tdameritrade-api-ruby 1.3.0.20210215

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d134792147ae3f4c334dae26243c3f8a13bd48841f38521b03ca4296ae8749c
+  data.tar.gz: bff7d8e1f07e85b27d3d91674bb61a4d367cd10e7aa8854b2eb9dd4dc0364ba2
+SHA512:
+  metadata.gz: 3c860ad9f0ed410f23617e2cf7e5d0b8a8056f1e39aede00e2471696df97723bf15f069bd397920fbadeff11260d1ccc539301daf0798f30e5e1f83fdfc20647
+  data.tar.gz: c49cee69e2a13981cca1bc2dbd626cafee90be3de4a7bbcc88789d6b0cc8e3846281f74a7ed218d725b5ea0edee4e82be35456875d3d5bb911ebfe04e58f86d7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+.DS_STORE
+spec/test_data/sample_stream_rspec_test.binary
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/test_data/sample_stream_archives
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+Version 1.3.0.20210215
+- Added tracking of token expiration dates to instance vars
+- API request results are now returned as a Hashie::Mash to make 'quotes' or :symbol reference of values indifferent
+- Corrected incorrect date submission in create watchlist operation
+
+Verion 1.2.0.20190915
+- (Breaking change) Make get_price_history return datetime stamp as Ruby Time vs milliseconds since epoch  
+
+Verion 1.1.1.20190915
+- Fix incorrect formatting when using startdate and enddate in get_price_history 
+
+Version 1.1.0 8/28/19
+- Enhance error messages for rate limit and invalid token
+
+Version 1.0 8/27/19
+- Change structure internally to use dependency injection of operations
+- Price history feature
+- Real time quotes feature
+- Added RSpec test coverage
+
+Version 0.2.alpha 
+- Basic Watchlist retrieval and modification
+
+Version 0.1.alpha - 11/29/2018
+- Initial, very basic release
+- Authentication: refresh access token by refresh_token
+- Instruments: get fundamentals
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tdameritrade_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 wkotzan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# TD Ameritrade API gem for Ruby
+
+This is a gem for connecting to the OAuth/JSON-based TD Ameritrade Developers API released in 2018. Go to 
+https://developer.tdameritrade.com/ for the official documentation and to create your OAuth application.
+
+For a gem that allows you to connect to the older version of the TDAmeritrade API, go to 
+https://github.com/wakproductions/tdameritrade_api
+
+## Installation
+
+In your Gemfile
+
+`gem 'tdameritrade-api-ruby', git: 'https://github.com/wakproductions/tdameritrade-api-ruby.git'`
+
+## Authenticating
+
+Currently this gem is designed for private app authorization. Read this guide for a general overview of signing in your
+private app: https://developer.tdameritrade.com/content/simple-auth-local-apps
+
+The TD Ameritrade API now uses OAuth for authentication. For an introduction to the OAuth flow, [I recommend reading
+this tutorial](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2).
+
+I plan on writing more detailed instructions in the file /doc/authentication.md
+
+## Basic Usage
+
+```
+client = TDAmeritrade::Client.new(
+  client_id: 'MYCLIENTID@AMER.OAUTHAP', 
+  redirect_uri: 'http://my-redirect-url', 
+  refresh_token: 'b6w31RJvP/Cz3MVghpx8S5dzeYVcHygEQHKWYQuI98NGpsMb1j...'
+)
+
+client.get_instrument_fundamentals('TWTR')
+#=> {"TWTR"=>
+      {"fundamental"=>
+        {"symbol"=>"TWTR",
+         "high52"=>47.79,
+         "low52"=>20.12,
+         "dividendAmount"=>0.0,
+         "dividendYield"=>0.0,
+         "peRatio"=>17.93788,
+         "pegRatio"=>0.039026,
+         "pbRatio"=>3.85707,
+         ...
+```
+
+# Current State of Functionality
+
+The official API is documented [here](https://developer.tdameritrade.com/apis). This gem currently implements the
+following functionality. If you would like to expand its functionality, then please submit a pull request.
+
+- [ ] Accounts and Trading
+- [x] Authentication
+- [x] Instruments
+- [ ] Market Hours
+- [ ] Movers
+- [ ] Option Chains
+- [x] Price History
+- [ ] Real-time Quotes
+- [ ] Transaction History
+- [ ] User Info and Preferences
+- [x] Watchlist
+  - [x] Get Watchlists
+  - [x] Replace Watchlist  
+  - [x] Delete Watchlist  
+  - [x] Update Watchlist  
+
+## Contributions
+
+If you would like to make a contribution, please submit a pull request to the original branch. Feel free to email me Winston Kotzan
+at wak@wakproductions.com with any feature requests, bug reports, or feedback.
+
+#### Wish List
+
+* Test Coverage in RSpec
+
+## Support
+
+Please open an issue on Github if you have any problems or questions.
+
+## Release Notes
+
+See CHANGELOG.md

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'tdameritrade-api-ruby'
+
+# This is just a placeholder
+# task :taskname do
+#   # perform logic
+# end
+

data/lib/tdameritrade-api-ruby.rb

@@ -0,0 +1 @@
+require 'tdameritrade'

data/lib/tdameritrade.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+
+require 'tdameritrade/authentication'
+require 'tdameritrade/client'
+require 'tdameritrade/error'
+require 'tdameritrade/version'
+
+module TDAmeritrade
+end

data/lib/tdameritrade/authentication.rb

@@ -0,0 +1,65 @@
+require 'tdameritrade/util'
+require 'hashie'
+require 'httparty'
+
+module TDAmeritrade
+  module Authentication
+    include Util
+
+    attr_reader :client_id, :redirect_uri, :authorization_code, :access_token, :refresh_token,
+                :access_token_expires_at, :refresh_token_expires_at
+
+    # This is the OAuth code retrieved from your browser window, first step in OAuth needed to retrieve the tokens
+    def get_access_tokens(authorization_grant_code)
+      # headers = { 'Content-Type': 'application/x-www-form-urlencoded' } # turns out didn't need this
+      params = {
+        'grant_type': 'authorization_code',
+        'access_type': 'offline',
+        'code': authorization_grant_code,
+        'client_id': client_id,
+        'redirect_uri': redirect_uri
+      }
+      response = HTTParty.post(
+        'https://api.tdameritrade.com/v1/oauth2/token',
+        body: params
+      )
+
+      unless response_success?(response)
+        raise TDAmeritrade::Error::TDAmeritradeError.new(
+          "Unable to retrieve access tokens from API - #{response.code} - #{response.body}"
+        )
+      end
+
+      update_tokens(parse_json_response(response))
+    end
+
+    def get_new_access_token
+      params = {
+        grant_type: 'refresh_token',
+        refresh_token: refresh_token,
+        access_type: 'offline',
+        client_id: client_id,
+        redirect_uri: redirect_uri
+      }
+
+      response = HTTParty.post(
+        'https://api.tdameritrade.com/v1/oauth2/token',
+        body: params
+      )
+
+      update_tokens(parse_json_response(response))
+    end
+    alias :refresh_access_token :get_new_access_token
+
+    def update_tokens(args={})
+      gem_error(args[:error]) if args.has_key?(:error)
+
+      @access_token = args[:access_token]
+      @refresh_token = args[:refresh_token]
+      @access_token_expires_at = Time.now + (args[:expires_in] || 0)
+      @refresh_token_expires_at = Time.now + (args[:refresh_token_expires_in] || 0)
+
+      args
+    end
+  end
+end

data/lib/tdameritrade/client.rb

@@ -0,0 +1,56 @@
+require 'tdameritrade/authentication'
+require 'tdameritrade/client'
+require 'tdameritrade/error'
+require 'tdameritrade/version'
+require 'tdameritrade/operations/create_watchlist'
+require 'tdameritrade/operations/get_instrument_fundamentals'
+require 'tdameritrade/operations/get_price_history'
+require 'tdameritrade/operations/get_quotes'
+require 'tdameritrade/operations/get_watchlists'
+require 'tdameritrade/operations/replace_watchlist'
+require 'tdameritrade/operations/update_watchlist'
+
+module TDAmeritrade
+  class Client
+    include TDAmeritrade::Authentication
+    include TDAmeritrade::Error
+
+    def initialize(**args)
+      @access_token = args[:access_token]
+      @refresh_token = args[:refresh_token]
+      @access_token_expires_at = args[:access_token_expires_at]
+      @refresh_token_expires_at = args[:refresh_token_expires_at]
+      @client_id = args[:client_id] || Error.gem_error('client_id is required!')
+      @redirect_uri = args[:redirect_uri] || Error.gem_error('redirect_uri is required!')
+    end
+
+    def get_instrument_fundamentals(symbol)
+      Operations::GetInstrumentFundamentals.new(self).call(symbol)
+    end
+
+    def get_price_history(symbol, **options)
+      Operations::GetPriceHistory.new(self).call(symbol, options)
+    end
+
+    def get_quotes(symbols)
+      Operations::GetQuotes.new(self).call(symbols: symbols)
+    end
+
+    def create_watchlist(account_id, watchlist_name, symbols)
+      Operations::CreateWatchlist.new(self).call(account_id, watchlist_name, symbols)
+    end
+
+    def get_watchlists(account_id)
+      Operations::GetWatchlists.new(self).call(account_id: account_id)
+    end
+
+    def replace_watchlist(account_id, watchlist_id, watchlist_name, symbols_to_add=[])
+      Operations::ReplaceWatchlist.new(self).call(account_id, watchlist_id, watchlist_name, symbols_to_add)
+    end
+
+    def update_watchlist(account_id, watchlist_id, watchlist_name, symbols_to_add=[])
+      Operations::UpdateWatchlist.new(self).call(account_id, watchlist_id, watchlist_name, symbols_to_add)
+    end
+
+  end
+end

data/lib/tdameritrade/error.rb

@@ -0,0 +1,20 @@
+module TDAmeritrade
+  module Error
+    module_function
+
+    class TDAmeritradeError < StandardError
+    end
+
+    class RateLimitError < StandardError
+    end
+
+    class NotAuthorizedError < StandardError
+    end
+
+    def gem_error(message)
+      error = TDAmeritradeError.new(message)
+      error.set_backtrace(caller)
+      raise error
+    end
+  end
+end

data/lib/tdameritrade/operations/base_operation.rb

@@ -0,0 +1,36 @@
+require 'tdameritrade/error'
+require 'tdameritrade/util'
+
+module TDAmeritrade
+  module Operations
+    class BaseOperation
+      include Util
+
+      HTTP_DEBUG_OUTPUT=ENV['DEBUG_OUTPUT'] # to make live testing easier
+
+      attr_reader :client
+
+      def initialize(client)
+        @client = client  # inject dependency of client credentials
+      end
+
+      private
+
+      def debug_output?
+        HTTP_DEBUG_OUTPUT.to_s == 'true'
+      end
+
+      def perform_api_get_request(url: , query: nil)
+        options = { headers: { 'Authorization': "Bearer #{client.access_token}" } }
+        options.merge!(query: query) if query
+        options.merge!(debug_output: $stdout) if debug_output?
+
+        HTTParty.get(
+          url,
+          options
+        )
+      end
+
+    end
+  end
+end

data/lib/tdameritrade/operations/create_watchlist.rb

@@ -0,0 +1,30 @@
+require 'tdameritrade/operations/base_operation'
+require 'tdameritrade/operations/support/build_watchlist_items'
+
+module TDAmeritrade; module Operations
+  class CreateWatchlist < BaseOperation
+    include Support::BuildWatchlistItems
+
+    def call(account_id, watchlist_name, symbols)
+      body = {
+        "name": watchlist_name,
+        "watchlistItems": build_watchlist_items(symbols)
+      }.to_json
+      uri = URI("https://api.tdameritrade.com/v1/accounts/#{account_id}/watchlists")
+      request = Net::HTTP::Post.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/get_instrument_fundamentals.rb

@@ -0,0 +1,22 @@
+require 'tdameritrade/operations/base_operation'
+
+module TDAmeritrade; module Operations
+  class GetInstrumentFundamentals < BaseOperation
+
+    def call(symbol)
+      params = {
+        apikey: client.client_id,
+        symbol: symbol,
+        projection: 'fundamental'
+      }
+
+      response = perform_api_get_request(
+        url: 'https://api.tdameritrade.com/v1/instruments',
+        query: params,
+      )
+
+      parse_api_response(response)
+    end
+
+  end
+end; end