yodlicious 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a1c24f5be0b2cd579d65a6e4729d7023716a82e
-  data.tar.gz: d540dbae32b123cdff4a6a77a222a2fedf8a8c7e
+  metadata.gz: bc007491e579889f0318b9f292d786eced0cf8bb
+  data.tar.gz: 8349f9cace5145555c1c12a61eca28fbc708e2c0
 SHA512:
-  metadata.gz: 0b003b8a7e0a7b6cfa4611ea324665a8108da6f6bd4b1ba35394b5ba768b229701a438fc40791b07b555af357b163f37ff4e858eaa6844c272c9ef638e74374a
-  data.tar.gz: 0c7b8cb612bb4c4a50dced5363fba4f8c7e94ea5f74d320584ab96746ecf0df2c6d34cecb0747ec96880b5ea2156a05501a3f55e5bf9bd385d67ba9ddad9490e
+  metadata.gz: 6baf54a65da2268c40a0d3543f2c2fb5ffcca19753a7e58e1ee328a93999e563e0a465b770b221b6f333148e52411fdf2efba2aaade036601d153785262b1966
+  data.tar.gz: 6c5dcc17e8df67652690bcc51d30c2870edc0310846e773fba2adf8bef8af998ce7665ccf08ba18eda0be690a2b0732a536077e82172364aae9e11f40299dc57

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.env

data/Gemfile

@@ -7,4 +7,5 @@ gem 'rspec-its'
 gem 'faraday', '0.9.1'
 gem 'faraday_middleware', '~>0.9.1'
 gem 'socksify', '~>1.6.0'
+gem 'dotenv'
 

data/README.md

@@ -1,6 +1,8 @@
-# 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)
+![image of yodlicious](https://github.com/liftforward/yodlicious/blob/master/yodlicious.png)
 
-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.
+# Yodlicious 0.0.1 [ ![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 painful than it should have been so we figured we share to be a good neighbor.
 
 ## Installation
 
@@ -37,6 +39,7 @@ 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'
@@ -50,12 +53,14 @@ Yodlicious::Config.cobranded_password = ENV['YODLEE_COBRANDED_PASSWORD']
 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' }
@@ -65,6 +70,7 @@ yodlee_api.configure { base_url: 'https://secure.yodlee.com/blablabla }
 puts yodlee_api.base_url
 ```
 will output
+
 ```
 https://secure.yodlee.com/blablabla
 ```
@@ -86,7 +92,7 @@ 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.
+The Yodlee Api responses are somewhat varied (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 inconsistent delivery of errors from Yodlee's APIs.
 
 ### Starting your cobranded session
 
@@ -99,16 +105,51 @@ 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.user_login '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
+
 ## Contributing
 
 1. Fork it ( https://github.com/liftforward/yodlicious/fork )
@@ -120,6 +161,7 @@ pry(main)> response.body
 ### 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"

data/lib/yodlicious.rb

@@ -8,7 +8,7 @@ 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"
+require File.dirname(__FILE__) + "/yodlicious/yodlee_api"
 
 class Faraday::Adapter::NetHttp
   def net_http_connection(env)

data/lib/yodlicious/parameter_translator.rb

@@ -17,7 +17,7 @@ module Yodlicious
         params["credentialFields[#{i}].valueIdentifier"] = field['valueIdentifier']
         params["credentialFields[#{i}].valueMask"] = field['valueMask']
         params["credentialFields[#{i}].isEditable"] = field['isEditable']
-        params["credentialFields[#{i}].value"] = field['value']
+        params["credentialFields[#{i}].value"] = field['fieldValue']
 
         i += 1
       }

data/lib/yodlicious/version.rb

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

data/lib/yodlicious/{yodlicious.rb → yodlee_api.rb}

@@ -121,7 +121,12 @@ module Yodlicious
     end
 
     def unregister_user
-      user_session_execute_api '/jsonsdk/UserRegistration/unregister'
+      response = user_session_execute_api '/jsonsdk/UserRegistration/unregister'
+      if response.success?
+        @user_auth = nil
+      end
+
+      response
     end
 
     def site_search search_string
@@ -141,34 +146,101 @@ module Yodlicious
     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)
+    def add_site_account_and_wait site_id, site_login_form, refresh_interval = 0.5, max_trys = 5
+      add_site_account_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
+      if add_site_account_response.success?
+        if normal_site_refresh_in_progress?(add_site_account_response.body['siteRefreshInfo'])
+          site_account_id = add_site_account_response.body['siteAccountId']
+          try = 1
           begin
-            info_log "try #{trys} to get refresh_info for #{site_id}"
-            trys += 1
+            debug_log "try #{try} to get refresh_info for #{site_id}"
+            try += 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
+            add_site_account_response.body['siteRefreshInfo'] = refresh_info_response.body unless refresh_info_response.fail?
+          end while should_retry_get_site_refresh_info? refresh_info_response, try, max_trys
         end
 
-        response
+        add_site_account_response
+      end
+    end
+
+    def should_retry_get_site_refresh_info? response, try, max_trys
+      return response.success? && try < max_trys && (response.body['code'] == 801  || (response.body['code'] == 0 && 
+        response.body['siteRefreshStatus']['siteRefreshStatus'] != 'REFRESH_COMPLETED' &&
+        response.body['siteRefreshStatus']['siteRefreshStatus'] != 'REFRESH_TIMED_OUT' &&
+        response.body['siteRefreshStatus']['siteRefreshStatus'] != 'LOGIN_SUCCESS' ))
+    end
+
+    def normal_site_refresh_in_progress? site_refresh_info
+      return site_refresh_info['siteRefreshMode']['refreshMode'] == 'NORMAL' &&
+             ['REFRESH_TRIGGERED','PARTIAL_COMPLETE'].include?(site_refresh_info['siteRefreshStatus']['siteRefreshStatus'])
+    end
+
+    def get_mfa_response_for_site site_account_id
+      user_session_execute_api '/jsonsdk/Refresh/getMFAResponseForSite', { memSiteAccId: site_account_id }
+    end
+
+    def get_mfa_response_for_site_and_wait site_account_id, refresh_interval=0.5, max_trys=5
+      response = get_mfa_response_for_site site_account_id
+
+      try = 1
+      while should_retry_get_mfa_response? response, try, max_trys
+        debug_log "try #{try} to get mfa message for #{site_account_id}"
+        try += 1
+        sleep(refresh_interval)
+        response = get_mfa_response_for_site site_account_id
       end
+
+      response
+    end
+
+    def should_retry_get_mfa_response? response, try, max_trys
+      return response.success? && response.body['errorCode'].nil? && response.body['isMessageAvailable'] != true && try < max_trys
+    end
+
+    def put_mfa_request_for_site site_account_id, mfa_type, field_info
+      params = {
+        'memSiteAccId' => site_account_id,
+        'userResponse.objectInstanceType' => "com.yodlee.core.mfarefresh.#{mfa_type}"
+      }
+
+      case mfa_type.to_sym
+      when :MFATokenResponse
+        params['userResponse.token']=field_info['fieldValue']
+      when :MFAImageResponse
+        params['userResponse.imageString']=field_info['fieldValue']
+      when :MFAQuesAnsResponse
+        questionsArray = field_info['questionAndAnswerValues']
+        i = 0
+        while i < questionsArray.length do
+          puts "questionsArray= #{questionsArray[i].class} #{i}"
+          params["userResponse.quesAnsDetailArray[#{i}].answer"]=questionsArray[i]['fieldValue']
+          params["userResponse.quesAnsDetailArray[#{i}].answerFieldType"]=questionsArray[i]['answerFieldType']
+          params["userResponse.quesAnsDetailArray[#{i}].metaData"]=questionsArray[i]['metaData']
+          params["userResponse.quesAnsDetailArray[#{i}].question"]=questionsArray[i]['question']
+          params["userResponse.quesAnsDetailArray[#{i}].questionFieldType"]=questionsArray[i]['questionFieldType']
+          i += 1
+        end
+      end
+
+      user_session_execute_api '/jsonsdk/Refresh/putMFARequestForSite', params
     end
 
     def get_site_refresh_info site_account_id
       user_session_execute_api '/jsonsdk/Refresh/getSiteRefreshInfo', { memSiteAccId: site_account_id }
     end
 
+    def get_content_service_info_by_routing_number routing_number, no_trim = true
+      params = {
+        routingNumber: routing_number,
+        notrim: no_trim
+      }
+
+      cobranded_session_execute_api '/jsonsdk/RoutingNumberService/getContentServiceInfoByRoutingNumber', params
+    end
+
     def get_item_summaries
       user_session_execute_api '/jsonsdk/DataService/getItemSummaries', { 'bridgetAppId' => '10003200' }
     end
@@ -233,7 +305,7 @@ module Yodlicious
       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}"
+      debug_log "response=#{response.status} success?=#{response.success?} body=#{response.body} "
 
       case response.status
       when 200
@@ -265,7 +337,7 @@ module Yodlicious
     end
 
     def debug_log msg
-      logger.info msg
+      logger.debug msg
     end
 
     def info_log msg

data/spec/integration_spec.rb

@@ -97,6 +97,31 @@ describe 'the yodlee api client integration tests', integration: true do
     end
   end
 
+  describe '#unregister_user' do
+    context 'Given a valid cobranded credentials and base_url' do
+      context 'Given a user who it logged into the api' do
+        context 'When #unregister_user is called the response' do
+          subject {
+            api.cobranded_login
+            api.login_or_register_user "testuser#{rand(100...200)}", 'testpassword143', 'test@test.com'
+            expect(api.user_session_token).not_to be_nil
+            api.unregister_user
+          }
+
+
+          it 'is expected to offer a valid response' do
+            is_expected.to be_kind_of(Yodlicious::Response)
+            is_expected.to be_success
+            expect(api.user_session_token).to be_nil
+          end
+
+          after { api.unregister_user }
+
+        end
+      end
+    end
+  end
+
   describe 'the yodlicious login_or_register_user method' do
     before { api.cobranded_login }
 
@@ -131,7 +156,7 @@ describe 'the yodlee api client integration tests', integration: true do
     end
   end
 
-  describe 'the yodlee apis site info endpoint' do
+  describe '#get_site_info' do
     context 'Given a valid cobranded credentials and base_url' do
       before { 
         api.cobranded_login
@@ -152,8 +177,40 @@ describe 'the yodlee api client integration tests', integration: true do
     end
   end
 
+
+  describe '#get_content_service_info_by_routing_number' do
+    context 'Given a valid cobranded credentials and base_url' do
+      before { api.cobranded_login }
+
+      context 'When #get_content_service_info_by_routing_number is called with a valid routing number the result' do
+        subject { api.get_content_service_info_by_routing_number 999988181 }
+
+        it 'is expected to contain valid content services info' do
+          is_expected.not_to be_nil
+          is_expected.to be_kind_of(Yodlicious::Response)
+          is_expected.to be_success
+          expect(subject.body['errorOccurred']).to be_nil
+          expect(subject.body['siteId']).to eq(16441)
+          expect(subject.body['contentServiceDisplayName']).to eq('Dag Site (US) - Bank')
+        end
+      end
+
+      context 'When #get_content_service_info_by_routing_number is called with an invalid routing number' do
+        subject { api.get_content_service_info_by_routing_number -23423 }
+
+        it 'is expected to contain valid error details' do
+          is_expected.not_to be_nil
+          is_expected.to be_kind_of(Yodlicious::Response)
+          is_expected.to be_fail
+          expect(subject.body['errorOccurred']).to be_truthy
+          expect(subject.body['exceptionType']).to eq('com.yodlee.core.routingnumberservice.InvalidRoutingNumberException')
+        end
+      end
+    end
+  end
+
   #todo reorganize this spec to use given-when-then
-  describe 'Yodilicious add_site_account_and_wait method' do
+  describe '#add_site_account_and_wait' do
     context 'Given a user who has registered and does not have any accounts' do
       before { 
         api.cobranded_login
@@ -164,7 +221,7 @@ describe 'the yodlee api client integration tests', integration: true do
       }
 
       let(:seconds_between_retry) { 3 }
-      let(:retry_count) { 10 }
+      let(:max_retrys) { 10 }
 
       after {
         begin
@@ -175,10 +232,10 @@ describe 'the yodlee api client integration tests', integration: true do
 
       context 'When a invalid username and password for an account is added' do
         before {
-          dag_login_form['componentList'][0]['value'] = 'invalid_username'
-          dag_login_form['componentList'][1]['value'] = 'invalid_password'
+          dag_login_form['componentList'][0]['fieldValue'] = 'invalid_username'
+          dag_login_form['componentList'][1]['fieldValue'] = 'invalid_password'
         }
-        subject { api.add_site_account_and_wait(16441, dag_login_form, seconds_between_retry, retry_count) }
+        subject { api.add_site_account_and_wait(16441, dag_login_form, seconds_between_retry, max_retrys) }
 
         it 'is expected to respond with siteRefreshStatus=LOGIN_FAILURE and refreshMode=NORMAL a siteAccountId' do
           # puts JSON.pretty_generate(subject.body)
@@ -191,10 +248,10 @@ describe 'the yodlee api client integration tests', integration: true do
 
       context 'When a valid username and password for an account is added' do
         before {
-          dag_login_form['componentList'][0]['value'] = 'yodlicious.site16441.1'
-          dag_login_form['componentList'][1]['value'] = 'site16441.1'
+          dag_login_form['componentList'][0]['fieldValue'] = 'yodlicious.site16441.1'
+          dag_login_form['componentList'][1]['fieldValue'] = 'site16441.1'
         }
-        subject { api.add_site_account_and_wait(16441, dag_login_form, seconds_between_retry, retry_count) }
+        subject { api.add_site_account_and_wait(16441, dag_login_form, seconds_between_retry, max_retrys) }
 
         it 'is expected to respond with siteRefreshStatus=LOGIN_SUCCESS and refreshMode=NORMAL a siteAccountId' do
           is_expected.to be_success
@@ -207,6 +264,239 @@ describe 'the yodlee api client integration tests', integration: true do
     end
   end
 
+  describe '#get_mfa_response_for_site' do
+    context 'Given a valid cobranded credentials and base_url' do
+      context 'Given a user who it logged into the api' do
+        context 'When #get_mfa_response_for_site is called the response' do
+          subject {
+            api.cobranded_login
+            response = api.login_or_register_user "testuser#{rand(100...200)}", 'testpassword143', 'test@test.com'
+
+            dag_fmfa_login_form['componentList'][0]['fieldValue'] = 'yodlicious1.site16445.1'
+            dag_fmfa_login_form['componentList'][1]['fieldValue'] = 'site16445.1'
+
+            response = api.add_site_account_and_wait(16445, dag_fmfa_login_form)
+            expect(response).to be_success
+            # puts "refreshMode= #{response.body['siteRefreshInfo']['siteRefreshMode']['refreshMode']}"
+            expect(response.body['siteRefreshInfo']['siteRefreshMode']['refreshMode']).to eq('MFA')
+            api.get_mfa_response_for_site response.body['siteAccountId']
+          }
+
+          it 'is expected be a valid response' do
+            is_expected.to be_kind_of(Yodlicious::Response)
+            is_expected.to be_success
+            expect(subject.body['isMessageAvailable']).not_to be_nil
+          end
+
+          after { api.unregister_user }
+        end
+      end
+    end
+  end
+
+  describe '#get_mfa_response_for_site_and_wait' do
+    context 'Given a valid cobranded credentials and base_url' do
+      context 'Given a user who it logged into the api' do
+        context 'When #get_mfa_response_for_site_and_wait is called the response' do
+          subject {
+            api.cobranded_login
+            response = api.login_or_register_user "testuser#{rand(100...200)}", 'testpassword143', 'test@test.com'
+
+            dag_fmfa_login_form['componentList'][0]['fieldValue'] = 'yodlicious1.site16445.1'
+            dag_fmfa_login_form['componentList'][1]['fieldValue'] = 'site16445.1'
+
+            response = api.add_site_account_and_wait(16445, dag_fmfa_login_form)
+            expect(response).to be_success
+
+            expect(response.body['siteRefreshInfo']['siteRefreshMode']['refreshMode']).to eq('MFA')
+            api.get_mfa_response_for_site_and_wait response.body['siteAccountId'], 1
+          }
+
+          it 'is expected be a valid response' do
+            is_expected.to be_kind_of(Yodlicious::Response)
+            is_expected.to be_success
+            expect(subject.body['isMessageAvailable']).to be_truthy
+            expect(subject.body['fieldInfo']).not_to be_nil
+          end
+
+          after { api.unregister_user }
+        end
+      end
+    end
+  end
+
+  describe '#put_mfa_request_for_site' do
+    context 'Given a valid cobranded credentials and base_url' do
+      context 'Given a user who is logged into the api' do
+        context 'Given a user attempting to add a site with Token Based MFA' do
+          context 'When #put_mfa_request_for_site is called the response' do
+            subject {
+              api.cobranded_login
+              response = api.login_or_register_user "testuser#{rand(100...200)}", 'testpassword143', 'test@test.com'
+
+              dag_fmfa_login_form['componentList'][0]['fieldValue'] = 'yodlicious1.site16445.1'
+              dag_fmfa_login_form['componentList'][1]['fieldValue'] = 'site16445.1'
+
+              response = api.add_site_account_and_wait(16445, dag_fmfa_login_form)
+              expect(response).to be_success
+
+              expect(response.body['siteRefreshInfo']['siteRefreshMode']['refreshMode']).to eq('MFA')
+              site_account_id = response.body['siteAccountId']
+              response = api.get_mfa_response_for_site_and_wait site_account_id, 2
+              #{ 
+              #  "isMessageAvailable":true,
+              #  "fieldInfo":{
+              #    "responseFieldType":"text",
+              #    "minimumLength":-1,
+              #    "maximumLength":6,
+              #    "displayString":"Security Key"
+              #  },
+              #  "timeOutTime":116420,
+              #  "itemId":0,
+              #  "memSiteAccId":10992295,
+              #  "retry":false
+              #}
+              expect(response.body['isMessageAvailable']).to be_truthy
+
+              field_info = response.body['fieldInfo']
+              field_info['fieldValue'] = "monkeys"
+              api.put_mfa_request_for_site site_account_id, :MFATokenResponse, field_info
+            }
+
+            it 'is expected be a valid response' do
+              is_expected.to be_kind_of(Yodlicious::Response)
+              is_expected.to be_success
+              expect(subject.body['primitiveObj']).to be_truthy
+            end
+
+            after { api.unregister_user }
+          end
+        end
+
+        context 'Given a user attempting to add a site with Security Question and Answer MFA' do
+          context 'When #put_mfa_request_for_site is called the response' do
+            subject {
+              api.cobranded_login
+              response = api.login_or_register_user "testuser#{rand(100...200)}", 'testpassword143', 'test@test.com'
+
+              dag_sqa_login_form['componentList'][0]['fieldValue'] = 'yodlicious1.site16486.1'
+              dag_sqa_login_form['componentList'][1]['fieldValue'] = 'site16486.1'
+
+              response = api.add_site_account(16486, dag_sqa_login_form)
+              expect(response).to be_success
+
+              expect(response.body['siteRefreshInfo']['siteRefreshMode']['refreshMode']).to eq('MFA')
+              site_account_id = response.body['siteAccountId']
+              response = api.get_mfa_response_for_site_and_wait site_account_id, 2
+              # {
+              #   "isMessageAvailable":true,
+              #   "fieldInfo":{
+              #     "questionAndAnswerValues":[
+              #       {
+              #         "question":"What is the name of your state?",
+              #         "questionFieldType":"label",
+              #         "responseFieldType":"text",
+              #         "isRequired":"true",
+              #         "sequence":1,
+              #         "metaData":"QUESTION_1"
+              #       },
+              #       {
+              #         "question":"What is the name of your first school",
+              #         "questionFieldType":"label",
+              #         "responseFieldType":"text",
+              #         "isRequired":"true",
+              #         "sequence":2,
+              #         "metaData":"QUESTION_2"
+              #       }
+              #     ],
+              #     "numOfMandatoryQuestions":-1
+              #   },
+              #   "timeOutTime":96180,
+              #   "itemId":0,
+              #   "memSiteAccId":11025687,
+              #   "retry":false
+              # }
+              expect(response.body['isMessageAvailable']).to be_truthy
+
+              field_info = response.body['fieldInfo']
+              field_info['questionAndAnswerValues'][0]['fieldValue'] = 'Texas'
+              field_info['questionAndAnswerValues'][1]['fieldValue'] = 'w3schools'
+              api.put_mfa_request_for_site site_account_id, :MFAQuesAnsResponse, field_info
+            }
+
+            it 'is expected be a valid response' do
+              is_expected.to be_kind_of(Yodlicious::Response)
+              is_expected.to be_success
+              expect(subject.body['primitiveObj']).to be_truthy
+            end
+
+            after { api.unregister_user }
+          end
+        end
+
+        context 'Given a user attempting to add a site with Captcha MFA' do
+          context 'When #put_mfa_request_for_site is called the response' do
+            subject {
+              api.cobranded_login
+              response = api.login_or_register_user "testuser#{rand(100...200)}", 'testpassword143', 'test@test.com'
+
+              dag_sqa_login_form['componentList'][0]['fieldValue'] = 'yodlicious1.site18769.1'
+              dag_sqa_login_form['componentList'][1]['fieldValue'] = 'site18769.1'
+
+              response = api.add_site_account(18769, dag_sqa_login_form)
+              expect(response).to be_success
+
+              expect(response.body['siteRefreshInfo']['siteRefreshMode']['refreshMode']).to eq('MFA')
+              site_account_id = response.body['siteAccountId']
+              response = api.get_mfa_response_for_site_and_wait site_account_id, 2
+              # {
+              #   "isMessageAvailable":true,
+              #   "fieldInfo":{
+              #     "questionAndAnswerValues":[
+              #       {
+              #         "question":"What is the name of your state?",
+              #         "questionFieldType":"label",
+              #         "responseFieldType":"text",
+              #         "isRequired":"true",
+              #         "sequence":1,
+              #         "metaData":"QUESTION_1"
+              #       },
+              #       {
+              #         "question":"What is the name of your first school",
+              #         "questionFieldType":"label",
+              #         "responseFieldType":"text",
+              #         "isRequired":"true",
+              #         "sequence":2,
+              #         "metaData":"QUESTION_2"
+              #       }
+              #     ],
+              #     "numOfMandatoryQuestions":-1
+              #   },
+              #   "timeOutTime":96180,
+              #   "itemId":0,
+              #   "memSiteAccId":11025687,
+              #   "retry":false
+              # }
+              expect(response.body['isMessageAvailable']).to be_truthy
+
+              field_info = response.body['fieldInfo']
+              field_info['fieldValue'] = "monkeys"
+              api.put_mfa_request_for_site site_account_id, :MFAImageResponse, field_info
+            }
+
+            it 'is expected be a valid response' do
+              is_expected.to be_kind_of(Yodlicious::Response)
+              is_expected.to be_success
+              expect(subject.body['primitiveObj']).to be_truthy
+            end
+
+            after { api.unregister_user }
+          end
+        end
+      end
+    end
+  end
+
   describe 'the yodlee apis fetching summary data about registered site accounts endpoints' do
     context 'Given a registered user with registered accounts' do
       before { 
@@ -276,8 +566,8 @@ describe 'the yodlee api client integration tests', integration: true do
       before { 
         api.cobranded_login
         api.login_or_register_user 'testuser_with_transactions@liftforward.com', 'testpassword143', 'testuser_with_transactions@liftforward.com'
-        dag_login_form['componentList'][0]['value'] = 'yodlicious.site16441.1'
-        dag_login_form['componentList'][1]['value'] = 'site16441.1'
+        dag_login_form['componentList'][0]['fieldValue'] = 'yodlicious.site16441.1'
+        dag_login_form['componentList'][1]['fieldValue'] = 'site16441.1'
         api.add_site_account_and_wait(16441, dag_login_form)
       }
 
@@ -466,4 +756,140 @@ describe 'the yodlee api client integration tests', integration: true do
       "defaultHelpText": "16103"
     }')
   }
+
+  let(:dag_fmfa_login_form) {
+    {
+      "conjunctionOp"=> {
+        "conjuctionOp"=>1
+      },
+      "componentList"=> [ 
+        {
+          "valueIdentifier"=>"LOGIN1",
+          "valueMask"=>"LOGIN_FIELD",
+          "fieldType"=>{"typeName"=>"IF_LOGIN"},
+          "size"=>20,
+          "maxlength"=>40,
+          "name"=>"LOGIN1",
+          "displayName"=>"Catalog",
+          "isEditable"=>true,
+          "isOptional"=>false,
+          "isEscaped"=>false,
+          "helpText"=>"150876",
+          "isOptionalMFA"=>false,
+          "isMFA"=>false
+        },
+        {
+          "valueIdentifier"=>"PASSWORD1",
+          "valueMask"=>"LOGIN_FIELD",
+          "fieldType"=>{"typeName"=>"IF_PASSWORD"},
+          "size"=>20,
+          "maxlength"=>40,
+          "name"=>"PASSWORD1",
+          "displayName"=>"Password",
+          "isEditable"=>true,
+          "isOptional"=>false,
+          "isEscaped"=>false,
+          "helpText"=>"150877",
+          "isOptionalMFA"=>false,
+          "isMFA"=>false
+        }
+      ],
+      "defaultHelpText"=>"16126"
+    }
+  }
+
+  let(:dag_sqa_login_form) {
+    JSON.parse('{
+      "conjunctionOp":{
+        "conjuctionOp":1
+      },
+      "componentList":[
+        {
+          "valueIdentifier":"LOGIN",
+          "valueMask":"LOGIN_FIELD",
+          "fieldType":{
+            "typeName":"IF_LOGIN"
+          },
+          "size":20,
+          "maxlength":40,
+          "name":"LOGIN",
+          "displayName":"Catalog",
+          "isEditable":true,
+          "isOptional":false,
+          "isEscaped":false,
+          "helpText":"150978",
+          "isOptionalMFA":false,
+          "isMFA":false
+        },
+        {
+          "valueIdentifier":"PASSWORD",
+          "valueMask":"LOGIN_FIELD",
+          "fieldType":{
+            "typeName":"IF_PASSWORD"
+          },
+          "size":20,
+          "maxlength":40,
+          "name":"PASSWORD",
+          "displayName":"Password",
+          "isEditable":true,
+          "isOptional":false,
+          "isEscaped":false,
+          "helpText":"150979",
+          "isOptionalMFA":false,
+          "isMFA":false
+        }
+      ],
+      "defaultHelpText":"16176"
+    }')
+  }
 end
+
+
+
+  # {"popularity"=>0,
+  #  "siteId"=>16477,
+  #  "orgId"=>1148,
+  #  "defaultDisplayName"=>"DagSIteMFAAndNonMFA (US)",
+  #  "defaultOrgDisplayName"=>"Demo Bank",
+  #  "contentServiceInfos"=>
+  #   [{"contentServiceId"=>20631, "siteId"=>16477, "containerInfo"=>{"containerName"=>"bank", "assetType"=>1}},
+  #    {"contentServiceId"=>20632, "siteId"=>16477, "containerInfo"=>{"containerName"=>"miles", "assetType"=>0}}],
+  #  "enabledContainers"=>[{"containerName"=>"bank", "assetType"=>1}, {"containerName"=>"miles", "assetType"=>0}],
+  #  "baseUrl"=>"http://192.168.210.152:9090/dag/dhaction.do",
+  #  "loginForms"=>
+  #   [{"conjunctionOp"=>{"conjuctionOp"=>1},
+  #     "componentList"=>
+  #      [{"valueIdentifier"=>"LOGIN",
+  #        "valueMask"=>"LOGIN_FIELD",
+  #        "fieldType"=>{"typeName"=>"IF_LOGIN"},
+  #        "size"=>20,
+  #        "maxlength"=>40,
+  #        "name"=>"LOGIN",
+  #        "displayName"=>"Catalog",
+  #        "isEditable"=>true,
+  #        "isOptional"=>false,
+  #        "isEscaped"=>false,
+  #        "helpText"=>"150970",
+  #        "isOptionalMFA"=>false,
+  #        "isMFA"=>false},
+  #       {"valueIdentifier"=>"PASSWORD",
+  #        "valueMask"=>"LOGIN_FIELD",
+  #        "fieldType"=>{"typeName"=>"IF_PASSWORD"},
+  #        "size"=>20,
+  #        "maxlength"=>40,
+  #        "name"=>"PASSWORD",
+  #        "displayName"=>"Password",
+  #        "isEditable"=>true,
+  #        "isOptional"=>false,
+  #        "isEscaped"=>false,
+  #        "helpText"=>"150971",
+  #        "isOptionalMFA"=>false,
+  #        "isMFA"=>false}],
+  #     "defaultHelpText"=>"16167"}],
+  #  "isHeld"=>false,
+  #  "isCustom"=>false,
+  #  "mfaType"=>{"typeId"=>4, "typeName"=>"SECURITY_QUESTION"},
+  #  "mfaCoverage"=>"FMPA",
+  #  "siteSearchVisibility"=>true,
+  #  "isAlreadyAddedByUser"=>false,
+  #  "isOauthEnabled"=>false}

data/spec/spec_helper.rb

@@ -2,7 +2,8 @@ unless defined?(SPEC_HELPER_LOADED)
   SPEC_HELPER_LOADED = true
 
   require "yodlicious"
-
+  require 'dotenv'
+  Dotenv.load
 
   RSpec.configure do |config|
 

data/spec/unit/parameter_translator_spec.rb

@@ -22,7 +22,7 @@ describe 'parameter translator' do
             'helpText' => 4710,
             'isOptionalMFA' => false,
             'isMFA' => false,
-            'value' => 'kanyewest'
+            'fieldValue' => 'kanyewest'
           },
           {  
             'valueIdentifier' => 'PASSWORD',
@@ -40,7 +40,7 @@ describe 'parameter translator' do
             'helpText' => 11976,
             'isOptionalMFA' => false,
             'isMFA' => false,
-            'value' => 'iLoveTheGrammys'
+            'fieldValue' => 'iLoveTheGrammys'
           }
         ]
       }

data/spec/unit/{yodlicious_spec.rb → yodlee_api_spec.rb}

@@ -3,7 +3,7 @@ require "yodlicious/config"
 
 describe Yodlicious::YodleeApi do
 
-  context 'Given a new uninitialized YodleeApi objecvt' do
+  context 'Given a new uninitialized YodleeApi object' do
     before {
       Yodlicious::Config.base_url=nil
       Yodlicious::Config.cobranded_username=nil
@@ -234,4 +234,107 @@ describe Yodlicious::YodleeApi do
       end
     end
   end
+
+  describe '#should_retry_get_mfa_response?' do
+    let (:api) { Yodlicious::YodleeApi.new }
+    let (:response) { double("response") }
+
+    context 'Given get mfa response has failed' do
+      before { allow(response).to receive(:success?).and_return(false) }
+      subject { api.should_retry_get_mfa_response?(response,0,1) }
+      it { is_expected.to be_falsy }
+    end
+    
+    context 'Given get mfa response is success' do
+      before { allow(response).to receive(:success?).and_return(true) }
+
+      context 'Given an error code is returned' do
+        before { allow(response).to receive(:body).and_return({ 'errorCode' => 100 }) }
+        subject { api.should_retry_get_mfa_response?(response,0,1) }
+        it { is_expected.to be_falsy }
+      end
+
+      context 'Given no error code is returned' do
+        context 'Given the MFA message is available' do
+          before { allow(response).to receive(:body).and_return({ 'isMessageAvailable' => true }) }
+          subject { api.should_retry_get_mfa_response?(response,0,1) }
+          it { is_expected.to be_falsy }
+        end
+
+        context 'Given the MFA message is not available' do
+          before { allow(response).to receive(:body).and_return({ 'isMessageAvailable' => false }) }
+          context 'Given all the trys have been used up' do
+            subject { api.should_retry_get_mfa_response?(response,1,1) }
+            it { is_expected.to be_falsy }
+          end
+
+          context 'Given the trys have not been used up' do
+            subject { api.should_retry_get_mfa_response?(response,0,2) }
+            it { is_expected.to be_truthy }
+          end
+        end
+      end
+    end
+  end
+
+  describe '#should_retry_get_site_refresh_info' do
+    let (:api) { Yodlicious::YodleeApi.new }
+    let (:response) { double("response") }
+
+    context 'Given get mfa response has failed' do
+      before { allow(response).to receive(:success?).and_return(false) }
+      subject { api.should_retry_get_site_refresh_info?(response,0,1) }
+      it { is_expected.to be_falsy }
+    end
+
+    context 'Given get mfa response is success' do
+      before { allow(response).to receive(:success?).and_return(true) }
+
+      context 'Given an code 801 is returned' do
+        before { allow(response).to receive(:body).and_return({ 'code' => 801 }) }
+        subject { api.should_retry_get_site_refresh_info?(response,0,1) }
+        it { is_expected.to be_truthy }
+      end
+
+      context 'Given not 801 and not 0 code is returned' do
+        before { allow(response).to receive(:body).and_return({ 'code' => 5 }) }
+        subject { api.should_retry_get_site_refresh_info?(response,0,1) }
+        it { is_expected.to be_falsy }
+      end
+
+      context 'Given a code 0 is returned' do
+        context 'Given a siteRefreshStatus of REFRESH_COMPLETED' do
+          before { allow(response).to receive(:body).and_return({ 'code' => 0, "siteRefreshStatus" => { "siteRefreshStatus" => "REFRESH_COMPLETED" }}) }
+          subject { api.should_retry_get_site_refresh_info?(response,0,1) }
+          it { is_expected.to be_falsy }
+        end
+
+        context 'Given a siteRefreshStatus of REFRESH_TIMED_OUT' do
+          before { allow(response).to receive(:body).and_return({ 'code' => 0, "siteRefreshStatus" => { "siteRefreshStatus" => "REFRESH_TIMED_OUT" }}) }
+          subject { api.should_retry_get_site_refresh_info?(response,0,1) }
+          it { is_expected.to be_falsy }
+        end
+
+        context 'Given a siteRefreshStatus of LOGIN_SUCCESS' do
+          before { allow(response).to receive(:body).and_return({ 'code' => 0, "siteRefreshStatus" => { "siteRefreshStatus" => "LOGIN_SUCCESS" }}) }
+          subject { api.should_retry_get_site_refresh_info?(response,0,1) }
+          it { is_expected.to be_falsy }
+        end
+
+        context 'Given a siteRefreshStatus of REFRESH_TRIGGERED' do
+          before { allow(response).to receive(:body).and_return({ 'code' => 0, "siteRefreshStatus" => { "siteRefreshStatus" => "REFRESH_TRIGGERED" }}) }
+          subject { api.should_retry_get_site_refresh_info?(response,0,1) }
+          it { is_expected.to be_truthy }
+        end
+
+        context 'Given a siteRefreshStatus of REFRESH_TRIGGERED' do
+          before { allow(response).to receive(:body).and_return({ 'code' => 0, "siteRefreshStatus" => { "siteRefreshStatus" => "REFRESH_TRIGGERED" }}) }
+          context 'Given trys have been used up' do
+            subject { api.should_retry_get_site_refresh_info?(response,1,1) }
+            it { is_expected.to be_falsy }
+          end
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yodlicious
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Drew Nichols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,14 +110,15 @@ files:
 - lib/yodlicious/parameter_translator.rb
 - lib/yodlicious/response.rb
 - lib/yodlicious/version.rb
-- lib/yodlicious/yodlicious.rb
+- lib/yodlicious/yodlee_api.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
 - spec/unit/config_spec.rb
 - spec/unit/parameter_translator_spec.rb
 - spec/unit/response_spec.rb
-- spec/unit/yodlicious_spec.rb
+- spec/unit/yodlee_api_spec.rb
 - yodlicious.gemspec
+- yodlicious.png
 homepage: https://github.com/liftforward/yodlicious
 licenses:
 - MIT
@@ -148,4 +149,4 @@ test_files:
 - spec/unit/config_spec.rb
 - spec/unit/parameter_translator_spec.rb
 - spec/unit/response_spec.rb
-- spec/unit/yodlicious_spec.rb
+- spec/unit/yodlee_api_spec.rb