finapps 4.0.6 → 4.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1e6ff1a8379127a67c120835e11aa5d02b4a250341583e6bb31d340b9eb6527
-  data.tar.gz: a0599c41a38248aaa2180a005cc6020666280e1b92137744d3143691fa39c1e9
+  metadata.gz: d3374db10baa1952267135d60010f5a68566349af848c02675b56f5690ae73fd
+  data.tar.gz: 9bdd765359d184a02c2d52a55f2a270c7ca1a3060ef0633bb50c2034c4f1a45e
 SHA512:
-  metadata.gz: a728f579cc44d56586cb0fd05e4949c38305791687dd6e9e231021477809cab9f5896f2e67974c82a6460f6d9f66b7a6b5ab5c235980a0a0c8fb4a6c0828ea95
-  data.tar.gz: 6a4721575df2270662974814db05af130ed69038ce6acfcccbd9841b47bbbba787d05b5d15ec603277e3adf81614a8b89939e8e4a7388aa772dcfe52e5443458
+  metadata.gz: a4bfa0fd0777d1f3c28537a13cf16f0ff4d57a3a849406fc7b51ddc76a3afe0e24f72632bf5c5e2393c932bf12d2fc12798eb1b6940a439a24b207cc8899f6f1
+  data.tar.gz: fd8d2d0168f5c559d3eae6b0f1a5411f18c500e2f43ffb8be7370af406fb680a65703aa9e1be8457d39bb07914541ccb649675990433bc541b2418aeacf89803

data/.travis.yml

@@ -5,7 +5,7 @@ rvm:
 before_install:
   - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
   - gem update --system
-  - gem install bundler
+  - gem install bundler -v "~>1.0"
 script:
   - bundle exec rspec
 notifications:

data/lib/finapps.rb

@@ -28,6 +28,14 @@ require 'finapps/rest/order_refreshes'
 require 'finapps/rest/statements'
 require 'finapps/rest/tenant_settings'
 require 'finapps/rest/tenant_app_settings'
+require 'finapps/rest/portfolios'
+require 'finapps/rest/alert_definitions'
+require 'finapps/rest/alert_occurrences'
+require 'finapps/rest/portfolios_available_consumers'
+require 'finapps/rest/portfolios_alerts'
+require 'finapps/rest/portfolios_consumers'
+require 'finapps/rest/consumers_portfolios'
+require 'finapps/rest/portfolio_reports'
 
 require 'finapps/utils/query_builder'
 require 'finapps/version' unless defined?(FinApps::VERSION)

data/lib/finapps/rest/alert_definitions.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class AlertDefinitions < FinAppsCore::REST::Resources
+      include FinApps::Utils::QueryBuilder
+      END_POINT = 'portfolio/alerts/definitions'
+
+      def list(params = nil)
+        return super END_POINT if params.nil?
+        raise FinAppsCore::InvalidArgumentsError, 'Invalid argument: params' unless params.is_a? Hash
+
+        super build_query_path(END_POINT, params)
+      end
+
+      def show(id)
+        not_blank(id, :id)
+        path = "#{END_POINT}/#{ERB::Util.url_encode(id)}"
+
+        super nil, path
+      end
+    end
+  end
+end

data/lib/finapps/rest/alert_occurrences.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class AlertOccurrences < FinAppsCore::REST::Resources
+      include FinApps::Utils::QueryBuilder
+      END_POINT = 'portfolio/alerts/occurrences'
+
+      def list(params = nil)
+        return super END_POINT if params.nil?
+        raise FinAppsCore::InvalidArgumentsError, 'Invalid argument: params' unless params.is_a? Hash
+
+        super build_query_path(END_POINT, params)
+      end
+
+      private
+
+      def build_filter(params)
+        filter = {}
+        filter[:"portfolio.id"] = params[:portfolio_id] if params[:portfolio_id]
+        filter
+      end
+    end
+  end
+end

data/lib/finapps/rest/client.rb

@@ -7,6 +7,9 @@ module FinApps
   module REST
     class Client < FinAppsCore::REST::BaseClient # :nodoc:
       RESOURCES = %i[
+        alert_definitions
+        alert_occurrences
+        consumers_portfolios
         institutions
         institutions_forms
         orders
@@ -20,6 +23,11 @@ module FinApps
         operators_password_resets
         password_resets
         products
+        portfolios
+        portfolios_alerts
+        portfolios_available_consumers
+        portfolios_consumers
+        portfolio_reports
         sessions
         statements
         consumers

data/lib/finapps/rest/consumers_portfolios.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class ConsumersPortfolios < FinAppsCore::REST::Resources
+      include FinApps::Utils::QueryBuilder
+
+      def list(id, params = nil)
+        not_blank(id)
+
+        path = "consumers/#{ERB::Util.url_encode(id)}/portfolios"
+        return super path if params.nil?
+
+        raise FinAppsCore::InvalidArgumentsError, 'Invalid argument: params' unless params.is_a? Hash
+
+        super build_query_path(path, params)
+      end
+    end
+  end
+end

data/lib/finapps/rest/portfolio_reports.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class PortfolioReports < FinAppsCore::REST::Resources
+      include FinApps::Utils::QueryBuilder
+
+      def list(params = nil)
+        path = 'portfolio/reports'
+
+        return super path if params.nil?
+        raise FinAppsCore::InvalidArgumentsError, 'Invalid argument: params' unless params.is_a? Hash
+
+        super build_query_path(path, params)
+      end
+    end
+  end
+end

data/lib/finapps/rest/portfolios.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class Portfolios < FinAppsCore::REST::Resources
+      include FinApps::Utils::QueryBuilder
+
+      def list(params = nil)
+        return super if params.nil?
+        raise FinAppsCore::InvalidArgumentsError, 'Invalid argument: params' unless params.is_a? Hash
+
+        super build_query_path(end_point, params)
+      end
+
+      def show(id)
+        not_blank(id, :id)
+        super
+      end
+
+      def create(params)
+        not_blank(params, :params)
+        super params
+      end
+
+      def update(id, params)
+        not_blank(id, :id)
+        not_blank(params, :params)
+
+        path = "#{end_point}/#{ERB::Util.url_encode(id)}"
+
+        super params, path
+      end
+
+      def destroy(id)
+        not_blank(id, :id)
+
+        super
+      end
+
+      # need to populate build_filter method
+    end
+  end
+end

data/lib/finapps/rest/portfolios_alerts.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class PortfoliosAlerts < FinAppsCore::REST::Resources
+      def list(portfolio_id)
+        not_blank(portfolio_id, :portfolio_id)
+
+        super build_path(portfolio_id)
+      end
+
+      def create(portfolio_id, alert_id, params = nil)
+        not_blank(portfolio_id, :portfolio_id)
+        not_blank(alert_id, :alert_id)
+
+        update params, build_path(portfolio_id, alert_id)
+      end
+
+      def destroy(portfolio_id, alert_id)
+        not_blank(portfolio_id, :portfolio_id)
+        not_blank(alert_id, :alert_id)
+
+        super nil, build_path(portfolio_id, alert_id)
+      end
+
+      private
+
+      def build_path(portfolio_id, alert_id = nil)
+        alert_path = alert_id ? "alerts/#{ERB::Util.url_encode(alert_id)}" : 'alerts'
+        "portfolios/#{ERB::Util.url_encode(portfolio_id)}/" + alert_path
+      end
+    end
+  end
+end

data/lib/finapps/rest/portfolios_available_consumers.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class PortfoliosAvailableConsumers < FinAppsCore::REST::Resources
+      include FinApps::Utils::QueryBuilder
+
+      def list(portfolio_id, params = nil)
+        not_blank(portfolio_id, :portfolio_id)
+
+        path = "portfolios/#{ERB::Util.url_encode(portfolio_id)}/consumers/available"
+        return super path if params.nil?
+
+        raise FinAppsCore::InvalidArgumentsError, 'Invalid argument: params' unless params.is_a? Hash
+
+        super build_query_path(path, params)
+      end
+    end
+  end
+end

data/lib/finapps/rest/portfolios_consumers.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module FinApps
+  module REST
+    class PortfoliosConsumers < FinAppsCore::REST::Resources
+      include FinApps::Utils::QueryBuilder
+
+      def list(portfolio_id, params = nil)
+        not_blank(portfolio_id, :portfolio_id)
+
+        path = build_path(portfolio_id)
+        return super path if params.nil?
+
+        raise FinAppsCore::InvalidArgumentsError, 'Invalid argument: params' unless params.is_a? Hash
+
+        super build_query_path(path, params)
+      end
+
+      def create(portfolio_id, params)
+        not_blank(portfolio_id, :portfolio_id)
+        not_blank(params, :params)
+
+        return super nil, build_path(portfolio_id, params) if params.is_a?(String) # Single Consumer Subscribe
+
+        # Array Consumer Subscribe
+        super params, build_path(portfolio_id)
+      end
+
+      def destroy(portfolio_id, consumer_id)
+        not_blank(portfolio_id, :portfolio_id)
+        not_blank(consumer_id, :consumer_id)
+
+        # Single Consumer Unsubscribe Only
+        super nil, build_path(portfolio_id, consumer_id)
+      end
+
+      private
+
+      def build_path(portfolio_id, consumer_id = nil)
+        consumer_path = consumer_id ? "consumers/#{ERB::Util.url_encode(consumer_id)}" : 'consumers'
+        "portfolios/#{ERB::Util.url_encode(portfolio_id)}/" + consumer_path
+      end
+    end
+  end
+end

data/lib/finapps/utils/query_builder.rb

@@ -18,6 +18,11 @@ module FinApps
         query_string = params_array.compact.join('&')
         !query_string.empty? ? [root_url, query_string].join('?') : nil
       end
+
+      def build_filter(_params)
+        # stub, to be overwritten by classes that include this module
+        {}
+      end
     end
   end
 end

data/lib/finapps/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinApps
-  VERSION = '4.0.7'
+  VERSION = '4.0.8'
 end

data/spec/rest/alert_definitions_spec.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+
+RSpec.describe FinApps::REST::AlertDefinitions do
+  include SpecHelpers::Client
+  subject { FinApps::REST::AlertDefinitions.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/alerts/definitions?page=2&requested=25&" \
+        'sort=-created_date'
+        expect(WebMock).to have_requested(:get, url)
+      end
+    end
+  end
+
+  describe '#show' do
+    let(:show) { subject.show(id) }
+    let(:results) { show[RESULTS] }
+    let(:errors) { show[ERROR_MESSAGES] }
+
+    context 'when missing params' do
+      let(:id) { nil }
+
+      it { expect { show }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when valid id is provided' do
+      let(:id) { 'valid_id' }
+
+      it { expect { show }.not_to raise_error(FinAppsCore::MissingArgumentsError) }
+      it('returns an array') { expect(show).to be_a(Array) }
+      it('performs a get and returns the response') do
+        expect(results).to respond_to(:_id)
+        expect(results).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 { show }.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

data/spec/rest/alert_occurrences_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+
+RSpec.describe FinApps::REST::AlertOccurrences do
+  include SpecHelpers::Client
+  subject { FinApps::REST::AlertOccurrences.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, portfolio_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 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/alerts/occurrences?" \
+        'filter=%7B%22portfolio.id%22:%22valid_id%22%7D&page=2&requested=25&sort=-created_date'
+        expect(WebMock).to have_requested(:get, url)
+      end
+    end
+  end
+end