questrade_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49d2e66e9476e189911591ed7fac0b63134b2fce
-  data.tar.gz: c941e8f74073691030eaed6bd8066c1af859b88b
+  metadata.gz: 28eb22cf9856de8e4e03c5d5b1a3f809a55144c4
+  data.tar.gz: 37db10221ed2dbf2bfba03c5331533da497359ce
 SHA512:
-  metadata.gz: 7895d0c76f3515bad23d095557f010f0d1d8528a660557335a7b05e2c3aeec99baa586f4f6685ee59f93c8dc2987fa56248ab29bc2c9246fc8066ae29302dd61
-  data.tar.gz: edf1116607c99e92f40e7618809eb5ee7d4995e2d5c651001ce3649f017892bcf04de3baf59ad467d358befcb27cdd1fd338e62d008dd8723557dd86123bc922
+  metadata.gz: 128517e2915b03b3d5acfbbe354405f521d8b4f77d9bb1c005154bc9b3966de957e9649af40804c44f2da3f1208d4e2914adc3fa0f4075c8b0b2f0417d413ea5
+  data.tar.gz: f84b81cfb6aae10db6230783a7594cf9f944d282046accb6f3fb8936d7e370081dc365531ce6d43efe62ea52cf5e3de15d259b1501186ddc4b110faaf49c1e0d

data/Gemfile

@@ -7,6 +7,7 @@ group :docs do
 end
 
 group :test do
+  gem 'byebug'
   gem 'guard'
   gem 'guard-rspec'
   gem 'bundler', '~> 1.14'

data/README.md

@@ -44,12 +44,18 @@ client.positions('account_id')
 # Activities of an specific period of time for an specific account
 client.activities('account_id', startTime: DateTime.yesterday.to_s, endTime: DateTime.now.to_s)
 
+# Symbols by name
+client.symbols(names: ['AAPL'])
+
+# Search symbols by prefix
+client.search_symbols(prefix: 'BMO')
+
 # In case you already have a valid access token and its respective URL, you can use the QuestradeApi::REST objects. Example:
 # authorization can be any object that responds to url and access_token
 authorization = QuestradeApi::Authorization.new(access_token: 'access_token', api_server: 'url')
 accounts = QuestradeApi::REST::Account.all(accounts)
 ```
-For more advanced options, check out our [documentation](http://www.rubydoc.info/gems/questrade_api).
+For more advanced options, check out our [documentation](http://www.rubydoc.info/gems/questrade_api/0.0.2).
 
 ## Current Status
 
@@ -72,10 +78,11 @@ Check the tables below for more details.
 
 | Endpoint                   | Development   | Documentation |
 | ---                        | ---           | ---           |
-| /symbols/:id               |      |      |
-| /symbols/:search           |      |      |
+| /symbols/                  | DONE          |      |
+| /symbols/:id               |               |      |
+| /symbols/search            | DONE          |      |
 | /symbols/:id/options       |      |      |
-| /markets                   |DONE|      |
+| /markets                   | DONE          |               |
 | /markets/quotes/:id        |      |      |
 | /markets/quotes/options    |      |      |
 | /markets/quotes/strategies |      |      |

data/lib/questrade_api/client.rb

@@ -8,6 +8,7 @@ require 'questrade_api/rest/activity'
 require 'questrade_api/rest/order'
 
 require 'questrade_api/rest/market'
+require 'questrade_api/rest/symbol'
 
 module QuestradeApi
   # @author Bruno Meira <goesmeira@gmail.com>
@@ -77,6 +78,14 @@ module QuestradeApi
       QuestradeApi::REST::Market.all(@authorization)
     end
 
+    def symbols(params)
+      QuestradeApi::REST::Symbol.all(@authorization, params)
+    end
+
+    def search_symbols(params)
+      QuestradeApi::REST::Symbol.search(@authorization, params)
+    end
+
     private
 
     def refresh_token?

data/lib/questrade_api/rest/symbol.rb

@@ -0,0 +1,78 @@
+require 'questrade_api/rest/base'
+
+module QuestradeApi
+  module REST
+    class Symbol < QuestradeApi::REST::Base
+      attr_accessor :id
+
+      def initialize(authorization, params = {})
+        super(authorization)
+
+        @id = params[:id]
+
+        @raw_body = params[:data]
+        build_data(params[:data]) if @raw_body
+      end
+
+      def self.endpoint(extra = '')
+        "#{BASE_ENDPOINT}/symbols/#{extra}"
+      end
+
+      def self.search(authorization, params = {})
+        response = superclass.all(access_token: authorization.access_token,
+                                  endpoint: endpoint('search'),
+                                  url: authorization.url,
+                                  params: params)
+
+        if response.status == 200
+          result = OpenStruct.new(symbols: [])
+          result.symbols = parse_symbols(authorization, response.body)
+          response = result
+        end
+
+        response
+      end
+
+      def self.all(authorization, params = {})
+        params[:ids] = params[:ids].join(',') if params[:ids]
+        params[:names] = params[:names].join(',') if params[:names]
+
+        response = super(access_token: authorization.access_token,
+                         endpoint: endpoint,
+                         url: authorization.url,
+                         params: params)
+
+        if response.status == 200
+          result = OpenStruct.new(symbols: [])
+          result.symbols = parse_symbols(authorization, response.body)
+          response = result
+        end
+
+        response
+      end
+
+      # TODO: Review this later
+      def self.parse_symbols(authorization, body)
+        raw = JSON.parse(body)
+
+        symbols = []
+
+        if raw['symbols']
+          raw['symbols'].each do |symbol|
+            symbols << new(authorization, id: symbol['symbolId'], data: symbol)
+          end
+        end
+
+        if raw['symbol']
+          raw['symbol'].each do |symbol|
+            symbols << new(authorization, id: symbol['symbolId'], data: symbol)
+          end
+        end
+
+        symbols
+      end
+
+      private_class_method :parse_symbols
+    end
+  end
+end

data/lib/questrade_api/version.rb

@@ -1,3 +1,3 @@
 module QuestradeApi
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/spec/fixtures/json/symbols.json

@@ -0,0 +1,51 @@
+{
+  "symbols": [
+    {
+      "symbol": "AAPL",
+      "symbolId": 8049,
+      "prevDayClosePrice": 102.5,
+      "highPrice52": 102.9,
+      "lowPrice52": 63.89,
+      "averageVol3Months": 43769680,
+      "averageVol20Days": 12860370,
+      "outstandingShares": 5987867000,
+      "eps": 6.2,
+      "pe": 16.54,
+      "dividend": 0.47,
+      "yield": 1.84,
+      "exDate": "2014-08-07T00:00:00.000000-04:00",
+      "marketCap": 613756367500,
+      "tradeUnit": 1,
+      "optionType": null,
+      "optionDurationType": null,
+      "optionRoot": "",
+      "optionContractDeliverables": {
+        "underlyings": [],
+        "cashInLieu": 0
+      },
+      "optionExerciseType": null,
+      "listingExchange": "NASDAQ",
+      "description": "APPLE INC",
+      "securityType": "Stock",
+      "optionExpiryDate": null,
+      "dividendDate": "2014-08-14T00:00:00.000000-04:00",
+      "optionStrikePrice": null,
+      "isTradable": true,
+      "isQuotable": true,
+      "hasOptions": true,
+      "minTicks": [
+        {
+          "pivot": 0,
+          "minTick": 0.0001
+        },
+        {
+          "pivot": 1,
+          "minTick": 0.01
+        }
+      ],
+      "industrySector": "BasicMaterials",
+      "industryGroup":  "Steel",
+      "industrySubGroup": "Steel"
+    }
+  ]
+}

data/spec/fixtures/json/symbols_search.json

@@ -0,0 +1,24 @@
+{
+  "symbol": [
+    {
+      "symbol": "BMO",
+      "symbolId": 9292,
+      "description": "BANK OF MONTREAL",
+      "securityType": "Stock",
+      "listingExchange": "NYSE",
+      "isTradable": true,
+      "isQuotable": true,
+      "currency": "USD"
+    },
+    {
+      "symbol": "BMO.PRJ.TO",
+      "symbolId": 9300,
+      "description": "BANK OF MONTREAL CL B SR 13",
+      "securityType": "Stock",
+      "listingExchange": "TSX",
+      "isTradable": true,
+      "isQuotable": true,
+      "currency": "CAD"
+    }
+  ]
+}

data/spec/questrade_api/rest/activity_spec.rb

@@ -12,8 +12,8 @@ describe QuestradeApi::REST::Activity do
 
   context '.all' do
     it "returns an object that contains a list of all user's activities for the specific period" do
-      start_time = DateTime.now.to_s
-      end_time = DateTime.now.to_s
+      start_time = '2011-02-16T00:00:00.000000-05:00'
+      end_time = '2011-02-16T00:00:00.000000-05:00'
       params = "startTime=#{start_time}&endTime=#{end_time}"
       full_url =
         url + QuestradeApi::REST::Activity.endpoint(account_id) + "?#{params}"

data/spec/questrade_api/rest/execution_spec.rb

@@ -12,8 +12,8 @@ describe QuestradeApi::REST::Execution do
 
   context '.all' do
     it "returns an object that contains a list of all user's executions for the specific period" do
-      start_time = DateTime.now.to_s
-      end_time = DateTime.now.to_s
+      start_time = '2014-03-31T13:38:29-04:00'
+      end_time = '2014-03-31T13:38:29-04:00'
       params = "startTime=#{start_time}&endTime=#{end_time}"
       full_url =
         url + QuestradeApi::REST::Execution.endpoint(account_id) + "?#{params}"

data/spec/questrade_api/rest/order_spec.rb

@@ -12,7 +12,7 @@ describe QuestradeApi::REST::Order do
 
   context '.all' do
     it "returns an object that contains a list of all user's orders" do
-      time = DateTime.now.to_s
+      time = '2014-03-31T13:38:29-04:00'
       params = "startTime=#{time}&endTime=#{time}&stateFilter=All"
       full_url =
         url + QuestradeApi::REST::Order.endpoint(account_id) + "?#{params}"

data/spec/questrade_api/rest/symbol_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+require 'questrade_api/rest/symbol'
+
+describe QuestradeApi::REST::Symbol do
+  include JSONFixtures
+
+  let(:access_token) { 'XXXX' }
+  let(:account_id) { '123456' }
+  let(:url) { 'http://test.com'}
+  let(:authorization) { OpenStruct.new(access_token: access_token, url: url) }
+
+  context '.search' do
+    let(:prefix) { 'BMO' }
+
+    it 'calls endpoint passing prefix' do
+      stub_request(:get, "http://test.com/v1/symbols/search?prefix=#{prefix}")
+        .to_return(status: 200, body: '{}').times(1)
+      response = QuestradeApi::REST::Symbol.search(authorization, prefix: prefix)
+
+      expect(response.symbols.size).to be(0)
+    end
+
+    it 'calls endpoint passing offset' do
+      stub_request(:get, "http://test.com/v1/symbols/search?offset=2")
+        .to_return(status: 200, body: '{}').times(1)
+      response = QuestradeApi::REST::Symbol.search(authorization, offset: 2)
+
+      expect(response.symbols.size).to be(0)
+    end
+
+    it 'returns an object that contains a list of searched symbols' do
+      stub_request(:get, "http://test.com/v1/symbols/search?prefix=#{prefix}")
+        .to_return(status: 200, body: json_string('symbols_search.json'))
+      response = QuestradeApi::REST::Symbol.search(authorization, prefix: prefix)
+
+      expect(response.symbols.size).to be(2)
+
+      first_symbol = response.symbols.first
+      expect(first_symbol.id).to eq(9292)
+      expect(first_symbol.data.to_h).to eq(
+        symbol: "BMO",
+        symbol_id: 9292,
+        description: "BANK OF MONTREAL",
+        security_type: "Stock",
+        listing_exchange: "NYSE",
+        is_tradable: true,
+        is_quotable: true,
+        currency: "USD"
+      )
+
+      last_symbol = response.symbols.last
+      expect(last_symbol.id).to eq(9300)
+      expect(last_symbol.data.to_h).to eq(
+        symbol: "BMO.PRJ.TO",
+        symbol_id: 9300,
+        description: "BANK OF MONTREAL CL B SR 13",
+        security_type: "Stock",
+        listing_exchange: "TSX",
+        is_tradable: true,
+        is_quotable: true,
+        currency: "CAD"
+      )
+    end
+  end
+
+  context '.all' do
+    let(:ids) { [8049, 8050] }
+    let(:names) { ['AAPL', 'GOOGL'] }
+
+    it 'calls endpoint passing a list of ids' do
+      stub_request(:get, "http://test.com/v1/symbols/?ids=8049,8050")
+        .to_return(status: 200, body: '{}').times(1)
+      response = QuestradeApi::REST::Symbol.all(authorization, ids: ids)
+
+      expect(response.symbols.size).to be(0)
+    end
+
+    it 'calls endpoint passing a list of names' do
+      stub_request(:get, "http://test.com/v1/symbols/?names=AAPL,GOOGL")
+        .to_return(status: 200, body: '{}')
+      response = QuestradeApi::REST::Symbol.all(authorization, names: names)
+
+      expect(response.symbols.size).to be(0)
+    end
+
+    it 'returns an object that contains a list of symbols' do
+      stub_request(:get, "http://test.com/v1/symbols/")
+        .to_return(status: 200, body: json_string('symbols.json'))
+
+      response = QuestradeApi::REST::Symbol.all(authorization)
+
+      expect(response.symbols.size).to be(1)
+
+      first_symbol = response.symbols.first
+      expect(first_symbol.id).to eq(8049)
+      expect(first_symbol.data.to_h).to eq(
+        symbol: 'AAPL',
+        symbol_id: 8049,
+        prev_day_close_price: 102.5,
+        high_price52: 102.9,
+        low_price52: 63.89,
+        average_vol3_months: 43769680,
+        average_vol20_days: 12860370,
+        outstanding_shares: 5987867000,
+        eps: 6.2,
+        pe: 16.54,
+        dividend: 0.47,
+        yield: 1.84,
+        ex_date: "2014-08-07T00:00:00.000000-04:00",
+        market_cap: 613756367500,
+        trade_unit: 1,
+        option_type: nil,
+        option_duration_type: nil,
+        option_root: "",
+        option_contract_deliverables: {
+          'underlyings' => [],
+          'cashInLieu' => 0
+        },
+        option_exercise_type: nil,
+        listing_exchange: "NASDAQ",
+        description: "APPLE INC",
+        security_type: "Stock",
+        option_expiry_date: nil,
+        dividend_date: "2014-08-14T00:00:00.000000-04:00",
+        option_strike_price: nil,
+        is_tradable: true,
+        is_quotable: true,
+        has_options: true,
+        min_ticks: [
+          {
+            'pivot' => 0,
+            'minTick' => 0.0001
+          },
+          {
+            'pivot' => 1,
+            'minTick' => 0.01
+          }
+        ],
+        industry_sector: "BasicMaterials",
+        industry_group:  "Steel",
+        industry_sub_group: "Steel")
+    end
+  end
+
+  context '.endpoint' do
+    it 'calls endpoint with no param passed' do
+      url = "/v1/symbols/"
+      expect(QuestradeApi::REST::Symbol.endpoint).to eq(url)
+    end
+
+    it 'calls endpoint with param passed' do
+      url = "/v1/symbols/search"
+      expect(QuestradeApi::REST::Symbol.endpoint('search')).to eq(url)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: questrade_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Bruno Meira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -94,6 +94,7 @@ files:
 - lib/questrade_api/rest/market.rb
 - lib/questrade_api/rest/order.rb
 - lib/questrade_api/rest/position.rb
+- lib/questrade_api/rest/symbol.rb
 - lib/questrade_api/rest/time.rb
 - lib/questrade_api/version.rb
 - questrade_api.gemspec
@@ -104,6 +105,8 @@ files:
 - spec/fixtures/json/markets.json
 - spec/fixtures/json/orders.json
 - spec/fixtures/json/positions.json
+- spec/fixtures/json/symbols.json
+- spec/fixtures/json/symbols_search.json
 - spec/fixtures/json/time.json
 - spec/questrade_api/authorization_spec.rb
 - spec/questrade_api/client_spec.rb
@@ -114,6 +117,7 @@ files:
 - spec/questrade_api/rest/market_spec.rb
 - spec/questrade_api/rest/order_spec.rb
 - spec/questrade_api/rest/position_spec.rb
+- spec/questrade_api/rest/symbol_spec.rb
 - spec/questrade_api/rest/time_spec.rb
 - spec/spec_helper.rb
 - spec/support/json_fixtures.rb
@@ -137,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An elegant Ruby gem to interact with Questrade API
@@ -149,6 +153,8 @@ test_files:
 - spec/fixtures/json/markets.json
 - spec/fixtures/json/orders.json
 - spec/fixtures/json/positions.json
+- spec/fixtures/json/symbols.json
+- spec/fixtures/json/symbols_search.json
 - spec/fixtures/json/time.json
 - spec/questrade_api/authorization_spec.rb
 - spec/questrade_api/client_spec.rb
@@ -159,6 +165,7 @@ test_files:
 - spec/questrade_api/rest/market_spec.rb
 - spec/questrade_api/rest/order_spec.rb
 - spec/questrade_api/rest/position_spec.rb
+- spec/questrade_api/rest/symbol_spec.rb
 - spec/questrade_api/rest/time_spec.rb
 - spec/spec_helper.rb
 - spec/support/json_fixtures.rb