tradier 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30124d867ad0669164caf1168411031587a96c7c
-  data.tar.gz: 024088bd9a7dd623407140d98c419769c5cd4a57
+  metadata.gz: 449b7877390ee6691113e738fc3ebf638eecc09f
+  data.tar.gz: ec4c89c64ee72eb5665e92b7f4144a0353076075
 SHA512:
-  metadata.gz: 8d798c61ab95763abd04eb597b134353984a8728c12537bc6266deb651c20e8c943cc23236576567e07bad9ed4af6361ea7a6ecd43ad83a99251c30b9e5d6bd5
-  data.tar.gz: d515ae754f0f045109be9a6715c710b3f3b6fe2324bcde5e9f83ecb44fd589e11f92d86d4d6184000900af1f068c84ed674cd5813f83a47314300c61a1ae116d
+  metadata.gz: c7c24a2ca8b67075d6b5b2bea0aef327c0b044bee2bae19a61bbc5057821abcd390a79799630d2af8535cade2db7b82b2fada66244660bff99b11121aec2f612
+  data.tar.gz: 9610f12009bb0a19f1f01c78c0718d3e95278a1b131f29c9a0403e4081a7bd172798ca85099eaa26139acb778c3975997fb4fbfdcc632ab781fba09c206e02c1

data/lib/tradier/api/accounts.rb

@@ -108,6 +108,9 @@ module Tradier
       #   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.
+      # @overload events(account_number, options)
+      #   @option options [Integer] :limit Indicate the number of events to return for pagination.
+      #   @option options [Integer] ;offset Indicate the offset of results to return for pagination.
       # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
       def events(account_number=nil, options={})
         if account_number
@@ -116,6 +119,7 @@ module Tradier
           object_from_response(Tradier::API::Utils::Account, :get, '/user/history', options).body
         end
       end
+      alias :history :events
 
     end
   end

data/lib/tradier/api/markets.rb

@@ -112,6 +112,34 @@ module Tradier
         object_from_response(Tradier::EventSession, :post, '/markets/events/session', options)
       end
 
+      # @see https://developer.tradier.com/documentation/markets/get-search
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Search for a stock symbol using a keyword lookup.
+      # @param [String] q The company/index name to search for.
+      # @overload search(q, options)
+      #   @option options [Boolean] :indexes Indicate whether or not to include indexes in results.
+      # @return [Array<Tradier::Security>] An array of search results.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def search(q, options={})
+        options.merge!('q' => q)
+        object_from_response(Tradier::API::Utils::Search, :get, '/markets/search', options).body
+      end
+
+      # @see https://developer.tradier.com/documentation/markets/get-lookup
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # Lookup a symbol.
+      # @param [String] q The company/index name to search for.
+      # @overload lookup(q, options)
+      #   @option options [Boolean] :indexes Indicate whether or not to include indexes in results.
+      # @return [Array<Tradier::Security>] An array of lookup results.
+      # @raise [Tradier::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      def lookup(q, options={})
+        options.merge!('q' => q)
+        object_from_response(Tradier::API::Utils::Search, :get, '/markets/lookup', options).body
+      end
+
       private
 
       def normalized_symbols(symbols)

data/lib/tradier/api/utils.rb

@@ -9,6 +9,7 @@ require 'tradier/order'
 require 'tradier/position'
 require 'tradier/profile'
 require 'tradier/quote'
+require 'tradier/security'
 require 'tradier/timesales'
 require 'tradier/watchlist'
 require 'tradier/event'
@@ -23,6 +24,7 @@ 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/search'
 require 'tradier/api/utils/strike'
 require 'tradier/api/utils/timesales'
 require 'tradier/api/utils/watchlist'

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

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

data/lib/tradier/security.rb

@@ -0,0 +1,12 @@
+require 'tradier/base'
+
+module Tradier
+  class Security < Tradier::Base
+    attr_reader :symbol, :exchange, :description, :type
+
+    def ==(quote)
+      self.symbol == quote.symbol
+    end
+
+  end
+end

data/lib/tradier/version.rb

@@ -1,3 +1,3 @@
 module Tradier
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/fixtures/lookup.json

@@ -0,0 +1,114 @@
+{
+  "securities": {
+    "security": [
+      {
+        "symbol": "AAPL",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Apple Inc"
+      },
+      {
+        "symbol": "AA",
+        "exchange": "XNYS",
+        "type": "stock",
+        "description": "Alcoa Inc"
+      },
+      {
+        "symbol": "AAL",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "American Airlines Group Inc"
+      },
+      {
+        "symbol": "AAN",
+        "exchange": "XNYS",
+        "type": "stock",
+        "description": "Aaron's Inc"
+      },
+      {
+        "symbol": "AAP",
+        "exchange": "XNYS",
+        "type": "stock",
+        "description": "Advance Auto Parts Inc"
+      },
+      {
+        "symbol": "AAXJ",
+        "exchange": "XNAS",
+        "type": "etf",
+        "description": "iShares MSCI All Country Asia ex Japan Index Fund"
+      },
+      {
+        "symbol": "AAVL",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Avalanche Biotechnologies Inc"
+      },
+      {
+        "symbol": "AAOI",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Applied Optoelectronics Inc"
+      },
+      {
+        "symbol": "AAWW",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Atlas Air Worldwide Holdings Inc"
+      },
+      {
+        "symbol": "AAON",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "AAON Inc"
+      },
+      {
+        "symbol": "AAT",
+        "exchange": "XNYS",
+        "type": "stock",
+        "description": "American Assets Trust Inc"
+      },
+      {
+        "symbol": "AAME",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Atlantic American Corp"
+      },
+      {
+        "symbol": "AADR",
+        "exchange": "ARCX",
+        "type": "etf",
+        "description": "WCM BNY Mellon Focused Growth ADR ETF"
+      },
+      {
+        "symbol": "AAIT",
+        "exchange": "XNAS",
+        "type": "etf",
+        "description": "iShares MSCI All Country Asia Information Technology Index Fund"
+      },
+      {
+        "symbol": "AAMC",
+        "exchange": "XASE",
+        "type": "stock",
+        "description": "Altisource Asset Management Corp Com"
+      },
+      {
+        "symbol": "AAp",
+        "exchange": "XASE",
+        "type": "stock",
+        "description": "Alcoa Inc. $3.75 Preferred Stock"
+      },
+      {
+        "symbol": "AAU",
+        "exchange": "XASE",
+        "type": "stock",
+        "description": "Almaden Minerals, Ltd. Ordinary Shares (Canada)"
+      },
+      {
+        "symbol": "AAV",
+        "exchange": "XNYS",
+        "type": "stock",
+        "description": "Advantage Oil & Gas Ltd Ordinary Shares"
+      }
+    ]
+  }
+}

data/spec/fixtures/search.json

@@ -0,0 +1,54 @@
+{
+  "securities": {
+    "security": [
+      {
+        "symbol": "AAPL",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Apple Inc"
+      },
+      {
+        "symbol": "AMAT",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Applied Materials Inc"
+      },
+      {
+        "symbol": "AMCC",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Applied Micro Circuits Corp"
+      },
+      {
+        "symbol": "AREX",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Approach Resources Inc"
+      },
+      {
+        "symbol": "AAOI",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Applied Optoelectronics Inc"
+      },
+      {
+        "symbol": "AIT",
+        "exchange": "XNYS",
+        "type": "stock",
+        "description": "Applied Industrial Technologies Inc"
+      },
+      {
+        "symbol": "AGTC",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Applied Genetic Technologies Corp"
+      },
+      {
+        "symbol": "ARCI",
+        "exchange": "XNAS",
+        "type": "stock",
+        "description": "Appliance Recycling Centers Of America Inc"
+      }
+    ]
+  }
+}

data/spec/tradier/api/accounts_spec.rb

@@ -190,6 +190,16 @@ describe Tradier::API::Accounts do
         expect(events.first).to be_a Tradier::Account
       end
     end
+    context 'with pagination' do
+      before do
+        stub_get("/v1/accounts/123456789/history?limit=12&offset=2").
+        to_return(:body => fixture("account_history.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+      it "requests the correct resource" do
+        @client.events("123456789", :limit => 12, :offset => 2)
+        expect(a_get("/v1/accounts/123456789/history?limit=12&offset=2")).to have_been_made
+      end
+    end
   end
 
 end

data/spec/tradier/api/markets_spec.rb

@@ -255,4 +255,42 @@ describe Tradier::API::Markets do
       expect(session).to be_a Tradier::EventSession
     end
   end
+
+  describe '#search' do
+    before do
+      stub_get("/v1/markets/search").
+        with(:query => { :q => 'App'}).
+        to_return(:body => fixture("search.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "requests the correct resource" do
+      @client.search('App')
+      expect(a_get("/v1/markets/search?q=App")).to have_been_made
+    end
+
+    it "returns an array of Tradier::Security objects" do
+      results = @client.search('App')
+      expect(results).to be_an Array
+      expect(results.first).to be_a Tradier::Security
+    end
+  end
+
+  describe '#lookup' do
+    before do
+      stub_get("/v1/markets/lookup").
+        with(:query => { :q => 'AA'}).
+        to_return(:body => fixture("lookup.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "requests the correct resource" do
+      @client.lookup('AA')
+      expect(a_get("/v1/markets/lookup?q=AA")).to have_been_made
+    end
+
+    it "returns an array of Tradier::Security objects" do
+      results = @client.lookup('AA')
+      expect(results).to be_an Array
+      expect(results.first).to be_a Tradier::Security
+    end
+  end
 end

data/spec/tradier/client_spec.rb

@@ -116,8 +116,8 @@ describe Tradier::Client do
       subject.stub(:connection).and_raise(Faraday::Error::ClientError.new("Oops"))
       expect{subject.send(:request, :get, "/path")}.to raise_error Tradier::Error::ClientError
     end
-    it "catches MultiJson::DecodeError errors" do
-      subject.stub(:connection).and_raise(MultiJson::DecodeError.new("unexpected token", [], "<!DOCTYPE html>"))
+    it "catches MultiJson::ParseError errors" do
+      subject.stub(:connection).and_raise(MultiJson::ParseError.build(ArgumentError.new, "<!DOCTYPE html>"))
       expect{subject.send(:request, :get, "/path")}.to raise_error Tradier::Error::DecodeError
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tradier
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Steve Agalloco
@@ -9,62 +9,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: celluloid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
 description: Rubygem for interacting with the Tradier API.
@@ -75,7 +75,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .yardopts
+- ".yardopts"
 - LICENSE.md
 - README.md
 - Rakefile
@@ -97,6 +97,7 @@ files:
 - lib/tradier/api/utils/order.rb
 - lib/tradier/api/utils/position.rb
 - lib/tradier/api/utils/quote.rb
+- lib/tradier/api/utils/search.rb
 - lib/tradier/api/utils/strike.rb
 - lib/tradier/api/utils/timesales.rb
 - lib/tradier/api/utils/watchlist.rb
@@ -137,6 +138,7 @@ files:
 - lib/tradier/quote.rb
 - lib/tradier/response/parse_json.rb
 - lib/tradier/response/raise_error.rb
+- lib/tradier/security.rb
 - lib/tradier/symbol.rb
 - lib/tradier/timesales.rb
 - lib/tradier/version.rb
@@ -153,6 +155,7 @@ files:
 - spec/fixtures/expirations.json
 - spec/fixtures/expirations_with_strikes.json
 - spec/fixtures/history.json
+- spec/fixtures/lookup.json
 - spec/fixtures/option_quote.json
 - spec/fixtures/option_quotes.json
 - spec/fixtures/order.json
@@ -160,6 +163,7 @@ files:
 - spec/fixtures/placed_order.json
 - spec/fixtures/quote.json
 - spec/fixtures/quotes.json
+- spec/fixtures/search.json
 - spec/fixtures/session.json
 - spec/fixtures/strikes.json
 - spec/fixtures/timesales.json
@@ -208,12 +212,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -234,6 +238,7 @@ test_files:
 - spec/fixtures/expirations.json
 - spec/fixtures/expirations_with_strikes.json
 - spec/fixtures/history.json
+- spec/fixtures/lookup.json
 - spec/fixtures/option_quote.json
 - spec/fixtures/option_quotes.json
 - spec/fixtures/order.json
@@ -241,6 +246,7 @@ test_files:
 - spec/fixtures/placed_order.json
 - spec/fixtures/quote.json
 - spec/fixtures/quotes.json
+- spec/fixtures/search.json
 - spec/fixtures/session.json
 - spec/fixtures/strikes.json
 - spec/fixtures/timesales.json