quaderno 1.15.2 → 2.0.1

data/changelog.md

@@ -1,154 +1,183 @@
-#Changelog
-##1.15.1
+# Changelog
+
+## 2.0.1
+* Fix an issue where requests would result in an error due to a missing `require`
+
+## 2.0.0
+* **Breaking change** Pagination strategy has been updated to be cursor based. Collections no longer offer the `current_page` and `total_pages` methods, and offer `has_more?` and `next_page` instead. The `page` parameter is no longer supported either, in favour of the `created_before` parameter. [See more information in the documentation](https://developers.quaderno.io/api/#pagination).
+* **Breaking change** `Quaderno::Tax.calculate` uses the [new tax calculation endpoint](https://developers.quaderno.io/api/#calculate-a-tax-rate). This endpoint accepts address parameters with the prefix `to_`. For example, `postal_code` is deprecated in favour of `to_postal_code`.
+* `Quaderno::Tax.validate` uses the [new tax ID validation endpoint](https://developers.quaderno.io/api/#validate-a-tax-id). The signature did not change, and no updates are necessary.
+* All requests now send the gem version in their User Agent header.
+
+## 1.17.1
+* Do not modify the input arguments when the thread-safe mode is used.
+
+## 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
+* Relax `httparty` version requirement.
+
+## 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,9 +3,11 @@ end
 
 require 'ostruct'
 
+require 'quaderno-ruby/version'
+require 'quaderno-ruby/helpers/rate_limit'
 require 'quaderno-ruby/exceptions/exceptions'
 require 'quaderno-ruby/helpers/authentication'
 require 'quaderno-ruby/collection'
 
 %w(block crud deliver payment retrieve).each { |filename| require "quaderno-ruby/behavior/#{filename}" }
-%w(base contact item invoice receipt credit income estimate expense recurring document_item report evidence payment webhook tax).each { |filename| require "quaderno-ruby/#{ filename }" }
+%w(base contact item invoice receipt credit income estimate expense recurring document_item report evidence payment webhook tax checkout_session).each { |filename| require "quaderno-ruby/#{ filename }" }

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/'
@@ -48,12 +49,15 @@ class Quaderno::Base < OpenStruct
   def self.authorization(auth_token, mode = nil)
     mode ||= :production
     url = mode == :sandbox ? SANDBOX_URL : PRODUCTION_URL
-    response = get("#{url}authorization.json", basic_auth: { username: auth_token }, headers: version_header)
+    response = get("#{url}authorization.json", basic_auth: { username: auth_token }, headers: default_headers)
 
     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
 
@@ -67,14 +71,21 @@ class Quaderno::Base < OpenStruct
 
       party_response = get("#{authentication[:url]}ping.json",
         basic_auth: authentication[:basic_auth],
-        headers: version_header.merge(authentication[:headers])
+        headers: default_headers.merge(authentication[:headers])
       )
 
       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 = {})
@@ -85,19 +96,15 @@ class Quaderno::Base < OpenStruct
 
     party_response = get("#{authentication[:url]}me.json",
       basic_auth: authentication[:basic_auth],
-      headers: version_header.merge(authentication[:headers])
+      headers: default_headers.merge(authentication[:headers])
     )
 
     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
@@ -128,7 +135,17 @@ class Quaderno::Base < OpenStruct
     @_document ||= document
   end
 
+  def self.default_headers
+    user_agent_header.merge(version_header)
+  end
+
+  def self.user_agent_header
+    { "User-Agent" => "Quaderno Ruby Gem #{Quaderno::VERSION}" }
+  end
+
   def self.version_header
     { 'Accept' => @@api_version.to_i.zero? ? "application/json" : "application/json; api_version=#{@@api_version.to_i}"}
   end
+
+  headers self.default_headers
 end

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

@@ -13,13 +13,16 @@ module Quaderno::Behavior
 
         response = put("#{authentication[:url]}#{api_model.api_path}/#{id}/block.json",
           basic_auth: authentication[:basic_auth],
-          headers: version_header.merge(authentication[:headers])
+          headers: default_headers.merge(authentication[:headers])
         )
 
         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

@@ -23,34 +23,28 @@ module Quaderno::Behavior
         element
       end
 
+      def all_from_url(url, options = {})
+        authentication = get_authentication(api_model: api_model)
+
+        response = get(url,
+          basic_auth: authentication[:basic_auth],
+          headers: default_headers.merge(authentication[:headers])
+        )
+
+        handle_all_response(response, authentication, options)
+      end
+
       def all(options = {})
         authentication = get_authentication(options.merge(api_model: api_model))
-        filter = options.delete_if { |k,v| %w(auth_token access_token api_url mode api_model).include? k.to_s }
+        filter = options.dup.delete_if { |k,v| %w(auth_token access_token api_url mode api_model).include? k.to_s }
 
         response = get("#{authentication[:url]}#{api_model.api_path}.json",
           query: filter,
           basic_auth: authentication[:basic_auth],
-          headers: version_header.merge(authentication[:headers])
+          headers: default_headers.merge(authentication[:headers])
         )
 
-        check_exception_for(response, { rate_limit: true, subdomain_or_token: true })
-        array = response.parsed_response
-        collection = Quaderno::Collection.new
-
-        if is_a_document?
-          array.each do |element|
-            element[:authentication_data] = authentication
-            api_model.parse_nested(element)
-            collection << (new element)
-          end
-        else
-          array.each { |element| collection << (new element) }
-        end
-
-        collection.current_page = response.headers['x-pages-currentpage']
-        collection.total_pages = response.headers['x-pages-totalpages']
-
-        collection
+        handle_all_response(response, authentication, options)
       end
 
       def find(id, options = {})
@@ -58,7 +52,7 @@ module Quaderno::Behavior
 
         response = get("#{authentication[:url]}#{api_model.api_path}/#{id}.json",
           basic_auth: authentication[:basic_auth],
-          headers: version_header.merge(authentication[:headers])
+          headers: default_headers.merge(authentication[:headers])
         )
 
         check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true })
@@ -67,17 +61,20 @@ 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 = {})
         authentication = get_authentication(params.merge(api_model: api_model))
-        params.delete_if { |k,v| %w(auth_token access_token api_url mode api_model').include? k.to_s }
+        params.dup.delete_if { |k,v| %w(auth_token access_token api_url mode api_model').include? k.to_s }
 
         response = post("#{authentication[:url]}#{api_model.api_path}.json",
           body: params.to_json,
           basic_auth: authentication[:basic_auth],
-          headers: version_header.merge(authentication[:headers]).merge('Content-Type' => 'application/json')
+          headers: default_headers.merge(authentication[:headers]).merge('Content-Type' => 'application/json')
         )
 
         check_exception_for(response, { rate_limit: true, subdomain_or_token: true, required_fields: true })
@@ -86,17 +83,20 @@ 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 = {})
         authentication = get_authentication(params.merge(api_model: api_model))
-        params = params.delete_if { |k,v| %w(auth_token access_token api_url mode api_model').include? k.to_s }
+        params = params.dup.delete_if { |k,v| %w(auth_token access_token api_url mode api_model').include? k.to_s }
 
         response = put("#{authentication[:url]}#{api_model.api_path}/#{id}.json",
           body: params.to_json,
           basic_auth: authentication[:basic_auth],
-          headers: version_header.merge(authentication[:headers]).merge('Content-Type' => 'application/json')
+          headers: default_headers.merge(authentication[:headers]).merge('Content-Type' => 'application/json')
         )
 
         check_exception_for(response, { rate_limit: true, required_fields: true, subdomain_or_token: true, id: true })
@@ -105,7 +105,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 = {})
@@ -113,11 +116,42 @@ module Quaderno::Behavior
 
         response = HTTParty.delete("#{authentication[:url]}#{ api_model.api_path }/#{ id }.json",
           basic_auth: authentication[:basic_auth],
-          headers: version_header.merge(authentication[:headers])
+          headers: default_headers.merge(authentication[:headers])
         )
         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
+
+      private
+
+      def handle_all_response(response, authentication, request_options)
+        check_exception_for(response, { rate_limit: true, subdomain_or_token: true })
+        array = response.parsed_response
+        collection = Quaderno::Collection.new
+
+        if is_a_document?
+          array.each do |element|
+            element[:authentication_data] = authentication
+            api_model.parse_nested(element)
+            collection << (new element)
+          end
+        else
+          array.each { |element| collection << (new element) }
+        end
+
+        collection.rate_limit_info = response
+        collection.request_options = request_options
+        collection.collection_type = self
+        collection.has_more = response.headers['x-pages-hasmore']
+        collection.next_page_url = response.headers['x-pages-nextpage']
+
+        collection
       end
     end
   end