yodlee_wrap 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b7e7dfd497e0eec58ac5065a0dd0de3bed1159e
-  data.tar.gz: ac68234bc087d55669679ce679fd2600019f0fdf
+  metadata.gz: 91be96e289ac0ed16b7bb328865c95c56b1e64e3
+  data.tar.gz: 6a39f206131d80dcc265bc1e86aded6606c299e5
 SHA512:
-  metadata.gz: 0502d857969e62ccd9505e1bf4c90b298aba07767e9e42cfe6e31401fa3e7eb73706027b33797fed1d7dec1a83e60981e4b4e0ae673c29d328d9e6283e3dbb00
-  data.tar.gz: cc38d429861db459ad74445bda3b8b58b5aa24beeec761cb318a1fc899b11641c0a74b270c9eb0232346e1116ca94e41bb60b6c4a01b05edfd4f66da046a8e2c
+  metadata.gz: 8d05e183c36aabe3ba06fb028f276d4916a9cb1a3663f95d3335878f3b158e5cd818bcfceaa4654d504ccc78762fc482a00ec0b41a99a74bb9dcde7165e47168
+  data.tar.gz: e582b194c5a90822fd4e5ebb6c9ec37194b0b37c014ea11e13b73ca2e5cc52ae94325d284dd2db8a9d67a03b52903a0d840392c42dcc9c65ee325a3bf24aa9b2

data/README.md

@@ -1,40 +1,39 @@
 
-# Yodlee-icious
-[![Gem Version](https://badge.fury.io/rb/yodlee-icious.svg)](http://badge.fury.io/rb/yodlee-icious)  [![Code Climate](https://codeclimate.com/repos/556dcf7fe30ba00903005872/badges/9398ac76dbcae2084eeb/gpa.svg)](https://codeclimate.com/repos/556dcf7fe30ba00903005872/feed) [![Test Coverage](https://codeclimate.com/repos/556dcf7fe30ba00903005872/badges/9398ac76dbcae2084eeb/coverage.svg)](https://codeclimate.com/repos/556dcf7fe30ba00903005872/coverage)
-[ ![Codeship Status for liftforward/yodlee-icious](https://codeship.com/projects/71603f00-9393-0132-dcd0-1a9a253548c0/status?branch=master)](https://codeship.com/projects/62288)
+# Yodlee Wrap
 
-Yodlee-icious (formally Yodlicious) is a ruby gem wrapping the Yodlee REST(ish) API. We had to build this for our integration with Yodlee which was somewhat more painful than it should have been so we figured we share to be a good neighbor.
 
-![image of yodleeicious](https://github.com/liftforward/yodlee-icious/blob/master/yodlicious.png)
+Yodlee Wrap is a ruby gem wrapping the new Yodlee REST API (2016). It is built on the roots of the Yodlee-icious gem, but works with the newly named endpoints and resource names.
+
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'yodlee-icious'
+gem 'yodlee_wrap'
 ```
 
-And then execute:
+ Then:
 
     $ bundle install
 
-Or install it yourself as:
+Or, outside Rails:
 
-    $ gem install yodlee-icious
+    $ gem install yodlee_wrap
 
 ## Usage
 
 ### Configuration
 
-We needed to use the Yodlee API both within a rails app and outside with multiple Yodlee connections concurrently. As such we provided both the option for a global default configuration and a instance specific configuration. For instance specific:
+Like Yodleeicious, you can continue to use the app from within Rails or externally. Outside of rails (even in an irb session)
 
 ```ruby
-require "yodleeicious"
+require "yodlee_wrap"
 
 config = {
   cobranded_username: your_username,
-  cobranded_password: your_password
+  cobranded_password: your_password,
+  webhook_endpoint: your_webhook_endpoint
 }
 
 yodlee_api = YodleeWrap::YodleeApi.new(config)
@@ -44,118 +43,34 @@ When in a Rails app it can be more convenient to use a global default configurat
 
 ```ruby
 #/<myproject>/config/initializers/yodleeicious.rb
-require 'yodleeicious'
+require 'yodlee_wrap'
 
 #setting default configurations for Yodleeicious
-Yodleeicious::Config.base_url = ENV['YODLEE_BASE_URL']
-Yodleeicious::Config.cobranded_username = ENV['YODLEE_COBRANDED_USERNAME']
-Yodleeicious::Config.cobranded_password = ENV['YODLEE_COBRANDED_PASSWORD']
+YodleeWrap::Config.base_url = ENV['YODLEE_BASE_URL']
+YodleeWrap::Config.cobranded_username = ENV['YODLEE_COBRANDED_USERNAME']
+YodleeWrap::Config.cobranded_password = ENV['YODLEE_COBRANDED_PASSWORD']
+YodleeWrap::Config.webhook_endpoint = ENV['YODLEE_WEBHOOK_ENDPOINT']
 
 #setting yodleeicious logger to use the Rails logger
-Yodleeicious::Config.logger = Rails.logger
+YodleeWrap::Config.logger = Rails.logger
 ```
 and wherever you want to use the api simply create a new one and it will pickup the global defaults.
 
 ```ruby
-yodlee_api = Yodleeicious::YodleeApi.new
+yodlee_api = YodleeWrap::YodleeApi.new
 ```
 If for any reason you need to, you can pass a hash into the constructor and it will use any provided hash values over the defaults. Note this is done on each value not the entire hash.
 
-You can also update an existing instances of the YodleeApi's configuration with the configure method. For example:
-
-```ruby
 
-yodlee_api = Yodleeicious::YodleeApi.new { base_url: 'http://yodlee.com/blablabla' }
+## TODO: Documentation
 
-yodlee_api.configure { base_url: 'https://secure.yodlee.com/blablabla }
+For right now, check the source code for documentation. I'll document when there is more time.
 
-puts yodlee_api.base_url
-```
-will output
-
-```
-https://secure.yodlee.com/blablabla
-```
-
-### Configuring the proxy
-
-If you're Yodlee account is like ours Yodlee will whitelist certain IPs for access and you'll need to proxy all of your API requests through that IP. You can set the proxy with the proxy_url key. Currently the proxy supports, http, https, and socks proxies. Simply set the proxy_url property in the config hash passed to YodleeApi and it should begin using the proxy. For example:
-
-```
-config = {
-  base_url: "https://consolidatedsdk.yodlee.com/yodsoap/srest/my-cobranded-path/v1.0",
-  cobranded_username: "my-cobranded-user",
-  cobranded_password: "my-cobranded-password",
-  proxy_url: "https://my-proxy-server-on-the-whitelist:my=proxy-port/"
-}
+For endpoints that are not currently included, you can call them directly on your yodlee_wrap object using
 
-yodlee_api = Yodleeicious::YodleeApi.new(config)
+``` yodlee_api.user_execute_api(:http_method, endpoint)
 ```
 
-## Working with the API
-
-The Yodlee Api responses are somewhat varied (especially the errors) and as such we build Yodleeicious as a pretty thin layer around their request/response model. We didn't attempt to map all their JSON responses into models or anything fancy like that. Instead we simply created a method for each API endpoint which takes the required parameters and return a response object. That said, Response object does provide some conveniences to make up for the inconsistent delivery of errors from Yodlee's APIs.
-
-### Starting your cobranded session
-
-Once you've configured an instance of the YodleeAPI the first thing you must do is start a Yodlee cobranded session. This is also a good rails console test to see if everything is configured correctly:
-
-```ruby
-pry(main)> yodlee_api = Yodleeicious::YodleeApi.new
-pry(main)> response = yodlee_api.cobranded_login
-pry(main)> response.success?
-=> true
-```
-As you probably suspect the call to cobranded_login wraps the ```/authenticate/coblogin``` endpoint call. If this is a success the YodleeApi instance will cache the cobranded session id yodlee returned and use it on all subsequent api calls. You can also access this value if desired with YodleeApi#cobranded_session_token.
-
-```
-pry(main)> yodlee_api.cobranded_session_token
-=> "12162013_1:a0b1ac3e32a2e656f8f5bd21de23ae1721ffd9dab8bee9f29811f5959bbf102f16c98354eba252bb030dc96e267bd2489a40562f18e09ee8ba9038d19280cc43"
-```
-At this point something has probably gone wrong for you and you want to see the response json from ```/authenticate/coblogin```. To do this simply use ```response#body```.
-
-```
-pry(main)> response.body
-=> {"Error"=>[{"errorDetail"=>"Invalid Cobrand Credentials"}]}
-```
-
-### Starting a user session
-
-Once the cobranded session is active a number of API endpoints will work however most of the interesting ones require you to register or login under a user account. It is within these accounts that you can add the user's bank accounts and whatnot to aggregate their financial data. There are 3 methods offered to allow you to #register_user, #login_user, or do either #login_or_register_user. After executing any of these the user session will be started and the user's session token will be cached in the YodleeApi instance and used on subsequent calls to api endpoints. As with all api calls if the call was not successful you'll need to look at the body of the response to determine what went wrong.
-
-### Registering a new user
-
-```
-pry(main)> response = yodlee_api.register_user 'my-username', 'my-password123', 'my-email@my-domain.com'
-pry(main)> yodlee_api.user_session_token
-=> "12162013_1:69761d51a4010e6382ccb49b854513dbccad0f835a873d37884b68826acefaa5b8d41b634f4cc83d97d86e7df861f70860a4e4d8a3f08d5b5440eae504af5f19"
-```
-
-### Login existing user
-
-```
-pry(main)> response = yodlee_api.login_user 'my-username', 'my-password123'
-pry(main)> yodlee_api.user_session_token
-=> "12162013_1:69761d51a4010e6382ccb49b854513dbccad0f835a873d37884b68826acefaa5b8d41b634f4cc83d97d86e7df861f70860a4e4d8a3f08d5b5440eae504af5f19"
-```
-
-### Convenience for doing both
-
-In case you have a situation where you don't know if the user is already registered there is #login_or_register_user
-
-```
-pry(main)> response = yodlee_api.login_or_register_user 'my-username', 'my-password123', 'my-email@my-domain.com'
-pry(main)> yodlee_api.user_session_token
-=> "12162013_1:69761d51a4010e6382ccb49b854513dbccad0f835a873d37884b68826acefaa5b8d41b634f4cc83d97d86e7df861f70860a4e4d8a3f08d5b5440eae504af5f19"
-```
-### other API methods
-
-TODO
-
-## Why the rename from Yodlicious?
-
-Rubygems.org's search apparently only indexes the gem name not the description or summary. This meant that if you searched for Yodlee in there Yodlicous didn't show up. Now it does.
-
 ## Contributing
 
 1. Fork it ( https://github.com/liftforward/yodlee-icious/fork )
@@ -163,14 +78,3 @@ Rubygems.org's search apparently only indexes the gem name not the description o
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
-
-### Running the integration suite
-
-To run the Yodlee-icious integration tests you'll need an approved yodlee account. This is more than the one offered here [https://devnow.yodlee.com/user/register]. (Some of the integration suite will work against the devnow APIs but not all. On my todo list is to separate them out to make testing easier.) The integration suite expects these values to be set in the following environment variables:
-
-```
-YODLEE_BASE_URL="https://consolidatedsdk.yodlee.com/yodsoap/srest/my-cobranded-path/v1.0"
-YODLEE_COBRANDED_USERNAME="my-cobranded-user"
-YODLEE_COBRANDED_PASSWORD="my-cobranded-password"
-YODLEEICIOUS_PROXY_URL="https://my-proxy-server-on-the-whitelist:my=proxy-port/"
-```

data/lib/yodlee_wrap/response.rb

@@ -17,14 +17,51 @@ module YodleeWrap
       body.is_a?(Hash) && !(body.fetch('errorCode', nil)).nil?
     end
 
+    # Determine if the PROVIDER has mfa
     def mfa?
       if body.is_a?(Hash) && body['provider'] && body['provider'].length == 1
-        body['provider'].first['mfaType']
+        body['provider'].first['mfaType'].present?
       end
     end
 
     def mfa_type
+      return nil unless body['provider']
       body['provider'].first['mfaType'] if mfa?
     end
+
+    def refresh_status
+      return nil unless body['providerAccount']
+      body['providerAccount']['refreshInfo']['status']
+    end
+
+    def additional_status
+      return nil unless body['providerAccount']
+      body['providerAccount']['refreshInfo']['additionalStatus']
+    end
+
+    def add_in_progress?
+      return false unless body['providerAccount']
+      refresh_status == 'IN_PROGRESS' && additional_status == 'USER_INPUT_REQUIRED'
+    end
+
+    def mfa_available?
+      return false unless body['providerAccount']
+      body['providerAccount']['loginForm'] && body['providerAccount']['loginForm']['formType'] != 'login'
+    end
+
+    def add_successful?
+      return false unless body['providerAccount']
+      ['SUCCESS', 'PARTIAL_SUCCESS'].include? refresh_status
+    end
+
+    def add_failed?
+      return false unless body['providerAccount']
+      refresh_status == 'FAILED'
+    end
+
+    def provider_account_id
+      return nil unless body['providerAccount']
+      body['providerAccount']['id']
+    end
   end
 end

data/lib/yodlee_wrap/version.rb

@@ -1,3 +1,3 @@
 module YodleeWrap
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/yodlee_wrap/yodlee_api.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'byebug'
 
 module YodleeWrap
   class YodleeApi
@@ -97,7 +98,6 @@ module YodleeWrap
       else
         info_log response.error_message
       end
-
       @user_auth = response.success? ? response.body : nil
 
       response
@@ -107,12 +107,20 @@ module YodleeWrap
       user_session_execute_api(:get, "/v1/transactions")
     end
 
+    def get_accounts_for(provider_account_id, container_name)
+      user_session_execute_api(:get, "/v1/accounts?providerAccountId=#{provider_account_id}&container=&#{container_name}")
+    end
+
+    def get_account(account_id)
+      user_session_execute_api(:get, "v1/accounts/#{account_id}")
+    end
+
     def get_provider_details(provider_id)
       user_session_execute_api(:get, "/v1/providers/#{provider_id}")
     end
 
     def add_provider_account(provider_id, provider_params)
-      user_session_execute_api(:post, "/v1/providers/#{provider_id}", provider_params)
+      user_session_execute_api(:post, "/v1/providers/providerAccounts?providerId=#{provider_id}", provider_params)
     end
 
     def delete_provider_account(provider_account_id)
@@ -121,8 +129,9 @@ module YodleeWrap
 
     # After an account has been added, use the returned provider_account_id
     # to get updates about the provider account.
+    # default to getting mfa questions if they are available.
     def get_provider_account_status(provider_account_id)
-      user_session_execute_api(:get, "/v1/providers/providerAccounts/#{provider_account_id}")
+      user_session_execute_api(:get, "/v1/providers/providerAccounts/#{provider_account_id}?include=credentials")
     end
 
     # Get all provider accounts for the currently logged in user.
@@ -130,6 +139,10 @@ module YodleeWrap
       user_session_execute_api(:get, '/v1/providers/providerAccounts')
     end
 
+    def get_statements
+      user_session_execute_api(:get, '/v1/statements')
+    end
+
     def update_provider_account(provider_account_id, provider_params)
       user_session_execute_api(:put, "/v1/providers/providerAccounts?providerAccountIds=#{provider_account_id}", provider_params)
     end
@@ -150,7 +163,7 @@ module YodleeWrap
       cobranded_auth_header + ",userSession=#{user_session_token}"
     end
 
-    def execute_api(method, url, params, auth_header = "")
+    def execute_api(method, url, params, auth_header = '')
       debug_log "calling #{url} with #{params}"
       ssl_opts = { verify: false }
       connection = Faraday.new(url: base_url, ssl: ssl_opts, request: { proxy: [] })
@@ -160,8 +173,9 @@ module YodleeWrap
         request.body = params.to_json unless params.empty?
         request.headers['Content-Type'] = 'application/json' unless params.empty?
       end
-      debug_log "response=#{response.status} success?=#{response.success?} body=#{response.body}"
-      Response.new(JSON.parse(response.body), response.status)
+      body = JSON.parse(response.body.blank? ? '{}' : response.body)
+      debug_log "response=#{response.status} success?=#{response.success?} body=#{body}"
+      Response.new(body, response.status)
     end
 
     def cobranded_session_token

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yodlee_wrap
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Shannon Byrne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-25 00:00:00.000000000 Z
+date: 2016-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ files:
 - spec/unit/yodlee_wrap/yodlee_api_spec.rb
 - spec/unit/yodleeicious/config_spec.rb
 - todo.md
+- yodlee_wrap-0.0.1.gem
 - yodlee_wrap.gemspec
 - yodlicious.png
 homepage: ''