tradier 0.1.0

data/.yardopts

@@ -0,0 +1,8 @@
+--no-private
+--protected
+--tag rate_limited:"Rate Limited?"
+--tag authentication:"Authentication"
+--markup markdown
+-
+LICENSE.md
+README.md

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Tradier Inc.
+
+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,114 @@
+# Tradier
+
+[![Gem Version](https://badge.fury.io/rb/tradier.png)][gem]
+[![Build Status](https://secure.travis-ci.org/tradier/tradier.rb.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/tradier/tradier.rb.png?travis)][gemnasium]
+[![Coverage Status](https://coveralls.io/repos/tradier/tradier.rb/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/tradier
+[travis]: http://travis-ci.org/tradier/tradier.rb
+[gemnasium]: https://gemnasium.com/tradier/tradier.rb
+[coveralls]: https://coveralls.io/r/tradier/tradier.rb
+
+Rubygem for interacting with the Tradier API.
+
+## Installation
+
+    gem install tradier
+
+## Usage
+
+Create an instance of a `Tradier::Client`:
+
+    require 'tradier'
+
+    client = Tradier::Client.new(:access_token => 'token')
+
+### Placing Orders
+
+Orders can be placed using the `create_order` method. Here are some basic examples:
+
+Place an equity order:
+
+    client.create_order({
+      :account  => '123456789'
+      :class    => 'equity',
+      :symbol   => 'AAPL',
+      :duration => 'day',
+      :side     => 'buy',
+      :quantity => '100',
+      :type     => 'market'
+    })
+
+Placing an option order:
+
+    client.create_order({
+      :account       => '123456789'
+      :class         => 'option',
+      :symbol        => 'AAPL',
+      :option_symbol => 'AAPL140118C00195000',
+      :duration      => 'day',
+      :side          => 'buy',
+      :quantity      => '100',
+      :type          => 'market'
+    })
+
+
+For a complete list of the types of orders accepted, refer to [Tradier's trading API documentation][trading]
+
+[trading]: https://developer.tradier.com/documentation/trading/getting-started
+
+### Interacting with Accounts
+
+Obtain a user's profile/accounts:
+
+    client.profile
+
+#### Balances
+
+Obtain an account's balances:
+
+    client.balance('12345678')
+
+#### Positions
+
+Obtain an account's positions
+
+    client.positions('12345678')
+
+Obtain positions for all of a user's accounts:
+
+    client.positions
+
+#### Orders
+
+Obtain an account's order
+
+    client.orders('12345678')
+
+Obtain order for all of a user's accounts:
+
+    client.orders
+
+### Market Data
+
+To obtain a quote, simply request:
+
+    client.quote('SYMBOL')
+
+Or multiple quotes at one time:
+
+    client.quote(['SYMBOL', 'SYMBOL2'])
+
+Option chains can be requested using a symbol and expiration:
+
+    client.chain('SYMBOL', :expiration => '2013-11-14')
+
+
+Refer to the complete [documentation][rdoc] for a complete listing of methods and classes.
+
+[rdoc]: http://rdoc.info/gems/tradier
+
+## Copyright
+
+Copyright (c) 2013 Tradier Inc. See [LICENSE](LICENSE.md) for detail.

data/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = '-w'
+end
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/lib/tradier.rb

@@ -0,0 +1,31 @@
+require 'tradier/error'
+require 'tradier/client'
+require 'tradier/configurable'
+require 'tradier/default'
+
+module Tradier
+  class << self
+    include Tradier::Configurable
+
+    # Delegate to a Tradier::Client
+    #
+    # @return [Tradier::Client]
+    def client
+      @client = Tradier::Client.new(options) unless defined?(@client) && @client.hash == options.hash
+      @client
+    end
+
+    def respond_to_missing?(method_name, include_private=false); client.respond_to?(method_name, include_private); end if RUBY_VERSION >= "1.9"
+    def respond_to?(method_name, include_private=false); client.respond_to?(method_name, include_private) || super; end if RUBY_VERSION < "1.9"
+
+  private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+  end
+end
+
+Tradier.setup

data/lib/tradier/account.rb

@@ -0,0 +1,30 @@
+require 'tradier/base'
+
+module Tradier
+  class Account < Tradier::Base
+    attr_reader :account_number, :type
+
+    def margin?
+      type.downcase == 'margin'
+    end
+
+    def cash?
+      type.downcase == 'cash'
+    end
+
+    def positions
+      @attrs[:positions][:position].map { |a| Tradier::Position.new(a) }
+    end
+
+    def orders
+      @attrs[:orders][:order].map { |a| Tradier::Order.new(a) }
+    end
+
+    def gainloss
+    end
+
+    def history
+    end
+
+  end
+end

data/lib/tradier/api/accounts.rb

@@ -0,0 +1,122 @@
+require 'tradier/api/utils'
+
+module Tradier
+  module API
+    module Accounts
+      include Tradier::API::Utils
+
+      # @see https://developer.tradier.com/documentation/user/get-profile
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Tradier::Profile] The user's profile.
+      def profile
+        object_from_response(Tradier::Profile, :get, '/user/profile', {})
+      end
+      alias user_profile profile
+
+      # @see https://developer.tradier.com/documentation/user/get-balances
+      # @see https://developer.tradier.com/documentation/accounts/get-account-balance
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @overload balances
+      #   Request a user's balances.
+      #   @return [Array<Tradier::Balance>] An array of balances.
+      # @overload balances(account_number)
+      #   Request an individual account's balance.
+      #   @param [String] account_number An account number.
+      #   @return [Tradier::Balance] The account balance object when a single account is requested.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def balances(account_number=nil, options={})
+        if account_number
+          object_from_response(Tradier::Balance, :get, "/accounts/#{account_number}/balances", options)
+        else
+          object_from_response(Tradier::API::Utils::Balance, :get, "/user/balances", options).body
+        end
+      end
+      alias balance balances
+
+      # @see https://developer.tradier.com/documentation/user/get-positions
+      # @see https://developer.tradier.com/documentation/accounts/get-account-positions
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @overload positions
+      #   Request a user's positions.
+      #   @return [Array<Tradier::Account>] An array of accounts with positions.
+      # @overload positions(account_number)
+      #   Request an individual account's positions.
+      #   @param [String] account_number An account number.
+      #   @return [Array<Tradier::Position>] An array of [Tradier::Position] objects for a given account.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def positions(account_number=nil, options={})
+        if account_number
+          object_from_response(Tradier::API::Utils::Position, :get, "/accounts/#{account_number}/positions", options).body
+        else
+          object_from_response(Tradier::API::Utils::Account, :get, '/user/positions', options).body
+        end
+      end
+      alias position positions
+
+      # @see https://developer.tradier.com/documentation/user/get-orders
+      # @see https://developer.tradier.com/documentation/accounts/get-account-orders
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @overload orders
+      #   Request a user's orders.
+      #   @return [Array<Tradier::Account>] An array of accounts with orders.
+      # @overload orders(account_number)
+      #   Request a specific account's orders.
+      #   @param [String] account_number An account number (optional).
+      #   @return [Array<Tradier::Order>] An array of [Tradier::Order] objects for a given account.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def orders(account_number=nil, options={})
+        if account_number
+          object_from_response(Tradier::API::Utils::Order, :get, "/accounts/#{account_number}/orders", options).body
+        else
+          object_from_response(Tradier::API::Utils::Account, :get, '/user/orders', options).body
+        end
+      end
+
+      # @see https://developer.tradier.com/documentation/user/get-gainloss
+      # @see https://developer.tradier.com/documentation/accounts/get-account-gainloss
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @overload gainloss
+      #   Request a user's cost basis.
+      #   @return [Array<Tradier::Account>] An array of accounts with cost-basis.
+      # @overload gainloss(account_number)
+      #   Request a specific account's cost basis.
+      #   @param [String] account_number An account number (optional).
+      #   @return [Array<Tradier::Position>] An array of [Tradier::Position] objects for a given account.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def gainloss(account_number=nil, options={})
+        if account_number
+          object_from_response(Tradier::API::Utils::Gainloss, :get, "/accounts/#{account_number}/gainloss", options).body
+        else
+          object_from_response(Tradier::API::Utils::Account, :get, '/user/gainloss', options).body
+        end
+      end
+
+      # @see https://developer.tradier.com/documentation/user/get-history
+      # @see https://developer.tradier.com/documentation/accounts/get-account-history
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @overload events
+      #   Request a user's events.
+      #   @return [Array<Tradier::Account>] An array of accounts with history.
+      # @overload events(account_number)
+      #   Request a specific account's events.
+      #   @param [String] account_number An account number (optional).
+      #   @return [Array<Tradier::Event>] An array of [Tradier::Event] objects for a given account.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def events(account_number=nil, options={})
+        if account_number
+          object_from_response(Tradier::API::Utils::Event, :get, "/accounts/#{account_number}/history", options).body
+        else
+          object_from_response(Tradier::API::Utils::Account, :get, '/user/history', options).body
+        end
+      end
+
+    end
+  end
+end

data/lib/tradier/api/markets.rb

@@ -0,0 +1,113 @@
+require 'tradier/api/utils'
+
+module Tradier
+  module API
+    module Markets
+      include Tradier::API::Utils
+
+      # @see https://developer.tradier.com/documentation/markets/get-quotes
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Obtain quotes.
+      # @param [String] symbols A comma delimited list of symbols.
+      # @return [Array<Tradier::Quote>] An array of expiration dates.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def quotes(symbols, options={})
+        options.merge!('symbols' => normalized_symbols(symbols))
+        object_from_response(Tradier::API::Utils::Quote, :get, '/markets/quotes', options).body
+      end
+      alias quote quotes
+
+      # @see https://developer.tradier.com/documentation/markets/get-options-chains
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Obtain an option chain.
+      # @param [String] symbol The underlier's symbol.
+      # @return [Array<Tradier::OptionQuote>] An array of option quotes.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def chains(symbol, options={})
+        options.merge!('symbol' => symbol)
+        object_from_response(Tradier::API::Utils::OptionQuote, :get, '/markets/options/chains', options).body
+      end
+      alias chain chains
+
+      # @see https://developer.tradier.com/documentation/markets/get-options-expirations
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Obtain an underlier's expiration dates.
+      # @param [String] symbol The underlier's symbol.
+      # @return [Array<Date>] An array of expiration dates.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def expirations(symbol)
+        object_from_response(Tradier::API::Utils::Expiration, :get, '/markets/options/expirations', :symbol => symbol).body
+      end
+
+      # @see https://developer.tradier.com/documentation/markets/get-options-strikes
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Obtain an underlier's expiration strikes for an expiration date.
+      # @param [String] symbol The underlier symbol.
+      # @param [String] expiration The expiration date.
+      # @return [Array<String>] An array of strike prices.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def strikes(symbol, expiration)
+        object_from_response(Tradier::API::Utils::Strike, :get, '/markets/options/strikes', :symbol => symbol, :expiration => expiration).body
+      end
+
+      # @see https://developer.tradier.com/documentation/markets/get-clock
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Obtain the market clock
+      # @return [Tradier::Clock] A clock.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def clock(options={})
+        object_from_response(Tradier::Clock, :get, '/markets/clock', options)
+      end
+
+      # @see https://developer.tradier.com/documentation/markets/get-calendar
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Obtain the market calendar
+      # @return [Tradier::Calendar] A calendar.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def calendar(options={})
+        object_from_response(Tradier::Calendar, :get, '/markets/calendar', options)
+      end
+
+      # @see https://developer.tradier.com/documentation/markets/get-timesales
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Get time and sales for a given symbol.
+      # @param [String] symbol The symbol.
+      # @return [Array<Tradier::Timesales>] An array of Time and Sales quotes.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def timesales(symbol, options={})
+        options.merge!('symbol' => symbol)
+        object_from_response(Tradier::API::Utils::Timesales, :get, '/markets/timesales', options).body
+      end
+
+      # @see https://developer.tradier.com/documentation/markets/get-history
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Get historical pricing for a given symbol.
+      # @param [String] symbol The symbol.
+      # @return [Array<Tradier::Event>] An array of historical quotes.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def history(symbol, options={})
+        options.merge!('symbol' => symbol)
+        object_from_response(Tradier::API::Utils::History, :get, '/markets/history', options).body
+      end
+
+      private
+
+      def normalized_symbols(symbols)
+        if symbols.is_a? Array
+          symbols.map(&:strip).join(',')
+        else
+          symbols
+        end
+      end
+
+    end
+  end
+end