RubyGems - questrade_api - Versions diffs - 0.0.1 - Mend

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ded11a2d448dfa40a7da186b112118a97cfbe9d
+  data.tar.gz: d44c839445d9f7b17435447011269540fa70e9af
+SHA512:
+  metadata.gz: 16429ac6177b3a1629e9b60b1e0509e1a93d5e8623ca58d91ddae8edb131b5b93e1d759dc18583a43389d8f0aef92920cdb5765a00e95cf4867b6b5fd4cef01e
+  data.tar.gz: a7875e088aa7cd1ac4dfe0eb1c5c8e19e6393960687073b0ab1d6b4bb0925ccbca6003be9b2322ae07a400739f354a22d2dfd150f2fccdc3a9e2af3e46f45a8a

data/.gitignore ADDED Viewed

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+# Specify your gem's dependencies in questrade_api.gemspec
+gemspec

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Bruno Meira
+MIT License
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,126 @@
+# 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
+```
+gem 'questrade_api'
+```
+3. 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.
+```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:
+```ruby
+# Get Questrade's current server time
+client.time
+# list of all accounts
+client.accounts
+# List of all balances of an specific account
+client.balances('account_id')
+# List of positions of an specific account
+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)
+# 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.google.com).
+## 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:       |
+### 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:       |
+### 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:       |
+## Contributing
+Contributions are more than welcome.
+The only thing we ask is that before you send a Pull Request, please check if you completed the steps below:
+1. Write and/or update affected tests
+3. Write and/or update documentation
+4. Run RuboCop and update code, if needed
+5. Run test suite
+6. Test if the changes are working properly and didn't break any affected area
+## Note
+This is an open-source project, licensed under the MIT License(see [LICENSE]), and was developed as a labour of love.
+We are not responsible for any damages, capital losses, or any claim caused by the use of this gem.
+USE IT AT YOUR OWN RISK.
+[LICENSE]: LICENSE.txt

data/Rakefile ADDED Viewed

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+task :console do
+ exec "irb -r questrade_api -I ./lib"
+end

data/lib/questrade_api.rb ADDED Viewed

@@ -0,0 +1,6 @@
+# @author Bruno Meira <goesmeira@gmail.com>
+module QuestradeApi
+end
+require 'questrade_api/client'
+require 'questrade_api/authorization'

data/lib/questrade_api/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module QuestradeApi
+  VERSION = '0.0.1'.freeze
+end

data/questrade_api.gemspec ADDED Viewed

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'questrade_api/version'
+Gem::Specification.new do |spec|
+  spec.name          = "questrade_api"
+  spec.version       = QuestradeApi::VERSION
+  spec.authors       = ["Bruno Meira"]
+  spec.email         = ["goesmeira@gmail.com"]
+  spec.summary       = "An elegant Ruby gem to interact with Questrade API"
+  spec.homepage      = 'https://github.com/brunomeira/questrade_api'
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'rubocop', '~> 0.47'
+  spec.add_dependency 'faraday', '~> 0.9'
+end

metadata ADDED Viewed

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: questrade_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bruno Meira
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description:
+email:
+- goesmeira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/questrade_api.rb
+- lib/questrade_api/version.rb
+- questrade_api.gemspec
+homepage: https://github.com/brunomeira/questrade_api
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+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: []
+rubyforge_project:
+rubygems_version: 2.5.1
+signing_key:
+specification_version: 4
+summary: An elegant Ruby gem to interact with Questrade API
+test_files: []

questrade_api 0.0.1