myfinance 0.7.0 → 1.0.0

data/lib/myfinance/entities/bank_statement.rb

@@ -0,0 +1,16 @@
+module Myfinance
+  module Entities
+    class BankStatement < Base
+      attribute :id, Integer
+      attribute :deposit_account_id, Integer
+      attribute :file_file_name, String
+      attribute :future_items_ignored_count, Integer
+      attribute :amount_zero_items_ignored_count, Integer
+      attribute :invalid_date_items_ignored_count, Integer
+      attribute :event, Hash
+
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/myfinance/entities/credit_card.rb

@@ -0,0 +1,19 @@
+module Myfinance
+  module Entities
+    class CreditCard < Base
+      attribute :id, Integer
+      attribute :entity_id, Integer
+      attribute :person_id, Integer
+      attribute :classification_center_id, Integer
+      attribute :category_id, Integer
+      attribute :closing_day, Integer
+      attribute :expiration_day, Integer
+      attribute :name, String
+      attribute :flag, String
+      attribute :flag_image_url, String
+      attribute :observation, String
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/myfinance/entities/credit_card_collection.rb

@@ -0,0 +1,11 @@
+module Myfinance
+  module Entities
+    class CreditCardCollection < Collection
+      def build_collection
+        response.parsed_body.each do |attributes|
+          collection.push(Myfinance::Entities::CreditCard.new(attributes["credit_card"]))
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/entities/credit_card_transaction.rb

@@ -0,0 +1,26 @@
+module Myfinance
+  module Entities
+    class CreditCardTransaction < Base
+      attribute :id, Integer
+      attribute :credit_card_invoice_id, Integer
+      attribute :credit_card_id, Integer
+      attribute :classification_center_id, Integer
+      attribute :category_id, Integer
+      attribute :amount, Decimal
+      attribute :description, String
+      attribute :occurred_at, Date
+      attribute :type, String
+      attribute :document, String
+      attribute :observation, String
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+      attribute :invoice_payment, Boolean
+      attribute :excel_import_id, Integer
+      attribute :financial_account_id, Integer
+      attribute :person_id, Integer
+      attribute :moved, Boolean
+      attribute :recurrence_id, Integer
+      attribute :indexed_at, DateTime
+    end
+  end
+end

data/lib/myfinance/entities/credit_card_transaction_collection.rb

@@ -0,0 +1,11 @@
+module Myfinance
+  module Entities
+    class CreditCardTransactionCollection < Collection
+      def build_collection
+        response.parsed_body.each do |attributes|
+          collection.push(Myfinance::Entities::CreditCardTransaction.new(attributes["credit_card_transaction"]))
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/entities/financial_account.rb

@@ -10,7 +10,7 @@ module Myfinance
         :competency_month].each { |k| attribute k, String }
 
       [:amount, :interest_amount, :discount_amount, :total_amount, :ticket_amount].each do |k|
-        attribute k, Float
+        attribute k, Decimal
       end
 
       [:remind, :income_tax_relevant, :recurrent, :parcelled, :ticket_amount].each do |k|

data/lib/myfinance/entities/payable_account_collection.rb

@@ -0,0 +1,14 @@
+module Myfinance
+  module Entities
+    #
+    # A wrapper to Myfinance payable accounts collection
+    #
+    class PayableAccountCollection < Collection
+      def build_collection
+        response.parsed_body.each do |attributes|
+          collection.push(Myfinance::Entities::PayableAccount.new(attributes["payable_account"]))
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/entities/receivable_account_collection.rb

@@ -0,0 +1,14 @@
+module Myfinance
+  module Entities
+    #
+    # A wrapper to Myfinance receivable accounts collection
+    #
+    class ReceivableAccountCollection < Collection
+      def build_collection
+        response.parsed_body.each do |attributes|
+          collection.push(Myfinance::Entities::ReceivableAccount.new(attributes["receivable_account"]))
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/entities/reconcile_collection.rb

@@ -0,0 +1,30 @@
+module Myfinance
+  module Entities
+    class ReconcileCollection < Collection
+      def build_collection
+        response.parsed_body.each do |attributes|
+          type = attributes.first
+          if type == "financial_transactions" || type == "financial_accounts"
+            create_collection(type, attributes)
+          end
+        end
+      end
+
+      private
+
+      def create_collection(type, attributes)
+        klass = klass_name(type)
+
+        attributes.delete(attributes.first)
+        attributes.each do |attribute|
+          collection.push(klass.new(attribute.first))
+        end
+      end
+
+      def klass_name(type)
+        return Myfinance::Entities::FinancialTransaction if type == "financial_transactions"
+        Myfinance::Entities::FinancialAccount
+      end
+    end
+  end
+end

data/lib/myfinance/resources/bank_statement.rb

@@ -0,0 +1,20 @@
+module Myfinance
+  module Resources
+    class BankStatement < Base
+      def import(entity_id, deposit_account_id, file)
+        path = "/entities/#{entity_id}/deposit_accounts/#{deposit_account_id}/bank_statements"
+        params = { file: file }
+        http.post(path, body: { bank_statement: params }, multipart: true) do |response|
+          respond_with_object(response, "bank_statement")
+        end
+      end
+
+      def status(entity_id, deposit_account_id, id)
+        path = "/entities/#{entity_id}/deposit_accounts/#{deposit_account_id}/bank_statements/#{id}"
+        http.get(path) do |response|
+          respond_with_object(response, "bank_statement")
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/resources/category.rb

@@ -35,6 +35,22 @@ module Myfinance
         end
       end
 
+      #
+      # Find a category by attributes
+      #
+      # [API]
+      #   Method: <tt>GET /categories/:id</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/categories#get_show
+      #
+      def find_by(params = {})
+        path = params.map { |k, v| "search[#{k}]=#{v}" }.join("&")
+
+        http.get(URI.encode("/categories?#{path}"), body: {}) do |response|
+          respond_with_collection(response)
+        end
+      end
+
       #
       # Creates a category
       #

data/lib/myfinance/resources/classification_center.rb

@@ -46,7 +46,7 @@ module Myfinance
       def find_by(params)
         values = params.map { |k,v| "search[#{k}]=#{v}" }.join("&")
         http.get(
-          "/classification_centers?#{values.gsub(%r/\s/, '+')}", body: {}
+          URI.encode("/classification_centers?#{values}"), body: {}
         ) do |response|
           respond_with_collection(response)
         end

data/lib/myfinance/resources/credit_card.rb

@@ -0,0 +1,47 @@
+module Myfinance
+  module Resources
+    class CreditCard < Base
+      def find_all(entity_id)
+        http.get(path(entity_id), body: {}) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      def find(entity_id, id)
+        cc_path = path(entity_id) + "/#{id}"
+        http.get(cc_path, body: {}) do |response|
+          respond_with_object(response, "credit_card")
+        end
+      end
+
+      def create(entity_id, params = {})
+        body = { credit_card: params }
+        http.post(path(entity_id), body: body) do |response|
+          respond_with_object(response, "credit_card")
+        end
+      end
+
+      def update(entity_id, id, params = {})
+        cc_path = path(entity_id) + "/#{id}"
+        body = { credit_card: params }
+        http.put(cc_path, body: body) do |response|
+          respond_with_object(response, "credit_card")
+        end
+      end
+
+      def destroy(entity_id, id)
+        cc_path = path(entity_id) + "/#{id}"
+        http.delete(cc_path, body: {}) do |response|
+          response
+        end
+      end
+
+
+      private
+
+      def path(entity_id)
+        "/entities/#{entity_id}/credit_cards"
+      end
+    end
+  end
+end

data/lib/myfinance/resources/credit_card_transaction.rb

@@ -0,0 +1,47 @@
+module Myfinance
+  module Resources
+    class CreditCardTransaction < Base
+      def find_all(entity_id, credit_card_id, year, month)
+        path = "/entities/#{entity_id}/credit_cards/#{credit_card_id}/invoices/#{year}-#{month}"
+        http.get(path, body: {}) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      def find(entity_id, credit_card_id, credit_card_transaction_id)
+        path = "/entities/#{entity_id}/credit_cards/#{credit_card_id}/transactions/#{credit_card_transaction_id}" 
+        http.get(path, body: {}) do |response|
+          respond_with_object(response, "credit_card_transaction")
+        end
+      end
+
+      def create(entity_id, credit_card_id, params = {})
+        path = "/entities/#{entity_id}/credit_cards/#{credit_card_id}/transactions" 
+        http.post(path, body: { credit_card_transaction: params }) do |response|
+          respond_with_object(response, "credit_card_transaction")
+        end
+      end
+
+      def update(entity_id, credit_card_id, credit_card_transaction_id, params = {})
+        path = "/entities/#{entity_id}/credit_cards/#{credit_card_id}/transactions/#{credit_card_transaction_id}" 
+        http.put(path, body: { credit_card_transaction: params }) do |response|
+          respond_with_object(response, "credit_card_transaction")
+        end
+      end
+
+      def destroy(entity_id, credit_card_id, credit_card_transaction_id, params = {})
+        path = "/entities/#{entity_id}/credit_cards/#{credit_card_id}/transactions/#{credit_card_transaction_id}" 
+        http.delete(path, body: { credit_card_transaction: params }) do |response|
+          response
+        end
+      end
+
+      def destroy_parcelled(entity_id, credit_card_id, credit_card_transaction_id, params = {})
+        path = "/entities/#{entity_id}/credit_cards/#{credit_card_id}/transactions/#{credit_card_transaction_id}/recurrence" 
+        http.delete(path, body: { credit_card_transaction: params }) do |response|
+          response
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/resources/financial_account.rb

@@ -7,6 +7,15 @@ module Myfinance
         set_method_for(pay_or_receive_method)
         set_method_for(undo_payment_or_receivement)
       end
+
+      def find_all(entity_id, page = nil)
+        request_and_build_collection_response(:get, index_endpoint(entity_id, page))
+      end
+
+      def find(entity_id, id)
+        request_and_build_object_response(:get, endpoint_for(id, entity_id, :show))
+      end
+
       #
       # Creates a payable/receivable account
       #
@@ -18,7 +27,7 @@ module Myfinance
       #   Documentation: https://app.myfinance.com.br/docs/api/receivable_accounts#post_create
       #
       def create(entity_id, params = {})
-        request_and_build_response(:post, endpoint_for(nil, entity_id, :create), params)
+        request_and_build_object_response(:post, endpoint_for(nil, entity_id, :create), params)
       end
 
       #
@@ -31,8 +40,8 @@ module Myfinance
       #   Documentation: https://app.myfinance.com.br/docs/api/payable_accounts#put_update
       #   Documentation: https://app.myfinance.com.br/docs/api/receivable_accounts#put_update
       #
-      def update(id, entity_id, params = {})
-        request_and_build_response(:put, endpoint_for(id, entity_id, :update), params)
+      def update(entity_id, id, params = {})
+        request_and_build_object_response(:put, endpoint_for(id, entity_id, :update), params)
       end
 
       #
@@ -45,29 +54,57 @@ module Myfinance
       #   Documentation: https://app.myfinance.com.br/docs/api/payable_accounts#delete_destroy
       #   Documentation: https://app.myfinance.com.br/docs/api/receivable_accounts#delete_destroy
       #
-      def destroy(id, entity_id)
+      def destroy(entity_id, id)
         http.delete(endpoint_for(id, entity_id, :destroy)) do |_response|
           true
         end
       end
 
+      def destroy_recurrence(entity_id, id)
+        http.delete(endpoint_for(id, entity_id, :destroy_recurrence)) do |_response|
+          true
+        end
+      end
+
+      def destroy_many(entity_id, ids)
+        http.delete(destroy_many_endpoint(ids, entity_id)) do |_response|
+          true
+        end
+      end
+
       private
 
-      def request_and_build_response(method, endpoint, params={})
+      def request_and_build_object_response(method, endpoint, params = {})
         http.send(method, endpoint, body: { resource_key => params }) do |response|
           respond_with_object(response, resource_key)
         end
       end
 
+      def request_and_build_collection_response(method, endpoint)
+        http.send(method, endpoint, body: {}) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      def index_endpoint(entity_id, page)
+        index_path = parameterize_endpoint(nil, entity_id, :index)
+
+        return index_path unless page
+        index_path + "?page=#{page}"
+      end
+
       def endpoint_for(id, entity_id, key)
         parameterize_endpoint(id, entity_id, key)
       end
 
       def default_endpoints
         {
+          index: "/entities/:entity_id/#{resource_key}s",
+          show: "/entities/:entity_id/#{resource_key}s/:id",
           create: "/entities/:entity_id/#{resource_key}s",
           update: "/entities/:entity_id/#{resource_key}s/:id",
-          destroy: "/entities/:entity_id/#{resource_key}s/:id"
+          destroy: "/entities/:entity_id/#{resource_key}s/:id",
+          destroy_recurrence: "/entities/:entity_id/#{resource_key}s/:id/recurrence"
         }
       end
 
@@ -77,9 +114,13 @@ module Myfinance
 
       def set_method_for(action)
         self.class.send(:define_method, action) do |id, entity_id, params={}|
-          request_and_build_response(:put, endpoint_for(id, entity_id, action), params)
+          request_and_build_object_response(:put, endpoint_for(id, entity_id, action), params)
         end
       end
+
+      def destroy_many_endpoint(ids, entity_id)
+        "/entities/#{entity_id}/#{resource_key}s?selected_ids=#{ids.join(',')}"
+      end
     end
   end
 end

data/lib/myfinance/resources/financial_transaction.rb

@@ -7,7 +7,7 @@ module Myfinance
       # [API]
       #   Documentation: https://app.myfinance.com.br/docs/api/financial_transactions
       #
-      def find_all(entity_id, deposit_account_id)
+      def find_all(entity_id, deposit_account_id, page = nil)
         #
         # List all financial transactions
         #
@@ -16,7 +16,9 @@ module Myfinance
         #
         #   Documentation: https://app.myfinance.com.br/docs/api/financial_transactions#get_index
         #
-        http.get(path(entity_id, deposit_account_id), body: {}) do |response|
+        fts_path = index_path(entity_id, deposit_account_id, page)
+
+        http.get(fts_path, body: {}) do |response|
           respond_with_collection(response)
         end       
       end
@@ -97,10 +99,19 @@ module Myfinance
 
       private
 
+      def index_path(entity_id, deposit_account_id, page)
+        return paginated_path(entity_id, deposit_account_id, page) if page
+        path(entity_id, deposit_account_id)
+      end
+
       def path(entity_id, deposit_account_id)
         "/entities/#{entity_id}/deposit_accounts/#{deposit_account_id}/financial_transactions"
       end
 
+      def paginated_path(entity_id, deposit_account_id, page)
+        "/entities/#{entity_id}/deposit_accounts/#{deposit_account_id}/financial_transactions?page=#{page}"
+      end
+
       def destroy_many_path(entity_id, deposit_account_id, ids)
         path(entity_id, deposit_account_id) + "/destroy_many?selected_ids=#{ids.join(",")}"
       end