oanda_api_v20 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fea2b5abda5730c36fa1d535c0de33c82f96c3d
-  data.tar.gz: ea80f60cd1263e3eb80e12d3715a052d9b08ab17
+  metadata.gz: 0c701def72ef104194002af2f65acc194a8f2b37
+  data.tar.gz: 5ed313d698c3b7914ae9f2a02e76bcf28e857506
 SHA512:
-  metadata.gz: ea0776c3df49196324f703632f6090b39fe4d203f3931872b927e086292aa9719abaf5f4ce64db56d7890cc611fe07f81eabdbc85b832a64c1b01dc34b2d6eab
-  data.tar.gz: 9e9a3fa546f6d3a6f47283b3cbeb2c18f8c096fb1a2d6d3992a77bcbd12ff4c5f68f5faaf4106b9fc5364c50998f507e7e51bf223a3de304c3b9449223d5e559
+  metadata.gz: fcd956994384f069a5b26d01f0ed79db68069bbced7d889a125a0da1515f8d9de751eef77d3b753306f3089e1425aae2f11e12d88c1cc1ece4740ad569d2c795
+  data.tar.gz: bafa52e682df3017a7fadaf73811a6699cdb580de817ffac280416ebf6e0afcb3def4298956db92a63dd1e597c463aec9759cdd3bcd4bc096a4c990a767d1b52

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.2.0
+#### 2016-12-03
+* Added the instruments method to retrieve candlestick data.
+
 ## 1.1.0
 #### 2016-10-24
 * Added an optional field to the account instruments method to query only a list of instruments instead of returning all instruments.

data/README.md

@@ -69,6 +69,16 @@ options = { alias: 'My New Account #2' }
 client.account('account_id').configuration(options).update
 ```
 
+### Instruments
+
+See the [Oanda Documentation](http://developer.oanda.com/rest-live-v20/instrument-ep/) for all available options on instruments.
+
+```ruby
+options = { count: 10 }
+
+client.instrument('EUR_USD').candles(options).show
+```
+
 ### Orders
 
 See the [Oanda Documentation](http://developer.oanda.com/rest-live-v20/orders-ep/) for all available options on orders.

data/lib/oanda_api_v20.rb

@@ -5,6 +5,7 @@ require 'http/exceptions'
 require 'oanda_api_v20/version'
 require 'oanda_api_v20/exceptions'
 require 'oanda_api_v20/accounts'
+require 'oanda_api_v20/instruments'
 require 'oanda_api_v20/orders'
 require 'oanda_api_v20/trades'
 require 'oanda_api_v20/positions'

data/lib/oanda_api_v20/api.rb

@@ -1,13 +1,14 @@
 module OandaApiV20
   class Api
     include Accounts
+    include Instruments
     include Orders
     include Trades
     include Positions
     include Transactions
     include Pricing
 
-    attr_accessor :http_verb, :base_uri, :headers, :account_id, :last_transaction_id
+    attr_accessor :http_verb, :base_uri, :headers, :account_id, :instrument, :last_transaction_id
 
     def initialize(options = {})
       options.each do |key, value|

data/lib/oanda_api_v20/client.rb

@@ -66,6 +66,7 @@ module OandaApiV20
       when *api_methods
         set_last_action_and_arguments(name, args)
         set_account_id(args.first) if name == :account
+        set_instrument(args.first) if name == :instrument
         self
       else
         super
@@ -74,10 +75,10 @@ module OandaApiV20
 
     private
 
-    attr_accessor :http_verb, :account_id, :last_transaction_id, :last_action, :last_arguments, :last_api_request_at
+    attr_accessor :http_verb, :account_id, :instrument, :last_transaction_id, :last_action, :last_arguments, :last_api_request_at
 
     def api_methods
-      Accounts.instance_methods + Orders.instance_methods + Trades.instance_methods + Positions.instance_methods + Transactions.instance_methods + Pricing.instance_methods
+      Accounts.instance_methods + Instruments.instance_methods + Orders.instance_methods + Trades.instance_methods + Positions.instance_methods + Transactions.instance_methods + Pricing.instance_methods
     end
 
     def govern_api_request_rate
@@ -107,6 +108,10 @@ module OandaApiV20
       self.account_id = id
     end
 
+    def set_instrument(instrument)
+      self.instrument = instrument
+    end
+
     def set_last_transaction_id(id)
       self.last_transaction_id = id
     end
@@ -130,6 +135,7 @@ module OandaApiV20
         base_uri: base_uri,
         headers: headers,
         account_id: account_id,
+        instrument: instrument,
         last_transaction_id: last_transaction_id
       }
     end

data/lib/oanda_api_v20/instruments.rb

@@ -0,0 +1,11 @@
+# @see http://developer.oanda.com/rest-live-v20/instrument-ep/
+module OandaApiV20
+  module Instruments
+    attr_accessor :instrument
+
+    # GET /v3/instruments/:instrument/candles
+    def candles(options = {})
+      Client.send(http_verb, "#{base_uri}/instruments/#{instrument}/candles", headers: headers, query: options)
+    end
+  end
+end

data/lib/oanda_api_v20/version.rb

@@ -1,3 +1,3 @@
 module OandaApiV20
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/oanda_api_v20/api_spec.rb

@@ -99,6 +99,16 @@ describe OandaApiV20::Api do
       end
     end
 
+    context 'instruments for' do
+      let!(:api) { OandaApiV20::Api.new(base_uri: 'https://api-fxtrade.oanda.com/v3', account_id: '100-100-100', instrument: 'EUR_USD', headers: {}) }
+
+      it 'retrieving candlestick data' do
+        options = { 'count' => '10' }
+        api.candles(options)
+        expect(a_request(:get, 'https://api-fxtrade.oanda.com/v3/instruments/EUR_USD/candles').with(query: options)).to have_been_made.once
+      end
+    end
+
     context 'orders for' do
       it 'retrieving an order' do
         api.order('1')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oanda_api_v20
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -128,6 +128,7 @@ files:
 - lib/oanda_api_v20/api.rb
 - lib/oanda_api_v20/client.rb
 - lib/oanda_api_v20/exceptions.rb
+- lib/oanda_api_v20/instruments.rb
 - lib/oanda_api_v20/oanda_api_v20.rb
 - lib/oanda_api_v20/orders.rb
 - lib/oanda_api_v20/positions.rb