quaderno 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 423898afe9290b9d5a056ed17c7e0ec2cb50e777
-  data.tar.gz: 7617314a3d1c18d9db47729030b8232f4de2011b
+  metadata.gz: c8752ad69dde9702c70fe935dc295170dbbbedb5
+  data.tar.gz: 44ab70967522966a4deb25b632d3e2e78b256029
 SHA512:
-  metadata.gz: ed38c65f4f96f9999c85b0b19f9fa9c31ae59db0c3ea2420600acab0f48e4f4a20434fa5a7ac86384ffb612dc4d3f774bbf8d034beb6fad96a82dc561fa25136
-  data.tar.gz: 1a9c6a1d1b737c3304bc7a5dbffab9d51c0ff74f8ddc7df571e8ae405566be39c40effdf9798a34279dd6b841c68a0a58926f4855ada5dec8dc2099ce89ea7ab
+  metadata.gz: 99ffeb8d24d6cd028cbe6eae2aa535ee9f0fcf6222ba726faecc61bc3fe9d45ea07752f6c128d6f55523a0aeae9cdce701aeed5d3c892e8983e62b6f526027b5
+  data.tar.gz: d7bbdea3bf038efd83f31b1f38d844c00104f5d83c40a22fb7f7a4f138fe68a724ee4ffe09df2b6a981c6967572adad063fe84d2e0f934b67154cc534bcb249b

data/README.md

@@ -18,7 +18,8 @@ To configure just add this to your initializers
 ```ruby
   Quaderno::Base.configure do |config|
     config.auth_token = 'my_authenticate_token'
-    config.url = 'https://my_subdomain.quadernoapp.com/api/v1/'
+    config.url = 'https://my_subdomain.quadernoapp.com/api/'
+    config.api_version = API_VERSION # Optional, defaults to the API version set in your account
   end
 ```
 
@@ -30,7 +31,7 @@ You can get your account subdomain by grabbing it from your account url or by ca
 
 ```ruby
   Quaderno::Base.authorization 'my_authenticate_token', environment
-  # => {"identity"=>{"id"=>737000, "name"=>"Walter White", "email"=>"cooking@br.bd", "href"=>"https://my_subdomain.quadernoapp.com/api/v1/"}}
+  # => {"identity"=>{"id"=>737000, "name"=>"Walter White", "email"=>"cooking@br.bd", "href"=>"https://my_subdomain.quadernoapp.com/api/"}}
 ```
 
 `environment` is an optional argument. By passing `:sandbox`, you will retrieve your credentials for the sandbox environment and not for production.
@@ -530,10 +531,18 @@ will calculate the taxes applied for a customer based on the data pased as param
 Quaderno-ruby exceptions raise depending on the type of error:
 
 ```ruby
+  Quaderno::Exceptions::UnsupportedApiVersion # Raised when the API version set is not supported.
+
   Quaderno::Exceptions::InvalidSubdomainOrToken # Raised when the credentials are wrong, missing or do not match the permission for some object.
 
+  Quaderno::Exceptions::InvalidID # Raised when the requested resource by ID does not exist in the account context.
+
+  Quaderno::Exceptions::ThrottleLimitExceeded # Raised when the throttle limit is exceeded.
+
   Quaderno::Exceptions::RateLimitExceeded # Raised when the rate limit is exceeded.
 
+  Quaderno::Exceptions::HasAssociatedDocuments # Raised when trying to delete a contact with associated documents.
+
   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"]}}'
 
 ```

data/VERSION

@@ -1 +1 @@
-1.8.0
+1.9.0

data/changelog.md

@@ -1,5 +1,8 @@
 #Changelog
 
+##1.9.0
+ * Add support for new versioning system
+
 ##1.8.0
  * Add Quaderno::Receipt support
  * Fix errors in README

data/lib/quaderno-ruby/base.rb

@@ -7,11 +7,12 @@ module Quaderno
     include Quaderno::Exceptions
     include Quaderno::Behavior::Crud
 
-    PRODUCTION_URL = 'https://quadernoapp.com/api/v1/'
-    SANDBOX_URL = 'http://sandbox-quadernoapp.com/api/v1/'
+    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
@@ -32,6 +33,10 @@ module Quaderno
       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
@@ -44,7 +49,7 @@ module Quaderno
       begin
         mode ||= :production
         url = mode == :sandbox ? SANDBOX_URL : PRODUCTION_URL
-        party_response = get("#{url}authorization.json", basic_auth: { username: auth_token })
+        party_response = get("#{url}authorization.json", basic_auth: { username: auth_token }, headers: version_header)
         return  JSON::parse party_response.body
       rescue Exception
         return false
@@ -54,7 +59,7 @@ module Quaderno
     #Check the connection
     def self.ping
       begin
-        party_response = get("#{@@url}ping.json", basic_auth: { username: auth_token })
+        party_response = get("#{@@url}ping.json", basic_auth: { username: auth_token }, headers: version_header)
         check_exception_for(party_response, { subdomain_or_token: true })
       rescue Errno::ECONNREFUSED
         return false
@@ -64,7 +69,7 @@ module Quaderno
 
     #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 })
+      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
@@ -75,6 +80,7 @@ module Quaderno
     end
 
     private
+    # Class methods
     def self.auth_token
       @@auth_token
     end
@@ -95,5 +101,9 @@ module Quaderno
     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

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

@@ -29,7 +29,7 @@ module Quaderno
         end
 
         def all(filter = nil)
-          party_response = get("#{api_model.url}#{ api_model.api_path }.json", body: filter, basic_auth: { username: api_model.auth_token })
+          party_response = get("#{api_model.url}#{ api_model.api_path }.json", body: filter, basic_auth: { username: api_model.auth_token }, headers: version_header)
           check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true })
           array = party_response.parsed_response
           collection = []
@@ -47,7 +47,7 @@ module Quaderno
         end
 
         def find(id)
-          party_response = get "#{api_model.url}#{ api_model.api_path }/#{ id }.json", basic_auth: { username: api_model.auth_token }
+          party_response = get "#{api_model.url}#{ api_model.api_path }/#{ id }.json", basic_auth: { username: api_model.auth_token }, headers: version_header
           check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true, id: true })
           hash = party_response.parsed_response
 
@@ -57,7 +57,7 @@ module Quaderno
         end
 
         def create(params)
-          party_response = post "#{api_model.url}#{ api_model.api_path }.json", body: params, basic_auth: { username: api_model.auth_token }
+          party_response = post "#{api_model.url}#{ api_model.api_path }.json", body: params, basic_auth: { username: api_model.auth_token }, headers: version_header
           check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true, required_fields: true })
           hash = party_response.parsed_response
 
@@ -67,7 +67,7 @@ module Quaderno
         end
 
         def update(id, params)
-          party_response = put "#{api_model.url}#{ api_model.api_path }/#{ id }.json", body: params, basic_auth: { username: api_model.auth_token }
+          party_response = put "#{api_model.url}#{ api_model.api_path }/#{ id }.json", body: params, basic_auth: { username: api_model.auth_token }, headers: version_header
           check_exception_for(party_response, { rate_limit: true, required_fields: true, subdomain_or_token: true, id: true })
           hash = party_response.parsed_response
 
@@ -77,7 +77,7 @@ module Quaderno
         end
 
         def delete(id)
-          party_response = HTTParty.delete "#{api_model.url}#{ api_model.api_path }/#{ id }.json", basic_auth: { username: api_model.auth_token }
+          party_response = HTTParty.delete "#{api_model.url}#{ api_model.api_path }/#{ id }.json", basic_auth: { username: api_model.auth_token }, headers: version_header
           check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true, id: true, has_documents: true })
           true
         end

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

@@ -8,7 +8,7 @@ module Quaderno
 
       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 })
+          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)
           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

@@ -11,7 +11,7 @@ module Quaderno
         end
 
         def add_payment(params)
-          party_response = api_model.post "#{api_model.url}#{ api_model.api_path }/#{ id }/payments.json", body: params, basic_auth: { username: api_model.auth_token }
+          party_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(party_response, { rate_limit: true, subdomain_or_token: true, required_fields: true })
           parsed = JSON::parse party_response.body
           instance = to_instance(Quaderno::Payment, parsed)
@@ -20,7 +20,7 @@ module Quaderno
         end
 
         def remove_payment(payment_id)
-          party_response = HTTParty.delete "#{api_model.url}#{ api_model.api_path }/#{ id }/payments/#{ payment_id }.json", basic_auth: { username: api_model.auth_token }
+          party_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
           to_delete = nil
           payments.each do |payment|
             if payment.id == payment_id

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

@@ -18,12 +18,17 @@ module Quaderno
     class ThrottleLimitExceeded < Exception
     end
 
+    class UnsupportedApiVersion < Exception
+    end
+
     def self.included(receiver)
       receiver.send :extend, ClassMethods
-    end  
+    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

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.8.0 ruby lib
+# stub: quaderno 1.9.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "quaderno"
-  s.version = "1.8.0"
+  s.version = "1.9.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 = "2016-05-09"
+  s.date = "2016-06-17"
   s.description = " A ruby wrapper for Quaderno API "
   s.email = "carlos@recrea.es"
   s.extra_rdoc_files = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quaderno
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Recrea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty