questrade_api 0.0.1 → 0.0.2

data/lib/questrade_api/version.rb

@@ -1,3 +1,3 @@
 module QuestradeApi
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

data/questrade_api.gemspec

@@ -18,9 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
+  spec.required_ruby_version     = '>= 2.0.0'
+
   spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'webmock', '~> 2.3'
   spec.add_development_dependency 'rubocop', '~> 0.47'

data/spec/fixtures/json/accounts.json

@@ -0,0 +1,21 @@
+{
+  "accounts": [
+    {
+      "type": "Margin",
+      "number": "26598145",
+      "status": "Active",
+      "isPrimary": true,
+      "isBilling": true,
+      "clientAccountType": "Individual"
+    },
+    {
+      "type": "Margin",
+      "number": "11122233",
+      "status": "Active",
+      "isPrimary": false,
+      "isBilling": true,
+      "clientAccountType": "Individual"
+    }
+  ],
+  "userId": "123456"
+}

data/spec/fixtures/json/activities.json

@@ -0,0 +1,36 @@
+{
+  "activities": [
+    {
+      "tradeDate": "2011-02-16T00:00:00.000000-05:00",
+      "transactionDate": "2011-02-16T00:00:00.000000-05:00",
+      "settlementDate": "2011-02-16T00:00:00.000000-05:00",
+      "action": "",
+      "symbol": "",
+      "symbolId": 0,
+      "description": "INT FR 02/04 THRU02/15@ 4 3/4%BAL  205,006   AVBAL  204,966 ",
+      "currency": "USD",
+      "quantity": 0,
+      "price": 0,
+      "grossAmount": 0,
+      "commission": 0,
+      "netAmount": -320.08,
+      "type": "Interest"
+    },
+    {
+      "tradeDate": "2011-01-16T00:00:00.000000-05:00",
+      "transactionDate": "2011-01-16T00:00:00.000000-05:00",
+      "settlementDate": "2011-01-16T00:00:00.000000-05:00",
+      "action": "",
+      "symbol": "",
+      "symbolId": 0,
+      "description": "INT FR 02/04 THRU02/15@ 4 3/4%BAL  205,006   AVBAL  204,966 ",
+      "currency": "USD",
+      "quantity": 0,
+      "price": 0,
+      "grossAmount": 0,
+      "commission": 0,
+      "netAmount": 120.08,
+      "type": "Interest"
+    }
+  ]
+}

data/spec/fixtures/json/balances.json

@@ -0,0 +1,55 @@
+{
+  "perCurrencyBalances": [
+    {
+      "currency": "CAD",
+      "cash": 243971.7,
+      "marketValue": 6017,
+      "totalEquity": 249988.7,
+      "buyingPower": 496367.2,
+      "maintenanceExcess": 248183.6,
+      "isRealTime": false
+    },
+    {
+      "currency": "USD",
+      "cash": 198259.05,
+      "marketValue": 53745,
+      "totalEquity": 252004.05,
+      "buyingPower": 461013.3,
+      "maintenanceExcess": 230506.65,
+      "isRealTime": false
+    }
+  ],
+  "combinedBalances": [
+    {
+      "currency": "CAD",
+      "cash": 243971.7,
+      "marketValue": 6017,
+      "totalEquity": 249988.7,
+      "buyingPower": 496367.2,
+      "maintenanceExcess": 248183.6,
+      "isRealTime": true
+    }
+  ],
+  "sodPerCurrencyBalances": [
+    {
+      "currency": "USD",
+      "cash": 243971.7,
+      "marketValue": 6017,
+      "totalEquity": 249988.7,
+      "buyingPower": 496367.2,
+      "maintenanceExcess": 248183.6,
+      "isRealTime": false
+    }
+  ],
+  "sodCombinedBalances": [
+    {
+      "currency": "CAD",
+      "cash": 243971.8,
+      "marketValue": 6017,
+      "totalEquity": 249988.7,
+      "buyingPower": 496367.2,
+      "maintenanceExcess": 248183.6,
+      "isRealTime": false
+    }
+  ]
+}

data/spec/fixtures/json/executions.json

@@ -0,0 +1,46 @@
+{
+  "executions": [
+    {
+      "symbol": "AAPL",
+      "symbolId": 8049,
+      "quantity": 10,
+      "side": "Buy",
+      "price": 536.87,
+      "id": 53817310,
+      "orderId": 177106005,
+      "orderChainId": 177106005,
+      "exchangeExecId": "XS1771060050147",
+      "timestamp": "2014-03-31T13:38:29.000000-04:00",
+      "notes": "",
+      "venue": "LAMP",
+      "totalCost": 5368.7,
+      "orderPlacementCommission": 0,
+      "commission": 4.95,
+      "executionFee": 0,
+      "secFee": 0,
+      "canadianExecutionFee": 0,
+      "parentId": 0
+    },
+    {
+      "symbol": "GOOGL",
+      "symbolId": 8048,
+      "quantity": 11,
+      "side": "Buy",
+      "price": 531.87,
+      "id": 53817311,
+      "orderId": 177106015,
+      "orderChainId": 177106015,
+      "exchangeExecId": "XS1773060050147",
+      "timestamp": "2014-03-31T13:38:29.000000-04:00",
+      "notes": "",
+      "venue": "LAMP",
+      "totalCost": 5268.7,
+      "orderPlacementCommission": 0,
+      "commission": 2.95,
+      "executionFee": 0,
+      "secFee": 0,
+      "canadianExecutionFee": 0,
+      "parentId": 0
+    }
+  ]
+}

data/spec/fixtures/json/markets.json

@@ -0,0 +1,34 @@
+{
+  "markets": [
+    {
+      "name": "TSX",
+      "tradingVenues": [
+        "TSX",
+        "ALPH",
+        "CHIC",
+        "OMGA",
+        "PURE"
+      ],
+      "defaultTradingVenue": "AUTO",
+      "primaryOrderRoutes": [
+        "AUTO"
+      ],
+      "secondaryOrderRoutes": [
+        "TSX",
+        "AUTO"
+      ],
+      "level1Feeds": [
+        "ALPH",
+        "CHIC",
+        "OMGA",
+        "PURE",
+        "TSX"
+      ],
+      "extendedStartTime": "2014-10-06T07:00:00.000000-04:00",
+      "startTime": "2014-10-06T09:30:00.000000-04:00",
+      "endTime": "2014-10-06T16:00:00.000000-04:00",
+      "currency": "CAD",
+      "snapQuotesLimit": 99999
+    }
+  ]
+}

data/spec/fixtures/json/orders.json

@@ -0,0 +1,49 @@
+{
+  "orders": [
+    {
+      "id": 173577870,
+      "symbol": "AAPL",
+      "symbolId": 8049,
+      "totalQuantity": 100,
+      "openQuantity": 100,
+      "filledQuantity": 0,
+      "canceledQuantity": 0,
+      "side": "Buy",
+      "type": "Limit",
+      "limitPrice": 500.95,
+      "stopPrice": null,
+      "isAllOrNone": false,
+      "isAnonymous": false,
+      "icebergQty": null,
+      "minQuantity": null,
+      "avgExecPrice": null,
+      "lastExecPrice": null,
+      "source": "TradingAPI",
+      "timeInForce": "Day",
+      "gtdDate": null,
+      "state": "Canceled",
+      "clientReasonStr": "",
+      "chainId": 173577870,
+      "creationTime": "2014-10-23T20:03:41.636000-04:00",
+      "updateTime": "2014-10-23T20:03:42.890000-04:00",
+      "notes": "",
+      "primaryRoute": "AUTO",
+      "secondaryRoute": "",
+      "orderRoute": "LAMP",
+      "venueHoldingOrder": "",
+      "comissionCharged": 0,
+      "exchangeOrderId": "XS173577870",
+      "isSignificantShareHolder": false,
+      "isInsider": false,
+      "isLimitOffsetInDollar": false,
+      "userId":  3000124,
+      "placementCommission": null,
+      "legs": [],
+      "strategyType": "SingleLeg",
+      "triggerStopPrice": null,
+      "orderGroupId": 0,
+      "orderClass": null,
+      "mainChainId": 0
+    }
+  ]
+}

data/spec/fixtures/json/positions.json

@@ -0,0 +1,17 @@
+{
+  "positions": [
+    {
+      "symbol": "THI.TO",
+      "symbolId": 38738 ,
+      "openQuantity": 100,
+      "currentMarketValue": 6017,
+      "currentPrice": 60.17,
+      "averageEntryPrice": 60.23,
+      "closedPnl": 0,
+      "openPnl": -6,
+      "totalCost": false,
+      "isRealTime": "Individual",
+      "isUnderReorg": false
+    }
+  ]
+}

data/spec/fixtures/json/time.json

@@ -0,0 +1,3 @@
+{
+  "time": "2017-01-24T12:14:42.730000-04:00"
+}

data/spec/questrade_api/authorization_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+require 'questrade_api/authorization'
+
+describe QuestradeApi::Authorization do
+  let(:access_token) { 'XXXX' }
+  let(:api_server) { 'http://test.com' }
+  let(:expires_in) { 123 }
+  let(:refresh_token) { 'AAAAA' }
+  let(:token_type) { 'refresh_token' }
+  let(:data) do
+    {
+      access_token: access_token,
+      api_server: api_server,
+      expires_in: expires_in,
+      refresh_token: refresh_token,
+      token_type: token_type
+    }
+  end
+
+  context '#initialize' do
+    it 'only accepts :live or :practice mode' do
+      expect { QuestradeApi::Authorization.new(data) }.to_not raise_error
+      expect { QuestradeApi::Authorization.new(data, :practice) }.to_not raise_error
+      expect { QuestradeApi::Authorization.new(data, :live) }.to_not raise_error
+
+      expect { QuestradeApi::Authorization.new(data, :other) }.to raise_error('Mode must be :live or :practice')
+    end
+
+    it 'populates attributes accordingly with practice mode as default' do
+      subject = QuestradeApi::Authorization.new(data)
+
+      expect(subject.mode).to eq(:practice)
+      expect(subject.connection).to be_a(Faraday::Connection)
+
+      expect(subject.data.access_token).to eq(access_token)
+      expect(subject.data.api_server).to eq(api_server)
+      expect(subject.data.expires_in).to eq(expires_in)
+      expect(subject.data.refresh_token).to eq(refresh_token)
+      expect(subject.data.token_type).to eq(token_type)
+    end
+  end
+
+  context '#refresh_token' do
+  end
+
+  context '#access_token' do
+    subject { QuestradeApi::Authorization.new(data) }
+
+    it 'returns value of #data.access_token' do
+      expect(subject.access_token).to eq(access_token)
+    end
+  end
+
+  context '#url' do
+    subject { QuestradeApi::Authorization.new(data) }
+
+    it 'returns value of #data.api_server' do
+      expect(subject.url).to eq(api_server)
+    end
+  end
+
+  context '#live?' do
+    it 'returns true if live' do
+      subject = QuestradeApi::Authorization.new(data, :live)
+      expect(subject.live?).to be_truthy
+    end
+
+    it 'returns false if practice' do
+      subject = QuestradeApi::Authorization.new(data)
+      expect(subject.live?).to be_falsy
+    end
+  end
+end

data/spec/questrade_api/client_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+require 'questrade_api/client'
+
+describe QuestradeApi::Client do
+  let(:refresh_token) { 'XXXXX' }
+  let(:api_server) { 'http://test.com' }
+  let(:access_token) { 'ABCDEF' }
+
+  context '#initialize' do
+    it 'refreshes token if refresh_token is present, and api_server and access_token are not'  do
+      expect_any_instance_of(QuestradeApi::Client).to receive(:refresh_token).once
+      QuestradeApi::Client.new(refresh_token: refresh_token)
+    end
+
+    it 'does not refreshes token if refresh_token is present, and api_server and/or access_token are'  do
+      expect_any_instance_of(QuestradeApi::Client).to receive(:refresh_token).never
+      QuestradeApi::Client.new(refresh_token: refresh_token,
+                               api_server: api_server)
+
+      QuestradeApi::Client.new(refresh_token: refresh_token,
+                               access_token: access_token)
+
+      QuestradeApi::Client.new(refresh_token: refresh_token,
+                               api_server: api_server,
+                               access_token: access_token)
+    end
+  end
+
+  context '#refresh_token' do
+    it 'calls authorization refresh token' do
+      client = QuestradeApi::Client.new(refresh_token: refresh_token, access_token: access_token)
+      expect(client.authorization).to receive(:refresh_token).once
+
+      client.refresh_token
+    end
+  end
+end

data/spec/questrade_api/rest/account_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+require 'questrade_api/rest/account'
+
+describe QuestradeApi::REST::Account do
+  include JSONFixtures
+
+  let(:access_token) { 'XXXX' }
+  let(:url) { 'http://test.com'}
+  let(:authorization) { OpenStruct.new(access_token: access_token, url: url) }
+
+  context 'instance methods' do
+    let(:id) { '123' }
+    subject { QuestradeApi::REST::Account.new(authorization, id: id) }
+
+    it 'returns a list of activities' do
+      expect(QuestradeApi::REST::Activity)
+        .to(receive(:all).with(authorization, id, {}))
+        .once
+
+      subject.activities({})
+    end
+
+    it 'returns a list of executions' do
+      expect(QuestradeApi::REST::Execution)
+        .to(receive(:all).with(authorization, id, {}))
+        .once
+
+      subject.executions({})
+    end
+
+    it 'returns a list of positions' do
+      expect(QuestradeApi::REST::Position)
+        .to(receive(:all).with(authorization, id))
+        .once
+
+      subject.positions
+    end
+
+    it 'returns a list of balances' do
+      expect(QuestradeApi::REST::Balance)
+        .to(receive(:all).with(authorization, id))
+        .once
+
+      subject.balances
+    end
+  end
+
+  context '.all' do
+    it "returns an object that contains a list of all user's accounts" do
+      full_url = url + QuestradeApi::REST::Account.endpoint
+      stub_request(:get, full_url).to_return(status: 200,
+                                             body: json_string('accounts.json'),
+                                             headers: {})
+
+      response = QuestradeApi::REST::Account.all(authorization)
+
+      expect(response.accounts.size).to be(2)
+
+      first_account = response.accounts.first
+      expect(first_account.id).to eq('26598145')
+      expect(first_account.user_id).to eq('123456')
+      expect(first_account.data.to_h).to eq(type:'Margin',
+                                            number: '26598145',
+                                            status: 'Active',
+                                            is_primary: true,
+                                            is_billing: true,
+                                            client_account_type: 'Individual')
+
+      second_account = response.accounts.last
+      expect(second_account.id).to eq('11122233')
+      expect(second_account.user_id).to eq('123456')
+      expect(second_account.data.to_h).to eq(type:'Margin',
+                                            number: '11122233',
+                                            status: 'Active',
+                                            is_primary: false,
+                                            is_billing: true,
+                                            client_account_type: 'Individual')
+    end
+  end
+
+  context '.endpoint' do
+    it 'calls right endpoint' do
+      url = '/v1/accounts'
+      expect(QuestradeApi::REST::Account.endpoint).to eq(url)
+    end
+  end
+end