oanda_api_v20 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df006567cbd1acee31c44649ff9660bae3cbd8ca
-  data.tar.gz: cbc54442151b3a3cb06fd4044812a56fc23ed52a
+  metadata.gz: 8de51715b0686fbc75824fe6da40c38d82aa83dd
+  data.tar.gz: 35a0b883d5abf389da6745d33080762011270891
 SHA512:
-  metadata.gz: fc14f293e67e1b0351044dd1f50621d248b633c9d254ae9a4f0d5a6bff990b381560370c497409117a01f1da1524b077afb30453b4e6f492087f3677a6b32d09
-  data.tar.gz: 5c82460ae6765964e0f23d93d4b6176d848cb6fce9a07d143371c1e132329d631a2a76f4102022b5a26f052b5259c675fad98abeb1fd3bfb94c6475d7b85e600
+  metadata.gz: a783da10af447a552a7e182a34a38e29a6b492c7fc58ec204967f46d54393465b3f12d4fb0c7ad50cf4da5c7c4ea57685cd12416f5704f59f413c02c6bda0241
+  data.tar.gz: 3b52f9e02531e69aedff3e5adb9333cd6d07f37f12fdc6db8dc86cd78bba0d7844ce3caaa0b56013a2d1aaaabb638360202e151a4383005c1bdd91cff525163d

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 1.0.0
+#### 2016-08-23
+* Added the RSpec Gem for writing unit tests.
+* Added the WebMock Gem to stub HTTP requests to Oanda API when writing unit tests.
+* Raises a NoMethodError exception when the method does not exist. Previously nil was returned.
+* Raises an OandaApiV20::RequestError exception when the status code is not 2xx.
+* Fixed an issue where the requests to Oanda API was limited to 30 requests per minute instead of 30 requests per second. Whoops!
+* Fixed a bug where the response body would sometimes be nil and cause the client to crash.
+
 ## 0.0.6
 #### 2016-08-18
 * HTTP exception handling added.

data/lib/oanda_api_v20/client.rb

@@ -44,19 +44,22 @@ module OandaApiV20
         api = Api.new(api_attributes)
 
         if api.respond_to?(last_action)
+          api_result = {}
           set_last_api_request_at
           govern_api_request_rate
 
           begin
-            response = Http::Exceptions.wrap_exception do
+            response = Http::Exceptions.wrap_and_check do
               last_arguments.nil? || last_arguments.empty? ? api.send(last_action, &block) : api.send(last_action, *last_arguments, &block)
             end
           rescue Http::Exceptions::HttpException => e
             raise OandaApiV20::RequestError, e.message
           end
 
-          api_result = JSON.parse(response.body)
-          set_last_transaction_id(api_result)
+          if response.body && !response.body.empty?
+            api_result.merge!(JSON.parse(response.body))
+            set_last_transaction_id(api_result['lastTransactionID']) if api_result['lastTransactionID']
+          end
         end
 
         api_result
@@ -64,6 +67,8 @@ module OandaApiV20
         set_last_action_and_arguments(name, args)
         set_account_id(args.first) if name == :account
         self
+      else
+        super
       end
     end
 
@@ -77,7 +82,7 @@ module OandaApiV20
 
     def govern_api_request_rate
       return unless last_api_request_at[0]
-      halt = 60 - (last_api_request_at[MAX_REQUESTS_PER_SECOND_ALLOWED - 1] - last_api_request_at[0])
+      halt = 1 - (last_api_request_at[MAX_REQUESTS_PER_SECOND_ALLOWED - 1] - last_api_request_at[0])
       sleep halt if halt > 0
     end
 
@@ -102,8 +107,8 @@ module OandaApiV20
       self.account_id = id
     end
 
-    def set_last_transaction_id(api_result)
-      self.last_transaction_id = api_result['lastTransactionID'] if api_result['lastTransactionID']
+    def set_last_transaction_id(id)
+      self.last_transaction_id = id
     end
 
     def set_http_verb(action, last_action)

data/lib/oanda_api_v20/version.rb

@@ -1,3 +1,3 @@
 module OandaApiV20
-  VERSION = '0.0.6'
+  VERSION = '1.0.0'
 end

data/oanda_api_v20.gemspec

@@ -20,6 +20,11 @@ Gem::Specification.new do |s|
   s.add_dependency 'persistent_httparty', '~> 0.1'
   s.add_dependency 'http-exceptions',     '~> 0.1'
 
+  s.add_development_dependency 'rspec',   '~> 3.4'
+  s.add_development_dependency 'webmock', '~> 2.1'
+  s.add_development_dependency 'timecop', '~> 0.8'
+
   s.files         = `git ls-files`.split("\n")
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 end

data/spec/oanda_api_v20/client_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+describe OandaApiV20::Client do
+  describe '#initialize' do
+    it 'sets the access_token attribute when supplied' do
+      c = OandaApiV20::Client.new(access_token: 'my_access_token')
+      expect(c.access_token).to eq('my_access_token')
+    end
+
+    it 'sets the base URI to practice when the practice option was supplied and set to true' do
+      c = OandaApiV20::Client.new(practice: true)
+      expect(c.base_uri).to eq('https://api-fxpractice.oanda.com/v3')
+    end
+
+    it 'sets the base URI to live when the practice option was supplied and set to false' do
+      c = OandaApiV20::Client.new(practice: false)
+      expect(c.base_uri).to eq('https://api-fxtrade.oanda.com/v3')
+    end
+
+    it 'sets the base URI to live when the practice option was not supplied' do
+      c = OandaApiV20::Client.new
+      expect(c.base_uri).to eq('https://api-fxtrade.oanda.com/v3')
+    end
+  end
+
+  describe '#method_missing' do
+    let(:c) { OandaApiV20::Client.new(access_token: 'my_access_token') }
+
+    context 'when an OandaApiV20::Api method has been called' do
+      it 'saves the method called' do
+        c.accounts
+        expect(c.send(:last_action)).to eq(:accounts)
+      end
+
+      it 'saves the attributes supplied' do
+        c.account('100-100-100')
+        expect(c.send(:last_action)).to eq(:account)
+        expect(c.send(:last_arguments)).to eq(['100-100-100'])
+      end
+
+      it 'saves the account ID when calling the account method' do
+        c.account('100-100-100')
+        expect(c.send(:account_id)).to eq('100-100-100')
+      end
+
+      it 'returns a OandaApiV20::Client instance' do
+        expect(c.account('100-100-100')).to be_an_instance_of(OandaApiV20::Client)
+      end
+    end
+
+    context 'when an action method has been called' do
+      let(:response_account)  { '{"account":{"id":"100-100-100","NAV":"100000.0000","balance":"100000.0000","lastTransactionID":"99","orders":[],"positions":[],"trades":[],"pendingOrderCount":0},"lastTransactionID":"99"}' }
+      let!(:request_account)  { stub_request(:get, 'https://api-fxtrade.oanda.com/v3/accounts/100-100-100').to_return(status: 200, body: response_account, headers: {}) }
+      let(:response_accounts) { '{"accounts":[{"id":"100-100-100","tags":[]}]}' }
+      let!(:request_accounts) { stub_request(:get, 'https://api-fxtrade.oanda.com/v3/accounts').to_return(status: 200, body: response_accounts, headers: {}) }
+
+      before(:each) do
+        allow(c).to receive(:sleep)
+      end
+
+      it 'sets the equivalent HTTP verb' do
+        c.accounts.show
+        expect(c.send(:http_verb)).to eq(:get)
+      end
+
+      it 'makes a request to Oanda API' do
+        c.accounts.show
+        expect(request_accounts).to have_been_requested
+        expect(request_accounts).to have_been_requested.at_most_once
+      end
+
+      it 'returns the response from Oanda API' do
+        expect(c.accounts.show).to eq(JSON.parse(response_accounts))
+        expect(c.account('100-100-100').show).to eq(JSON.parse(response_account))
+      end
+
+      it 'sets the last transaction ID when returned' do
+        c.account('100-100-100').show
+        expect(c.send(:last_transaction_id)).to eq('99')
+      end
+
+      it 'sets the last request made at time' do
+        expect(c.send(:last_api_request_at).last).to be_nil
+        c.accounts.show
+        expect(c.send(:last_api_request_at).last).to_not be_nil
+        expect(Time.parse(c.send(:last_api_request_at).last.to_s)).to be_an_instance_of(Time)
+      end
+
+      it 'raises an OandaApiV20::RequestError exception when receiving anything other than a 2xx response from Oanda API' do
+        stub_request(:get, 'https://api-fxtrade.oanda.com/v3/accounts/100-100-109').to_return(status: 401, body: '', headers: {})
+        expect{ c.account('100-100-109').show }.to raise_error(OandaApiV20::RequestError)
+      end
+
+      describe 'governing request rate' do
+        before(:each) do
+          Timecop.freeze(Time.local('2016-08-01 06:00:00'))
+        end
+
+        after(:each) do
+          Timecop.return
+        end
+
+        it 'is not allowed to make 30 requests or more per second' do
+          expect(c).to receive(:sleep).at_least(:twice)
+          30.times { c.accounts.show }
+          Timecop.freeze('2016-08-01 06:00:01')
+          30.times { c.accounts.show }
+        end
+
+        it 'is allowed to make less than 30 requests per second' do
+          expect(c).to_not receive(:sleep)
+          29.times { c.accounts.show }
+          Timecop.freeze('2016-08-01 06:00:01')
+          29.times { c.accounts.show }
+          Timecop.freeze('2016-08-01 06:00:02')
+          29.times { c.accounts.show }
+        end
+
+        it 'halts all API requests for the remainder of the second when 30 requests have been made in one second' do
+          expect(c).to receive(:sleep).with(0.7)
+          Timecop.freeze('2016-08-01 06:00:00.0')
+          10.times { c.accounts.show }
+          Timecop.freeze('2016-08-01 06:00:00.1')
+          10.times { c.accounts.show }
+          Timecop.freeze('2016-08-01 06:00:00.3')
+          10.times { c.accounts.show }
+        end
+      end
+    end
+
+    context 'when a method other than an OandaApiV20::Api method has been called' do
+      it 'throws a NoMethodError exception' do
+        expect{ c.accounts.show_me_the_money }.to raise_error(NoMethodError)
+      end
+    end
+
+    context 'when a method other than an action method has been called' do
+      it 'throws a NoMethodError exception' do
+        expect{ c.this_method_definitely_does_not_exist }.to raise_error(NoMethodError)
+      end
+    end
+  end
+end

data/spec/oanda_api_v20/oanda_api_v20_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe OandaApiV20 do
+  describe '.new' do
+    it 'instantiates a new OandaApiV20::Client' do
+      c = OandaApiV20.new
+      expect(c).to be_an_instance_of(OandaApiV20::Client)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'webmock/rspec'
+require 'timecop'
+require 'oanda_api_v20'
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oanda_api_v20
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -52,6 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Ruby client that supports the Oanda REST API V20 methods.
 email: kobus@translate3d.com
 executables: []
@@ -59,6 +101,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -76,6 +119,9 @@ files:
 - lib/oanda_api_v20/transactions.rb
 - lib/oanda_api_v20/version.rb
 - oanda_api_v20.gemspec
+- spec/oanda_api_v20/client_spec.rb
+- spec/oanda_api_v20/oanda_api_v20_spec.rb
+- spec/spec_helper.rb
 homepage: http://rubygems.org/gems/oanda_api_v20
 licenses:
 - MIT
@@ -100,4 +146,7 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby Oanda REST API V20
-test_files: []
+test_files:
+- spec/oanda_api_v20/client_spec.rb
+- spec/oanda_api_v20/oanda_api_v20_spec.rb
+- spec/spec_helper.rb