Module: Elk

Extended by:

Forwardable

Defined in:

lib/elk.rb,
lib/elk/sms.rb,
lib/elk/util.rb,
lib/elk/error.rb,
lib/elk/client.rb,
lib/elk/number.rb,
lib/elk/version.rb

Overview

Base module Used for to configure username and password through Elk.configure

Defined Under Namespace

Modules: Util Classes: AuthError, BadRequest, BadResponse, Client, MissingParameter, Number, SMS, ServerError

Constant Summary

VERSION =

"0.6.1"

Class Method Summary

• .client ⇒ Object

  Not thread safe.

• .configure {|client| ... } ⇒ Object

  Set up authentication credentials, has to be done before using Elk::Number and Elk::SMS.

Class Method Details

.client ⇒ Object

Not thread safe

# File 'lib/elk.rb', line 37

def client
  @client ||= Client.new
end

.configure {|client| ... } ⇒ Object

Set up authentication credentials, has to be done before using Elk::Number and Elk::SMS

Elk.configure do |config|
  config.username = "USERNAME"
  config.password = "PASSWORD"
end

Yields:

• (client)

# File 'lib/elk.rb', line 32

def configure
  yield client
end