quovo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3f2ab2081c5d4a1ba365f371b1c8784ef51a214
+  data.tar.gz: fb22a12ed8ccad14dc2f1bcda6e4f3dc2600bc1b
+SHA512:
+  metadata.gz: 91c9ee1b9a94cc1d3da4a1e159e8812c829763ce322ce3514a883dc4decb783d79d58b36f08ccd0b29f2ae854a1348e8c4c42c83be3445b6f8fbf63a8f68124a
+  data.tar.gz: 6ed3bb5cbb6f4d51d35f522e1101150d160f6cf0fff06406174ffc17432acac2a1ec6cba7ef9bf38ecaa5465f661e595a06ec8a483f113c9167ada6f9f49c52e

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+.storage
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+coverage
+.DS_Store

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/AbcSize:
+  Exclude:
+    - 'bin/console'
+    - 'tests/**'

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.2
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'bundler'
+gem 'rake'
+gem 'minitest',  require: false
+gem 'coveralls', require: false
+gem 'rubocop',   require: false
+gem 'pry',       require: false

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2016 Canopy
+
+The MIT License (MIT)
+
+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

@@ -0,0 +1,176 @@
+# Quovo
+
+Quovo RESTful API ruby client. 
+
+Read more about Quovo [here](https://new.quovo.com/api/docs/).
+
+[![Build Status](https://travis-ci.org/CanopyFA/quovo-ruby.svg?branch=master)](https://travis-ci.org/CanopyFA/quovo-ruby)  [![Coverage Status](https://coveralls.io/repos/github/CanopyFA/quovo-ruby/badge.svg?branch=master)](https://coveralls.io/github/CanopyFA/quovo-ruby?branch=master)
+
+## Installation
+
+```ruby
+# Gemfile
+gem 'quovo'
+
+# run `bundle` in shell
+```
+
+## Configuration
+
+```ruby
+  Quovo.configurate do |config|
+    config.username               = 'username'
+    config.password               = 'password'
+    config.request_timeout        = 30.seconds # by default 60 seconds
+    config.token_ttl              = 2.hour     # by default 1 hour
+    config.token_prefix           = 'APP-NAME' # add custom prefix for token (helps to manage token list)
+    config.debug                  = true # if you want to see detailed logs
+    config.strip_sensitive_params = true # show [FILTERED] in logs for sensitive data 
+  end
+```
+If you use Rails put this configuration into `config/initializers/quovo.rb`.
+
+**Note:** By default client uses in-memory storage for access tokens. If you want to use persistent storage (redis, file)
+you need to set storage object in configuration:
+
+```ruby
+  Quovo.configurate do |config|
+    # ...
+    config.token_storage = Object.new.tap do |o|
+      def o.read(key)
+        # read value by key from storage
+      end
+
+      def o.write(key, value)
+        # write value by key to storage
+      end
+    end
+  end
+```
+
+You can also use `Rails.cache` as storage:
+
+```ruby
+  Quovo.configurate do |config|
+    # ...
+    config.token_storage = Rails.cache
+  end
+```
+## Scopes and Hooks
+
+You can scope quovo actions with user-defined hash that
+could be used in hooks. Useful for action logging.
+
+```ruby
+  Quovo.scope(user: user) do
+    Quovo.accounts.all
+  end
+```
+
+Hook is a registered callback that invokes when web request happens. 
+
+```ruby
+  Quovo.hook do |path, method, params, status_code, response, elapsed_time, scope|
+    # path, method, params, status_code, response - attributes of web request
+    # elapsed_time - time in seconds of web request 
+    # scope - user-defined hash, see docs about scopes
+
+    # log quovo action in database or file
+  end
+```
+
+## Quovo Api bindings
+
+### Brokerages
+```ruby
+  # Provides information on Quovo's supported brokerages
+  client.brokerages.all
+  # Information about single brokerage
+  client.brokerages.find(brokerage_id)
+```
+
+### Users
+```ruby
+  client.users.all
+  client.users.find(user_id)
+  # Creates new user
+  # additional parameters
+  # name:   - client's name
+  # email:  - client's email. Cannot match another user's email
+  # phone:  - client's phone number  
+  client.users.create(username)
+  # Updates user information
+  # additional parameters
+  # name:   - client's name
+  # email:  - client's email. Cannot match another user's email
+  # phone:  - client's phone number  
+  client.users.update(user_id)
+  client.users.delete(user_id) 
+```
+
+### Accounts
+```ruby
+  client.accounts.all
+  client.accounts.find(id)
+  client.accounts.create(user_id, brokerage_id, username, password)
+  client.accounts.update(account_id, brokerage_id, username, password)
+  client.accounts.delete(account_id)
+  client.accounts.for_user(user_id)
+  # Init new sync
+  client.accounts.sync!(account_id)
+  # Get sync status
+  client.accounts.sync(account_id)
+```
+
+### Challenges
+```ruby
+  client.challenges.for_account(account_id)
+  # for text, image questions
+  client.challenges.answers!(account_id, [{question: 'question text', answer: 'answer text'}])
+  # for choice questions
+  client.challenges.answers!(account_id, [{question: 'question text', answer: 0}])
+```
+
+### History
+```ruby
+  client.history.all
+  # additional parameters
+  # start: - pointer to next set of items
+  # count: - max number of results to return
+  # start_date: - filters out history before this date
+  # end_date:   - filters out history after this date
+  # start_id:   - filters out history before this id
+  # end_id:     - filters out history after this id  
+  client.history.for_user(user_id)
+  client.history.for_account(account_id)
+  client.history.for_portfolio(portfolio_id)
+```
+
+### Portfolios
+```ruby
+  client.portfolios.all
+  client.portfolios.find(portfolio_id)
+  client.portfolios.update(portfolio_id, nickname, portfolio_type, is_inactive)
+  client.portfolios.for_user(user_id)
+  client.portfolios.for_account(account_id)
+```
+
+### Positions
+```ruby
+  # Load all positions
+  # additional parameters
+  # start:   - pointer to next set of items
+  # count:   - max number of results to return  
+  client.positions.all
+  client.positions.for_user(user_id)
+  client.positions.for_account(account_id)
+  client.positions.for_portfolio(portfolio_id)
+```
+
+## Contributors
+* Canopy Financials [https://www.canopyfa.com](https://www.canopyfa.com)
+* Castle Digital Partners [https://castle.co](https://castle.co)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new do |t|
+  t.libs << 'tests'
+  t.pattern = 'tests/**/*_test.rb'
+end
+
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :test]

data/bin/console

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'quovo'
+require 'pry'
+require 'json'
+
+def reconfigure!
+  Quovo.configure do |config|
+    config.username = ARGV[0]
+    config.password = ARGV[1]
+    config.debug    = true
+    config.token_storage = Object.new.tap do |o|
+      def o.path
+        '../.storage'
+      end
+
+      def o.storage
+        @storage ||= begin
+                       data = File.exist?(path) ? File.read(path) : nil
+                       data ? JSON.parse(data) : {}
+                     end
+      end
+
+      def o.read(key)
+        storage[key]
+      end
+
+      def o.write(key, value)
+        storage[key] = value
+        File.write(path, storage.to_json)
+      end
+    end
+  end
+end
+
+def reload!
+  Quovo.instance_variables.each do |var|
+    Quovo.instance_variable_set(var, nil)
+  end
+  Quovo.clear_hooks!
+  original_verbose = $VERBOSE
+  $VERBOSE = nil
+  $LOADED_FEATURES
+    .select { |file| file =~ %r{\/quovo\/} }
+    .each { |file| load(file) }
+  $VERBOSE = original_verbose
+  reconfigure!
+  'Reloaded!'
+end
+
+reconfigure!
+Pry.start

data/lib/quovo.rb

@@ -0,0 +1,81 @@
+require 'json'
+require 'uri'
+require 'time'
+require 'base64'
+require 'forwardable'
+require 'net/http'
+require 'openssl'
+
+require 'quovo/refinements/require'
+require 'quovo/refinements/to_time'
+require 'quovo/refinements/cast'
+require 'quovo/refinements/compact'
+require 'quovo/refinements/permit'
+require 'quovo/refinements/sensitive'
+
+require 'quovo/errors'
+
+require 'quovo/scope'
+require 'quovo/hook'
+require 'quovo/version'
+require 'quovo/config'
+require 'quovo/request'
+require 'quovo/token'
+require 'quovo/fake'
+
+require 'quovo/models/base'
+require 'quovo/models/account'
+require 'quovo/models/brokerage'
+require 'quovo/models/choice'
+require 'quovo/models/image'
+require 'quovo/models/challenge'
+require 'quovo/models/progress'
+require 'quovo/models/sync'
+require 'quovo/models/portfolio'
+require 'quovo/models/user'
+require 'quovo/models/position'
+require 'quovo/models/transaction'
+
+require 'quovo/api/base'
+require 'quovo/api/brokerages'
+require 'quovo/api/accounts'
+require 'quovo/api/challenges'
+require 'quovo/api/portfolios'
+require 'quovo/api/users'
+require 'quovo/api/positions'
+require 'quovo/api/history'
+require 'quovo/api'
+
+module Quovo
+  extend Quovo::Config.configurator
+  extend Quovo::Scope
+  extend Quovo::Hook
+  extend Quovo::Api
+  extend Quovo::Fake
+
+  def self.inspect
+    config.inspect
+  end
+
+  def self.enable_logging
+    Quovo.hook do |path, method, params, status_code, response, elapsed_time, scope|
+      if Quovo.config.debug
+        log = [
+          '',
+          'Quovo Action:',
+          "path: #{path}",
+          "method: #{method}",
+          "params: #{params.inspect}",
+          "status_code: #{status_code}",
+          "response: #{response.inspect}",
+          "elapsed_time: #{elapsed_time}s",
+          "scope: #{scope.inspect}",
+          ''
+        ]
+        puts log.join("\n    ")
+      end
+    end
+  end
+
+  enable_logging
+end

data/lib/quovo/api.rb

@@ -0,0 +1,31 @@
+module Quovo
+  module Api
+    def brokerages
+      @brokerages ||= Quovo::Api::Brokerages.new
+    end
+
+    def accounts
+      @accounts ||= Quovo::Api::Accounts.new
+    end
+
+    def challenges
+      @challenges ||= Quovo::Api::Challenges.new
+    end
+
+    def portfolios
+      @portfolios ||= Quovo::Api::Portfolios.new
+    end
+
+    def users
+      @users ||= Quovo::Api::Users.new
+    end
+
+    def positions
+      @positions ||= Quovo::Api::Positions.new
+    end
+
+    def history
+      @history ||= Quovo::Api::History.new
+    end
+  end
+end

data/lib/quovo/api/accounts.rb

@@ -0,0 +1,65 @@
+module Quovo
+  module Api
+    class Accounts < Base
+      using Quovo::Refinements::Cast
+      using Quovo::Refinements::Require
+      using Quovo::Refinements::Permit
+
+      def all
+        api(:get, '/accounts')
+          .fetch('accounts')
+          .cast(Account)
+      end
+
+      def find(id)
+        id.require!(as: :id)
+        api(:get, "/accounts/#{id}")
+          .fetch('account')
+          .cast(Account)
+      end
+
+      def create(params)
+        params.require!(:user, :brokerage, :username, :password)
+        api(:post, '/accounts', params)
+          .fetch('account')
+          .cast(Account)
+      end
+
+      def update(id, params)
+        id.require!(as: :id)
+        params
+          .permit!(:brokerage, :username, :password)
+        params.require!(:username, :password) if params[:username] || params[:password]
+        api(:put, "/accounts/#{id}", params)
+          .fetch('account')
+          .cast(Account)
+      end
+
+      def delete(id)
+        id.require!(as: :id)
+        api(:delete, "/accounts/#{id}")
+      end
+
+      def for_user(id)
+        id.require!(as: :id)
+        api(:get, "/users/#{id}/accounts")
+          .fetch('accounts')
+          .cast(Account)
+      end
+
+      def sync!(id)
+        id.require!(as: :id)
+        api(:post, "/accounts/#{id}/sync")
+          .fetch('sync')
+          .cast(Sync)
+      end
+
+      def sync(id)
+        id.require!(as: :id)
+        api(:get, "/accounts/#{id}/sync")
+          .fetch('sync')
+          .cast(Sync)
+      end
+    end
+  end
+end