Class: Africansms::Configuration

Inherits:

Object

• Object
• Africansms::Configuration

Defined in:

lib/africansms/configuration.rb

Instance Attribute Summary

• #api_key ⇒ Object

  Returns the value of attribute api_key.

• #shortcode ⇒ Object

  Returns the value of attribute shortcode.

• #username ⇒ Object

  Returns the value of attribute username.

Instance Method Summary

• #api_key! ⇒ Object
• #initialize ⇒ Configuration constructor

  A new instance of Configuration.

• #shortcode! ⇒ Object
• #username! ⇒ Object

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.

# File 'lib/africansms/configuration.rb', line 5

def initialize
  @api_key = nil
  @username = nil
  @shortcode = nil
end

Instance Attribute Details

#api_key ⇒ Object

Returns the value of attribute api_key.

# File 'lib/africansms/configuration.rb', line 3

def api_key
  @api_key
end

#shortcode ⇒ Object

Returns the value of attribute shortcode.

# File 'lib/africansms/configuration.rb', line 3

def shortcode
  @shortcode
end

#username ⇒ Object

Returns the value of attribute username.

# File 'lib/africansms/configuration.rb', line 3

def username
  @username
end

Instance Method Details

#api_key! ⇒ Object

# File 'lib/africansms/configuration.rb', line 11

def api_key!
  api_key || raise(AfricansmsError, 'No api key specified.')
end

#shortcode! ⇒ Object

# File 'lib/africansms/configuration.rb', line 19

def shortcode!
  shortcode || raise(AfricansmsError, 'No shortcode specified.')
end

#username! ⇒ Object

# File 'lib/africansms/configuration.rb', line 15

def username!
  username || raise(AfricansmsError, 'No username specified.')
end