schwab-api-ruby 2.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,110 @@
+require 'pry'
+require 'webmock/rspec'
+
+Dir[File.join(File.dirname(__FILE__), 'support', '/**/*.rb')].each { |f| require(f) }
+
+WebMock.disable_net_connect!
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/authenticated_client.rb

@@ -0,0 +1,12 @@
+shared_context 'authenticated client' do
+  let!(:client) do
+    # If you turn off WebMock by including the 'webmock_off' shared context in your tests, you can hit the
+    # live API with a real ping. Just be sure to replace these values here with actual connection tokens.
+    Schwab::Client.new(
+      client_id: 'RUBYAPITEST@AMER.OAUTHAP',
+      redirect_uri: 'http://localhost:3000',
+      access_token: 'test_access_token',
+      refresh_token: 'test_refresh_token'
+    )
+  end
+end

data/spec/support/spec/mocks/mock_get_instrument_fundamentals.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), 'tdameritrade_api_mock_base.rb')
+
+module Schwab
+  ; module Spec; module Mocks;
+  class MockGetInstrumentFundamentals < TDAmeritradeMockBase
+
+    def self.mock_find(request: { query: {}, headers: {} }, response: { status: 200, body: '' })
+      return if webmock_off?
+
+      url_params = build_url_params(request)
+      WebMock
+        .stub_request(:get, "#{API_BASE_URL}/instruments#{url_params}")
+        .with(request)
+        .to_return(response)
+    end
+
+  end
+end; end; end

data/spec/support/spec/mocks/mock_get_price_history.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), 'tdameritrade_api_mock_base.rb')
+
+module Schwab
+  ; module Spec; module Mocks;
+  class MockGetPriceHistory < TDAmeritradeMockBase
+
+    def self.mock_find(symbol: nil, request: { query: {}, headers: {} }, response: { status: 200, body: '' })
+      return if webmock_off?
+
+      url_params = build_url_params(request)
+      WebMock
+        .stub_request(:get, "#{API_BASE_URL}/marketdata/#{symbol}/pricehistory#{url_params}")
+        .with(request)
+        .to_return(response)
+    end
+
+  end
+end; end; end

data/spec/support/spec/mocks/mock_get_quotes.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), 'tdameritrade_api_mock_base.rb')
+
+module Schwab
+  ; module Spec; module Mocks;
+  class MockGetQuotes < TDAmeritradeMockBase
+
+    def self.mock_find(request: { query: {}, headers: {} }, response: { status: 200, body: '' })
+      return if webmock_off?
+
+      url_params = build_url_params(request)
+      WebMock
+        .stub_request(:get, "#{API_BASE_URL}/marketdata/quotes#{url_params}")
+        .with(request)
+        .to_return(response)
+    end
+
+  end
+end; end; end

data/spec/support/spec/mocks/mock_watchlists.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__), 'tdameritrade_api_mock_base.rb')
+
+module Schwab
+  ; module Spec; module Mocks;
+class MockWatchlists < TDAmeritradeMockBase
+
+  def self.mock_create(account_id, request: { headers: {} }, response: { status: 200, body: '' } )
+    return if webmock_off?
+
+    WebMock
+      .stub_request(:post, "#{API_BASE_URL}/accounts/#{account_id}/watchlists")
+      .with(request)
+      .to_return(response)
+  end
+
+  def self.mock_find_for_account(account_id, request: { headers: {} }, response: { status: 200, body: '' })
+    return if webmock_off?
+
+    WebMock
+      .stub_request(:get, "#{API_BASE_URL}/accounts/#{account_id}/watchlists")
+      .with(request)
+      .to_return(response)
+  end
+
+  def self.mock_replace(account_id, watchlist_id, request: { headers: {} }, response: { status: 200, body: '' })
+    return if webmock_off?
+
+    WebMock
+      .stub_request(:put, "#{API_BASE_URL}/accounts/#{account_id}/watchlists/#{watchlist_id}")
+      .with(request)
+      .to_return(response)
+  end
+
+  def self.mock_update(account_id, watchlist_id, request: { headers: {} }, response: { status: 200, body: '' })
+    return if webmock_off?
+
+    WebMock
+      .stub_request(:patch, "#{API_BASE_URL}/accounts/#{account_id}/watchlists/#{watchlist_id}")
+      .with(request)
+      .to_return(response)
+  end
+
+end
+end; end; end

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

@@ -0,0 +1,22 @@
+module Schwab
+  ; 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/error_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'support/authenticated_client'
+require 'schwab'
+
+describe Schwab::Error do
+  include_context 'authenticated client'
+  # include_context 'webmock off'
+
+  pending 'rate limit error' do
+    subject do
+      client.get_quotes(symbols)
+    end
+
+    let(:symbols) { %w(PG MSFT CVX) }
+
+    let!(:expected_request) do
+      Schwab::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(Schwab::Error::RateLimitError)
+    end
+  end
+
+  pending 'access token is invalid or expired' do
+    subject do
+      client.get_quotes(symbols)
+    end
+
+    let(:symbols) { %w(PG MSFT CVX) }
+
+    let!(:expected_request) do
+      Schwab::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(Schwab::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 'schwab'
+
+describe Schwab::Operations::GetInstrumentFundamentals do
+  include_context 'authenticated client'
+  # include_context 'webmock off'
+
+  pending 'valid symbol' do
+    subject do
+      client.get_instrument_fundamentals(symbol)
+    end
+
+    let(:symbol) { 'PG' }
+
+    let!(:expected_request) do
+      Schwab::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
+      Schwab::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 'schwab'
+
+describe Schwab::Operations::GetPriceHistory do
+  include_context 'authenticated client'
+  # include_context 'webmock off'
+
+  let(:single_ticker) { 'PG' }
+  let(:multiple_tickers) { ['PG', 'MSFT', 'BA'] }
+
+  pending '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
+        Schwab::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
+
+    pending '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
+        Schwab::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
+
+    pending '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
+        Schwab::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(Schwab::Error::SchwabAPIError, "400: Bad request.")
+      end
+    end
+
+  end
+
+end