oanda_api_v20 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e44f2d12b3c6e2fafe20137218ecfec9d8f4678
-  data.tar.gz: cec80bbcce9fe58398319d715a2d7a50cc1f37f4
+  metadata.gz: c705d6ed7e93994a827ab0f090c3ffb210af8abf
+  data.tar.gz: 9beca7942edcad3e584e29c2607ace094b38c3dd
 SHA512:
-  metadata.gz: 3b4439bf716d67a9117036009817ea19caa302b610b234832b7f7294116df3ab6b5ee6763967c6f4932a0630143367bcf498132f0b689e0c7627f9afdeff6a4e
-  data.tar.gz: 984932b04c7095c02af46a3000a6b2c8935f8062e707d235a45d07afcc43a4f94d719744d83b7277ab64e90525f1e3086982134b6e2ea58c001714bc717d694b
+  metadata.gz: b3206d93bf544c75b273a3685acb11a5485877e99127925c51df9173f50fd968ae7b335f7b40f7e67493fdc61e55ac977cef11a2d900eb6b737ce68119db203f
+  data.tar.gz: da31de41ee3bfd5cb0a245ce1e185e0e4ba1773d0e192efade7cd9536ffe9ce96ca8c2f5e1d507abf89cc629e62ff356d9625626b41d1490174e101146fbbc29

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 2.1.0
+#### 2019-02-01
+* New pricing_stream endpoint. Big thanks to @joseluis-fw.
+* Raises an OandaApiV20::ParseError exception when a malformed response returned from Oanda API.
+* The OandaApiV20::RequestError exception object now has an original_exception attribute which contains the original exception object raised.
+
 ## 2.0.0
 #### 2018-04-24
 * Fixed issues when trying to reuse a Client object to make HTTP requests to Oanda.

data/README.md

@@ -33,6 +33,10 @@ If you would like to trade with your test account:
 
     client = OandaApiV20.new(access_token: 'my_access_token', practice: true)
 
+If you would like to use the streaming endpoints:
+
+    client = OandaApiV20.new(access_token: 'my_access_token', stream: true)
+
 If you need your requests to go through a proxy:
 
     client = OandaApiV20.new(access_token: 'my_access_token', proxy_url: 'https://user:pass@proxy.com:80')
@@ -305,10 +309,34 @@ options = {
 client.account('account_id').pricing(options).show
 ```
 
+```ruby
+client = OandaApiV20.new(access_token: 'my_access_token', stream: true)
+
+options = {
+  'instruments' => 'EUR_USD,USD_CAD'
+}
+
+client.account('account_id').pricing_stream(options).show do |json|
+  puts json if json['type'] == 'PRICE'
+end
+```
+
 ## Exceptions
 
+A `OandaApiV20::ParseError` will be raised when a response from the Oanda API is malformed.
+
 A `OandaApiV20::RequestError` will be raised when a request to the Oanda API failed for any reason.
 
+You can access the original exception in a `OandaApiV20::RequestError`:
+
+```ruby
+begin
+  do_something
+rescue OandaApiV20::RequestError => e
+  e.original_exception
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/oanda_api_v20/api.rb

@@ -33,7 +33,7 @@ module OandaApiV20
       define_method(method_name) do |*args, &block|
         # Add the block below before each of the api_methods to set the last_action and last_arguments.
         # Return the OandaApiV20::Api object to allow for method chaining when any of the api_methods have been called.
-        # Only make an HTTP request to Oanda API When an action method like show, update, cancel, close or create was called.
+        # Only make an HTTP request to Oanda API when an action method like show, update, cancel, close or create was called.
         set_last_action_and_arguments(method_name, *args)
         return self unless http_verb
 
@@ -56,7 +56,7 @@ module OandaApiV20
               last_arguments.nil? || last_arguments.empty? ? send(last_action, &block) : send(last_action, *last_arguments, &block)
             end
           rescue Http::Exceptions::HttpException => e
-            raise OandaApiV20::RequestError, e.message
+            raise OandaApiV20::RequestError.new(e.message, response: e.response, original_exception: e.original_exception)
           end
 
           if response.body && !response.body.empty?

data/lib/oanda_api_v20/client.rb

@@ -3,9 +3,15 @@ module OandaApiV20
     include HTTParty
 
     BASE_URI = {
-      live:     'https://api-fxtrade.oanda.com/v3',
-      practice: 'https://api-fxpractice.oanda.com/v3'
-    }
+      live: {
+        api:    'https://api-fxtrade.oanda.com/v3',
+        stream: 'https://stream-fxtrade.oanda.com/v3'
+      },
+      practice: {
+        api:    'https://api-fxpractice.oanda.com/v3',
+        stream: 'https://stream-fxpractice.oanda.com/v3'
+      }
+    }.freeze
 
     attr_accessor :access_token, :proxy_url, :max_requests_per_second, :connection_pool_size, :debug
     attr_reader   :base_uri, :headers
@@ -20,7 +26,8 @@ module OandaApiV20
       @connection_pool_size    ||= 2
       @max_requests_per_second ||= 100
       @last_api_request_at     = Array.new(max_requests_per_second)
-      @base_uri                = options[:practice] == true ? BASE_URI[:practice] : BASE_URI[:live]
+      uris                     = options[:practice] == true ? BASE_URI[:practice] : BASE_URI[:live]
+      @base_uri                = options[:stream] == true ? uris[:stream] : uris[:api]
 
       @headers                             = {}
       @headers['Authorization']            = "Bearer #{access_token}"
@@ -39,7 +46,7 @@ module OandaApiV20
         pool_size:    connection_pool_size
       }
 
-      persistent_connection_adapter_options.merge!(logger: ::Logger.new(STDOUT)) if debug
+      persistent_connection_adapter_options.merge!(logger: ::Logger.new(STDOUT), debug_output: ::Logger.new(STDOUT)) if debug
       Client.persistent_connection_adapter(persistent_connection_adapter_options)
     end
 

data/lib/oanda_api_v20/exceptions.rb

@@ -1,4 +1,14 @@
 module OandaApiV20
   class ApiError < RuntimeError; end
-  class RequestError < RuntimeError; end
+  class ParseError < RuntimeError; end
+
+  class RequestError < RuntimeError
+    attr_reader :response, :original_exception
+
+    def initialize(message = nil, options = {})
+      @original_exception = options[:original_exception]
+      @response           = options[:response]
+      super(message)
+    end
+  end
 end

data/lib/oanda_api_v20/pricing.rb

@@ -5,5 +5,29 @@ module OandaApiV20
     def pricing(options)
       Client.send(http_verb, "#{base_uri}/accounts/#{account_id}/pricing", headers: headers, query: options)
     end
+
+    # GET /v3/accounts/:account_id/pricing/stream
+    def pricing_stream(options, &block)
+      buffer = StringIO.new
+
+      Client.send(http_verb, "#{base_uri}/accounts/#{account_id}/pricing/stream", headers: headers, query: options, stream_body: true) do |fragment|
+        begin
+          next if fragment.empty?
+
+          buffer << fragment
+          next unless fragment.match(/\n\Z/)
+
+          buffer.string.split("\n").each do |message|
+            cleaned_message = message.strip
+            next if cleaned_message.empty?
+            yield JSON.parse(cleaned_message)
+          end
+        rescue JSON::ParseError => e
+          raise OandaApiV20::ParseError, "#{e.message} in '#{fragment}'"
+        ensure
+          buffer.flush
+        end
+      end
+    end
   end
 end

data/lib/oanda_api_v20/version.rb

@@ -1,3 +1,3 @@
 module OandaApiV20
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/spec/oanda_api_v20/api_spec.rb

@@ -61,8 +61,10 @@ describe OandaApiV20::Api do
 
   describe '#method_missing' do
     describe 'constructs the correct API URL under' do
-      let!(:client) { OandaApiV20::Client.new(access_token: 'my_access_token', base_uri: 'https://api-fxtrade.oanda.com/v3', headers: {}) }
-      let!(:api)    { OandaApiV20::Api.new(client: client, account_id: '100-100-100') }
+      let!(:client)        { OandaApiV20::Client.new(access_token: 'my_access_token', base_uri: 'https://api-fxtrade.oanda.com/v3', headers: {}) }
+      let!(:stream_client) { OandaApiV20::Client.new(access_token: 'my_access_token', base_uri: 'https://api-fxtrade.oanda.com/v3', headers: {}, stream: true) }
+      let!(:api)           { OandaApiV20::Api.new(client: client, account_id: '100-100-100') }
+      let!(:stream_api)    { OandaApiV20::Api.new(client: stream_client, account_id: '100-100-100') }
 
       before(:each) do
         stub_request(:get, /https:\/\/api-fxtrade\.oanda\.com\/v3.*/)
@@ -331,6 +333,32 @@ describe OandaApiV20::Api do
           api.pricing(options).show
           expect(a_request(:get, 'https://api-fxtrade.oanda.com/v3/accounts/100-100-100/pricing').with(query: options)).to have_been_made.once
         end
+
+        it 'retrieving all pricing stream' do
+          options = {
+            'instruments' => 'EUR_USD,USD_CAD'
+          }
+
+          body = <<~EOF
+{"type":"PRICE","time":"2019-01-31T18:16:38.818627106Z","bids":[{"price":"0.72711","liquidity":10000000}],"asks":[{"price":"0.72725","liquidity":10000000}],"closeoutBid":"0.72696","closeoutAsk":"0.72740","status":"tradeable","tradeable":true,"instrument":"USD_CAD"}\n{"type":"PRICE","time":"2019-01-31T18:16:48.270050596Z","bids":[{"price":"0.95533","liquidity":10000000}],"asks":[{"price":"0.95554","liquidity":10000000}],"closeoutBid":"0.95533","closeoutAsk":"0.95554","status":"tradeable","tradeable":true,"instrument":"EUR_USD"}\n\r\n
+EOF
+
+          headers = {
+            'Transfer-Encoding' => 'chunked',
+            'Content-Type' => 'application/octet-stream'
+          }
+
+          stub_request(:get, 'https://stream-fxtrade.oanda.com/v3/accounts/100-100-100/pricing/stream?instruments=EUR_USD,USD_CAD').to_return(status: 200, body: body, headers: headers)
+
+          messages = []
+
+          stream_api.pricing_stream(options).show do |message|
+            messages << message
+          end
+
+          expect(a_request(:get, 'https://stream-fxtrade.oanda.com/v3/accounts/100-100-100/pricing/stream').with(query: options)).to have_been_made.once
+          expect(messages.count).to eq(2)
+        end
       end
     end
 
@@ -426,6 +454,7 @@ describe OandaApiV20::Api do
       :position, :positions, :open_positions,
       :transaction, :transactions, :transactions_id_range, :transactions_since_id,
       :pricing,
+      :pricing_stream,
       :candles
     ] }
 

data/spec/oanda_api_v20/exceptions_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe OandaApiV20::RequestError do
+  describe '#initialize' do
+    let(:response)           { { code: 200, body: '' } }
+
+    it 'sets the message attribute' do
+      exception = OandaApiV20::RequestError.new('An error as occured while processing response.')
+      expect(exception.message).to eq('An error as occured while processing response.')
+    end
+
+    it 'sets the response attribute when supplied' do
+      exception = OandaApiV20::RequestError.new('An error as occured while processing response.', response: response)
+      expect(exception.response).to eq(response)
+    end
+
+    it 'sets the original_exception attribue when supplied' do
+      original_exception = OpenSSL::SSL::SSLError.new('SSL_read: sslv3 alert handshake failure')
+      exception = OandaApiV20::RequestError.new('An error as occured while processing response.', original_exception: original_exception)
+      expect(exception.original_exception).to be_an_instance_of(OpenSSL::SSL::SSLError)
+      expect(exception.original_exception.message).to eq('SSL_read: sslv3 alert handshake failure')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oanda_api_v20
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2019-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -139,6 +139,7 @@ files:
 - oanda_api_v20.gemspec
 - spec/oanda_api_v20/api_spec.rb
 - spec/oanda_api_v20/client_spec.rb
+- spec/oanda_api_v20/exceptions_spec.rb
 - spec/oanda_api_v20/oanda_api_v20_spec.rb
 - spec/spec_helper.rb
 homepage: http://rubygems.org/gems/oanda_api_v20
@@ -168,5 +169,6 @@ summary: Ruby Oanda REST API V20
 test_files:
 - spec/oanda_api_v20/api_spec.rb
 - spec/oanda_api_v20/client_spec.rb
+- spec/oanda_api_v20/exceptions_spec.rb
 - spec/oanda_api_v20/oanda_api_v20_spec.rb
 - spec/spec_helper.rb