finapps 2.0.15 → 2.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2242125f25f1a4a899e074d02fcce073bfa609e2
-  data.tar.gz: c35d6ae1c4d2da1c9915a9d9b13b912949ce450a
+  metadata.gz: 7acc8269730e6c9379955eadb06949d765436767
+  data.tar.gz: 60954938368277bfd3d29b76ab001c67f71025d9
 SHA512:
-  metadata.gz: d6624a26b750c6f7d1c2271961210967bc60caddc75a12bd4f66e8dbef080c4d3ca68a21b6e98fd22bbd3834044ef4bd164cabf0352ec5be42a635dd64734769
-  data.tar.gz: 6c1504ecf7d72f1b11bf0a601c2bcba4a23185000cfd6e8500ac2581eb84e5f32477d85aed672b3aee5947d80500244189afd8ccfec58fcd1805a903a9fe3927
+  metadata.gz: eb7dae092bd33046c5f7f605e92eb4b6f454595a9a8089fbc1543308dafc78166e9fb3fb5c922efe828a38a624f9511cfc1bcb456266a24e3485174badb75740
+  data.tar.gz: fcb7e7fd5186a691e8948a67d874bbc090b99f34226a9c9bd7b360d8a3e4289581b8ab29d9693db817fcbcd6d3d771f9fa5bca223347193c7ac621309a0dc919

data/lib/finapps/rest/base_client.rb

@@ -39,7 +39,7 @@ module FinApps
         raise FinApps::MissingArgumentsError.new 'Missing argument: method.' if method.blank?
 
         response, error_messages = execute_request(method, params, path)
-        result = if response.blank?
+        result = if empty?(response)
                    nil
                  else
                    block_given? ? yield(response) : response.body
@@ -50,6 +50,10 @@ module FinApps
 
       private
 
+      def empty?(response)
+        response.blank? || (response.respond_to?(:body) && response.body.blank?)
+      end
+
       def execute_request(method, params, path)
         error_messages = []
         begin

data/lib/finapps/rest/resources.rb

@@ -21,14 +21,32 @@ module FinApps
         [results, error_messages]
       end
 
-      def show(id, path=nil)
+      def update(params={}, path=nil)
+        path = end_point if path.nil?
+        logger.debug "#{self.class.name}##{__method__} => path: #{path} params: #{params}"
+        results, error_messages = client.send_request(path, :put, params)
+        [results, error_messages]
+      end
+
+      def show(id=nil, path=nil)
+        raise MissingArgumentsError.new 'Missing argument: id.' if id.nil? && path.nil?
+
         path = "#{end_point}/:id".sub ':id', ERB::Util.url_encode(id) if path.nil?
         logger.debug "#{self.class.name}##{__method__} => path: #{path}"
         results, error_messages = client.send_request(path, :get)
         [results, error_messages]
       end
 
-      private
+      def destroy(id=nil, path=nil)
+        raise MissingArgumentsError.new 'Missing argument: id.' if id.nil? && path.nil?
+
+        path = "#{end_point}/:id".sub ':id', ERB::Util.url_encode(id) if path.nil?
+        logger.debug "#{self.class.name}##{__method__} => path: #{path}"
+        results, error_messages = client.send_request(path, :delete)
+        [results, error_messages]
+      end
+
+      protected
 
       def logger
         client.logger

data/lib/finapps/rest/users.rb

@@ -2,60 +2,32 @@
 module FinApps
   module REST
     class Users < FinApps::REST::Resources # :nodoc:
+      require 'erb'
+
       using ObjectExtensions
       using StringExtensions
 
-      END_POINTS = {
-        list:    nil,
-        create:  'users/new',
-        show:    'users/:public_id',
-        update:  'user',
-        destroy: 'users/:public_id'
-      }.freeze
-
       # @param [String] public_id
       # @return [FinApps::REST::User, Array<String>]
       def show(public_id)
         raise MissingArgumentsError.new 'Missing argument: public_id.' if public_id.blank?
-
-        end_point = END_POINTS[:show]
-        path = end_point.sub ':public_id', ERB::Util.url_encode(public_id)
-
-        logger.debug "##{__method__} => path: #{path}"
-
-        results, error_messages = client.send_request(path, :get)
-        [results, error_messages]
+        super public_id
       end
 
       # @param [Hash] params
       # @return [Array<String>]
-      def update(params)
+      def update(public_id, params)
+        raise MissingArgumentsError.new 'Missing argument: public_id.' if public_id.blank?
         raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
-        logger.debug "##{__method__} => params: #{params}"
-
-        end_point = END_POINTS[:update]
-        path = end_point
 
-        logger.debug "##{__method__} => path: #{path}"
-
-        results, error_messages = client.send_request(path, :put, params.compact)
-        [results, error_messages]
+        path = "#{end_point}/#{ERB::Util.url_encode(public_id)}#{'/password' if password_update?(params)}"
+        super params, path
       end
 
-      # @param [String] public_id
-      # @return [Array<String>]
-      def delete(public_id)
-        raise MissingArgumentsError.new 'Missing argument: public_id.' if public_id.blank?
-        logger.debug "##{__method__} => public_id: #{public_id}"
-
-        end_point = END_POINTS[:delete]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':public_id', ERB::Util.url_encode(public_id)
-        logger.debug "##{__method__} => path: #{path}"
+      private
 
-        results, error_messages = client.send_request(path, :delete)
-        [results, error_messages]
+      def password_update?(params)
+        params.key?(:password) && params.key?(:password_confirm)
       end
     end
   end

data/lib/finapps/version.rb

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

data/spec/rest/order_tokens_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe FinApps::REST::OrderTokens, 'initialized with valid FinApps::Clie
 
       it { expect { show }.not_to raise_error }
       it('results is nil') { expect(results).to be_nil }
-      it('error messages array is populated') { expect(error_messages.first).to eq('resource not found') }
+      it('error messages array is populated') { expect(error_messages.first.downcase).to eq('resource not found') }
     end
   end
 end

data/spec/rest/resources_spec.rb

@@ -21,11 +21,21 @@ RSpec.describe FinApps::REST::Resources do
 
   describe '#create' do
     context 'when valid params are provided' do
-      subject { FinApps::REST::Resources.new(client) }
-      it { expect { subject.create }.not_to raise_error }
-      it('returns an array') { expect(subject.create).to be_a(Array) }
-      it('performs a post and returns the response') { expect(subject.create[0]).to respond_to(:public_id) }
-      it('returns no error messages') { expect(subject.create[1]).to be_empty }
+      subject { FinApps::REST::Resources.new(client).create }
+      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
+  end
+
+  describe '#update' do
+    context 'when valid params are provided' do
+      subject { FinApps::REST::Resources.new(client).update }
+      it { expect { subject }.not_to raise_error }
+      it('returns an array') { expect(subject).to be_a(Array) }
+      it('performs a put 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
 
@@ -34,7 +44,17 @@ RSpec.describe FinApps::REST::Resources do
       subject { FinApps::REST::Resources.new(client).show(:id) }
       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('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 '#destroy' do
+    context 'when valid params are provided' do
+      subject { FinApps::REST::Resources.new(client).destroy(:id) }
+      it { expect { subject }.not_to raise_error }
+      it('returns an array') { expect(subject).to be_a(Array) }
+      it('performs a delete and returns an empty response') { expect(subject[0]).to be_nil }
       it('returns no error messages') { expect(subject[1]).to be_empty }
     end
   end

data/spec/rest/users_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+RSpec.describe FinApps::REST::Users, 'initialized with valid FinApps::Client object' do
+  missing_public_id = 'Missing argument: public_id.'
+  client = FinApps::REST::Client.new :company_identifier, :company_token
+
+  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
+
+    context 'for valid public_id' do
+      let(:show) { subject.show(:valid_public_id) }
+      let(:results) { show[0] }
+      let(:error_messages) { show[1] }
+
+      it { expect { show }.not_to raise_error }
+      it('results is a Hashie::Rash') { expect(results).to be_a(Hashie::Rash) }
+      it('performs a get and returns the response') { expect(results).to respond_to(:public_id) }
+      it('error_messages array is empty') { expect(error_messages).to eq([]) }
+    end
+
+    context 'for invalid token' do
+      let(:show) { subject.show(:invalid_public_id) }
+      let(:results) { show[0] }
+      let(:error_messages) { show[1] }
+
+      it { expect { show }.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
+
+  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
+
+    context 'when updating user details' do
+      context 'for valid public_id' do
+        let(:update) { subject.update(:valid_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 empty') { expect(error_messages).to eq([]) }
+      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
+      end
+    end
+
+    context 'when updating password' do
+      context 'for valid public_id' do
+        let(:update) { subject.update(:valid_public_id, password: 'Aa123456!', password_confirm: 'Aa123456!') }
+        let(:results) { update[0] }
+        let(:error_messages) { update[1] }
+
+        it { expect { update }.not_to raise_error }
+        it('results is a Hashie::Rash') { expect(results).to be_a(Hashie::Rash) }
+        it('the public_id is on the results') { expect(results).to respond_to(:public_id) }
+        it('the new token is on the results') { expect(results).to respond_to(:token) }
+        it('error_messages array is empty') { expect(error_messages).to eq([]) }
+      end
+
+      context 'for invalid public_id' do
+        let(:update) { subject.update(:invalid_public_id, password: 'Aa123456!', password_confirm: 'Aa123456!') }
+        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') { expect(error_messages.first.downcase).to eq('resource not found') }
+      end
+    end
+  end
+end

data/spec/support/fake_api.rb

@@ -6,14 +6,20 @@ class FakeApi < Sinatra::Base
   # resource
   post('/v2/resources') { json_response 201, 'resource.json' }
   get('/v2/resources/:id') { json_response 200, 'resource.json' }
+  put('/v2/resources') { json_response 201, 'resource.json' }
+  delete('/v2/resources/:id') { status 202 }
 
   # orders
-  post('/v2/orders/invalid_token') { json_response 404, 'order_token_invalid.json' }
   post('/v2/orders/valid_token') { json_response 200, 'order_token.json' }
+  post('/v2/orders/invalid_token') { json_response 404, 'resource_not_found.json' }
   get('/v2/orders/:id') { json_response 200, 'resource.json' }
 
   # users
-  get('/users/:id') { json_response 200, 'user.json' }
+  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/valid_public_id/password'){ json_response 200, 'user.json'}
+  put('/v2/users/invalid_public_id/password'){ json_response 404, 'resource_not_found.json' }
 
   # relevance
   get('/v2/relevance/ruleset/names') { json_response 200, 'relevance_ruleset_names.json' }

data/spec/support/fixtures/resource_not_found.json

@@ -0,0 +1,5 @@
+{
+  "messages": [
+    "Resource not found"
+  ]
+}

data/spec/support/fixtures/unauthorized.json

@@ -0,0 +1,5 @@
+{
+  "messages": [
+    "Invalid User Identifier or Credentials"
+  ]
+}

data/spec/support/fixtures/user.json

@@ -1,8 +1,9 @@
 {
-  "public_id":"83e6c55a-9883-40bb-45f9-fc70d70731c9",
-  "first_name":"Erich",
-  "last_name":"{\"phone_number\":\"3052224444\", \"first_name\":\"John\", \"last_name\":\"Smith\", \"savings_plan_id\":1}",
-  "email":"erich.1440775160085@example.com",
-  "postal_code":"00000",
-  "token":"XkI8MORAlR5m2DvF+QuSkrWGsVrBfZUI3mRToYzZ494="
+  "public_id": "8dc3bf36-571a-48cd-707a-2e9a9850c4ae",
+  "first_name": "John",
+  "last_name": "Smith",
+  "email": "j.smith@financialapps.com",
+  "memo": "",
+  "postal_code": "33021",
+  "token": "n4Q57JdnE2v1kbvFagLCZEhPG7t2mWQfvs4zWkDpGKg="
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 2.0.15
+  version: 2.0.16
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -280,13 +280,15 @@ files:
 - spec/rest/order_tokens_spec.rb
 - spec/rest/orders_spec.rb
 - spec/rest/resources_spec.rb
+- spec/rest/users_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_api.rb
 - spec/support/fixtures/error.json
 - spec/support/fixtures/order_token.json
-- spec/support/fixtures/order_token_invalid.json
 - spec/support/fixtures/relevance_ruleset_names.json
 - spec/support/fixtures/resource.json
+- spec/support/fixtures/resource_not_found.json
+- spec/support/fixtures/unauthorized.json
 - spec/support/fixtures/user.json
 homepage: https://github.com/finapps/ruby-client
 licenses:
@@ -331,5 +333,6 @@ test_files:
 - spec/rest/order_tokens_spec.rb
 - spec/rest/orders_spec.rb
 - spec/rest/resources_spec.rb
+- spec/rest/users_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_api.rb

data/spec/support/fixtures/order_token_invalid.json

@@ -1,5 +0,0 @@
-{
-  "messages": [
-    "resource not found"
-  ]
-}