myfinance 1.2.1 → 1.3.0

data/CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
+## v1.3.0
+### New Endpoints
+- Add endpoints for `Sale`, `SaleAccount` and `SaleRule`
 
 ## v1.2.0
 ### Endpoints improvements

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    myfinance (1.2.1)
+    myfinance (1.3.0)
       mime-types (~> 2.99)
       multi_json (~> 1.11)
+      require_all (~> 1.4.0)
       typhoeus (~> 0.8)
       virtus (~> 1.0.5)
 
@@ -45,6 +46,7 @@ GEM
       pry (>= 0.9.10, < 0.11.0)
     public_suffix (2.0.5)
     rake (10.5.0)
+    require_all (1.4.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)

data/README.md

@@ -64,6 +64,9 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
 * [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`
+* [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`
 
 ### Endpoints
 
@@ -1022,6 +1025,203 @@ client = Myfinance.client("YOUR_TOKEN_HERE")
   </tr>
 </table>
 
+#### [Sales](https://app.myfinance.com.br/docs/api/sales)
+
+<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/sales#get_index" target="_blank">
+        /entities/:entity_id/sales
+      </a>
+    </td>
+    <td>
+      <code>client.sales.find_all</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sales#get_show" target="_blank">
+        /entities/:entity_id/sales/:id
+      </a>
+    </td>
+    <td>
+      <code>client.sales.find</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>POST</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sales#post_create" target="_blank">
+        /entities/:entity_id/sales
+      </a>
+    </td>
+    <td>
+      <code>client.sales.create</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>PUT</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sales#put_update" target="_blank">
+        /entities/:entity_id/sales/:id
+      </a>
+    </td>
+    <td>
+      <code>client.sales.update</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sales#delete_destroy" target="_blank">
+        /entities/:entity_id/sales/:id
+      </a>
+    </td>
+    <td>
+      <code>client.sales.destroy</code>
+    </td>
+  </tr>
+</table>
+
+
+#### [SaleAccounts](https://app.myfinance.com.br/docs/api/sale_accounts)
+
+<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/sale_accounts#get_index" target="_blank">
+        /entities/:entity_id/sale_accounts
+      </a>
+    </td>
+    <td>
+      <code>client.sale_accounts.find_all</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sale_accounts#get_show" target="_blank">
+        /entities/:entity_id/sale_accounts/:id
+      </a>
+    </td>
+    <td>
+      <code>client.sale_accounts.find</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>POST</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sale_accounts#post_create" target="_blank">
+        /entities/:entity_id/sale_accounts
+      </a>
+    </td>
+    <td>
+      <code>client.sale_accounts.create</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>PUT</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sale_accounts#put_update" target="_blank">
+        /entities/:entity_id/sale_accounts/:id
+      </a>
+    </td>
+    <td>
+      <code>client.sale_accounts.update</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sale_accounts#delete_destroy" target="_blank">
+        /entities/:entity_id/sale_accounts/:id
+      </a>
+    </td>
+    <td>
+      <code>client.sale_accounts.destroy</code>
+    </td>
+  </tr>
+</table>
+
+#### [SaleRules](https://app.myfinance.com.br/docs/api/sale_rules)
+
+<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/sale_rules#get_index" target="_blank">
+        /entities/:entity_id/sale_rules
+      </a>
+    </td>
+    <td>
+      <code>client.sale_rules.find_all</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>GET</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sale_rules#get_show" target="_blank">
+        /entities/:entity_id/sale_rules/:id
+      </a>
+    </td>
+    <td>
+      <code>client.sale_rules.find</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>POST</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sale_rules#post_create" target="_blank">
+        /entities/:entity_id/sale_rules
+      </a>
+    </td>
+    <td>
+      <code>client.sale_rules.create</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>PUT</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sale_rules#put_update" target="_blank">
+        /entities/:entity_id/sale_rules/:id
+      </a>
+    </td>
+    <td>
+      <code>client.sale_rules.update</code>
+    </td>
+  </tr>
+  <tr>
+    <td><code>DELETE</code></td>
+    <td>
+      <a href="https://app.myfinance.com.br/docs/api/sale_rules#delete_destroy" target="_blank">
+        /entities/:entity_id/sale_rules/:id
+      </a>
+    </td>
+    <td>
+      <code>client.sale_rules.destroy</code>
+    </td>
+  </tr>
+</table>
+
+
 ### Configuration
 
 ```ruby

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/rspec

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError => e
+  raise unless e.message.include?("spring")
+end
+#
+# This file was generated by Bundler.
+#
+# The application "rspec" is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+                                           Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/myfinance.rb

@@ -1,68 +1,13 @@
 require "typhoeus"
 require "multi_json"
-require 'mime/types'
+require "mime/types"
+require "require_all"
 
-require "myfinance/version"
-require "myfinance/configuration"
-require "myfinance/http"
-require "myfinance/client"
-
-require "myfinance/entities/base"
-require "myfinance/entities/collection"
-require "myfinance/entities/entity"
-require "myfinance/entities/entity_collection"
-require "myfinance/entities/attachment_collection"
-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"
-require "myfinance/entities/category"
-require "myfinance/entities/category_collection"
-require "myfinance/entities/account"
-require "myfinance/entities/account_collection"
-require "myfinance/entities/deposit_account"
-require "myfinance/entities/deposit_account_collection"
-require "myfinance/entities/person"
-require "myfinance/entities/person_collection"
-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"
-require "myfinance/resources/financial_transaction"
-require "myfinance/resources/financial_account"
-require "myfinance/resources/payable_account"
-require "myfinance/resources/receivable_account"
-require "myfinance/resources/attachment"
-require "myfinance/resources/classification_center"
-require "myfinance/resources/category"
-require "myfinance/resources/account"
-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"
+require_all "lib/myfinance"
 
 module Myfinance
   def self.configuration
-    @configuration ||=  Configuration.new
+    @configuration ||= Configuration.new
   end
 
   def self.configure

data/lib/myfinance/client.rb

@@ -43,7 +43,7 @@ module Myfinance
     def categories
       Myfinance::Resources::Category.new(http)
     end
-    
+
     def accounts
       Myfinance::Resources::Account.new(http)
     end
@@ -54,7 +54,7 @@ module Myfinance
 
     def people
       Myfinance::Resources::Person.new(http)
-    end      
+    end
 
     def webhooks
       Myfinance::Resources::Webhook.new(http)
@@ -79,5 +79,17 @@ module Myfinance
     def bank_statements
       Myfinance::Resources::BankStatement.new(http)
     end
+
+    def sales
+      Myfinance::Resources::Sale.new(http)
+    end
+
+    def sale_accounts
+      Myfinance::Resources::SaleAccount.new(http)
+    end
+
+    def sale_rules
+      Myfinance::Resources::SaleRule.new(http)
+    end
   end
 end

data/lib/myfinance/configuration.rb

@@ -1,11 +1,11 @@
-require 'base64'
+require "base64"
 
 module Myfinance
   class Configuration
     attr_accessor :url, :user_agent
 
     def initialize
-      @url = 'https://app.myfinance.com.br'
+      @url = "https://app.myfinance.com.br"
       @user_agent = "Myfinance Ruby Client v#{Myfinance::VERSION}"
     end
   end

data/lib/myfinance/entities/collection.rb

@@ -1,7 +1,9 @@
 module Myfinance
   module Entities
     #
-    # A wrapper to Myfinance collection returns from API. This wrapper represents a collection and it's responsible for processing pagination information as well.
+    # A wrapper to Myfinance collection returns from API.
+    # This wrapper represents a collection and it's responsible for
+    # processing pagination information as well.
     #
     class Collection < Base
       PAGE_REGEX = /page=(\d+)/
@@ -11,11 +13,15 @@ module Myfinance
       def initialize(response)
         @response = response
         @collection = []
-        @headers = response.headers['Link'].split(',') rescue []
+        @headers = begin
+                     response.headers["Link"].split(",")
+                   rescue
+                     []
+                   end
       end
 
       def self.build(response)
-        self.new(response).build
+        new(response).build
       end
 
       def build
@@ -42,11 +48,13 @@ module Myfinance
       private
 
       def page_for(page_rel)
-        header_link_for(page_rel).match(PAGE_REGEX)[1].to_i rescue nil
+        header_link_for(page_rel).match(PAGE_REGEX)[1].to_i
+      rescue
+        nil
       end
 
       def header_link_for(rel)
-        headers.select{|n| n =~ /rel=#{rel}/}.first
+        headers.select { |n| n =~ /rel=#{rel}/ }.first
       end
 
       def build_collection

data/lib/myfinance/entities/sale.rb

@@ -0,0 +1,32 @@
+module Myfinance
+  module Entities
+    class Sale < Base
+      attribute :id
+      attribute :nominal_amount
+      attribute :receivable_amount
+      attribute :fixed_fee_amount
+      attribute :fee_percentage
+      attribute :fee_percentage_amount
+      attribute :issuer
+      attribute :payment_method
+      attribute :status
+      attribute :summary
+      attribute :description
+      attribute :observation
+      attribute :category_id
+      attribute :classification_center_id
+      attribute :person_id
+      attribute :days_to_liquidation
+      attribute :sale_account_id
+      attribute :financial_account_id
+      attribute :liquidation_week_day
+      attribute :estimated_liquidated_at
+      attribute :liquidated_at
+      attribute :occurred_at
+      attribute :confirmed_at
+      attribute :created_at
+      attribute :updated_at
+      attribute :custom_classifications
+    end
+  end
+end