finapps 0.15.2.pre → 0.16.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 221dace01dc937a32d9e2c5f7f6f6055e4256f07
-  data.tar.gz: ec44bba21c568e39ba7f2ad3032de9a4fc47d67e
+  metadata.gz: fb3b3440f5bca209610fcf02bbc8e0bac6f92ca6
+  data.tar.gz: 799674cd7b7444eeef4b05d5856cf442b90c65d8
 SHA512:
-  metadata.gz: 38716ba06d21b39137079daa0e4488dae4f7afe95f7d01cc28e3b5028bb0bbbd0a4e670d7363da3befee325bf6c266923820a36ab5b5fd111cb3b8b05b0954e5
-  data.tar.gz: d5a77305abbdb03169a083b42d765354976ac83e7a907f433cec9e8b0939188fe3f3db974afa498763b97d0d15eb8d1cb2085b30d24edf43cffa28405df70d59
+  metadata.gz: d287bb0bd73efd04435de7374b8293d03bc2507caaec0926b696dcfbc47a5231e4f6517cdcbd30edcdeb01f2e74c238eeea18f2496e4740da5c7a3083e64cd54
+  data.tar.gz: d3176f06cf949c9d010963e63f70b469cfe14f5d9475ba9771d10b9c7602d9c70450fa327c0f1d4aa2919376089b67a9822f28ae5891c867fc898b9457a0a5a7

data/bin/finapps

@@ -3,5 +3,6 @@ require 'finapps/cli/common'
 require 'finapps/cli/users'
 require 'finapps/cli/institutions'
 require 'finapps/cli/budgets'
+require 'finapps/cli/cashflows'
 
 FinApps::CLI.start

data/lib/finapps/cli/cashflows.rb

@@ -0,0 +1,37 @@
+require 'thor'
+require 'finapps'
+require 'pp'
+
+module FinApps
+  class CLI < Thor
+
+    desc 'cashflows', 'show'
+
+    def cashflows_show
+
+      begin
+
+        user_identifier = '53d17daf-909d-45d2-6fb6-d43b74d364cb'
+        user_token = '4JZmhcHVf3ODRJ9TMKF7N/1sHDY3M5Q49A9ToAy+TDE='
+
+        client.user_credentials!(user_identifier, user_token)
+        budget, error_messages = client.cashflows.show('2015-01-01T00:00:00Z', '2015-01-31T00:00:00Z')
+        if budget.present?
+          puts
+          puts 'cashflow results:'
+          pp budget
+        else
+          puts
+          puts 'unable to get cashflow'
+          error_messages.each { |m| puts m } if error_messages.present?
+        end
+        puts
+
+      rescue StandardError => error
+        rescue_standard_error(error)
+      end
+
+    end
+
+  end
+end

data/lib/finapps/rest/budgets.rb

@@ -27,42 +27,14 @@ module FinApps
 
         result, error_messages = @client.send(path, :get)
         if result.present? && error_messages.blank?
-          transactions = result.find { |r| r.has_key?('trans') }
-          transactions = transactions['trans'] if transactions.present?
-          logger.debug transactions.pretty_inspect
-
-          categories = result.find { |r| r.has_key?('cats') }
-          logger.debug categories.pretty_inspect
-
-          raise 'Category results set for budget is not an array.' unless categories.respond_to?(:each)
-          categories['cats'].each do |c|
-            logger.debug "---------------------------------------------"
-            raise 'Unable to locate category id for current category record.' unless c.key?('cat_id')
-            category_id = c['cat_id']
-            logger.debug "category_id: #{category_id}"
-
-            raise 'Unable to locate category name for current category record.' unless c.key?('name')
-            category_name = c['name']
-            logger.debug "category_name: #{category_name}"
-
-            raise 'Unable to locate budget_amount for current category record.' unless c.key?('budget_amount')
-            budget_amount = c['budget_amount']
-            logger.debug "daily_budget_amount: #{budget_amount}"
-
-            raise 'Unable to locate number of days for current category record.' unless c.key?('days')
-            days = c['days']
-            logger.debug "days: #{days}"
-
-            date_range_budget_amount = budget_amount.to_f * days.to_i
-            logger.debug "budget_amount for #{days} days: #{date_range_budget_amount}"
-
-            budget.details << BudgetDetail.new({:category_id => category_id,
-                                                :category_name => category_name,
-                                                :budget_amount => date_range_budget_amount,
-                                                :expense_amount => expense_amount(category_id, transactions)})
-          end
-        end
+          categories = result_categories(result)
+          raise 'Category results-set for budget is not an array.' unless categories.respond_to?(:each)
+
+          transactions = result_transactions(result)
+          categories.each { |category| budget.details << result_category_to_budget_detail(category, transactions) }
 
+          logger.debug budget.pretty_inspect
+        end
 
         logger.debug "##{__method__.to_s} => Completed"
         return budget, error_messages
@@ -85,6 +57,41 @@ module FinApps
       end
 
       private
+
+      def result_categories(result)
+        extract_array(result, 'cats')
+      end
+
+      def result_category_to_budget_detail(category, transactions)
+        raise 'Unable to locate category id for current category record.' unless category.key?('cat_id')
+        category_id = category['cat_id']
+
+        raise 'Unable to locate category name for current category record.' unless category.key?('name')
+        category_name = category['name']
+
+        raise 'Unable to locate budget_amount for current category record.' unless category.key?('budget_amount')
+        budget_amount = category['budget_amount']
+
+        raise 'Unable to locate number of days for current category record.' unless category.key?('days')
+        days = category['days']
+
+        date_range_budget_amount = budget_amount.to_f * days.to_i
+
+        BudgetDetail.new({:category_id => category_id,
+                          :category_name => category_name,
+                          :budget_amount => date_range_budget_amount,
+                          :expense_amount => expense_amount(category_id, transactions)})
+      end
+
+      def result_transactions(result)
+        extract_array(result, 'trans')
+      end
+
+      def extract_array(result, array_identifier)
+        array_container = result.find { |r| r.has_key?(array_identifier) }
+        array_container.present? ? array_container[array_identifier] : nil
+      end
+
       def expense_amount(category_id, transactions = [])
         amount = 0
         if category_id.present? && transactions.respond_to?(:find)

data/lib/finapps/rest/cashflows.rb

@@ -0,0 +1,97 @@
+module FinApps
+  module REST
+
+    require 'erb'
+
+    class Cashflows < FinApps::REST::Resources
+      include FinApps::REST::Defaults
+
+      # @param [Date] start_date
+      # @param [Date] end_date
+      # @return [Hash, Array<String>]
+      def show(start_date, end_date)
+        logger.debug "##{__method__.to_s} => Started"
+
+        raise MissingArgumentsError.new 'Missing argument: start_date.' if start_date.blank?
+        logger.debug "##{__method__.to_s} => start_date: #{start_date}"
+        raise MissingArgumentsError.new 'Missing argument: end_date.' if end_date.blank?
+        logger.debug "##{__method__.to_s} => end_date: #{end_date}"
+
+        cashflow = Cashflow.new({:start_date => start_date,
+                                 :end_date => end_date,
+                                 :total_inflow_amount => 0,
+                                 :total_outflow_amount => 0,
+                                 :total_leftover_amount => 0,
+                                 :details => []})
+
+        end_point = Defaults::END_POINTS[:cashflow_show]
+        logger.debug "##{__method__.to_s} => end_point: #{end_point}"
+
+        path = end_point.sub(':start_date', ERB::Util.url_encode(start_date)).sub(':end_date', ERB::Util.url_encode(end_date))
+        logger.debug "##{__method__.to_s} => path: #{path}"
+
+        result, error_messages = @client.send(path, :get)
+        if result.present? && error_messages.blank?
+
+          summary = extract_value(result, 'summary')
+          raise 'Summary result-set for cashflow is not present.' if summary.nil?
+          raise 'Summary result-set for cashflow is not a hash.' unless summary.respond_to?(:key?)
+
+          raise 'Total in-flow value for cashflow is not present.' unless summary.key?('inflow')
+          cashflow.total_inflow_amount = summary['inflow']
+
+          raise 'Total out-flow value for cashflow is not present.' unless summary.key?('outflow')
+          cashflow.total_outflow_amount = summary['outflow']
+
+          raise 'Total left-over value for cashflow is not present.' unless summary.key?('diff')
+          cashflow.total_leftover_amount = summary['diff']
+
+          categories = extract_value(result, 'details')
+          raise 'Category results-set for cashflow is not an array.' unless categories.respond_to?(:each)
+
+          categories.each { |category| cashflow.details << result_category_to_cashflow_detail(category) }
+        end
+
+        logger.debug "##{__method__.to_s} => Completed"
+        return cashflow, error_messages
+      end
+
+      private
+
+      def extract_value(result, array_identifier)
+        array_container = result.find { |r| r.has_key?(array_identifier) }
+        array_container.present? ? array_container[array_identifier] : nil
+      end
+
+      def result_category_to_cashflow_detail(category)
+        raise 'Unable to locate category id for current category record.' unless category.key?('cat')
+        category_id = category['cat']
+
+        raise 'Unable to locate inflow amount for current category record.' unless category.key?('inflow')
+        inflow_amount = category['inflow']
+
+        raise 'Unable to locate outflow amount for current category record.' unless category.key?('outflow')
+        outflow_amount = category['outflow']
+
+        raise 'Unable to locate left over amount for current category record.' unless category.key?('diff')
+        leftover_amount = category['diff']
+
+        BudgetDetail.new({:category_id => category_id,
+                          :inflow_amount => inflow_amount,
+                          :outflow_amount => outflow_amount,
+                          :leftover_amount => leftover_amount})
+      end
+
+    end
+
+    class Cashflow < FinApps::REST::Resource
+      attr_accessor :start_date, :end_date,
+                    :total_inflow_amount, :total_outflow_amount, :total_leftover_amount, :details
+    end
+
+    class CashflowDetail < FinApps::REST::Resource
+      attr_accessor :category_id, :inflow_amount, :outflow_amount, :leftover_amount
+    end
+
+  end
+end

data/lib/finapps/rest/client.rb

@@ -7,7 +7,7 @@ module FinApps
 
       attr_reader :connection, :users, :institutions, :user_institutions,
                   :transactions, :categories,
-                  :budget_models, :budget_calculation, :budgets, :cashflow,
+                  :budget_models, :budget_calculation, :budgets, :cashflows,
                   :alert, :alert_definition, :alert_setting,
                   :rule_sets
 
@@ -202,7 +202,7 @@ module FinApps
         @budget_models ||= FinApps::REST::BudgetModels.new self
         @budget_calculation ||= FinApps::REST::BudgetCalculation.new self
         @budgets ||= FinApps::REST::Budgets.new self
-        @cashflow ||= FinApps::REST::Cashflow.new self
+        @cashflows ||= FinApps::REST::Cashflows.new self
         @alert ||= FinApps::REST::Alert.new self
         @alert_definition ||= FinApps::REST::AlertDefinition.new self
         @alert_setting ||= FinApps::REST::AlertSetting.new self

data/lib/finapps/version.rb

@@ -1,3 +1,3 @@
 module FinApps
-  VERSION = '0.15.2.pre'
+  VERSION = '0.16.0.pre'
 end

data/lib/finapps.rb

@@ -27,7 +27,7 @@ require 'finapps/rest/categories'
 require 'finapps/rest/budget_models'
 require 'finapps/rest/budget_calculation'
 require 'finapps/rest/budgets'
-require 'finapps/rest/cashflow'
+require 'finapps/rest/cashflows'
 require 'finapps/rest/alert'
 require 'finapps/rest/alert_definition'
 require 'finapps/rest/alert_setting'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 0.15.2.pre
+  version: 0.16.0.pre
 platform: ruby
 authors:
 - Erich Quintero
@@ -192,6 +192,7 @@ files:
 - finapps.gemspec
 - lib/finapps.rb
 - lib/finapps/cli/budgets.rb
+- lib/finapps/cli/cashflows.rb
 - lib/finapps/cli/common.rb
 - lib/finapps/cli/institutions.rb
 - lib/finapps/cli/users.rb
@@ -204,7 +205,7 @@ files:
 - lib/finapps/rest/budget_calculation.rb
 - lib/finapps/rest/budget_models.rb
 - lib/finapps/rest/budgets.rb
-- lib/finapps/rest/cashflow.rb
+- lib/finapps/rest/cashflows.rb
 - lib/finapps/rest/categories.rb
 - lib/finapps/rest/client.rb
 - lib/finapps/rest/connection.rb

data/lib/finapps/rest/cashflow.rb

@@ -1,34 +0,0 @@
-module FinApps
-  module REST
-
-    require 'erb'
-
-    class Cashflow < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # @param [Date] start_date
-      # @param [Date] end_date
-      # @return [Hash, Array<String>]
-      def show(start_date, end_date)
-        logger.debug "##{__method__.to_s} => Started"
-
-        raise MissingArgumentsError.new 'Missing argument: start_date.' if start_date.blank?
-        logger.debug "##{__method__.to_s} => start_date: #{start_date}"
-        raise MissingArgumentsError.new 'Missing argument: end_date.' if end_date.blank?
-        logger.debug "##{__method__.to_s} => end_date: #{end_date}"
-
-        end_point = Defaults::END_POINTS[:cashflow_show]
-        logger.debug "##{__method__.to_s} => end_point: #{end_point}"
-
-        path = end_point.sub(':start_date', ERB::Util.url_encode(start_date)).sub(':end_date', ERB::Util.url_encode(end_date))
-        logger.debug "##{__method__.to_s} => path: #{path}"
-
-        budget, error_messages = @client.send(path, :get)
-
-        logger.debug "##{__method__.to_s} => Completed"
-        return budget, error_messages
-      end
-
-    end
-  end
-end