Contents

module OandaAPI
  require 'json'
  # Base class for all Resources.
  #
  # @!attribute [rw] location
  #   @return [String] the `location` header if one is returned in an API
  #     response.
  #   @example Using the `location` attribute
  #      client = OandaAPI::Client::TokenClient.new :practice, token
  #      all_transactions = client.account(123).alltransactions.get
  #      all_transactions.location # => https://fxtrade.oanda.com/transactionhistory/d3aed6823c.json.zip
  class ResourceBase
    attr_accessor :location

    # @param [Hash] attributes collection of resource attributes. See the
    #   {http://developer.oanda.com/rest-live/development-guide/ Oanda Developer Guide}
    #   for documentation about resource attributes.
    def initialize(attributes = {})
      initialize_attributes Utils.rubyize_keys(attributes)
      @location = attributes.location if attributes.respond_to? :location
    end

    # Serializes an instance as JSON
    # @return [String] a stringified JSON representation of an instance
    def to_json(*args)
      JSON.generate @_attributes.merge(custom_attributes), *args
    end

    private

    # @private
    # Initializes attributes.
    #
    # @param [Hash] attributes collection of resource attributes.
    # @return [void]
    def initialize_attributes(attributes)
      @_attributes = attributes
      attributes.each do |key, value|
        send("#{key}=", value) if respond_to? key
      end
    end

    # Provides additional attributes used in serialization.
    # @return [Hash] returns a hash of customized attributes for serialization
    def custom_attributes
      {}.tap { |hash| hash[:location] = location if location }
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
oanda_api-0.9.4	lib/oanda_api/resource_base.rb
oanda_api-0.9.3	lib/oanda_api/resource_base.rb
oanda_api-0.9.2	lib/oanda_api/resource_base.rb