coyodlee 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ba6d4efb440932238cd8a92bf8f85c0d5e875bd6
-  data.tar.gz: 9359ce7258b12ae59b71e42b9168ef3930632940
+SHA256:
+  metadata.gz: 40db7ffc3fa44618447c72116d9cd62c954a4f02541784ada16d4d29f5104d14
+  data.tar.gz: 2f2915b89732be626884d3b6eec01edb867f5f7899b2524faec8183ddd71cfdf
 SHA512:
-  metadata.gz: f1d0518db712d34968cd30e0038aff7d02f6e55f1b070e309fce5ad9c2aa6fd2fd624fa192a17cef982757992e1ea83b56757051987f785450cd7406e9e6ea6f
-  data.tar.gz: 8452e4f1ed34d277b49d7d344c0ee7d7c4b58654eab8eb53ddbe70c24f7ea53138f8c1c27b576c5674540166345d7d299cef9b4d493a79a3f680e16932b9a206
+  metadata.gz: a950639030248a83ed8277763b6f2c4f91fccfd6bd350e692eb3ecbcca5395a558feca0153d6d86dd10aaeb04d783668fb47b174b07eb3cf84d1c4abea4edcf9
+  data.tar.gz: ee77c734c28abf4b844ad6ab3f2c95f51b754a627a5251ea54e6fbe0e6075e29ea939ab7d92a5444c3268800bdb8fc38822338aee1a2e60f6d2611a82e295ae5

data/.travis.yml

@@ -1,9 +1,18 @@
 language: ruby
 rvm:
-- 2.2.3
+- 2.3
+- 2.4
+- 2.5
+before_script:
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- ./cc-test-reporter before-build
 before_install: gem install bundler -v 1.11.2
+after_script:
+- ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 env:
   global:
+  - CC_TEST_REPORTER_ID: 97fb3bdc3bc9764c19651246fad6c2a798a83d410f1eab0a66e467e9c2b2ce79
   - secure: uUfBk39flmbyd21ayyqVP4pm1FS7h18joIIAF+547CV6+6Ke7BG3DxR+ivIDG1MVXZNErQ+U5zRAcnG0kWYwbJ1bcFksJYpxR6hN+6MY6SDW7G2oN/Ono6DqHE/tnzrL+/Ax5ui0Yw/W6258tlgm1dj3K28/lmmoK1qbyNqeL5bf+PoggNSIk/DQIHotJsWR4QEIXQM077+PGRfm9TIBE9hU77Cphmu0jPk9NTUHdQHGo6SwDfl2X5CO1Qfp43cn0X7Giir3+tHWZZo8bdDmhDKiTVrLpCFvD6tXHzvU5zhyElUAM4jdPH+jXpmLSK+OwEJispCxHgt6Zd9RELEYMRidlInuxrqYrwikc55shuiIHRq7Sf0JmB2q+sj70+1bNSrJlfPZ6GK3+Ye+HIEGTf8K4B6PUZDrEsPb4fJiaq1kjB5Z5+s3olVqnl0oVIVWk6Pw6qhn0UgVwFMP26eIua7lGo1g9+DqhtZ9WFhBcLDe5f10M7YfaXgDhIW0yXz7Emqip+llpMg//5R2sSQy48M6jjMX4wDcXVrnYFSZAtUno6unxddctdqXQHDpwr60uEyeyb3j5xJp7LUKs7CkOGrfyPqmljD83Ibayh/yBXelme2l6esElWOUVUScuBint5AiPDrnhbApdUGTYbGDPzB4Et3wwfd4ddePTh8z16M=
   - secure: t/ro3jAcnKuJCXqzvbxrukbcwD02+CZIUS6tUXBWexxowbvpC+el60ZLP+q9VD40hBy8SwFf7ukdmtunNRXBUmhPb/NhyBRmtcaHlrvReYV1d8AJX/tGtcuv4OirfcXj45u0mEOtUdDTYYvbbv3cecoKPLtjaZcLct2mwoTh0tcTei0qs/4fZNOm5yGrIVIO5lxyrnGTmWKbSceK9FAwz7FiZ108DrG8QApQNmpXS/5P6G4cnpsilRDXt0p4zMdi/QOgPw7dfANU5K1Hwg7cryBsqk4JwN0mJ6AWTkv4A8THuVAmDzojyqH0Su151HecNu5GOfsXiHzavkvQTdO+s00AkqkyZkzCq8KDx8DxeK363iw/gSVztWv3Q77oDhZ6UyOkPgpzYPbMrl9d2+Z/fC2CrSiVKCLnqjdSbSdhOEFgmc3LTSM7kuGEwtwMGPARmjrC7NVynol4Ji6YWAopO/B79dNNBUSAZRt8yJReN26sIZ3bTqqqIhqzZWvPWWRtYkS7TMu3djqb0ey/0rPI35i7esiIrD26XT+invuehZhRJ+qOikscVjwKSw5wVGoWODOELcL9lF5zccQQDp8xtPvQN8818wekGbBibnrnQ98kzVpR7C1Dl0tEM+ZcdfReC/6a5xL8x1/pS+lGvxN5xqMQFbejc6rKTWJjplUkPY4=
   - secure: emoFvYI3rOkbj8YOOgmLkT7WQtSn/f/D5JTPZ1nl41P8/xaQLGFaa9aSYV3AqsZOER+hDEplek1DFPZNBvgTUND09hpS6qDa9oMGxzJlMxokZIMdHfFBMsb9eXdsvHnG6vilejQ7ic9EfISv4SqwoZmr6KMGBX5o17REtTHwgzuV/aMozhJi5agjWUuLhGFPPTg/fhqLqBZOXCiQjkdhtDkC4PX8FNnwzXWnjn/CuyTZvhapFOftfh76n72FLhMfCpOi3FZnkFcpSvs38uFv7RS9d0ci0XuNFzrhaUbr8WsB+nz1rGKdRUP9RhaU2OJPWmGcGfBeYApG8DhE6dMUJK3k+1X4aPkDjEYm+/xWTjD/2jbRjqvLJJ4B9S75GRz6O3zV4KMc9GkgQWXx+MzCkkc72TsL3XjSCxeqQMvQ8mjl7GFgfeZw5UFiMaCcQzDHECphBAt990rGhwXq0B2eEluOtHo2Kkh7FGvPkCOiMjTdlgNpe2BAh+sf+Bn+/rZ25iFIAWF8IDlfPJc+QiHLtZntwI0afzjWs+2TjDFj3PQ+Shx/Pshk8PXdaPUEP0t7HyLpiWOuyeJaG8O96W/cX51fopmDhlRaVREcpAaJwZ9AXoYSHGXFL9+027L3obG4PYyBF1goBcoe1BZKsLRjGxSftKPmXgCQnBQR3FPYgtM=

data/Gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'yajl-ruby', require: 'yajl'
+gem 'simplecov', require: false, group: :test
 
 gemspec

data/README.md

@@ -1,6 +1,16 @@
 # Coyodlee
-[![Build Status](https://travis-ci.com/pennymac/coyodlee.svg?token=KvBtKQs616ELBMQxp2n7&branch=master)](https://travis-ci.com/pennymac/coyodlee)
+[![Gem Version](https://badge.fury.io/rb/coyodlee.svg)](https://badge.fury.io/rb/coyodlee)
+[![Build Status](https://travis-ci.org/pennymac/coyodlee.svg?branch=master)](https://travis-ci.org/pennymac/coyodlee)
 [![Maintainability](https://api.codeclimate.com/v1/badges/f36b069069540b196fbd/maintainability)](https://codeclimate.com/github/pennymac/coyodlee/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/f36b069069540b196fbd/test_coverage)](https://codeclimate.com/github/pennymac/coyodlee/test_coverage)
+
+## Status
+
+The software in this repository is in an early alpha state. This repository is currently not accepting pull requests or responding to issues. If there is a bug in the code or a feature you'd like to have, feel free to fork the repository.
+
+## Requirements
+
+This library works with Ruby 2.3+.
 
 ## Setup
 
@@ -8,20 +18,10 @@ In sandbox mode, point the ```base_url``` to ```https://developer.api.yodlee.com
 
 Export the following environment variables:
 
-<table>
-  <tr>
-    <td><strong>Environment Variables</strong></td>
-    <td><strong>Description</td>
-  </tr>
-  <tr>
-    <td>YODLEE_COBRAND_LOGIN</td>
-    <td>The Yodlee cobrand login</td>
-  <tr/>
-  <tr>
-    <td>YODLEE_COBRAND_PASSWORD</td>
-    <td>The Yodlee cobrand password</td>
-  <tr/>
-</table>
+| Environment Variable      | Description                           |
+|---------------------------|---------------------------------------|
+| YODLEE\_COBRAND\_LOGIN    | The login of your assigned cobrand    |
+| YODLEE\_COBRAND\_PASSWORD | The password of your assigned cobrand |
 
 ## Installation
 
@@ -41,34 +41,33 @@ Or install it yourself as:
 
 ## Usage
 
-This API exposes a ```setup``` method:
+The API remains in flux. Here is the current way to interact with Yodlee:
 
 ``` ruby
 require 'coyodlee'
 
 Coyodlee.setup do |config|
-  config.base_url = ENV['YODLEE_BASE_URL']
+  config.host = 'developer.api.yodlee.com'
   config.cobrand_login = ENV['YODLEE_COBRAND_LOGIN']
   config.cobrand_password = ENV['YODLEE_COBRAND_PASSWORD']
 end
 
-require 'coyodlee/sessions'
+require 'coyodlee/connection'
+require 'coyodlee/session'
 
-cob_session = Coyodlee::Sessions::CobrandSession.new
-cob_session.login login_name: Coyodlee.cobrand_login, password: Coyodlee.cobrand_password
+conn = Coyodlee::Connection.create
 
-user_session = Coyodlee::Sessions::UserSession.new(cobrand_session: cob_session)
-user_session.login login_name: 'yodlee-test-user-login', password: 'yodlee-test-user-password'
+resp = conn.start do |api|
+  session = Coyodlee::Session.create(api)
+  session.cobrand_login login_name: Coyodlee.cobrand_login,
+                        password: Coyodlee.cobrand_password
+  session.user_login login_name: ENV['YODLEE_USER_1_LOGIN_NAME'],
+                     password: ENV['YODLEE_USER_1_PASSWORD']
 
-require 'coyodlee/client'
-
-client = Coyodlee::Client.new(user_session)
-resp = client.get_accounts
-
-require 'json'
+  api.get_accounts
+end
 
-# Print all accounts for the test user
-puts JSON.parse(resp.body)
+puts resp
 ```
 
 ## Testing

data/coyodlee.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rest-client", "~> 2.0"
+  spec.add_dependency "yajl-ruby", "~> 1.3.1"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
@@ -29,4 +29,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard", '~> 0.9'
   spec.add_development_dependency "activesupport", '5.1'
   spec.add_development_dependency "travis", '~> 1.8'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'pry'
 end

data/examples/demo.rb

@@ -0,0 +1,23 @@
+require 'coyodlee'
+require 'coyodlee/connection'
+require 'coyodlee/session'
+require 'dotenv/load'
+require 'pry'
+
+Coyodlee.setup do |config|
+  config.host = 'developer.api.yodlee.com'
+  config.cobrand_login = ENV['YODLEE_COBRAND_LOGIN']
+  config.cobrand_password = ENV['YODLEE_COBRAND_PASSWORD']
+end
+
+conn = Coyodlee::Connection.create
+
+resp = conn.start do |api|
+  session = Coyodlee::Session.create(api)
+  session.login_cobrand login_name: Coyodlee.cobrand_login,
+                        password: Coyodlee.cobrand_password
+  session.login_user login_name: ENV['YODLEE_USER_1_LOGIN_NAME'],
+                     password: ENV['YODLEE_USER_1_PASSWORD']
+end
+
+puts resp

data/lib/coyodlee.rb

@@ -1,15 +1,16 @@
 require_relative 'coyodlee/version'
-require_relative 'coyodlee/http_wrapper'
-require 'json'
 require 'yajl'
 
 # The global Yodlee configuration object
 module Coyodlee
 
   class << self
-    # The base url Yodlee provides for your cobrand
-    # @return [String] The base url Yodlee provides for your cobrand
-    attr_accessor :base_url
+    # The name of the Yodlee API host
+    # @return [String] The name of the Yodlee API host
+    attr_accessor :host
+    # The cobrand name
+    # @return [String] The cobrand name
+    attr_accessor :cobrand_name
     # The login of your cobrand
     # @return [String] The login of your cobrand
     attr_accessor :cobrand_login

data/lib/coyodlee/connection.rb

@@ -0,0 +1,207 @@
+require_relative 'uri_builder'
+require_relative 'facades'
+require 'forwardable'
+require 'net/http'
+
+module Coyodlee
+  class RequestBuilder
+    extend Forwardable
+
+    def initialize(uri_builder)
+      @uri_builder = uri_builder
+      @session_authorization = nil
+    end
+
+    def_delegators :@uri_builder, :host
+
+    def authorize(session_authorization)
+      @session_authorization = session_authorization
+    end
+
+    def build(method, resource_path, headers: {}, params: {}, body: nil)
+      q = params.empty? ? nil : build_query(params)
+      uri = @uri_builder.build(resource_path, query: q)
+      http_constructor(method).new(uri).tap do |req|
+        add_headers(req, headers)
+        req.body = body if body
+      end
+    end
+
+    private
+
+    def build_query(params)
+      params
+        .to_a
+        .map { |keyval| keyval.join('=') }
+        .join('&')
+    end
+
+    def add_headers(req, headers)
+      if @session_authorization
+        headers['Authorization'] = @session_authorization.to_s
+      end
+
+      headers.each do |key, value|
+        req[key] = value
+      end
+    end
+
+    def http_constructor(method)
+      case method
+      when :get
+        Net::HTTP::Get
+      when :post
+        Net::HTTP::Post
+      when :put
+        Net::HTTP::Put
+      when :delete
+        Net::HTTP::Delete
+      end
+    end
+  end
+
+  class RequestFacade
+    attr_reader :http
+    attr_reader :request_builder
+
+    extend Forwardable
+    include Facades
+
+    def initialize(http:, request_builder:)
+      @http = http
+      @request_builder = request_builder
+      @user_facade = UserFacade.new(self)
+      @cobrand_facade = CobrandFacade.new(self)
+      @accounts_facade = AccountsFacade.new(self)
+      @transactions_facade = TransactionsFacade.new(self)
+      @holdings_facade = HoldingsFacade.new(self)
+      @provider_accounts_facade = ProviderAccountsFacade.new(self)
+    end
+
+    def_delegators :@request_builder, :authorize, :build
+
+    def_delegator :@user_facade, :login, :login_user
+    def_delegator :@user_facade, :logout, :logout_user
+    def_delegator :@user_facade, :register, :register_user
+    def_delegator :@user_facade, :unregister, :unregister_user
+
+    def_delegator :@cobrand_facade, :login, :login_cobrand
+    def_delegator :@cobrand_facade, :logout, :logout_cobrand
+    def_delegator :@cobrand_facade, :public_key, :cobrand_public_key
+
+    def_delegator :@accounts_facade, :all, :accounts
+    def_delegator :@accounts_facade, :details, :account_details
+    def_delegator :@accounts_facade, :update, :update_account
+    def_delegator :@accounts_facade, :delete, :delete_account
+    def_delegator :@accounts_facade, :add_manually, :add_manual_account
+    def_delegator :@accounts_facade, :investment_options, :investment_options
+    def_delegator :@accounts_facade, :historical_balances, :historical_balances
+
+    def_delegator :@holdings_facade, :all, :holdings
+    def_delegators :@holdings_facade, :extended_securities_info, :holding_type_list, :asset_classification_list
+
+    def_delegator :@transactions_facade, :count, :transactions_count
+    def_delegator :@transactions_facade, :all, :transactions
+    def_delegator :@transactions_facade, :categorization_rules, :transaction_categorization_rules
+    def_delegator :@transactions_facade, :create_categorization_rule, :create_transaction_categorization_rule
+    def_delegator :@transactions_facade, :update_categorization_rule, :update_transaction_categorization_rule
+    def_delegator :@transactions_facade, :delete_categorization_rule, :delete_transaction_categorization_rule
+    def_delegator :@transactions_facade, :run_categorization_rule, :run_transaction_categorization_rule
+    def_delegator :@transactions_facade, :run_all_categorization_rule, :run_all_transaction_categorization_rule
+    def_delegator :@transactions_facade, :update, :update_transaction
+    def_delegator :@transactions_facade, :category_list, :transaction_category_list
+    def_delegator :@transactions_facade, :create_category, :create_transaction_category
+    def_delegator :@transactions_facade, :update_category, :update_transaction_category
+    def_delegator :@transactions_facade, :delete_category, :delete_transaction_category
+
+    def_delegator :@provider_accounts_facade, :add, :add_provider_account
+    def_delegator :@provider_accounts_facade, :details, :provider_account_details
+    def_delegator :@provider_accounts_facade, :delete, :delete_provider_account
+    def_delegator :@provider_accounts_facade, :update, :update_provider_account
+    def_delegator :@provider_accounts_facade, :verify, :verify_provider_account
+    def_delegator :@provider_accounts_facade, :verification_status, :provider_account_verification_status
+
+    def providers(params={})
+      headers = { 'Accept' => 'application/json' }
+      req = @request_builder.build(:get, "providers", headers: headers, params: params)
+      execute(req)
+    end
+
+    def provider_details(provider_id:, provider_account_id:)
+      headers = { 'Accept' => 'application/json' }
+      params = { 'providerAccountId' => provider_account_id }
+      req = @request_builder.build(:get, "providers/#{provider_id}", headers: headers, params: params)
+      execute(req)
+    end
+
+    def statements(params={})
+      headers = { 'Accept' => 'application/json' }
+      req = @request_builder.build(:get, 'statements', headers: headers, params: params)
+      execute(req)
+    end
+
+    def transaction_summary(group_by:, params: {})
+      params['groupBy'] = group_by
+      headers = { 'Accept' => 'application/json' }
+      req = @request_builder.build(:get, 'derived/transactionSummary', headers: headers, params: params)
+      execute(req)
+    end
+
+    def holding_summary(params={})
+      headers = { 'Accept' => 'application/json' }
+      req = @request_builder.build(:get, 'derived/holdingSummary', headers: headers, params: params)
+      execute(req)
+    end
+
+    def networth_summary(params={})
+      headers = { 'Accept' => 'application/json' }
+      req = @request_builder.build(:get, 'derived/networth', headers: headers, params: params)
+      execute(req)
+    end
+
+    def extract_events(event_name:, from_date:, to_date:)
+      params = {
+        'eventName' => event_name,
+        'fromDate' => fromDate,
+        'toDate' => toDate
+      }
+      headers = { 'Accept' => 'application/json' }
+      req = @request_builder.build(:get, 'dataExtracts/events', headers: headers, params: params)
+      execute(req)
+    end
+
+    def user_data(login_name:, from_date:, to_date:)
+      params = {
+        'loginName' => login_name,
+        'fromDate' => fromDate,
+        'toDate' => toDate
+      }
+      headers = { 'Accept' => 'application/json' }
+      req = @request_builder.build(:get, 'dataExtracts/userData', headers: headers, params: params)
+      execute(req)
+    end
+
+    def execute(req)
+      http.request(req)
+    end
+  end
+
+  class Connection
+    class << self
+      def create
+        new RequestBuilder.new(UriBuilder.new(host: Coyodlee.host))
+      end
+    end
+
+    def initialize(request_builder)
+      @request_builder = request_builder
+    end
+
+    def start(&block)
+      Net::HTTP.start(@request_builder.host, use_ssl: true) do |http|
+        yield RequestFacade.new(http: http,
+                                request_builder: @request_builder)
+      end
+    end
+  end
+end

data/lib/coyodlee/facades.rb

@@ -0,0 +1,6 @@
+require_relative 'facades/accounts_facade'
+require_relative 'facades/user_facade'
+require_relative 'facades/cobrand_facade'
+require_relative 'facades/transactions_facade'
+require_relative 'facades/holdings_facade'
+require_relative 'facades/provider_accounts_facade'

data/lib/coyodlee/facades/accounts_facade.rb

@@ -0,0 +1,52 @@
+module Coyodlee
+  module Facades
+    class AccountsFacade
+      def initialize(request_facade)
+        @request_facade = request_facade
+      end
+
+      def all
+        headers = { 'Accept' => 'application/json' }
+        req = @request_facade.build(:get, 'accounts', headers: headers)
+        @request_facade.execute(req)
+      end
+
+      def details(account_id:, container:)
+        headers = { 'Accept' => 'application/json' }
+        params = { container: container }
+        req = @request_facade.build(:get, "accounts/#{account_id}", params: params, headers: headers)
+        @request_facade.execute(req)
+      end
+
+      def update(account_id:, body:)
+        headers = { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }
+        req = @request_facade.build(:put, "accounts/#{account_id}", headers: headers, body: body.to_json)
+        @request_facade.execute(req)
+      end
+
+      def delete(account_id:)
+        headers = { 'Accept' => 'application/json' }
+        req = @request_facade.build(:delete, "accounts/#{account_id}", headers: headers)
+        @request_facade.execute(req)
+      end
+
+      def add_manually(body:)
+        headers = { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }
+        req = @request_facade.build(:post, 'accounts', headers: headers, body: body.to_json)
+        @request_facade.execute(req)
+      end
+
+      def investment_options(params={})
+        headers = { 'Accept' => 'application/json' }
+        req = @request_facade.build(:get, 'accounts/investmentPlan/investmentOptions', headers: headers, params: params)
+        @request_facade.execute(req)
+      end
+
+      def historical_balances(params={})
+        headers = { 'Accept' => 'application/json' }
+        req = @request_facade.build(:get, 'accounts/historicalBalances', headers: headers, params: params)
+        @request_facade.execute(req)
+      end
+    end
+  end
+end