yodlicious 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a1c24f5be0b2cd579d65a6e4729d7023716a82e
+  data.tar.gz: d540dbae32b123cdff4a6a77a222a2fedf8a8c7e
+SHA512:
+  metadata.gz: 0b003b8a7e0a7b6cfa4611ea324665a8108da6f6bd4b1ba35394b5ba768b229701a438fc40791b07b555af357b163f37ff4e858eaa6844c272c9ef638e74374a
+  data.tar.gz: 0c7b8cb612bb4c4a50dced5363fba4f8c7e94ea5f74d320584ab96746ecf0df2c6d34cecb0747ec96880b5ea2156a05501a3f55e5bf9bd385d67ba9ddad9490e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format doc
+--tag ~skip
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yodlicious.gemspec
+gemspec
+
+gem 'rspec-its'
+gem 'faraday', '0.9.1'
+gem 'faraday_middleware', '~>0.9.1'
+gem 'socksify', '~>1.6.0'
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Drew Nichols
+
+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

@@ -0,0 +1,128 @@
+# Yodlicious 0.0.1_alpha [ ![Codeship Status for liftforward/yodlicious](https://codeship.com/projects/71603f00-9393-0132-dcd0-1a9a253548c0/status?branch=master)](https://codeship.com/projects/62288)
+
+Yodlicisous is a ruby gem wrapping the Yodlee REST(ish) API. We had to build this for our integration with Yodlee which was somewhat more painfull than it should have been so we figured we share to be a good neighbor.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yodlicious'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install yodlicious
+
+## 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:
+
+```ruby
+require "yodlicious"
+
+config = {
+  base_url: "https://consolidatedsdk.yodlee.com/yodsoap/srest/my-cobranded-path/v1.0",
+  cobranded_username: "my-cobranded-user",
+  cobranded_password: "my-cobranded-password"
+}
+
+yodlee_api = Yodlicious::YodleeApi.new(config)
+
+```
+When in a Rails app it can be more convenient to use a global default configuration. To use global defaults:
+```ruby
+#/<myproject>/config/initializers/yodlicious.rb
+require 'yodlicious'
+
+#setting default configurations for Yodlicious
+Yodlicious::Config.base_url = ENV['YODLEE_BASE_URL']
+Yodlicious::Config.cobranded_username = ENV['YODLEE_COBRANDED_USERNAME']
+Yodlicious::Config.cobranded_password = ENV['YODLEE_COBRANDED_PASSWORD']
+
+#setting yodlicious logger to use the Rails logger
+Yodlicious::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 = Yodlicious::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 = Yodlicious::YodleeApi.new { base_url: 'http://yodlee.com/blablabla' }
+
+yodlee_api.configure { base_url: 'https://secure.yodlee.com/blablabla }
+
+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/"
+}
+
+yodlee_api = Yodlicious::YodleeApi.new(config)
+```
+
+## Working with the API
+
+The Yodlee Api responses are somewhat veried (especially the errors) and as such we build Yodlicious 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 inconsisten deliver 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 = Yodlicious::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"}]}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/liftforward/yodlicious/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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 Yodlicious 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"
+YODLICIOUS_PROXY_URL="https://my-proxy-server-on-the-whitelist:my=proxy-port/"
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/yodlicious/config.rb

@@ -0,0 +1,13 @@
+
+
+module Yodlicious
+  class Config
+    class << self
+      attr_accessor :base_url, :cobranded_username, :cobranded_password, :proxy_url, :logger
+    end
+    
+    self.logger = Logger.new(STDOUT)
+    self.logger.level = Logger::WARN  
+
+  end
+end

data/lib/yodlicious/parameter_translator.rb

@@ -0,0 +1,28 @@
+module Yodlicious
+  class ParameterTranslator
+    def site_login_form_to_add_site_account_params site_login_form
+      
+      params = { "credentialFields.enclosedType" => "com.yodlee.common.FieldInfoSingle" }
+
+      i = 0
+      site_login_form['componentList'].each { |field|
+        # puts "field=#{field}"
+        params["credentialFields[#{i}].displayName"] = field['displayName']
+        params["credentialFields[#{i}].fieldType.typeName"] = field['fieldType']['typeName']
+        params["credentialFields[#{i}].helpText"] = field['helpText']
+        params["credentialFields[#{i}].maxlength"] = field['maxlength']
+        params["credentialFields[#{i}].name"] = field['name']
+        params["credentialFields[#{i}].size"] = field['size']
+        params["credentialFields[#{i}].value"] = field['value']
+        params["credentialFields[#{i}].valueIdentifier"] = field['valueIdentifier']
+        params["credentialFields[#{i}].valueMask"] = field['valueMask']
+        params["credentialFields[#{i}].isEditable"] = field['isEditable']
+        params["credentialFields[#{i}].value"] = field['value']
+
+        i += 1
+      }
+
+      params
+    end
+  end
+end

data/lib/yodlicious/response.rb

@@ -0,0 +1,30 @@
+module Yodlicious
+  class Response
+
+    def initialize body
+      @body = body
+    end
+
+    def success?
+      !fail?
+    end
+
+    def fail?
+      body.kind_of?(Hash) && (body['errorOccurred'] == 'true' || body.has_key?('Error'))
+    end
+
+    def body
+      @body
+    end
+
+    def error
+      if body.kind_of?(Hash)
+        if body.has_key?('Error')
+          body['Error'][0]['errorDetail']
+        elsif body['errorOccurred'] == 'true'
+          body['exceptionType']
+        end
+      end
+    end
+  end
+end

data/lib/yodlicious/version.rb

@@ -0,0 +1,3 @@
+module Yodlicious
+  VERSION = "0.0.1"
+end

data/lib/yodlicious/yodlicious.rb

@@ -0,0 +1,276 @@
+require 'json'
+
+
+module Yodlicious
+  class YodleeApi
+    attr_reader :base_url, :cobranded_username, :cobranded_password, :proxy_url, :logger
+
+    def initialize config = {}
+      configure config
+    end
+
+    def configure config = {}
+      validate config
+      @base_url = config[:base_url] || Yodlicious::Config.base_url
+      @cobranded_username = config[:cobranded_username] || Yodlicious::Config.cobranded_username
+      @cobranded_password = config[:cobranded_password] || Yodlicious::Config.cobranded_password
+      @proxy_url = config[:proxy_url] || Yodlicious::Config.proxy_url
+      @logger = config[:logger] || Yodlicious::Config.logger
+      
+      info_log "YodleeApi configured with base_url=#{base_url} cobranded_username=#{cobranded_username} proxy_url=#{proxy_url} logger=#{logger}"
+    end
+
+    def validate config
+      [:proxy_url, :base_url, :cobranded_username, :cobranded_password, :logger].each { |key|
+        if config.has_key?(key) && config[key].nil?
+          raise "Invalid config provided to YodleeApi. Values may not be nil or blank."
+        end
+      }
+    end
+
+    def proxy_opts
+      proxy_opts = {}
+
+      unless proxy_url == nil
+        proxy_opts[:uri] = URI.parse(proxy_url) 
+        proxy_opts[:socks] = use_socks?
+      end
+
+      proxy_opts
+    end
+
+    def use_socks?
+      return proxy_url != nil && proxy_url.start_with?('socks') 
+    end
+
+    def cobranded_login
+      params = {
+        cobrandLogin: cobranded_username,
+        cobrandPassword: cobranded_password
+      }
+
+      response = execute_api '/authenticate/coblogin', params
+
+      if response.success?
+        @cobranded_auth = response.body
+      else
+        @cobranded_auth = nil
+      end
+
+      response
+    end
+
+    def user_login login, pass
+      params = {
+        login: login,
+        password: pass
+      }
+
+      response = cobranded_session_execute_api '/authenticate/login', params
+
+      if response.success?
+        @user_auth = response.body
+      else
+        @user_auth = nil
+      end
+
+      response
+    end
+
+    def logout_user
+      user_session_execute_api '/jsonsdk/Login/logout'
+    end
+
+    def register_user username, password, emailAddress, options = {}
+      params = {
+        'userCredentials.loginName' => username,
+        'userCredentials.password' => password,
+        'userCredentials.objectInstanceType' => 'com.yodlee.ext.login.PasswordCredentials',
+        'userProfile.emailAddress' => emailAddress
+        #todo add in user preferences
+      }.merge(options)
+
+      response = cobranded_session_execute_api "/jsonsdk/UserRegistration/register3", params
+
+      if response.success?
+        @user_auth = response.body
+      else
+        @user_auth = nil
+      end
+
+      response
+    end
+
+    def login_or_register_user  username, password, email
+      info_log "attempting to login #{username}"
+      response = user_login(username, password)
+
+      #TODO look into what other errors could occur here
+      if response.fail? && response.error == "Invalid User Credentials"
+        info_log "invalid credentials for #{username} attempting to register"
+        response = register_user username, password, email
+      end
+
+      if response.success?
+        @user_auth = response.body
+      else
+        @user_auth = nil
+      end
+
+      response
+    end
+
+    def unregister_user
+      user_session_execute_api '/jsonsdk/UserRegistration/unregister'
+    end
+
+    def site_search search_string
+      user_session_execute_api "/jsonsdk/SiteTraversal/searchSite", { siteSearchString: search_string }
+    end
+
+    def search_content_services search_string
+      user_session_execute_api "/jsonsdk/Search/searchContentServices", { keywords: search_string }
+    end
+
+    def add_site_account site_id, site_login_form
+      params = { 
+        siteId: site_id
+      }.merge(translator.site_login_form_to_add_site_account_params(site_login_form))
+
+      user_session_execute_api '/jsonsdk/SiteAccountManagement/addSiteAccount1', params
+    end
+
+
+    def add_site_account_and_wait site_id, site_login_form, refresh_interval = 0.5, refresh_trys = 5
+      response = add_site_account(site_id, site_login_form)
+
+      #TODO validate response with assert
+      if response.success?
+
+         if response.body['siteRefreshInfo']['siteRefreshStatus']['siteRefreshStatus'] == 'REFRESH_TRIGGERED' &&
+            response.body['siteRefreshInfo']['siteRefreshMode']['refreshMode'] == 'NORMAL'
+
+          site_account_id = response.body['siteAccountId']
+          trys = 1
+          begin
+            info_log "try #{trys} to get refresh_info for #{site_id}"
+            trys += 1
+            sleep(refresh_interval)
+            refresh_info_response = get_site_refresh_info site_account_id
+            response.body['siteRefreshInfo'] = refresh_info_response.body unless refresh_info_response.fail?
+          end until (refresh_info_response.success? && refresh_info_response.body['siteRefreshStatus']['siteRefreshStatus'] != 'REFRESH_TRIGGERED') || trys > refresh_trys
+        end
+
+        response
+      end
+    end
+
+    def get_site_refresh_info site_account_id
+      user_session_execute_api '/jsonsdk/Refresh/getSiteRefreshInfo', { memSiteAccId: site_account_id }
+    end
+
+    def get_item_summaries
+      user_session_execute_api '/jsonsdk/DataService/getItemSummaries', { 'bridgetAppId' => '10003200' }
+    end
+
+    def get_item_summaries_for_site site_account_id
+      user_session_execute_api '/jsonsdk/DataService/getItemSummariesForSite', { memSiteAccId: site_account_id }
+    end
+
+    def get_all_site_accounts
+      user_session_execute_api '/jsonsdk/SiteAccountManagement/getAllSiteAccounts'
+    end
+
+    def get_site_info site_id
+      params = {
+        'siteFilter.siteId' => site_id,
+        'siteFilter.reqSpecifier' => 16
+      }
+      cobranded_session_execute_api '/jsonsdk/SiteTraversal/getSiteInfo', params
+    end
+
+    def execute_user_search_request options = {}
+      params = {
+        'transactionSearchRequest.containerType' => 'All',
+        'transactionSearchRequest.lowerFetchLimit' => 1,
+        'transactionSearchRequest.higherFetchLimit' => 500,
+        'transactionSearchRequest.resultRange.startNumber' => 1,
+        'transactionSearchRequest.resultRange.endNumber' => 10,
+        'transactionSearchRequest.searchClients.clientId' => 1,
+        'transactionSearchRequest.searchClients.clientName' => 'DataSearchService',
+        'transactionSearchRequest.ignoreUserInput' => true,
+        #todo make it so that we can pass a simpler hash of arguments
+        # 'transactionSearchRequest.userInput' => nil,
+        # 'transactionSearchRequest.searchFilter.currencyCode' => nil,
+        # 'transactionSearchRequest.searchFilter.postDateRange.fromDate' => nil,
+        # 'transactionSearchRequest.searchFilter.postDateRange.toDate' => nil,
+        # 'transactionSearchRequest.searchFilter.itemAccountId.identifier' => nil,
+        'transactionSearchRequest.searchFilter.transactionSplitType' => 'ALL_TRANSACTION'
+      }.merge(options)
+
+      user_session_execute_api "/jsonsdk/TransactionSearchService/executeUserSearchRequest", params
+    end
+
+    def cobranded_session_execute_api uri, params = {}
+      params = {
+        cobSessionToken: cobranded_session_token,
+      }.merge(params)
+
+      execute_api uri, params
+    end
+
+    def user_session_execute_api uri, params = {}
+      params = {
+        userSessionToken: user_session_token
+      }.merge(params)
+
+      cobranded_session_execute_api uri, params
+    end
+
+    def execute_api uri, params = {}
+      debug_log "calling #{uri} with #{params}"
+      ssl_opts = { verify: false }
+      connection = Faraday.new(url: base_url, ssl: ssl_opts, request: { proxy: proxy_opts })
+
+      response = connection.post("#{base_url}#{uri}", params)
+      debug_log "response=#{response.status} body=#{response.body} headers=#{response.headers}"
+
+      case response.status
+      when 200
+        Response.new(JSON.parse(response.body))
+      else
+      end
+    end
+
+    def translator
+      @translator ||= ParameterTranslator.new
+    end
+
+    def cobranded_auth
+      @cobranded_auth
+    end
+
+    def user_auth
+      @user_auth
+    end
+
+    def cobranded_session_token
+      return nil if cobranded_auth.nil?
+      cobranded_auth.fetch('cobrandConversationCredentials',{}).fetch('sessionToken','dude')
+    end
+
+    def user_session_token
+      return nil if user_auth.nil?
+      user_auth.fetch('userContext',{}).fetch('conversationCredentials',{}).fetch('sessionToken',nil)
+    end
+
+    def debug_log msg
+      logger.info msg
+    end
+
+    def info_log msg
+      logger.info msg
+    end
+
+  end
+end

data/lib/yodlicious.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'logger'
+require 'faraday'
+require 'socksify'
+require 'socksify/http'
+
+require File.dirname(__FILE__) + "/yodlicious/version"
+require File.dirname(__FILE__) + "/yodlicious/config"
+require File.dirname(__FILE__) + "/yodlicious/parameter_translator"
+require File.dirname(__FILE__) + "/yodlicious/response"
+require File.dirname(__FILE__) + "/yodlicious/yodlicious"
+
+class Faraday::Adapter::NetHttp
+  def net_http_connection(env)
+    if proxy = env[:request][:proxy]
+      if proxy[:socks]
+        # TCPSocket.socks_username = proxy[:user] if proxy[:user]
+        # TCPSocket.socks_password = proxy[:password] if proxy[:password]
+        Net::HTTP::SOCKSProxy(proxy[:uri].host, proxy[:uri].port)
+      else
+        Net::HTTP::Proxy(proxy[:uri].host, proxy[:uri].port, proxy[:uri].user, proxy[:uri].password)
+      end
+    else
+        Net::HTTP
+    end.new(env[:url].host, env[:url].port)
+  end
+end