finapps 0.22.4.pre → 1.0.0

data/lib/finapps/rest/transactions.rb

@@ -7,37 +7,49 @@ module FinApps
       # @transaction_id [String]
       # # @return [Hash, Array<String>]
       def show(transaction_id)
+        logger.debug "##{__method__.to_s} => Started"
+
         end_point = Defaults::END_POINTS[:transactions_show]
         logger.debug "##{__method__.to_s} => end_point: #{end_point}"
 
         path = end_point.sub ':transaction_id', ERB::Util.url_encode(transaction_id)
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        transaction, error_messages = @client.send(path, :get)
+        transaction, error_messages =  @client.send_request(path, :get)
+
+        logger.debug "##{__method__.to_s} => Completed"
         return transaction, error_messages
       end
 
       # @param [Hash] params
       # @return [Array<Hash>, Array<String>]
       def search(params={})
+        logger.debug "##{__method__.to_s} => Started"
+
         path = Defaults::END_POINTS[:transactions_list]
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        transactions, error_messages = @client.send(path, :post, params.compact)
+        transactions, error_messages = @client.send_request(path, :post, params.compact)
+
+        logger.debug "##{__method__.to_s} => Completed"
         return transactions, error_messages
       end
 
       # @param [Hash] params
       # @return [Array<Hash>, Array<String>]
       def update(params={})
+        logger.debug "##{__method__.to_s} => Started"
+
         path = Defaults::END_POINTS[:transactions_update]
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        _, error_messages = @client.send(path, :put, params.compact)
+        _, error_messages = @client.send_request(path, :put, params.compact)
+
+        logger.debug "##{__method__.to_s} => Completed"
         error_messages
       end
 
     end
 
   end
-end
+end

data/lib/finapps/rest/user_institutions.rb

@@ -7,15 +7,19 @@ module FinApps
       include FinApps::REST::Defaults
 
       def list
+        logger.debug "##{__method__.to_s} => Started"
+
         path = Defaults::END_POINTS[:user_institutions_list]
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        user_institutions, error_messages = @client.send(path, :get)
+        user_institutions, error_messages = @client.send_request(path, :get)
 
+        logger.debug "##{__method__.to_s} => Completed"
         return user_institutions, error_messages
       end
 
       def add(site_id, parameters)
+        logger.debug "##{__method__.to_s} => Started"
 
         raise MissingArgumentsError.new 'Missing argument: site_id.' if site_id.blank?
         logger.debug "##{__method__.to_s} => site_id: #{site_id}"
@@ -29,12 +33,14 @@ module FinApps
         path = end_point.sub ':site_id', ERB::Util.url_encode(site_id)
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        user_institution, error_messages = @client.send(path, :post, :parameters => parameters)
+        user_institution, error_messages = @client.send_request(path, :post, :parameters => parameters)
 
+        logger.debug "##{__method__.to_s} => Completed"
         return user_institution, error_messages
       end
 
       def show(user_institution_id)
+        logger.debug "##{__method__.to_s} => Started"
 
         raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
         logger.debug "##{__method__.to_s} => user_institution_id: #{user_institution_id}"
@@ -45,12 +51,15 @@ module FinApps
         path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        user_institution, error_messages = @client.send(path, :get)
+        user_institution, error_messages = @client.send_request(path, :get)
 
+        logger.debug "##{__method__.to_s} => Completed"
         return user_institution, error_messages
       end
 
       def form(user_institution_id)
+        logger.debug "##{__method__.to_s} => Started"
+
         raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
         logger.debug "##{__method__.to_s} => user_institution_id: #{user_institution_id}"
 
@@ -60,12 +69,15 @@ module FinApps
         path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        user_institution, error_messages = @client.send(path, :get)
+        user_institution, error_messages = @client.send_request(path, :get)
 
+        logger.debug "##{__method__.to_s} => Completed"
         return user_institution, error_messages
       end
 
       def status(user_institution_id)
+        logger.debug "##{__method__.to_s} => Started"
+
         raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
         logger.debug "##{__method__.to_s} => user_institution_id: #{user_institution_id}"
 
@@ -75,12 +87,15 @@ module FinApps
         path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        user_institution, error_messages = @client.send(path, :get)
+        user_institution, error_messages = @client.send_request(path, :get)
 
+        logger.debug "##{__method__.to_s} => Completed"
         return user_institution, error_messages
       end
 
       def mfa(user_institution_id, parameters)
+        logger.debug "##{__method__.to_s} => Started"
+
         raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
         logger.debug "##{__method__.to_s} => user_institution_id: #{user_institution_id}"
 
@@ -93,12 +108,15 @@ module FinApps
         path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        user_institution, error_messages = @client.send(path, :put, :parameters => parameters)
+        user_institution, error_messages = @client.send_request(path, :put, :parameters => parameters)
 
+        logger.debug "##{__method__.to_s} => Completed"
         return user_institution, error_messages
       end
 
       def update(user_institution_id, parameters)
+        logger.debug "##{__method__.to_s} => Started"
+
         raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
         logger.debug "##{__method__.to_s} => user_institution_id: #{user_institution_id}"
 
@@ -111,22 +129,28 @@ module FinApps
         path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        user_institution, error_messages = @client.send(path, :put, :parameters => parameters)
+        user_institution, error_messages = @client.send_request(path, :put, :parameters => parameters)
 
+        logger.debug "##{__method__.to_s} => Completed"
         return user_institution, error_messages
       end
 
       def refresh
+        logger.debug "##{__method__.to_s} => Started"
+
         path = Defaults::END_POINTS[:user_institutions_refresh]
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        user_institutions, error_messages = @client.send(path, :get)
+        user_institutions, error_messages = @client.send_request(path, :get)
 
+        logger.debug "##{__method__.to_s} => Completed"
         return user_institutions, error_messages
       end
 
       # @return [Hash, Array<String>]
       def delete(user_institution_id)
+        logger.debug "##{__method__.to_s} => Started"
+
         raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
         logger.debug "##{__method__.to_s} => user_institution_id: #{user_institution_id.inspect}"
 
@@ -136,12 +160,13 @@ module FinApps
         path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        _, error_messages = @client.send(path, :delete)
+        _, error_messages = @client.send_request(path, :delete)
 
+        logger.debug "##{__method__.to_s} => Completed"
         error_messages
       end
 
     end
 
   end
-end
+end

data/lib/finapps/rest/users.rb

@@ -10,37 +10,44 @@ module FinApps
       # @param [Hash] params
       # @return [FinApps::REST::User, Array<String>]
       def create(params = {})
+        logger.debug "##{__method__.to_s} => Started"
+
         raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
         logger.debug "##{__method__.to_s} => params: #{skip_sensitive_data params}"
 
         end_point = Defaults::END_POINTS[:users_create]
         logger.debug "##{__method__.to_s} => end_point: #{end_point}"
 
-        user, error_messages = @client.send(end_point, :post, params) { |r| User.new(r.body) }
+        user, error_messages = @client.send_request(end_point, :post, params) { |r| User.new(r.body) }
+        logger.debug "##{__method__.to_s} => Completed"
 
         return user, error_messages
       end
 
       def update(params = {})
-        raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
+        logger.debug "##{__method__.to_s} => Started"
+
         logger.debug "##{__method__.to_s} => params: #{skip_sensitive_data params}"
 
         path = Defaults::END_POINTS[:users_update]
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        _, error_messages = @client.send(path, :put, params.compact)
+        _, error_messages = @client.send_request(path, :put, params.compact)
 
+        logger.debug "##{__method__.to_s} => Completed"
         error_messages
       end
 
       def update_password(params = {})
-        raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
+        logger.debug "##{__method__.to_s} => Started"
+
         logger.debug "##{__method__.to_s} => params: #{skip_sensitive_data params}"
 
         path = Defaults::END_POINTS[:users_update_password]
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        user, error_messages = @client.send(path, :put, params.compact) { |r| User.new(r.body) }
+        user, error_messages = @client.send_request(path, :put, params.compact) { |r| User.new(r.body) }
+        logger.debug "##{__method__.to_s} => Completed"
 
         return user, error_messages
       end
@@ -48,30 +55,16 @@ module FinApps
       # @param [Hash] params
       # @return [FinApps::REST::User, Array<String>]
       def login(params = {})
+        logger.debug "##{__method__.to_s} => Started"
+
         raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
         logger.debug "##{__method__.to_s} => params: #{skip_sensitive_data params}"
 
         end_point = Defaults::END_POINTS[:users_login]
         logger.debug "##{__method__.to_s} => end_point: #{end_point}"
 
-        user, error_messages = @client.send(end_point, :post, params) { |r| User.new(r.body) }
-
-        return user, error_messages
-      end
-
-      # @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?
-        logger.debug "##{__method__.to_s} => public_id: #{public_id}"
-
-        end_point = Defaults::END_POINTS[:users_show]
-        logger.debug "##{__method__.to_s} => end_point: #{end_point}"
-
-        path = end_point.sub ':public_id', ERB::Util.url_encode(public_id)
-        logger.debug "##{__method__.to_s} => path: #{path}"
-
-        user, error_messages = @client.send(path, :get) { |r| User.new(r.body) }
+        user, error_messages = @client.send_request(end_point, :post, params) { |r| User.new(r.body) }
+        logger.debug "##{__method__.to_s} => Completed"
 
         return user, error_messages
       end
@@ -79,6 +72,8 @@ module FinApps
       # @param [String] public_id
       # @return [Array<String>]
       def delete(public_id)
+        logger.debug "##{__method__.to_s} => Started"
+
         raise MissingArgumentsError.new 'Missing argument: public_id.' if public_id.blank?
         logger.debug "##{__method__.to_s} => public_id: #{public_id}"
 
@@ -88,7 +83,8 @@ module FinApps
         path = end_point.sub ':public_id', ERB::Util.url_encode(public_id)
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        _, error_messages = @client.send(path, :delete)
+        _, error_messages = @client.send_request(path, :delete)
+        logger.debug "##{__method__.to_s} => Completed"
 
         error_messages
       end

data/lib/finapps/utils/logging.rb

@@ -2,14 +2,14 @@ module FinApps
   module Logging
 
     SEVERITY_LABEL = %w(DEBUG INFO WARN ERROR FATAL UNKNOWN)
-    PROTECTED_KEYS = %w(login password password_confirm password1 token)
+    PROTECTED_KEYS = %w(login login1 password password1 password_confirm token)
     FORMAT = "\033[%sm[%s#%d] %5s -- %s: %s\033[0m\n"
     FORMAT_TAG = "\033[%sm[%s#%d] %5s -- %s: %s %s\033[0m\n"
     SEVERITY_COLOR_MAP = {:debug => '0', :info => '32', :warn => '33', :error => '31', :fatal => '31', :unknown => '0;37'}
 
 
     class << self;
-      attr_accessor :tag;
+      attr_accessor :tag, :level;
     end
 
     def logger=(logger)
@@ -23,21 +23,21 @@ module FinApps
         require 'logger' unless defined?(::Logger)
         ::Logger.new(STDOUT).tap do |log|
           log.progname = "#{self.class.to_s}"
+          log.level = Logging.level if Logging.level.present?
           log.formatter = proc do |severity, time, progname, msg|
             Logging.tag.present? ?
                 FORMAT_TAG % [severity_to_color(severity), format_datetime(time), $$, severity, progname, Logging.tag.to_s, msg2str(msg)] :
                 FORMAT % [severity_to_color(severity), format_datetime(time), $$, severity, progname, msg2str(msg)]
+
           end
         end
       end
 
     end
 
-    def set_up_logger_level(logger_level)
-      unless logger_level.blank? || logger.level == logger_level
-        logger.info "##{__method__.to_s} => Setting logger level to #{SEVERITY_LABEL[logger_level]}"
-        logger.level = logger_level
-      end
+    def logger_config(config)
+      Logging.tag= config[:logger_tag] if config[:logger_tag].present?
+      Logging.level = config[:log_level] if config[:log_level].present?
     end
 
     # noinspection SpellCheckingInspection

data/lib/finapps/version.rb

@@ -1,3 +1,3 @@
 module FinApps
-  VERSION = '0.22.4.pre'
+  VERSION = '1.0.0'
 end

data/spec/middleware/api_token_spec.rb

@@ -0,0 +1,32 @@
+RSpec.describe FinApps::Middleware::ApiToken do
+
+  describe '#call' do
+
+    fake_app = Proc.new { |env| env }
+    valid_credentials = {:company_identifier => 'id', :company_token => 'token'}
+
+    context 'when company_identifier is NOT provided' do
+      let(:api_token) { FinApps::Middleware::ApiToken.new fake_app, valid_credentials.select { |x| x!= :company_identifier } }
+      it { expect { api_token.call({}) }.to raise_error(FinApps::REST::MissingArgumentsError) }
+    end
+
+    context 'when company_token is NOT provided' do
+      let(:api_token) { FinApps::Middleware::ApiToken.new fake_app, valid_credentials.select { |x| x!= :company_token } }
+      it { expect { api_token.call({}) }.to raise_error(FinApps::REST::MissingArgumentsError) }
+    end
+
+    context 'when company credentials were provided' do
+
+      let(:api_token) { FinApps::Middleware::ApiToken.new fake_app, valid_credentials }
+      let(:expected_header_value) { "#{valid_credentials[:company_identifier]}=#{valid_credentials[:company_token]}" }
+      subject(:call) { api_token.call({:request_headers => {}}) }
+
+      it { expect { call }.not_to raise_error }
+      it 'should generate the X-FinApps-Token header' do
+        expect(call[:request_headers]['X-FinApps-Token']).to eq(expected_header_value)
+      end
+    end
+
+  end
+end
+

data/spec/rest/client_spec.rb

@@ -1,91 +1,123 @@
-require 'rspec'
-require 'finapps'
+RSpec.describe FinApps::REST::Client do
 
-module FinApps
+  describe '#new' do
 
-  describe FinApps::REST::Client do
+    context 'when company_identifier is NOT provided' do
+      it { expect { FinApps::REST::Client.new nil, :company_token }.to raise_error(FinApps::REST::MissingArgumentsError) }
+    end
 
-    before do
-      @client = FinApps::REST::Client.new :company_identifier, :company_token
+    context 'when company_token is NOT provided' do
+      it { expect { FinApps::REST::Client.new :company_identifier, nil }.to raise_error(FinApps::REST::MissingArgumentsError) }
     end
 
-    it 'responds to send' do
-      expect(@client).to respond_to(:send)
+    context 'when company_identifier is not string or symbol' do
+      it { expect { FinApps::REST::Client.new 1, :company_token }.to raise_error(FinApps::REST::InvalidArgumentsError) }
     end
 
-    it 'responds to user_credentials!' do
-      expect(@client).to respond_to(:user_credentials!)
+    context 'when company_token is not string or symbol' do
+      it { expect { FinApps::REST::Client.new :company_identifier, 1 }.to raise_error(FinApps::REST::InvalidArgumentsError) }
     end
 
-    it 'responds to public api methods' do
-      [:alert, :alert_definition, :alert_settings, :alert_preferences,
-       :budgets, :budget_calculation, :budget_models, :cashflows,
-       :categories, :institutions, :transactions,
-       :user_institutions, :users,
-       :rule_sets].each do |method|
-        expect(@client).to respond_to(method)
-      end
+    context 'when options are not provided' do
+      it { expect { FinApps::REST::Client.new :company_identifier, :company_token }.not_to raise_error }
     end
 
-    describe '#new' do
-      context 'when company credentials are NOT provided' do
-        it 'should raise a MissingArgumentsError exception' do
-          expect { FinApps::REST::Client.new nil, nil }.to raise_error(FinApps::REST::MissingArgumentsError)
-        end
-      end
+  end
 
-      context 'when company credentials are of invalid type' do
-        it 'should raise an InvalidArgumentsError exception' do
-          expect { FinApps::REST::Client.new 1, 2 }.to raise_error(FinApps::REST::InvalidArgumentsError)
-        end
-      end
+  context 'after initialized' do
 
-      context 'when company credentials are provided' do
-        it 'returns a client object' do
-          expect(@client).to be_an_instance_of(FinApps::REST::Client)
-        end
+    let(:client) { FinApps::REST::Client.new(:company_identifier, :company_token) }
+
+    [:send_request, :connection, :users, :institutions, :user_institutions, :transactions,
+     :categories, :budget_models, :budget_calculation, :budgets, :cashflows, :alert,
+     :alert_definition, :alert_preferences, :alert_settings, :rule_sets, :user_credentials!].each do |method|
+      it "responds to #{method}" do
+        expect(client).to respond_to(method)
       end
     end
 
-    describe '.users' do
-      it 'returns a Users object' do
-        expect(@client.users).to be_an_instance_of(FinApps::REST::Users)
-      end
+    describe '#users' do
+      it { expect(client.users).to be_an_instance_of(FinApps::REST::Users) }
     end
 
-    describe '.users' do
-      it 'returns a Users object' do
-        expect(@client.users).to be_an_instance_of(FinApps::REST::Users)
-      end
+    describe '#institutions' do
+      it { expect(client.institutions).to be_an_instance_of(FinApps::REST::Institutions) }
     end
 
-    describe '.institutions' do
-      it 'returns an Institutions object' do
-        expect(@client.institutions).to be_an_instance_of(FinApps::REST::Institutions)
-      end
+    describe '#user_institutions' do
+      it { expect(client.user_institutions).to be_an_instance_of(FinApps::REST::UserInstitutions) }
     end
 
-    describe '.user_institutions' do
-      it 'returns a UserInstitutions object' do
-        expect(@client.user_institutions).to be_an_instance_of(FinApps::REST::UserInstitutions)
-      end
+    describe '#categories' do
+      it { expect(client.categories).to be_an_instance_of(FinApps::REST::Categories) }
     end
 
-    describe '.transactions' do
-      it 'returns a Transactions object' do
-        expect(@client.transactions).to be_an_instance_of(FinApps::REST::Transactions)
-      end
+    describe '#budget_models' do
+      it { expect(client.budget_models).to be_an_instance_of(FinApps::REST::BudgetModels) }
+    end
+
+    describe '#budget_calculation' do
+      it { expect(client.budget_calculation).to be_an_instance_of(FinApps::REST::BudgetCalculation) }
+    end
+
+    describe '#budgets' do
+      it { expect(client.budgets).to be_an_instance_of(FinApps::REST::Budgets) }
+    end
+
+    describe '#cashflows' do
+      it { expect(client.cashflows).to be_an_instance_of(FinApps::REST::Cashflows) }
+    end
+
+    describe '#alert' do
+      it { expect(client.alert).to be_an_instance_of(FinApps::REST::Alert) }
+    end
+
+    describe '#alert_definition' do
+      it { expect(client.alert_definition).to be_an_instance_of(FinApps::REST::AlertDefinition) }
+    end
+
+    describe '#alert_preferences' do
+      it { expect(client.alert_preferences).to be_an_instance_of(FinApps::REST::AlertPreferences) }
+    end
+
+    describe '#alert_settings' do
+      it { expect(client.alert_settings).to be_an_instance_of(FinApps::REST::AlertSettings) }
+    end
+
+    describe '#rule_sets' do
+      it { expect(client.rule_sets).to be_an_instance_of(FinApps::REST::Relevance::Rulesets) }
     end
 
     describe '#connection' do
-      it 'looks like Faraday connection' do
-        expect(@client.connection).to respond_to(:run_request)
+      it { expect(client.connection).to be_an_instance_of(Faraday::Connection) }
+    end
+
+    [:connection, :users, :institutions, :user_institutions, :transactions,
+     :categories, :budget_models, :budget_calculation, :budgets, :cashflows, :alert,
+     :alert_definition, :alert_preferences, :alert_settings, :rule_sets].each do |method|
+      it "memoizes the result of #{method}" do
+        first, second = client.send(method), client.send(method)
+        expect(first.object_id).to eq(second.object_id)
       end
-      it 'memoizes the connection' do
-        c1, c2 = @client.connection, @client.connection
-        expect(c1.object_id).to eq(c2.object_id)
+    end
+
+    describe '#send_request' do
+
+      context 'when path is NOT provided' do
+        it { expect { client.send_request(nil, :post) }.to raise_error(FinApps::REST::MissingArgumentsError) }
       end
+
+      context 'when method is NOT provided' do
+        it { expect { client.send_request(:path, nil) }.to raise_error(FinApps::REST::MissingArgumentsError) }
+      end
+
+      context 'when method is NOT supported' do
+        it { expect { client.send_request(:path, :unsupported_method) }.to raise_error(FinApps::REST::InvalidArgumentsError) }
+      end
+
     end
 
   end
-end
+
+end
+