quaderno 1.13.2 → 1.17.0

data/Rakefile

@@ -1,52 +1,6 @@
-# encoding: utf-8
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
+RSpec::Core::RakeTask.new(:spec)
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "quaderno"
-  gem.homepage = "http://github.com/quaderno/quaderno-ruby"
-  gem.license = "MIT"
-  gem.summary = %Q{one-line summary of your gem}
-  gem.description = %Q{ A ruby wrapper for Quaderno API }
-  gem.email = "carlos@recrea.es"
-  gem.authors = ["Recrea"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-desc "Code coverage detail"
-task :simplecov do
-  ENV['COVERAGE'] = "true"
-  Rake::Task['test'].execute
-end
-
-
-task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "quaderno-ruby #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task :default => :spec

data/changelog.md

@@ -1,145 +1,171 @@
-#Changelog
-##1.13.2
+# 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
+* Relax `httparty` version requirement.
+
+## 1.15.1
+* Fix `Quaderno` load order.
+
+## 1.15.0
+* Removed `jeweler` and updated the gem structure.
+
+## 1.14.0
+* Added `domestic_taxes`, `sales_taxes`, `vat_moss`, `ec_sales` and `international_taxes` to `Quaderno::Report`
+
+## 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

@@ -1,12 +1,12 @@
+class Quaderno
+end
+
 require 'ostruct'
 
+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 }" }
-
-module Quaderno
-
-end
+%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

@@ -1,136 +1,141 @@
-module Quaderno
-  require 'httparty'
-  require 'json'
-
-  class Base < OpenStruct
-    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/'
-
-    @@auth_token = nil
-    @@rate_limit_info = nil
-    @@api_version = nil
-    @@url = PRODUCTION_URL
-
-    # Class methods
-    def self.api_model(klass)
-      instance_eval <<-END
-        def api_model
-          #{klass}
-        end
-      END
-      class_eval <<-END
-        def api_model
-          #{klass}
-        end
-      END
-    end
-
-    def self.configure
-      yield self
-    end
-
-    def self.api_version=(api_version)
-      @@api_version = api_version
-    end
-
-    def self.auth_token=(auth_token)
-      @@auth_token = auth_token
-    end
+require 'httparty'
+require 'json'
+
+class Quaderno::Base < OpenStruct
+  include HTTParty
+  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/'
+
+  @@auth_token = nil
+  @@rate_limit_info = nil
+  @@api_version = nil
+  @@url = PRODUCTION_URL
+
+  # Class methods
+  def self.api_model(klass)
+    instance_eval <<-END
+      def api_model
+        #{klass}
+      end
+    END
+    class_eval <<-END
+      def api_model
+        #{klass}
+      end
+    END
+  end
 
-    def self.url=(url)
-      @@url = url
-    end
+  def self.configure
+    yield self
+  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)
+  def self.api_version=(api_version)
+    @@api_version = api_version
+  end
 
-      if response.code == 200
-        response.parsed_response
-      else
-        raise(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token')
-      end
-    end
+  def self.auth_token=(auth_token)
+    @@auth_token = auth_token
+  end
 
-    #Check the connection
-    def self.ping(options = {})
-      begin
-        options[:auth_token] ||= auth_token
-        options[:api_url] ||= url
+  def self.url=(url)
+    @@url = url
+  end
 
-        authentication = get_authentication(options)
+  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)
 
-        party_response = get("#{authentication[:url]}ping.json",
-          basic_auth: authentication[:basic_auth],
-          headers: version_header.merge(authentication[:headers])
-        )
+    if response.code == 200
+      data = self.new(response.parsed_response)
+      data.rate_limit_info = response
 
-        check_exception_for(party_response, { subdomain_or_token: true })
-      rescue Errno::ECONNREFUSED
-        return false
-      end
-      true
+      data
+    else
+      raise_exception(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token', response)
     end
+  end
 
-    def self.me(options = {})
+  #Check the connection
+  def self.ping(options = {})
+    begin
       options[:auth_token] ||= auth_token
       options[:api_url] ||= url
 
       authentication = get_authentication(options)
 
-      party_response = get("#{authentication[:url]}me.json",
+      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 })
-
-      party_response.parsed_response
+    rescue Errno::ECONNREFUSED
+      return Quaderno::Base.new({ status: false })
     end
 
-    #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 }
-    end
+    data = self.new({ status: true })
+    data.rate_limit_info = party_response
 
-    # Instance methods
-    def to_hash
-      self.marshal_dump
-    end
+    data
+  end
+  class <<self
+    alias_method :rate_limit_info, :ping
+  end
 
-    private
-    # Class methods
-    def self.auth_token
-      @@auth_token
-    end
+  def self.me(options = {})
+    options[:auth_token] ||= auth_token
+    options[:api_url] ||= url
 
-    def self.url
-      @@url
-    end
+    authentication = get_authentication(options)
 
-    def self.subdomain
-      @_subdomain = @@subdomain
-    end
+    party_response = get("#{authentication[:url]}me.json",
+      basic_auth: authentication[:basic_auth],
+      headers: version_header.merge(authentication[:headers])
+    )
 
-    #Set or returns the model path for the url
-    def self.api_path(api_path = nil)
-      @_api_path ||= api_path
-    end
+    check_exception_for(party_response, { subdomain_or_token: true })
 
-    def self.is_a_document?(document = nil)
-      @_document ||= document
-    end
+    data = self.new(party_response.parsed_response)
+    data.rate_limit_info = party_response
 
-    def self.version_header
-      { 'Accept' => @@api_version.to_i.zero? ? "application/json" : "application/json; api_version=#{@@api_version.to_i}"}
-    end
+    data
+  end
+
+  # Instance methods
+  def to_hash
+    self.marshal_dump
+  end
+
+  private
+  # Class methods
+  def self.auth_token
+    @@auth_token
+  end
+
+  def self.url
+    @@url
+  end
+
+  def self.subdomain
+    @_subdomain = @@subdomain
+  end
+
+  #Set or returns the model path for the url
+  def self.api_path(api_path = nil)
+    @_api_path ||= api_path
+  end
+
+  def self.is_a_document?(document = nil)
+    @_document ||= document
+  end
+
+  def self.version_header
+    { 'Accept' => @@api_version.to_i.zero? ? "application/json" : "application/json; api_version=#{@@api_version.to_i}"}
   end
-end
+end