tradier 0.1.0

data/lib/tradier/api/orders.rb

@@ -0,0 +1,84 @@
+require 'tradier/api/utils'
+
+module Tradier
+  module API
+    module Orders
+      include Tradier::API::Utils
+
+      # @see https://developer.tradier.com/documentation/trading/create-order
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Place an order.
+      # @param [Hash] options
+      # @option options [String] :account The account number.
+      # @return [Tradier::Order] An order.
+      # @raise [Tradier::Error::BadRequest] Error raised when supplied order is not valid.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def create_order(options={})
+        account = options.delete(:account)
+        object_from_response(Tradier::Order, :post, "/accounts/#{account}/orders", options)
+      end
+      alias place_order create_order
+      alias submit_order create_order
+
+      # @see https://developer.tradier.com/documentation/trading/preview-order
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Preview an order.
+      # @return [Tradier::Order] An order.
+      # @raise [Tradier::Error::BadRequest] Error raised when supplied order is not valid.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def preview_order(options={})
+        create_order(options.merge(preview: true))
+      end
+
+      # @see https://developer.tradier.com/documentation/trading/cancel-order
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Cancel an order.
+      # @param [Hash] options
+      # @option options [String] :account The account number.
+      # @option options [String] :id The id of the order.
+      # @return [Tradier::Order] An order.
+      # @raise [Tradier::Error::BadRequest] Error raised when supplied order is not valid.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def cancel_order(options={})
+        account = options.delete(:account)
+        id      = options.delete(:id)
+        object_from_response(Tradier::Order, :delete, "/accounts/#{account}/orders/#{id}", options)
+      end
+
+      # @see https://developer.tradier.com/documentation/accounts/get-account-order
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Retrieve an order.
+      # @param [Hash] options
+      # @option options [String] :account The account number.
+      # @option options [String] :id The id of the order.
+      # @return [Tradier::Order] An order.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def order(options={})
+        account = options.delete(:account)
+        id      = options.delete(:id)
+        object_from_response(Tradier::Order, :get, "/accounts/#{account}/orders/#{id}", options)
+      end
+
+      # @see https://developer.tradier.com/documentation/trading/change-order
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Update an order.
+      # @param [Hash] options
+      # @option options [String] :account The account number.
+      # @option options [String] :id The id of the order.
+      # @return [Tradier::Order] An order.
+      # @raise [Tradier::Error::BadRequest] Error raised when supplied order is not valid.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def update_order(options={})
+        account = options.delete(:account)
+        id      = options.delete(:id)
+        object_from_response(Tradier::Order, :put, "/accounts/#{account}/orders/#{id}", options)
+      end
+      alias change_order update_order
+    end
+  end
+end

data/lib/tradier/api/utils.rb

@@ -0,0 +1,47 @@
+require 'tradier/account'
+require 'tradier/balance'
+require 'tradier/calendar'
+require 'tradier/clock'
+require 'tradier/history'
+require 'tradier/option_quote'
+require 'tradier/order'
+require 'tradier/position'
+require 'tradier/profile'
+require 'tradier/quote'
+require 'tradier/timesales'
+require 'tradier/watchlist'
+require 'tradier/event'
+
+require 'tradier/api/utils/account'
+require 'tradier/api/utils/balance'
+require 'tradier/api/utils/expiration'
+require 'tradier/api/utils/gainloss'
+require 'tradier/api/utils/history'
+require 'tradier/api/utils/option_quote'
+require 'tradier/api/utils/order'
+require 'tradier/api/utils/position'
+require 'tradier/api/utils/quote'
+require 'tradier/api/utils/strike'
+require 'tradier/api/utils/timesales'
+require 'tradier/api/utils/watchlist'
+require 'tradier/api/utils/event'
+
+module Tradier
+  module API
+    module Utils
+
+      private
+
+      # @param klass [Class]
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @return [klass instance]
+      def object_from_response(klass, request_method, path, options={})
+        response_body = send(request_method.to_sym, path, options)[:body]
+        klass.from_response(response_body)
+      end
+
+    end
+  end
+end

data/lib/tradier/api/utils/account.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Account < Tradier::API::Utils::Base
+
+        def body
+          nested_array(Tradier::Account, [:accounts, :account])
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/balance.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Balance < Tradier::API::Utils::Base
+
+        def body
+          nested_array(Tradier::Balance, [:accounts, :account])
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/base.rb

@@ -0,0 +1,46 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Base
+
+        def self.from_response(body)
+          self.new(body)
+        end
+
+        def initialize(attrs)
+          @attrs = attrs
+        end
+
+        private
+
+        def nested_array(klass, response_path)
+          begin
+            nested_attrs = nested_response_body(response_path)
+            if nested_attrs.is_a?(Array)
+              nested_attrs.map do |element|
+                klass.from_response(element)
+              end
+            else
+              [klass.from_response(nested_attrs)]
+            end
+          rescue TypeError => e
+            []
+          end
+        end
+
+        def nested_response_body(path)
+          body = @attrs.dup
+
+          path.each do |p|
+            body = body[p]
+          end
+
+          body
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/event.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Event < Tradier::API::Utils::Base
+
+        def body
+          nested_array(Tradier::Event, [:history, :event])
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/expiration.rb

@@ -0,0 +1,19 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Expiration < Tradier::API::Utils::Base
+
+        def body
+          return [] unless @attrs[:expirations].kind_of?(Hash)
+
+          @attrs[:expirations].fetch(:date, []).map do |element|
+            Date.parse(element)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/gainloss.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Gainloss < Tradier::API::Utils::Base
+
+        def body
+          nested_array(Tradier::Position, [:gainloss, :closed_position])
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/history.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class History < Tradier::API::Utils::Base
+
+        def body
+          nested_array(Tradier::History, [:history, :day])
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/option_quote.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class OptionQuote < Tradier::API::Utils::Base
+
+        def body
+          nested_array(Tradier::OptionQuote, [:options, :option])
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/order.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Order < Tradier::API::Utils::Base
+
+        def body
+          nested_array(Tradier::Order, [:orders, :order])
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/position.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Position < Tradier::API::Utils::Base
+
+        def body
+          nested_array(Tradier::Position, [:positions, :position])
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/quote.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Quote < Tradier::API::Utils::Base
+
+        def body
+          nested_array(Tradier::Quote, [:quotes, :quote])
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/strike.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Strike < Tradier::API::Utils::Base
+
+        def body
+          @attrs[:strikes][:strike]
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/timesales.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Timesales < Tradier::API::Utils::Base
+
+        def body
+          nested_array(Tradier::Timesales, [:series, :data])
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/utils/watchlist.rb

@@ -0,0 +1,15 @@
+require 'tradier/api/utils/base'
+
+module Tradier
+  module API
+    module Utils
+      class Watchlist < Tradier::API::Utils::Base
+
+        def body
+          nested_array(Tradier::Watchlist, [:watchlists, :watchlist])
+        end
+
+      end
+    end
+  end
+end

data/lib/tradier/api/watchlists.rb

@@ -0,0 +1,139 @@
+require 'tradier/api/utils'
+
+module Tradier
+  module API
+    module Watchlists
+      include Tradier::API::Utils
+
+      # @see https://developer.tradier.com/documentation/watchlists/get-watchlists
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Get all watchlists.
+      # @return [Array<Tradier::Watchlist>] An array of watchlists.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def watchlists(options={})
+        response = object_from_response(Tradier::API::Utils::Watchlist, :get, '/watchlists', options).body
+      end
+
+      # @see https://developer.tradier.com/documentation/watchlists/get-specific-watchlist
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Get a watchlist.
+      # @param [String] id The watchlist id.
+      # @return [Tradier::Watchlist] A watchlist.
+      # @raise [Tradier::Error::NotFound] Error raised when watchlist is not found.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def watchlist(id, options={})
+        object_from_response(Tradier::Watchlist, :get, "/watchlists/#{id}", options)
+      end
+
+      # @see https://developer.tradier.com/documentation/watchlists/delete-watchlist
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Delete a watchlist.
+      # @param [String] id The watchlist id.
+      # @return [Boolean] Result of watchlist removal.
+      # @raise [Tradier::Error::NotFound] Error raised when watchlist is not found.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def delete_watchlist(id, options={})
+        send(:delete, "/watchlists/#{id}", options)[:status] == 200
+      end
+
+      # @see https://developer.tradier.com/documentation/watchlists/create-watchlist
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Create a new watchlist.
+      # @param [Hash] options
+      # @option options [String] :name The watchlist name.
+      # @return [Tradier::Watchlist] A watchlist.
+      # @raise [Tradier::Error::BadRequest] Error raised when request is not valid.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def create_watchlist(options={})
+        object_from_response(Tradier::Watchlist, :post, '/watchlists', options)
+      end
+
+      # @see https://developer.tradier.com/documentation/watchlists/update-watchlist
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Update a watchlist.
+      # @param [String] id The watchlist id.
+      # @param [Hash] options
+      # @option options [String] :name The watchlist name.
+      # @return [Tradier::Watchlist] A watchlist.
+      # @raise [Tradier::Error::BadRequest] Error raised when request is not valid.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def update_watchlist(id, options={})
+        object_from_response(Tradier::Watchlist, :put, "/watchlists/#{id}", options)
+      end
+
+      # @see https://developer.tradier.com/documentation/watchlists/update-watchlist
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Retrieve a watchlist symbol.
+      # @param [String] id The watchlist id.
+      # @param [String] symbol The watchlist symbol.
+      # @return [Tradier::WatchlistItem] A watchlist item.
+      # @raise [Tradier::Error::NotFound] Error raised when watchlist or watchlist item is not found.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def watchlist_item(id, symbol, options={})
+        object_from_response(Tradier::WatchlistItem, :get, "/watchlists/#{id}/symbols/#{symbol}", options)
+      end
+      alias watchlist_symbol watchlist_item
+
+      # @see https://developer.tradier.com/documentation/watchlists/add-watchlist-symbol
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Update a watchlist symbol.
+      # @param [String] id The watchlist id.
+      # @param [Hash] options
+      # @option options [String] :symbols A comma delimited list of symbols.
+      # @return [Tradier::Watchlist] A watchlist.
+      # @raise [Tradier::Error::BadRequest] Error raised when request is not valid.
+      # @raise [Tradier::Error::NotFound] Error raised when watchlist is not found.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def add_watchlist_item(id, options={})
+        object_from_response(Tradier::WatchlistItem, :post, "/watchlists/#{id}/symbols", options)
+      end
+      alias create_watchlist_item add_watchlist_item
+      alias create_watchlist_symbol add_watchlist_item
+      alias add_watchlist_symbol add_watchlist_item
+
+      # @see https://developer.tradier.com/documentation/watchlists/remove-watchlist-symbol
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Remove a watchlist symbol.
+      # @param [String] id The watchlist id.
+      # @param [String] symbol The watchlist symbol.
+      # @return [Tradier::Watchlist] A watchlist.
+      # @raise [Tradier::Error::NotFound] Error raised when watchlist or watchlist item is not found.
+      # @raise [Tradier::Error::BadRequest] Error raised when request is not valid.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def remove_watchlist_item(id, symbol, options={})
+        send(:delete, "/watchlists/#{id}/symbols/#{symbol}", options)[:status] == 200
+      end
+      alias delete_watchlist_item remove_watchlist_item
+      alias remove_watchlist_symbol remove_watchlist_item
+      alias delete_watchlist_symbol remove_watchlist_item
+
+      # @see https://developer.tradier.com/documentation/watchlists/update-watchlist-symbol
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Update a watchlist symbol.
+      # @param [String] id The watchlist id.
+      # @param [String] symbol The watchlist symbol.
+      # @param [Hash] options
+      # @option options [String] :shares The number of shares.
+      # @option options [String] :purchase_date The purchase date.
+      # @option options [String] :purchase_price The purchase price.
+      # @return [Tradier::WatchlistItem] A watchlist item.
+      # @raise [Tradier::Error::NotFound] Error raised when watchlist or watchlist item is not found.
+      # @raise [Tradier::Error::BadRequest] Error raised when request is not valid.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def update_watchlist_item(id, symbol, options={})
+        object_from_response(Tradier::WatchlistItem, :put, "/watchlists/#{id}/symbols/#{symbol}", options)
+      end
+      alias update_watchlist_symbol update_watchlist_item
+
+    end
+  end
+end