Class: OandaAPI::Client::UsernameClient

Inherits:

Object

• Object
• OandaAPI::Client::UsernameClient

Includes:

OandaAPI::Client

Defined in:

lib/oanda_api/client/username_client.rb

Overview

Makes requests to the API. Instances access the Oanda sandbox environment. Most client requests require a valid Oanda sandbox account username. See the Oanda Development Guide for information about creating a test account.

Examples:

Example usage (creates a new test account).

client = OandaAPI::Client::UsernameClient.new "_"  # Note: A new test account can be created without having an
                                                   # existing account, which is why we create a client in this
                                                   # example with a bogus username ("_").
new_account = client.account.create                # => OandaAPI::Resource::Account
new_account.username                               # => "<username>"

Constant Summary

Constants included from OandaAPI::Client

BASE_URI

Instance Attribute Summary

• #default_params ⇒ Hash

  Parameters that are included with every API request as either query or url_form encoded parameters.

• #domain ⇒ Symbol readonly

  Identifies the Oanda subdomain (:sandbox) which the client accesses.

• #headers ⇒ Hash

  Parameters that are included with every API request as HTTP headers.

• #username ⇒ String readonly

  The username used for authentication.

Instance Method Summary

• #auth ⇒ Hash

  Parameters used for authentication.

• #initialize(username) ⇒ UsernameClient constructor

  A new instance of UsernameClient.

Methods included from OandaAPI::Client

#api_uri, #execute_request, last_throttled_at, map_method_to_http_verb, #proc, throttle_request_rate

Constructor Details

#initialize(username) ⇒ UsernameClient

# File 'lib/oanda_api/client/username_client.rb', line 38

def initialize(username)
  super()
  @domain = :sandbox
  @username = username
  @default_params = auth
  @headers = {}
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class OandaAPI::Client

Instance Attribute Details

#default_params ⇒ Hash

# File 'lib/oanda_api/client/username_client.rb', line 31

class UsernameClient
  include Client

  attr_reader :domain, :username
  attr_accessor :default_params, :headers

  # @param [String] username used for authentication.
  def initialize(username)
    super()
    @domain = :sandbox
    @username = username
    @default_params = auth
    @headers = {}
  end

  # Parameters used for authentication.
  # @return [Hash]
  def auth
    { "username" => @username }
  end
end

#domain ⇒ Symbol (readonly)

# File 'lib/oanda_api/client/username_client.rb', line 31

class UsernameClient
  include Client

  attr_reader :domain, :username
  attr_accessor :default_params, :headers

  # @param [String] username used for authentication.
  def initialize(username)
    super()
    @domain = :sandbox
    @username = username
    @default_params = auth
    @headers = {}
  end

  # Parameters used for authentication.
  # @return [Hash]
  def auth
    { "username" => @username }
  end
end

#headers ⇒ Hash

# File 'lib/oanda_api/client/username_client.rb', line 31

class UsernameClient
  include Client

  attr_reader :domain, :username
  attr_accessor :default_params, :headers

  # @param [String] username used for authentication.
  def initialize(username)
    super()
    @domain = :sandbox
    @username = username
    @default_params = auth
    @headers = {}
  end

  # Parameters used for authentication.
  # @return [Hash]
  def auth
    { "username" => @username }
  end
end

#username ⇒ String (readonly)

# File 'lib/oanda_api/client/username_client.rb', line 31

class UsernameClient
  include Client

  attr_reader :domain, :username
  attr_accessor :default_params, :headers

  # @param [String] username used for authentication.
  def initialize(username)
    super()
    @domain = :sandbox
    @username = username
    @default_params = auth
    @headers = {}
  end

  # Parameters used for authentication.
  # @return [Hash]
  def auth
    { "username" => @username }
  end
end

Instance Method Details

#auth ⇒ Hash

Parameters used for authentication.

# File 'lib/oanda_api/client/username_client.rb', line 48

def auth
  { "username" => @username }
end