questrade_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ded11a2d448dfa40a7da186b112118a97cfbe9d
-  data.tar.gz: d44c839445d9f7b17435447011269540fa70e9af
+  metadata.gz: 49d2e66e9476e189911591ed7fac0b63134b2fce
+  data.tar.gz: c941e8f74073691030eaed6bd8066c1af859b88b
 SHA512:
-  metadata.gz: 16429ac6177b3a1629e9b60b1e0509e1a93d5e8623ca58d91ddae8edb131b5b93e1d759dc18583a43389d8f0aef92920cdb5765a00e95cf4867b6b5fd4cef01e
-  data.tar.gz: a7875e088aa7cd1ac4dfe0eb1c5c8e19e6393960687073b0ab1d6b4bb0925ccbca6003be9b2322ae07a400739f354a22d2dfd150f2fccdc3a9e2af3e46f45a8a
+  metadata.gz: 7895d0c76f3515bad23d095557f010f0d1d8528a660557335a7b05e2c3aeec99baa586f4f6685ee59f93c8dc2987fa56248ab29bc2c9246fc8066ae29302dd61
+  data.tar.gz: edf1116607c99e92f40e7618809eb5ee7d4995e2d5c651001ce3649f017892bcf04de3baf59ad467d358befcb27cdd1fd338e62d008dd8723557dd86123bc922

data/.gitignore

@@ -20,3 +20,7 @@ tmp
 *.o
 *.a
 mkmf.log
+*.sw*
+.DS_Store
+.byebug_history
+.vimrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3.0

data/.yardopts

@@ -0,0 +1,9 @@
+--title "QuestradeApi Documentation"
+--markup-provider redcarpet
+--markup markdown
+--readme README.md
+--protected
+--exclude lib/questrade_api/modules/util.rb
+-
+'lib/questrade_api/**/*.rb'
+LICENSE

data/Gemfile

@@ -1,4 +1,19 @@
 source 'http://rubygems.org'
 
+group :docs do
+  gem 'yard'
+  gem "redcarpet"
+  gem 'github-markup'
+end
+
+group :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'bundler', '~> 1.14'
+end
+
+gem 'rake'
+
 # Specify your gem's dependencies in questrade_api.gemspec
 gemspec
+

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/questrade_api/rest/(.+)\.rb$})     { |m| "spec/questrade_api/rest/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,37 +1,32 @@
+[![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)
+
 # QuestradeApi
 
 A Ruby interface to use the [Questrade API](http://www.questrade.com/api).
 
 ## Quick Start
 
-1. Create a Questrade Demo Account on: <http://www.questrade.com/api/free-practice-account>
-
-2. Add the following line to your Gemfile
+- Create a Questrade Demo Account on: <http://www.questrade.com/api/free-practice-account>
+- Add the following line to your Gemfile
 
 ```
 gem 'questrade_api'
-
 ```
-
-3. Run Bundle to install gem
+- Run Bundle to install gem
 
 ```
 $ bundle
-
 ```
-
-4. Follow the tutorial on <http://www.questrade.com/api/documentation/getting-started> to generate a refresh token
-
-5. Copy the snippet of code below to your application, and replace the 'XXXX' token with the token generated on step 4.
+- 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.
 
 ```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')
-
 ```
-
-6. That's all you need to access the API. A few examples of what you can do with it:
+- That's all you need to access the API. A few examples of what you can do with it:
 
 ```ruby
 # Get Questrade's current server time
@@ -53,57 +48,48 @@ client.activities('account_id', startTime: DateTime.yesterday.to_s, endTime: Dat
 # 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.google.com).
+For more advanced options, check out our [documentation](http://www.rubydoc.info/gems/questrade_api).
 
 ## Current Status
 
 This Project is under development and some endpoints are still not accessible through the gem.
 Check the tables below for more details.
 
-<dl>
-  <dt>LEGEND</dt>
-
-  <dd>:green_heart: = Available</dd>
-  <dd>:heart: = Not Available</dd>
-</dl>
-
 ### Account Calls
 
 | Endpoint                 | Development   | Documentation |
 | ---                      | ---           | ---           |
-| /time                    | :green_heart: | :green_heart: |
-| /accounts                | :green_heart: | :green_heart: |
-| /accounts/:id/positions  | :green_heart: | :heart:       |
-| /accounts/:id/balances   | :green_heart: | :heart:       |
-| /accounts/:id/executions | :green_heart: | :heart:       |
-| /accounts/:id/orders     | :green_heart: | :heart:       |
-| /accounts/:id/activities | :green_heart: | :heart:       |
+| /time                    |DONE           | DONE          |
+| /accounts                |DONE           | DONE          |
+| /accounts/:id/positions  |DONE           | DONE          |
+| /accounts/:id/balances   |DONE           | DONE          |
+| /accounts/:id/executions |DONE           | DONE          |
+| /accounts/:id/orders     |DONE           | DONE          |
+| /accounts/:id/activities |DONE           | DONE          |
 
 ### Market Calls
 
 | Endpoint                   | Development   | Documentation |
 | ---                        | ---           | ---           |
-| /symbols/:id               | :heart:       | :heart:       |
-| /symbols/:search           | :heart:       | :heart:       |
-| /symbols/:id/options       | :heart:       | :heart:       |
-| /markets                   | :green_heart: | :heart:       |
-| /markets/quotes/:id        | :heart:       | :heart:       |
-| /markets/quotes/options    | :heart:       | :heart:       |
-| /markets/quotes/strategies | :heart:       | :heart:       |
-| /markets/candles/:id       | :heart:       | :heart:       |
+| /symbols/:id               |      |      |
+| /symbols/:search           |      |      |
+| /symbols/:id/options       |      |      |
+| /markets                   |DONE|      |
+| /markets/quotes/:id        |      |      |
+| /markets/quotes/options    |      |      |
+| /markets/quotes/strategies |      |      |
+| /markets/candles/:id       |      |      |
 
 ### Order Calls
 
 | Endpoint                          | Development   | Documentation |
 | ---                               | ---           | ---           |
-| POST accounts/:id/orders          | :heart:       | :heart:       |
-| POST accounts/:id/orders/impact   | :heart:       | :heart:       |
-| DELETE accounts/:id/orders        | :heart:       | :heart:       |
-| POST accounts/:id/orders/brackets | :heart:       | :heart:       |
-| POST accounts/:id/orders/strategy | :heart:       | :heart:       |
+| POST accounts/:id/orders          |      |      |
+| POST accounts/:id/orders/impact   |      |      |
+| DELETE accounts/:id/orders        |      |      |
+| POST accounts/:id/orders/brackets |      |      |
+| POST accounts/:id/orders/strategy |      |      |
 
 ## Contributing
 
@@ -123,4 +109,4 @@ We are not responsible for any damages, capital losses, or any claim caused by t
 
 USE IT AT YOUR OWN RISK.
 
-[LICENSE]: LICENSE.txt
+[LICENSE]: https://github.com/brunomeira/questrade_api/blob/master/LICENSE

data/Rakefile

@@ -3,3 +3,7 @@ require "bundler/gem_tasks"
 task :console do
  exec "irb -r questrade_api -I ./lib"
 end
+
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new

data/lib/questrade_api/authorization.rb

@@ -0,0 +1,94 @@
+require 'faraday'
+require 'json'
+
+require 'questrade_api/modules/util'
+
+module QuestradeApi
+  # @author Bruno Meira <goesmeira@gmail.com>
+  class Authorization
+    include QuestradeApi::Util
+
+    MODE = %i(live practice).freeze
+    attr_reader :mode, :data, :connection
+
+    # Initialize an instance of QuestradeApi::Client.
+    #
+    # @note Only access_token, api_server, and refresh_token are needed for this gem.
+    #
+    # @param params [Hash] for Questrade authorization.
+    # @option params [String] :access_token Access token used to access API.
+    # @option params [String] :api_server Endpoint used to access API. Example: 'https://apiXX.iq.questrade.com/', where X is a number.
+    # @option params [Integer] :expires_in How much time the access token is valid.
+    # @option params [String] :refresh_token Token used to get a new access token.
+    # @option params [String] :token_type Token type.
+    #
+    # @param mode [Symbol] accessed on Questrade, `:live` or `:practice`
+    def initialize(params, mode = :practice)
+      raise 'Mode must be :live or :practice' unless MODE.include?(mode)
+
+      @mode = mode
+      @connection = build_connection
+
+      build_data(params)
+    end
+
+    # Uses refresh_token to fetch a new valid access token.
+    #
+    # @note #data will be populated accordingly, if call is successful.
+    #
+    # @return The result of the call.
+    def refresh_token
+      response = connection.get do |req|
+        req.params[:grant_type] = 'refresh_token'
+        req.params[:refresh_token] = data.refresh_token
+      end
+
+      if response.status == 200
+        raw_body = JSON.parse(response.body)
+        build_data(raw_body)
+      end
+
+      response
+    end
+
+    # Returns the authorized access token.
+    def access_token
+      data.access_token
+    end
+
+    # Returns the server associated with the authorized access token.
+    def url
+      data.api_server
+    end
+
+    # Checks if selected mode is live.
+    #
+    # @return [Boolean]
+    def live?
+      mode == :live
+    end
+
+    private
+
+    def login_url
+      if live?
+        'https://login.questrade.com/oauth2/token'
+      else
+        'https://practicelogin.questrade.com/oauth2/token'
+      end
+    end
+
+    def build_data(data)
+      hash = hash_to_snakecase(data)
+      @data = OpenStruct.new(hash)
+    end
+
+    def build_connection
+      Faraday.new(login_url) do |faraday|
+        faraday.response :logger
+        faraday.adapter Faraday.default_adapter
+        faraday.headers['Content-Type'] = 'application/json'
+      end
+    end
+  end
+end

data/lib/questrade_api/client.rb

@@ -0,0 +1,87 @@
+require 'questrade_api/authorization'
+require 'questrade_api/rest/time'
+require 'questrade_api/rest/account'
+require 'questrade_api/rest/balance'
+require 'questrade_api/rest/position'
+require 'questrade_api/rest/execution'
+require 'questrade_api/rest/activity'
+require 'questrade_api/rest/order'
+
+require 'questrade_api/rest/market'
+
+module QuestradeApi
+  # @author Bruno Meira <goesmeira@gmail.com>
+  class Client
+    attr_reader :authorization
+
+    # @see QuestradeApi::Client#initialize for more details
+    def initialize(params = {}, mode = :practice)
+      @authorization = QuestradeApi::Authorization.new(params, mode)
+      refresh_token if refresh_token?
+    end
+
+    # Fetches a new access_token. (see QuestradeApi::Authorization#refresh_token)
+    def refresh_token
+      @authorization.refresh_token
+    end
+
+    # Fetch current server time.
+    #
+    # @return [DateTime] if no issues to call /time endpoint occurs.
+    # @return [nil] if current server time cannot be fetched.
+    def time
+      time = QuestradeApi::REST::Time.new(@authorization)
+      time.get
+
+      time.data && time.data.time
+    end
+
+    # Fetch all accounts associated with user.
+    #
+    # @return [Array<QuestradeApi::REST::Account>]
+    def accounts
+      QuestradeApi::REST::Account.all(@authorization).accounts
+    end
+
+    # Fetch all positions associated with account.
+    #
+    # @param account_id [String] to which positions will be fetched.
+    #
+    # @return [Array<QuestradeApi::REST::Position>]
+    def positions(account_id)
+      QuestradeApi::REST::Position.all(@authorization, account_id).positions
+    end
+
+    # Fetch all balances associated with account.
+    #
+    # @param account_id [String] to which balances will be fetched.
+    #
+    # @return [OpenStruct(per_currency_balances)]
+    def balances(account_id)
+      QuestradeApi::REST::Balance.all(@authorization, account_id)
+    end
+
+    def executions(account_id, params = {})
+      QuestradeApi::REST::Execution.all(@authorization, account_id, params)
+    end
+
+    def activities(account_id, params = {})
+      QuestradeApi::REST::Activity.all(@authorization, account_id, params)
+    end
+
+    def orders(account_id, params = {})
+      QuestradeApi::REST::Activity.all(@authorization, account_id, params)
+    end
+
+    def markets
+      QuestradeApi::REST::Market.all(@authorization)
+    end
+
+    private
+
+    def refresh_token?
+      data = @authorization.data
+      data.refresh_token && !data.api_server && !data.access_token
+    end
+  end
+end

data/lib/questrade_api/modules/util.rb

@@ -0,0 +1,22 @@
+module QuestradeApi
+  module Util
+    private
+
+    def hash_to_snakecase(hash)
+      values = hash.map do |k, v|
+        [underscore(k.to_s).to_sym, v]
+      end
+
+      Hash[values]
+    end
+
+    def underscore(camel_cased_word)
+      camel_cased_word
+        .gsub(/::/, '/')
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr('-', '_')
+        .downcase
+    end
+  end
+end

data/lib/questrade_api/rest/account.rb

@@ -0,0 +1,101 @@
+require 'questrade_api/modules/util'
+
+require 'questrade_api/rest/base'
+require 'questrade_api/rest/activity'
+require 'questrade_api/rest/position'
+require 'questrade_api/rest/balance'
+require 'questrade_api/rest/execution'
+
+module QuestradeApi
+  module REST
+    # @author Bruno Meira <goesmeira@gmail.com>
+    class Account < QuestradeApi::REST::Base
+      attr_accessor :id, :user_id
+
+      def initialize(authorization, params)
+        super(authorization)
+
+        @id = params[:id]
+        @user_id = params[:user_id]
+
+        @raw_body = params[:data]
+        build_data(params[:data]) if @raw_body
+      end
+
+      #
+      # Fetch activities associated with account.
+      #
+      # @param see QuestradeApi::REST::Activity.all
+      #
+      # @return [OpenStruct(executions: [QuestradeApi::REST::Activity)]
+      def activities(params)
+        QuestradeApi::REST::Activity.all(authorization, id, params)
+      end
+
+      # Fetch executions associated with account.
+      #
+      # @param see QuestradeApi::REST::Execution.all
+      #
+      # @return [OpenStruct(executions: [QuestradeApi::REST::Execution)]
+      def executions(params)
+        QuestradeApi::REST::Execution.all(authorization, id, params)
+      end
+
+      # Fetch balances associated with account.
+      #
+      # @return [OpenStruct(per_currency_balances)]
+      def balances
+        QuestradeApi::REST::Balance.all(authorization, id)
+      end
+
+      # Fetch positions associated with account.
+      #
+      # @return [OpenStruct(positions: [QuestradeApi::REST::Position])]
+      def positions
+        QuestradeApi::REST::Position.all(authorization, id)
+      end
+
+      # Fetch accounts for specific authorized user.
+      #
+      # @param authorization is any object that
+      #   responds to #access_token and #url
+      #
+      # @return [OpenStruct(accounts: [QuestradeApi::REST::Account])] if call to server is successful
+      # @return [Faraday::Response] if call to server is not successful
+      def self.all(authorization)
+        response = super(access_token: authorization.access_token,
+                         endpoint: endpoint,
+                         url: authorization.url)
+
+        result = OpenStruct.new(accounts: [])
+
+        if response.status == 200
+          result.accounts = parse_accounts(authorization, response.body)
+          response = result
+        end
+
+        response
+      end
+
+      def self.endpoint
+        "#{BASE_ENDPOINT}/accounts"
+      end
+
+      def self.parse_accounts(authorization, body)
+        raw = JSON.parse(body)
+        clients = []
+
+        raw['accounts'].each do |client|
+          clients << new(authorization,
+                         id: client['number'],
+                         user_id: raw['userId'],
+                         data: client)
+        end
+
+        clients
+      end
+
+      private_class_method :parse_accounts
+    end
+  end
+end