oanda_api 0.9.4 → 0.9.5

data/lib/oanda_api/resource/candle.rb

@@ -16,7 +16,7 @@ module OandaAPI
 
         # Top of hour alignments
         M2  = "M2"
-        M3  = "M3" 
+        M3  = "M3"
         M4  = "M4"
         M5  = "M5"
         M10 = "M10"

data/lib/oanda_api/resource/labs/calendar_event.rb

@@ -0,0 +1,25 @@
+module OandaAPI
+  module Resource
+    module Labs
+
+    # Calendar value object.
+    # See the Oanda Developer Guide for information about {http://developer.oanda.com/rest-live/forex-labs/#calendar Calendar}.
+      class CalendarEvent < ResourceBase
+        attr_accessor :actual,
+                      :currency,
+                      :forecast,
+                      :impact,
+                      :market,
+                      :previous,
+                      :region,
+                      :timestamp,
+                      :title,
+                      :unit
+
+        def time
+          Time.at(timestamp).utc if timestamp
+        end
+      end
+    end
+  end
+end

data/lib/oanda_api/resource/labs/spread_history.rb

@@ -0,0 +1,61 @@
+module OandaAPI
+  module Resource
+    module Labs
+
+    # Spread value object.
+    # See the Oanda Developer Guide for information about {http://developer.oanda.com/rest-live/forex-labs/#spreads Spreads}.
+      class SpreadHistory < ResourceBase
+        attr_accessor :avg,
+                      :max,
+                      :min
+
+        alias_method :averages, :avg
+        alias_method :maximums, :max
+        alias_method :minimums, :min
+
+        def initialize(attributes = {})
+          attribs = attributes.dup
+          self.averages = attribs.delete(:avg) || []
+          self.maximums = attribs.delete(:max) || []
+          self.minimums = attribs.delete(:min) || []
+          super attribs
+        end
+
+        def averages=(array=[])
+          @avg = []
+          array.each { |elements| @avg << Tuple.new(*elements) }
+        end
+
+        def maximums=(array=[])
+          @max = []
+          array.each { |elements| @max << Tuple.new(*elements) }
+        end
+
+        def minimums=(array=[])
+          @min = []
+          array.each { |elements| @min << Tuple.new(*elements) }
+        end
+
+        # @private
+        class Tuple
+          attr_accessor :spread,
+                        :time,
+                        :timestamp
+
+          def initialize(timestamp, spread)
+            @timestamp = timestamp
+            @spread = spread
+          end
+
+          def time
+            Time.at(timestamp).utc if timestamp
+          end
+
+          def to_s
+            spread
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oanda_api/resource/order.rb

@@ -23,10 +23,10 @@ module OandaAPI
 
       def initialize(attributes = {})
         attribs = attributes.dup
-        self.order_opened  = attribs.delete(order_opened)  || {}
-        self.trade_opened  = attribs.delete(trade_opened)  || {}
-        self.trade_reduced = attribs.delete(trade_reduced) || {}
-        self.trades_closed = attribs.delete(trades_closed) || []
+        self.order_opened  = attribs.delete(:order_opened)  || {}
+        self.trade_opened  = attribs.delete(:trade_opened)  || {}
+        self.trade_reduced = attribs.delete(:trade_reduced) || {}
+        self.trades_closed = attribs.delete(:trades_closed) || []
         super attribs
       end
 

data/lib/oanda_api/resource/transaction_history.rb

@@ -3,7 +3,6 @@ module OandaAPI
     # Transactions History value object. Resource name in API: alltransactions.
     # See the Oanda Developer Guide for information about {http://developer.oanda.com/rest-live/transaction-history/ Transactions history}.
     class TransactionHistory < ResourceBase
-
     end
   end
 end

data/lib/oanda_api/resource_base.rb

@@ -1,5 +1,6 @@
 module OandaAPI
   require 'json'
+
   # Base class for all Resources.
   #
   # @!attribute [rw] location
@@ -20,14 +21,63 @@ module OandaAPI
       @location = attributes.location if attributes.respond_to? :location
     end
 
-    # Serializes an instance as JSON
+    # 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
 
+    # Returns the class of a Resource if klass_symbol is the name
+    #   of a resource, otherwise nil.
+    #
+    #   @example Example:
+    #     ResourceBase.class_from_symbol(:transaction_history) => OandaAPI::Resource::TransactionHistory
+    #     ResourceBase.class_from_symbol(:calendar_event) => OandaAPI::Resource::Labs::CalendarEvent
+    #
+    # @param [Symbol] resource_symbol symbolized resource name
+    #
+    # @return [Nil] if resource_symbol is not a Resource.
+    #
+    # @return [Class] if resource_symbol is identifies a Resource.
+    def self.class_from_symbol(resource_symbol)
+      descendant resource_symbol
+    end
+
+    # Tests whether a class is a Labs Resource.
+    #
+    # @param [Class] klass the class to be tested.
+    #
+    # @return [Boolean] True if the class is a Labs Resource.
+    def self.labs_resource?(klass)
+      (@lab_resources ||=[]).include? klass
+    end
+
+    # List of API resources that don't follow normal REST naming standards,
+    #  and are not pluralized despite being collections.
+    NOT_PLURALIZED = [:calendar]
+
+    # Returns a pluralized version of the resource class name
+    # @param [Symbol] klass_symbol
+    # @return [String] the pluralized resource class name
+    def self.pluralize(klass_symbol)
+      NOT_PLURALIZED.include?(klass_symbol.to_sym) ? klass_symbol.to_s : OandaAPI::Utils.pluralize(klass_symbol)
+    end
+
     private
 
+    # @private
+    # Called whenever ResourceBase class is inherited by a descendant class.
+    #  Used to track descendant classes.
+    #  Used to identify classes within the "::Labs::" namespace.
+    def self.inherited(klass)
+      ResourceBase.inherited(klass) unless self == OandaAPI::ResourceBase
+      klass.to_s.match(/^(?<labs>(.*::)?Labs::)?(.*?)?(?<resource_name>(\w)+)$/) do |matched|
+        resource_symbol = OandaAPI::Utils.underscore(matched[:resource_name]).to_sym
+        (@descendants ||= {})[resource_symbol] = klass
+        (@lab_resources ||= []) << klass if matched[:labs]
+      end
+    end
+
     # @private
     # Initializes attributes.
     #
@@ -40,10 +90,22 @@ module OandaAPI
       end
     end
 
+    # @private
     # Provides additional attributes used in serialization.
-    # @return [Hash] returns a hash of customized attributes for serialization
+    # @return [Hash] a hash of customized attributes for serialization
     def custom_attributes
       {}.tap { |hash| hash[:location] = location if location }
     end
+
+    # @private
+    # Returns a class name if klass_symbol is the name of a class that
+    # descends from {OandaAPI::ResourceBase}, otherwise nil.
+    # @param [Symbol] klass_symbol class name of a resource class
+    # @return [Class]
+    # @return [Nil] if klass_symbol is not a class that descends from
+    #  {OandaAPI::ResourceBase}.
+    def self.descendant(klass_symbol)
+      (@descendants || {})[klass_symbol]
+    end
   end
 end

data/lib/oanda_api/resource_collection.rb

@@ -28,6 +28,12 @@ module OandaAPI
     #   about the resource collection and its elements.
     def initialize(attributes, resource_descriptor)
       attributes = {} if attributes.nil? || attributes.respond_to?(:empty) && attributes.empty?
+      if attributes.kind_of?(Array)
+        h = {}
+        h["#{resource_descriptor.collection_name}".to_sym] = attributes
+        attributes = h
+      end
+
       fail ArgumentError, "Expecting a Hash" unless attributes.respond_to? :each_pair
       @attributes = Utils.rubyize_keys attributes
       @collection = @attributes.delete(resource_descriptor.collection_name) || []

data/lib/oanda_api/streaming/client.rb

@@ -132,6 +132,7 @@ module OandaAPI
                                                                 uri: api_uri(path),
                                                                 query: Utils.stringify_keys(conditions),
                                                                 headers: OandaAPI.configuration.headers.merge(headers)
+          @streaming_request.emit_heartbeats = emit_heartbeats?
           @streaming_request.stream(&block)
           return nil
         end

data/lib/oanda_api/version.rb

@@ -1,3 +1,3 @@
 module OandaAPI
-  VERSION = "0.9.4"
+  VERSION = "0.9.5"
 end

data/oanda_api.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_dependency "http-exceptions",           "~> 0.0"
 
   s.add_development_dependency "rspec",         "~> 3.2"
-  s.add_development_dependency "vcr",           "~> 2.9"
-  s.add_development_dependency "webmock",       "~> 1.21"
+  s.add_development_dependency "vcr",           "~> 3.0"
+  s.add_development_dependency "webmock",       "~> 1.24"
   s.add_development_dependency "yard",          "~> 0.8"
 end

data/spec/fixtures/vcr_cassettes/accounts_get.yml

@@ -2,13 +2,15 @@
 http_interactions:
 - request:
     method: get
-    uri: http://api-sandbox.oanda.com/v1/accounts?username=dwaymotim
+    uri: https://api-fxpractice.oanda.com/v1/accounts
     body:
       encoding: US-ASCII
       string: ''
     headers:
       X-Accept-Datetime-Format:
       - RFC3339
+      Authorization:
+      - Bearer <OANDA_TESTING_API_TOKEN>
       Connection:
       - keep-alive
       Keep-Alive:
@@ -21,91 +23,23 @@ http_interactions:
       Server:
       - openresty/1.7.0.1
       Date:
-      - Tue, 20 Jan 2015 17:22:27 GMT
+      - Mon, 14 Mar 2016 16:28:06 GMT
       Content-Type:
       - application/json
       Content-Length:
-      - '139'
+      - '366'
       Connection:
       - keep-alive
       Etag:
-      - '"2c8bda3c0aced2c86025961c4e2da0452332ea36"'
+      - '"efb224b14d5e6c03ab1a19a9983274e09d124b20"'
     body:
       encoding: UTF-8
-      string: "{\n\t\"accounts\" : [\n\t\t{\n\t\t\t\"accountId\" : 5342358,\n\t\t\t\"accountName\"
+      string: "{\n\t\"accounts\" : [\n\t\t{\n\t\t\t\"accountId\" : 1871900,\n\t\t\t\"accountName\"
         : \"Primary\",\n\t\t\t\"accountCurrency\" : \"USD\",\n\t\t\t\"marginRate\"
-        : 0.05\n\t\t}\n\t]\n}"
+        : 0.05\n\t\t},\n\t\t{\n\t\t\t\"accountId\" : 1401515,\n\t\t\t\"accountName\"
+        : \"USD\",\n\t\t\t\"accountCurrency\" : \"USD\",\n\t\t\t\"marginRate\" : 0.1\n\t\t},\n\t\t{\n\t\t\t\"accountId\"
+        : 5094848,\n\t\t\t\"accountName\" : \"WTI\",\n\t\t\t\"accountCurrency\" :
+        \"CAD\",\n\t\t\t\"marginRate\" : 0.05\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Tue, 20 Jan 2015 17:22:29 GMT
-- request:
-    method: get
-    uri: http://api-sandbox.oanda.com/v1/accounts/?username=paudougles
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      X-Accept-Datetime-Format:
-      - RFC3339
-      Connection:
-      - keep-alive
-      Keep-Alive:
-      - 30
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - openresty/1.7.0.1
-      Date:
-      - Tue, 20 Jan 2015 23:27:03 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '139'
-      Connection:
-      - keep-alive
-      Etag:
-      - '"61cce213956060b4ccb6fd9f47235b4c03e74095"'
-    body:
-      encoding: UTF-8
-      string: "{\n\t\"accounts\" : [\n\t\t{\n\t\t\t\"accountId\" : 1724176,\n\t\t\t\"accountName\"
-        : \"Primary\",\n\t\t\t\"accountCurrency\" : \"USD\",\n\t\t\t\"marginRate\"
-        : 0.05\n\t\t}\n\t]\n}"
-    http_version: 
-  recorded_at: Tue, 20 Jan 2015 23:27:03 GMT
-- request:
-    method: get
-    uri: http://api-sandbox.oanda.com/v1/accounts?username
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      X-Accept-Datetime-Format:
-      - RFC3339
-      Connection:
-      - keep-alive
-      Keep-Alive:
-      - 30
-  response:
-    status:
-      code: 404
-      message: NOT_FOUND
-    headers:
-      Server:
-      - openresty/1.7.0.1
-      Date:
-      - Fri, 23 Jan 2015 17:37:52 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '144'
-      Connection:
-      - keep-alive
-    body:
-      encoding: UTF-8
-      string: "{\n\t\"code\" : 55,\n\t\"message\" : \"Username specified is invalid\",\n\t\"moreInfo\"
-        : \"http:\\/\\/developer.oanda.com\\/docs\\/v1\\/troubleshooting\\/#errors\"\n}"
-    http_version: 
-  recorded_at: Fri, 23 Jan 2015 17:37:52 GMT
-recorded_with: VCR 2.9.3
+  recorded_at: Mon, 14 Mar 2016 16:28:06 GMT
+recorded_with: VCR 3.0.1

data/spec/fixtures/vcr_cassettes/accounts_id_get.yml

@@ -2,13 +2,15 @@
 http_interactions:
 - request:
     method: get
-    uri: http://api-sandbox.oanda.com/v1/accounts?username=dwaymotim
+    uri: https://api-fxpractice.oanda.com/v1/accounts
     body:
       encoding: US-ASCII
       string: ''
     headers:
       X-Accept-Datetime-Format:
       - RFC3339
+      Authorization:
+      - Bearer <OANDA_TESTING_API_TOKEN>
       Connection:
       - keep-alive
       Keep-Alive:
@@ -21,31 +23,36 @@ http_interactions:
       Server:
       - openresty/1.7.0.1
       Date:
-      - Tue, 20 Jan 2015 17:22:27 GMT
+      - Mon, 14 Mar 2016 16:28:07 GMT
       Content-Type:
       - application/json
       Content-Length:
-      - '139'
+      - '366'
       Connection:
       - keep-alive
       Etag:
-      - '"2c8bda3c0aced2c86025961c4e2da0452332ea36"'
+      - '"efb224b14d5e6c03ab1a19a9983274e09d124b20"'
     body:
       encoding: UTF-8
-      string: "{\n\t\"accounts\" : [\n\t\t{\n\t\t\t\"accountId\" : 5342358,\n\t\t\t\"accountName\"
+      string: "{\n\t\"accounts\" : [\n\t\t{\n\t\t\t\"accountId\" : 1871900,\n\t\t\t\"accountName\"
         : \"Primary\",\n\t\t\t\"accountCurrency\" : \"USD\",\n\t\t\t\"marginRate\"
-        : 0.05\n\t\t}\n\t]\n}"
+        : 0.05\n\t\t},\n\t\t{\n\t\t\t\"accountId\" : 1401515,\n\t\t\t\"accountName\"
+        : \"USD\",\n\t\t\t\"accountCurrency\" : \"USD\",\n\t\t\t\"marginRate\" : 0.1\n\t\t},\n\t\t{\n\t\t\t\"accountId\"
+        : 5094848,\n\t\t\t\"accountName\" : \"WTI\",\n\t\t\t\"accountCurrency\" :
+        \"CAD\",\n\t\t\t\"marginRate\" : 0.05\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Tue, 20 Jan 2015 17:22:29 GMT
+  recorded_at: Mon, 14 Mar 2016 16:28:07 GMT
 - request:
     method: get
-    uri: http://api-sandbox.oanda.com/v1/accounts/5342358?username=dwaymotim
+    uri: https://api-fxpractice.oanda.com/v1/accounts/1871900
     body:
       encoding: US-ASCII
       string: ''
     headers:
       X-Accept-Datetime-Format:
       - RFC3339
+      Authorization:
+      - Bearer <OANDA_TESTING_API_TOKEN>
       Connection:
       - keep-alive
       Keep-Alive:
@@ -58,130 +65,21 @@ http_interactions:
       Server:
       - openresty/1.7.0.1
       Date:
-      - Tue, 20 Jan 2015 17:22:27 GMT
+      - Mon, 14 Mar 2016 16:28:08 GMT
       Content-Type:
       - application/json
       Content-Length:
-      - '247'
+      - '276'
       Connection:
       - keep-alive
       Etag:
-      - '"52b4908f3477c81c8c80224512bc0715f21deaf4"'
+      - '"158b907f059d85274d407e88979dc2a616a3e0c9"'
     body:
       encoding: UTF-8
-      string: "{\n\t\"accountId\" : 5342358,\n\t\"accountName\" : \"Primary\",\n\t\"balance\"
-        : 100000,\n\t\"unrealizedPl\" : 0,\n\t\"realizedPl\" : 0,\n\t\"marginUsed\"
-        : 0,\n\t\"marginAvail\" : 100000,\n\t\"openTrades\" : 0,\n\t\"openOrders\"
+      string: "{\n\t\"accountId\" : 1871900,\n\t\"accountName\" : \"Primary\",\n\t\"balance\"
+        : 100375.6663,\n\t\"unrealizedPl\" : -18.712,\n\t\"realizedPl\" : 332.7989,\n\t\"marginUsed\"
+        : 8111.17,\n\t\"marginAvail\" : 92245.7843,\n\t\"openTrades\" : 16,\n\t\"openOrders\"
         : 0,\n\t\"marginRate\" : 0.05,\n\t\"accountCurrency\" : \"USD\"\n}"
     http_version: 
-  recorded_at: Tue, 20 Jan 2015 17:22:29 GMT
-- request:
-    method: get
-    uri: http://api-sandbox.oanda.com/v1/accounts/?username=paudougles
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      X-Accept-Datetime-Format:
-      - RFC3339
-      Connection:
-      - keep-alive
-      Keep-Alive:
-      - 30
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - openresty/1.7.0.1
-      Date:
-      - Tue, 20 Jan 2015 23:27:04 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '139'
-      Connection:
-      - keep-alive
-      Etag:
-      - '"61cce213956060b4ccb6fd9f47235b4c03e74095"'
-    body:
-      encoding: UTF-8
-      string: "{\n\t\"accounts\" : [\n\t\t{\n\t\t\t\"accountId\" : 1724176,\n\t\t\t\"accountName\"
-        : \"Primary\",\n\t\t\t\"accountCurrency\" : \"USD\",\n\t\t\t\"marginRate\"
-        : 0.05\n\t\t}\n\t]\n}"
-    http_version: 
-  recorded_at: Tue, 20 Jan 2015 23:27:03 GMT
-- request:
-    method: get
-    uri: http://api-sandbox.oanda.com/v1/accounts/1724176?username=paudougles
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      X-Accept-Datetime-Format:
-      - RFC3339
-      Connection:
-      - keep-alive
-      Keep-Alive:
-      - 30
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - openresty/1.7.0.1
-      Date:
-      - Tue, 20 Jan 2015 23:27:04 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '247'
-      Connection:
-      - keep-alive
-      Etag:
-      - '"83c3b001199921bd888ca07ddf04539617fe4a63"'
-    body:
-      encoding: UTF-8
-      string: "{\n\t\"accountId\" : 1724176,\n\t\"accountName\" : \"Primary\",\n\t\"balance\"
-        : 100000,\n\t\"unrealizedPl\" : 0,\n\t\"realizedPl\" : 0,\n\t\"marginUsed\"
-        : 0,\n\t\"marginAvail\" : 100000,\n\t\"openTrades\" : 0,\n\t\"openOrders\"
-        : 0,\n\t\"marginRate\" : 0.05,\n\t\"accountCurrency\" : \"USD\"\n}"
-    http_version: 
-  recorded_at: Tue, 20 Jan 2015 23:27:04 GMT
-- request:
-    method: get
-    uri: http://api-sandbox.oanda.com/v1/accounts?username
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      X-Accept-Datetime-Format:
-      - RFC3339
-      Connection:
-      - keep-alive
-      Keep-Alive:
-      - 30
-  response:
-    status:
-      code: 404
-      message: NOT_FOUND
-    headers:
-      Server:
-      - openresty/1.7.0.1
-      Date:
-      - Fri, 23 Jan 2015 17:37:52 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '144'
-      Connection:
-      - keep-alive
-    body:
-      encoding: UTF-8
-      string: "{\n\t\"code\" : 55,\n\t\"message\" : \"Username specified is invalid\",\n\t\"moreInfo\"
-        : \"http:\\/\\/developer.oanda.com\\/docs\\/v1\\/troubleshooting\\/#errors\"\n}"
-    http_version: 
-  recorded_at: Fri, 23 Jan 2015 17:37:53 GMT
-recorded_with: VCR 2.9.3
+  recorded_at: Mon, 14 Mar 2016 16:28:08 GMT
+recorded_with: VCR 3.0.1