finapps 0.22.4.pre → 1.0.0

data/lib/finapps/rest/categories.rb

@@ -5,16 +5,20 @@ module FinApps
 
       # @return [Array<Hash>, Array<String>]
       def list
+        logger.debug "##{__method__.to_s} => Started"
+
         end_point = Defaults::END_POINTS[:categories_list]
         logger.debug "##{__method__.to_s} => end_point: #{end_point}"
 
         path = end_point
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        categories, error_messages = @client.send(path, :get)
+        categories, error_messages = @client.send_request(path, :get)
+
+        logger.debug "##{__method__.to_s} => Completed"
         return categories, error_messages
       end
 
     end
   end
-end
+end

data/lib/finapps/rest/client.rb

@@ -5,33 +5,80 @@ module FinApps
       include FinApps::Logging
       include FinApps::REST::Connection
 
-      attr_reader :connection, :users, :institutions, :user_institutions,
-                  :transactions, :categories,
-                  :budget_models, :budget_calculation, :budgets, :cashflows,
-                  :alert, :alert_definition, :alert_settings, :alert_preferences,
-                  :rule_sets
-
       # @param [String] company_identifier
       # @param [String] company_token
       # @param [Hash] options
       # @return [FinApps::REST::Client]
       def initialize(company_identifier, company_token, options = {})
+        logger.debug "##{__method__.to_s} => Started"
+
         @config = DEFAULTS.merge! options
-        if @config[:logger_tag].present?
-          Logging.tag= @config[:logger_tag]
-          logger.info "##{__method__.to_s} => Custom tag for logs: #{@config[:logger_tag]}"
-        end
+        logger_config @config
 
-        set_up_logger_level @config[:log_level]
-        logger.info "##{__method__.to_s} => Current logger level: #{SEVERITY_LABEL[logger.level]}"
+        @company_credentials = {:company_identifier => company_identifier, :company_token => company_token}
+        @company_credentials.validate_required_strings!
 
-        @company_credentials = {:company_identifier => company_identifier,
-                                :company_token => company_token}
-        @connection = set_up_connection(@company_credentials, @config)
-        logger.debug "##{__method__.to_s} => Connection initialized"
+        logger.debug "##{__method__.to_s} => Completed"
+      end
+
+      def connection
+        @connection ||= set_up_connection(@company_credentials, @config)
+      end
+
+      def users
+        @users ||= FinApps::REST::Users.new self
+      end
+
+      def institutions
+        @institutions ||= FinApps::REST::Institutions.new self
+      end
+
+      def user_institutions
+        @user_institutions ||= FinApps::REST::UserInstitutions.new self
+      end
+
+      def transactions
+        @transactions ||= FinApps::REST::Transactions.new self
+      end
 
-        set_up_resources
-        logger.debug "##{__method__.to_s} => All resources initialized"
+      def categories
+        @categories ||= FinApps::REST::Categories.new self
+      end
+
+      def budget_models
+        @budget_models ||= FinApps::REST::BudgetModels.new self
+      end
+
+      def budget_calculation
+        @budget_calculation ||= FinApps::REST::BudgetCalculation.new self
+      end
+
+      def budgets
+        @budgets ||= FinApps::REST::Budgets.new self
+      end
+
+      def cashflows
+        @cashflows ||= FinApps::REST::Cashflows.new self
+      end
+
+      def alert
+        @alert ||= FinApps::REST::Alert.new self
+      end
+
+      def alert_definition
+        @alert_definition ||= FinApps::REST::AlertDefinition.new self
+      end
+
+      def alert_settings
+        @alert_settings ||= FinApps::REST::AlertSettings.new self
+      end
+
+      def alert_preferences
+        @alert_preferences ||= FinApps::REST::AlertPreferences.new self
+      end
+
+      def rule_sets
+        @rule_sets ||= FinApps::REST::Relevance::Rulesets.new self
       end
 
       # Performs HTTP GET, POST, UPDATE and DELETE requests.
@@ -42,12 +89,15 @@ module FinApps
       # @param [String] method
       # @param [Proc] proc
       # @return [Hash,Array<String>]
-      def send(path, method, params = {}, &proc)
-        raise MissingArgumentsError.new 'Missing argument: method.' if method.blank?
-        result, error_messages = nil, nil
+      def send_request(path, method, params = {}, &proc)
+        logger.debug "##{__method__.to_s} => Started"
 
-        begin
+        raise FinApps::REST::MissingArgumentsError.new 'Missing argument: path.' if path.blank?
+        raise FinApps::REST::MissingArgumentsError.new 'Missing argument: method.' if method.blank?
 
+        result, error_messages = nil, []
+
+        begin
           case method
             when :get
               response = get(path)
@@ -58,7 +108,7 @@ module FinApps
             when :delete
               response = delete(path, params)
             else
-              raise StandardError "Method not supported: #{method}."
+              raise FinApps::REST::InvalidArgumentsError.new "Method not supported: #{method}."
           end
 
           if response.present?
@@ -67,33 +117,38 @@ module FinApps
             logger.error "##{__method__.to_s} => Null response found. Unable to process it."
           end
 
+        rescue FinApps::REST::InvalidArgumentsError => error
+          raise error
         rescue FinApps::REST::Error => error
           error_messages = error.error_messages
         rescue Faraday::ParsingError => error
-          error_messages = []
           error_messages << 'Unable to parse the server response.'
           logger.error "##{__method__.to_s} => Faraday::ParsingError, #{error.to_s}"
         rescue Exception => error
-          error_messages = []
           error_messages << 'Unexpected error.'
           logger.fatal "##{__method__.to_s} => Exception, #{error.to_s}"
           logger.fatal error
         ensure
           logger.debug "##{__method__.to_s} => Failed, error_messages: #{error_messages.pretty_inspect}" if error_messages.present?
         end
+
+        logger.debug "##{__method__.to_s} => Completed"
         return result, error_messages
       end
 
       # @param [String] user_identifier
       # @param [String] user_token
       def user_credentials!(user_identifier, user_token)
+        logger.debug "##{__method__.to_s} => Started"
+
         {:user_identifier => user_identifier, :user_token => user_token}.validate_required_strings!
         logger.debug "##{__method__.to_s} => Credentials passed validation. Attempting to set user credentials on current connection."
 
-
         @config[:user_identifier] = user_identifier
         @config[:user_token] = user_token
         @connection = set_up_connection(@company_credentials, @config)
+
+        logger.debug "##{__method__.to_s} => Completed"
       end
 
       private
@@ -105,10 +160,16 @@ module FinApps
       # @param [String] path
       # @return [Hash,Array<String>]
       def get(path)
+        logger.debug "##{__method__.to_s} => Started"
         raise MissingArgumentsError.new 'Missing argument: path.' if path.blank?
 
         logger.debug "##{__method__.to_s} => GET path:#{path}"
-        @connection.get { |req| req.url path }
+        response = @connection.get do |req|
+          req.url path
+        end
+
+        logger.debug "##{__method__.to_s} => Completed"
+        response
       end
 
       # Performs an HTTP POST request.
@@ -119,13 +180,17 @@ module FinApps
       # @param [Hash] params
       # @return [Hash,Array<String>]
       def post(path, params = {})
+        logger.debug "##{__method__.to_s} => Started"
         raise MissingArgumentsError.new 'Missing argument: path.' if path.blank?
 
         logger.debug "##{__method__.to_s} => POST path:#{path} params:#{skip_sensitive_data params }"
-        @connection.post do |req|
+        response = @connection.post do |req|
           req.url path
           req.body = params
         end
+
+        logger.debug "##{__method__.to_s} => Completed"
+        response
       end
 
       # Performs an HTTP PUT request.
@@ -136,13 +201,17 @@ module FinApps
       # @param [Hash] params
       # @return [Hash,Array<String>]
       def put(path, params = {})
+        logger.debug "##{__method__.to_s} => Started"
         raise MissingArgumentsError.new 'Missing argument: path.' if path.blank?
 
         logger.debug "##{__method__.to_s} => PUT path:#{path} params:#{skip_sensitive_data(params)}"
-        @connection.put do |req|
+        response = @connection.put do |req|
           req.url path
           req.body = params
         end
+
+        logger.debug "##{__method__.to_s} => Completed"
+        response
       end
 
       # Performs an HTTP DELETE request.
@@ -153,32 +222,17 @@ module FinApps
       # @param [Hash] params
       # @return [Hash,Array<String>]
       def delete(path, params = {})
+        logger.debug "##{__method__.to_s} => Started"
         raise MissingArgumentsError.new 'Missing argument: path.' if path.blank?
 
         logger.debug "##{__method__.to_s} => DELETE path:#{path} params:#{skip_sensitive_data(params)}"
-        @connection.delete do |req|
+        response = @connection.delete do |req|
           req.url path
           req.body = params
         end
-      end
 
-      # Initialize resources.
-      #
-      def set_up_resources
-        @users ||= FinApps::REST::Users.new self
-        @institutions ||= FinApps::REST::Institutions.new self
-        @user_institutions ||= FinApps::REST::UserInstitutions.new self
-        @transactions ||= FinApps::REST::Transactions.new self
-        @categories ||= FinApps::REST::Categories.new self
-        @budget_models ||= FinApps::REST::BudgetModels.new self
-        @budget_calculation ||= FinApps::REST::BudgetCalculation.new self
-        @budgets ||= FinApps::REST::Budgets.new self
-        @cashflows ||= FinApps::REST::Cashflows.new self
-        @alert ||= FinApps::REST::Alert.new self
-        @alert_definition ||= FinApps::REST::AlertDefinition.new self
-        @alert_settings ||= FinApps::REST::AlertSettings.new self
-        @alert_preferences ||= FinApps::REST::AlertPreferences.new self
-        @rule_sets ||= FinApps::REST::Relevance::Rulesets.new self
+        logger.debug "##{__method__.to_s} => Completed"
+        response
       end
 
     end

data/lib/finapps/rest/connection.rb

@@ -9,17 +9,11 @@ module FinApps
       # @param [Hash] config
       # @return [Faraday::Connection]
       def set_up_connection(company_credentials, config)
-        company_credentials.validate_required_strings!
-        logger.debug "##{__method__.to_s} => company_credentials were provided."
-
-        host = config[:host]
-        validate_host_url! host
-
-        base_url = "#{host}/v#{API_VERSION}"
-        logger.debug " base_url: #{base_url}"
+        host_url = config[:host].blank? ? DEFAULTS[:host] : config[:host]
+        raise InvalidArgumentsError.new "Invalid argument: host_url: #{host_url}" unless host_url.start_with?('http://', 'https://')
 
+        base_url = "#{host_url}/v#{API_VERSION}"
         timeout = config[:timeout].blank? ? DEFAULTS[:timeout] : config[:timeout]
-        logger.debug " timeout: #{timeout}"
 
         Faraday.new(:url => base_url,
                     :request => {
@@ -29,47 +23,28 @@ module FinApps
                         :accept => HEADERS[:accept],
                         :user_agent => HEADERS[:user_agent]}) do |conn|
 
-          set_request_middleware(conn, company_credentials)
-          set_basic_authentication(conn, config)
-          set_response_middleware(conn)
-
-          # Adapter (ensure that the adapter is always last.)
-          conn.adapter :typhoeus
-        end
-      end
+          # add basic authentication header if user credentials were provided
+          user_identifier = config[:user_identifier]
+          user_token = config[:user_token]
+          conn.request :basic_auth, user_identifier, user_token unless user_identifier.blank? || user_token.blank?
 
-      private
-      def set_response_middleware(conn)
-        conn.use FinApps::Middleware::RaiseHttpExceptions
-        conn.response :rashify
-        conn.response :json, :content_type => /\bjson$/
-        conn.use FinApps::Middleware::ResponseLogger
-      end
+          # company level authentication
+          conn.use FinApps::Middleware::ApiToken, company_credentials
 
-      def set_request_middleware(conn, company_credentials)
-        conn.use FinApps::Middleware::ApiToken, company_credentials
-        conn.request :json
-        conn.request :retry
-        conn.request :multipart
-        conn.request :url_encoded
-      end
+          conn.request :json
+          conn.request :retry
+          conn.request :multipart
+          conn.request :url_encoded
+          conn.use FinApps::Middleware::RaiseHttpExceptions
+          conn.response :rashify
+          conn.response :json, :content_type => /\bjson$/
+          conn.use FinApps::Middleware::ResponseLogger
 
-      def set_basic_authentication(conn, config)
-        if config[:user_identifier].blank? || config[:user_token].blank?
-          logger.debug "##{__method__.to_s} => User credentials were not provided. Authentication header not set."
-        else
-          conn.request :basic_auth, config[:user_identifier], config[:user_token]
-          logger.debug "##{__method__.to_s} => Basic Authentication header set for provided user credentials."
+          # Adapter (ensure that the adapter is always last.)
+          conn.adapter :typhoeus
         end
       end
 
-      def validate_host_url!(host_url)
-        raise MissingArgumentsError.new 'Missing argument: host_url.' if host_url.blank?
-        raise InvalidArgumentsError.new 'Invalid argument: host_url does not specify a valid protocol (http/https).' unless host_url.start_with?('http://', 'https://')
-
-        logger.debug "##{__method__.to_s} => host [#{host_url}] passed validation."
-      end
-
     end
   end
-end
+end

data/lib/finapps/rest/defaults.rb

@@ -27,7 +27,6 @@ module FinApps
           :users_update => 'user',
           :users_update_password => 'user/password',
           :users_delete => 'users/:public_id',
-          :users_show => 'users/:public_id',
           :users_login => 'users/login',
 
           :relevance_rulesets_list => 'relevance/ruleset/names',
@@ -86,4 +85,4 @@ module FinApps
 
     end
   end
-end
+end

data/lib/finapps/rest/institutions.rb

@@ -9,6 +9,8 @@ module FinApps
       # @param [String] term
       # @return [Array<FinApps::REST::Institution>, Array<String>]
       def search(term)
+        logger.debug "##{__method__.to_s} => Started"
+
         raise MissingArgumentsError.new 'Missing argument: term.' if term.blank?
         logger.debug "##{__method__.to_s} => term: #{term}"
 
@@ -18,12 +20,16 @@ module FinApps
         path = end_point.sub ':search_term', ERB::Util.url_encode(term)
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        institutions, error_messages = @client.send(path, :get)
+        institutions, error_messages = @client.send_request(path, :get)
+
+        logger.debug "##{__method__.to_s} => Completed"
         return institutions, error_messages
       end
 
       # @param [Integer] site_id
       def form(site_id)
+        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}"
 
@@ -33,7 +39,9 @@ module FinApps
         path = end_point.sub ':site_id', ERB::Util.url_encode(site_id)
         logger.debug "##{__method__.to_s} => path: #{path}"
 
-        institution, error_messages = @client.send(path, :get) { |r| Institution.new(r.body) }
+        institution, error_messages = @client.send_request(path, :get) { |r| Institution.new(r.body) }
+
+        logger.debug "##{__method__.to_s} => Completed"
         return institution, error_messages
       end
 
@@ -44,4 +52,4 @@ module FinApps
     end
 
   end
-end
+end

data/lib/finapps/rest/relevance/rulesets.rb

@@ -7,7 +7,7 @@ module FinApps
       class Rulesets < FinApps::REST::Resources
 
         def list
-
+          logger.debug "##{__method__.to_s} => Started"
 
           end_point = Defaults::END_POINTS[:relevance_rulesets_list]
           logger.debug "##{__method__.to_s} => end_point: #{end_point}"
@@ -15,14 +15,14 @@ module FinApps
           path = end_point
           logger.debug "##{__method__.to_s} => path: #{path}"
 
-          results, error_messages = @client.send(path, :get)
-
+          results, error_messages = @client.send_request(path, :get)
 
+          logger.debug "##{__method__.to_s} => Completed"
           return results, error_messages
         end
 
         def show(ruleset_name)
-
+          logger.debug "##{__method__.to_s} => Started"
 
           raise MissingArgumentsError.new 'Missing argument: ruleset_name.' if ruleset_name.blank?
           logger.debug "##{__method__.to_s} => ruleset_name: #{ruleset_name}"
@@ -33,14 +33,14 @@ module FinApps
           path = end_point.sub ':ruleset_name', ERB::Util.url_encode(ruleset_name)
           logger.debug "##{__method__.to_s} => path: #{path}"
 
-          results, error_messages = @client.send(path, :get)
-
+          results, error_messages = @client.send_request(path, :get)
 
+          logger.debug "##{__method__.to_s} => Completed"
           return results, error_messages
         end
 
         def run(params = {})
-
+          logger.debug "##{__method__.to_s} => Started"
 
           raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
           logger.debug "##{__method__.to_s} => params: #{params.inspect}"
@@ -51,9 +51,9 @@ module FinApps
           path = end_point
           logger.debug "##{__method__.to_s} => path: #{path}"
 
-          results, error_messages = @client.send(path, :post, params)
-
+          results, error_messages = @client.send_request(path, :post, params)
 
+          logger.debug "##{__method__.to_s} => Completed"
           return results, error_messages
         end
 
@@ -61,4 +61,4 @@ module FinApps
     end
 
   end
-end
+end