finapps 2.3.3 → 2.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b3837e4ad6513b4ede27e48ff7b674fe7cbce17
-  data.tar.gz: b8f1e7f1cf52de4cf611507c330ae6365f474309
+  metadata.gz: 466bc237a6a77b4f9021545c74a398c3665a18b3
+  data.tar.gz: 42e49b85f895de09e7892a59e0aad5320ffcd63c
 SHA512:
-  metadata.gz: c1cece3db388c511a7ade9210a19a003263b810db2bdcf5699752d41c74e55a3cd25317efddc272f0a29a90b9b72833a422e34d1c9bbd4aeccf3876c735d36f3
-  data.tar.gz: bf7d8267bf6622511325fa9c39ccd8cd02018480357362abd2a8d79f05c399d3247efedf8b684e4ba122dc1a6fb1eea88fd5592334b0bc40983ebc83ed1f5e31
+  metadata.gz: 9cd1afd63950ac89df8c4110494809b1816812c8a4191d410efc93fb9e0c8f0a562ca89b184118d00c8ecf0afe61a3ee41e5cc23861ae6295aa8467c5728640d
+  data.tar.gz: f37cadd33797e2c95e76ccfc628891e4560232ea304712b0ef26c393b410caab57b563dd6b81b8413d617c17c89c301ba735014c8881d004cab434f41b8e8adb

data/.rubocop.yml

@@ -1,5 +1,5 @@
 Rails:
-  Enabled: true
+  Enabled: false
 
 AllCops:
   DisplayCopNames: true

data/lib/finapps/rest/operators.rb

@@ -51,6 +51,21 @@ module FinApps
       def validates(params)
         params.key?(:password) && params[:password] && params.key?(:password_confirm) && params[:password_confirm]
       end
+
+      def build_filter(params)
+        filter = {}
+        filter.merge!(search_query(params[:searchTerm])) if params[:searchTerm]
+        filter.merge!(role_query(params[:role])) if params[:role]
+        filter
+      end
+
+      def search_query(term)
+        {"last_name": {"$regex": term, "$options": 'i'}}
+      end
+
+      def role_query(role)
+        role.is_a?(Array) ? {"role": {"$in": role.map(&:to_i)}} : {"role": role.to_i}
+      end
     end
   end
 end

data/lib/finapps/rest/orders.rb

@@ -48,6 +48,50 @@ module FinApps
         path = "#{end_point}/#{ERB::Util.url_encode(id)}/cancel"
         update nil, nil, path
       end
+
+      private
+
+      def build_filter(params)
+        filter = {}
+        filter.merge!(search_query(params[:searchTerm])) if params[:searchTerm]
+        filter.merge!(status_query(params[:status])) if params[:status]
+        filter.merge!(assignment_query(params[:assignment])) if params.key?(:assignment) # assignment can be nil
+        filter
+      end
+
+      def search_query(term)
+        {
+          "$or": [{
+            "public_id": {
+              "$regex": "^#{term}",
+              "$options": 'i'
+            }
+          }, {
+            "applicant.last_name": {
+              "$regex": term,
+              "$options": 'i'
+            }
+          }, {
+            "assignment.last_name": {
+              "$regex": term,
+              "$options": 'i'
+            }
+          }, {
+            "requestor.reference_no": {
+              "$regex": "^#{term}",
+              "$options": 'i'
+            }
+          }]
+        }
+      end
+
+      def status_query(status)
+        status.is_a?(Array) ? {"status": {"$in": status.map(&:to_i)}} : {"status": status.to_i}
+      end
+
+      def assignment_query(assignment)
+        {"assignment.operator_id": assignment}
+      end
     end
   end
 end

data/lib/finapps/utils/query_builder.rb

@@ -4,11 +4,19 @@ module FinApps
   module Utils
     module QueryBuilder
       def build_query_path(root_url, params)
-        page = params[:page] ? "page=#{params[:page]}" : ''
-        requested = params[:requested] ? "&requested=#{params[:requested]}" : ''
-        sort = params[:sort] ? "&sort=#{ERB::Util.url_encode(params[:sort])}" : ''
-        filter = params[:filter] ? "&filter=#{ERB::Util.url_encode(params[:filter])}" : ''
-        "#{root_url}?#{page}#{requested}#{sort}#{filter}"
+        filter_obj = build_filter(params)
+        page = "page=#{params[:page]}" if params[:page]
+        requested = "requested=#{params[:requested]}" if params[:requested]
+        sort = "sort=#{ERB::Util.url_encode(params[:sort])}" if params[:sort]
+        filter = "filter=#{ERB::Util.url_encode(filter_obj.to_json)}" if filter_obj && !filter_obj.empty?
+        query_join(root_url, [page, requested, sort, filter])
+      end
+
+      private
+
+      def query_join(root_url, params_array)
+        query_string = params_array.compact.join('&')
+        !query_string.empty? ? [root_url, query_string].join('?') : nil
       end
     end
   end

data/lib/finapps/version.rb

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

data/spec/rest/operators_spec.rb

@@ -7,16 +7,37 @@ RSpec.describe FinApps::REST::Operators, 'initialized with valid FinApps::Client
   subject(:operators) { FinApps::REST::Operators.new(client) }
 
   describe '#list' do
+    let(:list) { subject.list(params) }
+    let(:results) { list[0] }
+    let(:error_messages) { list[1] }
+
     context 'when missing params' do
-      # use defaults
-      let(:list) { subject.list }
-      let(:results) { list[0] }
-      let(:error_messages) { list[1] }
+      let(:params) { nil }
+      it { expect { list }.not_to raise_error }
+      it('performs a get and returns the response') { expect(results).to respond_to(:records) }
+      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) { {page: 2, sort: 'date_created', requested: 25, searchTerm: 'term', role: 2} }
 
       it { expect { list }.not_to raise_error }
       it('performs a get and returns the response') { expect(results).to respond_to(:records) }
       it('returns an array of records') { expect(results.records).to be_a(Array) }
       it('returns no error messages') { expect(error_messages).to be_empty }
+      it 'builds query and sends proper request' do
+        list
+        url = "#{FinAppsCore::REST::Defaults::DEFAULTS[:host]}/v2/operators?filter=%7B%22last_name%22:%7B%22$regex" \
+              '%22:%22term%22,%22$options%22:%22i%22%7D,%22role%22:2%7D&page=2&requested=25&sort=date_created'
+        expect(WebMock).to have_requested(:get, url)
+      end
     end
   end
 

data/spec/rest/orders_spec.rb

@@ -76,16 +76,24 @@ RSpec.describe FinApps::REST::Orders do
 
     context 'when including valid params' do
       subject { FinApps::REST::Orders.new(client).list(params) }
-      let(:params) { {page: 2, sort: 'status'} }
+      let(:params) do
+        {page: 2, sort: 'status', requested: 25, searchTerm: 'term', status: %w(1 7),
+         assignment: 'valid_operator'}
+      end
 
       it { expect { subject }.not_to raise_error }
       it('returns an array') { expect(subject).to be_a(Array) }
       it('performs a get and returns the response') { expect(subject[RESULTS]).to respond_to(:orders) }
       it('each order contains a consumer_id') { expect(subject[RESULTS].orders).to all(have_key('consumer_id')) }
       it('returns no error messages') { expect(subject[ERROR_MESSAGES]).to be_empty }
-      it 'sends proper request' do
+      it 'builds query and sends proper request' do
         subject
-        url = "#{FinAppsCore::REST::Defaults::DEFAULTS[:host]}/v2/orders?page=2&sort=status"
+        url = "#{FinAppsCore::REST::Defaults::DEFAULTS[:host]}/v2/orders?filter=%7B%22$or%22:%5B%7B%22public_id%22:" \
+              '%7B%22$regex%22:%22%5Eterm%22,%22$options%22:%22i%22%7D%7D,%7B%22applicant.last_name%22:%7B%22$regex' \
+              '%22:%22term%22,%22$options%22:%22i%22%7D%7D,%7B%22assignment.last_name%22:%7B%22$regex%22:%22term%22,' \
+              '%22$options%22:%22i%22%7D%7D,%7B%22requestor.reference_no%22:%7B%22$regex%22:%22%5Eterm%22,%22$options' \
+              '%22:%22i%22%7D%7D%5D,%22status%22:%7B%22$in%22:%5B1,7%5D%7D,%22assignment.operator_id%22:%22' \
+              'valid_operator%22%7D&page=2&requested=25&sort=status'
         expect(WebMock).to have_requested(:get, url)
       end
     end

data/spec/utils/query_builder_spec.rb

@@ -2,25 +2,32 @@
 
 class FakeClass
   include FinApps::Utils::QueryBuilder
+
+  def build_filter(p); end
 end
 
 RSpec.describe FinApps::Utils::QueryBuilder do
+  subject { FakeClass.new }
+
   describe '#build_query_path' do
-    subject { FakeClass.new }
     let(:end_point) { 'orders' }
 
     context 'with full params' do
-      let(:params) { {page: '1', requested: '20', sort: '-date', filter: '{"role": "1"}'} }
-      it 'returns correct string' do
-        correct_string = 'orders?page=1&requested=20&sort=-date&filter=%7B%22role%22%3A%20%221%22%7D'
+      let(:params) { {page: '1', requested: '20', sort: '-date', random: 'random'} }
+      it 'calls #build_filter and returns correct string' do
+        allow(subject).to receive(:build_filter) { {role: 2} }
+        expect(subject).to receive(:build_filter).with(params)
+        correct_string = 'orders?page=1&requested=20&sort=-date&filter=%7B%22role%22%3A2%7D'
         expect(subject.build_query_path(end_point, params)).to eq(correct_string)
       end
     end
 
-    context 'with partial params' do
-      let(:params) { {page: '1', filter: '{"role": "1"}'} }
-      it 'returns correct string' do
-        expect(subject.build_query_path(end_point, params)).to eq('orders?page=1&filter=%7B%22role%22%3A%20%221%22%7D')
+    context 'with no params' do
+      let(:params) { {} }
+      it 'returns returns' do
+        allow(subject).to receive(:build_filter) { {} }
+        expect(subject).to receive(:build_filter).with(params)
+        expect(subject.build_query_path(end_point, params)).to be_nil
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.3.5
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: finapps_core
@@ -315,34 +315,34 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: FinApps REST API ruby client.
 test_files:
-- spec/rest/operators_password_resets_spec.rb
-- spec/rest/products_spec.rb
-- spec/rest/statements_spec.rb
-- spec/rest/version_spec.rb
-- spec/rest/user_institutions_forms_spec.rb
-- spec/rest/consumers_spec.rb
-- spec/rest/orders_spec.rb
-- spec/rest/order_tokens_spec.rb
-- spec/rest/institutions_forms_spec.rb
-- spec/rest/operators_spec.rb
-- spec/rest/user_institutions_statuses_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helpers/client.rb
+- spec/utils/query_builder_spec.rb
+- spec/support/fake_api.rb
+- spec/rest/order_reports_spec.rb
 - spec/rest/client_spec.rb
 - spec/rest/user_institutions_spec.rb
-- spec/rest/consumer_institution_refreshes_spec.rb
-- spec/rest/password_resets_spec.rb
-- spec/rest/order_reports_spec.rb
-- spec/rest/institutions_spec.rb
+- spec/rest/consumers_spec.rb
 - spec/rest/order_statuses_spec.rb
-- spec/rest/order_refreshes_spec.rb
 - spec/rest/order_notifications_spec.rb
+- spec/rest/operators_password_resets_spec.rb
+- spec/rest/institutions_forms_spec.rb
+- spec/rest/operators_spec.rb
+- spec/rest/version_spec.rb
+- spec/rest/statements_spec.rb
 - spec/rest/order_assignments_spec.rb
+- spec/rest/order_refreshes_spec.rb
+- spec/rest/user_institutions_statuses_spec.rb
+- spec/rest/order_tokens_spec.rb
+- spec/rest/products_spec.rb
 - spec/rest/sessions_spec.rb
-- spec/support/fake_api.rb
-- spec/utils/query_builder_spec.rb
-- spec/spec_helpers/client.rb
-- spec/spec_helper.rb
+- spec/rest/password_resets_spec.rb
+- spec/rest/consumer_institution_refreshes_spec.rb
+- spec/rest/user_institutions_forms_spec.rb
+- spec/rest/institutions_spec.rb
+- spec/rest/orders_spec.rb