yodlee-icious 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9eab47ae01a99ab1d4ac7a9f7eb2b5890c254f1
-  data.tar.gz: 9b4ab7293d4ef8a6a610b773afbeed171bea2bbd
+  metadata.gz: ef657a8e0be48fd78555ced77a44dc9fa8a442e8
+  data.tar.gz: c38c3dc0f39b588f9dbd89e832e0a524c08bb75d
 SHA512:
-  metadata.gz: 5f3086d4c81ca0d5736ec609a81137b43c70119384c06314deab9c45257b8b7a17d922bfc98fcd670003af0cfd95acf9b6c5b9f54bea6a5c6e6e5ebb65f23fb7
-  data.tar.gz: 3d4c97573ff3105ec774b0c468eea8a334d07fba96d79f57e568ce416d73ee553a5deef6fbb81476f2b8fb9553129ec3eb474dc4cefe771779bed4c43174a3bb
+  metadata.gz: de70078bd2302015cb9ef739043eb137c38cb0059d4607d3c772a9604bf166686b1de718a952e6767746a3b6f64ccc33ba5394674ca3253fe0b1a3ed5b9aa030
+  data.tar.gz: a95ee9952630975c96961ec0b64ef0268a004ad1e45f8f3331e30ddeca420a6831015187c9abc456a6213963f42c4871a3a68d3a36561690b917724b1752a70d

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/lib/yodleeicious/response.rb

@@ -1,8 +1,9 @@
 module Yodleeicious
   class Response
 
-    def initialize body
-      @body = body
+    def initialize res, payload=nil
+      @res = res
+      @payload = payload
     end
 
     def success?
@@ -14,7 +15,25 @@ module Yodleeicious
     end
 
     def body
-      @body
+      @body ||= JSON.parse(@res.body)
+    end
+
+    def payload
+      @payload
+    end
+
+    def request_url
+      @res.env.url.to_s
+    rescue
+      nil
+    end
+
+    def status
+      @res.status
+    end
+
+    def response
+      body
     end
 
     def error

data/lib/yodleeicious/version.rb

@@ -1,3 +1,3 @@
 module Yodleeicious
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/yodleeicious/yodlee_api.rb

@@ -16,7 +16,7 @@ module Yodleeicious
       @cobranded_password = config[:cobranded_password] || Yodleeicious::Config.cobranded_password
       @proxy_url = config[:proxy_url] || Yodleeicious::Config.proxy_url
       @logger = config[:logger] || Yodleeicious::Config.logger
-      
+
       info_log "YodleeApi configured with base_url=#{base_url} cobranded_username=#{cobranded_username} proxy_url=#{proxy_url} logger=#{logger}"
     end
 
@@ -32,7 +32,7 @@ module Yodleeicious
       proxy_opts = {}
 
       unless proxy_url == nil
-        proxy_opts[:uri] = URI.parse(proxy_url) 
+        proxy_opts[:uri] = URI.parse(proxy_url)
         proxy_opts[:socks] = use_socks?
       end
 
@@ -40,7 +40,7 @@ module Yodleeicious
     end
 
     def use_socks?
-      return proxy_url != nil && proxy_url.start_with?('socks') 
+      return proxy_url != nil && proxy_url.start_with?('socks')
     end
 
     def cobranded_login
@@ -138,7 +138,7 @@ module Yodleeicious
     end
 
     def add_site_account site_id, site_login_form
-      params = { 
+      params = {
         siteId: site_id
       }.merge(translator.site_login_form_to_add_site_account_params(site_login_form))
 
@@ -167,7 +167,7 @@ module Yodleeicious
     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 && 
+      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' ))
@@ -329,7 +329,7 @@ module Yodleeicious
 
       case response.status
       when 200
-        Response.new(JSON.parse(response.body))
+        Response.new(response, params)
       else
       end
     end

data/spec/integration/integration_spec.rb

@@ -1,8 +1,8 @@
 require "yodleeicious"
 
 describe 'the yodlee api client integration tests', integration: true do
-  let(:config) { 
-    { 
+  let(:config) {
+    {
       base_url: ENV['YODLEE_BASE_URL'],
       cobranded_username: ENV['YODLEE_COBRANDED_USERNAME'],
       cobranded_password: ENV['YODLEE_COBRANDED_PASSWORD'],
@@ -19,6 +19,25 @@ describe 'the yodlee api client integration tests', integration: true do
     }
   }
 
+  shared_examples "request_response_examples" do
+    it 'sets the response data' do
+      expect(subject.response).not_to be_nil
+    end
+
+    it 'sets the request_url' do
+      expect(subject.request_url).not_to be_nil
+    end
+
+    it 'sets payload' do
+      expect(subject.payload).not_to be_nil
+    end
+
+    it 'sets the status code' do
+      expect(subject.status).not_to be_nil
+    end
+  end
+
+
   describe 'the yodlee apis cobranded login endpoint' do
     context 'Given valid cobranded credentials and base_url' do
       context 'When /authenticate/coblogin is called the return' do
@@ -27,6 +46,8 @@ describe 'the yodlee api client integration tests', integration: true do
         it { is_expected.to be_kind_of(Yodleeicious::Response) }
         it { is_expected.to be_success }
 
+        include_examples 'request_response_examples'
+
         it 'contains valid json response' do
           expect(subject.body['cobrandConversationCredentials']).not_to be_nil
           expect(subject.body['cobrandConversationCredentials']['sessionToken']).not_to be_nil
@@ -39,7 +60,7 @@ describe 'the yodlee api client integration tests', integration: true do
     context 'Given valid cobranded credentials and base_url' do
       context 'Given a new user who does not exist within the cobranded account' do
         describe 'When /authenticate/coblogin is called the return' do
-          subject { 
+          subject {
             api.cobranded_login
             api.user_login 'testuser', 'testpassword'
           }
@@ -47,6 +68,8 @@ describe 'the yodlee api client integration tests', integration: true do
           it { is_expected.to be_kind_of(Yodleeicious::Response) }
           it { is_expected.to be_fail }
 
+          include_examples 'request_response_examples'
+
           it 'returns an error response' do
             expect(subject.body).to eq({"Error"=>[{"errorDetail"=>"Invalid User Credentials"}]})
           end
@@ -55,7 +78,7 @@ describe 'the yodlee api client integration tests', integration: true do
 
       context 'Given a user who does exist within the cobranded account' do
         describe 'When /authenticate/coblogin is called the return' do
-          subject { 
+          subject {
             api.cobranded_login
             api.user_login 'testuser', 'testpassword'
           }
@@ -63,6 +86,8 @@ describe 'the yodlee api client integration tests', integration: true do
           it { is_expected.to be_kind_of(Yodleeicious::Response) }
           it { is_expected.to be_fail }
 
+          include_examples 'request_response_examples'
+
           it 'returns an error response' do
             expect(subject.body).to eq({"Error"=>[{"errorDetail"=>"Invalid User Credentials"}]})
           end
@@ -84,6 +109,8 @@ describe 'the yodlee api client integration tests', integration: true do
             api.unregister_user
           }
 
+          include_examples 'request_response_examples'
+
           it 'is expected to offer a valid response' do
             is_expected.to be_kind_of(Yodleeicious::Response)
             is_expected.to be_success
@@ -108,6 +135,7 @@ describe 'the yodlee api client integration tests', integration: true do
             api.unregister_user
           }
 
+          include_examples 'request_response_examples'
 
           it 'is expected to offer a valid response' do
             is_expected.to be_kind_of(Yodleeicious::Response)
@@ -133,7 +161,9 @@ describe 'the yodlee api client integration tests', integration: true do
       context 'When login_or_register_user is called' do
         subject { api.login_or_register_user email, password, email }
 
-        it 'should register the new user and set the user_session_token'  do 
+        include_examples 'request_response_examples'
+
+        it 'should register the new user and set the user_session_token'  do
           expect(subject).to be_success
           expect(subject).to be_kind_of(Yodleeicious::Response)
           expect(api.user_session_token).not_to be_nil
@@ -147,6 +177,8 @@ describe 'the yodlee api client integration tests', integration: true do
       context 'When login_or_register_user is called' do
         subject { api.login_or_register_user registered_user[:email], registered_user[:password], registered_user[:email] }
 
+        include_examples 'request_response_examples'
+
         it 'should login the user and not register them' do
           expect(subject).to be_success
           expect(subject).to be_kind_of(Yodleeicious::Response)
@@ -158,13 +190,15 @@ describe 'the yodlee api client integration tests', integration: true do
 
   describe '#get_site_info' do
     context 'Given a valid cobranded credentials and base_url' do
-      before { 
+      before {
         api.cobranded_login
       }
 
       context 'When a request for site info is performed the result' do
         subject { api.get_site_info 16441 }
 
+        include_examples 'request_response_examples'
+
         it 'is expected to contain login form details' do
           is_expected.not_to be_nil
           is_expected.to be_kind_of(Yodleeicious::Response)
@@ -185,6 +219,8 @@ describe 'the yodlee api client integration tests', integration: true do
       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 }
 
+        include_examples 'request_response_examples'
+
         it 'is expected to contain valid content services info' do
           is_expected.not_to be_nil
           is_expected.to be_kind_of(Yodleeicious::Response)
@@ -198,6 +234,8 @@ describe 'the yodlee api client integration tests', integration: true do
       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 }
 
+        include_examples 'request_response_examples'
+
         it 'is expected to contain valid error details' do
           is_expected.not_to be_nil
           is_expected.to be_kind_of(Yodleeicious::Response)
@@ -232,6 +270,8 @@ describe 'the yodlee api client integration tests', integration: true do
             api.get_mfa_response_for_site response.body['siteAccountId']
           }
 
+          include_examples 'request_response_examples'
+
           it 'is expected be a valid response' do
             is_expected.to be_kind_of(Yodleeicious::Response)
             is_expected.to be_success
@@ -267,6 +307,8 @@ describe 'the yodlee api client integration tests', integration: true do
             api.get_mfa_response_for_site_and_wait response.body['siteAccountId'], 2
           }
 
+          include_examples 'request_response_examples'
+
           it 'is expected be a valid response' do
             is_expected.to be_kind_of(Yodleeicious::Response)
             is_expected.to be_success
@@ -310,6 +352,8 @@ describe 'the yodlee api client integration tests', integration: true do
               api.put_mfa_request_for_site site_account_id, :MFATokenResponse, field_info
             }
 
+            include_examples 'request_response_examples'
+
             it 'is expected be a valid response' do
               is_expected.to be_kind_of(Yodleeicious::Response)
               is_expected.to be_success
@@ -347,6 +391,8 @@ describe 'the yodlee api client integration tests', integration: true do
               api.put_mfa_request_for_site site_account_id, :MFAQuesAnsResponse, field_info
             }
 
+            include_examples 'request_response_examples'
+
             it 'is expected be a valid response' do
               is_expected.to be_kind_of(Yodleeicious::Response)
               is_expected.to be_success
@@ -384,6 +430,8 @@ describe 'the yodlee api client integration tests', integration: true do
               api.put_mfa_request_for_site site_account_id, :MFAImageResponse, field_info
             }
 
+            include_examples 'request_response_examples'
+
             it 'is expected be a valid response' do
               is_expected.to be_kind_of(Yodleeicious::Response)
               is_expected.to be_success
@@ -399,7 +447,7 @@ describe 'the yodlee api client integration tests', integration: true do
 
   describe 'the yodlee apis fetching summary data about registered site accounts endpoints' do
     context 'Given a registered user with registered accounts' do
-      before { 
+      before {
         api.cobranded_login
         api.user_login "testuser_with_transactions@liftforward.com", 'testpassword143'
         # api.register_user "testuser#{rand(100..999)}", 'testpassword143', 'test@test.com'
@@ -408,9 +456,11 @@ describe 'the yodlee api client integration tests', integration: true do
         # api.add_site_account_and_wait(16441, dag_login_form)
       }
 
-      context 'when getAllSiteAccounts is called the return' do 
+      context 'when getAllSiteAccounts is called the return' do
         subject { api.get_all_site_accounts }
 
+        include_examples 'request_response_examples'
+
         it 'is expected to return an array containing 1 siteAccount' do
           # puts JSON.pretty_generate(subject)
           is_expected.to be_success
@@ -456,7 +506,7 @@ describe 'the yodlee api client integration tests', integration: true do
 
   describe 'the yodlee apis fetching user/s transactions' do
     context 'Given a registered user with registered accounts' do
-      before { 
+      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]['fieldValue'] = 'yodlicious.site16441.1'
@@ -482,7 +532,7 @@ describe 'the yodlee api client integration tests', integration: true do
     end
   end
 
-  pending 'downloading transaction history' 
+  pending 'downloading transaction history'
   pending 'fetching a list of content services'
   pending 'failing to create a new session'
   pending 'failing when running a search for a site'

data/spec/unit/yodleeicious/response_spec.rb

@@ -1,29 +1,41 @@
 require "yodleeicious"
 
-describe Yodleeicious::Response do
-  let(:error_response_1) {
-    { 
-      "errorOccurred"=>"true", 
-      "exceptionType"=>"com.yodlee.core.IllegalArgumentValueException", 
-      "referenceCode"=>"_3932d208-345a-400f-a273-83619b8b548b", 
-      "message"=>"Multiple exceptions encapsulated within: invoke getWrappedExceptions for details"
-    }
-  }
+shared_examples 'sets_the_requests' do
+  it 'sets the response data' do
+    expect(subject.response).not_to be_nil
+  end
+
+  it 'sets the request_url' do
+    expect(subject.request_url).not_to be_nil
+  end
 
-  let(:error_response_2) {
-    { "Error" => [ {"errorDetail" => "Invalid User Credentials"} ] }
-  }
+  it 'sets payload' do
+    expect(subject.payload).not_to be_nil
+  end
 
-  let(:success_hash_response) {
-    {}
-  }
+  it 'sets the status code' do
+    expect(subject.status).not_to be_nil
+  end
+end
 
-  let(:success_array_response) {
-    [{}]
-  }
+
+describe Yodleeicious::Response do
+  let (:mock_env) { double("env", url: "http://example.com") }
+  let (:response) { double("Response", body: response_json, env: mock_env, status: 200 ) }
+
+  subject { Yodleeicious::Response.new response, { key: "val" } }
 
   context 'When the error_response is the errorOccured syntax' do
-    subject { Yodleeicious::Response.new error_response_1 }
+    let(:response_json) {
+      {
+        "errorOccurred"=>"true",
+        "exceptionType"=>"com.yodlee.core.IllegalArgumentValueException",
+        "referenceCode"=>"_3932d208-345a-400f-a273-83619b8b548b",
+        "message"=>"Multiple exceptions encapsulated within: invoke getWrappedExceptions for details"
+      }.to_json
+    }
+
+    include_examples "sets_the_requests"
     it { is_expected.not_to be_success }
     it { is_expected.to be_fail }
     it "is expected to return error of InvalidArgumentValueException" do
@@ -32,7 +44,13 @@ describe Yodleeicious::Response do
   end
 
   context 'When the error_response is the Error : ["errorDetail"] syntax' do
-    subject { Yodleeicious::Response.new error_response_2 }
+    let(:response_json) { { "Error" => [ {"errorDetail" => "Invalid User Credentials"} ] }.to_json }
+    let (:mock_env) { double("env", url: "http://example.com") }
+    let (:response) { double("Response", body: response_json, env: mock_env, status: 200 ) }
+
+    subject { Yodleeicious::Response.new response, { key: "val" } }
+
+    include_examples "sets_the_requests"
     it { is_expected.not_to be_success }
     it { is_expected.to be_fail }
     it "is expected to return error of Invalid User Credentials" do
@@ -41,7 +59,11 @@ describe Yodleeicious::Response do
   end
 
   context 'When operation is a success and returns hash' do
-    subject { Yodleeicious::Response.new success_hash_response }
+    let(:response_json) { {}.to_json }
+
+    subject { Yodleeicious::Response.new response, { key: "val" } }
+
+    include_examples "sets_the_requests"
     it { is_expected.to be_success }
     it { is_expected.not_to be_fail }
     it 'is expected to return nil for error' do
@@ -50,7 +72,11 @@ describe Yodleeicious::Response do
   end
 
   context 'When operation is a success and return array' do
-    subject { Yodleeicious::Response.new success_array_response }
+    let(:response_json) { [{}].to_json }
+
+    subject { Yodleeicious::Response.new response, { key: "val" } }
+
+    include_examples "sets_the_requests"
     it { is_expected.to be_success }
     it { is_expected.not_to be_fail }
     it 'is expected to return nil for error' do

data/spec/unit/yodleeicious/yodlee_api_spec.rb

@@ -31,6 +31,7 @@ describe Yodleeicious::YodleeApi do
     it 'should return a translator' do
       expect(subject.translator).not_to be_nil
     end
+
   end
 
   context 'Given a Yodleeicious::Config with nil configuration' do
@@ -104,7 +105,7 @@ describe Yodleeicious::YodleeApi do
       end
     end
   end
-  
+
   context 'Given a Yodleeicious::Config with nil configuration' do
     context 'When a new YodleeApi instance is created and provided a configuration' do
       before {
@@ -114,7 +115,7 @@ describe Yodleeicious::YodleeApi do
         Yodleeicious::Config.proxy_url=nil
       }
       let(:config) {
-        { 
+        {
           base_url: "https://rest.developer.yodlee.com/services/srest/restserver/v1.0",
           cobranded_username: "some_username",
           cobranded_password: "some_password",
@@ -162,7 +163,7 @@ describe Yodleeicious::YodleeApi do
         Yodleeicious::Config.cobranded_password='password'
         Yodleeicious::Config.proxy_url='socks5h://somehostname'
       }
-      let(:config) { 
+      let(:config) {
          {
            base_url: "https://rest.developer.yodlee.com/services/srest/restserver/v1.0",
            cobranded_username: "some_username",
@@ -245,7 +246,7 @@ describe Yodleeicious::YodleeApi do
       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) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yodlee-icious
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Drew Nichols
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-13 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -102,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Yodlee API Client Gem