module ActiveRestClient::Configuration::ClassMethods

Public Instance Methods

_reset_configuration!() click to toggle source
# File lib/active_rest_client/configuration.rb, line 169
def _reset_configuration!
  @base_url             = nil
  @@base_url            = nil
  @request_body_type    = nil
  @@request_body_type   = :form_encoded
  @whiny_missing        = nil
  @lazy_load            = false
  @faraday_config       = default_faraday_config
  @adapter              = Faraday.default_adapter
  @api_auth_access_id   = nil
  @api_auth_secret_key  = nil
end
adapter() click to toggle source
# File lib/active_rest_client/configuration.rb, line 93
def adapter
  @adapter ||= Faraday.default_adapter
end
adapter=(adapter) click to toggle source
# File lib/active_rest_client/configuration.rb, line 88
def adapter=(adapter)
  ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Adapter set to be #{adapter}"
  @adapter = adapter
end
api_auth_access_id() click to toggle source
# File lib/active_rest_client/configuration.rb, line 132
def api_auth_access_id
  if !@api_auth_access_id.nil?
    return @api_auth_access_id
  elsif self.superclass.respond_to?(:api_auth_access_id)
    return self.superclass.api_auth_access_id
  end

  return nil
end
api_auth_credentials(access_id, secret_key) click to toggle source
# File lib/active_rest_client/configuration.rb, line 117
def api_auth_credentials(access_id, secret_key)
  begin
    require 'api-auth'
  rescue LoadError
    raise MissingOptionalLibraryError.new("You must include the gem 'api-auth' in your Gemfile to set api-auth credentials.")
  end

  @api_auth_access_id = access_id
  @api_auth_secret_key = secret_key
end
api_auth_secret_key() click to toggle source
# File lib/active_rest_client/configuration.rb, line 142
def api_auth_secret_key
  if !@api_auth_secret_key.nil?
    return @api_auth_secret_key
  elsif self.superclass.respond_to?(:api_auth_secret_key)
    return self.superclass.api_auth_secret_key
  end

  return nil
end
base_url(value = nil) click to toggle source
# File lib/active_rest_client/configuration.rb, line 14
def base_url(value = nil)
  if value.nil?
    if @base_url.nil?
      @@base_url
    else
      @base_url
    end
  else
    value = value.gsub(/\/$/, '')
    @base_url = value
  end
end
base_url=(value) click to toggle source
# File lib/active_rest_client/configuration.rb, line 27
def base_url=(value)
  ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Base URL set to be #{value}"
  value = value.gsub(/\/+$/, '')
  @@base_url = value
end
faraday_config(&block) click to toggle source
# File lib/active_rest_client/configuration.rb, line 97
def faraday_config(&block)
  if block
    @faraday_config = block
  else
    @faraday_config ||= default_faraday_config
  end
end
lazy_load!() click to toggle source
# File lib/active_rest_client/configuration.rb, line 105
def lazy_load!
  @lazy_load = true
end
lazy_load?() click to toggle source
# File lib/active_rest_client/configuration.rb, line 109
def lazy_load?
  @lazy_load || false
end
password(value = nil) click to toggle source
# File lib/active_rest_client/configuration.rb, line 52
def password(value = nil)
  if value.nil?
    if @password.nil?
      @@password
    else
      @password
    end
  else
    value = CGI::escape(value) if value.present? && !value.include?("%")
    @password = value
  end
end
password=(value) click to toggle source
# File lib/active_rest_client/configuration.rb, line 65
def password=(value)
  ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Password set..."
  value = CGI::escape(value) if value.present? && !value.include?("%")
  @@password = value
end
proxy(value = nil) click to toggle source
# File lib/active_rest_client/configuration.rb, line 165
def proxy(value = nil)
  value ? @proxy = value : @proxy || nil
end
request_body_type(value = nil) click to toggle source
# File lib/active_rest_client/configuration.rb, line 71
def request_body_type(value = nil)
  if value.nil?
    if @request_body_type.nil?
      @@request_body_type
    else
      @request_body_type
    end
  else
    @request_body_type = value
  end
end
request_body_type=(value) click to toggle source
# File lib/active_rest_client/configuration.rb, line 83
def request_body_type=(value)
  ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Request Body Type set to be #{value}"
  @@request_body_type = value
end
translator(value = nil) click to toggle source
# File lib/active_rest_client/configuration.rb, line 160
def translator(value = nil)
  ActiveRestClient::Logger.warn("DEPRECATION: The translator functionality of ActiveRestClient has been replaced with proxy functionality, see https://github.com/whichdigital/active-rest-client#proxying-apis for more information") unless value.nil?
  value ? @translator = value : @translator || nil
end
username(value = nil) click to toggle source
# File lib/active_rest_client/configuration.rb, line 33
def username(value = nil)
  if value.nil?
    if @username.nil?
      @@username
    else
      @username
    end
  else
    value = CGI::escape(value) if value.present? && !value.include?("%")
    @username = value
  end
end
username=(value) click to toggle source
# File lib/active_rest_client/configuration.rb, line 46
def username=(value)
  ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Username set to be #{value}"
  value = CGI::escape(value) if value.present? && !value.include?("%")
  @@username = value
end
using_api_auth?() click to toggle source
# File lib/active_rest_client/configuration.rb, line 128
def using_api_auth?
  !self.api_auth_access_id.nil? && !self.api_auth_secret_key.nil?
end
verbose(value = nil) click to toggle source
# File lib/active_rest_client/configuration.rb, line 156
def verbose(value = nil)
  value ? @verbose = value : @verbose || false
end
verbose!() click to toggle source
# File lib/active_rest_client/configuration.rb, line 152
def verbose!
  @verbose = true
end
whiny_missing(value = nil) click to toggle source
# File lib/active_rest_client/configuration.rb, line 113
def whiny_missing(value = nil)
  value ? @whiny_missing = value : @whiny_missing || false
end

Private Instance Methods

default_faraday_config() click to toggle source
# File lib/active_rest_client/configuration.rb, line 184
def default_faraday_config
  Proc.new do |faraday|
    faraday.adapter(adapter)

    if faraday.options.respond_to?(:timeout=)
      faraday.options.timeout         = 10
      faraday.options.open_timeout    = 10
    else
      faraday.options['timeout']      = 10
      faraday.options['open_timeout'] = 10
    end

    faraday.headers['User-Agent'] = "ActiveRestClient/#{ActiveRestClient::VERSION}"
    faraday.headers['Connection'] = "Keep-Alive"
    faraday.headers['Accept']     = "application/json"
  end
end