myfinance 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cc4a1064aa43f5ea804054f28615cca76b55736
-  data.tar.gz: 6c1865d21fb91219abcfd059ad6e7f90dccdc3d4
+  metadata.gz: f7d232896f250a7b2c78111a9fd498491e38be7e
+  data.tar.gz: 6ea40361789ab7210fae8e0fda62e2f04fe3d0b1
 SHA512:
-  metadata.gz: 2697a1a00cb82c86a0c0f0a1737e4179eb05b10ffd42740a2e70aa0c3d23c2e734593d881e76baf6506d96a3e4429b1e723a1f1b9cf48b972191e871b35a5c0c
-  data.tar.gz: c4ed5d1bf31c386dca979788f458aa4e4e86ec4f46dffb959c601767ffc94bb914347125f37c11555c8aa7cb89445559f433f12fb1fb69fdf8705894a49576c7
+  metadata.gz: 7d4096f7fd67ec4da65075b7f6e76bc93ef2bfb4495e46140a6a91d99550a82c398bf6fd1445cf172804bcc82fc6cff09cbe9d5e26f9587fb6c664607b05cda4
+  data.tar.gz: 1d72e21517c1aabc1030c77c0486776d36a1ac8c394fa100e5714e37c1cf1001b93f8343f8402666b7f8b9d2839399b46ee6f4930a4f9c801c97bfe7a7979ae6

data/.rubocop.yml

@@ -231,9 +231,10 @@ Metrics/CyclomaticComplexity:
   Enabled: true
 
 Metrics/LineLength:
-  Description: 'Limit lines to 80 characters.'
+  Description: 'Limit lines to 120 characters.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
-  Enabled: false
+  Enabled: true
+  Max: 120
 
 Metrics/MethodLength:
   Description: 'Avoid methods longer than 30 lines of code.'

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## v1.0.0
+
+### New Endpoints
+- Add Bank Statements endpoints
+- Add Categories endpoints
+- Add Credit Cards endpoints
+- Add Credit Cards Transactions endpoints
+- Add Reconciles endpoints
+- More endpoints for Financial Accounts (`find_all`, `find`)
+### Improvements
+- Implement search by attributes in Categories
+###  Deprecations
+- `FinancialAccount#destroy` and `#update` signatures are now `(entity_id, id, params)` instead of `(id, entity_id, params)`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    myfinance (0.7.0)
+    myfinance (1.0.0)
       mime-types (~> 2.99)
       multi_json (~> 1.11)
       typhoeus (~> 0.8)

data/README.md

@@ -25,6 +25,19 @@ Or install it yourself as:
 
     $ gem install myfinance
 
+## Configuration
+
+Use `Myfinance.configure` to setup your environment:
+
+```ruby
+require 'myfinance'
+
+Myfinance.configure do |config|
+  config.url = 'https://sandbox.myfinance.com.br' # defaults to 'https://app.myfinance.com.br'
+  config.user_agent = 'My App v1.0' # optional, but you should pass a custom user-agent identifying your app
+end
+```
+
 ## Usage
 
 ##### Given your token, create an instance of Myfinance::Client, as below:
@@ -47,6 +60,10 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
 * [People API](https://app.myfinance.com.br/docs/api/people) as `client.people`
 * [Webhooks API](https://app.myfinance.com.br/docs/api/webhooks) as `client.webhooks`
 * [Taxes API](https://app.myfinance.com.br/docs/api/taxes) as `client.taxes`
+* [CreditCards API](https://app.myfinance.com.br/docs/api/credit_cards) as `client.credit_cards`
+* [CreditCardsTransactions API](https://app.myfinance.com.br/docs/api/credit_cards_transactions) as `client.credit_cards_transactions`
+* [Reconciles API](https://app.myfinance.com.br/docs/api/reconciles) as `client.reconciles`
+* [BankStatements API](https://app.myfinance.com.br/docs/api/bank_statements) as `client.bank_statements`
 
 ### Endpoints
 
@@ -167,6 +184,30 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
     <th>Endpoint</th>
     <th>Client method</th>
   </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/payable_accounts#get_index" target="_blank">
+        /entities/:entity_id/payable_accounts
+      </a>
+    </td>
+    <td>
+      <code>client.payable_accounts.find_all</code>
+    </td>
+  </tr>
+
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/payable_accounts#get_show" target="_blank">
+        /entities/:entity_id/payable_accounts/:id
+      </a>
+    </td>
+    <td>
+      <code>client.payable_accounts.find</code>
+    </td>
+  </tr>
+
   <tr>
     <td><code>POST</code></td>
     <td>
@@ -222,6 +263,29 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
       <code>client.payable_accounts.destroy</code>
     </td>
   </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/payable_accounts#delete_destroy_as_recurrent" target="_blank">
+        /entities/:entity_id/payable_accounts/:id/recurrence
+      </a>
+    </td>
+    <td>
+      <code>client.payable_accounts.destroy_recurrence</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/payable_accounts#delete_destroy_many" target="_blank">
+        /entities/:entity_id/payable_accounts?selected_ids=:id1,id2,id3
+      </a>
+    </td>
+    <td>
+      <code>client.payable_accounts.destroy_many</code>
+    </td>
+  </tr>
+
 </table>
 
 #### [ReceivableAccounts](https://app.myfinance.com.br/docs/api/receivable_accounts)
@@ -232,6 +296,29 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
     <th>Endpoint</th>
     <th>Client method</th>
   </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/receivable_accounts#get_index" target="_blank">
+        /entities/:entity_id/receivable_accounts
+      </a>
+    </td>
+    <td>
+      <code>client.receivable_accounts.find_all</code>
+    </td>
+  </tr>
+
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/receivable_accounts#get_show" target="_blank">
+        /entities/:entity_id/receivable_accounts/:id
+      </a>
+    </td>
+    <td>
+      <code>client.receivable_accounts.find</code>
+    </td>
+  </tr>
   <tr>
     <td><code>POST</code></td>
     <td>
@@ -287,6 +374,28 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
       <code>client.receivable_accounts.destroy</code>
     </td>
   </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/receivable_accounts#delete_destroy_as_recurrent" target="_blank">
+        /entities/:entity_id/receivable_accounts/:id/recurrence
+      </a>
+    </td>
+    <td>
+      <code>client.receivable_accounts.destroy_recurrence</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/receivable_accounts#delete_destroy_many" target="_blank">
+        /entities/:entity_id/receivable_accounts?selected_ids=:id1,id2,id3
+      </a>
+    </td>
+    <td>
+      <code>client.receivable_accounts.destroy_many</code>
+    </td>
+  </tr>
 </table>
 
 #### [Attachments](https://app.myfinance.com.br/docs/api/attachments)
@@ -743,6 +852,198 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
   </tr>
 </table>
 
+#### [CreditCards](https://app.myfinance.com.br/docs/api/credit_cards)
+<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/credit_cards#get_index" target="_blank">
+        /entities/:entity_id/credit_cards
+      </a>
+    </td>
+    <td>
+      <code>client.credit_cards.find_all</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/credit_cards#get_show" target="_blank">
+        /entities/:entity_id/credit_cards/:id
+      </a>
+    </td>
+    <td>
+      <code>client.credit_cards.find</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>POST</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/credit_cards#post_create" target="_blank">
+        /entities/:entity_id/credit_cards
+      </a>
+    </td>
+    <td>
+      <code>client.credit_cards.create</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>PUT</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/credit_cards#put_update" target="_blank">
+        /entities/:entity_id/credit_cards/:id
+      </a>
+    </td>
+    <td>
+      <code>client.credit_cards.update</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/credit_cards#delete_destroy" target="_blank">
+        /entities/:entity_id/credit_cards/:id
+      </a>
+    </td>
+    <td>
+      <code>client.credit_cards.destroy</code>
+    </td>
+  </tr>
+</table>
+
+#### [CreditCardTransactions](https://app.myfinance.com.br/docs/api/credit_card_transactions)
+
+<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/credit_card_transactions#get_index" target="_blank">
+        /entities/:entity_id/credit_cards/:credit_card_id/transactions
+      </a>
+    </td>
+    <td>
+      <code>client.credit_card_transactions.find_all</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/credit_card_transactions#get_show" target="_blank">
+        /entities/:entity_id/credit_cards/:credit_card_id/transactions/:id
+      </a>
+    </td>
+    <td>
+      <code>client.credit_card_transactions.find</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>POST</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/credit_card_transactions#post_create" target="_blank">
+        /entities/:entity_id/credit_cards/:credit_card_id/transactions
+      </a>
+    </td>
+    <td>
+      <code>client.credit_card_transactions.create</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>PUT</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/credit_card_transactions#put_update" target="_blank">
+        /entities/:entity_id/credit_cards/:credit_card_id/transactions/:id
+      </a>
+    </td>
+    <td>
+      <code>client.credit_card_transactions.update</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/credit_card_transactions#delete_destroy" target="_blank">
+        /entities/:entity_id/credit_cards/:credit_card_id/transactions/:id
+      </a>
+    </td>
+    <td>
+      <code>client.credit_card_transactions.destroy</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/credit_card_transactions#delete_destroy_parcelled" target="_blank">
+        /entities/:entity_id/credit_cards/:credit_card_id/transactions/:id/recurrence
+      </a>
+    </td>
+    <td>
+      <code>client.credit_card_transactions.destroy_parcelled</code>
+    </td>
+  </tr>
+</table>
+
+#### [Reconciles](https://app.myfinance.com.br/docs/api/reconciles)
+
+<table>
+  <tr>
+    <th>HTTP method</th>
+    <th>Endpoint</th>
+    <th>Client method</th>
+  </tr>
+  <tr>
+    <td><code>POST</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/reconciles#post_reconciles" target="_blank">
+        /entities/:entity_id/reconciles
+      </a>
+    </td>
+    <td>
+      <code>client.reconciles.reconcile</code>
+    </td>
+  </tr>
+</table>
+
+#### [BankStatements](https://app.myfinance.com.br/docs/api/bank_statements)
+<table>
+  <tr>
+    <th>HTTP method</th>
+    <th>Endpoint</th>
+    <th>Client method</th>
+  </tr>
+  <tr>
+    <td><code>POST</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/bank_statements" target="_blank">
+        /entities/:entity_id/deposit_accounts/:deposit_account_id/bank_statements
+      </a>
+    </td>
+    <td>
+      <code>client.bank_statements.import</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/bank_statements" target="_blank">
+        /entities/:entity_id/deposit_accounts/:deposit_account_id/bank_statements/:id
+      </a>
+    </td>
+    <td>
+      <code>client.bank_statements.status</code>
+    </td>
+  </tr>
+</table>
+
 ### Configuration
 
 ```ruby
@@ -778,7 +1079,9 @@ end
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `lib/myfinance/version.rb`, run `bundle install` and commit & push the changes to the repository. Then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). Make sure you have publishing rights for the gem on RubyGems beforehand, though.
 
 ## Contributing
 

data/lib/myfinance.rb

@@ -16,7 +16,9 @@ require "myfinance/entities/financial_transaction"
 require "myfinance/entities/financial_transaction_collection"
 require "myfinance/entities/financial_account"
 require "myfinance/entities/payable_account"
+require "myfinance/entities/payable_account_collection"
 require "myfinance/entities/receivable_account"
+require "myfinance/entities/receivable_account_collection"
 require "myfinance/entities/attachment"
 require "myfinance/entities/classification_center"
 require "myfinance/entities/classification_center_collection"
@@ -32,6 +34,12 @@ require "myfinance/entities/webhook"
 require "myfinance/entities/webhook_collection"
 require "myfinance/entities/tax"
 require "myfinance/entities/tax_collection"
+require "myfinance/entities/credit_card"
+require "myfinance/entities/credit_card_collection"
+require "myfinance/entities/credit_card_transaction"
+require "myfinance/entities/credit_card_transaction_collection"
+require "myfinance/entities/reconcile_collection"
+require "myfinance/entities/bank_statement"
 
 require "myfinance/resources/base"
 require "myfinance/resources/entity"
@@ -47,6 +55,10 @@ require "myfinance/resources/deposit_account"
 require "myfinance/resources/person"
 require "myfinance/resources/webhook"
 require "myfinance/resources/tax"
+require "myfinance/resources/credit_card"
+require "myfinance/resources/credit_card_transaction"
+require "myfinance/resources/reconcile"
+require "myfinance/resources/bank_statement"
 
 module Myfinance
   def self.configuration

data/lib/myfinance/client.rb

@@ -63,5 +63,21 @@ module Myfinance
     def taxes
       Myfinance::Resources::Tax.new(http)
     end
+
+    def credit_cards
+      Myfinance::Resources::CreditCard.new(http)
+    end
+
+    def credit_card_transactions
+      Myfinance::Resources::CreditCardTransaction.new(http)
+    end
+
+    def reconciles
+      Myfinance::Resources::Reconcile.new(http)
+    end
+
+    def bank_statements
+      Myfinance::Resources::BankStatement.new(http)
+    end
   end
 end