finapps 4.0.6 → 4.0.7

data/spec/rest/portfolios_spec.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require 'spec_helpers/client'
+
+RSpec.describe FinApps::REST::Portfolios do
+  include SpecHelpers::Client
+  subject { FinApps::REST::Portfolios.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/portfolios?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(:product)
+      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
+
+  describe '#create' do
+    let(:create) { subject.create(params) }
+    let(:results) { create[RESULTS] }
+    let(:errors) { create[ERROR_MESSAGES] }
+
+    context 'when missing params' do
+      let(:params) { nil }
+
+      it { expect { create }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when valid params are provided' do
+      let(:params) { { name: 'Account Checks', description: 'Some Check Stuff', product: 'valid' } }
+
+      it { expect { create }.not_to raise_error(FinAppsCore::MissingArgumentsError) }
+      it('returns an array') { expect(create).to be_a(Array) }
+      it('performs a get and returns the response') do
+        expect(results).to respond_to(:_id)
+        expect(results).to respond_to(:product)
+      end
+      it('returns no error messages') { expect(errors).to be_empty }
+    end
+
+    context 'when invalid params are provided' do
+      let(:params) { { name: 'Account Checks', description: 'Some Check Stuff', product: 'invalid' } }
+
+      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('invalid request body')
+      end
+    end
+  end
+
+  describe '#update' do
+    let(:update) { subject.update(id, params) }
+    let(:results) { update[RESULTS] }
+    let(:errors) { update[ERROR_MESSAGES] }
+
+    context 'when missing id' do
+      let(:id) { nil }
+      let(:params) { { fake: 'data' } }
+
+      it { expect { update }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when missing params' do
+      let(:id) { 'valid_id' }
+      let(:params) { nil }
+
+      it { expect { update }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when invalid id or params are provided' do
+      let(:id) { 'invalid_id' }
+      let(:params) { { fake: 'data' } }
+
+      it { expect { update }.not_to raise_error(FinAppsCore::MissingArgumentsError) }
+      it('results is nil') { expect(results).to be_nil }
+      it('error messages array is populated') { expect(errors.first.downcase).to eq('resource not found') }
+    end
+
+    context 'when valid id and params are provided' do
+      let(:id) { 'valid_id' }
+      let(:params) { { fake: 'data' } }
+
+      it { expect { update }.not_to raise_error(FinAppsCore::MissingArgumentsError) }
+      it('returns an array') { expect(update).to be_a(Array) }
+      it('performs a get and returns the response') do
+        expect(results).to respond_to(:_id)
+        expect(results).to respond_to(:product)
+      end
+      it('returns no error messages') { expect(errors).to be_empty }
+    end
+  end
+
+  describe '#destroy' do
+    let(:destroy) { subject.destroy(id) }
+    let(:results) { destroy[RESULTS] }
+    let(:errors) { destroy[ERROR_MESSAGES] }
+
+    context 'when missing id' do
+      let(:id) { nil }
+
+      it { expect { destroy }.to raise_error(FinAppsCore::MissingArgumentsError) }
+    end
+
+    context 'when invalid id is provided' do
+      let(:id) { 'invalid_id' }
+
+      it { expect { destroy }.not_to raise_error }
+      it('results is nil') { expect(results).to be_nil }
+      it('error messages array is populated') { expect(errors.first.downcase).to eq('resource not found') }
+    end
+
+    context 'when valid id is provided' do
+      let(:id) { 'valid_id' }
+
+      it { expect { destroy }.not_to raise_error }
+      it('results is nil') { expect(results).to be_nil }
+      it('error messages array is empty') { expect(errors).to be_empty }
+    end
+  end
+end

data/spec/support/fake_api.rb

@@ -180,6 +180,60 @@ class FakeApi < Sinatra::Base
   # products
   get('/v3/products') { json_response 200, 'products.json' }
 
+  # portfolios
+  get('/v3/portfolios') { json_response 200, 'portfolios.json' }
+  get('/v3/portfolios/valid_id') { json_response 200, 'portfolio.json' }
+  get('/v3/portfolios/invalid_id') { json_response 404, 'resource_not_found.json' }
+  post('/v3/portfolios') do
+    request.body.rewind
+    request_payload = JSON.parse request.body.read
+    if request_payload['product'] == 'invalid'
+      json_response(400, 'invalid_request_body.json')
+    else
+      json_response(200, 'portfolio.json')
+    end
+  end
+  put('/v3/portfolios/valid_id') { json_response 200, 'portfolio.json' }
+  put('/v3/portfolios/invalid_id') { json_response 404, 'resource_not_found.json' }
+  delete('/v3/portfolios/valid_id') { status 204 }
+  delete('/v3/portfolios/invalid_id') { json_response 404, 'resource_not_found.json' }
+
+  # alert definitions
+  get('/v3/portfolio/alerts/definitions') { json_response 200, 'alert_definitions.json' }
+  get('/v3/portfolio/alerts/definitions/valid_id') { json_response 200, 'alert_definition.json' }
+  get('/v3/portfolio/alerts/definitions/invalid_id') { json_response 404, 'resource_not_found.json' }
+
+  # alert occurrences
+  get('/v3/portfolio/alerts/occurrences') { json_response 200, 'alert_occurrences.json' }
+
+  # portfolios alerts
+  get('/v3/portfolios/valid_id/alerts') { json_response 200, 'portfolios_alerts.json' }
+  get('/v3/portfolios/invalid_id/alerts') { json_response 404, 'resource_not_found.json' }
+  put('/v3/portfolios/valid_id/alerts/valid_id') { status 204 }
+  put('/v3/portfolios/invalid_id/alerts/invalid_id') { json_response 404, 'resource_not_found.json' }
+  delete('/v3/portfolios/valid_id/alerts/valid_id') { status 204 }
+  delete('/v3/portfolios/invalid_id/alerts/invalid_id') { json_response 404, 'resource_not_found.json' }
+
+  # portfolios consumers
+  get('/v3/portfolios/valid_id/consumers') { json_response 200, 'portfolios_consumers.json' }
+  get('/v3/portfolios/invalid_id/consumers') { json_response 404, 'resource_not_found.json' }
+  post('/v3/portfolios/valid_id/consumers') { status 204 }
+  post('/v3/portfolios/invalid_id/consumers') { json_response 400, 'multiple_consumer_subscribe_error.json' }
+  post('/v3/portfolios/valid_id/consumers/valid_id') { status 204 }
+  post('/v3/portfolios/invalid_id/consumers/invalid_id') { json_response 400, 'single_consumer_subscribe_error.json' }
+  delete('/v3/portfolios/valid_id/consumers/valid_id') { status 204 }
+  delete('/v3/portfolios/invalid_id/consumers/invalid_id') { json_response 404, 'resource_not_found.json' }
+
+  # portfolios available consumers
+  get('/v3/portfolios/:id/consumers/available') { json_response 200, 'portfolios_available_consumers.json' }
+
+  # consumers portfolios
+  get('/v3/consumers/valid_id/portfolios') { json_response 200, 'portfolios.json' }
+  get('/v3/consumers/invalid_id/portfolios') { json_response 404, 'resource_not_found.json' }
+
+  # portfolio reports
+  get('/v3/portfolio/reports') { json_response 200, 'portfolio_reports.json' }
+
   # relevance
   get('/v3/relevance/ruleset/names') { json_response 200, 'relevance_ruleset_names.json' }
 

data/spec/support/fixtures/alert_definition.json

@@ -0,0 +1,17 @@
+{
+  "_id": "7d48e535-6405-4c9c-adc2-be94e19cf94e",
+  "name": "Low Balance Alert",
+  "rule_name": "min_balance",
+  "description": "Checks a consumer's account balance",
+  "params": [
+    {
+      "name": "minimum",
+      "display": "Minimum Balance",
+      "type": "float",
+      "message": "Account balance is too low.",
+      "value": 200.00
+    }
+  ],
+  "created_date": "2018-09-18T17:23:36.272Z",
+  "modified_date": "2018-09-18T17:23:36.272Z"
+}

data/spec/support/fixtures/alert_definitions.json

@@ -0,0 +1,24 @@
+{
+  "total_records": 1,
+  "page": 1,
+  "total_pages": 1,
+  "records": [
+    {
+      "_id": "7d48e535-6405-4c9c-adc2-be94e19cf94e",
+      "name": "Low Balance Alert",
+      "rule_name": "min_balance",
+      "description": "Checks a consumer's account balance",
+      "params": [
+        {
+          "name": "minimum",
+          "display": "Minimum Balance",
+          "type": "float",
+          "message": "Account balance is too low.",
+          "value": 200.00
+        }
+      ],
+      "created_date": "2018-09-18T17:23:36.272Z",
+      "modified_date": "2018-09-18T17:23:36.272Z"
+    }
+  ]
+}

data/spec/support/fixtures/alert_occurrences.json

@@ -0,0 +1,32 @@
+{
+  "total_records": 1,
+  "page": 1,
+  "total_pages": 1,
+  "records": [
+    {
+      "_id": "8847b703-dfd5-4bb8-8c06-35b64d6a6a54",
+      "portfolio": {
+        "_id": "c75283f7-0dea-4bf0-b5a2-4a648bdc5d95",
+        "name": "Account Checks",
+        "description": "Checks accounts for various thresholds.",
+        "enabled": true,
+        "product": "PROD3",
+        "created_date": "2018-09-18T17:38:10.353Z",
+        "modified_date": "2018-09-18T17:38:10.353Z"
+      },
+      "consumer": {
+        "first_name": "test",
+        "last_name": "consumer",
+        "email": "testconsumer@finapps.com",
+        "memo": "test memo",
+        "postal_code": "33032"
+      },
+      "alert_id": "7d48e535-6405-4c9c-adc2-be94e19cf94e",
+      "alert_name": "Low Balance Alert",
+      "results": [
+        {}
+      ],
+      "date": "2018-09-18T17:38:10.353Z"
+    }
+  ]
+}

data/spec/support/fixtures/multiple_consumer_subscribe_error.json

@@ -0,0 +1,7 @@
+[
+  {"consumer_id": "a031137a-4c4b-4b8e-5be5-3747a7953e83", "message": "Consumer not eligible, no completed orders."},
+  {"consumer_id": "b2fbc913-c7c0-452a-5a10-09e4b34ab6a9", "message": "Consumer not found."},
+  {"consumer_id": "b2fbc913-c7c0-452a-5a10-09e4b34ab6a1", "message": "Application error"},
+  {"consumer_id": "c63fa6e8-0494-4ee1-5e96-c26fa31fc62a", "message": "Consumer not processed."},
+  {"consumer_id": "b5d03e74-92c9-462f-455f-827a77b8082d", "message": "Consumer not processed."}
+]

data/spec/support/fixtures/portfolio.json

@@ -0,0 +1,9 @@
+{
+  "_id": "c75283f7-0dea-4bf0-b5a2-4a648bdc5d95",
+  "name": "Account Checks",
+  "description": "Checks accounts for various thresholds.",
+  "enabled": true,
+  "product": "PROD3",
+  "created_date": "2018-09-18T17:38:10.353Z",
+  "modified_date": "2018-09-18T17:38:10.353Z"
+}

data/spec/support/fixtures/portfolio_reports.json

@@ -0,0 +1,38 @@
+{
+  "total_records": 1,
+  "page": 1,
+  "total_pages": 1,
+  "records": [
+    {
+      "_id": "56aac2ff-d746-4095-aaca-3b71caf3b6cb",
+      "portfolio": {
+        "_id": "c75283f7-0dea-4bf0-b5a2-4a648bdc5d95",
+        "name": "Account Checks",
+        "description": "Checks accounts for various thresholds.",
+        "enabled": true,
+        "product": "PROD3",
+        "created_date": "2018-09-18T17:38:10.353Z",
+        "modified_date": "2018-09-18T17:38:10.353Z"
+      },
+      "consumer": {
+        "first_name": "test",
+        "last_name": "consumer",
+        "email": "testconsumer@finapps.com",
+        "memo": "test memo",
+        "postal_code": "33032"
+      },
+      "occurrences": [
+        {
+          "_id": "429bca0a-e557-43af-a3d0-777a09e903c0",
+          "alert_id": "7d48e535-6405-4c9c-adc2-be94e19cf94e",
+          "alert_name": "Low Balance Alert",
+          "results": [
+            {}
+          ],
+          "date": "2018-09-18T18:16:35.962Z"
+        }
+      ],
+      "date": "2018-09-18T18:16:35.962Z"
+    }
+  ]
+}

data/spec/support/fixtures/portfolios.json

@@ -0,0 +1,16 @@
+{
+  "total_records": 1,
+  "page": 1,
+  "total_pages": 1,
+  "records": [
+    {
+      "_id": "c75283f7-0dea-4bf0-b5a2-4a648bdc5d95",
+      "name": "Account Checks",
+      "description": "Checks accounts for various thresholds.",
+      "enabled": true,
+      "product": "PROD3",
+      "created_date": "2018-09-18T17:38:10.353Z",
+      "modified_date": "2018-09-18T17:38:10.353Z"
+    }
+  ]
+}

data/spec/support/fixtures/portfolios_alerts.json

@@ -0,0 +1,19 @@
+[
+  {
+    "_id": "7d48e535-6405-4c9c-adc2-be94e19cf94e",
+    "name": "Low Balance Alert",
+    "rule_name": "min_balance",
+    "description": "Checks a consumer's account balance",
+    "params": [
+      {
+        "name": "minimum",
+        "display": "Minimum Balance",
+        "type": "float",
+        "message": "Account balance is too low.",
+        "value": 200.00
+      }
+    ],
+    "created_date": "2018-09-18T17:23:36.272Z",
+    "modified_date": "2018-09-18T17:23:36.272Z"
+  }
+]

data/spec/support/fixtures/portfolios_available_consumers.json

@@ -0,0 +1,20 @@
+{
+  "total_records": 1,
+  "page": 1,
+  "total_pages": 1,
+  "records": [
+    {
+      "public_id": "b242cc06-2ca7-4158-6197-7f7af08f1b41",
+      "email": "testconsumer@finapps.com",
+      "first_name": "Ed",
+      "last_name": "Smith",
+      "memo": "",
+      "tenant_id": "49fb918d-7e71-44dd-7378-58f19606df2a",
+      "language": 1,
+      "currency": 1,
+      "date_modified": "2018-09-24T22:05:57.607-04:00",
+      "date_created": "2018-09-24T22:05:57.607-04:00",
+      "postal_code": ""
+    }
+  ]
+}

data/spec/support/fixtures/portfolios_consumers.json

@@ -0,0 +1,14 @@
+{
+  "page": 1,
+  "total_pages": 1,
+  "total_records": 1,
+  "records": [
+    {
+      "first_name": "test",
+      "last_name": "consumer",
+      "email": "testconsumer@finapps.com",
+      "memo": "test memo",
+      "postal_code": "33032"
+    }
+  ]
+}