Module: CrmpClient

Defined in:
lib/crmp_client.rb,
lib/crmp_client/api.rb,
lib/crmp_client/client.rb,
lib/crmp_client/errors.rb,
lib/crmp_client/version.rb,
lib/crmp_client/configuration.rb

Overview

The main namespace for CrmpClient.

It provides methods to configure the gem, and a convenience method to create a new Client object.

Defined Under Namespace

Classes: Api, Client, Configuration, CrmpClientError, HttpError, InvalidResponseBodyError

Constant Summary collapse

VERSION = 
'0.2.0'

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



15
16
17
 
# File 'lib/crmp_client.rb', line 15

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



19
20
21
 
# File 'lib/crmp_client.rb', line 19

def configure
  yield(configuration)
end

.new(crmp_base_uri = nil, crmp_api_token = nil) ⇒ Object

Return a new Client (which provides all the functionality of this gem), using passed parameters or the configured defaults.



25
26
27
28
29
30
 
# File 'lib/crmp_client.rb', line 25

def new(crmp_base_uri = nil, crmp_api_token = nil)
  base_uri = crmp_base_uri || configuration.default_base_uri
  api_token = crmp_api_token || configuration.default_api_token

  Client.new(base_uri, api_token)
end