tdameritrade-api-ruby 1.3.0.20210215

data/lib/tdameritrade/operations/get_price_history.rb

@@ -0,0 +1,55 @@
+require 'tdameritrade/operations/base_operation'
+
+module TDAmeritrade; module Operations
+  class GetPriceHistory < BaseOperation
+
+    # Not used right now, but can be used later on for validation
+    FREQUENCY_TYPE=[:minute, :daily, :weekly, :monthly]
+    PERIOD_TYPE=[:day, :month, :year, :ytd]
+
+    def call(
+      symbol,
+      period_type: nil,
+      period: nil,
+      frequency_type: nil,
+      frequency: nil,
+      end_date: nil, # should be a Date
+      start_date: nil, # should be a Date
+      need_extended_hours_data: false
+    )
+      params = {
+        apikey: client.client_id,
+        needExtendedHoursData: need_extended_hours_data,
+      }
+
+      params.merge!(frequencyType: frequency_type) if frequency_type
+      params.merge!(frequency: frequency) if frequency
+
+      # NOTE: can't use period if using start and end dates
+      params.merge!(periodType: period_type) if period_type
+      params.merge!(period: period) if period
+      params.merge!(startDate: "#{start_date.strftime('%s')}000") if start_date
+      params.merge!(endDate: "#{end_date.strftime('%s')}000") if end_date
+
+      response = perform_api_get_request(
+        url: "https://api.tdameritrade.com/v1/marketdata/#{symbol}/pricehistory",
+        query: params,
+      )
+
+      parsed_response = parse_api_response(response)
+
+      if parsed_response["candles"]
+        parsed_response["candles"].map do |candle|
+          if candle["datetime"].is_a? Numeric
+            candle["datetime"] = Time.at(candle["datetime"] / 1000)
+          end
+        end
+      end
+
+      parsed_response
+    end
+
+    private
+
+  end
+end; end

data/lib/tdameritrade/operations/get_quotes.rb

@@ -0,0 +1,21 @@
+require 'tdameritrade/operations/base_operation'
+
+module TDAmeritrade; module Operations
+  class GetQuotes < BaseOperation
+
+    def call(symbols: [])
+      params = {
+        apikey: client.client_id,
+        symbol: symbols.join(','),
+      }
+
+      response = perform_api_get_request(
+        url: "https://api.tdameritrade.com/v1/marketdata/quotes",
+        query: params,
+      )
+
+      parse_api_response(response)
+    end
+
+  end
+end; end

data/lib/tdameritrade/operations/get_watchlists.rb

@@ -0,0 +1,12 @@
+require 'tdameritrade/operations/base_operation'
+
+module TDAmeritrade; module Operations
+  class GetWatchlists < BaseOperation
+
+    def call(account_id: )
+      response = perform_api_get_request(url: "https://api.tdameritrade.com/v1/accounts/#{account_id}/watchlists")
+      parse_api_response(response)
+    end
+
+  end
+end; end

data/lib/tdameritrade/operations/replace_watchlist.rb

@@ -0,0 +1,33 @@
+require 'tdameritrade/operations/base_operation'
+require 'tdameritrade/operations/support/build_watchlist_items'
+
+module TDAmeritrade; module Operations
+  class ReplaceWatchlist < BaseOperation
+    include Support::BuildWatchlistItems
+
+    def call(account_id, watchlist_id, watchlist_name, symbols_to_add=[])
+      symbols_to_add = symbols_to_add.is_a?(String) ? [symbols_to_add] : symbols_to_add
+      body = {
+        "name": watchlist_name,
+        "watchlistId": watchlist_id,
+        "watchlistItems": build_watchlist_items(symbols_to_add)
+      }.to_json
+
+      uri = URI("https://api.tdameritrade.com/v1/accounts/#{account_id}/watchlists/#{watchlist_id}")
+      request = Net::HTTP::Put.new(
+        uri.path,
+        'authorization' => "Bearer #{client.access_token}",
+        'content-type' => 'application/json'
+      )
+      request.body = body
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
+
+      if response_success?(response)
+        true
+      else
+        parse_api_response(response)
+      end
+    end
+
+  end
+end; end

data/lib/tdameritrade/operations/support/build_watchlist_items.rb

@@ -0,0 +1,21 @@
+module TDAmeritrade; module Operations; module Support
+  module BuildWatchlistItems
+
+    # This gem only supports EQUITY type, even though there is a lot more you can do with the API
+    def build_watchlist_items(symbol_list)
+      symbol_list.map do |symbol|
+        {
+          "quantity": 0,
+          "averagePrice": 0,
+          "commission": 0,
+          "purchasedDate": (Date.today).strftime('%Y-%m-%d'),
+          "instrument": {
+            "symbol": symbol,
+            "assetType": "EQUITY"
+          }
+        }
+      end
+    end
+
+  end
+end; end; end

data/lib/tdameritrade/operations/update_watchlist.rb

@@ -0,0 +1,33 @@
+require 'tdameritrade/operations/base_operation'
+require 'tdameritrade/operations/support/build_watchlist_items'
+
+module TDAmeritrade; module Operations
+  class UpdateWatchlist < BaseOperation
+    include Support::BuildWatchlistItems
+
+    def call(account_id, watchlist_id, watchlist_name, symbols_to_add=[])
+      symbols_to_add = symbols_to_add.is_a?(String) ? [symbols_to_add] : symbols_to_add
+      body = {
+        "name": watchlist_name,
+        "watchlistId": watchlist_id,
+        "watchlistItems": build_watchlist_items(symbols_to_add)
+      }.to_json
+
+      uri = URI("https://api.tdameritrade.com/v1/accounts/#{account_id}/watchlists/#{watchlist_id}")
+      request = Net::HTTP::Patch.new(
+        uri.path,
+        'authorization' => "Bearer #{client.access_token}",
+        'content-type' => 'application/json'
+      )
+      request.body = body
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
+
+      if response_success?(response)
+        true
+      else
+        parse_api_response(response)
+      end
+    end
+
+  end
+end; end

data/lib/tdameritrade/util.rb

@@ -0,0 +1,50 @@
+require 'tdameritrade/error'
+
+module TDAmeritrade
+  module Util
+    module_function
+
+    def handle_api_error(response)
+      # "Individual App's transactions per seconds restriction, please update to commercial apps for unrestricted tps"
+      if response.code == 429
+        raise TDAmeritrade::Error::RateLimitError.new(response.body)
+      elsif response.code == 401
+        raise TDAmeritrade::Error::NotAuthorizedError.new(response.body)
+      end
+
+      error_message = JSON.parse(response.body)['error']
+      raise TDAmeritrade::Error::TDAmeritradeError.new("#{response.code}: #{error_message}")
+    rescue JSON::ParserError
+      raise TDAmeritrade::Error::TDAmeritradeError.new(
+        "Unable to parse error response from TD Ameritrade API: #{response.body}"
+      )
+    end
+
+    def parse_json_response(response)
+      handle_api_error(response) unless response_success?(response)
+
+      stripped_text = response.body.strip
+      sanitized_text = stripped_text[0] == "\\" ? stripped_text[1..-1] : stripped_text
+      json = JSON.parse(sanitized_text)
+
+      case json
+      when Array
+        json.map { |item| Hashie::Mash.new(item) }  # assuming that we're only dealing with arrays of hashes
+      when Hash
+        Hashie::Mash.new(json)
+      else
+        json
+      end
+
+    rescue JSON::ParserError
+      raise TDAmeritrade::Error::TDAmeritradeError.new(
+        "Unable to parse response from TD Ameritrade API: #{sanitized_text}"
+      )
+    end
+    alias :parse_api_response :parse_json_response
+
+    def response_success?(response)
+      response.code.to_s =~ /^2\d\d/
+    end
+  end
+end

data/lib/tdameritrade/version.rb

@@ -0,0 +1,3 @@
+module TDAmeritrade
+  VERSION = '1.3.0.20210215'
+end

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.
+    TDAmeritrade::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,17 @@
+require File.join(File.dirname(__FILE__), 'tdameritrade_api_mock_base.rb')
+
+module TDAmeritrade; 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,17 @@
+require File.join(File.dirname(__FILE__), 'tdameritrade_api_mock_base.rb')
+
+module TDAmeritrade; 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,17 @@
+require File.join(File.dirname(__FILE__), 'tdameritrade_api_mock_base.rb')
+
+module TDAmeritrade; 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,43 @@
+require File.join(File.dirname(__FILE__), 'tdameritrade_api_mock_base.rb')
+
+module TDAmeritrade; 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