myfinance 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec920463cf5999546a46af9d396ecf921a6ff371
-  data.tar.gz: a1ab1557e5e85a10689c011fd349ea1993448d3b
+  metadata.gz: 589e8dda000cd743433879d1fc4d1055347b167c
+  data.tar.gz: 157ffd66f873d623ebcc00a20124272c0b191d43
 SHA512:
-  metadata.gz: 5017df20951a4193830850c3a87b04f3fba16bd3599f2e9dd1c3797bf4bd5d54e81f50b1281d71760f93bee217ebe3d8de8bb3a0eef81b4274c068d0d8eea30d
-  data.tar.gz: 97223a355291502fae10e73cf81fb60f3b7996c27ba90f417686aed704b016a6111d77259943b8d634050bc4506964075c22db79e81db4697ba36ea471385b83
+  metadata.gz: 2bec2de68fc39a90ac6e916db7e2b4ee2eab79e062de0ed7a3c2d25a3196fdc623c8f4bc4aa4698dc9765ef2b5d157a00a980d1e52f6cc35d284661f72da9bb5
+  data.tar.gz: 3abcdac4f99c38b63a4cd596ff7e5b6c7f3035d84ed0e90067efaac355ccc5eb380f32106165da7481661025f95aa9cb0cb6037d9054fe6792f6f50fea58286f

data/CHANGELOG.md

@@ -1,7 +1,13 @@
 # Changelog
+## v1.5.0
+### New Endpoints
+- Add endpoints for `CustomClassifier` and `CustomClassifierValue`
+### New Attributes
+- `CreditCard`, `CreditCardTransaction`, `FinancialAccount`, `FinancialTransaction`, `Sale` and `SaleAccount`
+now respond_to `custom_classifications`
 ## v1.4.1
 - In v1.4.0 we broke the API by renaming `financial_account_taxes_attributes` to `tax_charges_attributes`.
-We add `financial_account_taxes_attributes` back. Both can be used for the same purpose.
+We added `financial_account_taxes_attributes` back. Both can be used for the same purpose.
 - We also renamed `tax_charges_attributes` to `tax_charges` as an effort to move away from the `_attributes` suffix.
 ## v1.4.0
 ### New attributes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    myfinance (1.4.1)
+    myfinance (1.5.0)
       mime-types (~> 2.99)
       multi_json (~> 1.11)
       require_all (~> 1.4.0)
@@ -97,4 +97,4 @@ DEPENDENCIES
   webmock (~> 1.9.3)
 
 BUNDLED WITH
-   1.15.1
+   1.15.2

data/README.md

@@ -67,6 +67,8 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
 * [Sales API](https://app.myfinance.com.br/docs/api/sales) as `client.sales`
 * [SaleAccounts API](https://app.myfinance.com.br/docs/api/sale_accounts) as `client.sale_accounts`
 * [SaleRules API](https://app.myfinance.com.br/docs/api/sale_rules) as `client.sale_rules`
+* [CustomClassifiers API](https://app.myfinance.com.br/docs/api/custom_classifiers) as `client.custom_classifiers`
+* [CustomClassifierValues API](https://app.myfinance.com.br/docs/api/custom_classifier_values) as `client.custom_classifier_values`
 
 ### Endpoints
 
@@ -1221,6 +1223,135 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
   </tr>
 </table>
 
+#### [CustomClassifiers](https://app.myfinance.com.br/docs/api/custom_classifiers)
+
+<table>
+  <tr>
+    <th>HTTP method</th>
+    <th>Endpoint</th>
+    <th>Client method</th>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/custom_classifiers#get_index" target="_blank">
+        /custom_classifiers
+      </a>
+    </td>
+    <td>
+      <code>client.custom_classifiers.find_all</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/custom_classifiers#get_show" target="_blank">
+        /custom_classifiers/:id
+      </a>
+    </td>
+    <td>
+      <code>client.custom_classifiers.find</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>POST</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/custom_classifiers#post_create" target="_blank">
+        /custom_classifiers
+      </a>
+    </td>
+    <td>
+      <code>client.custom_classifiers.create</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>PUT</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/custom_classifiers#put_update" target="_blank">
+        /custom_classifiers/:id
+      </a>
+    </td>
+    <td>
+      <code>client.custom_classifiers.update</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/custom_classifiers#delete_destroy" target="_blank">
+        /custom_classifiers/:id
+      </a>
+    </td>
+    <td>
+      <code>client.custom_classifiers.destroy</code>
+    </td>
+  </tr>
+</table>
+
+#### [CustomClassifierValues](https://app.myfinance.com.br/docs/api/custom_classifier_values)
+
+<table>
+  <tr>
+    <th>HTTP method</th>
+    <th>Endpoint</th>
+    <th>Client method</th>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/custom_classifier_values#get_index" target="_blank">
+        /custom_classifiers/:custom_classifier_value_id/values
+      </a>
+    </td>
+    <td>
+      <code>client.custom_classifier_values.find_all</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/custom_classifier_values#get_show" target="_blank">
+        /custom_classifiers/:custom_classifier_value_id/values/:id
+      </a>
+    </td>
+    <td>
+      <code>client.custom_classifier_values.find</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>POST</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/custom_classifier_values#post_create" target="_blank">
+        /custom_classifiers/:custom_classifier_value_id/values
+      </a>
+    </td>
+    <td>
+      <code>client.custom_classifier_values.create</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>PUT</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/custom_classifier_values#put_update" target="_blank">
+        /custom_classifiers/:custom_classifier_value_id/values/:id
+      </a>
+    </td>
+    <td>
+      <code>client.custom_classifier_values.update</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/custom_classifier_values#delete_destroy" target="_blank">
+        /custom_classifiers/:custom_classifier_value_id/values/:id
+      </a>
+    </td>
+    <td>
+      <code>client.custom_classifier_values.destroy</code>
+    </td>
+  </tr>
+</table>
 
 ### Configuration
 

data/lib/myfinance/client.rb

@@ -91,5 +91,13 @@ module Myfinance
     def sale_rules
       Myfinance::Resources::SaleRule.new(http)
     end
+
+    def custom_classifiers
+      Myfinance::Resources::CustomClassifier.new(http)
+    end
+
+    def custom_classifier_values
+      Myfinance::Resources::CustomClassifierValue.new(http)
+    end
   end
 end

data/lib/myfinance/entities/credit_card.rb

@@ -7,6 +7,7 @@ module Myfinance
       attribute :classification_center_id, Integer
       attribute :category_id, Integer
       attribute :closing_day, Integer
+      attribute :custom_classifications, Array[Hash]
       attribute :expiration_day, Integer
       attribute :name, String
       attribute :flag, String

data/lib/myfinance/entities/credit_card_transaction.rb

@@ -6,6 +6,7 @@ module Myfinance
       attribute :credit_card_id, Integer
       attribute :classification_center_id, Integer
       attribute :category_id, Integer
+      attribute :custom_classifications, Array[Hash]
       attribute :amount, Decimal
       attribute :description, String
       attribute :occurred_at, Date

data/lib/myfinance/entities/custom_classifier.rb

@@ -0,0 +1,11 @@
+module Myfinance
+  module Entities
+    class CustomClassifier < Base
+      attribute :account_id, Integer
+      attribute :id, Integer
+      attribute :name, String
+      attribute :updated_at, DateTime
+      attribute :created_at, DateTime
+    end
+  end
+end

data/lib/myfinance/entities/custom_classifier_collection.rb

@@ -0,0 +1,16 @@
+module Myfinance
+  module Entities
+    #
+    # A wrapper to Myfinance custom_classifiers collection
+    #
+    class CustomClassifierCollection < Collection
+      def build_collection
+        response.parsed_body.each do |attributes|
+          collection.push(
+            Myfinance::Entities::CustomClassifier.new(attributes["custom_classifier"])
+          )
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/entities/custom_classifier_value.rb

@@ -0,0 +1,11 @@
+module Myfinance
+  module Entities
+    class CustomClassifierValue < Base
+      attribute :custom_classifier_id, Integer
+      attribute :id, Integer
+      attribute :value, String
+      attribute :updated_at, DateTime
+      attribute :created_at, DateTime
+    end
+  end
+end

data/lib/myfinance/entities/custom_classifier_value_collection.rb

@@ -0,0 +1,16 @@
+module Myfinance
+  module Entities
+    #
+    # A wrapper to Myfinance custom_classifiers collection
+    #
+    class CustomClassifierValueCollection < Collection
+      def build_collection
+        response.parsed_body.each do |attributes|
+          collection.push(
+            Myfinance::Entities::CustomClassifierValue.new(attributes["custom_classifier_value"])
+          )
+        end
+      end
+    end
+  end
+end

data/lib/myfinance/entities/financial_account.rb

@@ -24,6 +24,7 @@ module Myfinance
 
       attribute :tax_charges, Array[Hash]
       attribute :financial_account_taxes_attributes, Array[Hash]
+      attribute :custom_classifications, Array[Hash]
       attribute :reconciliations, Hash[String => Array]
       attribute :links, Array[Hash[String => String]]
     end

data/lib/myfinance/entities/financial_transaction.rb

@@ -8,6 +8,7 @@ module Myfinance
       attribute :owner_id, Integer
       attribute :currency_id, Integer
       attribute :category_id, Integer
+      attribute :custom_classifications, Array[Hash]
       attribute :type, String
       attribute :occurred_at, Date
       attribute :document, String

data/lib/myfinance/entities/sale.rb

@@ -8,7 +8,6 @@ module Myfinance
       attribute :confirmed_at
       attribute :created_at
       attribute :custom_classifications
-      attribute :custom_classifications
       attribute :days_to_liquidation
       attribute :description
       attribute :discount_amount

data/lib/myfinance/resources/custom_classifier.rb

@@ -0,0 +1,83 @@
+module Myfinance
+  module Resources
+    class CustomClassifier < Base
+      #
+      # List all custom classifiers
+      #
+      # [API]
+      #   Method: <tt>GET /custom_classifiers</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/custom_classifiers#get_index
+      #
+      def find_all(params = {})
+        search_endpoint = build_search_endpoint(params)
+
+        http.get(search_endpoint) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      #
+      # Find a custom classifier
+      #
+      # [API]
+      #   Method: <tt>GET /custom_classifiers/:id</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/custom_classifiers#get_show
+      #
+      def find(id)
+        http.get("/custom_classifiers/#{id}", body: {}) do |response|
+          respond_with_object response, "custom_classifier"
+        end
+      end
+
+      #
+      # Creates a custom classifier
+      #
+      # [API]
+      #   Method: <tt>POST /custom_classifiers</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/custom_classifiers#post_create
+      #
+      def create(params)
+        http.post("/custom_classifiers", body: { custom_classifier: params }) do |response|
+          respond_with_object response, "custom_classifier"
+        end
+      end
+
+      #
+      # Updates a custom classifier
+      #
+      # [API]
+      #   Method: <tt>PUT /custom_classifiers/:id</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/custom_classifiers#put_update
+      #
+      def update(id, params = {})
+        http.put("/custom_classifiers/#{id}", body: { custom_classifier: params }) do |response|
+          respond_with_object response, "custom_classifier"
+        end
+      end
+
+      #
+      # Destroy a custom_classifier
+      #
+      # [API]
+      #   Method: <tt>DELETE /custom_classifiers/:id</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/custom_classifiers#delete_destroy
+      #
+      def destroy(id)
+        http.delete("/custom_classifiers/#{id}", body: {}) do |response|
+          respond_with_object response, "custom_classifier"
+        end
+      end
+
+      private
+
+      def endpoint
+        "/custom_classifiers"
+      end
+    end
+  end
+end

data/lib/myfinance/resources/custom_classifier_value.rb

@@ -0,0 +1,92 @@
+module Myfinance
+  module Resources
+    class CustomClassifierValue < Base
+      #
+      # List all custom classifier values
+      #
+      # [API]
+      #   Method: <tt>GET /custom_classifiers/:custom_classifier_id/values</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/custom_classifier_values#get_index
+      #
+      def find_all(custom_classifier_id, params = {})
+        search_endpoint = build_search_endpoint(custom_classifier_id, params)
+
+        http.get(search_endpoint) do |response|
+          respond_with_collection(response)
+        end
+      end
+
+      #
+      # Find a custom classifier value
+      #
+      # [API]
+      #   Method: <tt>GET /custom_classifiers/:custom_classifier_id/values/:id</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/custom_classifier_values#get_show
+      #
+      def find(custom_classifier_id, id)
+        http.get("/custom_classifiers/#{custom_classifier_id}/values/#{id}", body: {}) do |response|
+          respond_with_object(response, "custom_classifier_value")
+        end
+      end
+
+      #
+      # Creates a custom classifier value
+      #
+      # [API]
+      #   Method: <tt>POST /custom_classifiers/:custom_classifier_id/values</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/custom_classifiers#post_create
+      #
+      def create(custom_classifier_id, params)
+        body = { custom_classifier_value: params }
+        http.post("/custom_classifiers/#{custom_classifier_id}/values", body: body) do |response|
+          respond_with_object(response, "custom_classifier_value")
+        end
+      end
+
+      #
+      # Updates a custom classifier value
+      #
+      # [API]
+      #   Method: <tt>PUT /custom_classifiers/:custom_classifier_id/values/:id</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/custom_classifiers#put_update
+      #
+      def update(custom_classifier_id, id, params = {})
+        body = { custom_classifier_value: params }
+        http.put("/custom_classifiers/#{custom_classifier_id}/values/#{id}", body: body) do |response|
+          respond_with_object(response, "custom_classifier_value")
+        end
+      end
+
+      #
+      # Destroy a custom classifier value
+      #
+      # [API]
+      #   Method: <tt>DELETE /custom_classifiers/:custom_classifier_id/values/:id</tt>
+      #
+      #   Documentation: https://sandbox.myfinance.com.br/docs/api/custom_classifiers#delete_destroy
+      #
+      def destroy(custom_classifier_id, id)
+        http.delete("/custom_classifiers/#{custom_classifier_id}/values/#{id}", body: {}) do |response|
+          respond_with_object(response, "custom_classifier_value")
+        end
+      end
+
+      private
+
+      def build_search_endpoint(custom_classifier_id, params)
+        query_string = query(params).join("&")
+        custom_classifier_endpoint = endpoint(custom_classifier_id)
+
+        URI.encode("#{custom_classifier_endpoint}?#{query_string}")
+      end
+
+      def endpoint(custom_classifier_id)
+        "/custom_classifiers/#{custom_classifier_id}/values"
+      end
+    end
+  end
+end