Module: Mailercity

Defined in:
lib/mailercity.rb,
lib/mailercity/helper.rb,
lib/mailercity/version.rb,
lib/mailercity/errors/authentication_error.rb

Defined Under Namespace

Modules: Helper Classes: AuthenticationError, Message

Constant Summary collapse

VERSION = 
"0.0.3"
@@api_base = 
'https://mailercity.onthecity.org'
@@api_key = 
nil

Class Method Summary collapse

Class Method Details

.api_base ⇒ Object 



14
15
16
 
# File 'lib/mailercity.rb', line 14

def self.api_base
  @@api_base
end

.api_base=(api_base) ⇒ Object 



10
11
12
 
# File 'lib/mailercity.rb', line 10

def self.api_base=(api_base)
  @@api_base = api_base
end

.api_key ⇒ Object 



26
27
28
 
# File 'lib/mailercity.rb', line 26

def self.api_key
  @@api_key
end

.api_key=(api_key) ⇒ Object 



22
23
24
 
# File 'lib/mailercity.rb', line 22

def self.api_key=(api_key)
  @@api_key = api_key
end

.api_url(url = '') ⇒ Object 



18
19
20
 
# File 'lib/mailercity.rb', line 18

def self.api_url(url='')
  @@api_base + url
end

.const_missing(const_name) ⇒ Object 



36
37
38
39
40
41
 
# File 'lib/mailercity.rb', line 36

def self.const_missing(const_name)
  new_class = Class.new(super_class=Message)

  # Non-obvious: we assign it to a const in order to name.
  const_set(const_name, new_class)
end

.request(path, params) ⇒ Object

Raises:



30
31
32
33
34
 
# File 'lib/mailercity.rb', line 30

def self.request(path, params)
  raise AuthenticationError.new('No API key provided.  (HINT: set your API key using "Mailercity.api_key = <API-KEY>".') unless api_key
  response = Faraday.post(api_url(path), params, "X-Api-Key" => Mailercity.api_key)
  # TODO: CATCH ALL EXCEPTIONS (like URI::InvalidURIError) AND RAISE MY OWN ERROR
end