finapps 2.0.19 → 2.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8aabe52dfb750c8fdfa36a6c14719c55f0ac7fe3
-  data.tar.gz: cb35dd9fc2145d027dd857ad4e2c0b753b2ed669
+  metadata.gz: f9527628458941678b7c20016419c7ca28428977
+  data.tar.gz: dde2b60589faa029658abcd22669950f7371cdf4
 SHA512:
-  metadata.gz: 7732672b75583a484f87d8c154dca931b944bae7235297f53ba8d26f225f783d22289a1a578d8f1205f7785d1eae1607f85b292fb97c48842a658d9c9d8bbd03
-  data.tar.gz: c9a3b2937ebfebe7c750ab46b525558d2a84047c3eb4f2d74aa9c12948fe0ddc07eb77997d60355f020fac300bbe79805669b6de8d2a5ff533887edd47950138
+  metadata.gz: 40e65b20cb6f4273c5f719e89a4ba59a13923de56039a152e83a8747430ec60975785909b19503f63538ba07dab593bbb4322ea2841e075b1382de8970895d46
+  data.tar.gz: f8e53d38f9dcb25abd1531e4b3157c4ad87071c7ebbf1b16817f28507047a6462033d74d69cee14c2875578c4d24f9ff9aced2bacf4177d30e41f501de308ce2

data/lib/finapps/rest/client.rb

@@ -35,6 +35,14 @@ module FinApps
       def orders
         @orders ||= FinApps::REST::Orders.new self
       end
+
+      def institutions
+        @institutions ||= FinApps::REST::Institutions.new self
+      end
+
+      def institutions_forms
+        @institutions_forms ||= FinApps::REST::InstitutionsForms.new self
+      end
     end
   end
 end

data/lib/finapps/rest/institutions.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module FinApps
+  module REST
+    class Institutions < FinApps::REST::Resources
+      require 'erb'
+      using ObjectExtensions
+      using StringExtensions
+
+      def create(site_id, params)
+        raise MissingArgumentsError.new 'Missing argument: site_id.' if site_id.blank?
+        raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
+
+        path = "#{end_point}/site/#{ERB::Util.url_encode(site_id)}/add"
+
+        super params, path
+      end
+
+      def list(search_term)
+        raise MissingArgumentsError.new 'Missing argument: search_term' if search_term.blank?
+        # API errors when search_term is blank, maybe it shouldn't
+
+        path = "#{end_point}/search/#{ERB::Util.url_encode(search_term)}"
+        super path
+      end
+    end
+  end
+end

data/lib/finapps/rest/institutions_forms.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module FinApps
+  module REST
+    class InstitutionsForms < FinApps::REST::Resources
+      require 'erb'
+      using ObjectExtensions
+      using StringExtensions
+
+      def show(site_id)
+        raise MissingArgumentsError.new 'Missing argument: site_id.' if site_id.blank?
+
+        path = "institutions/site/#{ERB::Util.url_encode(site_id)}/form"
+        super site_id, path
+      end
+    end
+  end
+end

data/lib/finapps/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module FinApps
-  VERSION = '2.0.19'
+  VERSION = '2.0.20'
 end

data/lib/finapps.rb

@@ -25,6 +25,8 @@ require 'finapps/rest/users'
 require 'finapps/rest/sessions'
 require 'finapps/rest/order_tokens'
 require 'finapps/rest/orders'
+require 'finapps/rest/institutions_forms'
+require 'finapps/rest/institutions'
 
 require 'finapps/rest/configuration'
 require 'finapps/rest/credentials'

data/spec/rest/institutions_forms_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+RSpec.describe FinApps::REST::InstitutionsForms do
+  let(:client) { FinApps::REST::Client.new(:company_identifier, :company_token) }
+  describe '#show' do
+    context 'when missing site id' do
+      subject { FinApps::REST::InstitutionsForms.new(client).show(nil) }
+      it('raises missing argument error') { expect { subject }.to raise_error(FinApps::MissingArgumentsError) }
+    end
+
+    context 'when valid site id provided' do
+      subject { FinApps::REST::InstitutionsForms.new(client).show('valid_site_id') }
+
+      it { expect { subject }.not_to raise_error }
+      it('performs a get and returns the login html') { expect(subject[0]).to respond_to(:login_form_html) }
+      it('returns no error messages') { expect(subject[1]).to be_empty }
+    end
+
+    context 'when invalid site id provided' do
+      subject { FinApps::REST::InstitutionsForms.new(client).show('invalid_site_id') }
+
+      it { expect { subject }.not_to raise_error }
+      it('results is nil') { expect(subject[0]).to be_nil }
+      it('error messages array is populated') { expect(subject[1].first.downcase).to eq('invalid institution id') }
+    end
+  end
+end

data/spec/rest/institutions_spec.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+RSpec.describe FinApps::REST::Institutions do
+  let(:client) { FinApps::REST::Client.new(:company_identifier, :company_token) }
+  describe '#create' do
+    subject(:institutions) { FinApps::REST::Institutions.new(client) }
+
+    context 'when missing site_id' do
+      let(:create) { subject.create(nil, :params) }
+      it { expect { create }.to raise_error(FinApps::MissingArgumentsError) }
+    end
+
+    context 'when missing params' do
+      let(:create) { subject.create(:site_id, nil) }
+      it { expect { create }.to raise_error(FinApps::MissingArgumentsError) }
+    end
+
+    context 'when valid site_id and params are provided' do
+      let(:create) { subject.create('valid_site_id', :params) }
+
+      it { expect { create }.not_to raise_error }
+      it('performs a post and returns the response') { expect(create[0]).to respond_to(:user_institution) }
+      it('returns no error messages') { expect(create[1]).to be_empty }
+    end
+
+    # No tests for invalid site_id/params because of API/Yodlee flow
+  end
+
+  describe '#list' do
+    subject(:institutions) { FinApps::REST::Institutions.new(client) }
+
+    context 'when search_term is missing' do
+      let(:list) { subject.list(nil) }
+      it { expect { list }.to raise_error(FinApps::MissingArgumentsError) }
+    end
+
+    context 'when proper search_term is provided' do
+      let(:list) { subject.list(:search_term) }
+
+      it { expect { list }.not_to raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns institution array') { expect(list[0]).to be_a(Array) }
+      it('returns no error messages') { expect(list[1]).to be_empty }
+    end
+  end
+end

data/spec/support/fake_api.rb

@@ -16,6 +16,14 @@ class FakeApi < Sinatra::Base
   get('/v2/orders/:id') { json_response 200, 'resource.json' }
   get('/v2/list/orders/:page/:requested/:sort/:asc') { json_response 200, 'orders.json' }
 
+  # institutions
+  get('/v2/institutions/site/valid_site_id/form') { json_response 200, 'institution_login_form.json' }
+  get('/v2/institutions/site/invalid_site_id/form') { json_response 400, 'invalid_institution_id.json' }
+  post('/v2/institutions/site/valid_site_id/add') { json_response 200, 'institution_add.json' }
+  post('/v2/institutions/site/invalid_site_id/add') { json_response 400, 'invalid_institution_id.json' }
+  get('/v2/institutions/search/:search_term') { json_response 200, 'institutions_search_list.json' }
+
+
   # users
   get('/v2/users/valid_public_id') { json_response 200, 'user.json' }
   get('/v2/users/invalid_public_id') { json_response 404, 'resource_not_found.json' }

data/spec/support/fixtures/institution_add.json

@@ -0,0 +1,11 @@
+{
+    "user_institution": {
+        "_id": "57ade50924fb4800013042de",
+        "account_id": 16412510,
+        "institution_name": "Dag Site (US)",
+        "status": 3,
+        "status_message": "queued",
+        "last_refreshed": "2016-08-12T15:02:33.416615465Z"
+    },
+    "mfa": ""
+}

data/spec/support/fixtures/institution_login_form.json

@@ -0,0 +1,3 @@
+{
+    "login_form_html": "<div class='loginField'><label class='loginFieldName'>Catalog</label><input class='loginFieldInput' type='TEXT' name='LOGIN' value='' maxlength='40' size='20'></div><div class='loginField'><label class='loginFieldName'>Password</label><input class='loginFieldInput' type='PASSWORD' name='PASSWORD' value='' maxlength='40' size='20'></div>"
+}

data/spec/support/fixtures/institutions_search_list.json

@@ -0,0 +1,74 @@
+[
+    {
+        "base_url": "https://www.citibank.co.th",
+        "display_name": "CITIBANK (Thailand)",
+        "site_id": 20638,
+        "org_display_name": "Citigroup Inc"
+    },
+    {
+        "base_url": "http://www.citibank.com.au/",
+        "display_name": "Citibank (Australia)",
+        "site_id": 10388,
+        "org_display_name": "Citigroup"
+    },
+    {
+        "base_url": "https://www.citibank.com.br/BRGCB/JPS/portal/Index.do",
+        "display_name": "Citibank (Brazil)",
+        "site_id": 17781,
+        "org_display_name": "Citibank (Brazil)"
+    },
+    {
+        "base_url": "https://online.citibank.com/US/Welcome.c",
+        "display_name": "Citibank (Colombia)",
+        "site_id": 17780,
+        "org_display_name": "Citibank (Colombia)"
+    },
+    {
+        "base_url": "https://www.citibank.co.in",
+        "display_name": "Citibank (India)",
+        "site_id": 9864,
+        "org_display_name": "Citigroup"
+    },
+    {
+        "base_url": "http://www.citibank.com.sg/",
+        "display_name": "Citibank (Singapore)",
+        "site_id": 18079,
+        "org_display_name": "Citibank (Singapore)"
+    },
+    {
+        "base_url": "http://www.citibank.com/uk/",
+        "display_name": "Citibank (UK)",
+        "site_id": 4057,
+        "org_display_name": "Citigroup"
+    },
+    {
+        "base_url": "https://online.citibank.com/US/Welcome.c",
+        "display_name": "Citibank (online.citibank.com) (US)",
+        "site_id": 1603,
+        "org_display_name": "Citigroup"
+    },
+    {
+        "base_url": "http://citibankonline.com",
+        "display_name": "Citibank AT1 (US)",
+        "site_id": 5732,
+        "org_display_name": "Citigroup"
+    },
+    {
+        "base_url": "http://hsa.citibank.com/",
+        "display_name": "Citibank Health Savings Account (US)",
+        "site_id": 13256,
+        "org_display_name": "Citigroup"
+    },
+    {
+        "base_url": "http://www.citibank.com.au/",
+        "display_name": "Citibank Personal Loan (Australia)",
+        "site_id": 12718,
+        "org_display_name": "Citigroup"
+    },
+    {
+        "base_url": "http://www.citibank.com/uk/portal/consumer/investments/sharedealing/index_td.htm",
+        "display_name": "Citibank Sharedealing Service (UK)",
+        "site_id": 8646,
+        "org_display_name": "Citigroup"
+    }
+]

data/spec/support/fixtures/invalid_institution_id.json

@@ -0,0 +1,5 @@
+{
+    "messages": [
+        "Invalid Institution Id"
+    ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 2.0.19
+  version: 2.0.20
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -261,6 +261,8 @@ files:
 - lib/finapps/rest/connection.rb
 - lib/finapps/rest/credentials.rb
 - lib/finapps/rest/defaults.rb
+- lib/finapps/rest/institutions.rb
+- lib/finapps/rest/institutions_forms.rb
 - lib/finapps/rest/order_tokens.rb
 - lib/finapps/rest/orders.rb
 - lib/finapps/rest/resources.rb
@@ -279,6 +281,8 @@ files:
 - spec/rest/client_spec.rb
 - spec/rest/configuration_spec.rb
 - spec/rest/credentials_spec.rb
+- spec/rest/institutions_forms_spec.rb
+- spec/rest/institutions_spec.rb
 - spec/rest/order_tokens_spec.rb
 - spec/rest/orders_spec.rb
 - spec/rest/resources_spec.rb
@@ -288,6 +292,10 @@ files:
 - spec/spec_helpers/client.rb
 - spec/support/fake_api.rb
 - spec/support/fixtures/error.json
+- spec/support/fixtures/institution_add.json
+- spec/support/fixtures/institution_login_form.json
+- spec/support/fixtures/institutions_search_list.json
+- spec/support/fixtures/invalid_institution_id.json
 - spec/support/fixtures/order_token.json
 - spec/support/fixtures/orders.json
 - spec/support/fixtures/relevance_ruleset_names.json
@@ -322,26 +330,28 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: FinApps REST API ruby client.
 test_files:
-- spec/support/fake_api.rb
-- spec/middleware/request/user_agent_spec.rb
+- spec/spec_helpers/client.rb
+- spec/core_extensions/object/is_integer_spec.rb
+- spec/core_extensions/hash/compact_spec.rb
 - spec/middleware/request/tenant_authentication_spec.rb
 - spec/middleware/request/accept_json_spec.rb
+- spec/middleware/request/user_agent_spec.rb
 - spec/middleware/response/raise_error_spec.rb
-- spec/core_extensions/hash/compact_spec.rb
-- spec/core_extensions/object/is_integer_spec.rb
-- spec/spec_helpers/client.rb
+- spec/support/fake_api.rb
 - spec/spec_helper.rb
-- spec/rest/credentials_spec.rb
-- spec/rest/order_tokens_spec.rb
-- spec/rest/users_spec.rb
-- spec/rest/base_client_spec.rb
-- spec/rest/client_spec.rb
-- spec/rest/orders_spec.rb
 - spec/rest/configuration_spec.rb
-- spec/rest/resources_spec.rb
+- spec/rest/institutions_forms_spec.rb
+- spec/rest/users_spec.rb
 - spec/rest/sessions_spec.rb
+- spec/rest/resources_spec.rb
+- spec/rest/credentials_spec.rb
+- spec/rest/orders_spec.rb
+- spec/rest/client_spec.rb
+- spec/rest/base_client_spec.rb
+- spec/rest/order_tokens_spec.rb
+- spec/rest/institutions_spec.rb