oanda_api_v20 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 145cfc6151144fbd433437480a84ade5979e0925
-  data.tar.gz: be705bc8e001aa7130fb737bb4d293398d00cc14
+SHA256:
+  metadata.gz: be0ef34e9d27b283681c25c8f281c5ec264f9b36b63b39715df9bc69de0209a9
+  data.tar.gz: ba7a3cd6ec27e820e58565fedc2ec6b7e723f954ae1381ef79548d4ca88469af
 SHA512:
-  metadata.gz: 01e1f96777e51ff3313c7d842a0fce4eb9730b4f127a7af5794a7292f516fd67c10fb9df437df9a9becca6afd4fb8607e7ce3afcff0acb7315be9ac8f374fc57
-  data.tar.gz: ef476fb280a946cf30f8624c4482655ee1fb8fb54bc8bf6117d38fdd6461daba1a77759a791aab7b69ca5035a98f733df0a9d35e8286f67242669c61997d781c
+  metadata.gz: 39f4320e897a343a542e19155c36a6b80698ab7b57bc8d5e40da608ab6ec6845ba12cf9d1a79ef29c24a28850616ddf12760929fc15f78df7b9ff7aa5ea41eb3
+  data.tar.gz: e791adff74088c1f6da6a23454f30d13fe226828a9683d609b9ff910819a34008722a4badb6b0d7b29fb0b59b95064f5eb44844b2474a6004877c46d1f0f8dec

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.7.2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 2.2.0
+#### 2021-08-27
+
+* New transactions_stream endpoint. Big thanks to @plabaj.
+* Upgraded development dependency version for rake to fix potential security vulnerability.
+
 ## 2.1.1
 #### 2019-10-05
 * Fix to pricing_stream method. This fixes the currency pair rate being reused over and over no matter the value read in the HTTP chunk. Big thanks to @joseluis-fw & @salrepe.

data/README.md

@@ -297,6 +297,14 @@ options = {
 client.account('account_id').transactions_since_id(options).show
 ```
 
+```ruby
+client = OandaApiV20.new(access_token: 'my_access_token', stream: true)
+
+client.account('account_id').transactions_stream.show do |json|
+  puts json if json['type'] != 'HEARTBEAT'
+end
+```
+
 ### Pricing
 
 See the [Oanda Documentation](http://developer.oanda.com/rest-live-v20/pricing-ep/) for all available options on pricing.

data/lib/oanda_api_v20/api.rb

@@ -92,5 +92,17 @@ module OandaApiV20
         self.http_verb = nil
       end
     end
+
+    def parse(buffer, fragment, &block)
+      buffer.split("\n").each do |message|
+        cleaned_message = message.strip
+        next if cleaned_message.empty?
+        yield JSON.parse(cleaned_message)
+      end
+    rescue JSON::ParserError => e
+      raise OandaApiV20::ParseError, "#{e.message} in '#{fragment}'"
+    ensure
+      buffer.clear
+    end
   end
 end

data/lib/oanda_api_v20/pricing.rb

@@ -17,19 +17,5 @@ module OandaApiV20
         end
       end
     end
-
-    private
-
-    def parse(buffer, fragment, &block)
-      buffer.split("\n").each do |message|
-        cleaned_message = message.strip
-        next if cleaned_message.empty?
-        yield JSON.parse(cleaned_message)
-      end
-    rescue JSON::ParserError => e
-      raise OandaApiV20::ParseError, "#{e.message} in '#{fragment}'"
-    ensure
-      buffer.clear
-    end
   end
 end

data/lib/oanda_api_v20/transactions.rb

@@ -20,5 +20,17 @@ module OandaApiV20
     def transactions_since_id(options)
       Client.send(http_verb, "#{base_uri}/accounts/#{account_id}/transactions/sinceid", headers: headers, query: options)
     end
+
+    # GET /v3/accounts/:account_id/transactions/stream
+    def transactions_stream(options = {}, &block)
+      buffer = String.new
+
+      Client.send(http_verb, "#{base_uri}/accounts/#{account_id}/transactions/stream", headers: headers, query: options, stream_body: true) do |fragment|
+        if !fragment.empty?
+          buffer << fragment
+          parse(buffer, fragment, &block) if fragment.match(/\n\Z/)
+        end
+      end
+    end
   end
 end

data/lib/oanda_api_v20/version.rb

@@ -1,3 +1,3 @@
 module OandaApiV20
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

data/oanda_api_v20.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec',   '~> 3.4'
   s.add_development_dependency 'webmock', '~> 2.1'
   s.add_development_dependency 'timecop', '~> 0.8'
-  s.add_development_dependency 'rake',    '~> 10.5'
+  s.add_development_dependency 'rake',    '~> 13.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})

data/spec/oanda_api_v20/api_spec.rb

@@ -323,6 +323,28 @@ describe OandaApiV20::Api do
           api.transactions_since_id(options).show
           expect(a_request(:get, 'https://api-fxtrade.oanda.com/v3/accounts/100-100-100/transactions/sinceid').with(query: options)).to have_been_made.once
         end
+
+        it 'retrieving all transactions stream' do
+          body = <<~EOF
+{"id":"6","accountID":"100-100-100","userID":12345678,"batchID":"4","requestID":"11111111111111111","time":"2021-08-20T11:56:39.037505525Z","type":"TAKE_PROFIT_ORDER","tradeID":"5","timeInForce":"GTC","triggerCondition":"DEFAULT","price":"0.71388","reason":"ON_FILL"}\n{"id":"7","accountID":"100-100-100","userID":12345678,"batchID":"4","requestID":"11111111111111112","time":"2021-08-20T11:56:39.037505525Z","type":"STOP_LOSS_ORDER","tradeID":"5","timeInForce":"GTC","triggerCondition":"DEFAULT","triggerMode":"TOP_OF_BOOK","price":"0.71258","distance":"0.00030","reason":"ON_FILL"}\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/transactions/stream').to_return(status: 200, body: body, headers: headers)
+
+          messages = []
+
+          stream_api.transactions_stream.show do |message|
+            messages << message
+          end
+
+          expect(a_request(:get, 'https://stream-fxtrade.oanda.com/v3/accounts/100-100-100/transactions/stream')).to have_been_made.once
+          expect(messages.count).to eq(2)
+        end
       end
 
       context 'pricing for' do
@@ -453,6 +475,7 @@ EOF
       :trade, :trades, :open_trades,
       :position, :positions, :open_positions,
       :transaction, :transactions, :transactions_id_range, :transactions_since_id,
+      :transactions_stream,
       :pricing,
       :pricing_stream,
       :candles

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oanda_api_v20
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '13.0'
 description: Ruby client that supports the Oanda REST API V20 methods.
 email: kobus@translate3d.com
 executables: []
@@ -161,8 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby Oanda REST API V20