Module: FrederickAPI

Defined in:
lib/frederick_api.rb,
lib/frederick_api/v2/role.rb,
lib/frederick_api/v2/user.rb,
lib/frederick_api/version.rb,
lib/frederick_api/v2/contact.rb,
lib/frederick_api/v2/campaign.rb,
lib/frederick_api/v2/location.rb,
lib/frederick_api/v2/resource.rb,
lib/frederick_api/configuration.rb,
lib/frederick_api/v2/automation.rb,
lib/frederick_api/v2/interaction.rb,
lib/frederick_api/v2/contact_list.rb,
lib/frederick_api/v2/contact_type.rb,
lib/frederick_api/v2/errors/errors.rb,
lib/frederick_api/v2/background_job.rb,
lib/frederick_api/v2/email_document.rb,
lib/frederick_api/v2/automation_step.rb,
lib/frederick_api/v2/public_resource.rb,
lib/frederick_api/v2/contact_property.rb,
lib/frederick_api/v2/helpers/has_many.rb,
lib/frederick_api/v2/business_category.rb,
lib/frederick_api/v2/helpers/paginator.rb,
lib/frederick_api/v2/helpers/requestor.rb,
lib/frederick_api/v2/communication_content.rb,
lib/frederick_api/v2/helpers/query_builder.rb,
lib/frederick_api/v2/communication_template.rb,
lib/frederick_api/v2/helpers/backgroundable_parser.rb

Overview

:nodoc:

Defined Under Namespace

Modules: V2 Classes: Configuration

Constant Summary collapse

VERSION =

Current gem version

'0.10'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config ⇒ FrederickAPI::Configuration

Returns a reference to the current configuration.

Returns:



54
55
56
 
# File 'lib/frederick_api/configuration.rb', line 54

def self.config
  @config ||= Configuration.new
end

Class Method Details

.configure {|configuration| ... } ⇒ FrederickAPI::Configuration

Configure FrederickAPI, for example in an initializer or (better yet) in one of the ‘config/environments/*.rb` files so you can have it configured differently per environment. For example, you may want to use staging API in staging environment, or may want different timeouts in development environment than production.

Examples:

# config/environments/staging.rb
...
FrederickAPI.configure do |c|
  c.base_url = 'https://api.staging.hirefrederick.com/v1'
  c.api_key = '1234-5678-1234-5678-1234-5678'
end
...

Yields:

  • (configuration) —

    block to configure FrederickAPI

Returns:



47
48
49
 
# File 'lib/frederick_api/configuration.rb', line 47

def self.configure
  yield(config)
end