quaderno 1.11.2 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 470de4559fa2e97d4765b34b5d73613c8dd1f388
-  data.tar.gz: 437161875f0a344443d824d40998c115446600db
+  metadata.gz: 99d18f2cc67c9df4eb49d8bf5c545a966c6ff520
+  data.tar.gz: 2e605b26ce41c9f45b8871852b4cd5251e14f8d5
 SHA512:
-  metadata.gz: 06dde9c589f2dbcb3e56e2aed929798a94035f024db6a2c5ea6fabb1a1e5e9571170ead4522d74a13efb2dfacb844513dd75dd01dd761ccaf18464317a558b92
-  data.tar.gz: 7fa2dee669868d93400484a84e8f7f2a55279366a803230e1695c087c53e3f67acbc7c4d76e8b3e8fef29976487d270506e65a08f3c7ca722b8fad751c16c260
+  metadata.gz: 918acf002048a31ff6f8830d23d72e8ba1a66825aba93322e9a9c1c86e6d8bd4d80ee47f3084bba1bc18c886af56c31f29dd5b6875b675155e3fe4f19b8ca97d
+  data.tar.gz: 70fecee7f72f788b1d35c4936199dfae703d89f7b9f824b1c29c266af9af90209f5182867b09ce0790f8be50600b129833db420ff306995c61bc9d13f40f158d

data/Gemfile.lock

@@ -29,7 +29,7 @@ GEM
     httparty (0.13.1)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
-    i18n (0.6.9)
+    i18n (0.7.0)
     jeweler (2.0.1)
       builder
       bundler (>= 1.0)

data/README.md

@@ -3,7 +3,7 @@
 Quaderno-ruby is a ruby wrapper for [Quaderno API] (https://github.com/quaderno/quaderno-api).
 As the API, it's mostly CRUD.
 
-Current version is 1.11.2 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
+Current version is 1.12.0 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
 
 ## Installation & Configuration
 
@@ -588,6 +588,58 @@ Quaderno-ruby exceptions raise depending on the type of error:
 
 All those exceptions inherit from `Quaderno::Exceptions::BaseException`.
 
+### Pagination information
+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.class #=> Quaderno::Collection
+collection.pagination_info #=> {:current_page=>"1", :total_pages=>"3"}
+collection.current_page #=> "2"
+collection.total_pages #=> "3"
+```
+
+### Thread-safe configuration
+
+If you are managing multiple accounts you may need a thread-safe way to configure the credentials. You can do it by passing the credentials on each request:
+
+```ruby
+Quaderno::Invoice.all(
+  api_url: 'https://my_subdomain.quadernoapp.com/api/',
+  auth_token: 'my_authenticate_token'
+)
+
+Quaderno::Invoice.find(INVOICE_ID,
+  api_url: 'https://my_subdomain.quadernoapp.com/api/',
+  auth_token: 'my_authenticate_token'
+)
+
+Quaderno::Invoice.update(INVOICE_ID,
+  po_number: '12345',
+  api_url: 'https://my_subdomain.quadernoapp.com/api/',
+  auth_token: 'my_authenticate_token'
+)
+
+invoice = Quaderno::Invoice.find(INVOICE_ID,
+  api_url: 'https://my_subdomain.quadernoapp.com/api/',
+  auth_token: 'my_authenticate_token'
+)
+
+invoice.add_payment(params) # Credentials are already stored on the Quaderno::Invoice instance from the first request
+
+invoice = Quaderno::Invoice.find(INVOICE_ID,
+  api_url: 'https://my_subdomain.quadernoapp.com/api/',
+  auth_token: 'my_authenticate_token'
+)
+invoice.remove_payment(PAYMENT_ID) # Credentials are already stored on the Quaderno::Invoice instance from the first request
+
+Quaderno::Invoice.delete(INVOICE_ID,
+  api_url: 'https://my_subdomain.quadernoapp.com/api/',
+  auth_token: 'my_authenticate_token'
+)
+```
+
 ## More information
 
 Remember this is only a ruby wrapper for the original API. If you want more information about the API itself, head to the original [API documentation](https://quaderno.io/docs/api/).

data/VERSION

@@ -1 +1 @@
-1.11.2
+1.12.0

data/changelog.md

@@ -1,4 +1,7 @@
 #Changelog
+##1.12.0
+* Added thread-safe credentials configuration.
+* `all` methods returns a `Quaderno::Object` with pagination info instead of an `Array`
 
 ##1.11.2
 * Specify `Content-Type` header so `HTTParty` don't merge the elements within the body content.

data/lib/quaderno-ruby/base.rb

@@ -6,6 +6,7 @@ module Quaderno
     include HTTParty
     include Quaderno::Exceptions
     include Quaderno::Behavior::Crud
+    include Quaderno::Helpers::Authentication
 
     PRODUCTION_URL = 'https://quadernoapp.com/api/'
     SANDBOX_URL = 'http://sandbox-quadernoapp.com/api/'
@@ -58,9 +59,18 @@ module Quaderno
     end
 
     #Check the connection
-    def self.ping
+    def self.ping(options = {})
       begin
-        party_response = get("#{@@url}ping.json", basic_auth: { username: auth_token }, headers: version_header)
+        options[:auth_token] ||= auth_token
+        options[:url] ||= url
+
+        authentication = get_authentication(options)
+
+        party_response = get("#{authentication[:url]}ping.json",
+          basic_auth: authentication[:basic_auth],
+          headers: version_header.merge(authentication[:headers])
+        )
+
         check_exception_for(party_response, { subdomain_or_token: true })
       rescue Errno::ECONNREFUSED
         return false

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

@@ -1,11 +1,14 @@
 module Quaderno
   module Behavior
     module Crud
+
       def self.included(receiver)
         receiver.send :extend, ClassMethods
       end
 
       module ClassMethods
+        include Quaderno::Helpers::Authentication
+
         def parse_nested(element)
           if element.has_key?('payments')
             payments_collection = Array.new
@@ -21,14 +24,23 @@ module Quaderno
           element
         end
 
-        def all(filter = nil)
-          response = get("#{api_model.url}#{ api_model.api_path }.json", body: filter, basic_auth: { username: api_model.auth_token }, headers: version_header)
+        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 }
+
+          response = get("#{authentication[:url]}#{api_model.api_path}.json",
+            query: filter,
+            basic_auth: authentication[:basic_auth],
+            headers: version_header.merge(authentication[:headers])
+          )
+
           check_exception_for(response, { rate_limit: true, subdomain_or_token: true })
           array = response.parsed_response
-          collection = Array.new
+          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
@@ -36,41 +48,74 @@ module Quaderno
             array.each { |element| collection << (new element) }
           end
 
+          collection.current_page = response.headers['x-pages-currentpage']
+          collection.total_pages = response.headers['x-pages-totalpages']
+
           collection
         end
 
-        def find(id)
-          response = get "#{api_model.url}#{ api_model.api_path }/#{ id }.json", basic_auth: { username: api_model.auth_token }, headers: version_header
+        def find(id, options = {})
+          authentication = get_authentication(options.merge(api_model: api_model))
+
+          response = get("#{authentication[:url]}#{api_model.api_path}/#{id}.json",
+            basic_auth: authentication[:basic_auth],
+            headers: version_header.merge(authentication[:headers])
+          )
+
           check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true })
           hash = response.parsed_response
+          hash[:authentication_data] = authentication
 
           api_model.parse_nested(hash) if is_a_document?
 
           new hash
         end
 
-        def create(params)
-          response = post "#{api_model.url}#{ api_model.api_path }.json", body: params.to_json, basic_auth: { username: api_model.auth_token }, headers: version_header.merge('Content-Type' => 'application/json')
+        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 }
+
+          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')
+          )
+
           check_exception_for(response, { rate_limit: true, subdomain_or_token: true, required_fields: true })
           hash = response.parsed_response
+          hash[:authentication_data] = authentication
 
           api_model.parse_nested(hash) if is_a_document?
 
           new hash
         end
 
-        def update(id, params)
-          response = put "#{api_model.url}#{ api_model.api_path }/#{ id }.json", body: params.to_json, basic_auth: { username: api_model.auth_token }, headers: version_header.merge('Content-Type' => 'application/json')
+        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 }
+
+          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')
+          )
+
           check_exception_for(response, { rate_limit: true, required_fields: true, subdomain_or_token: true, id: true })
           hash = response.parsed_response
+          hash[:authentication_data] = authentication
 
           api_model.parse_nested(hash) if is_a_document?
 
           new hash
         end
 
-        def delete(id)
-          response = HTTParty.delete "#{api_model.url}#{ api_model.api_path }/#{ id }.json", basic_auth: { username: api_model.auth_token }, headers: version_header
+        def delete(id, options = {})
+          authentication = get_authentication(options.merge(api_model: api_model))
+
+          response = HTTParty.delete("#{authentication[:url]}#{ api_model.api_path }/#{ id }.json",
+            basic_auth: authentication[:basic_auth],
+            headers: version_header.merge(authentication[:headers])
+          )
           check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true, has_documents: true })
 
           true

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

@@ -7,8 +7,16 @@ module Quaderno
       end
 
       module InstanceMethods
-        def deliver
-          party_response = api_model.get("#{api_model.url}#{ api_model.api_path }/#{ id }/deliver.json", basic_auth: { username: api_model.auth_token }, headers: self.class.version_header)
+        include Quaderno::Helpers::Authentication
+
+        def deliver(options = nil)
+          self.authentication_data = get_authentication(options.merge(api_model: api_model)) if options.is_a?(Hash)
+
+          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])
+          )
+
           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 }
         end

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

@@ -1,14 +1,26 @@
 module Quaderno
   module Behavior
     module Payment
+
       def self.included(base)
         base.send :include, InstanceMethods
       end
 
       module InstanceMethods
+        include Quaderno::Helpers::Authentication
+
+        def add_payment(params = {})
+          if (params.keys.map(&:to_s) & %w(auth_token access_token api_url mode api_model)).any?
+            self.authentication_data = get_authentication(params.merge(api_model: api_model))
+            params = params.delete_if { |k, _| %w(auth_token access_token api_url mode api_model).include? k.to_s }
+          end
+
+          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])
+          )
 
-        def add_payment(params)
-          response = api_model.post "#{api_model.url}#{ api_model.api_path }/#{ id }/payments.json", body: params, basic_auth: { username: api_model.auth_token }, headers: self.class.version_header
           api_model.check_exception_for(response, { rate_limit: true, subdomain_or_token: true, required_fields: true })
 
           instance = Quaderno::Payment.new(response.parsed_response)
@@ -17,8 +29,15 @@ module Quaderno
           Quaderno::Payment.new instance
         end
 
-        def remove_payment(payment_id)
-          response = HTTParty.delete "#{api_model.url}#{ api_model.api_path }/#{ id }/payments/#{ payment_id }.json", basic_auth: { username: api_model.auth_token }, headers: self.class.version_header
+        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])
+          )
+
           api_model.check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true })
 
           self.payments.delete_if { |payment| payment.id == payment_id }

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

@@ -1,16 +1,25 @@
 module Quaderno
   module Behavior
     module Retrieve
+
       def self.included(receiver)
         receiver.send :extend, ClassMethods
       end
 
       module ClassMethods
+        include Quaderno::Helpers::Authentication
+
+        def retrieve(gateway_id, gateway = 'stripe', options = {})
+          authentication = get_authentication(options.merge(api_model: api_model))
+
+          response = get("#{authentication[:url]}#{gateway}/#{@_retrieve_path}/#{gateway_id}.json",
+            basic_auth: authentication[:basic_auth],
+            headers: version_header.merge(authentication[:headers])
+          )
 
-        def retrieve(gateway_id, gateway = nil)
-          response = get "#{api_model.url}#{gateway || 'stripe'}/#{@_retrieve_path}/#{gateway_id}.json", basic_auth: { username: api_model.auth_token }, headers: version_header
           check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true })
           hash = response.parsed_response
+          hash[:authentication_data] = authentication
 
           new hash
         end

data/lib/quaderno-ruby/collection.rb

@@ -0,0 +1,22 @@
+class Quaderno::Collection < Array
+
+  def current_page=(page_number)
+    @page = page_number
+  end
+
+  def current_page
+    @page || 1
+  end
+
+  def total_pages=(total_pages)
+    @total_pages = total_pages
+  end
+
+  def total_pages
+    @total_pages || 1
+  end
+
+  def pagination_info
+    { current_page: current_page, total_pages: total_pages }
+  end
+end

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

@@ -0,0 +1,26 @@
+module Quaderno
+  module Helpers
+    module Authentication
+
+      def get_authentication(options = {})
+        mode = options[:mode] || :production
+
+        local_api_model = options[:api_model]
+        url = options[:api_url] || (local_api_model && local_api_model.url) || (mode == :production ? 'https://quadernoapp.com/api/' : 'http://sandbox-quadernoapp.com/api/')
+
+        auth_token = options[:auth_token] || options['auth_token'] || (local_api_model && local_api_model.auth_token)
+        access_token = options[:access_token] || options['access_token']
+
+        authentication = { url: url, headers: {}, basic_auth: nil }
+
+        if access_token
+          authentication[:headers] = { 'Authorization' => "Bearer #{access_token}" }
+        elsif auth_token
+          authentication[:basic_auth] = { username: auth_token }
+        end
+
+        authentication
+      end
+    end
+  end
+end

data/lib/quaderno-ruby.rb

@@ -1,7 +1,10 @@
 require 'ostruct'
 
 require 'quaderno-ruby/exceptions/exceptions'
-%w(crud deliver payment retrieve).each { |filename| require "quaderno-ruby/behavior/#{ filename }" }
+require 'quaderno-ruby/helpers/authentication'
+require 'quaderno-ruby/collection'
+
+%w(crud deliver payment retrieve).each { |filename| require "quaderno-ruby/behavior/#{filename}" }
 %w(base contact item invoice receipt credit estimate expense recurring document_item evidence payment webhook tax).each { |filename| require "quaderno-ruby/#{ filename }" }
 
 module Quaderno

data/quaderno.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: quaderno 1.11.2 ruby lib
+# stub: quaderno 1.12.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "quaderno"
-  s.version = "1.11.2"
+  s.version = "1.12.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Recrea"]
-  s.date = "2017-03-14"
+  s.date = "2017-06-14"
   s.description = " A ruby wrapper for Quaderno API "
   s.email = "carlos@recrea.es"
   s.extra_rdoc_files = [
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
     "lib/quaderno-ruby/behavior/deliver.rb",
     "lib/quaderno-ruby/behavior/payment.rb",
     "lib/quaderno-ruby/behavior/retrieve.rb",
+    "lib/quaderno-ruby/collection.rb",
     "lib/quaderno-ruby/contact.rb",
     "lib/quaderno-ruby/credit.rb",
     "lib/quaderno-ruby/document_item.rb",
@@ -40,6 +41,7 @@ Gem::Specification.new do |s|
     "lib/quaderno-ruby/evidence.rb",
     "lib/quaderno-ruby/exceptions/exceptions.rb",
     "lib/quaderno-ruby/expense.rb",
+    "lib/quaderno-ruby/helpers/authentication.rb",
     "lib/quaderno-ruby/invoice.rb",
     "lib/quaderno-ruby/item.rb",
     "lib/quaderno-ruby/payment.rb",
@@ -50,18 +52,21 @@ Gem::Specification.new do |s|
     "quaderno.gemspec",
     "test/fixtures/quaderno_cassettes/.DS_Store",
     "test/fixtures/quaderno_cassettes/all_contacts.yml",
+    "test/fixtures/quaderno_cassettes/all_contacts_by_access_token.yml",
+    "test/fixtures/quaderno_cassettes/all_contacts_by_authentication_token.yml",
     "test/fixtures/quaderno_cassettes/all_estimates.yml",
     "test/fixtures/quaderno_cassettes/all_expenses.yml",
     "test/fixtures/quaderno_cassettes/all_invoices.yml",
     "test/fixtures/quaderno_cassettes/all_items.yml",
     "test/fixtures/quaderno_cassettes/all_receipts.yml",
     "test/fixtures/quaderno_cassettes/all_webhooks.yml",
-    "test/fixtures/quaderno_cassettes/calculate_tax.yml",
     "test/fixtures/quaderno_cassettes/create_estimate_on_downgraded_API.yml",
     "test/fixtures/quaderno_cassettes/create_expense_on_downgraded_API.yml",
     "test/fixtures/quaderno_cassettes/create_invoice_on_downgraded_API.yml",
     "test/fixtures/quaderno_cassettes/create_receipt_on_downgraded_API.yml",
     "test/fixtures/quaderno_cassettes/deleted_contact.yml",
+    "test/fixtures/quaderno_cassettes/deleted_contact_by_access_token.yml",
+    "test/fixtures/quaderno_cassettes/deleted_contact_by_authentication_token.yml",
     "test/fixtures/quaderno_cassettes/deleted_estimate.yml",
     "test/fixtures/quaderno_cassettes/deleted_expense.yml",
     "test/fixtures/quaderno_cassettes/deleted_invoice.yml",
@@ -73,6 +78,8 @@ Gem::Specification.new do |s|
     "test/fixtures/quaderno_cassettes/delivered_receipt.yml",
     "test/fixtures/quaderno_cassettes/evidence_invoice.yml",
     "test/fixtures/quaderno_cassettes/found_contact.yml",
+    "test/fixtures/quaderno_cassettes/found_contact_by_access_token.yml",
+    "test/fixtures/quaderno_cassettes/found_contact_by_authentication_token.yml",
     "test/fixtures/quaderno_cassettes/found_estimate.yml",
     "test/fixtures/quaderno_cassettes/found_expense.yml",
     "test/fixtures/quaderno_cassettes/found_invoice.yml",
@@ -80,6 +87,8 @@ Gem::Specification.new do |s|
     "test/fixtures/quaderno_cassettes/found_receipt.yml",
     "test/fixtures/quaderno_cassettes/found_webhook.yml",
     "test/fixtures/quaderno_cassettes/new_contact.yml",
+    "test/fixtures/quaderno_cassettes/new_contact_by_access_token.yml",
+    "test/fixtures/quaderno_cassettes/new_contact_by_authentication_token.yml",
     "test/fixtures/quaderno_cassettes/new_estimate.yml",
     "test/fixtures/quaderno_cassettes/new_evidence.yml",
     "test/fixtures/quaderno_cassettes/new_expense.yml",
@@ -93,6 +102,8 @@ Gem::Specification.new do |s|
     "test/fixtures/quaderno_cassettes/unpay_an_expense.yml",
     "test/fixtures/quaderno_cassettes/unpay_an_invoice.yml",
     "test/fixtures/quaderno_cassettes/updated_contact.yml",
+    "test/fixtures/quaderno_cassettes/updated_contact_by_access_token.yml",
+    "test/fixtures/quaderno_cassettes/updated_contact_by_authentication_token.yml",
     "test/fixtures/quaderno_cassettes/updated_estimate.yml",
     "test/fixtures/quaderno_cassettes/updated_expense.yml",
     "test/fixtures/quaderno_cassettes/updated_invoice.yml",
@@ -101,9 +112,9 @@ Gem::Specification.new do |s|
     "test/fixtures/quaderno_cassettes/updated_webhook.yml",
     "test/fixtures/quaderno_cassettes/validate_invalid_VAT_number.yml",
     "test/fixtures/quaderno_cassettes/validate_valid_VAT_number.yml",
-    "test/fixtures/quaderno_cassettes/wrong_token.yml",
     "test/helper.rb",
     "test/unit/test_quaderno_contacts.rb",
+    "test/unit/test_quaderno_contacts_thread_safe.rb",
     "test/unit/test_quaderno_estimates.rb",
     "test/unit/test_quaderno_evidences.rb",
     "test/unit/test_quaderno_expenses.rb",