finapps 2.0.16 → 2.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7acc8269730e6c9379955eadb06949d765436767
-  data.tar.gz: 60954938368277bfd3d29b76ab001c67f71025d9
+  metadata.gz: d92b2ccd2cbe3f2d7088938232d1c73f0c0c95b4
+  data.tar.gz: 5b0f6965de1b07f36ce1f0584e475a7a8e8d1461
 SHA512:
-  metadata.gz: eb7dae092bd33046c5f7f605e92eb4b6f454595a9a8089fbc1543308dafc78166e9fb3fb5c922efe828a38a624f9511cfc1bcb456266a24e3485174badb75740
-  data.tar.gz: fcb7e7fd5186a691e8948a67d874bbc090b99f34226a9c9bd7b360d8a3e4289581b8ab29d9693db817fcbcd6d3d771f9fa5bca223347193c7ac621309a0dc919
+  metadata.gz: 5a909e96ebb509f0f975b2892355343ba890d1cf85eaca4d0b368f01b3d7a8a6054521c0ad93327128e0484fc0a1eae2bed91f596c0c18f987c0d7ecdcd9bdd3
+  data.tar.gz: 6156ca6318427f8f0c8557182d8b965a58a7aedee84ba8c06c121f90adf4ba81d0c43972fd8ac846eca42c74356ea93b29e356216dd2dbe66e9c8af6b880984a

data/README.md

@@ -5,6 +5,7 @@ FinApps Ruby-Client
 [![Gem Version](https://badge.fury.io/rb/finapps.svg)](https://badge.fury.io/rb/finapps)
 [![Build Status](http://img.shields.io/travis/finapps/ruby-client.svg?style=flat-square)](https://travis-ci.org/finapps/ruby-client)
 [![Code Climate](https://codeclimate.com/github/finapps/ruby-client/badges/gpa.svg)](https://codeclimate.com/github/finapps/ruby-client)
+[![Test Coverage](https://codeclimate.com/github/finapps/ruby-client/badges/coverage.svg)](https://codeclimate.com/github/finapps/ruby-client/coverage)
 [![Dependency Status](https://gemnasium.com/badges/github.com/finapps/ruby-client.svg)](https://gemnasium.com/github.com/finapps/ruby-client)
 [![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://finapps.mit-license.org)
 

data/lib/finapps/rest/base_client.rb

@@ -38,7 +38,7 @@ module FinApps
         raise FinApps::MissingArgumentsError.new 'Missing argument: path.' if path.blank?
         raise FinApps::MissingArgumentsError.new 'Missing argument: method.' if method.blank?
 
-        response, error_messages = execute_request(method, params, path)
+        response, error_messages = execute_request(path, method, params)
         result = if empty?(response)
                    nil
                  else
@@ -54,10 +54,10 @@ module FinApps
         response.blank? || (response.respond_to?(:body) && response.body.blank?)
       end
 
-      def execute_request(method, params, path)
+      def execute_request(path, method, params)
         error_messages = []
         begin
-          response = execute_method method, params, path
+          response = execute_method path, method, params
         rescue FinApps::InvalidArgumentsError,
                FinApps::MissingArgumentsError,
                Faraday::Error::ConnectionFailed => error
@@ -86,7 +86,7 @@ module FinApps
         ['Unexpected error.']
       end
 
-      def execute_method(method, params, path)
+      def execute_method(path, method, params)
         case method
         when :get
           get(path)

data/lib/finapps/rest/client.rb

@@ -24,6 +24,10 @@ module FinApps
         @users ||= FinApps::REST::Users.new self
       end
 
+      def sessions
+        @sessions ||= FinApps::REST::Sessions.new self
+      end
+
       def order_tokens
         @order_tokens ||= FinApps::REST::OrderTokens.new self
       end

data/lib/finapps/rest/resources.rb

@@ -11,39 +11,37 @@ module FinApps
       def initialize(client)
         raise MissingArgumentsError.new 'Missing argument: client.' if client.nil?
         raise InvalidArgumentsError.new 'Invalid argument: client.' unless client.is_a?(FinApps::REST::Client)
+
         @client = client
       end
 
       def create(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, :post, params)
-        [results, error_messages]
+        request_with_body(path, :post, params)
       end
 
       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]
+        request_with_body(path, :put, params)
       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]
+        request_without_body(path, :get, id)
       end
 
       def destroy(id=nil, path=nil)
-        raise MissingArgumentsError.new 'Missing argument: id.' if id.nil? && path.nil?
+        request_without_body(path, :delete, id)
+      end
 
+      def request_without_body(path, method, id)
+        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]
+        request_with_body path, method, {}
+      end
+
+      def request_with_body(path, method, params)
+        path = end_point if path.nil?
+        logger.debug "#{self.class.name}##{__method__} => path: #{path} params: #{params}"
+
+        client.send_request path, method, params
       end
 
       protected

data/lib/finapps/rest/sessions.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module FinApps
+  module REST
+    class Sessions < FinApps::REST::Resources # :nodoc:
+      require 'erb'
+
+      using ObjectExtensions
+      using StringExtensions
+
+      # @param [Hash] params
+      # @return [Array<String>]
+      def create(params)
+        raise InvalidArgumentsError.new 'Invalid argument: params.' unless validates params
+
+        super params, 'login'
+      end
+
+      private
+
+      def validates(params)
+        params.key?(:email) && params[:email].present? && params.key?(:password) && params[:password].present?
+      end
+    end
+  end
+end

data/lib/finapps/version.rb

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

data/lib/finapps.rb

@@ -22,6 +22,7 @@ require 'finapps/rest/defaults'
 require 'finapps/rest/resources'
 
 require 'finapps/rest/users'
+require 'finapps/rest/sessions'
 require 'finapps/rest/order_tokens'
 require 'finapps/rest/orders'
 

data/spec/middleware/response/raise_error_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+RSpec.describe FinApps::Middleware::RaiseError do
+  let(:fake_app) { proc {|env| env } }
+  Env = Struct.new(:status, :response_headers, :body)
+
+  describe '#on_complete' do
+    subject { FinApps::Middleware::RaiseError.new(fake_app) }
+
+    context 'for succesful requests' do
+      let(:env) { Env.new(200) }
+      it { expect { subject.on_complete(env) }.not_to raise_error }
+    end
+    context 'for client errors' do
+      let(:env) { Env.new(401, {}, '{"messages":["Invalid User Identifier or Credentials"]}') }
+      error_message = 'the server responded with status 401'
+      it { expect { subject.on_complete(env) }.to raise_error(Faraday::Error::ClientError, error_message) }
+    end
+    context 'for connection failed error' do
+      let(:env) { Env.new(407) }
+      error_message = '407 "Proxy Authentication Required"'
+      it { expect { subject.on_complete(env) }.to raise_error(Faraday::Error::ConnectionFailed, error_message) }
+    end
+  end
+end

data/spec/rest/base_client_spec.rb

@@ -69,9 +69,8 @@ RSpec.describe FinApps::REST::BaseClient do
         subject { FinApps::REST::BaseClient.new(valid_tenant_options).send_request('client_error', :get) }
 
         it('result is null') { expect(subject[RESPONSE]).to be_nil }
-        it('error_messages is not null') { expect(subject[ERROR_MESSAGES]).not_to be_nil }
         it('error_messages is an array') { expect(subject[ERROR_MESSAGES]).to be_a(Array) }
-        it('error messages array contains elements') { expect(subject[ERROR_MESSAGES].length).to be > 0 }
+        it('error_messages gets populated'){expect(subject[ERROR_MESSAGES].first).to eq 'Password Minimum size is 8'}
       end
 
       context 'for server errors' do
@@ -97,4 +96,10 @@ RSpec.describe FinApps::REST::BaseClient do
       end
     end
   end
+
+  describe '#method_missing' do
+    context 'for unsupported methods' do
+      it { expect { subject.unsupported }.to raise_error(NoMethodError) }
+    end
+  end
 end

data/spec/rest/client_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe FinApps::REST::Client do
   context 'an instance of Client' do
     subject { FinApps::REST::Client.new(:company_identifier, :company_token) }
 
-    %i(users orders order_tokens).each do |method|
+    %i(users sessions orders order_tokens).each do |method|
       it "responds to #{method}" do
         expect(subject).to respond_to(method)
       end
@@ -23,6 +23,10 @@ RSpec.describe FinApps::REST::Client do
       it { expect(subject.users).to be_an_instance_of(FinApps::REST::Users) }
     end
 
+    describe '#sessions' do
+      it { expect(subject.sessions).to be_an_instance_of(FinApps::REST::Sessions) }
+    end
+
     describe '#order_tokens' do
       it { expect(subject.order_tokens).to be_an_instance_of(FinApps::REST::OrderTokens) }
     end
@@ -34,7 +38,7 @@ RSpec.describe FinApps::REST::Client do
     # [:users, :institutions, :user_institutions, :transactions, :categories,
     # :budget_models, :budget_calculation, :budgets, :cashflows,
     # :alert, :alert_definition, :alert_preferences, :alert_settings, :rule_sets]
-    %i(users orders order_tokens).each do |method|
+    %i(users sessions orders order_tokens).each do |method|
       it "memoizes the result of #{method}" do
         first = subject.send(method)
         second = subject.send(method)

data/spec/rest/sessions_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+require 'spec_helpers/client'
+
+RSpec.describe FinApps::REST::Sessions, 'initialized with valid FinApps::Client object' do
+  include SpecHelpers::Client
+
+  describe '#create' do
+    subject { FinApps::REST::Sessions.new(client) }
+    let(:create) { subject.create(credentials) }
+    let(:results) { create[0] }
+    let(:error_messages) { create[1] }
+
+    context 'when missing email or password' do
+      message = 'Invalid argument: params.'
+      it do
+        expect { subject.create(email: nil, password: 'password') }
+          .to raise_error(FinApps::InvalidArgumentsError, message)
+      end
+      it do
+        expect { subject.create(email: 'email', password: nil) }
+          .to raise_error(FinApps::InvalidArgumentsError, message)
+      end
+    end
+
+    context 'for invalid credentials' do
+      let(:credentials) { {email: 'email@domain.com', password: 'invalid_password'} }
+
+      it { expect { create }.not_to raise_error }
+      it('results is nil') { expect(results).to be_nil }
+      error_message = 'Invalid User Identifier or Credentials'
+      it('error_messages are populated') { expect(error_messages.first).to eq(error_message) }
+    end
+
+    context 'for valid credentials' do
+      let(:credentials) { {email: 'email@domain.com', password: 'valid_password'} }
+
+      it('results is a Hashie::Rash') { expect(results).to be_a(Hashie::Rash) }
+      it('token value is in the result') { expect(results).to respond_to(:token) }
+      it('error_messages is empty') { expect(error_messages).to be_empty }
+    end
+  end
+end

data/spec/rest/users_spec.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+require 'spec_helpers/client'
+
 RSpec.describe FinApps::REST::Users, 'initialized with valid FinApps::Client object' do
+  include SpecHelpers::Client
+
   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) }

data/spec/spec_helpers/client.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module SpecHelpers
+  module Client
+    def client
+      FinApps::REST::Client.new :tenant_id, :tenant_token
+    end
+  end
+end

data/spec/support/fake_api.rb

@@ -18,8 +18,19 @@ 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/valid_public_id/password'){ json_response 200, 'user.json'}
-  put('/v2/users/invalid_public_id/password'){ json_response 404, 'resource_not_found.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' }
+
+  # session
+  post('/v2/login') do
+    request.body.rewind
+    request_payload = JSON.parse request.body.read
+    if request_payload['password'] == 'valid_password'
+      json_response(200, 'user.json')
+    else
+      json_response(401, 'unauthorized.json')
+    end
+  end
 
   # relevance
   get('/v2/relevance/ruleset/names') { json_response 200, 'relevance_ruleset_names.json' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 2.0.16
+  version: 2.0.17
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -264,15 +264,17 @@ files:
 - lib/finapps/rest/order_tokens.rb
 - lib/finapps/rest/orders.rb
 - lib/finapps/rest/resources.rb
+- lib/finapps/rest/sessions.rb
 - lib/finapps/rest/users.rb
 - lib/finapps/utils/loggeable.rb
 - lib/finapps/version.rb
 - lib/tasks/releaser.rake
 - spec/core_extensions/hash/compact_spec.rb
 - spec/core_extensions/object/is_integer_spec.rb
-- spec/middleware/accept_json_spec.rb
-- spec/middleware/tenant_authentication_spec.rb
-- spec/middleware/user_agent_spec.rb
+- spec/middleware/request/accept_json_spec.rb
+- spec/middleware/request/tenant_authentication_spec.rb
+- spec/middleware/request/user_agent_spec.rb
+- spec/middleware/response/raise_error_spec.rb
 - spec/rest/base_client_spec.rb
 - spec/rest/client_spec.rb
 - spec/rest/configuration_spec.rb
@@ -280,8 +282,10 @@ files:
 - spec/rest/order_tokens_spec.rb
 - spec/rest/orders_spec.rb
 - spec/rest/resources_spec.rb
+- spec/rest/sessions_spec.rb
 - spec/rest/users_spec.rb
 - spec/spec_helper.rb
+- spec/spec_helpers/client.rb
 - spec/support/fake_api.rb
 - spec/support/fixtures/error.json
 - spec/support/fixtures/order_token.json
@@ -316,23 +320,26 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: FinApps REST API ruby client.
 test_files:
-- spec/core_extensions/hash/compact_spec.rb
-- spec/core_extensions/object/is_integer_spec.rb
-- spec/middleware/accept_json_spec.rb
-- spec/middleware/tenant_authentication_spec.rb
-- spec/middleware/user_agent_spec.rb
-- spec/rest/base_client_spec.rb
-- spec/rest/client_spec.rb
-- spec/rest/configuration_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_api.rb
+- spec/spec_helpers/client.rb
+- spec/middleware/request/user_agent_spec.rb
+- spec/middleware/request/tenant_authentication_spec.rb
+- spec/middleware/request/accept_json_spec.rb
+- spec/middleware/response/raise_error_spec.rb
 - spec/rest/credentials_spec.rb
-- spec/rest/order_tokens_spec.rb
-- spec/rest/orders_spec.rb
 - spec/rest/resources_spec.rb
+- spec/rest/sessions_spec.rb
+- spec/rest/client_spec.rb
+- spec/rest/orders_spec.rb
+- spec/rest/order_tokens_spec.rb
+- spec/rest/base_client_spec.rb
+- spec/rest/configuration_spec.rb
 - spec/rest/users_spec.rb
-- spec/spec_helper.rb
-- spec/support/fake_api.rb
+- spec/core_extensions/object/is_integer_spec.rb
+- spec/core_extensions/hash/compact_spec.rb