quaderno 1.13.2 → 1.17.0

data/lib/quaderno-ruby/checkout_session.rb

@@ -0,0 +1,4 @@
+class Quaderno::CheckoutSession < Quaderno::Base
+  api_model Quaderno::CheckoutSession
+  api_path 'checkout/sessions'
+end

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/contact.rb

@@ -1,9 +1,7 @@
-module Quaderno
-  class Contact < Base
-    include Quaderno::Behavior::Retrieve
+class Quaderno::Contact < Quaderno::Base
+  include Quaderno::Behavior::Retrieve
 
-    api_model Quaderno::Contact
-    api_path 'contacts'
-    retrieve_path 'customers'
-  end
-end
+  api_model Quaderno::Contact
+  api_path 'contacts'
+  retrieve_path 'customers'
+end

data/lib/quaderno-ruby/credit.rb

@@ -1,13 +1,11 @@
-module Quaderno
-  class Credit < Base
-    include Quaderno::Behavior::Deliver
-    include Quaderno::Behavior::Payment
-    include Quaderno::Behavior::Retrieve
-    include Quaderno::Behavior::Block
+class Quaderno::Credit < Quaderno::Base
+  include Quaderno::Behavior::Deliver
+  include Quaderno::Behavior::Payment
+  include Quaderno::Behavior::Retrieve
+  include Quaderno::Behavior::Block
 
-    api_model Quaderno::Credit
-    api_path 'credits'
-    retrieve_path 'refunds'
-    is_a_document? true
-  end
-end
+  api_model Quaderno::Credit
+  api_path 'credits'
+  retrieve_path 'refunds'
+  is_a_document? true
+end

data/lib/quaderno-ruby/document_item.rb

@@ -1,4 +1,2 @@
-module Quaderno
-  class DocumentItem < OpenStruct
-  end
+class Quaderno::DocumentItem < OpenStruct
 end

data/lib/quaderno-ruby/estimate.rb

@@ -1,9 +1,7 @@
-module Quaderno
-  class Estimate < Base
-    include Quaderno::Behavior::Deliver
+class Quaderno::Estimate < Quaderno::Base
+  include Quaderno::Behavior::Deliver
 
-    api_model Quaderno::Estimate
-    api_path 'estimates'
-    is_a_document? true
-  end
+  api_model Quaderno::Estimate
+  api_path 'estimates'
+  is_a_document? true
 end

data/lib/quaderno-ruby/evidence.rb

@@ -1,10 +1,8 @@
-module Quaderno
-  class Evidence < Base
-    api_model Quaderno::Evidence
-    api_path 'evidences'
+class Quaderno::Evidence < Quaderno::Base
+  api_model Quaderno::Evidence
+  api_path 'evidences'
 
-    class << self
-      undef :all, :find, :update, :delete, :parse_nested
-    end
+  class << self
+    undef :all, :find, :update, :delete, :parse_nested
   end
 end

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

@@ -1,56 +1,62 @@
-module Quaderno
-  module Exceptions
-    class BaseException < StandardError
-    end
+module Quaderno::Exceptions
+  class BaseException < StandardError
+    include Quaderno::Helpers::RateLimit
+  end
 
-    class InvalidSubdomainOrToken < BaseException
-    end
+  class InvalidSubdomainOrToken < BaseException
+  end
 
-    class InvalidID < BaseException
-    end
+  class InvalidID < BaseException
+  end
 
-    class RateLimitExceeded < BaseException
-    end
+  class RateLimitExceeded < BaseException
+  end
 
-    class HasAssociatedDocuments < BaseException
-    end
+  class HasAssociatedDocuments < BaseException
+  end
 
-    class RequiredFieldsEmptyOrInvalid < BaseException
-    end
+  class RequiredFieldsEmptyOrInvalid < BaseException
+  end
 
-    class ThrottleLimitExceeded < BaseException
-    end
+  class ThrottleLimitExceeded < BaseException
+  end
 
-    class UnsupportedApiVersion < BaseException
-    end
+  class UnsupportedApiVersion < BaseException
+  end
 
-    def self.included(receiver)
-      receiver.send :extend, ClassMethods
-    end
+  def self.included(receiver)
+    receiver.send :extend, ClassMethods
+  end
 
-    module ClassMethods
-      def check_exception_for(party_response, params = {})
-        raise(Quaderno::Exceptions::UnsupportedApiVersion, 'Unsupported API version') 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
-        end
-        if params[:rate_limit].nil? == false
-          raise(Quaderno::Exceptions::RateLimitExceeded, 'Rate limit exceeded') if party_response.response.class == Net::HTTPForbidden
-        end
-        if params[:subdomain_or_token].nil? == false
-          raise(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token') 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)
-        end
-        if params[:required_fields].nil? == false
-          raise(Quaderno::Exceptions::RequiredFieldsEmptyOrInvalid, party_response.body) 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
-        end
+  module ClassMethods
+    def check_exception_for(party_response, params = {})
+      raise_exception(Quaderno::Exceptions::UnsupportedApiVersion, 'Unsupported API version', party_response) if !!(party_response.body =~ /Unsupported API version/)
+
+      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 && 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_exception(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token', party_response) if party_response.response.class == Net::HTTPUnauthorized
       end
+      if params[:id].nil? == false
+        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_exception(Quaderno::Exceptions::RequiredFieldsEmptyOrInvalid, party_response.body, party_response) if party_response.response.class == Net::HTTPUnprocessableEntity
+      end
+      if params[:has_documents].nil? == false
+        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
+end

data/lib/quaderno-ruby/expense.rb

@@ -1,10 +1,8 @@
-module Quaderno
-  class Expense < Base
-    include Quaderno::Behavior::Payment
-    include Quaderno::Behavior::Block
+class Quaderno::Expense < Quaderno::Base
+  include Quaderno::Behavior::Payment
+  include Quaderno::Behavior::Block
 
-    api_model Quaderno::Expense
-    api_path 'expenses'
-    is_a_document? true
-  end
+  api_model Quaderno::Expense
+  api_path 'expenses'
+  is_a_document? true
 end

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

@@ -1,26 +1,24 @@
-module Quaderno
-  module Helpers
-    module Authentication
+module Quaderno::Helpers
+  module Authentication
 
-      def get_authentication(options = {})
-        mode = options[:mode] || :production
+    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/')
+      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']
+      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 }
+      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
+      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/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/income.rb

@@ -1,13 +1,11 @@
-module Quaderno
-  class Income < Base
-    include Quaderno::Behavior::Block
+class Quaderno::Income < Quaderno::Base
+  include Quaderno::Behavior::Block
 
-    class << self
-      undef :find, :update, :delete
-    end
-
-    api_model Quaderno::Income
-    api_path 'income'
-    is_a_document? true
+  class << self
+    undef :find, :update, :delete
   end
+
+  api_model Quaderno::Income
+  api_path 'income'
+  is_a_document? true
 end

data/lib/quaderno-ruby/invoice.rb

@@ -1,13 +1,11 @@
-module Quaderno
-  class Invoice < Base
-    include Quaderno::Behavior::Deliver
-    include Quaderno::Behavior::Payment
-    include Quaderno::Behavior::Retrieve
-    include Quaderno::Behavior::Block
+class Quaderno::Invoice < Quaderno::Base
+  include Quaderno::Behavior::Deliver
+  include Quaderno::Behavior::Payment
+  include Quaderno::Behavior::Retrieve
+  include Quaderno::Behavior::Block
 
-    api_model Quaderno::Invoice
-    api_path 'invoices'
-    retrieve_path 'charges'
-    is_a_document? true
-  end
+  api_model Quaderno::Invoice
+  api_path 'invoices'
+  retrieve_path 'charges'
+  is_a_document? true
 end

data/lib/quaderno-ruby/item.rb

@@ -1,7 +1,4 @@
-module Quaderno
-  class Item < Base
-
-    api_model Quaderno::Item
-    api_path 'items'
-  end
+class Quaderno::Item < Quaderno::Base
+  api_model Quaderno::Item
+  api_path 'items'
 end

data/lib/quaderno-ruby/payment.rb

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

data/lib/quaderno-ruby/receipt.rb

@@ -1,10 +1,8 @@
-module Quaderno
-  class Receipt < Base
-    include Quaderno::Behavior::Deliver
-    include Quaderno::Behavior::Block
+class Quaderno::Receipt < Quaderno::Base
+  include Quaderno::Behavior::Deliver
+  include Quaderno::Behavior::Block
 
-    api_model Quaderno::Receipt
-    api_path 'receipts'
-    is_a_document? true
-  end
+  api_model Quaderno::Receipt
+  api_path 'receipts'
+  is_a_document? true
 end

data/lib/quaderno-ruby/recurring.rb

@@ -1,8 +1,5 @@
-module Quaderno
-  class Recurring < Base
-
-    api_model Quaderno::Recurring
-    api_path 'recurring'
-    is_a_document? true
-  end
+class Quaderno::Recurring < Quaderno::Base
+  api_model Quaderno::Recurring
+  api_path 'recurring'
+  is_a_document? true
 end

data/lib/quaderno-ruby/report.rb

@@ -1,40 +1,78 @@
-module Quaderno
-  class Report < Base
-    api_model Quaderno::Report
-    api_path 'reports'
+class Quaderno::Report < Quaderno::Base
+  api_model Quaderno::Report
+  api_path 'reports'
 
-    class << self
-      undef :all, :find, :create, :update, :delete, :parse_nested
-    end
+  class << self
+    undef :all, :find, :create, :update, :delete, :parse_nested
+  end
+
+  def self.journal(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}/journal.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 })
+
+    response.parsed_response
+  end
+
+  def self.taxes(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}/taxes.json",
+      query: filter,
+      basic_auth: authentication[:basic_auth],
+      headers: version_header.merge(authentication[:headers])
+    )
 
-    def self.journal(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 }
+    check_exception_for(response, { rate_limit: true, subdomain_or_token: true })
+
+    response.parsed_response
+  end
 
-      response = get("#{authentication[:url]}#{api_model.api_path}/journal.json",
-        query: filter,
-        basic_auth: authentication[:basic_auth],
-        headers: version_header.merge(authentication[:headers])
-      )
+  def self.domestic_taxes(options = {})
+    request_tax_report('domestic_taxes', options)
+  end
+
+  def self.sales_taxes(options = {})
+    request_tax_report('sales_taxes', options)
+  end
+
+  def self.vat_moss(options = {})
+    request_tax_report('vat_moss', options)
+  end
+
+  def self.ec_sales(options = {})
+    request_tax_report('ec_sales', options)
+  end
+
+  def self.international_taxes(options = {})
+    request_tax_report('international_taxes', options)
+  end
 
-      check_exception_for(response, { rate_limit: true, subdomain_or_token: true })
+  private
 
-      response.parsed_response
-    end
+  def self.request_tax_report(tax_report_type, 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 }
 
-    def self.taxes(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}/#{tax_report_type}.json",
+      query: filter,
+      basic_auth: authentication[:basic_auth],
+      headers: version_header.merge(authentication[:headers])
+    )
 
-      response = get("#{authentication[:url]}#{api_model.api_path}/taxes.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 })
 
-      check_exception_for(response, { rate_limit: true, subdomain_or_token: true })
+    collection = Array.new
+    response.parsed_response.each { |tax_report| collection << self.new(tax_report) }
 
-      response.parsed_response
-    end
+    collection
   end
 end