oanda_api 0.9.5 → 0.9.6

data/spec/fixtures/vcr_cassettes/without_throttling.yml

@@ -14,16 +14,16 @@ http_interactions:
       Connection:
       - keep-alive
       Keep-Alive:
-      - 30
+      - '30'
   response:
     status:
       code: 200
       message: OK
     headers:
       Server:
-      - openresty/1.7.0.1
+      - openresty/1.9.15.1
       Date:
-      - Mon, 14 Mar 2016 16:28:49 GMT
+      - Mon, 08 Jan 2018 18:26:34 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -31,14 +31,16 @@ http_interactions:
       Connection:
       - keep-alive
       Etag:
-      - '"7307c40c38b58f85d7f3145c3c71bd20c5445765"'
+      - '"f31dec3261edd9030df81dc0ba69fe5a9d4e2fc9"'
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: "{\n\t\"prices\" : [\n\t\t{\n\t\t\t\"instrument\" : \"EUR_USD\",\n\t\t\t\"time\"
-        : \"2016-03-14T16:28:48.718496Z\",\n\t\t\t\"bid\" : 1.11104,\n\t\t\t\"ask\"
-        : 1.11118\n\t\t}\n\t]\n}"
+        : \"2018-01-08T18:26:31.344805Z\",\n\t\t\t\"bid\" : 1.19674,\n\t\t\t\"ask\"
+        : 1.19686\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Mon, 14 Mar 2016 16:28:48 GMT
+  recorded_at: Mon, 08 Jan 2018 18:26:45 GMT
 - request:
     method: get
     uri: https://api-fxpractice.oanda.com/v1/prices?instruments=EUR_USD
@@ -53,16 +55,16 @@ http_interactions:
       Connection:
       - keep-alive
       Keep-Alive:
-      - 30
+      - '30'
   response:
     status:
       code: 200
       message: OK
     headers:
       Server:
-      - openresty/1.7.0.1
+      - openresty/1.9.15.1
       Date:
-      - Mon, 14 Mar 2016 16:28:50 GMT
+      - Mon, 08 Jan 2018 18:26:34 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -70,14 +72,16 @@ http_interactions:
       Connection:
       - keep-alive
       Etag:
-      - '"50c652cb079cb183ec34718d3760fd9f07cd9948"'
+      - '"f31dec3261edd9030df81dc0ba69fe5a9d4e2fc9"'
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: "{\n\t\"prices\" : [\n\t\t{\n\t\t\t\"instrument\" : \"EUR_USD\",\n\t\t\t\"time\"
-        : \"2016-03-14T16:28:49.214000Z\",\n\t\t\t\"bid\" : 1.11104,\n\t\t\t\"ask\"
-        : 1.11118\n\t\t}\n\t]\n}"
+        : \"2018-01-08T18:26:31.344805Z\",\n\t\t\t\"bid\" : 1.19674,\n\t\t\t\"ask\"
+        : 1.19686\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Mon, 14 Mar 2016 16:28:50 GMT
+  recorded_at: Mon, 08 Jan 2018 18:26:45 GMT
 - request:
     method: get
     uri: https://api-fxpractice.oanda.com/v1/prices?instruments=EUR_USD
@@ -92,16 +96,16 @@ http_interactions:
       Connection:
       - keep-alive
       Keep-Alive:
-      - 30
+      - '30'
   response:
     status:
       code: 200
       message: OK
     headers:
       Server:
-      - openresty/1.7.0.1
+      - openresty/1.9.15.1
       Date:
-      - Mon, 14 Mar 2016 16:28:51 GMT
+      - Mon, 08 Jan 2018 18:26:34 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -109,14 +113,16 @@ http_interactions:
       Connection:
       - keep-alive
       Etag:
-      - '"50c652cb079cb183ec34718d3760fd9f07cd9948"'
+      - '"f31dec3261edd9030df81dc0ba69fe5a9d4e2fc9"'
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: "{\n\t\"prices\" : [\n\t\t{\n\t\t\t\"instrument\" : \"EUR_USD\",\n\t\t\t\"time\"
-        : \"2016-03-14T16:28:49.214000Z\",\n\t\t\t\"bid\" : 1.11104,\n\t\t\t\"ask\"
-        : 1.11118\n\t\t}\n\t]\n}"
+        : \"2018-01-08T18:26:31.344805Z\",\n\t\t\t\"bid\" : 1.19674,\n\t\t\t\"ask\"
+        : 1.19686\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Mon, 14 Mar 2016 16:28:51 GMT
+  recorded_at: Mon, 08 Jan 2018 18:26:45 GMT
 - request:
     method: get
     uri: https://api-fxpractice.oanda.com/v1/prices?instruments=EUR_USD
@@ -131,16 +137,16 @@ http_interactions:
       Connection:
       - keep-alive
       Keep-Alive:
-      - 30
+      - '30'
   response:
     status:
       code: 200
       message: OK
     headers:
       Server:
-      - openresty/1.7.0.1
+      - openresty/1.9.15.1
       Date:
-      - Mon, 14 Mar 2016 16:28:52 GMT
+      - Mon, 08 Jan 2018 18:26:34 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -148,14 +154,16 @@ http_interactions:
       Connection:
       - keep-alive
       Etag:
-      - '"50c652cb079cb183ec34718d3760fd9f07cd9948"'
+      - '"f31dec3261edd9030df81dc0ba69fe5a9d4e2fc9"'
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: "{\n\t\"prices\" : [\n\t\t{\n\t\t\t\"instrument\" : \"EUR_USD\",\n\t\t\t\"time\"
-        : \"2016-03-14T16:28:49.214000Z\",\n\t\t\t\"bid\" : 1.11104,\n\t\t\t\"ask\"
-        : 1.11118\n\t\t}\n\t]\n}"
+        : \"2018-01-08T18:26:31.344805Z\",\n\t\t\t\"bid\" : 1.19674,\n\t\t\t\"ask\"
+        : 1.19686\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Mon, 14 Mar 2016 16:28:52 GMT
+  recorded_at: Mon, 08 Jan 2018 18:26:45 GMT
 - request:
     method: get
     uri: https://api-fxpractice.oanda.com/v1/prices?instruments=EUR_USD
@@ -170,16 +178,16 @@ http_interactions:
       Connection:
       - keep-alive
       Keep-Alive:
-      - 30
+      - '30'
   response:
     status:
       code: 200
       message: OK
     headers:
       Server:
-      - openresty/1.7.0.1
+      - openresty/1.9.15.1
       Date:
-      - Mon, 14 Mar 2016 16:28:53 GMT
+      - Mon, 08 Jan 2018 18:26:34 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -187,14 +195,16 @@ http_interactions:
       Connection:
       - keep-alive
       Etag:
-      - '"50c652cb079cb183ec34718d3760fd9f07cd9948"'
+      - '"f31dec3261edd9030df81dc0ba69fe5a9d4e2fc9"'
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: "{\n\t\"prices\" : [\n\t\t{\n\t\t\t\"instrument\" : \"EUR_USD\",\n\t\t\t\"time\"
-        : \"2016-03-14T16:28:49.214000Z\",\n\t\t\t\"bid\" : 1.11104,\n\t\t\t\"ask\"
-        : 1.11118\n\t\t}\n\t]\n}"
+        : \"2018-01-08T18:26:31.344805Z\",\n\t\t\t\"bid\" : 1.19674,\n\t\t\t\"ask\"
+        : 1.19686\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Mon, 14 Mar 2016 16:28:53 GMT
+  recorded_at: Mon, 08 Jan 2018 18:26:45 GMT
 - request:
     method: get
     uri: https://api-fxpractice.oanda.com/v1/prices?instruments=EUR_USD
@@ -209,16 +219,16 @@ http_interactions:
       Connection:
       - keep-alive
       Keep-Alive:
-      - 30
+      - '30'
   response:
     status:
       code: 200
       message: OK
     headers:
       Server:
-      - openresty/1.7.0.1
+      - openresty/1.9.15.1
       Date:
-      - Mon, 14 Mar 2016 16:28:54 GMT
+      - Mon, 08 Jan 2018 18:26:34 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -226,14 +236,16 @@ http_interactions:
       Connection:
       - keep-alive
       Etag:
-      - '"50c652cb079cb183ec34718d3760fd9f07cd9948"'
+      - '"f31dec3261edd9030df81dc0ba69fe5a9d4e2fc9"'
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: "{\n\t\"prices\" : [\n\t\t{\n\t\t\t\"instrument\" : \"EUR_USD\",\n\t\t\t\"time\"
-        : \"2016-03-14T16:28:49.214000Z\",\n\t\t\t\"bid\" : 1.11104,\n\t\t\t\"ask\"
-        : 1.11118\n\t\t}\n\t]\n}"
+        : \"2018-01-08T18:26:31.344805Z\",\n\t\t\t\"bid\" : 1.19674,\n\t\t\t\"ask\"
+        : 1.19686\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Mon, 14 Mar 2016 16:28:54 GMT
+  recorded_at: Mon, 08 Jan 2018 18:26:45 GMT
 - request:
     method: get
     uri: https://api-fxpractice.oanda.com/v1/prices?instruments=EUR_USD
@@ -248,16 +260,16 @@ http_interactions:
       Connection:
       - keep-alive
       Keep-Alive:
-      - 30
+      - '30'
   response:
     status:
       code: 200
       message: OK
     headers:
       Server:
-      - openresty/1.7.0.1
+      - openresty/1.9.15.1
       Date:
-      - Mon, 14 Mar 2016 16:28:55 GMT
+      - Mon, 08 Jan 2018 18:26:34 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -265,14 +277,16 @@ http_interactions:
       Connection:
       - keep-alive
       Etag:
-      - '"50c652cb079cb183ec34718d3760fd9f07cd9948"'
+      - '"f31dec3261edd9030df81dc0ba69fe5a9d4e2fc9"'
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: "{\n\t\"prices\" : [\n\t\t{\n\t\t\t\"instrument\" : \"EUR_USD\",\n\t\t\t\"time\"
-        : \"2016-03-14T16:28:49.214000Z\",\n\t\t\t\"bid\" : 1.11104,\n\t\t\t\"ask\"
-        : 1.11118\n\t\t}\n\t]\n}"
+        : \"2018-01-08T18:26:31.344805Z\",\n\t\t\t\"bid\" : 1.19674,\n\t\t\t\"ask\"
+        : 1.19686\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Mon, 14 Mar 2016 16:28:55 GMT
+  recorded_at: Mon, 08 Jan 2018 18:26:45 GMT
 - request:
     method: get
     uri: https://api-fxpractice.oanda.com/v1/prices?instruments=EUR_USD
@@ -287,16 +301,16 @@ http_interactions:
       Connection:
       - keep-alive
       Keep-Alive:
-      - 30
+      - '30'
   response:
     status:
       code: 200
       message: OK
     headers:
       Server:
-      - openresty/1.7.0.1
+      - openresty/1.9.15.1
       Date:
-      - Mon, 14 Mar 2016 16:28:56 GMT
+      - Mon, 08 Jan 2018 18:26:34 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -304,14 +318,16 @@ http_interactions:
       Connection:
       - keep-alive
       Etag:
-      - '"50c652cb079cb183ec34718d3760fd9f07cd9948"'
+      - '"f31dec3261edd9030df81dc0ba69fe5a9d4e2fc9"'
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: "{\n\t\"prices\" : [\n\t\t{\n\t\t\t\"instrument\" : \"EUR_USD\",\n\t\t\t\"time\"
-        : \"2016-03-14T16:28:49.214000Z\",\n\t\t\t\"bid\" : 1.11104,\n\t\t\t\"ask\"
-        : 1.11118\n\t\t}\n\t]\n}"
+        : \"2018-01-08T18:26:31.344805Z\",\n\t\t\t\"bid\" : 1.19674,\n\t\t\t\"ask\"
+        : 1.19686\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Mon, 14 Mar 2016 16:28:56 GMT
+  recorded_at: Mon, 08 Jan 2018 18:26:45 GMT
 - request:
     method: get
     uri: https://api-fxpractice.oanda.com/v1/prices?instruments=EUR_USD
@@ -326,16 +342,16 @@ http_interactions:
       Connection:
       - keep-alive
       Keep-Alive:
-      - 30
+      - '30'
   response:
     status:
       code: 200
       message: OK
     headers:
       Server:
-      - openresty/1.7.0.1
+      - openresty/1.9.15.1
       Date:
-      - Mon, 14 Mar 2016 16:28:58 GMT
+      - Mon, 08 Jan 2018 18:26:34 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -343,14 +359,16 @@ http_interactions:
       Connection:
       - keep-alive
       Etag:
-      - '"50c652cb079cb183ec34718d3760fd9f07cd9948"'
+      - '"f31dec3261edd9030df81dc0ba69fe5a9d4e2fc9"'
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: "{\n\t\"prices\" : [\n\t\t{\n\t\t\t\"instrument\" : \"EUR_USD\",\n\t\t\t\"time\"
-        : \"2016-03-14T16:28:49.214000Z\",\n\t\t\t\"bid\" : 1.11104,\n\t\t\t\"ask\"
-        : 1.11118\n\t\t}\n\t]\n}"
+        : \"2018-01-08T18:26:31.344805Z\",\n\t\t\t\"bid\" : 1.19674,\n\t\t\t\"ask\"
+        : 1.19686\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Mon, 14 Mar 2016 16:28:57 GMT
+  recorded_at: Mon, 08 Jan 2018 18:26:45 GMT
 - request:
     method: get
     uri: https://api-fxpractice.oanda.com/v1/prices?instruments=EUR_USD
@@ -365,16 +383,16 @@ http_interactions:
       Connection:
       - keep-alive
       Keep-Alive:
-      - 30
+      - '30'
   response:
     status:
       code: 200
       message: OK
     headers:
       Server:
-      - openresty/1.7.0.1
+      - openresty/1.9.15.1
       Date:
-      - Mon, 14 Mar 2016 16:28:59 GMT
+      - Mon, 08 Jan 2018 18:26:35 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -382,12 +400,14 @@ http_interactions:
       Connection:
       - keep-alive
       Etag:
-      - '"50c652cb079cb183ec34718d3760fd9f07cd9948"'
+      - '"f31dec3261edd9030df81dc0ba69fe5a9d4e2fc9"'
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: "{\n\t\"prices\" : [\n\t\t{\n\t\t\t\"instrument\" : \"EUR_USD\",\n\t\t\t\"time\"
-        : \"2016-03-14T16:28:49.214000Z\",\n\t\t\t\"bid\" : 1.11104,\n\t\t\t\"ask\"
-        : 1.11118\n\t\t}\n\t]\n}"
+        : \"2018-01-08T18:26:31.344805Z\",\n\t\t\t\"bid\" : 1.19674,\n\t\t\t\"ask\"
+        : 1.19686\n\t\t}\n\t]\n}"
     http_version: 
-  recorded_at: Mon, 14 Mar 2016 16:28:58 GMT
-recorded_with: VCR 3.0.1
+  recorded_at: Mon, 08 Jan 2018 18:26:45 GMT
+recorded_with: VCR 4.0.0

data/spec/oanda_api/configuration_spec.rb

@@ -72,6 +72,7 @@ describe "OandaAPI::Configuration" do
     end
   end
 
+  #---
   describe "#max_requests_per_second" do
     it "returns the default max requests per second" do
       expect(config.max_requests_per_second).to eq OandaAPI::Configuration::MAX_REQUESTS_PER_SECOND
@@ -101,6 +102,36 @@ describe "OandaAPI::Configuration" do
       expect(config.min_request_interval).to eq(0.5)
     end
   end
+  
+  describe "#max_new_connections_per_second" do
+    it "returns the default max new connections per second" do
+      expect(config.max_new_connections_per_second).to eq OandaAPI::Configuration::MAX_NEW_CONNECTIONS_PER_SECOND
+    end
+  end
+
+  describe "#max_new_connections_per_second=" do
+    it "overrides the default max new connections per second" do
+      config.max_new_connections_per_second = 5
+      expect(config.max_new_connections_per_second).to eq 5
+    end
+
+    it "must be numeric" do
+      expect { config.max_new_connections_per_second = "X" }.to raise_error(ArgumentError)
+    end
+
+    it "must be > 0" do
+      [-10, 0].each do |val|
+        expect { config.max_new_connections_per_second = val }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe "#min_new_connection_interval" do
+    it "is the inverse of #max_new_connections_per_second" do
+      config.max_new_connections_per_second = 2
+      expect(config.min_new_connection_interval).to eq(0.5)
+    end
+  end
 
   describe "#open_timeout" do
     it "returns the default open timeout" do

data/spec/oanda_api/examples/request_throttling_spec.rb

@@ -5,11 +5,13 @@ describe "OandaAPI::Client" do
   let(:client) { ClientHelper.client }
 
   around do |example|
-    reset_configuration(:use_request_throttling, :max_requests_per_second) { example.call }
+    reset_configuration(:use_request_throttling,
+                        :max_requests_per_second,
+                        :max_new_connections_per_second) { example.call }
   end
 
   context "when NOT using request throttling" do
-    it "it does NOT limit the request rate of multiple sequential requests", :vcr do
+    it "does NOT limit the request rate of multiple sequential requests", :vcr do
       OandaAPI.configuration.use_request_throttling = false
       VCR.use_cassette("without_throttling") do
         start_time = Time.now
@@ -24,11 +26,44 @@ describe "OandaAPI::Client" do
         expect(Time.now - start_time).to be > 0.0 && be < 1.0
       end
     end
+
+    #
+    # 08 Jan, 2018 - it seems connection rate limiting is not enforced consistently by Oanda
+    #                so, removing this test for now.
+    #
+    # it "does NOT limit the rate of NEW connections", :vcr do
+    #   OandaAPI.configuration.use_request_throttling = false
+    #   VCR.use_cassette("without_throttling_new_connections") do
+    #     message = ""
+    #     begin
+    #       1.upto(10) do
+    #         client = ClientHelper.client force_new: true
+    #         client.prices(instruments: "EUR_USD").get
+    #       end
+    #     rescue OandaAPI::RequestError => e
+    #       message = e.message
+    #     end
+    #     expect(message).to match(/Rate limit violation of newly established connections/)
+    #   end
+    # end
   end
 
   context "when using request throttling" do
+    it "limits the rate of NEW connections", :vcr do
+      OandaAPI.configuration.use_request_throttling = true
+      VCR.use_cassette("with_throttling_new_connections") do
+        successful_connections = 0
+        1.upto(10) do
+          client = ClientHelper.client force_new: true
+          client.accounts.get
+          successful_connections += 1
+        end
+        expect(successful_connections).to eq 10
+      end
+    end
+
     context "with a positive value set for max_requests_per_second" do
-      it "it limits multiple sequential requests to the rate specified in the requests_per_second setting " do
+      it "limits multiple sequential requests to the rate specified in the requests_per_second setting " do
         OandaAPI.configuration.use_request_throttling = true
         OandaAPI.configuration.max_requests_per_second = 2
 
@@ -47,7 +82,7 @@ describe "OandaAPI::Client" do
       end
 
       context "when multiple threads make synchronized requests to the same client instance" do
-        it "it throttles the combined requests made by all threads" do
+        it "throttles the combined requests made by all threads" do
           OandaAPI.configuration.use_request_throttling = true
           OandaAPI.configuration.max_requests_per_second = 3