finapps 4.0.6 → 4.0.7

data/spec/rest/client_spec.rb

@@ -16,6 +16,14 @@ RSpec.describe FinApps::REST::Client do
       end
     end
 
+    describe '#alert_definitions' do
+      it { expect(subject.alert_definitions).to be_an_instance_of(FinApps::REST::AlertDefinitions) }
+    end
+
+    describe '#alert_occurrences' do
+      it { expect(subject.alert_occurrences).to be_an_instance_of(FinApps::REST::AlertOccurrences) }
+    end
+
     describe '#version' do
       it { expect(subject.version).to be_an_instance_of(FinApps::REST::Version) }
     end
@@ -98,6 +106,32 @@ RSpec.describe FinApps::REST::Client do
       it { expect(subject.products).to be_an_instance_of(FinApps::REST::Products) }
     end
 
+    describe '#portfolios' do
+      it { expect(subject.portfolios).to be_an_instance_of(FinApps::REST::Portfolios) }
+    end
+
+    describe '#portfolios_alerts' do
+      it { expect(subject.portfolios_alerts).to be_an_instance_of(FinApps::REST::PortfoliosAlerts) }
+    end
+
+    describe '#portfolios_available_consumers' do
+      it {
+        expect(subject.portfolios_available_consumers).to be_an_instance_of(FinApps::REST::PortfoliosAvailableConsumers)
+      }
+    end
+
+    describe '#portfolios_consumers' do
+      it { expect(subject.portfolios_consumers).to be_an_instance_of(FinApps::REST::PortfoliosConsumers) }
+    end
+
+    describe '#consumers_portfolios' do
+      it { expect(subject.consumers_portfolios).to be_an_instance_of(FinApps::REST::ConsumersPortfolios) }
+    end
+
+    describe '#portfolio_reports' do
+      it { expect(subject.portfolio_reports).to be_an_instance_of(FinApps::REST::PortfolioReports) }
+    end
+
     describe '#statements' do
       it { expect(subject.statements).to be_an_instance_of(FinApps::REST::Statements) }
     end

data/spec/rest/consumers_portfolios_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+
+RSpec.describe FinApps::REST::ConsumersPortfolios do
+  include SpecHelpers::Client
+  subject { FinApps::REST::ConsumersPortfolios.new(client) }
+
+  describe '#list' do
+    let(:list) { subject.list(id, params) }
+    let(:results) { list[RESULTS] }
+    let(:errors) { list[ERROR_MESSAGES] }
+
+    context 'when missing id' do
+      let(:id) { nil }
+      let(:params) { nil }
+
+      it { expect { list }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when missing params' do
+      let(:id) { 'valid_id' }
+      let(:params) { nil }
+
+      it { expect { list }.not_to raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns the response') { expect(results).to respond_to(:records) }
+      it('returns no error messages') { expect(errors).to be_empty }
+    end
+
+    context 'when invalid params are provided' do
+      let(:id) { 'valid_id' }
+      let(:params) { %w[this is an array] }
+
+      it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
+    end
+
+    context 'when including valid params' do
+      let(:id) { 'valid_id' }
+      let(:params) { { page: 2, sort: '-created_date', requested: 25 } }
+
+      it { expect { list }.not_to raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns the response') { expect(results).to respond_to(:records) }
+      it('returns no error messages') { expect(errors).to be_empty }
+      it 'builds query and sends proper request' do
+        list
+        url = "#{FinAppsCore::REST::Defaults::DEFAULTS[:host]}/v3/consumers/#{id}/portfolios?page=2&" \
+        'requested=25&sort=-created_date'
+        expect(WebMock).to have_requested(:get, url)
+      end
+    end
+  end
+end

data/spec/rest/portfolio_reports_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+
+RSpec.describe FinApps::REST::PortfolioReports do
+  include SpecHelpers::Client
+  subject { FinApps::REST::PortfolioReports.new(client) }
+
+  describe '#list' do
+    let(:list) { subject.list(params) }
+    let(:results) { list[RESULTS] }
+    let(:errors) { list[ERROR_MESSAGES] }
+
+    context 'when missing params' do
+      let(:params) { nil }
+
+      it { expect { list }.not_to raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns the response') { expect(results).to respond_to(:records) }
+      it('returns no error messages') { expect(errors).to be_empty }
+    end
+
+    context 'when invalid params are provided' do
+      let(:params) { %w[this is an array] }
+
+      it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
+    end
+
+    context 'when including valid params' do
+      let(:params) { { page: 2, sort: '-created_date', requested: 25 } }
+
+      it { expect { list }.not_to raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns the response') { expect(results).to respond_to(:records) }
+      it('returns no error messages') { expect(errors).to be_empty }
+      it 'builds query and sends proper request' do
+        list
+        url = "#{FinAppsCore::REST::Defaults::DEFAULTS[:host]}/v3/portfolio/reports?page=2&requested=25&" \
+        'sort=-created_date'
+        expect(WebMock).to have_requested(:get, url)
+      end
+    end
+  end
+end

data/spec/rest/portfolios_alerts_spec.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+
+RSpec.describe FinApps::REST::PortfoliosAlerts do
+  include SpecHelpers::Client
+  subject { FinApps::REST::PortfoliosAlerts.new(client) }
+
+  describe '#list' do
+    let(:list) { subject.list(id) }
+    let(:results) { list[RESULTS] }
+    let(:errors) { list[ERROR_MESSAGES] }
+
+    context 'when missing id' do
+      let(:id) { nil }
+
+      it { expect { list }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when valid id is provided' do
+      let(:id) { 'valid_id' }
+
+      it { expect { list }.not_to raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns array of alert definitions') do
+        expect(results).to be_a(Array)
+        expect(results.first).to respond_to(:_id)
+        expect(results.first).to respond_to(:rule_name)
+      end
+      it('returns no error messages') { expect(errors).to be_empty }
+    end
+
+    context 'when invalid id is provided' do
+      let(:id) { 'invalid_id' }
+
+      it { expect { list }.not_to raise_error }
+      it('results is nil') { expect(results).to be_nil }
+      it('error messages array is populated') do
+        expect(errors.first.downcase).to eq('resource not found')
+      end
+    end
+  end
+
+  describe '#create' do
+    let(:create) { subject.create(portfolio_id, alert_id) }
+    let(:results) { create[RESULTS] }
+    let(:errors) { create[ERROR_MESSAGES] }
+
+    context 'when missing portfolio_id' do
+      let(:portfolio_id) { nil }
+      let(:alert_id) { 'valid_id' }
+
+      it { expect { create }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when missing alert_id' do
+      let(:portfolio_id) { 'valid_id' }
+      let(:alert_id) { nil }
+
+      it { expect { create }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when valid ids are provided' do
+      let(:portfolio_id) { 'valid_id' }
+      let(:alert_id) { portfolio_id }
+
+      it { expect { create }.not_to raise_error(FinAppsCore::MissingArgumentsError) }
+      it('returns an array') { expect(create).to be_a(Array) }
+      it('results is nil') { expect(results).to be_nil }
+      it('returns no error messages') { expect(errors).to be_empty }
+    end
+
+    context 'when invalid ids are provided' do
+      let(:portfolio_id) { 'invalid_id' }
+      let(:alert_id) { portfolio_id }
+
+      it { expect { create }.not_to raise_error(FinAppsCore::MissingArgumentsError) }
+      it('results is nil') { expect(results).to be_nil }
+      it('error messages array is populated') do
+        expect(errors.first.downcase).to eq('resource not found')
+      end
+    end
+  end
+
+  describe '#destroy' do
+    let(:destroy) { subject.destroy(portfolio_id, alert_id) }
+    let(:results) { destroy[RESULTS] }
+    let(:errors) { destroy[ERROR_MESSAGES] }
+
+    context 'when missing portfolio_id' do
+      let(:portfolio_id) { nil }
+      let(:alert_id) { 'valid_id' }
+
+      it { expect { destroy }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when missing alert_id' do
+      let(:portfolio_id) { 'valid_id' }
+      let(:alert_id) { nil }
+
+      it { expect { destroy }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when valid ids are provided' do
+      let(:portfolio_id) { 'valid_id' }
+      let(:alert_id) { portfolio_id }
+
+      it { expect { destroy }.not_to raise_error(FinAppsCore::MissingArgumentsError) }
+      it('returns an array') { expect(destroy).to be_a(Array) }
+      it('results is nil') { expect(results).to be_nil }
+      it('returns no error messages') { expect(errors).to be_empty }
+    end
+
+    context 'when invalid ids are provided' do
+      let(:portfolio_id) { 'invalid_id' }
+      let(:alert_id) { portfolio_id }
+
+      it { expect { destroy }.not_to raise_error(FinAppsCore::MissingArgumentsError) }
+      it('results is nil') { expect(results).to be_nil }
+      it('error messages array is populated') do
+        expect(errors.first.downcase).to eq('resource not found')
+      end
+    end
+  end
+end

data/spec/rest/portfolios_available_consumers_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+
+RSpec.describe FinApps::REST::PortfoliosAvailableConsumers do
+  include SpecHelpers::Client
+  subject { FinApps::REST::PortfoliosAvailableConsumers.new(client) }
+
+  describe '#list' do
+    let(:list) { subject.list(id, params) }
+    let(:results) { list[RESULTS] }
+    let(:errors) { list[ERROR_MESSAGES] }
+
+    context 'when missing id' do
+      let(:id) { nil }
+      let(:params) { nil }
+
+      it { expect { list }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when missing params' do
+      let(:id) { 'valid_id' }
+      let(:params) { nil }
+
+      it { expect { list }.not_to raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns the response') { expect(results).to respond_to(:records) }
+      it('returns no error messages') { expect(errors).to be_empty }
+    end
+
+    context 'when invalid params are provided' do
+      let(:id) { 'valid_id' }
+      let(:params) { %w[this is an array] }
+
+      it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
+    end
+
+    context 'when including valid params' do
+      let(:id) { 'valid_id' }
+      let(:params) { { page: 2, sort: '-created_date', requested: 25 } }
+
+      it { expect { list }.not_to raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns the response') { expect(results).to respond_to(:records) }
+      it('returns no error messages') { expect(errors).to be_empty }
+      it 'builds query and sends proper request' do
+        list
+        url = "#{FinAppsCore::REST::Defaults::DEFAULTS[:host]}/v3/portfolios/#{id}/consumers/available?page=2&" \
+        'requested=25&sort=-created_date'
+        expect(WebMock).to have_requested(:get, url)
+      end
+    end
+  end
+end

data/spec/rest/portfolios_consumers_spec.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+
+RSpec.describe FinApps::REST::PortfoliosConsumers do
+  include SpecHelpers::Client
+  subject { FinApps::REST::PortfoliosConsumers.new(client) }
+
+  describe '#list' do
+    let(:list) { subject.list(portfolio_id, params) }
+    let(:results) { list[RESULTS] }
+    let(:errors) { list[ERROR_MESSAGES] }
+
+    context 'when missing id' do
+      let(:portfolio_id) { nil }
+      let(:params) { nil }
+
+      it { expect { list }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when invalid params are provided' do
+      let(:portfolio_id) { 'valid_id' }
+      let(:params) { %w[this is an array] }
+
+      it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
+    end
+
+    context 'when valid id is provided w/o params' do
+      let(:portfolio_id) { 'valid_id' }
+      let(:params) { nil }
+
+      it { expect { list }.not_to raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns the response') { expect(results).to respond_to(:records) }
+      it('returns no error messages') { expect(errors).to be_empty }
+    end
+
+    context 'when valid id is provided w/ valid params' do
+      let(:portfolio_id) { 'valid_id' }
+      let(:params) { { page: 2, sort: '-created_date', requested: 25 } }
+
+      it { expect { list }.not_to raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns the response') { expect(results).to respond_to(:records) }
+      it('returns no error messages') { expect(errors).to be_empty }
+      it 'builds query and sends proper request' do
+        list
+        url = "#{FinAppsCore::REST::Defaults::DEFAULTS[:host]}/v3/portfolios/#{portfolio_id}/consumers?page=2&" \
+        'requested=25&sort=-created_date'
+        expect(WebMock).to have_requested(:get, url)
+      end
+    end
+
+    context 'when invalid id is provided' do
+      let(:portfolio_id) { 'invalid_id' }
+      let(:params) { nil }
+
+      it { expect { list }.not_to raise_error }
+      it('results is nil') { expect(results).to be_nil }
+      it('error messages array is populated') do
+        expect(errors.first.downcase).to eq('resource not found')
+      end
+    end
+  end
+
+  describe '#create' do
+    let(:create) { subject.create(portfolio_id, params) }
+    let(:results) { create[RESULTS] }
+    let(:errors) { create[ERROR_MESSAGES] }
+
+    context 'when missing portfolio_id' do
+      let(:portfolio_id) { nil }
+      let(:params) { 'valid_id' }
+
+      it { expect { create }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when missing params' do
+      let(:portfolio_id) { 'valid_id' }
+      let(:params) { nil }
+
+      it { expect { create }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'for bulk subscribe' do
+      context 'when valid id and params are provided' do
+        let(:portfolio_id) { 'valid_id' }
+        let(:params) { %w[id1 id2 id3] }
+
+        it { expect { create }.not_to raise_error }
+        it('returns an array') { expect(create).to be_a(Array) }
+        it('results is nil') { expect(results).to be_nil }
+        it('returns no error messages') { expect(errors).to be_empty }
+        it('builds correct url') do
+          create
+          url = "#{FinAppsCore::REST::Defaults::DEFAULTS[:host]}/v3/portfolios/#{portfolio_id}/consumers"
+          expect(WebMock).to have_requested(:post, url)
+        end
+      end
+
+      context 'when invalid id and params are provided' do
+        let(:portfolio_id) { 'invalid_id' }
+        let(:params) { %w[id1 id2 id3] }
+
+        it { expect { create }.not_to raise_error }
+        it('results is nil') { expect(results).to be_nil }
+        it('error messages array is populated') do
+          # this will break when client is fixed to expect new array error response
+          expect(errors.first.downcase).to eq('the server responded with status 400')
+        end
+      end
+    end
+
+    context 'for single subscribe' do
+      context 'when valid ids are provided' do
+        let(:portfolio_id) { 'valid_id' }
+        let(:params) { portfolio_id }
+
+        it { expect { create }.not_to raise_error }
+        it('returns an array') { expect(create).to be_a(Array) }
+        it('results is nil') { expect(results).to be_nil }
+        it('returns no error messages') { expect(errors).to be_empty }
+        it('builds correct url') do
+          create
+          url = "#{FinAppsCore::REST::Defaults::DEFAULTS[:host]}/v3/portfolios/#{portfolio_id}/consumers/#{params}"
+          expect(WebMock).to have_requested(:post, url)
+        end
+      end
+
+      context 'when invalid ids are provided' do
+        let(:portfolio_id) { 'invalid_id' }
+        let(:params) { portfolio_id }
+
+        it { expect { create }.not_to raise_error }
+        it('results is nil') { expect(results).to be_nil }
+        it('error messages array is populated') do
+          expect(errors.first.downcase).to eq('consumer not eligible, no completed orders.')
+        end
+      end
+    end
+  end
+
+  describe '#destroy' do
+    let(:destroy) { subject.destroy(portfolio_id, consumer_id) }
+    let(:results) { destroy[RESULTS] }
+    let(:errors) { destroy[ERROR_MESSAGES] }
+
+    context 'when missing portfolio_id' do
+      let(:portfolio_id) { nil }
+      let(:consumer_id) { 'valid_id' }
+
+      it { expect { destroy }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when missing consumer_id' do
+      let(:portfolio_id) { 'valid_id' }
+      let(:consumer_id) { nil }
+
+      it { expect { destroy }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when valid ids are provided' do
+      let(:portfolio_id) { 'valid_id' }
+      let(:consumer_id) { portfolio_id }
+
+      it { expect { destroy }.not_to raise_error }
+      it('returns an array') { expect(destroy).to be_a(Array) }
+      it('results is nil') { expect(results).to be_nil }
+      it('returns no error messages') { expect(errors).to be_empty }
+    end
+
+    context 'when invalid ids are provided' do
+      let(:portfolio_id) { 'invalid_id' }
+      let(:consumer_id) { portfolio_id }
+
+      it { expect { destroy }.not_to raise_error }
+      it('results is nil') { expect(results).to be_nil }
+      it('error messages array is populated') do
+        expect(errors.first.downcase).to eq('resource not found')
+      end
+    end
+  end
+end