questrade_api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28eb22cf9856de8e4e03c5d5b1a3f809a55144c4
-  data.tar.gz: 37db10221ed2dbf2bfba03c5331533da497359ce
+  metadata.gz: fc55678c85117d92ad613586840f18ea4a380e47
+  data.tar.gz: a4ca8fc7f3a6c99714f6d17cf0a18c1287879ca2
 SHA512:
-  metadata.gz: 128517e2915b03b3d5acfbbe354405f521d8b4f77d9bb1c005154bc9b3966de957e9649af40804c44f2da3f1208d4e2914adc3fa0f4075c8b0b2f0417d413ea5
-  data.tar.gz: f84b81cfb6aae10db6230783a7594cf9f944d282046accb6f3fb8936d7e370081dc365531ce6d43efe62ea52cf5e3de15d259b1501186ddc4b110faaf49c1e0d
+  metadata.gz: 5f627f715a2b4ad662954cd32ba0e6ffbfa5f7ea8678087fa32549244f8268ae22217d0fd914dd0bf52d0d3ba0a72d1a3f6a661968b64e49008a20e4f67a2c27
+  data.tar.gz: 41d579f99b870df5b496ac94dfe7127d5e72a4424e93eeb18a98c80cf582fb7046f90bbda10bfd55fdbc11bd1356acc9c11a18dbcdfbe9ce0926e587e2b6285a

data/README.md

@@ -55,7 +55,7 @@ client.search_symbols(prefix: 'BMO')
 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/0.0.2).
+For more advanced options, check out our [documentation](http://www.rubydoc.info/gems/questrade_api/0.0.4).
 
 ## Current Status
 
@@ -78,15 +78,16 @@ Check the tables below for more details.
 
 | Endpoint                   | Development   | Documentation |
 | ---                        | ---           | ---           |
-| /symbols/                  | DONE          |      |
-| /symbols/:id               |               |      |
-| /symbols/search            | DONE          |      |
-| /symbols/:id/options       |      |      |
+| /symbols/                  | DONE          |               |
+| /symbols/:id               |               |               |
+| /symbols/search            | DONE          |               |
+| /symbols/:id/options       | DONE          |               |
 | /markets                   | DONE          |               |
-| /markets/quotes/:id        |      |      |
-| /markets/quotes/options    |      |      |
-| /markets/quotes/strategies |      |      |
-| /markets/candles/:id       |      |      |
+| /markets/quotes/           | DONE          |               |
+| /markets/quotes/:id        | DONE          |               |
+| /markets/quotes/options    |               |               |
+| /markets/quotes/strategies |               |               |
+| /markets/candles/:id       | DONE          |               |
 
 ### Order Calls
 

data/lib/questrade_api/client.rb

@@ -9,6 +9,9 @@ require 'questrade_api/rest/order'
 
 require 'questrade_api/rest/market'
 require 'questrade_api/rest/symbol'
+require 'questrade_api/rest/quote'
+require 'questrade_api/rest/candle'
+require 'questrade_api/rest/option'
 
 module QuestradeApi
   # @author Bruno Meira <goesmeira@gmail.com>
@@ -86,6 +89,27 @@ module QuestradeApi
       QuestradeApi::REST::Symbol.search(@authorization, params)
     end
 
+    def quotes(ids)
+      QuestradeApi::REST::Quote.all(@authorization, ids)
+    end
+
+    def quote(id)
+      quote =
+        QuestradeApi::REST::Quote.new(authorization: @authorization, id: id)
+
+      quote.get
+
+      quote
+    end
+
+    def candles(symbol_id, params)
+      QuestradeApi::REST::Candle.all(@authorization, symbol_id, params)
+    end
+
+    def symbol_options(symbol_id)
+      QuestradeApi::REST::Option.all(@authorization, symbol_id)
+    end
+
     private
 
     def refresh_token?

data/lib/questrade_api/rest/base.rb

@@ -58,9 +58,9 @@ module QuestradeApi
 
       def get(params = {})
         response = @connection.get do |req|
-          req.path = self.class.endpoint
+          req.path = params[:endpoint] || self.class.endpoint
 
-          params.each do |key, value|
+          params.fetch(:params, []).each do |key, value|
             req.params[key] = value
           end
         end

data/lib/questrade_api/rest/candle.rb

@@ -0,0 +1,45 @@
+require 'questrade_api/rest/base'
+
+module QuestradeApi
+  module REST
+    class Candle < QuestradeApi::REST::Base
+      def initialize(params)
+        @raw_body = params[:data]
+        build_data(params[:data]) if @raw_body
+      end
+
+      def self.all(authorization, symbol_id, params)
+        response = super(access_token: authorization.access_token,
+                         endpoint: endpoint(symbol_id),
+                         url: authorization.url,
+                         params: params)
+
+        if response.status == 200
+          result = OpenStruct.new(candles: [])
+          result.candles = parse_candles(response.body)
+          response = result
+        end
+
+        response
+      end
+
+      def self.endpoint(symbol_id)
+        "#{BASE_ENDPOINT}/markets/candles/#{symbol_id}"
+      end
+
+      def self.parse_candles(body)
+        raw = JSON.parse(body)
+
+        candles = []
+
+        raw['candles'].each do |candle|
+          candles << new(data: candle)
+        end
+
+        candles
+      end
+
+      private_class_method :parse_candles
+    end
+  end
+end

data/lib/questrade_api/rest/option.rb

@@ -0,0 +1,44 @@
+require 'questrade_api/rest/base'
+
+module QuestradeApi
+  module REST
+    class Option < QuestradeApi::REST::Base
+      def initialize(params)
+        @raw_body = params[:data]
+        build_data(params[:data]) if @raw_body
+      end
+
+      def self.all(authorization, symbol_id)
+        response = super(access_token: authorization.access_token,
+                         endpoint: endpoint(symbol_id),
+                         url: authorization.url)
+
+        if response.status == 200
+          result = OpenStruct.new(options: [])
+          result.options = parse_options(response.body)
+          response = result
+        end
+
+        response
+      end
+
+      def self.endpoint(symbol_id)
+        "#{BASE_ENDPOINT}/symbol/#{symbol_id}/options"
+      end
+
+      def self.parse_options(body)
+        raw = JSON.parse(body)
+
+        options = []
+
+        raw['options'].each do |option|
+          options << new(data: option)
+        end
+
+        options
+      end
+
+      private_class_method :parse_options
+    end
+  end
+end

data/lib/questrade_api/rest/quote.rb

@@ -0,0 +1,75 @@
+require 'questrade_api/rest/base'
+
+module QuestradeApi
+  module REST
+    class Quote < QuestradeApi::REST::Base
+      attr_accessor :id
+
+      def initialize(params)
+        super(params[:authorization])
+        @id = params[:id]
+
+        @raw_body = params[:data]
+        build_data(params[:data]) if @raw_body
+      end
+
+      def get
+        response = super(endpoint: endpoint)
+
+        if response.status == 200
+          parse_quotes(response.body)
+        end
+
+        response
+      end
+
+      def self.all(authorization, ids)
+        response = super(access_token: authorization.access_token,
+                         endpoint: endpoint,
+                         url: authorization.url,
+                         params: { ids: ids.join(',') })
+
+        if response.status == 200
+          result = OpenStruct.new(quotes: [])
+          result.quotes = parse_quotes(authorization, response.body)
+          response = result
+        end
+
+        response
+      end
+
+      def endpoint
+        self.class.endpoint + "/#{id}"
+      end
+
+      def self.endpoint
+        "#{BASE_ENDPOINT}/markets/quotes"
+      end
+
+      def self.parse_quotes(authorization, body)
+        raw = JSON.parse(body)
+
+        quotes = []
+
+        raw['quotes'].each do |quote|
+          quotes << new(authorization: authorization,
+                        id: quote['symbolId'], data: quote)
+        end
+
+        quotes
+      end
+
+      private_class_method :parse_quotes
+
+      private
+
+      def parse_quotes(body)
+        raw = JSON.parse(body)
+
+        raw['quotes'].each do |quote|
+          build_data(quote)
+        end
+      end
+    end
+  end
+end

data/lib/questrade_api/version.rb

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

data/spec/fixtures/json/candles.json

@@ -0,0 +1,13 @@
+{
+  "candles": [
+    {
+      "start": "2014-01-02T00:00:00.000000-05:00",
+      "end": "2014-01-03T00:00:00.000000-05:00",
+      "low": 70.3,
+      "high": 70.78,
+      "open": 70.68,
+      "close": 70.73,
+      "volume": 983609
+    }
+  ]
+}

data/spec/fixtures/json/options.json

@@ -0,0 +1,33 @@
+{
+  "options": [
+    {
+      "expiryDate": "2015-01-17T00:00:00.000000-05:00",
+      "description": "BANK OF MONTREAL",
+      "listingExchange": "MX",
+      "optionExerciseType": "American",
+      "chainPerRoot": [
+        {
+          "root": "BMO",
+          "chainPerStrikePrice": [
+            {
+              "strikePrice": 60,
+              "callSymbolId": 6101993,
+              "putSymbolId": 6102009
+            },
+            {
+              "strikePrice": 62,
+              "callSymbolId": 6101994,
+              "putSymbolId": 6102010
+            },
+            {
+              "strikePrice": 64,
+              "callSymbolId": 6101995,
+              "putSymbolId": 6102011
+            }
+          ],
+          "multiplier": 100
+        }
+      ]
+    }
+  ]
+}

data/spec/fixtures/json/quote_01.json

@@ -0,0 +1,24 @@
+{
+  "quotes": [
+    {
+      "symbol": "THI.TO",
+      "symbolId": 38738,
+      "tier": "",
+      "bidPrice": 83.65,
+      "bidSize": 6500,
+      "askPrice": 83.67,
+      "askSize": 9100,
+      "lastTradePriceTrHrs": 83.66,
+      "lastTradePrice": 83.66,
+      "lastTradeSize": 3100,
+      "lastTradeTick": "Equal",
+      "lastTradeTime": "2014-10-24T20:06:40.131000-04:00",
+      "volume": 80483500,
+      "openPrice": 83.66,
+      "highPrice": 83.86,
+      "lowPrice": 83.66,
+      "delay": 0,
+      "isHalted": false
+    }
+  ]
+}

data/spec/fixtures/json/quotes.json

@@ -0,0 +1,24 @@
+{
+  "quotes": [
+    {
+      "symbol": "THI.TO",
+      "symbolId": 38738,
+      "tier": "",
+      "bidPrice": 83.65,
+      "bidSize": 6500,
+      "askPrice": 83.67,
+      "askSize": 9100,
+      "lastTradePriceTrHrs": 83.66,
+      "lastTradePrice": 83.66,
+      "lastTradeSize": 3100,
+      "lastTradeTick": "Equal",
+      "lastTradeTime": "2014-10-24T20:06:40.131000-04:00",
+      "volume": 80483500,
+      "openPrice": 83.66,
+      "highPrice": 83.86,
+      "lowPrice": 83.66,
+      "delay": 0,
+      "isHalted": false
+    }
+  ]
+}

data/spec/questrade_api/rest/candle_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'questrade_api/rest/candle'
+
+describe QuestradeApi::REST::Candle do
+  include JSONFixtures
+
+  let(:access_token) { 'XXXX' }
+  let(:url) { 'http://test.com'}
+  let(:authorization) { OpenStruct.new(access_token: access_token, url: url) }
+
+  context '.all' do
+    it 'fetches candle for an specific symbol' do
+      start_time = '2014-10-01T00:00:00-05:00'
+      end_time = '2014-10-01T00:00:00-05:00'
+      interval='OneDay'
+      stub_request(:get, 'http://test.com/v1/markets/candles/1010?startTime=2014-10-01T00:00:00-05:00&endTime=2014-10-01T00:00:00-05:00&interval=OneDay')
+         .to_return(status: 200, body: json_string('candles.json'))
+
+      params = {
+        startTime: start_time,
+        endTime: end_time,
+        interval: interval
+      }
+
+      response = QuestradeApi::REST::Candle.all(authorization, 1010, params)
+
+      expect(response.candles.size).to be(1)
+
+      first_candle = response.candles.first
+      expect(first_candle.data.to_h).to eq(
+        start: "2014-01-02T00:00:00.000000-05:00",
+        end: "2014-01-03T00:00:00.000000-05:00",
+        low: 70.3,
+        high: 70.78,
+        open: 70.68,
+        close: 70.73,
+        volume: 983609
+      )
+    end
+  end
+
+  context '.endpoint' do
+    it 'returns the right endpoint' do
+      url = "/v1/markets/candles/1019"
+      expect(QuestradeApi::REST::Candle.endpoint(1019)).to eq(url)
+    end
+  end
+end

data/spec/questrade_api/rest/option_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'questrade_api/rest/option'
+
+describe QuestradeApi::REST::Option do
+  include JSONFixtures
+
+  let(:access_token) { 'XXXX' }
+  let(:url) { 'http://test.com'}
+  let(:authorization) { OpenStruct.new(access_token: access_token, url: url) }
+
+  context '.all' do
+    it 'fetches option chain for an specific symbol' do
+       stub_request(:get, 'http://test.com/v1/symbol/9291/options')
+         .to_return(status: 200, body: json_string('options.json'))
+
+      response = QuestradeApi::REST::Option.all(authorization, 9291)
+
+      expect(response.options.size).to be(1)
+
+      first_option = response.options.first
+      expect(first_option.data.to_h).to eq(
+        expiry_date: '2015-01-17T00:00:00.000000-05:00',
+        description: 'BANK OF MONTREAL',
+        listing_exchange: 'MX',
+        option_exercise_type: 'American',
+        chain_per_root: [
+          {
+            "root" => "BMO",
+            "chainPerStrikePrice" => [
+              {
+                "strikePrice" => 60,
+                "callSymbolId" => 6101993,
+                "putSymbolId" => 6102009
+              },
+              {
+                "strikePrice" => 62,
+                "callSymbolId" => 6101994,
+                "putSymbolId" => 6102010
+              },
+              {
+                "strikePrice" => 64,
+                "callSymbolId" => 6101995,
+                "putSymbolId" => 6102011
+              }
+            ],
+            "multiplier" => 100
+          }
+        ]
+      )
+    end
+  end
+
+  context '.endpoint' do
+    it 'returns the right endpoint' do
+      url = "/v1/symbol/#{10}/options"
+      expect(QuestradeApi::REST::Option.endpoint(10)).to eq(url)
+    end
+  end
+end

data/spec/questrade_api/rest/quote_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'questrade_api/rest/quote'
+
+describe QuestradeApi::REST::Quote do
+  include JSONFixtures
+
+  let(:access_token) { 'XXXX' }
+  let(:url) { 'http://test.com'}
+  let(:authorization) { OpenStruct.new(access_token: access_token, url: url) }
+
+  context '#endpoint' do
+    subject { QuestradeApi::REST::Quote.new(authorization: authorization, id: 10) }
+
+    it 'returns the right endpoint' do
+      url = "/v1/markets/quotes/#{10}"
+
+      expect(subject.endpoint).to eq(url)
+    end
+  end
+
+  context '#get' do
+    subject { QuestradeApi::REST::Quote.new(authorization: authorization, id: 10) }
+
+    it 'fetches quote data' do
+      stub_request(:get, 'http://test.com/v1/markets/quotes/10')
+         .to_return(status: 200, body: json_string('quote_01.json'))
+
+      expect(subject.data).to be_nil
+
+      subject.get
+
+      expect(subject.data.to_h).to eq(
+        symbol: "THI.TO",
+        symbol_id: 38738,
+        tier: "",
+        bid_price: 83.65,
+        bid_size: 6500,
+        ask_price: 83.67,
+        ask_size: 9100,
+        last_trade_price_tr_hrs: 83.66,
+        last_trade_price: 83.66,
+        last_trade_size: 3100,
+        last_trade_tick: "Equal",
+        last_trade_time: "2014-10-24T20:06:40.131000-04:00",
+        volume: 80483500,
+        open_price: 83.66,
+        high_price: 83.86,
+        low_price: 83.66,
+        delay: 0,
+        is_halted: false
+      )
+    end
+  end
+
+  context '.all' do
+    it 'fetches quote for an specific symbol' do
+      stub_request(:get, 'http://test.com/v1/markets/quotes?ids=12,11')
+         .to_return(status: 200, body: json_string('quotes.json'))
+
+      response = QuestradeApi::REST::Quote.all(authorization, [12, 11])
+
+      expect(response.quotes.size).to be(1)
+
+      first_quote = response.quotes.first
+      expect(first_quote.data.to_h).to eq(
+        symbol: "THI.TO",
+        symbol_id: 38738,
+        tier: "",
+        bid_price: 83.65,
+        bid_size: 6500,
+        ask_price: 83.67,
+        ask_size: 9100,
+        last_trade_price_tr_hrs: 83.66,
+        last_trade_price: 83.66,
+        last_trade_size: 3100,
+        last_trade_tick: "Equal",
+        last_trade_time: "2014-10-24T20:06:40.131000-04:00",
+        volume: 80483500,
+        open_price: 83.66,
+        high_price: 83.86,
+        low_price: 83.66,
+        delay: 0,
+        is_halted: false
+      )
+    end
+  end
+
+  context '.endpoint' do
+    it 'returns the right endpoint' do
+      url = "/v1/markets/quotes"
+      expect(QuestradeApi::REST::Quote.endpoint).to eq(url)
+    end
+  end
+end

data/spec/questrade_api/rest/symbol_spec.rb

@@ -10,6 +10,10 @@ describe QuestradeApi::REST::Symbol do
   let(:url) { 'http://test.com'}
   let(:authorization) { OpenStruct.new(access_token: access_token, url: url) }
 
+  context '#get' do
+    
+  end
+
   context '.search' do
     let(:prefix) { 'BMO' }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: questrade_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Bruno Meira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -90,10 +90,13 @@ files:
 - lib/questrade_api/rest/activity.rb
 - lib/questrade_api/rest/balance.rb
 - lib/questrade_api/rest/base.rb
+- lib/questrade_api/rest/candle.rb
 - lib/questrade_api/rest/execution.rb
 - lib/questrade_api/rest/market.rb
+- lib/questrade_api/rest/option.rb
 - lib/questrade_api/rest/order.rb
 - lib/questrade_api/rest/position.rb
+- lib/questrade_api/rest/quote.rb
 - lib/questrade_api/rest/symbol.rb
 - lib/questrade_api/rest/time.rb
 - lib/questrade_api/version.rb
@@ -101,10 +104,14 @@ files:
 - spec/fixtures/json/accounts.json
 - spec/fixtures/json/activities.json
 - spec/fixtures/json/balances.json
+- spec/fixtures/json/candles.json
 - spec/fixtures/json/executions.json
 - spec/fixtures/json/markets.json
+- spec/fixtures/json/options.json
 - spec/fixtures/json/orders.json
 - spec/fixtures/json/positions.json
+- spec/fixtures/json/quote_01.json
+- spec/fixtures/json/quotes.json
 - spec/fixtures/json/symbols.json
 - spec/fixtures/json/symbols_search.json
 - spec/fixtures/json/time.json
@@ -113,10 +120,13 @@ files:
 - spec/questrade_api/rest/account_spec.rb
 - spec/questrade_api/rest/activity_spec.rb
 - spec/questrade_api/rest/balance_spec.rb
+- spec/questrade_api/rest/candle_spec.rb
 - spec/questrade_api/rest/execution_spec.rb
 - spec/questrade_api/rest/market_spec.rb
+- spec/questrade_api/rest/option_spec.rb
 - spec/questrade_api/rest/order_spec.rb
 - spec/questrade_api/rest/position_spec.rb
+- spec/questrade_api/rest/quote_spec.rb
 - spec/questrade_api/rest/symbol_spec.rb
 - spec/questrade_api/rest/time_spec.rb
 - spec/spec_helper.rb
@@ -141,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: An elegant Ruby gem to interact with Questrade API
@@ -149,10 +159,14 @@ test_files:
 - spec/fixtures/json/accounts.json
 - spec/fixtures/json/activities.json
 - spec/fixtures/json/balances.json
+- spec/fixtures/json/candles.json
 - spec/fixtures/json/executions.json
 - spec/fixtures/json/markets.json
+- spec/fixtures/json/options.json
 - spec/fixtures/json/orders.json
 - spec/fixtures/json/positions.json
+- spec/fixtures/json/quote_01.json
+- spec/fixtures/json/quotes.json
 - spec/fixtures/json/symbols.json
 - spec/fixtures/json/symbols_search.json
 - spec/fixtures/json/time.json
@@ -161,10 +175,13 @@ test_files:
 - spec/questrade_api/rest/account_spec.rb
 - spec/questrade_api/rest/activity_spec.rb
 - spec/questrade_api/rest/balance_spec.rb
+- spec/questrade_api/rest/candle_spec.rb
 - spec/questrade_api/rest/execution_spec.rb
 - spec/questrade_api/rest/market_spec.rb
+- spec/questrade_api/rest/option_spec.rb
 - spec/questrade_api/rest/order_spec.rb
 - spec/questrade_api/rest/position_spec.rb
+- spec/questrade_api/rest/quote_spec.rb
 - spec/questrade_api/rest/symbol_spec.rb
 - spec/questrade_api/rest/time_spec.rb
 - spec/spec_helper.rb