Module: Moonclerk

Defined in:
lib/moonclerk.rb,
lib/moonclerk/form.rb,
lib/moonclerk/util.rb,
lib/moonclerk/payment.rb,
lib/moonclerk/version.rb,
lib/moonclerk/customer.rb,
lib/moonclerk/list_object.rb,
lib/moonclerk/api_resource.rb,
lib/moonclerk/errors/api_error.rb,
lib/moonclerk/moonclerk_object.rb,
lib/moonclerk/api_operations/list.rb,
lib/moonclerk/api_operations/request.rb,
lib/moonclerk/errors/moonclerk_error.rb,
lib/moonclerk/errors/authentication_error.rb,
lib/moonclerk/errors/invalid_request_error.rb

Defined Under Namespace

Modules: APIOperations, Util Classes: APIError, APIResource, AuthenticationError, Customer, Form, InvalidRequestError, ListObject, MoonclerkError, MoonclerkObject, Payment

Constant Summary collapse

API_BASE = 
"https://api.moonclerk.com"
API_VERSION = 
1
DEFAULT_CA_BUNDLE_PATH = 
File.join(File.dirname(__FILE__), '/data/ca_certificates.crt')
VERSION = 
"1.0.3"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_key ⇒ Object

Returns the value of attribute api_key.



34
35
36
 
# File 'lib/moonclerk.rb', line 34

def api_key
  @api_key
end

.env ⇒ Object

Returns the value of attribute env.



34
35
36
 
# File 'lib/moonclerk.rb', line 34

def env
  @env
end

.verify_ssl_certs ⇒ Object

Returns the value of attribute verify_ssl_certs.



34
35
36
 
# File 'lib/moonclerk.rb', line 34

def verify_ssl_certs
  @verify_ssl_certs
end

Class Method Details

.api_error(error, response, error_obj) ⇒ Object 



137
138
139
 
# File 'lib/moonclerk.rb', line 137

def self.api_error(error, response, error_obj)
  APIError.new(error[:message], response.status, response.body, error_obj, response.headers)
end

.authentication_error(error, response, error_obj) ⇒ Object 



132
133
134
135
 
# File 'lib/moonclerk.rb', line 132

def self.authentication_error(error, response, error_obj)
  AuthenticationError.new(error[:message], response.status, response.body, error_obj,
                          response.headers)
end

.default_param_keys ⇒ Object 



97
98
99
 
# File 'lib/moonclerk.rb', line 97

def self.default_param_keys
  [:count, :offset]
end

.general_api_error(status, response_body) ⇒ Object 



101
102
103
104
 
# File 'lib/moonclerk.rb', line 101

def self.general_api_error(status, response_body)
  APIError.new("Invalid response object from API: #{response_body.inspect} " +
               "(HTTP response code was #{status})", status, response_body)
end

.handle_api_error(response) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/moonclerk.rb', line 106

def self.handle_api_error(response)
  begin
    error_obj = JSON.parse(response.body)
    error_obj = Util.symbolize_names(error_obj)
    error = error_obj[:error]
    raise MoonclerkError.new unless error && error.is_a?(Hash)

  rescue JSON::ParserError, StripeError
    raise general_api_error(response.status, response.body)
  end

  case response.status
  when 400, 404
    raise invalid_request_error(error, response, error_obj)
  when 401
    raise authentication_error(error, response, error_obj)
  else
    raise api_error(error, response, error_obj)
  end
end

.headers ⇒ Object 



90
91
92
93
94
95
 
# File 'lib/moonclerk.rb', line 90

def self.headers
  {
    "Authorization" => "Token token=#{api_key}",
    "Accept" => "application/vnd.moonclerk+json;version=#{API_VERSION}"
  }
end

.invalid_request_error(error, response, error_obj) ⇒ Object 



127
128
129
130
 
# File 'lib/moonclerk.rb', line 127

def self.invalid_request_error(error, response, error_obj)
  InvalidRequestError.new(error[:message], response.status, response.body, error_obj, 
                          response.headers)
end

.request(method, url, params = {}) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/moonclerk.rb', line 37

def self.request(method, url, params = {})
  unless env
    env = Rails.env
  end

  env = env.to_sym unless env.is_a?(Symbol)

  unless api_key
    raise AuthenticationError.new('No API key provided. ' \
      'Set your API key using "Moonclerk.api_key = <API-KEY>". ' \
      'You can generate API keys from the Moonclerk web interface' \
      'by logging in at moonclerk.com.')
  end

  if api_key =~ /\s/
    raise AuthenticationError.new('Your API key is invalid, as it contains ' \
      'whitespace. (HINT: You can double-check your API key from the ' \
      'MoonClerk web interface by logging in at moonclerk.com.)')
  end

  if verify_ssl_certs
    ssl_options = {
      ssl: {
        ca_file: Moonclerk::DEFAULT_CA_BUNDLE_PATH
      }
    }
  else
    ssl_options = { 
      ssl: { 
        verify: false
      }
    }
    unless @verify_ssl_warned
      @verify_ssl_warned = true
      $stderr.puts("WARNING: Running without SSL cert verification. " \
        "You should never do this in production. " \
        "Execute 'Moonclerk.verify_ssl_certs = true' to enable verification.")
    end
  end

  connection = Faraday.new(ssl_options)
  response = connection.send(method, url, params, headers)
  handle_api_error(response) if !(200..299).include?(response.status)
  parsed_response = JSON.parse(response.body)
  symbolized_response = Util.symbolize_names(parsed_response)

  if symbolized_response[:error]
    handle_api_error(response)
  else
    symbolized_response[symbolized_response.keys.first]
  end
end