questrade_api 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3648ccbf7f83b5173c5606b74b047e0e3c0e71d0
-  data.tar.gz: 8ae0d104853ccb59ae7604ba53749dde2c5bb625
+  metadata.gz: b4ce5fe5a4b01f8455e79cb80476d4426c1e9530
+  data.tar.gz: 747bd6e4053f03cc36ead638ceecd27baf5cc80e
 SHA512:
-  metadata.gz: e8153c221b4f6e8250bfe1e0aa6c83fda5432e702c38cafb398b22dd610a437b397dc759755638c4d33cb92931a18cb4b3284b8995cec581f07b13350eb9bdd3
-  data.tar.gz: c59f4a154528e5d44d56ce8bc93c6cad553454327f3ebd4ec072aedb343ec8068d1db04260aa3102a86c2e54656018f8e22e978d9dbc823223d4546d3371768d
+  metadata.gz: 4cea9d006d79006b2af8c8f2093d480e347118c79243ab295705bd9ed3eb9983bebdc59c53e4398db2c5507d9d1f1efc95ee3222d2bf149d8faad688d7fd05da
+  data.tar.gz: beaa6a59a7f869a3a38daa96dc2b7ed81a239b26dfb97f9c82a5e7aff71bb77d6b5493aae686ceb3eb1b1c18611287375b1aa6c4c88342ba453de9f1b9aaffd2

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
   - 2.3.0
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0

data/Gemfile

@@ -8,9 +8,7 @@ end
 
 group :test do
   gem 'byebug'
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'bundler', '~> 1.14'
+  gem 'bundler'
 end
 
 gem 'rake'

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/questrade_api.svg)](https://badge.fury.io/rb/questrade_api)
 [![Build Status](https://travis-ci.org/brunomeira/questrade_api.svg?branch=master)](https://travis-ci.org/brunomeira/questrade_api) 
 [![Code Climate](https://codeclimate.com/github/brunomeira/questrade_api/badges/gpa.svg)](https://codeclimate.com/github/brunomeira/questrade_api)
 
@@ -19,14 +20,31 @@ gem 'questrade_api'
 $ bundle
 ```
 - Follow the tutorial on <http://www.questrade.com/api/documentation/getting-started> to generate a refresh token
-- Copy the snippet of code below to your application, and replace the 'XXXX' token with the token generated in the previous step.
+
+### Authorization
+
+- After getting the refresh token from Questrade, you are now ready to ask for an access token. In order to fetch an access token, copy the snippet of code below and replace the example token with your refresh token.
 
 ```ruby
 # By default this API calls the practice(demo) endpoint.
-# Check our documentation to learn how to call the live endpoint.
 client = QuestradeApi::Client.new(refresh_token: 'XXXX')
+
+# If you want to call the live platform you need to pass :live as a parameter. Ex:
+client = QuestradeApi::Client.new(refresh_token: 'XXXX', :live)
+
+# Both calls automatically ask for a new access token
+
+
+# In case you already have an access token and a api_server, you can instead use:
+client = QuestradeApi::Client.new(access_token: 'XXXX', api_server: 'XXXX', :live)
+
+# To ask for a new access token(Questrade invalidates tokens every 30 mins), simply call:
+client.refresh_token # Make sure client has a valid refresh_token
 ```
-- That's all you need to access the API. A few examples of what you can do with it:
+
+### Some examples:
+
+- After fetching a valid access token, you are now ready to use the API. Below you can find a few examples of the calls you can make with the gem.
 
 ```ruby
 # Get Questrade's current server time
@@ -44,18 +62,30 @@ 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)
 
+# Symbol by ID
+client.symbol('id')
+
 # Symbols by name
 client.symbols(names: ['AAPL'])
 
 # Search symbols by prefix
 client.search_symbols(prefix: 'BMO')
 
+# List of quotes
+client.quotes(['123', '456'])
+
+# Quote details
+client.quote('123')
+
+# Historical Market in candlestick format
+client.candles('123', startTime: DateTime.yesterday.to_s, endTime: DateTime.now.to_s)
+
 # 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.fetch(accounts)
 ```
-For more advanced options, check out our [documentation](http://www.rubydoc.info/gems/questrade_api/0.0.4).
+For more advanced options, check out our [documentation](http://www.rubydoc.info/gems/questrade_api/1.0.0).
 
 ## Current Status
 

data/lib/questrade_api/modules/market_call.rb

@@ -14,6 +14,13 @@ module QuestradeApi
       QuestradeApi::REST::Symbol.fetch(authorization, params)
     end
 
+    def symbol(id)
+      symbol = QuestradeApi::REST::Symbol.new(authorization, id: id)
+      symbol.fetch
+
+      symbol
+    end
+
     def search_symbols(params)
       QuestradeApi::REST::Symbol.search(authorization, params)
     end

data/lib/questrade_api/version.rb

@@ -1,3 +1,3 @@
 module QuestradeApi
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/questrade_api/modules/market_call_spec.rb

@@ -31,6 +31,13 @@ describe QuestradeApi::MarketCall do
     end
   end
 
+  context '.symbol' do
+    it 'calls proper endpoint' do
+      expect_any_instance_of(QuestradeApi::REST::Symbol).to receive(:fetch).and_return([])
+      expect(subject.symbol('1')).to be_a(QuestradeApi::REST::Symbol)
+    end
+  end
+
   context '.search_symbols' do
     it 'calls proper endpoint' do
       expect(QuestradeApi::REST::Symbol).to receive(:search).and_return([])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: questrade_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Bruno Meira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-11 00:00:00.000000000 Z
+date: 2017-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: An elegant Ruby gem to interact with Questrade API