quaderno 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c06a424989f613db0191cce31b7acd854b4ba01f
-  data.tar.gz: 3075394c13a2add9a27ef1a9e969d0cf4c820100
+SHA256:
+  metadata.gz: 80ac06b981bcae525ea523aef71452980fba4a7e36bb8beec9bb72b8d3831d5f
+  data.tar.gz: 7130b682ec295ef787559cca17c3a55e7fc7f0343fc6170c25d92ef4d41eb029
 SHA512:
-  metadata.gz: 9e6f8fe0b4bfb388386c2e5eaf5bb4d14af6099a868ea9f3db2309024c7896af5eae823d63adde5c7818cb6ba46d38376f63cac3c26c7a5b8cffeea5a3d91eac
-  data.tar.gz: 4b66fcebba6da2b411b9f249a2bffd809a5857ea16ed4c5ea261028de7f219ad672d787b64a90cb1a84f175c3b8935969246cc72d8fe3432b314d94bfdb883c5
+  metadata.gz: f61d7417b9928b2ebd192a3e113c67b5bc53447049798dfbb4c5bc206a6b1b9968be0245f32a2bc1f684447a076804bf3ff46b0c9c4b231a116702fae221e45d
+  data.tar.gz: c85c55d68a167a7a318d80e054b41ad5d21e64806bf55475a9a118ab9ae1e1add30ddbeac881a420e5d60e22fa83a48d0c89c43c19b9292755a5bc215f26d31a

data/README.md

@@ -2,7 +2,7 @@
 
 Quaderno-ruby is a ruby wrapper for [Quaderno API] (https://github.com/quaderno/quaderno-api).
 
-Current version is 1.16.0 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
+Current version is 1.17.0 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
 
 ## Installation & Configuration
 
@@ -29,8 +29,8 @@ To configure just add this to your initializers
 You can get your account subdomain by grabbing it from your account url or by calling the authorization method with your personal api token.
 
 ```ruby
-  Quaderno::Base.authorization 'my_authenticate_token', environment
-  # => {"identity"=>{"id"=>737000, "name"=>"Walter White", "email"=>"cooking@br.bd", "href"=>"https://my_subdomain.quadernoapp.com/api/"}}
+  response = Quaderno::Base.authorization 'my_authenticate_token', environment #=> Quaderno::Base
+  response.identity # => {"id"=>737000, "name"=>"Walter White", "email"=>"cooking@br.bd", "href"=>"https://my_subdomain.quadernoapp.com/api/"}
 ```
 
 `environment` is an optional argument. By passing `:sandbox`, you will retrieve your credentials for the sandbox environment and not for production.
@@ -41,19 +41,48 @@ This will return a hash with the information about your api url, which includes
  You can ping the service in order to check if it is up with:
 
 ```ruby
-  Quaderno::Base.ping #=> Boolean
+  response = Quaderno::Base.ping #=> Quaderno::Base
+
+  response.status #=> Boolean
 ```
 
-This will return true if the service is up or false if it is not.
+This will return `status: true` if the service is up or `status: false` if it is not.
 
 ## Check the rate limit
 
 ```ruby
-  Quaderno::Base.rate_limit_info #=>  {:reset=>4, :remaining=>0}
+  response = Quaderno::Base.ping #=> Quaderno::Base
+  response.rate_limit_info #=>  { :reset=> 4, :remaining=> 0 }
+
 ```
 
 This will return a hash with information about the seconds until the rate limit reset and your remaining requests per minute ([check the API documentation for more information](https://github.com/quaderno/quaderno-api#rate-limiting)).
 
+You can also check the rate limit for each request by checking the `rate_limit_info` method on the response:
+
+```ruby
+
+  invoices = Quaderno::Invoice.all #=> Quaderno::Collection
+  invoices.rate_limit_info #=> {:reset=> 5, :remaning=>6}
+
+  invoice = Quaderno::Invoice.find INVOICE_ID #=> Quaderno::Invoice
+  invoice.rate_limit_info #=> {:reset=>4, :remaining=>5}
+
+  result = invoice.deliver #=> Quaderno::Base
+  result.rate_limit_info #=> {:reset=>3, :remaining=>4}
+
+  begin
+    deleted_invoice = Quaderno::Invoice.delete(ANOTHER_INVOICE_ID) #=> Quaderno::Invoice
+  rescue Quaderno::Exceptions::InvalidSubdomainOrToken => e
+    # If the exception is triggered you can check the rate limit on the raised exception
+    e.rate_limit_info #=> {:reset=>2, :remaining=>3}
+  end
+
+  deleted_invoice.rate_limit_info #=> {:reset=>2, :remaining=>3}
+
+  # etc.
+```
+
 ## Reading the values
 
 Quaderno-ruby parses all the json responses in human readable data, so you can access each value just like this:
@@ -69,7 +98,7 @@ Quaderno-ruby parses all the json responses in human readable data, so you can a
 
 ### Getting contacts
 ```ruby
- Quaderno::Contact.all() #=> Array
+ Quaderno::Contact.all #=> Array
  Quaderno::Contact.all(page: 1) #=> Array
 ```
 
@@ -111,16 +140,16 @@ will update the specified contact with the data of the hash passed as second par
 
 ### Deleting a contact
 ```ruby
-  Quaderno::Contact.delete(id) #=> Boolean
+  Quaderno::Contact.delete(id) #=> Quaderno::Contact
 ```
 
-will delete the contact with the id passed as parameter.
+will delete the contact with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Contact` with the `deleted` attribute set to `true` will be returned.
 
 ## Managing items
 
 ### Getting items
 ```ruby
-  Quaderno::Item.all() #=> Array
+  Quaderno::Item.all #=> Array
 ```
 
 will return an array with all your items.
@@ -148,10 +177,10 @@ will update the specified item with the data of the hash passed as second parame
 
 ### Deleting an item
 ```ruby
-  Quaderno::Item.delete(id) #=> Boolean
+  Quaderno::Item.delete(id) #=> Quaderno::Item
 ```
 
-will delete the item with the id passed as parameter.
+will delete the item with the id passed as parameter.  If the deletion was successful, an instance of `Quaderno::Item` with the `deleted` attribute set to `true` will be returned.
 
 
 ## Managing invoices
@@ -196,10 +225,10 @@ will update the specified invoice with the data of the hash passed as second par
 ### Deleting an invoice
 
 ```ruby
-  Quaderno::Invoice.delete(id) #=> Boolean
+  Quaderno::Invoice.delete(id) #=> Quaderno::Invoice
 ```
 
-will delete the invoice with the id passed as parameter.
+will delete the invoice with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Item` with the `deleted` attribute set to `true` will be returned.
 
 
 ###Adding or removing a payment
@@ -219,13 +248,15 @@ In order to  remove a payment you will need the Invoice instance you want to upd
   invoice.remove_payment(payment_id) #=> Boolean
 ```
 
-###Delivering the invoice
+### Delivering the invoice
 
   In order to deliver the invoice to the default recipient you will need the invoice you want to send.
 
 ```ruby
   invoice = Quaderno::Invoice.find(invoice_id)
-  invoice.deliver
+  result = invoice.deliver #=> Quaderno::Base
+
+  result.success #=> Boolean
 ```
 
 ## Managing receipts
@@ -263,18 +294,20 @@ will update the specified receipt with the data of the hash passed as second par
 ### Deleting an receipt
 
 ```ruby
-  Quaderno::Receipt.delete(id) #=> Boolean
+  Quaderno::Receipt.delete(id) #=> Quaderno::Receipt
 ```
 
-will delete the receipt with the id passed as parameter.
+will delete the receipt with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Receipt` with the `deleted` attribute set to `true` will be returned.
 
-###Delivering the receipt
+### Delivering the receipt
 
   In order to deliver the receipt to the default recipient you will need the receipt you want to send.
 
 ```ruby
   receipt = Quaderno::Receipt.find(receipt_id)
-  receipt.deliver
+  result = receipt.deliver #=> Quaderno::Base
+
+  result.success #=> Boolean
 ```
 
 
@@ -319,13 +352,13 @@ will update the specified credit with the data of the hash passed as second para
 ### Deleting a credit
 
 ```ruby
-  Quaderno::Credit.delete(id) #=> Boolean
+  Quaderno::Credit.delete(id) #=> Quaderno::Credit
 ```
 
-will delete the credit with the id passed as parameter.
+will delete the credit with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Credit` with the `deleted` attribute set to `true` will be returned.
 
 
-###Adding or removing a payment
+### Adding or removing a payment
  In order to  add a payment you will need the Credit instance you want to update.
 
 ```ruby
@@ -339,16 +372,20 @@ In order to  remove a payment you will need the Credit instance you want to upda
 
 ```ruby
   credit = Quaderno::Credit.find(credit_id)
-  credit.remove_payment(payment_id) #=> Boolean
+  credit.remove_payment(payment_id) #=> Quaderno::Payment
 ```
 
-###Delivering the credit
+If the deletion was successful, an instance of `Quaderno::Payment` with the `deleted` attribute set to `true` will be returned.
+
+### Delivering the credit
 
   In order to deliver the credit to the default recipient you will need the credit you want to send.
 
 ```ruby
   credit = Quaderno::Credit.find(credit_id)
-  credit.deliver
+  result = credit.deliver #=> Quaderno::Base
+
+  result.success #=> Boolean
 ```
 
 
@@ -357,7 +394,7 @@ In order to  remove a payment you will need the Credit instance you want to upda
 
 ### Getting estimates
 ```ruby
-  Quaderno::Estimate.all() #=> Array
+  Quaderno::Estimate.all #=> Array
   Quaderno::Estimate.all(page: 1) #=> Array
 ```
 
@@ -388,10 +425,10 @@ will update the specified estimate with the data of the hash passed as second pa
 ### Deleting an estimate
 
 ```ruby
-  Quaderno::Estimate.delete(id) #=> Boolean
+  Quaderno::Estimate.delete(id) #=> Quaderno::Estimate
 ```
 
-will delete the estimate with the id passed as parameter.
+will delete the estimate with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Contact` with the `deleted` attribute set to `true` will be returned.
 
 
 ###Adding or removing a payment
@@ -411,12 +448,14 @@ In order to  remove a payment you will need the estimate you want to update.
   estimate.remove_payment(payment_id) #=> Boolean
 ```
 
-###Delivering the estimate
+### Delivering the estimate
   In order to deliver the estimate to the default recipient you will need the estimate you want to send.
 
 ```ruby
   estimate = Quaderno::Estimate.find(estimate_id)
-  estimate.deliver
+  result = estimate.deliver #=> Quaderno::Base
+
+  result.success #=> Boolean
 ```
 
 
@@ -424,7 +463,7 @@ In order to  remove a payment you will need the estimate you want to update.
 
 ### Getting expenses
 ```ruby
- Quaderno::Expense.all() #=> Array
+ Quaderno::Expense.all #=> Array
  Quaderno::Expense.all(page: 1) #=> Array
 ```
 
@@ -453,10 +492,10 @@ will update the specified expense with the data of the hash passed as second par
 
 ### Deleting an expense
 ```ruby
-  Quaderno::Expense.delete(id) #=> Boolean
+  Quaderno::Expense.delete(id) #=> Quaderno::Expense
 ```
 
-will delete the expense with the id passed as parameter.
+will delete the expense with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Expense` with the `deleted` attribute set to `true` will be returned.
 
 
 ## Managing recurrings
@@ -494,17 +533,17 @@ will update the specified recurring with the data of the hash passed as second p
 ### Deleting a recurring
 
 ```ruby
-  Quaderno::Recurring.delete(id) #=> Boolean
+  Quaderno::Recurring.delete(id) #=> Quaderno::Recurring
 ```
 
-will delete the recurring with the id passed as parameter.
+will delete the recurring with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Recurring` with the `deleted` attribute set to `true` will be returned.
 
 
 ## Managing webhooks
 
 ### Getting webhooks
 ```ruby
- Quaderno::Webhook.all() #=> Array
+ Quaderno::Webhook.all #=> Array
 ```
 
  will return an array with all the webhooks you have subscribed.
@@ -532,9 +571,9 @@ will update the specified webhook with the data of the hash passed as second par
 
 ### Deleting a webhook
 ```ruby
-  Quaderno::Webhook.delete(id) #=> Boolean
+  Quaderno::Webhook.delete(id) #=> Quaderno::Webhook
 ```
-will delete the webhook with the id passed as parameter.
+will delete the webhook with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::Webhook` with the `deleted` attribute set to `true` will be returned.
 
 
 ## Taxes
@@ -548,10 +587,12 @@ will calculate the taxes applied for a customer based on the data pased as param
 
 ### Validate VAT numbers
 ```ruby
-country = 'IE'
-vat_number = 'IE6388047V'
+ country = 'IE'
+ vat_number = 'IE6388047V'
+
+ result = Quaderno::Tax.validate_vat_number(country, vat_number) #=> Quaderno::Tax
 
- Quaderno::Tax.validate_vat_number(country, vat_number) #=> Boolean
+ result.valid #=> Boolean or nil
 ```
 
 will validate the vat number for the passed country.
@@ -569,7 +610,7 @@ will create an evidence based on the data pased as parameters.
 
 ### Getting checkout sessions
 ```ruby
- Quaderno::CheckoutSession.all() #=> Array
+ Quaderno::CheckoutSession.all #=> Array
 ```
 
  will return an array with all the checkout sessions in your account.
@@ -597,9 +638,9 @@ will update the specified checkout session with the data of the hash passed as s
 
 ### Deleting a checkout session
 ```ruby
-  Quaderno::CheckoutSession.delete(id) #=> Boolean
+  Quaderno::CheckoutSession.delete(id) #=> Quaderno::CheckoutSession
 ```
-will delete the checkout session with the id passed as parameter.
+will delete the checkout session with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::CheckoutSession` with the `deleted` attribute set to `true` will be returned.
 
 
 ## Exceptions

data/changelog.md

@@ -1,160 +1,171 @@
-#Changelog
-##1.16.0
+# Changelog
+
+## 1.17.0
+* Added `rate_limit_info` method to each API response
+* **Breaking change:** `.delete` methods no longer returns a boolean but an instance of the removed object with a `deleted` attribute set to `true`
+* **Breaking change:** `Quaderno::Base.ping` no longer returns a boolean but a `Quaderno::Base` instance with a `status` attribute.
+* **Breaking change:** `Quaderno::Base.authorization` no longer returns a `Hash` but a `Quaderno::Base` instance with an `identity` attribute.
+* **Breaking change:** `Quaderno::Base.me` no longer returns a `Hash` but a `Quaderno::Base` instance with all the attributes contained in the previous format.
+* **Breaking change:** `Quaderno::Tax.validate_vat_number` no longer returns a boolean but a `Quaderno::Tax` instance with a `valid` attribute.
+* **Breaking change:** `.deliver` no longer returns a `Hash` but a `Quaderno::Base` instance with a `success` attribute.
+* **Breaking change:** Removed `Quaderno::Base.rate_limit_info`. Now it's an alias of `Quaderno::Base.ping`.
+
+## 1.16.0
 * Added `Quaderno::CheckoutSession`
 
-##1.15.2
+## 1.15.2
 * Relax `httparty` version requirement.
 
-##1.15.1
+## 1.15.1
 * Fix `Quaderno` load order.
 
-##1.15.0
+## 1.15.0
 * Removed `jeweler` and updated the gem structure.
 
-##1.14.0
+## 1.14.0
 * Added `domestic_taxes`, `sales_taxes`, `vat_moss`, `ec_sales` and `international_taxes` to `Quaderno::Report`
 
-##1.13.2
+## 1.13.2
 * Added index method to `Quaderno::Tax` as `Quaderno::Tax.all()`.
 
-##1.13.1
+## 1.13.1
 * Added `taxes` report to `Quaderno::Report`.
 
-##1.13.0
+## 1.13.0
 * Added `Quaderno::Report`.
 
-##1.12.5
+## 1.12.5
 * Added `create` method to `Quaderno::Income`.
 * Fix `Quaderno::Base.ping` and `Quaderno::Base.me` methods.
 
-##1.12.4
+## 1.12.4
 * Use version headers on taxes requests.
 
-##1.12.3
+## 1.12.3
 * Return integers insteado of strings on pagination readers.
 
-##1.12.2
+## 1.12.2
 * Added `me` method.
 
-##1.12.0
+## 1.12.0
 * Added thread-safe credentials configuration.
 * `all` methods returns a `Quaderno::Object` with pagination info instead of an `Array`
 
-##1.11.2
+## 1.11.2
 * Specify `Content-Type` header so `HTTParty` don't merge the elements within the body content.
 
-##1.11.1
+## 1.11.1
 * Added `retrieve` method for `Quaderno::Contact`, `Quaderno::Invoice`, `Quaderno::Credit`
 * Deprecate `retrieve_customer` as an alias of `retrieve`
 
-##1.11.0
+## 1.11.0
 * Added `Quaderno::Tax.validate_vat_number` method
 
-##1.10.0
+## 1.10.0
  * Added location evidences support
 
-##1.9.2
+## 1.9.2
  * Added `Quaderno::Contact.retrieve` method
  * Code cleanup
  * Update tests
 
-##1.9.1
+## 1.9.1
  * `Quaderno::Base.authorization` raises `Quaderno::Exceptions::InvalidSubdomainOrToken` instead returning false on wrong credentials
  * Inherit from `StandardError` instead of `Exception` for `Quaderno::Exceptions` by **@mvelikov**
 
-##1.9.0
+## 1.9.0
  * Add support for new versioning system
 
-##1.8.0
+## 1.8.0
  * Add Quaderno::Receipt support
  * Fix errors in README
 
-##1.7.3
+## 1.7.3
  * Raise exception on failed updates
 
-##1.7.2
- * Fix URL in `Quaderno::Tax.calculate` by [**@jcxplorer**] (https://github.com/jcxplorer)
+## 1.7.2
+ * Fix URL in `Quaderno::Tax.calculate` by [**@jcxplorer**](https://github.com/jcxplorer)
 
-##1.7.1
+## 1.7.1
  * Breaking change: change configuration options
 
-##1.7.0
+## 1.7.0
  * Added recurring documents
  * Raise existent exception
 
-##1.6.1
+## 1.6.1
  * Fixed typo from old version released as 1.6.0
 
-##1.6.0 (yanked)
+## 1.6.0 (yanked)
  * Crud module refactor
  * Added support for credit notes
 
-##1.5.5
+## 1.5.5
  * Move rdoc as a development dependency
 
-##1.5.4
+## 1.5.4
 * Remove transaction class.
 
-##1.5.3
+## 1.5.3
 * Update `rate_limit_info` to fit the new rate limit
 * Remove transaction information from README (future resource name change)
 * Added new throttle limit exception (will be activated in future releases)
 
-##1.5.1 and 1.5.2
+## 1.5.1 and 1.5.2
 * Remove debugger
 * `Quaderno::Exceptions::RequiredFieldsEmpty` replaced with `Quaderno::Exceptions::RequiredFieldsEmptyOrInvalid`
 
-##1.5.0
+## 1.5.0
 * Added transactions
 * Raise `Quaderno::Exceptions::RequiredFieldsEmpty` for 422 responses
 
-##1.4.2
+## 1.4.2
 * Find method hotfix
 
-##1.4.1
+## 1.4.1
 * Fix wrong method name
 * Use correct organization in url
 * Add short description of the gem
 
-##1.4.0
+## 1.4.0
 * Added taxes calculations support
 * Added webhooks documentation
 
-##1.3.2
+## 1.3.2
 
 * Use new urls format
 
-##1.3.1
+## 1.3.1
 
 * Added sandbox environment
 * Added `to_hash` instance method
 
-##1.3.0
+## 1.3.0
 
 * Removed debug mode
 
-##1.2.2
+## 1.2.2
 
 * Added ruby 2.0.0 compatibility
 
-##1.2.1
+## 1.2.1
 
 * Deleted debugger dependency
 
-##1.2.0
+## 1.2.0
 
 * Added Quaderno webhooks as a resource
 * Added authorization method
 
-##1.1.2
+## 1.1.2
 
 * Fixed minor bugs
 
-##1.1.0
+## 1.1.0
 
 * Added Quaderno items as a resource
 * Added filter in index queries
 
-##1.0.0
+## 1.0.0
 
 * Initial release

data/lib/quaderno-ruby.rb

@@ -3,6 +3,7 @@ end
 
 require 'ostruct'
 
+require 'quaderno-ruby/helpers/rate_limit'
 require 'quaderno-ruby/exceptions/exceptions'
 require 'quaderno-ruby/helpers/authentication'
 require 'quaderno-ruby/collection'

data/lib/quaderno-ruby/base.rb

@@ -6,6 +6,7 @@ class Quaderno::Base < OpenStruct
   include Quaderno::Exceptions
   include Quaderno::Behavior::Crud
   include Quaderno::Helpers::Authentication
+  include Quaderno::Helpers::RateLimit
 
   PRODUCTION_URL = 'https://quadernoapp.com/api/'
   SANDBOX_URL = 'http://sandbox-quadernoapp.com/api/'
@@ -51,9 +52,12 @@ class Quaderno::Base < OpenStruct
     response = get("#{url}authorization.json", basic_auth: { username: auth_token }, headers: version_header)
 
     if response.code == 200
-      response.parsed_response
+      data = self.new(response.parsed_response)
+      data.rate_limit_info = response
+
+      data
     else
-      raise(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token')
+      raise_exception(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token', response)
     end
   end
 
@@ -72,9 +76,16 @@ class Quaderno::Base < OpenStruct
 
       check_exception_for(party_response, { subdomain_or_token: true })
     rescue Errno::ECONNREFUSED
-      return false
+      return Quaderno::Base.new({ status: false })
     end
-    true
+
+    data = self.new({ status: true })
+    data.rate_limit_info = party_response
+
+    data
+  end
+  class <<self
+    alias_method :rate_limit_info, :ping
   end
 
   def self.me(options = {})
@@ -90,14 +101,10 @@ class Quaderno::Base < OpenStruct
 
     check_exception_for(party_response, { subdomain_or_token: true })
 
-    party_response.parsed_response
-  end
+    data = self.new(party_response.parsed_response)
+    data.rate_limit_info = party_response
 
-  #Returns the rate limit information: limit and remaining requests
-  def self.rate_limit_info
-    party_response = get("#{@@url}ping.json", basic_auth: { username: auth_token }, headers: version_header)
-    check_exception_for(party_response, { subdomain_or_token: true })
-    @@rate_limit_info = { reset: party_response.headers['x-ratelimit-reset'].to_i, remaining: party_response.headers["x-ratelimit-remaining"].to_i }
+    data
   end
 
   # Instance methods

data/lib/quaderno-ruby/behavior/block.rb

@@ -19,7 +19,10 @@ module Quaderno::Behavior
         check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true })
         doc = response.parsed_response
 
-        new doc
+        object = new doc
+        object.rate_limit_info = response
+
+        object
       end
     end
   end

data/lib/quaderno-ruby/behavior/crud.rb

@@ -47,6 +47,7 @@ module Quaderno::Behavior
           array.each { |element| collection << (new element) }
         end
 
+        collection.rate_limit_info = response
         collection.current_page = response.headers['x-pages-currentpage']
         collection.total_pages = response.headers['x-pages-totalpages']
 
@@ -67,7 +68,10 @@ module Quaderno::Behavior
 
         api_model.parse_nested(hash) if is_a_document?
 
-        new hash
+        object = new hash
+        object.rate_limit_info = response
+
+        object
       end
 
       def create(params = {})
@@ -86,7 +90,10 @@ module Quaderno::Behavior
 
         api_model.parse_nested(hash) if is_a_document?
 
-        new hash
+        object = new hash
+        object.rate_limit_info = response
+
+        object
       end
 
       def update(id, params = {})
@@ -105,7 +112,10 @@ module Quaderno::Behavior
 
         api_model.parse_nested(hash) if is_a_document?
 
-        new hash
+        object = new hash
+        object.rate_limit_info = response
+
+        object
       end
 
       def delete(id, options = {})
@@ -117,7 +127,12 @@ module Quaderno::Behavior
         )
         check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true, has_documents: true })
 
-        true
+        hash = { deleted: true, id: id }
+
+        object = new hash
+        object.rate_limit_info = response
+
+        object
       end
     end
   end

data/lib/quaderno-ruby/behavior/deliver.rb

@@ -17,7 +17,11 @@ module Quaderno::Behavior
         )
 
         api_model.check_exception_for(party_response, { rate_limit: true, subdomain_or_token: true, id: true, required_fields: true })
-        { limit: party_response.headers["x-ratelimit-limit"].to_i, remaining: party_response.headers["x-ratelimit-remaining"].to_i }
+
+        data = Quaderno::Base.new(success: true)
+        data.rate_limit_info = party_response
+
+        data
       end
     end
   end

data/lib/quaderno-ruby/behavior/payment.rb

@@ -25,13 +25,14 @@ module Quaderno::Behavior
         instance = Quaderno::Payment.new(response.parsed_response)
         self.payments << instance
 
-        Quaderno::Payment.new instance
+        instance.rate_limit_info = response
+
+        instance
       end
 
       def remove_payment(payment_id, options = nil)
         self.authentication_data = get_authentication(options.merge(api_model: api_model)) if options.is_a?(Hash)
 
-
         response = HTTParty.delete("#{authentication_data[:url]}#{api_model.api_path}/#{id}/payments/#{payment_id}.json",
           basic_auth: authentication_data[:basic_auth],
           headers: self.class.version_header.merge(authentication_data[:headers])
@@ -41,7 +42,12 @@ module Quaderno::Behavior
 
         self.payments.delete_if { |payment| payment.id == payment_id }
 
-        true
+        hash = { deleted: true, id: payment_id}
+
+        object = Quaderno::Payment.new(hash)
+        object.rate_limit_info = response
+
+        object
       end
     end
   end

data/lib/quaderno-ruby/behavior/retrieve.rb

@@ -20,7 +20,10 @@ module Quaderno::Behavior
         hash = response.parsed_response
         hash[:authentication_data] = authentication
 
-        new hash
+        object = new hash
+        object.rate_limit_info = response
+
+        object
       end
       alias_method :retrieve_customer, :retrieve
 

data/lib/quaderno-ruby/collection.rb

@@ -1,4 +1,5 @@
 class Quaderno::Collection < Array
+  include Quaderno::Helpers::RateLimit
 
   def current_page=(page_number)
     @page = page_number

data/lib/quaderno-ruby/exceptions/exceptions.rb

@@ -1,5 +1,6 @@
 module Quaderno::Exceptions
   class BaseException < StandardError
+    include Quaderno::Helpers::RateLimit
   end
 
   class InvalidSubdomainOrToken < BaseException
@@ -29,26 +30,33 @@ module Quaderno::Exceptions
 
   module ClassMethods
     def check_exception_for(party_response, params = {})
-      raise(Quaderno::Exceptions::UnsupportedApiVersion, 'Unsupported API version') if !!(party_response.body =~ /Unsupported API version/)
+      raise_exception(Quaderno::Exceptions::UnsupportedApiVersion, 'Unsupported API version', party_response) if !!(party_response.body =~ /Unsupported API version/)
 
-      if params[:throttle_limit].nil? == false
-       raise(Quaderno::Exceptions::ThrottleLimitExceeded, 'Throttle limit exceeded, please try again later') if party_response.response.class == Net::HTTPServiceUnavailable
+      if params[:throttle_limit].nil? == false && party_response.response.class == Net::HTTPServiceUnavailable
+        raise_exception(Quaderno::Exceptions::ThrottleLimitExceeded, 'Throttle limit exceeded, please try again later', party_response)
       end
-      if params[:rate_limit].nil? == false
-        raise(Quaderno::Exceptions::RateLimitExceeded, 'Rate limit exceeded') if party_response.response.class == Net::HTTPForbidden
+      if params[:rate_limit].nil? == false && party_response.response.class == Net::HTTPForbidden
+        raise_exception(Quaderno::Exceptions::RateLimitExceeded, 'Rate limit exceeded', party_response)
       end
       if params[:subdomain_or_token].nil? == false
-        raise(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token') if party_response.response.class == Net::HTTPUnauthorized
+        raise_exception(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token', party_response) if party_response.response.class == Net::HTTPUnauthorized
       end
       if params[:id].nil? == false
-        raise(Quaderno::Exceptions::InvalidID, "Invalid #{ api_model } instance identifier") if (party_response.response.class == Net::HTTPInternalServerError) || (party_response.response.class == Net::HTTPNotFound)
+        raise_exception(Quaderno::Exceptions::InvalidID, "Invalid #{ api_model } instance identifier", party_response) if (party_response.response.class == Net::HTTPInternalServerError) || (party_response.response.class == Net::HTTPNotFound)
       end
       if params[:required_fields].nil? == false
-        raise(Quaderno::Exceptions::RequiredFieldsEmptyOrInvalid, party_response.body) if party_response.response.class == Net::HTTPUnprocessableEntity
+        raise_exception(Quaderno::Exceptions::RequiredFieldsEmptyOrInvalid, party_response.body, party_response) if party_response.response.class == Net::HTTPUnprocessableEntity
       end
       if params[:has_documents].nil? == false
-        raise(Quaderno::Exceptions::HasAssociatedDocuments, party_response.body) if party_response.response.class == Net::HTTPClientError
+        raise_exception(Quaderno::Exceptions::HasAssociatedDocuments, party_response.body, party_response) if party_response.response.class == Net::HTTPClientError
       end
     end
+
+    def raise_exception(klass, message, response)
+      exception = klass.new(message)
+      exception.rate_limit_info = response
+
+      raise exception
+    end
   end
 end

data/lib/quaderno-ruby/helpers/rate_limit.rb

@@ -0,0 +1,12 @@
+module Quaderno::Helpers
+  module RateLimit
+
+    def rate_limit_info=(response)
+      @rate_limit_info = { reset: response.headers['x-ratelimit-reset'].to_i, remaining: response.headers["x-ratelimit-remaining"].to_i }
+    end
+
+    def rate_limit_info
+      @rate_limit_info
+    end
+  end
+end

data/lib/quaderno-ruby/payment.rb

@@ -1,2 +1,3 @@
 class Quaderno::Payment < OpenStruct
+  include Quaderno::Helpers::RateLimit
 end

data/lib/quaderno-ruby/tax.rb

@@ -20,7 +20,10 @@ class Quaderno::Tax < Quaderno::Base
     )
 
     check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true })
-    new response.parsed_response
+    data = new response.parsed_response
+    data.rate_limit_info = response
+
+    data
   end
 
   def self.validate_vat_number(country, vat_number, options = {})
@@ -34,7 +37,10 @@ class Quaderno::Tax < Quaderno::Base
 
     check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true })
 
-    response.parsed_response['valid']
+    data = new({ valid: response.parsed_response['valid'] })
+    data.rate_limit_info = response
+
+    data
   end
 
   def self.reports(options = {})
@@ -49,6 +55,7 @@ class Quaderno::Tax < Quaderno::Base
 
     array = response.parsed_response
     collection = Quaderno::Collection.new
+    collection.rate_limit_info = response
     collection.current_page = response.headers['x-pages-currentpage']
     collection.total_pages = response.headers['x-pages-totalpages']
 

data/lib/quaderno-ruby/version.rb

@@ -1,3 +1,3 @@
 class Quaderno
-  VERSION = "1.16.0"
+  VERSION = "1.17.0"
 end

data/quaderno.gemspec

@@ -28,6 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('webmock', "~> 1.22.6")
   spec.add_development_dependency('vcr', ">= 0")
   spec.add_development_dependency("bundler", "~> 1.11")
-  spec.add_development_dependency("rake", "~> 10.0")
+  spec.add_development_dependency("rake", ">= 12.3.3")
   spec.add_development_dependency("rspec", "~> 3.0")
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: quaderno
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Recrea
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
 date: 2018-05-07 00:00:00.000000000 Z
@@ -98,16 +98,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +156,7 @@ files:
 - lib/quaderno-ruby/exceptions/exceptions.rb
 - lib/quaderno-ruby/expense.rb
 - lib/quaderno-ruby/helpers/authentication.rb
+- lib/quaderno-ruby/helpers/rate_limit.rb
 - lib/quaderno-ruby/income.rb
 - lib/quaderno-ruby/invoice.rb
 - lib/quaderno-ruby/item.rb
@@ -171,7 +172,7 @@ homepage: http://github.com/quaderno/quaderno-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -186,9 +187,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Quaderno API (https://quaderno.io/docs/api)
 test_files: []