yodlee-icious 0.0.4

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+unless defined?(SPEC_HELPER_LOADED)
+  SPEC_HELPER_LOADED = true
+
+  require "yodleeicious"
+  require 'dotenv'
+  Dotenv.load
+
+  Yodleeicious::Config.logger = Logger.new("log/test.log")
+  Yodleeicious::Config.logger.level = Logger::DEBUG
+
+  RSpec.configure do |config|
+
+    config.filter_run :focus
+    config.run_all_when_everything_filtered = true
+
+  end
+end

data/spec/unit/yodleeicious/config_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+require "yodleeicious/config"
+
+describe Yodleeicious::Config do
+  describe "#base_url" do
+    it "default value is nil" do
+      Yodleeicious::Config.base_url = nil
+    end
+  end
+
+  describe "#cobranded_username" do
+    it "default value is nil" do
+      Yodleeicious::Config.cobranded_username = nil
+    end
+  end
+
+  describe "#cobranded_password" do
+    it "default value is nil" do
+      Yodleeicious::Config.cobranded_password = nil
+    end
+  end
+
+  describe "#proxy_url" do
+    it "default value is nil" do
+      Yodleeicious::Config.proxy_url = nil
+    end
+  end
+
+  describe "#base_url=" do
+    it "can set value" do
+      Yodleeicious::Config.base_url = 'http://someurl'
+      expect(Yodleeicious::Config.base_url).to eq('http://someurl')
+    end
+  end
+
+  describe "#cobranded_username=" do
+    it "can set value" do
+      Yodleeicious::Config.cobranded_username = 'some username'
+      expect(Yodleeicious::Config.cobranded_username).to eq('some username')
+    end
+  end
+
+  describe "#cobranded_password=" do
+    it "can set value" do
+      Yodleeicious::Config.cobranded_password = 'some password'
+      expect(Yodleeicious::Config.cobranded_password).to eq('some password')
+    end
+  end
+
+  describe "#proxy_url=" do
+    it "can set value" do
+      Yodleeicious::Config.proxy_url = 'http://someurl'
+      expect(Yodleeicious::Config.proxy_url).to eq('http://someurl')
+    end
+  end
+
+  describe "#logger="do
+    let(:logger) { Logger.new(STDOUT) }
+    it "can set value" do
+      Yodleeicious::Config.logger = logger
+      expect(Yodleeicious::Config.logger).to eq(logger)
+    end
+  end
+
+end

data/spec/unit/yodleeicious/parameter_translator_spec.rb

@@ -0,0 +1,80 @@
+ require "yodleeicious/parameter_translator"
+
+describe 'parameter translator' do
+  subject { Yodleeicious::ParameterTranslator.new }
+  context 'converting login params json to add site params' do
+    let (:login_form) {
+      {
+        'componentList' => [  
+          {  
+            'valueIdentifier' => 'LOGIN',
+            'valueMask' => 'LOGIN_FIELD',
+            'fieldType' => {  
+              'typeName' => 'IF_LOGIN'
+            },
+            'size' => 20,
+            'maxlength' => 32,
+            'name' => 'LOGIN',
+            'displayName' => 'User ID',
+            'isEditable' => true,
+            'isOptional' => false,
+            'isEscaped' => false,
+            'helpText' => 4710,
+            'isOptionalMFA' => false,
+            'isMFA' => false,
+            'fieldValue' => 'kanyewest'
+          },
+          {  
+            'valueIdentifier' => 'PASSWORD',
+            'valueMask' => 'LOGIN_FIELD',
+            'fieldType' => {  
+              'typeName' => 'IF_PASSWORD'
+            },
+            'size' => 20,
+            'maxlength' => 40,
+            'name' => 'PASSWORD',
+            'displayName' => 'Password',
+            'isEditable' => true,
+            'isOptional' => false,
+            'isEscaped' => false,
+            'helpText' => 11976,
+            'isOptionalMFA' => false,
+            'isMFA' => false,
+            'fieldValue' => 'iLoveTheGrammys'
+          }
+        ]
+      }
+    }
+
+    let (:add_site_params) {
+      {
+        "credentialFields.enclosedType"          => "com.yodlee.common.FieldInfoSingle",
+        "credentialFields[0].displayName"        => "User ID",
+        "credentialFields[0].fieldType.typeName" => "IF_LOGIN",
+        "credentialFields[0].helpText"           => 4710,
+        "credentialFields[0].maxlength"          => 32,
+        "credentialFields[0].name"               => "LOGIN",
+        "credentialFields[0].size"               => 20,
+        "credentialFields[0].value"              => 'kanyewest',
+        "credentialFields[0].valueIdentifier"    => "LOGIN",
+        "credentialFields[0].valueMask"          => "LOGIN_FIELD",
+        "credentialFields[0].isEditable"         => true,
+        "credentialFields[1].displayName"        => "Password",
+        "credentialFields[1].fieldType.typeName" => "IF_PASSWORD",
+        "credentialFields[1].helpText"           => 11976,
+        "credentialFields[1].maxlength"          => 40,
+        "credentialFields[1].name"               => "PASSWORD",
+        "credentialFields[1].size"               => 20,
+        "credentialFields[1].value"              => 'iLoveTheGrammys',
+        "credentialFields[1].valueIdentifier"    => "PASSWORD",
+        "credentialFields[1].valueMask"          => "LOGIN_FIELD",
+        "credentialFields[1].isEditable"         => true 
+      }
+    }
+
+    it "converts correctly to params hash" do
+      expect(subject.site_login_form_to_add_site_account_params(login_form)).to be == add_site_params
+    end
+
+  end
+end

data/spec/unit/yodleeicious/response_spec.rb

@@ -0,0 +1,61 @@
+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"
+    }
+  }
+
+  let(:error_response_2) {
+    { "Error" => [ {"errorDetail" => "Invalid User Credentials"} ] }
+  }
+
+  let(:success_hash_response) {
+    {}
+  }
+
+  let(:success_array_response) {
+    [{}]
+  }
+
+  context 'When the error_response is the errorOccured syntax' do
+    subject { Yodleeicious::Response.new error_response_1 }
+    it { is_expected.not_to be_success }
+    it { is_expected.to be_fail }
+    it "is expected to return error of InvalidArgumentValueException" do
+      expect(subject.error).to eq('com.yodlee.core.IllegalArgumentValueException')
+    end
+  end
+
+  context 'When the error_response is the Error : ["errorDetail"] syntax' do
+    subject { Yodleeicious::Response.new error_response_2 }
+    it { is_expected.not_to be_success }
+    it { is_expected.to be_fail }
+    it "is expected to return error of Invalid User Credentials" do
+      expect(subject.error).to eq('Invalid User Credentials')
+    end
+  end
+
+  context 'When operation is a success and returns hash' do
+    subject { Yodleeicious::Response.new success_hash_response }
+    it { is_expected.to be_success }
+    it { is_expected.not_to be_fail }
+    it 'is expected to return nil for error' do
+      expect(subject.error).to be_nil
+    end
+  end
+
+  context 'When operation is a success and return array' do
+    subject { Yodleeicious::Response.new success_array_response }
+    it { is_expected.to be_success }
+    it { is_expected.not_to be_fail }
+    it 'is expected to return nil for error' do
+      expect(subject.error).to be_nil
+    end
+  end
+
+end

data/spec/unit/yodleeicious/yodlee_api_spec.rb

@@ -0,0 +1,341 @@
+require "yodleeicious"
+require "yodleeicious/config"
+
+describe Yodleeicious::YodleeApi do
+
+  context 'Given a new uninitialized YodleeApi object' do
+    before {
+      Yodleeicious::Config.base_url=nil
+      Yodleeicious::Config.cobranded_username=nil
+      Yodleeicious::Config.cobranded_password=nil
+      Yodleeicious::Config.proxy_url=nil
+    }
+    subject { Yodleeicious::YodleeApi.new }
+
+    it 'should return nil for cobranded_auth' do
+      expect(subject.cobranded_auth).to be_nil
+    end
+
+    it 'should return nil for user_auth' do
+      expect(subject.user_auth).to be_nil
+    end
+
+    it 'should return nil for session_token' do
+      expect(subject.cobranded_session_token).to be_nil
+    end
+
+    it 'should return nil for user_session_token' do
+      expect(subject.user_session_token).to be_nil
+    end
+
+    it 'should return a translator' do
+      expect(subject.translator).not_to be_nil
+    end
+  end
+
+  context 'Given a Yodleeicious::Config with nil configuration' do
+    context 'When a new YodleeApi instance is created with no configuration' do
+      before {
+        Yodleeicious::Config.base_url=nil
+        Yodleeicious::Config.cobranded_username=nil
+        Yodleeicious::Config.cobranded_password=nil
+        Yodleeicious::Config.proxy_url=nil
+      }
+      subject { Yodleeicious::YodleeApi.new }
+
+      it 'no base_url set' do
+        expect(subject.base_url).to be_nil
+      end
+
+      it 'no cobranded_username is set' do
+        expect(subject.cobranded_username).to be_nil
+      end
+
+      it 'no cobranded_password is set' do
+        expect(subject.cobranded_password).to be_nil
+      end
+
+      it 'no proxy_url is set' do
+        expect(subject.proxy_url).to be_nil
+      end
+
+      it 'empty proxy_opts are created' do
+        expect(subject.proxy_opts).to eq({})
+      end
+
+      it 'no socks proxy is used' do
+        expect(subject.use_socks?).to eq(false)
+      end
+    end
+  end
+
+  context 'Given a Yodleeicious::Config with a configuration' do
+    context 'When a new YodleeApi instance is created with the global configuration set' do
+      before {
+        Yodleeicious::Config.base_url='base url'
+        Yodleeicious::Config.cobranded_username='user name'
+        Yodleeicious::Config.cobranded_password='password'
+        Yodleeicious::Config.proxy_url='socks5h://somehostname'
+      }
+      subject { Yodleeicious::YodleeApi.new }
+
+      it 'base_url set' do
+        expect(subject.base_url).to eq('base url')
+      end
+
+      it 'cobranded_username is set' do
+        expect(subject.cobranded_username).to eq('user name')
+      end
+
+      it 'cobranded_password is set' do
+        expect(subject.cobranded_password).to eq('password')
+      end
+
+      it 'proxy_url is set' do
+        expect(subject.proxy_url).to eq('socks5h://somehostname')
+      end
+
+      it 'proxy_opts are created' do
+        expect(subject.proxy_opts).to eq({ socks: true, uri: URI.parse('socks5h://somehostname') })
+      end
+
+      it 'socks proxy is used' do
+        expect(subject.use_socks?).to eq(true)
+      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 {
+        Yodleeicious::Config.base_url=nil
+        Yodleeicious::Config.cobranded_username=nil
+        Yodleeicious::Config.cobranded_password=nil
+        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",
+          proxy_url: "socks5h://127.0.0.1:1080"
+        }
+      }
+
+      subject { Yodleeicious::YodleeApi.new(config) }
+
+      it 'the provided base url is set' do
+        expect(subject.base_url).to eq(config[:base_url])
+      end
+
+      it 'the provided cobranded_username is set' do
+        expect(subject.cobranded_username).to eq(config[:cobranded_username])
+      end
+
+      it 'the provided cobranded_password is set' do
+        expect(subject.cobranded_password).to eq(config[:cobranded_password])
+      end
+
+      it 'the provided proxy_url is set' do
+        expect(subject.proxy_url).to eq(config[:proxy_url])
+      end
+
+      it 'the provided proxy_opts are created' do
+        proxy_opts = {
+          socks: true,
+          uri: URI.parse(config[:proxy_url])
+        }
+        expect(subject.proxy_opts).to eq(proxy_opts)
+      end
+
+      it 'the provided socks proxy is used' do
+        expect(subject.use_socks?).to eq(true)
+      end
+    end
+  end
+
+  context 'Given a Yodleeicious::Config with set config values' do
+    context 'When a new YodleeApi instance is created and provided a configuration' do
+      before {
+        Yodleeicious::Config.base_url='base url'
+        Yodleeicious::Config.cobranded_username='user name'
+        Yodleeicious::Config.cobranded_password='password'
+        Yodleeicious::Config.proxy_url='socks5h://somehostname'
+      }
+      let(:config) { 
+         {
+           base_url: "https://rest.developer.yodlee.com/services/srest/restserver/v1.0",
+           cobranded_username: "some_username",
+           cobranded_password: "some_password",
+           proxy_url: "socks5h://127.0.0.1:1080"
+         }
+      }
+
+      subject { Yodleeicious::YodleeApi.new(config) }
+
+      it 'the provided base url is set' do
+        expect(subject.base_url).to eq(config[:base_url])
+      end
+
+      it 'the provided cobranded_username is set' do
+        expect(subject.cobranded_username).to eq(config[:cobranded_username])
+      end
+
+      it 'the provided cobranded_password is set' do
+        expect(subject.cobranded_password).to eq(config[:cobranded_password])
+      end
+
+      it 'the provided proxy_url is set' do
+        expect(subject.proxy_url).to eq(config[:proxy_url])
+      end
+
+      it 'the provided proxy_opts are created' do
+        proxy_opts = {
+          socks: true,
+          uri: URI.parse(config[:proxy_url])
+        }
+        expect(subject.proxy_opts).to eq(proxy_opts)
+      end
+
+      it 'the provided socks proxy is used' do
+        expect(subject.use_socks?).to eq(true)
+      end
+    end
+  end
+
+  context 'Given a Yodleeicious::Config with nil config values' do
+    context 'When a new YodleeApi instance is configured with no proxy_url' do
+      before {
+        Yodleeicious::Config.base_url=nil
+        Yodleeicious::Config.cobranded_username=nil
+        Yodleeicious::Config.cobranded_password=nil
+        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"
+        }
+      }
+
+      subject { Yodleeicious::YodleeApi.new(config) }
+
+      it 'no proxy_url is set' do
+        expect(subject.proxy_url).to be_nil
+      end
+
+      it 'no proxy_opts are created' do
+        expect(subject.proxy_opts).to eq({})
+      end
+
+      it 'the socks proxy is not used' do
+        expect(subject.use_socks?).to eq(false)
+      end
+    end
+  end
+
+  describe '#should_retry_get_mfa_response?' do
+    let (:api) { Yodleeicious::YodleeApi.new }
+    let (:response) { instance_double("Yodleeicious::Response") }
+
+    context 'Given get mfa response has failed' do
+      before { allow(response).to receive(:success?).and_return(false) }
+      before { allow(response).to receive(:body).and_return({}) }
+      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) { Yodleeicious::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