finapps 2.0.27 → 2.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15ae9c547ceaadc025c1b3f03d7c993d9f79f49e
-  data.tar.gz: 1bf245cf64d57451f652c1da3920521b473910cc
+  metadata.gz: 96e530944d9dd3ef2ad9fa275645777bd14f47e1
+  data.tar.gz: bafbeb5761ff48a077ac50a07b0f816bdafc9b70
 SHA512:
-  metadata.gz: 5d3221c7cc42c64a8ec61e4d822b413d04e0a302f252e564c7378ebdbd263e51ed97d0c18efb5fd10e81f68ec7a0c5fab981d3d66aa877c6b7900e69880cc593
-  data.tar.gz: 7c323b31dcaa4258b95f19fb1a175f20ed8c9b0e57ddf50240d9783f8df4c0431097ab86d3ad156398d50ba88fce896aad701cc786f5928e6ab791de40f905ac
+  metadata.gz: 38eb922890d8e99ff8b408f8e1fead1dc99ad74ac68408af4537803aa55641f95df3539823d01b7c54be191cb90b2eab643ea6e65ab9af814b02f78ecb1f9312
+  data.tar.gz: eaa2583d8a286ee234d717511aed8a18c574869658d0b936de30d680d5cc74e2e29ae6b60dacce9ec8f2c86a0b90c6a95920988ef8bffd258fb43981bd48b03f

data/lib/finapps/rest/order_reports.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module FinApps
+  module REST
+    class OrderReports < FinApps::REST::Resources # :nodoc:
+      using ObjectExtensions
+      using StringExtensions
+
+      def show(id, format)
+        raise MissingArgumentsError.new 'Missing argument: id.' if id.blank?
+        raise MissingArgumentsError.new 'Missing argument: format' if format.blank?
+        raise InvalidArgumentsError.new 'Invalid argument: format' unless accepted_format?(format)
+
+        path = "orders/#{ERB::Util.url_encode(id)}/report.#{ERB::Util.url_encode(format)}"
+        super nil, path
+      end
+
+      private
+
+      def accepted_format?(format)
+        [:json, :html, :pdf].include? format.to_sym
+      end
+    end
+  end
+end

data/lib/finapps/rest/orders.rb

@@ -10,18 +10,24 @@ module FinApps
         super
       end
 
-      def list(_params=nil)
-        # TODO: get the paramaters for the pagination
-        # GET /v2/list/orders/:page/:requested/:sort/:asc
-        # :page - page number requested
-        # :requested - number of results per page requested
-        # :sort - sort order
-        # options:
-        #     date - the date of the order
-        #     status - the status of the order
-        # :asc - sort order true for asc false for desc
-
-        super 'list/orders/1/10000/date/false'
+      def create(params)
+        raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
+        super params
+      end
+
+      # GET /v2/list/orders/:page/:requested/:sort/:asc
+      # :page - page number requested
+      # :requested - number of results per page requested
+      # :sort - sort order
+      #   options:
+      #     date - the date of the order
+      #     status - the status of the order
+      # :asc - sort order true for asc false for desc
+      def list(params=nil) # params hash with optional keys [:page, :requested, :sort, :asc]
+        return super 'list/orders/1/10000/date/false' if params.nil?
+        raise InvalidArgumentsError.new 'Invalid argument: params' unless params.is_a? Hash
+
+        super build_path(params)
       end
 
       def update(id, params)
@@ -35,6 +41,19 @@ module FinApps
 
         super params, path
       end
+
+      private
+
+      def build_path(p)
+        page = p[:page] || 1
+        requested = p[:requested] || 100
+        sort = p[:sort] || 'date'
+        asc = p[:asc] || false
+        end_point = 'list/orders'
+        path = end_point.dup
+        [page, requested, sort, asc].each_with_index {|a| path << "/#{ERB::Util.url_encode(a)}" }
+        path
+      end
     end
   end
 end

data/lib/finapps/rest/users.rb

@@ -22,6 +22,11 @@ module FinApps
         super params, path
       end
 
+      def destroy(public_id)
+        raise MissingArgumentsError.new 'Missing argument: public_id.' if public_id.blank?
+        super public_id
+      end
+
       private
 
       def password_update?(params)

data/lib/finapps/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module FinApps
-  VERSION = '2.0.27'
+  VERSION = '2.0.28'
 end

data/lib/finapps.rb

@@ -33,6 +33,7 @@ require 'finapps/rest/institutions'
 require 'finapps/rest/user_institutions_statuses'
 require 'finapps/rest/user_institutions'
 require 'finapps/rest/user_institutions_forms'
+require 'finapps/rest/order_reports'
 
 require 'finapps/rest/configuration'
 require 'finapps/rest/credentials'

data/spec/rest/order_reports_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+RSpec.describe FinApps::REST::OrderReports do
+  let(:client) { FinApps::REST::Client.new(:company_identifier, :company_token) }
+  describe '#show' do
+    context 'when missing id' do
+      subject { FinApps::REST::OrderReports.new(client).show(nil, :pdf) }
+      it { expect { subject }.to raise_error(FinApps::MissingArgumentsError) }
+    end
+
+    context 'when missing format' do
+      subject { FinApps::REST::OrderReports.new(client).show(:valid_id, nil) }
+      it { expect { subject }.to raise_error(FinApps::MissingArgumentsError) }
+    end
+
+    context 'when invalid format is provided' do
+      subject { FinApps::REST::OrderReports.new(client).show(:valid_id, :xml) }
+      it { expect { subject }.to raise_error(FinApps::InvalidArgumentsError) }
+    end
+
+    context 'when valid params are provided' do
+      subject { FinApps::REST::OrderReports.new(client).show(:valid_id, :json) }
+
+      it { expect { subject }.not_to raise_error }
+      it('performs a get and returns the response') { expect(subject[0]).to respond_to(:days_requested) }
+      it('returns no error messages') { expect(subject[1]).to be_empty }
+    end
+
+    context 'when invalid id is provided' do
+      subject { FinApps::REST::OrderReports.new(client).show(:invalid_id, :json) }
+
+      it { expect { subject }.not_to raise_error }
+      it('results is nil') { expect(subject[0]).to be_nil }
+      it('error messages array is populated') { expect(subject[1].first.downcase).to eq('resource not found') }
+    end
+  end
+end

data/spec/rest/orders_spec.rb

@@ -10,11 +10,37 @@ RSpec.describe FinApps::REST::Orders do
     context 'when valid params are provided' do
       subject { FinApps::REST::Orders.new(client).show(:id) }
 
+      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[0]).to respond_to(:public_id) }
+      it('returns no error messages') { expect(subject[1]).to be_empty }
+    end
+  end
+
+  describe '#create' do
+    context 'when missing params' do
+      subject { FinApps::REST::Orders.new(client).create(nil) }
+      it { expect { subject }.to raise_error(FinApps::MissingArgumentsError) }
+    end
+
+    context 'when valid params are provided' do
+      subject { FinApps::REST::Orders.new(client).create(valid_params) }
+      let(:valid_params) { {applicant: 'valid', institutions: 'valid', product: 'valid'} }
+
       it { expect { subject }.not_to raise_error }
       it('returns an array') { expect(subject).to be_a(Array) }
       it('performs a post and returns the response') { expect(subject[0]).to respond_to(:public_id) }
       it('returns no error messages') { expect(subject[1]).to be_empty }
     end
+
+    context 'when invalid params are provided' do
+      subject { FinApps::REST::Orders.new(client).create(invalid_params) }
+      let(:invalid_params) { {applicant: 'valid'} }
+
+      it { expect { subject }.not_to raise_error }
+      it('results is nil') { expect(subject[0]).to be_nil }
+      it('error messages array is populated') { expect(subject[1].first.downcase).to eq('invalid request body') }
+    end
   end
 
   describe '#list' do
@@ -28,6 +54,16 @@ RSpec.describe FinApps::REST::Orders do
       it('performs a get and returns the response') { expect(subject[0]).to respond_to(:orders) }
       it('returns no error messages') { expect(subject[1]).to be_empty }
     end
+
+    context 'when including partial params' do
+      subject { FinApps::REST::Orders.new(client).list(params) }
+      let(:params) { {page: 2, sort: 'status'} }
+
+      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[0]).to respond_to(:orders) }
+      it('returns no error messages') { expect(subject[1]).to be_empty }
+    end
   end
 
   describe '#update' do

data/spec/rest/users_spec.rb

@@ -3,12 +3,10 @@ require 'spec_helpers/client'
 
 RSpec.describe FinApps::REST::Users, 'initialized with valid FinApps::Client object' do
   include SpecHelpers::Client
-
+  subject(:users) { FinApps::REST::Users.new(client) }
   missing_public_id = 'Missing argument: public_id.'
 
   describe '#show' do
-    subject(:users) { FinApps::REST::Users.new(client) }
-
     context 'when missing public_id' do
       it { expect { subject.show(nil) }.to raise_error(FinApps::MissingArgumentsError, missing_public_id) }
     end
@@ -36,8 +34,6 @@ RSpec.describe FinApps::REST::Users, 'initialized with valid FinApps::Client obj
   end
 
   describe '#update' do
-    subject(:users) { FinApps::REST::Users.new(client) }
-
     context 'when missing public_id' do
       it { expect { subject.update(nil, {}) }.to raise_error(FinApps::MissingArgumentsError, missing_public_id) }
     end
@@ -54,7 +50,15 @@ RSpec.describe FinApps::REST::Users, 'initialized with valid FinApps::Client obj
       end
 
       context 'for invalid public_id' do
-        # no point testing this context unless this api bug is solved: https://github.com/finapps/api/issues/209
+        let(:update) { subject.update(:invalid_public_id, postal_code: '33021') }
+        let(:results) { update[0] }
+        let(:error_messages) { update[1] }
+
+        it { expect { update }.not_to raise_error }
+        it('results is nil') { expect(results).to be_nil }
+        it('error messages array is populated') do
+          expect(error_messages.first.downcase).to eq('invalid user id specified.')
+        end
       end
     end
 
@@ -81,5 +85,31 @@ RSpec.describe FinApps::REST::Users, 'initialized with valid FinApps::Client obj
         it('error messages array is populated') { expect(error_messages.first.downcase).to eq('resource not found') }
       end
     end
+
+    describe '#destroy' do
+      context 'when missing public_id' do
+        it { expect { subject.destroy(nil) }.to raise_error(FinApps::MissingArgumentsError, missing_public_id) }
+      end
+
+      context 'for valid public_id' do
+        let(:destroy) { subject.destroy(:valid_public_id) }
+        let(:results) { destroy[0] }
+        let(:error_messages) { destroy[1] }
+
+        it { expect { destroy }.not_to raise_error }
+        it('results is nil') { expect(results).to be_nil }
+        it('error_messages array is empty') { expect(error_messages).to eq([]) }
+      end
+
+      context 'for invalid token' do
+        let(:destroy) { subject.destroy(:invalid_public_id) }
+        let(:results) { destroy[0] }
+        let(:error_messages) { destroy[1] }
+
+        it { expect { destroy }.not_to raise_error }
+        it('results is nil') { expect(results).to be_nil }
+        it('error messages array is populated') { expect(error_messages.first.downcase).to eq('resource not found') }
+      end
+    end
   end
 end

data/spec/support/fake_api.rb

@@ -15,6 +15,8 @@ class FakeApi < Sinatra::Base
   post('/v2/orders/invalid_token') { json_response 404, 'resource_not_found.json' }
   get('/v2/orders/:id') { json_response 200, 'resource.json' }
   get('/v2/list/orders/:page/:requested/:sort/:asc') { json_response 200, 'orders.json' }
+  get('/v2/orders/valid_id/report.:format') { json_response 200, 'order_report.json' }
+  get('/v2/orders/invalid_id/report.:format') { json_response 404, 'resource_not_found.json' }
   put('/v2/orders/invalid_id') { json_response 404, 'resource_not_found.json' }
   put('/v2/orders/valid_id') do
     request.body.rewind
@@ -25,6 +27,15 @@ class FakeApi < Sinatra::Base
       json_response 400, 'invalid_request_body.json'
     end
   end
+  post('/v2/orders') do
+    request.body.rewind
+    request_payload = JSON.parse request.body.read
+    if %w(applicant institutions product).all? {|s| request_payload.key? s }
+      json_response 200, 'order_token.json'
+    else
+      json_response 400, 'invalid_request_body.json'
+    end
+  end
 
   # institutions
   get('/v2/institutions/site/valid_site_id/form') { json_response 200, 'institution_login_form.json' }
@@ -53,8 +64,11 @@ class FakeApi < Sinatra::Base
   get('/v2/users/valid_public_id') { json_response 200, 'user.json' }
   get('/v2/users/invalid_public_id') { json_response 404, 'resource_not_found.json' }
   put('/v2/users/valid_public_id') { status 204 }
+  put('/v2/users/invalid_public_id') { json_response 400, 'invalid_user_id.json' }
   put('/v2/users/valid_public_id/password') { json_response 200, 'user.json' }
   put('/v2/users/invalid_public_id/password') { json_response 404, 'resource_not_found.json' }
+  delete('/v2/users/valid_public_id') { status 204 }
+  delete('/v2/users/invalid_public_id') { json_response 404, 'resource_not_found.json' }
 
   # session
   post('/v2/login') do

data/spec/support/fixtures/invalid_user_id.json

@@ -0,0 +1,5 @@
+{
+  "messages": [
+    "invalid user id specified."
+  ]
+}

data/spec/support/fixtures/order_report.json

@@ -0,0 +1,31 @@
+{
+  "currency": "USD",
+  "days_requested": 90,
+  "applicant": {
+    "first_name": "Bobby",
+    "last_name": "P",
+    "ssn": "",
+    "dob": "",
+    "email": "bobby@bobby.com",
+    "mobile_phone": "",
+    "work_phone": "",
+    "home_phone": "",
+    "address": "",
+    "address2": "",
+    "city": "",
+    "state": "",
+    "zip": "33146",
+    "employer": {
+      "name": "",
+      "position": "",
+      "length_months": 0,
+      "pay_cycle": "",
+      "type": "",
+      "start_date": "0001-01-01T00:00:00Z",
+      "end_date": "0001-01-01T00:00:00Z",
+      "pay_amt_gross": 0,
+      "pay_amt_net": 0
+    }
+  }
+  //  shortened version
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 2.0.27
+  version: 2.0.28
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-15 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -266,6 +266,7 @@ files:
 - lib/finapps/rest/defaults.rb
 - lib/finapps/rest/institutions.rb
 - lib/finapps/rest/institutions_forms.rb
+- lib/finapps/rest/order_reports.rb
 - lib/finapps/rest/order_tokens.rb
 - lib/finapps/rest/orders.rb
 - lib/finapps/rest/resources.rb
@@ -290,6 +291,7 @@ files:
 - spec/rest/credentials_spec.rb
 - spec/rest/institutions_forms_spec.rb
 - spec/rest/institutions_spec.rb
+- spec/rest/order_reports_spec.rb
 - spec/rest/order_tokens_spec.rb
 - spec/rest/orders_spec.rb
 - spec/rest/resources_spec.rb
@@ -307,7 +309,9 @@ files:
 - spec/support/fixtures/institutions_search_list.json
 - spec/support/fixtures/invalid_institution_id.json
 - spec/support/fixtures/invalid_request_body.json
+- spec/support/fixtures/invalid_user_id.json
 - spec/support/fixtures/invalid_user_institution_id.json
+- spec/support/fixtures/order_report.json
 - spec/support/fixtures/order_token.json
 - spec/support/fixtures/orders.json
 - spec/support/fixtures/relevance_ruleset_names.json
@@ -369,6 +373,7 @@ test_files:
 - spec/rest/users_spec.rb
 - spec/rest/base_client_spec.rb
 - spec/rest/user_institutions_forms_spec.rb
+- spec/rest/order_reports_spec.rb
 - spec/rest/user_institutions_statuses_spec.rb
 - spec/rest/user_institutions_spec.rb
 - spec/rest/client_spec.rb