finapps 5.0.24 → 5.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f21200338d07c1ab7882266ee53bb695bcd2214fd54c3dd8bd1e4f54f07003fd
-  data.tar.gz: 95168dfe1ade82536cd5ccb0a967a451cfabc6c3323796955e97f821c81c03ac
+  metadata.gz: 4ce0fc688800cfa247a62642d55c679edbe52a0a10556e359bf290b8f202351a
+  data.tar.gz: 0b5a307b87e1b704c8fa684a98f6fcb804538d3ac6326a08ac8285f462f23556
 SHA512:
-  metadata.gz: bd3183fe7bad50f52717109c80b14766a642d895d8d3fc30bce7171428324cb372258b31d5d70f14fe0f492875109b6b415dbf2008d6fe3c05e59e93e98ee2b3
-  data.tar.gz: c3a257358611b37562c7d34559bd69b574fdd590a7576c82cb8fa569b298bc2b907bee86a447c052f15c59480c74df81663e033c9833601be018f196fac387c2
+  metadata.gz: 3bbddba45806a7df005d72934aff45b43a3f574bf054e63622e2e7acc39ec06bd210742cd5dc8b9684cb9d179e8b4e882cb04fa9d1d278bea81dd002f4dd89f9
+  data.tar.gz: 2d8ac6a59586af1c7eaa3d7e3b8bcf78b7fcaca9ea7d440e07c639d7e8cc728439579eb45ff0cc78a399349b00cf6f8f4655cdc7d1834c82b95886881ab515d3

data/lib/finapps/rest/consumers.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+require_relative '../utils/query_builder'
+
 module FinApps
   module REST
     class Consumers < FinAppsCore::REST::Resources # :nodoc:
+      include FinApps::Utils::QueryBuilder
       # @param [String] public_id
       # @return [FinApps::REST::User, Array<String>]
       def create(params)
@@ -10,6 +13,13 @@ module FinApps
         super params
       end
 
+      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(public_id)
         not_blank(public_id, :public_id)
         super public_id
@@ -36,6 +46,20 @@ module FinApps
       def password_update?(params)
         params.key?(:password) && params.key?(:password_confirm)
       end
+
+      def build_filter(params)
+        search_query(params[:searchTerm]) if params[:searchTerm]
+      end
+
+      def search_query(term)
+        {
+          "$or": [
+            { "email": term },
+            { "first_name": term },
+            { "last_name": term }
+          ]
+        }
+      end
     end
   end
 end

data/lib/finapps/version.rb

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

data/spec/rest/consumers_spec.rb

@@ -41,6 +41,55 @@ RSpec.describe FinApps::REST::Consumers,
     end
   end
 
+  describe '#list' do
+    let(:list) { subject.list(params) }
+    let(:results) { list[0] }
+    let(:error_messages) { list[1] }
+
+    context 'when missing params' do
+      let(:params) { nil }
+      it { expect { list }.to_not raise_error }
+      it('performs a get and returns the response') do
+        expect(results).to have_key(:records)
+      end
+      it('returns an array of records') { expect(results[:records]).to be_a(Array) }
+      it('returns no error messages') { expect(error_messages).to be_empty }
+    end
+
+    context 'when invalid params are provided' do
+      let(:params) { ['invalid array'] }
+
+      it { expect { list }.to raise_error(FinAppsCore::InvalidArgumentsError) }
+    end
+
+    context 'when including valid params' do
+      let(:params) do
+        {
+          page: 2,
+          sort: 'date_created',
+          requested: 25,
+          searchTerm: 'term'
+        }
+      end
+
+      it { expect { list }.to_not raise_error }
+      it('returns an array') { expect(list).to be_a(Array) }
+      it('performs a get and returns the response') do
+        expect(results).to have_key(:records)
+      end
+      it('returns no error messages') do
+        expect(error_messages).to be_empty
+      end
+      it 'builds query and sends proper request' do
+        list
+        url = "#{versioned_api_path}/consumers?filter=%7B%22$or%22:%5B%7B%22email%22:%22term%22%7D," \
+            '%7B%22first_name%22:%22term%22%7D,%7B%22last_name%22:%22term%22%7D%5D%7D&page=2&requested=25' \
+            '&sort=date_created'
+        expect(WebMock).to have_requested(:get, url)
+      end
+    end
+  end
+
   describe '#show' do
     context 'when missing public_id' do
       it do

data/spec/support/fake_api.rb

@@ -190,6 +190,9 @@ class FakeApi < Sinatra::Base
   end
 
   # consumers
+  get("/#{version}/consumers") do
+    json_response 200, 'users.json'
+  end
   get("/#{version}/consumers/valid_public_id") do
     json_response 200, 'user.json'
   end

data/spec/support/fixtures/users.json

@@ -0,0 +1,18 @@
+{
+  "total_records": 1,
+  "page": 1,
+  "total_pages": 1,
+  "records": [
+    {
+      "public_id": "b090a422-b62f-4210-7526-f9513df0c3a5",
+      "email": "test.1578406657576@postman.com",
+      "first_name": "API",
+      "last_name": "Test",
+      "memo": "memo goes here",
+      "tenant_id": "988a0c8f-8a17-4bfd-6ac5-9df8ba91c095",
+      "date_modified": "2020-01-07T14:17:37.643Z",
+      "date_created": "2020-01-07T14:17:37.643Z",
+      "postal_code": "33136"
+    }
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 5.0.24
+  version: 5.0.25
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-30 00:00:00.000000000 Z
+date: 2020-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -418,6 +418,7 @@ files:
 - spec/support/fixtures/tenant_settings.json
 - spec/support/fixtures/unauthorized.json
 - spec/support/fixtures/user.json
+- spec/support/fixtures/users.json
 - spec/support/fixtures/verix/metadata.json
 - spec/support/fixtures/verix/record/create.json
 - spec/support/fixtures/verix/record/list.json