quaderno 1.17.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff20a4dbd47a968b4fedb922d622804909717069a0bcab8ebf077090fb3eff96
-  data.tar.gz: 13b73cd944e916c59309ac000e4366cb718ef1a253fd4a2f83ede62a2ced5b85
+  metadata.gz: 5785e9a03af0c0ffa3eb2d52fc0586e8fa866c9da75170619a0a53755f2d2623
+  data.tar.gz: b45c9dbb82dc07b655dc3a8a3bb9a636fad5d1e3d5b1e15382fdeb4290c84357
 SHA512:
-  metadata.gz: 8a8cd3b2fbab98cecb89e9e57a41bba5b85e5b088bce9c4ca7718a2942d3227225bf29828fb57bba4d3f85a5a0a8c72ba6c4ab11af3d08cdc0bca07bca0cdaba
-  data.tar.gz: b5db04494e9c164d76e269c96409309f42925e993a39f78f8a7cdabe1a99b17abeee0af5dc950864a8dd2461f7192884a3699ce9a9f204eb234ce1694aea59fb
+  metadata.gz: fae563254f44fbd6a1128916bbc79d134b312a0945ad97b727b064140900e7d336499836b7eafd6f103d2a3b0cce5be5c410eb1e72043dfbea3b3eb7ec1bfdbb
+  data.tar.gz: fe5a981e7e7a2c3f48df1b83c0f9bf1cc87db36044d45cd998b2167940cc5401534750145617baa82fafc27b4511061a5468897cf9adfc7ee6ff5528068ab97f

data/.github/workflows/test.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec ./spec/**/*.rb

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.17.0 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
+Current version is 2.1.2 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
 
 ## Installation & Configuration
 
@@ -19,6 +19,7 @@ To configure just add this to your initializers
     config.auth_token = 'my_authenticate_token'
     config.url = 'https://my_subdomain.quadernoapp.com/api/'
     config.api_version = API_VERSION # Optional, defaults to the API version set in your account
+    config.user_agent_header = 'my custom user agent' # Optional, will make support for your account more efficient if you are doing oauth integrations
   end
 ```
 
@@ -99,10 +100,9 @@ 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(page: 1) #=> Array
 ```
 
- will return an array with all your contacts on the first page. You can also pass query strings using the attribute :q in order to filter the results by contact name. For example:
+ will return an array with all your contacts. You can also pass query strings using the attribute :q in order to filter the results by contact name. For example:
 
 ```ruby
  Quaderno::Contact.all(q: 'John Doe') #=> Array
@@ -188,10 +188,9 @@ will delete the item with the id passed as parameter.  If the deletion was succe
 ### Getting invoices
 ```ruby
   Quaderno::Invoice.all #=> Array
-  Quaderno::Invoice.all(page: 1) #=> Array
 ```
 
- will return an array with all your invoices on the first page. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
+ will return an array with all your invoices. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
 
 ### Finding an invoice
 ```ruby
@@ -259,67 +258,14 @@ In order to  remove a payment you will need the Invoice instance you want to upd
   result.success #=> Boolean
 ```
 
-## Managing receipts
-
-### Getting receipts
-```ruby
-  Quaderno::Receipt.all #=> Array
-  Quaderno::Receipt.all(page: 1) #=> Array
-```
-
- will return an array with all your receipts on the first page. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
-
-### Finding a receipt
-```ruby
-  Quaderno::Receipt.find(id) #=> Quaderno::Receipt
-```
-
-will return the receipt with the id passed as parameter.
-
-### Creating a new receipt
-
-```ruby
-  Quaderno::Receipt.create(params) #=> Quaderno::Receipt
-```
-
-will create an receipt using the information of the hash passed as parameter.
-
-### Updating an existing receipt
-```ruby
-  Quaderno::Receipt.update(id, params) #=> Quaderno::Receipt
-```
-
-will update the specified receipt with the data of the hash passed as second parameter.
-
-### Deleting an receipt
-
-```ruby
-  Quaderno::Receipt.delete(id) #=> Quaderno::Receipt
-```
-
-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
-
-  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)
-  result = receipt.deliver #=> Quaderno::Base
-
-  result.success #=> Boolean
-```
-
-
 ## Managing credits
 
 ### Getting credits
 ```ruby
   Quaderno::Credit.all #=> Array
-  Quaderno::Credit.all(page: 1) #=> Array
 ```
 
- will return an array with all your credit notes on the first page. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
+ will return an array with all your credit notes. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
 
 ### Finding a credit
 ```ruby
@@ -337,10 +283,10 @@ will return the credit note with the transaction id passed as parameter.
 ### Creating a new credit
 
 ```ruby
-  Quaderno::Credit.create(params) #=> Quaderno::Credit
+  Quaderno::Credit.create(invoice_id: 42) #=> Quaderno::Credit
 ```
 
-will create a credit using the information of the hash passed as parameter.
+will create a credit from the invoice specified in the parameter.
 
 ### Updating an existing credit
 ```ruby
@@ -395,10 +341,9 @@ If the deletion was successful, an instance of `Quaderno::Payment` with the `del
 ### Getting estimates
 ```ruby
   Quaderno::Estimate.all #=> Array
-  Quaderno::Estimate.all(page: 1) #=> Array
 ```
 
- will return an array with all your estimates on the first page.
+ will return an array with all your estimates.
 
 ### Finding an estimate
 ```ruby
@@ -464,10 +409,9 @@ 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(page: 1) #=> Array
 ```
 
- will return an array with all your expenses on the first page. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date.
+ will return an array with all your expenses. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date.
 
 ### Finding an expense
 ```ruby
@@ -503,10 +447,9 @@ will delete the expense with the id passed as parameter. If the deletion was suc
 ### Getting recurrings
 ```ruby
   Quaderno::Recurring.all #=> Array
-  Quaderno::Recurring.all(page: 1) #=> Array
 ```
 
- will return an array with all your recurring notes on the first page. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
+ will return an array with all your recurring notes. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
 
 ### Finding a recurring
 ```ruby
@@ -585,17 +528,17 @@ will delete the webhook with the id passed as parameter. If the deletion was suc
 
 will calculate the taxes applied for a customer based on the data pased as parameters.
 
-### Validate VAT numbers
+### Validate tax ID
 ```ruby
  country = 'IE'
- vat_number = 'IE6388047V'
+ tax_id = 'IE6388047V'
 
- result = Quaderno::Tax.validate_vat_number(country, vat_number) #=> Quaderno::Tax
+ result = Quaderno::Tax.validate_tax_id(country, tax_id) #=> Quaderno::Tax
 
  result.valid #=> Boolean or nil
 ```
 
-will validate the vat number for the passed country.
+will validate the tax ID or business number for the specified country.
 
 ## Evidences
 
@@ -642,6 +585,29 @@ will update the specified checkout session with the data of the hash passed as s
 ```
 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.
 
+## Managing report requests
+
+### Getting report requests
+```ruby
+  Quaderno::ReportRequest.all #=> Array
+```
+
+ will return an array with all your report requests.
+
+### Finding a report request
+```ruby
+  Quaderno::ReportRequest.find(id) #=> Quaderno::ReportRequest
+```
+
+will return the report request with the id passed as parameter.
+
+### Creating a new report request
+
+```ruby
+  Quaderno::ReportRequest.create(params) #=> Quaderno::ReportRequest
+```
+
+will create a report request using the information of the hash passed as parameter and return an instance of Quaderno::ReportRequest with the created report request.
 
 ## Exceptions
 Quaderno-ruby exceptions raise depending on the type of error:
@@ -661,6 +627,7 @@ Quaderno-ruby exceptions raise depending on the type of error:
 
   Quaderno::Exceptions::RequiredFieldsEmptyOrInvalid # Raised if the format of the request is right but some validations failed. You can JSON parse the exception message to get which field triggered the exception. For example: '{"errors":{"vat_number":["is not a valid German vat number"]}}'
 
+  Quaderno::Exceptions::ServerError # Raised when Quaderno returns an HTTP response code of the 50X family. Try again later or contact support if the issue persists
 ```
 
 All those exceptions inherit from `Quaderno::Exceptions::BaseException`.
@@ -669,12 +636,27 @@ All those exceptions inherit from `Quaderno::Exceptions::BaseException`.
 Whenever you call the `all` method on one of the classes, the result will be a `Quaderno::Collection`. For example:
 
 ```ruby
-collection = Quaderno::Contact.all(page: 2)
+collection = Quaderno::Contact.all
 
 collection.class #=> Quaderno::Collection
-collection.pagination_info #=> {:current_page=>"1", :total_pages=>"3"}
-collection.current_page #=> "2"
-collection.total_pages #=> "3"
+collection.has_more? #=> true
+collection.next_page #=> another instance of
+```
+
+The `next_page` method is an abstraction for the `created_before` parameter, which you may also use with the `all` method.
+
+```ruby
+collection = Quaderno::Contact.all
+
+Quaderno::Contact.all(created_before: collection.last.id)
+```
+
+You can also use the `limit` parameter to determine how many results to retrieve. Its default is `25`, and Quaderno will cap the limit at `100`.
+
+```ruby
+collection = Quaderno::Contact.all(limit: 50)
+
+collection.length #=> 50
 ```
 
 ### Thread-safe configuration
@@ -731,5 +713,3 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-

data/changelog.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 2.1.2
+* Fixed a reference to non-existent variable by [**@fwitzke**](https://github.com/fwitzke)
+## 2.1.1
+* Added assign operator to the user_agent_header
+
+## 2.1.0
+* Added a new `Quaderno::Exceptions::ServerError` exception for more transparency, and better control of workflows
+* Added a `user_agent_header` optional configuration to make debugging oauth integrations easier
+
+## 2.0.2
+* Fix an issue with the parameters sent during the `validate_vat_number` request
+* Renames `validate_vat_number` into `validate_tax_id`
+
+## 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.
 

data/lib/quaderno-ruby/base.rb

@@ -15,6 +15,7 @@ class Quaderno::Base < OpenStruct
   @@rate_limit_info = nil
   @@api_version = nil
   @@url = PRODUCTION_URL
+  @@user_agent_suffix = nil
 
   # Class methods
   def self.api_model(klass)
@@ -46,16 +47,22 @@ class Quaderno::Base < OpenStruct
     @@url = url
   end
 
+  def self.user_agent_header=(custom_user_agent)
+    @@user_agent_suffix = custom_user_agent
+  end
+
   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
       data = self.new(response.parsed_response)
       data.rate_limit_info = response
 
       data
+    elsif response.response.is_a?(Net::HTTPServerError)
+      raise_exception(Quaderno::Exceptions::ServerError, 'Server error', response)
     else
       raise_exception(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token', response)
     end
@@ -71,7 +78,7 @@ 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 })
@@ -96,7 +103,7 @@ 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 })
@@ -135,7 +142,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}", @@user_agent_suffix].compact.join(' - ') }
+  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,7 +13,7 @@ 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 })

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

@@ -23,6 +23,17 @@ 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.dup.delete_if { |k,v| %w(auth_token access_token api_url mode api_model).include? k.to_s }
@@ -30,28 +41,10 @@ module Quaderno::Behavior
         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.rate_limit_info = response
-        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 = {})
@@ -59,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 })
@@ -81,7 +74,7 @@ module Quaderno::Behavior
         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 })
@@ -103,7 +96,7 @@ module Quaderno::Behavior
         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 })
@@ -123,7 +116,7 @@ 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 })
 
@@ -134,6 +127,32 @@ module Quaderno::Behavior
 
         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
 end

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

@@ -13,7 +13,7 @@ module Quaderno::Behavior
 
         party_response = api_model.get("#{authentication_data[:url]}#{api_model.api_path}/#{id}/deliver.json",
           basic_auth: authentication_data[:basic_auth],
-          headers: self.class.version_header.merge(authentication_data[:headers])
+          headers: self.class.default_headers.merge(authentication_data[:headers])
         )
 
         api_model.check_exception_for(party_response, { rate_limit: true, subdomain_or_token: true, id: true, required_fields: true })

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

@@ -17,7 +17,7 @@ module Quaderno::Behavior
         response = api_model.post("#{authentication_data[:url]}#{api_model.api_path}/#{id}/payments.json",
           body: params,
           basic_auth: authentication_data[:basic_auth],
-          headers: self.class.version_header.merge(authentication_data[:headers])
+          headers: self.class.default_headers.merge(authentication_data[:headers])
         )
 
         api_model.check_exception_for(response, { rate_limit: true, subdomain_or_token: true, required_fields: true })
@@ -35,7 +35,7 @@ module Quaderno::Behavior
 
         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])
+          headers: self.class.default_headers.merge(authentication_data[:headers])
         )
 
         api_model.check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true })

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

@@ -13,7 +13,7 @@ module Quaderno::Behavior
 
         response = get("#{authentication[:url]}#{gateway}/#{@_retrieve_path}/#{gateway_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 })

data/lib/quaderno-ruby/collection.rb

@@ -1,23 +1,28 @@
 class Quaderno::Collection < Array
   include Quaderno::Helpers::RateLimit
 
-  def current_page=(page_number)
-    @page = page_number
+  def request_options=(options)
+    @request_options = options
   end
 
-  def current_page
-    @page.to_i || 1
+  def collection_type=(collection_type)
+    @collection_type = collection_type
   end
 
-  def total_pages=(total_pages)
-    @total_pages = total_pages
+  def has_more=(has_more_response)
+    @has_more = has_more_response
   end
 
-  def total_pages
-    @total_pages.to_i || 1
+  def next_page_url=(next_page_url)
+    @next_page_url = next_page_url
   end
 
-  def pagination_info
-    { current_page: current_page, total_pages: total_pages }
+  def has_more?
+    @has_more == 'true'
   end
-end
+
+  def next_page
+    return Quaderno::Collection.new unless has_more?
+    @collection_type.all_from_url(@next_page_url, @request_options)
+  end
+end

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

@@ -24,6 +24,9 @@ module Quaderno::Exceptions
   class UnsupportedApiVersion < BaseException
   end
 
+  class ServerError < BaseException
+  end
+
   def self.included(receiver)
     receiver.send :extend, ClassMethods
   end
@@ -50,6 +53,8 @@ module Quaderno::Exceptions
       if params[:has_documents].nil? == false
         raise_exception(Quaderno::Exceptions::HasAssociatedDocuments, party_response.body, party_response) if party_response.response.class == Net::HTTPClientError
       end
+
+      raise_exception(Quaderno::Exceptions::ServerError, 'Server error', party_response) if party_response.response.is_a?(Net::HTTPServerError)
     end
 
     def raise_exception(klass, message, response)

data/lib/quaderno-ruby/report.rb

@@ -13,7 +13,7 @@ class Quaderno::Report < Quaderno::Base
     response = get("#{authentication[:url]}#{api_model.api_path}/journal.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 })
@@ -28,7 +28,7 @@ class Quaderno::Report < Quaderno::Base
     response = get("#{authentication[:url]}#{api_model.api_path}/taxes.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 })
@@ -65,7 +65,7 @@ class Quaderno::Report < Quaderno::Base
     response = get("#{authentication[:url]}#{api_model.api_path}/#{tax_report_type}.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 })
@@ -75,4 +75,4 @@ class Quaderno::Report < Quaderno::Base
 
     collection
   end
-end
+end

data/lib/quaderno-ruby/report_request.rb

@@ -0,0 +1,4 @@
+class Quaderno::ReportRequest < Quaderno::Base
+  api_model Quaderno::ReportRequest
+  api_path 'reporting/requests'
+end

data/lib/quaderno-ruby/tax.rb

@@ -13,10 +13,10 @@ class Quaderno::Tax < Quaderno::Base
     authentication = get_authentication(options.merge(api_model: api_model))
     params = options.dup.delete_if { |k,v| %w(auth_token access_token api_url mode api_model).include? k.to_s }
 
-    response = get("#{authentication[:url]}taxes/calculate.json",
+    response = get("#{authentication[:url]}tax_rates/calculate.json",
       query: params,
       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 })
@@ -26,13 +26,13 @@ class Quaderno::Tax < Quaderno::Base
     data
   end
 
-  def self.validate_vat_number(country, vat_number, options = {})
+  def self.validate_tax_id(country, tax_id, options = {})
     authentication = get_authentication(options.merge(api_model: api_model))
 
-    response = get("#{authentication[:url]}taxes/validate.json",
-      query: { country: country, vat_number: vat_number },
+    response = get("#{authentication[:url]}tax_ids/validate.json",
+      query: { country: country, tax_id: tax_id },
       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 })
@@ -42,6 +42,8 @@ class Quaderno::Tax < Quaderno::Base
 
     data
   end
+  # TODO: Temporary alias to be removed in future releases
+  self.singleton_class.send(:alias_method, :validate_vat_number, :validate_tax_id)
 
   def self.reports(options = {})
     authentication = get_authentication(options.merge(api_model: api_model))
@@ -50,7 +52,7 @@ class Quaderno::Tax < Quaderno::Base
     response = get("#{authentication[:url]}taxes/reports.json",
       query: params,
       basic_auth: authentication[:basic_auth],
-      headers: version_header.merge(authentication[:headers])
+      headers: default_headers.merge(authentication[:headers])
     )
 
     array = response.parsed_response

data/lib/quaderno-ruby/version.rb

@@ -1,3 +1,3 @@
 class Quaderno
-  VERSION = "1.17.1"
+  VERSION = "2.1.2"
 end

data/lib/quaderno-ruby.rb

@@ -3,10 +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 checkout_session).each { |filename| require "quaderno-ruby/#{ filename }" }
+%w(base contact item invoice receipt credit income estimate expense recurring document_item report report_request evidence payment webhook tax checkout_session).each { |filename| require "quaderno-ruby/#{ filename }" }

data/quaderno.gemspec

@@ -4,30 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'quaderno-ruby/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "quaderno"
+  spec.name = 'quaderno'
   spec.version = Quaderno::VERSION
-  spec.authors = ["Recrea"]
-  spec.email = "carlos@recrea.es"
+  spec.authors = ['Recrea']
+  spec.email = 'carlos@recrea.es'
 
-  spec.summary = "Ruby wrapper for the Quaderno API (https://quaderno.io/docs/api)"
-  spec.description = " A ruby wrapper for Quaderno API "
-  spec.homepage = "http://github.com/quaderno/quaderno-ruby"
-  spec.licenses = ["MIT"]
+  spec.summary = 'Ruby wrapper for the Quaderno API (https://quaderno.io/docs/api)'
+  spec.description = ' A ruby wrapper for Quaderno API '
+  spec.homepage = 'http://github.com/quaderno/quaderno-ruby'
+  spec.licenses = ['MIT']
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w(lib)
-  spec.date = "2018-05-07"
+  spec.date = '2018-05-07'
   spec.extra_rdoc_files = %w(LICENSE.txt README.md)
 
-
-  spec.add_dependency('httparty', "~> 0.13")
-  spec.add_development_dependency('rdoc', "~> 3.12")
-  spec.add_development_dependency('activesupport', "~> 4.2.0")
-  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", ">= 12.3.3")
-  spec.add_development_dependency("rspec", "~> 3.0")
+  spec.add_dependency('httparty', '~> 0.13')
+  spec.add_development_dependency('rdoc', '>= 6.3.1')
+  spec.add_development_dependency('activesupport', '~> 4.2.0')
+  spec.add_development_dependency('webmock', '~> 1.22.6')
+  spec.add_development_dependency('vcr', '>= 0')
+  spec.add_development_dependency('bundler', '~> 2.2')
+  spec.add_development_dependency('rake', '>= 12.3.3')
+  spec.add_development_dependency('rspec', '~> 3.0')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quaderno
 version: !ruby/object:Gem::Version
-  version: 1.17.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Recrea
@@ -28,16 +28,16 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 6.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 6.3.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -131,9 +131,9 @@ extra_rdoc_files:
 - README.md
 files:
 - ".document"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -164,6 +164,7 @@ files:
 - lib/quaderno-ruby/receipt.rb
 - lib/quaderno-ruby/recurring.rb
 - lib/quaderno-ruby/report.rb
+- lib/quaderno-ruby/report_request.rb
 - lib/quaderno-ruby/tax.rb
 - lib/quaderno-ruby/version.rb
 - lib/quaderno-ruby/webhook.rb
@@ -187,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Quaderno API (https://quaderno.io/docs/api)

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.1
-before_install: gem install bundler -v 1.11.2