oanda_api 0.9.4 → 0.9.5

data/spec/oanda_api/client/namespace_proxy_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe "OandaAPI::Client::NamespaceProxy" do
-  let(:client) { OandaAPI::Client::UsernameClient.new("spongebob") }
+  let(:client) { (Class.new { include OandaAPI::Client }).new }
   let(:namespace_proxy) { OandaAPI::Client::NamespaceProxy.new client, "account" }
 
   describe "#initialize" do

data/spec/oanda_api/client/resource_descriptor_spec.rb

@@ -3,33 +3,52 @@ require 'spec_helper'
 describe "OandaAPI::Client::ResourceDescriptor" do
   describe "#initialize" do
     let(:resource_descriptor) { OandaAPI::Client::ResourceDescriptor.new "/accounts", :get }
-    it "sets path" do
+
+    it "sets the path " do
       expect(resource_descriptor.path).to eq("/accounts")
     end
 
-    context 'when path resource is equal alltransactions' do
-      let(:resource_descriptor) { OandaAPI::Client::ResourceDescriptor.new "/account/123/alltransactions", :get }
+    context "non-standard (special case) resources" do
+      describe "special case: '/alltransactions'" do
+        let(:resource_descriptor) { OandaAPI::Client::ResourceDescriptor.new "/account/123/alltransactions", :get }
+
+        it "sets TransactionHistory as its resource_klass" do
+          expect(resource_descriptor.resource_klass).to eq(OandaAPI::Resource::TransactionHistory)
+        end
 
-      it 'is sets TransactionHistory as resource_klass' do
-        expect(resource_descriptor.resource_klass).to eq(OandaAPI::Resource::TransactionHistory)
+        it "sets @is_collection to false" do
+          expect(resource_descriptor.is_collection?).to be false
+        end
       end
 
-      it 'is sets @is_collection to false' do
-        expect(resource_descriptor.is_collection?).to be false
+      describe "special case: '/calendar'" do
+        let(:resource_descriptor) { OandaAPI::Client::ResourceDescriptor.new "/calendar", :get }
+
+        it "sets CalendarEvents as its resource_klass" do
+          expect(resource_descriptor.resource_klass).to eq(OandaAPI::Resource::Labs::CalendarEvent)
+        end
+
+        it "sets @is_collection to true, despite its path name being singular" do
+          expect(resource_descriptor.is_collection?).to be true
+        end
       end
-    end
-  end
 
-  context "when the path ends with a known resource" do
-    let(:resource_descriptor) { OandaAPI::Client::ResourceDescriptor.new "/account/123/orders", :get }
+      describe "special case: '/calendar_events'" do
+        let(:resource_descriptor) { OandaAPI::Client::ResourceDescriptor.new "/calendar_events", :get }
 
-    describe "#resource_klass" do
-      it "is the requested resource class" do
-        expect(resource_descriptor.resource_klass).to be(OandaAPI::Resource::Order)
+        it "uses /calendar as the true API resource name" do
+          expect(resource_descriptor.path).to eq "/calendar"
+        end
       end
     end
   end
 
+  context "when the path ends with an unknown resource" do
+    it "doesn't allow invalid resources" do
+      expect { OandaAPI::Client::ResourceDescriptor.new "/invalid_resource" }.to raise_error(ArgumentError)
+    end
+  end
+
   describe "#is_collection?" do
     it "is true for GET requests without a resource id" do
       resource_descriptor = OandaAPI::Client::ResourceDescriptor.new "/account/123/orders", :get
@@ -48,4 +67,16 @@ describe "OandaAPI::Client::ResourceDescriptor" do
       end
     end
   end
+
+  describe "#labs?" do
+    it "is true for 'Labs' resources" do
+      resource_descriptor = OandaAPI::Client::ResourceDescriptor.new "/calendar", :get
+      expect(resource_descriptor.labs?).to be true
+    end
+
+    it "is false for non 'Labs' resources" do
+      resource_descriptor = OandaAPI::Client::ResourceDescriptor.new "/account", :get
+      expect(resource_descriptor.labs?).to be false
+    end
+  end
 end

data/spec/oanda_api/configuration_spec.rb

@@ -59,6 +59,19 @@ describe "OandaAPI::Configuration" do
     end
   end
 
+  describe "#labs_api_version" do
+    it "returns the default Labs api version" do
+      expect(config.labs_api_version).to eq OandaAPI::Configuration::LABS_API_VERSION
+    end
+  end
+
+  describe "#labs_api_version=" do
+    it "overrides the default Labs api version" do
+      config.labs_api_version = "X"
+      expect(config.labs_api_version).to eq "X"
+    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

data/spec/oanda_api/examples/accounts_spec.rb

@@ -4,13 +4,6 @@ require 'support/client_helper'
 describe "OandaAPI::Resource::Account" do
   let(:client) { ClientHelper.client }
 
-  it "creates a new account" do
-    VCR.use_cassette("accounts.create") do
-      account = client.accounts.create
-      expect(account).to be_an OandaAPI::Resource::Account
-    end
-  end
-
   it "gets all accounts", :vcr do
     VCR.use_cassette("accounts.get") do
       accounts = client.accounts.get

data/spec/oanda_api/examples/calendar_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'support/client_helper'
+
+describe "OandaAPI::Resource::Labs::CalendarEvent" do
+  let(:client) { ClientHelper.client }
+
+  it "gets economic calendar events related to an instrument", :vcr do
+    VCR.use_cassette("calendar(instrument_and_period).get") do
+      events = client.calendar(instrument: "EUR_CAD", period: 604800).get
+      expect(events.first).to be_an OandaAPI::Resource::Labs::CalendarEvent
+    end
+  end
+
+  it "gets all economic calendar events for a period", :vcr do
+    VCR.use_cassette("calendar(period).get") do
+      events = client.calendar(period: 86400).get
+      expect(events.first).to be_an OandaAPI::Resource::Labs::CalendarEvent
+    end
+  end
+
+  it "can use the alias: calendar_events", :vcr do
+    VCR.use_cassette("calendar_events(period).get") do
+      events = client.calendar_events(period: 86400).get
+      expect(events.first).to be_an OandaAPI::Resource::Labs::CalendarEvent
+    end
+  end
+end

data/spec/oanda_api/examples/orders_spec.rb

@@ -3,10 +3,10 @@ require 'support/client_helper'
 
 describe "OandaAPI::Resource::Order" do
   let(:account) { ClientHelper.account }
-  let(:price)   { ClientHelper.instrument("EUR_USD").bid - 0.1 }
+  let(:price)  { ->(instrument) { ClientHelper.instrument(instrument).bid - 0.1 } }
 
   it "creates an order", :vcr do
-    VCR.use_cassette("account(id).order(options).create") do
+    VCR.use_cassette("order(options).create") do
       order = account.order(instrument: "EUR_USD",
                                   type: "market",
                                   side: "buy",
@@ -17,16 +17,16 @@ describe "OandaAPI::Resource::Order" do
   end
 
   it "gets all open orders", :vcr do
-    VCR.use_cassette("account(id).orders.get") do
-      ClientHelper.create_order(type: "limit", price: price)
+    VCR.use_cassette("orders.get") do
+      ClientHelper.create_order(type: "limit", instrument: "EUR_USD", price: price["EUR_USD"])
       orders = account.orders.get
       expect(orders.first).to be_an OandaAPI::Resource::Order
     end
   end
 
   it "gets a filtered list of open orders", :vcr do
-    VCR.use_cassette("account(id).orders(options).get") do
-      ClientHelper.create_order(instrument: "USD_JPY", type: "limit", price: price)
+    VCR.use_cassette("orders(options).get") do
+      ClientHelper.create_order(type: "limit", instrument: "USD_JPY", price: price["USD_JPY"])
 
       orders = account.orders(instrument: "USD_JPY").get
       expect(orders.first).to be_an OandaAPI::Resource::Order
@@ -34,8 +34,8 @@ describe "OandaAPI::Resource::Order" do
   end
 
   it "gets a specific open order", :vcr do
-    VCR.use_cassette("account(id).order(id).get") do
-      order_id = ClientHelper.create_order(type: "limit", price: price)
+    VCR.use_cassette("order(id).get") do
+      order_id = ClientHelper.create_order(type: "limit", instrument: "EUR_USD", price: price["EUR_USD"])
                              .order_opened
                              .id
       expect(account.order(order_id).get).to be_an OandaAPI::Resource::Order
@@ -43,8 +43,8 @@ describe "OandaAPI::Resource::Order" do
   end
 
   it "modifies an open order", :vcr do
-    VCR.use_cassette("account(id).order(options).update") do
-      order_id = ClientHelper.create_order(type: "limit", price: price)
+    VCR.use_cassette("order(options).update") do
+      order_id = ClientHelper.create_order(type: "limit", instrument: "EUR_USD", price: price["EUR_USD"])
                              .order_opened
                              .id
       updated_order = account.order(id: order_id, units: 9_000).update
@@ -53,8 +53,8 @@ describe "OandaAPI::Resource::Order" do
   end
 
   it "closes an open order", :vcr do
-    VCR.use_cassette("account(id).order(id).close") do
-      order_id = ClientHelper.create_order(type: "limit", price: price)
+    VCR.use_cassette("order(id).close") do
+      order_id = ClientHelper.create_order(type: "limit", instrument: "EUR_USD", price: price["EUR_USD"])
                              .order_opened
                              .id
       before_order_ids = account.orders.get.map(&:id)

data/spec/oanda_api/examples/positions_spec.rb

@@ -5,7 +5,7 @@ describe "OandaAPI::Resource::Position" do
   let(:account) { ClientHelper.account }
 
   it "gets all open positions", :vcr do
-    VCR.use_cassette("account(id).positions.get") do
+    VCR.use_cassette("positions.get") do
       ClientHelper.create_trade
       positions = account.positions.get
       expect(positions.first).to be_an OandaAPI::Resource::Position
@@ -13,7 +13,7 @@ describe "OandaAPI::Resource::Position" do
   end
 
   it "gets the position for an instrument", :vcr do
-    VCR.use_cassette("account(id).positions(instrument).get") do
+    VCR.use_cassette("positions(instrument).get") do
       ClientHelper.create_trade(instrument: "USD_JPY")
       position = account.positions("USD_JPY").get
       expect(position).to be_an OandaAPI::Resource::Position
@@ -21,7 +21,7 @@ describe "OandaAPI::Resource::Position" do
   end
 
   it "closes an existing position", :vcr do
-    VCR.use_cassette("account(id).positions(instrument).close") do
+    VCR.use_cassette("positions(instrument).close") do
       ClientHelper.create_trade(instrument: "USD_JPY")
 
       # Verify we have an open position.

data/spec/oanda_api/examples/rates_spec.rb

@@ -3,18 +3,20 @@ require 'support/client_helper'
 
 describe "OandaAPI::Resource" do
   let(:client) { ClientHelper.client }
+  let(:account) { ClientHelper.account }
 
   describe "Instrument" do
     it "gets all instruments", :vcr do
       VCR.use_cassette("instruments.get") do
-        instruments = client.instruments.get
+        instruments = client.instruments(account_id: ClientHelper.account_id).get
         expect(instruments.first).to be_an OandaAPI::Resource::Instrument
       end
     end
 
     it "gets a filtered list of instruments", :vcr do
       VCR.use_cassette("instruments(options).get") do
-        instruments = client.instruments(instruments: %w(EUR_USD EUR_CAD),
+        instruments = client.instruments( account_id: ClientHelper.account_id,
+                                         instruments: %w(EUR_USD EUR_CAD),
                                               fields: %w(pip precision))
                             .get
         expect(instruments.first).to be_an OandaAPI::Resource::Instrument

data/spec/oanda_api/examples/spread_history_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'support/client_helper'
+
+describe "OandaAPI::Resource::Labs::SpreadHistory" do
+  let(:client) { ClientHelper.client }
+
+  it "gets spread history for an instrument and a period", :vcr do
+    VCR.use_cassette("spreads.get") do
+      spread_history = client.spreads(instrument: "EUR_CAD", period: 3600).get
+      expect(spread_history).to be_an OandaAPI::Resource::Labs::SpreadHistory
+
+      expect(spread_history.averages.first.spread).to be_a Numeric
+      expect(spread_history.averages.first.timestamp).to be_a Fixnum
+      expect(spread_history.averages.first.time).to be_a Time
+
+      expect(spread_history.maximums.first.spread).to be_a Numeric
+      expect(spread_history.maximums.first.timestamp).to be_a Fixnum
+      expect(spread_history.maximums.first.time).to be_a Time
+
+      expect(spread_history.minimums.first.spread).to be_a Numeric
+      expect(spread_history.minimums.first.timestamp).to be_a Fixnum
+      expect(spread_history.minimums.first.time).to be_a Time
+    end
+  end
+
+  it "can use the alias: spread_history", :vcr do
+    VCR.use_cassette("spread_history.get") do
+      spread_history = client.spread_history(instrument: "EUR_CAD", period: 3600).get
+      expect(spread_history).to be_an OandaAPI::Resource::Labs::SpreadHistory
+    end
+  end
+end

data/spec/oanda_api/examples/trades_spec.rb

@@ -5,7 +5,7 @@ describe "OandaAPI::Resource::Trade" do
   let(:account) { ClientHelper.account }
 
   it "gets a list of trades", :vcr do
-    VCR.use_cassette("account(id).trades.get") do
+    VCR.use_cassette("trades.get") do
       ClientHelper.create_trade
       trades = account.trades.get
       expect(trades.first).to be_an OandaAPI::Resource::Trade
@@ -13,7 +13,7 @@ describe "OandaAPI::Resource::Trade" do
   end
 
   it "gets a filtered list of trades", :vcr do
-    VCR.use_cassette("account(id).trades(filter).get") do
+    VCR.use_cassette("trades(filter).get") do
       ClientHelper.create_trade(instrument: "USD_JPY")
       trades = account.trades(instrument: "USD_JPY").get
       expect(trades.first).to be_an OandaAPI::Resource::Trade
@@ -21,7 +21,7 @@ describe "OandaAPI::Resource::Trade" do
   end
 
   it "gets information on a specific trade", :vcr do
-    VCR.use_cassette("account(id).trade(id).get") do
+    VCR.use_cassette("trade(id).get") do
       trade_id = ClientHelper.create_trade.trade_opened.id
       trade = account.trade(trade_id).get
       expect(trade).to be_an OandaAPI::Resource::Trade
@@ -29,7 +29,7 @@ describe "OandaAPI::Resource::Trade" do
   end
 
   it "modifies an open trade " do
-    VCR.use_cassette("account(id).trade(options).modify") do
+    VCR.use_cassette("trade(options).modify") do
       order = ClientHelper.create_trade
       modified_order =
         account.trade(id: order.trade_opened.id, take_profit: order.price + 2.0)
@@ -39,7 +39,7 @@ describe "OandaAPI::Resource::Trade" do
   end
 
   it "closes an open trade" do
-    VCR.use_cassette("account(id).trade(id).close") do
+    VCR.use_cassette("trade(id).close") do
       ClientHelper.create_trade(instrument: "USD_JPY").trade_opened.id
 
       # Get the oldest open trade for USD_JPY, so we can close that trade.

data/spec/oanda_api/examples/transactions_spec.rb

@@ -5,7 +5,7 @@ describe "OandaAPI::Transaction" do
   let(:account) { ClientHelper.account }
 
   it "gets transaction history" do
-    VCR.use_cassette("account(id).transactions(options).get") do
+    VCR.use_cassette("transactions(options).get") do
       ClientHelper.create_trade(instrument: "USD_JPY")
       transactions = account.transactions(instrument: "USD_JPY").get
       expect(transactions.first).to be_an OandaAPI::Resource::Transaction
@@ -13,7 +13,7 @@ describe "OandaAPI::Transaction" do
   end
 
   it "gets information for a specific transaction" do
-    VCR.use_cassette("account(id).transaction(id).get") do
+    VCR.use_cassette("transaction(id).get") do
       ClientHelper.create_trade(instrument: "USD_JPY")
       id = account.transactions(instrument: "USD_JPY").get.first.id
       transaction = account.transaction(id).get

data/spec/oanda_api/resource_base_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 describe "OandaAPI::ResourceBase" do
-  class MyClass < OandaAPI::ResourceBase
+  class SomeResource < OandaAPI::ResourceBase
     attr_accessor :webbed_feet
   end
 
-  class MyCustomizedClass < OandaAPI::ResourceBase
+  class SomeResourceCustomized < OandaAPI::ResourceBase
     attr_accessor :webbed_feet
 
     def custom_attributes
@@ -12,40 +12,80 @@ describe "OandaAPI::ResourceBase" do
     end
   end
 
+  describe ".class_from_symbol" do
+    it "returns the Class for a resource name" do
+      expect(OandaAPI::ResourceBase.class_from_symbol(:account)).to be OandaAPI::Resource::Account
+    end
+
+    let(:baby_klass) { module OandaAPI; class Mama < OandaAPI::ResourceBase; end; end; module OandaAPI; class Baby < Mama; end; end; OandaAPI::Baby }
+    it "works for any resource that decends from OandaAPI::ResourceBase" do
+      expect(baby_klass).to be OandaAPI::Baby
+      expect(OandaAPI::ResourceBase.class_from_symbol(:baby)).to be baby_klass
+    end
+  end
+
+  describe ".labs_resource?" do
+    it "is true for a 'Labs' resource" do
+      expect(OandaAPI::ResourceBase.labs_resource?(OandaAPI::Resource::Labs::CalendarEvent)).to be true
+    end
+
+    it "is false for a non 'Labs' resource" do
+      expect(OandaAPI::ResourceBase.labs_resource?(OandaAPI::Resource::Account)).to be false
+    end
+
+    let(:flux_capacitor_klass) { module OandaAPI; module Resource; module Labs; module RocketScience class FluxCapacitor < OandaAPI::ResourceBase; end; end; end; end; end; OandaAPI::Resource::Labs::RocketScience::FluxCapacitor }
+    it "works for any resource under the Labs:: namespace" do
+      expect(flux_capacitor_klass).to be OandaAPI::Resource::Labs::RocketScience::FluxCapacitor
+      expect(OandaAPI::ResourceBase.labs_resource?(flux_capacitor_klass)).to be true
+    end
+  end
+
+  describe ".pluralize" do
+    it "pluralizes resource class names" do
+      expect(OandaAPI::ResourceBase.pluralize(:account)).to eq "accounts"
+    end
+
+    it "doesn't pluralize resource name exceptions (these are never pluralized in the API)" do
+      OandaAPI::ResourceBase::NOT_PLURALIZED.each do |special_case_resource|
+        expect(OandaAPI::ResourceBase.pluralize(special_case_resource)).to eq special_case_resource.to_s
+      end
+    end
+  end
+
   describe "#initialize" do
     it "initializes writer methods with matching attributes" do
-      obj = MyClass.new webbed_feet: "webbed feet"
+      obj = SomeResource.new webbed_feet: "webbed feet"
       expect(obj.webbed_feet).to eq "webbed feet"
     end
 
     it "initializes snake_case writer methods with matching camelCase attributes" do
-      obj = MyClass.new webbedFeet: "webbed feet"
+      obj = SomeResource.new webbedFeet: "webbed feet"
       expect(obj.webbed_feet).to eq "webbed feet"
     end
   end
 
   describe "#location" do
     it "sets location" do
-      obj = MyClass.new location: "location"
+      obj = SomeResource.new location: "location"
       expect(obj.location).to eq "location"
     end
   end
 
   describe "#to_json" do
     it "serializes all of an instance's attributes" do
-      obj = MyClass.new webbedFeet: "webbed feet", location: "location", extraAttribute: "extra"
+      obj = SomeResource.new webbedFeet: "webbed feet", location: "location", extraAttribute: "extra"
       h = JSON.parse obj.to_json
       expect(h).to include("webbed_feet" => "webbed feet", "extra_attribute" => "extra", "location" => "location")
     end
 
     it "serializes all of an instance's customized attributes" do
-      obj = MyCustomizedClass.new webbedFeet: "webbed feet"
+      obj = SomeResourceCustomized.new webbedFeet: "webbed feet"
       h = JSON.parse obj.to_json
       expect(h).to include("webbed_feet" => "customized webbed feet")
     end
 
     it "serializes when nested" do
-      obj = MyCustomizedClass.new webbedFeet: "webbed feet"
+      obj = SomeResourceCustomized.new webbedFeet: "webbed feet"
       a = JSON.parse [obj].to_json
       expect(a.first).to include("webbed_feet" => "customized webbed feet")
     end