tdameritrade-api-ruby 1.3.0.20210215

data/spec/support/spec/mocks/tdameritrade_api_mock_base.rb

@@ -0,0 +1,21 @@
+module TDAmeritrade; module Spec; module Mocks
+  class TDAmeritradeMockBase
+
+    API_BASE_URL = 'https://api.tdameritrade.com/v1'
+
+    def self.build_url_params(request)
+      # Need to do this to get around a WebMock encoding bug. It's looking for 'APIKEY@AMER.OAUTHAP' when it
+      # should be looking for 'APIKEY%40AMER.OAUTHAP'
+      if request[:query]
+        "?" + request.delete(:query).map { |k,v| "#{k}=#{CGI::escape(v)}" }.join('&')
+      else
+        ''
+      end
+    end
+
+    def self.webmock_off?
+      WebMock.net_connect_allowed?
+    end
+
+  end
+end; end; end

data/spec/support/webmock_off.rb

@@ -0,0 +1,7 @@
+# Include this context if you want to do a live test. Be sure to enter actual connection details in
+# authenticated_client.rb so that it authenticates.
+shared_context 'webmock off' do
+  before do
+    WebMock.allow_net_connect!
+  end
+end

data/spec/tdameritrade/operations/create_watchlist_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'support/authenticated_client'
+require 'tdameritrade'
+
+describe TDAmeritrade::Operations::CreateWatchlist do
+  include_context 'authenticated client'
+  # include_context 'webmock off'
+
+  context 'for single account' do
+    subject do
+      client.create_watchlist(account_id, 'My New Watchlist', %w(AAPL MSFT VZ))
+    end
+
+    let(:account_id) { '123456789' }
+
+    let!(:expected_request) do
+      TDAmeritrade::Spec::Mocks::MockWatchlists.mock_create(
+        account_id,
+        request: {
+          headers: { 'Authorization': "Bearer #{client.access_token}" },
+          body: expected_request_body
+        }
+      )
+    end
+
+    let(:expected_request_body) do
+      {
+        :name=>"My New Watchlist",
+        :watchlistItems=>
+          [
+            {:quantity=>0, :averagePrice=>0, :commission=>0, :purchasedDate=>Date.today.strftime('%Y-%m-%d'), :instrument=>{:symbol=>"AAPL", :assetType=>"EQUITY"}},
+            {:quantity=>0, :averagePrice=>0, :commission=>0, :purchasedDate=>Date.today.strftime('%Y-%m-%d'), :instrument=>{:symbol=>"MSFT", :assetType=>"EQUITY"}},
+            {:quantity=>0, :averagePrice=>0, :commission=>0, :purchasedDate=>Date.today.strftime('%Y-%m-%d'), :instrument=>{:symbol=>"VZ", :assetType=>"EQUITY"}}
+          ]
+      }.to_json
+    end
+
+    it { is_expected.to be_truthy }
+  end
+
+
+end

data/spec/tdameritrade/operations/error_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'support/authenticated_client'
+require 'tdameritrade'
+
+describe TDAmeritrade::Error do
+  include_context 'authenticated client'
+  # include_context 'webmock off'
+
+  context 'rate limit error' do
+    subject do
+      client.get_quotes(symbols)
+    end
+
+    let(:symbols) { %w(PG MSFT CVX) }
+
+    let!(:expected_request) do
+      TDAmeritrade::Spec::Mocks::MockGetQuotes.mock_find(
+        request: {
+          headers: { 'Authorization': "Bearer #{client.access_token}" },
+          query: {
+            apikey: client.client_id,
+            symbol: symbols.join(','),
+          }.map {|k,v| [k, v.to_s] }.to_h,
+        },
+        response: {
+          status: 429,
+          body: <<~RESPONSE
+            {"error":"Rate limit error"}
+          RESPONSE
+        }
+      )
+    end
+
+    let(:expected_result) do
+    end
+
+    it 'raises a RateLimitError' do
+      expect { subject }.to raise_error(TDAmeritrade::Error::RateLimitError)
+    end
+  end
+
+  context 'access token is invalid or expired' do
+    subject do
+      client.get_quotes(symbols)
+    end
+
+    let(:symbols) { %w(PG MSFT CVX) }
+
+    let!(:expected_request) do
+      TDAmeritrade::Spec::Mocks::MockGetQuotes.mock_find(
+        request: {
+          headers: { 'Authorization': "Bearer #{client.access_token}" },
+          query: {
+            apikey: client.client_id,
+            symbol: symbols.join(','),
+          }.map {|k,v| [k, v.to_s] }.to_h,
+        },
+        response: {
+          status: 401,
+          body: <<~RESPONSE
+            {"error":"Not Authorized."}
+          RESPONSE
+        }
+      )
+    end
+
+    let(:expected_result) do
+    end
+
+    it 'raises a NotAuthorizedError' do
+      expect { subject }.to raise_error(TDAmeritrade::Error::NotAuthorizedError)
+    end
+  end
+
+end

data/spec/tdameritrade/operations/get_instrument_fundamentals_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+require 'support/authenticated_client'
+require 'tdameritrade'
+
+describe TDAmeritrade::Operations::GetInstrumentFundamentals do
+  include_context 'authenticated client'
+  # include_context 'webmock off'
+
+  context 'valid symbol' do
+    subject do
+      client.get_instrument_fundamentals(symbol)
+    end
+
+    let(:symbol) { 'PG' }
+
+    let!(:expected_request) do
+      TDAmeritrade::Spec::Mocks::MockGetInstrumentFundamentals.mock_find(
+        request: {
+          headers: { 'Authorization': "Bearer #{client.access_token}" },
+          query: {
+            apikey: client.client_id,
+            symbol: symbol,
+            projection: 'fundamental'
+          }.map {|k,v| [k, v.to_s] }.to_h,
+        },
+        response: {
+          body: <<~RESPONSE
+            {
+              "PG": {
+                "fundamental": {
+                  "symbol": "PG",
+                  "high52": 121.76,
+                  "low52": 78.49,
+                  "dividendAmount": 2.9836,
+                  "dividendYield": 2.54,
+                  "dividendDate": "2019-07-18 00:00:00.000",
+                  "peRatio": 79.14674,
+                  "pegRatio": 0.0,
+                  "pbRatio": 6.35135,
+                  "prRatio": 4.33729,
+                  "pcfRatio": 44.97703,
+                  "grossMarginTTM": 49.84339,
+                  "grossMarginMRQ": 50.80145,
+                  "netProfitMarginTTM": 5.85958,
+                  "netProfitMarginMRQ": 0.0,
+                  "operatingMarginTTM": 8.61208,
+                  "operatingMarginMRQ": 0.0,
+                  "returnOnEquity": 7.44733,
+                  "returnOnAssets": 3.39838,
+                  "returnOnInvestment": 4.55386,
+                  "quickRatio": 0.58165,
+                  "currentRatio": 0.74883,
+                  "interestCoverage": 467.625,
+                  "totalDebtToCapital": 38.7429,
+                  "ltDebtToEquity": 43.21524,
+                  "totalDebtToEquity": 63.76234,
+                  "epsTTM": 1.48231,
+                  "epsChangePercentTTM": 0.0,
+                  "epsChangeYear": 0.0,
+                  "epsChange": 0.0,
+                  "revChangeYear": 0.0,
+                  "revChangeTTM": 1.27484,
+                  "revChangeIn": 3.83914,
+                  "sharesOutstanding": 2502.26,
+                  "marketCapFloat": 2499.515,
+                  "marketCap": 293565.1,
+                  "bookValuePerShare": 0.0,
+                  "shortIntToFloat": 0.0,
+                  "shortIntDayToCover": 0.0,
+                  "divGrowthRate3Year": 0.0,
+                  "dividendPayAmount": 0.7459,
+                  "dividendPayDate": "2019-11-15 00:00:00.000",
+                  "beta": 0.40382,
+                  "vol1DayAvg": 6650680.0,
+                  "vol10DayAvg": 6548680.0,
+                  "vol3MonthAvg": 161420290.0
+                },
+                "cusip": "742718109",
+                "symbol": "PG",
+                "description": "Procter & Gamble Company (The) Common Stock",
+                "exchange": "NYSE",
+                "assetType": "EQUITY"
+              }
+            }
+          RESPONSE
+        }
+      )
+    end
+
+    let(:expected_result) do
+      {"PG"=>
+         {"fundamental"=>
+            {"symbol"=>"PG",
+             "high52"=>121.76,
+             "low52"=>78.49,
+             "dividendAmount"=>2.9836,
+             "dividendYield"=>2.54,
+             "dividendDate"=>"2019-07-18 00:00:00.000",
+             "peRatio"=>79.14674,
+             "pegRatio"=>0.0,
+             "pbRatio"=>6.35135,
+             "prRatio"=>4.33729,
+             "pcfRatio"=>44.97703,
+             "grossMarginTTM"=>49.84339,
+             "grossMarginMRQ"=>50.80145,
+             "netProfitMarginTTM"=>5.85958,
+             "netProfitMarginMRQ"=>0.0,
+             "operatingMarginTTM"=>8.61208,
+             "operatingMarginMRQ"=>0.0,
+             "returnOnEquity"=>7.44733,
+             "returnOnAssets"=>3.39838,
+             "returnOnInvestment"=>4.55386,
+             "quickRatio"=>0.58165,
+             "currentRatio"=>0.74883,
+             "interestCoverage"=>467.625,
+             "totalDebtToCapital"=>38.7429,
+             "ltDebtToEquity"=>43.21524,
+             "totalDebtToEquity"=>63.76234,
+             "epsTTM"=>1.48231,
+             "epsChangePercentTTM"=>0.0,
+             "epsChangeYear"=>0.0,
+             "epsChange"=>0.0,
+             "revChangeYear"=>0.0,
+             "revChangeTTM"=>1.27484,
+             "revChangeIn"=>3.83914,
+             "sharesOutstanding"=>2502.26,
+             "marketCapFloat"=>2499.515,
+             "marketCap"=>293565.1,
+             "bookValuePerShare"=>0.0,
+             "shortIntToFloat"=>0.0,
+             "shortIntDayToCover"=>0.0,
+             "divGrowthRate3Year"=>0.0,
+             "dividendPayAmount"=>0.7459,
+             "dividendPayDate"=>"2019-11-15 00:00:00.000",
+             "beta"=>0.40382,
+             "vol1DayAvg"=>6650680.0,
+             "vol10DayAvg"=>6548680.0,
+             "vol3MonthAvg"=>161420290.0},
+          "cusip"=>"742718109",
+          "symbol"=>"PG",
+          "description"=>"Procter & Gamble Company (The) Common Stock",
+          "exchange"=>"NYSE",
+          "assetType"=>"EQUITY"}
+      }
+    end
+
+    it { is_expected.to eql(expected_result) }
+  end
+
+  context 'invalid symbol' do
+    subject do
+      client.get_instrument_fundamentals(invalid_symbol)
+    end
+
+    let(:invalid_symbol) { 'XXX' }
+
+    let!(:expected_request) do
+      TDAmeritrade::Spec::Mocks::MockGetInstrumentFundamentals.mock_find(
+        request: {
+          headers: { 'Authorization': "Bearer #{client.access_token}" },
+          query: {
+            apikey: client.client_id,
+            symbol: invalid_symbol,
+            projection: 'fundamental'
+          }.map {|k,v| [k, v.to_s] }.to_h,
+        },
+        response: {
+          body: <<~RESPONSE
+            {}
+          RESPONSE
+        }
+      )
+    end
+
+    let(:expected_result) do
+      {}
+    end
+
+    it { is_expected.to eql(expected_result) }
+  end
+
+end

data/spec/tdameritrade/operations/get_price_history_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+require 'support/authenticated_client'
+require 'tdameritrade'
+
+describe TDAmeritrade::Operations::GetPriceHistory do
+  include_context 'authenticated client'
+  # include_context 'webmock off'
+
+  let(:single_ticker) { 'PG' }
+  let(:multiple_tickers) { ['PG', 'MSFT', 'BA'] }
+
+  context '5 days of 5-min candles' do
+    context 'single ticker' do
+      subject do
+        client.get_price_history(single_ticker, period_type: :day, period: 10, frequency: 5, frequency_type: :minute)
+      end
+
+      let!(:expected_request) do
+        TDAmeritrade::Spec::Mocks::MockGetPriceHistory.mock_find(
+          symbol: single_ticker,
+          request: {
+            headers: { 'Authorization': "Bearer #{client.access_token}" },
+            query: {
+              apikey: client.client_id,
+              periodType: 'day',
+              period: 10,
+              frequencyType: 'minute',
+              frequency: 5,
+              needExtendedHoursData: 'false'
+            }.map {|k,v| [k, v.to_s] }.to_h,
+          },
+          response: {
+            body: <<~RESPONSE
+              {
+                "candles": [
+                  {
+                    "open": 119.44,
+                    "high": 119.54,
+                    "low": 119.44,
+                    "close": 119.54,
+                    "volume": 208,
+                    "datetime": 1566558000000
+                  },
+                  {
+                    "open": 119.54,
+                    "high": 119.54,
+                    "low": 119.54,
+                    "close": 119.54,
+                    "volume": 104,
+                    "datetime": 1566559800000
+                  }
+                ],
+                "symbol": "PG",
+                "empty": false
+              }
+            RESPONSE
+          }
+        )
+      end
+
+      let(:expected_result) do
+        {
+          "candles"=>
+           [{"open"=>119.44, "high"=>119.54, "low"=>119.44, "close"=>119.54, "volume"=>208, "datetime"=>Time.at(1566558000000 / 1000)},
+            {"open"=>119.54, "high"=>119.54, "low"=>119.54, "close"=>119.54, "volume"=>104, "datetime"=>Time.at(1566559800000 / 1000)}],
+          "symbol"=>"PG",
+          "empty"=>false
+        }
+      end
+
+      it { is_expected.to eql(expected_result) }
+    end
+
+    context 'multiple tickers' do
+      pending 'does not appear to be supported yet by the API'
+    end
+
+    context 'invalid ticker or one with no data' do
+      subject do
+        client.get_price_history(invalid_ticker, period: 1, period_type: :month, frequency: 5, frequency_type: :minute)
+      end
+      let(:invalid_ticker) { 'XXX' }
+
+      let!(:expected_request) do
+        TDAmeritrade::Spec::Mocks::MockGetPriceHistory.mock_find(
+          symbol: invalid_ticker,
+          request: {
+            headers: { 'Authorization': "Bearer #{client.access_token}" },
+            query: {
+              apikey: client.client_id,
+              periodType: 'month',
+              period: 1,
+              frequencyType: 'minute',
+              frequency: 5,
+              needExtendedHoursData: 'false'
+            }.map {|k,v| [k, v.to_s] }.to_h,
+          },
+          response: {
+            body: <<~RESPONSE
+              {"candles":[],"symbol":"XXX","empty":true}
+            RESPONSE
+          }
+        )
+      end
+
+      let(:expected_result) do
+        {
+          "candles"=> [],
+          "symbol"=>"XXX",
+          "empty"=>true
+        }
+      end
+
+      it { is_expected.to eql(expected_result) }
+    end
+
+    context 'invalid request due to mismatched frequency type and interval' do
+      subject do
+        # Can't use minute with the monthly period type
+        client.get_price_history(
+          single_ticker,
+          period_type: :month,
+          period: 10,
+          frequency: 5,
+          frequency_type: :minute,
+          need_extended_hours_data: true
+        )
+      end
+
+      let!(:expected_request) do
+        TDAmeritrade::Spec::Mocks::MockGetPriceHistory.mock_find(
+          symbol: single_ticker,
+          request: {
+            headers: { 'Authorization': "Bearer #{client.access_token}" },
+            query: {
+              apikey: client.client_id,
+              periodType: 'month',
+              period: 10,
+              frequencyType: 'minute',
+              frequency: 5,
+              needExtendedHoursData: 'true'
+            }.map {|k,v| [k, v.to_s] }.to_h,
+          },
+          response: {
+            status: 400,
+            body: <<~RESPONSE
+              {"error":"Bad request."}
+            RESPONSE
+          }
+        )
+      end
+
+      it 'raises an error' do
+        expect { subject }.to raise_error(TDAmeritrade::Error::TDAmeritradeError, "400: Bad request.")
+      end
+    end
+
+  end
+
+end