quaderno 1.3.2 → 1.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YWU4MDljODQ0MWYwMzk4ZjcwMWVkMDhhYjhjMjM0MDFiZDA1MDcwOA==
-  data.tar.gz: !binary |-
-    MWEyNGVhOTAzYjcyMzE1YTYyOTFlM2EwZWY2MzljZmM5NWQyNTRjMw==
+SHA1:
+  metadata.gz: 6a856c49bdf181c9122a299d38bf1c6f4feb9b88
+  data.tar.gz: 707680768d69048f3e519935fa4376e78ca3da59
 SHA512:
-  metadata.gz: !binary |-
-    YjBhNzg1M2ExOGUwYjZjOTcxYmRlYmZhZTFmYmUxNGQ3YjZkNTcwNjdiZjAy
-    ZWNlNDZjZDUxYjAzZTA5ZTIzNjhiMzI1YjkyMjI0ZjI3ZjdhZWNmZjFjNDk1
-    NDQzNDdkYTUwZGIwNzExYzMzNTZkZjA2NWI3NzUwZDdjMTQ5NDA=
-  data.tar.gz: !binary |-
-    N2NjODQ0MzdmNzMxZTFiNjI2MzQyZjIyODJkZjQwZTg2ZGQ1ZDM0YzFkODYy
-    Mjc1Nzg3MDdmNDA0OTk2NGM3ZjFmMDk0MDU0NzVkNDI3ODZmZDMwNjc4NmRh
-    ZGMzMDYzZmEyZWMyMmQ4OTY3OWUzMDQxNGVhNjM4ZTJhOWJhYWU=
+  metadata.gz: 06b18625ae1df44c45478df0c967a51a7c1a96fe6f5c2239bf2624afd4e16dd7260e6ed9e16a907b9f9531055bd92c73d5205bf153ebb910bd728bc4ec232259
+  data.tar.gz: ec16cf079c71679f5b0b785991d59425f117aaea939928c4d299843c2a9ba2e1268bf40fe1e83bbe4b9baf9c8a2dc2cdc08814f3ad24b6968bd6e254526b77f1

data/README.md

@@ -3,7 +3,7 @@
 Quaderno-ruby is a ruby wrapper for [quaderno api] (https://github.com/recrea/quaderno-api). 
 As the API, it's mostly CRUD.
 
-Current version is 1.3.1. See the changelog [here](https://github.com/recrea/quaderno-ruby/blob/master/changelog.md)
+Current version is 1.3.2. See the changelog [here](https://github.com/recrea/quaderno-ruby/blob/master/changelog.md)
 
 ## Installation & Configuration
 
@@ -321,6 +321,50 @@ will update the specified expense with the data of the hash passed as second par
 will delete the expense with the id passed as parameter.
 
 
+## Managing webhooks
+
+### Getting webhooks
+```ruby
+ Quaderno::Webhook.all() #=> Array
+```
+
+ will return an array with all the webhooks you have subscribed.
+ 
+### Finding an webhook
+```ruby
+ Quaderno::Webhook.find(id) #=> Quaderno::Webhook
+```
+
+will return the webhook with the id passed as parameter.
+
+### Creating a new webhook
+```ruby
+ Quaderno::Webhook.create(params) #=> Quaderno::Webhook
+```
+
+will create a webhook using the information of the hash passed as parameter and return an instance of Quaderno::Webhook with the created webhook.
+
+### Updating an existing webhook
+```ruby
+ Quaderno::Webhook.update(id, params) #=> Quaderno::Webhook
+```
+
+will update the specified webhook with the data of the hash passed as second parameter.
+
+### Deleting a webhook
+```ruby
+  Quaderno::Webhook.delete(id) #=> Boolean
+```
+
+## Taxes
+
+### Calculating taxes
+```ruby
+ Quaderno::Tax.calculate(params) #=> Quaderno::Tax
+```
+
+will calculate the taxes applied for a customer based on the data pased as parameters.
+
 ## Quaderno-api 
 
 For further information, please visit [quaderno api] (https://github.com/recrea/quaderno-api) wiki

data/VERSION

@@ -1 +1 @@
-1.3.2
+1.4.0

data/changelog.md

@@ -1,4 +1,8 @@
 #Changelog
+##1.4.0
+* Added taxes calculations support
+* Added webhooks documentation 
+
 ##1.3.2
 
 * Use new urls format

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

@@ -30,7 +30,7 @@ module Quaderno
         def all(filter = nil)
           party_response = get("#{api_model.base_url}/api/v1/#{ api_model.api_path }.json", body: filter, basic_auth: { username: api_model.auth_token })
           check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true })
-          array = JSON::parse party_response.body
+          array = party_response.parsed_response
           collection = []
           array.each do |element|  
             if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
@@ -44,7 +44,7 @@ module Quaderno
         def find(id)
           party_response = get "#{api_model.base_url}/api/v1/#{ api_model.api_path }/#{ id }.json", basic_auth: { username: api_model.auth_token }
           check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true, id: true })       
-          hash = JSON::parse party_response.body
+          hash = parse party_response.parsed_response
           if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
             api_model.parse(hash)
           end
@@ -54,7 +54,7 @@ module Quaderno
         def create(params)
           party_response = post "#{api_model.base_url}/api/v1/#{ api_model.api_path }.json", body: params, basic_auth: { username: api_model.auth_token }
           check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true, required_fields: true })
-          hash = JSON::parse party_response.body
+          hash = party_response..parsed_response
           if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
             api_model.parse(hash)
           end
@@ -64,7 +64,7 @@ module Quaderno
         def update(id, params)
           party_response = put "#{api_model.base_url}/api/v1/#{ api_model.api_path }/#{ id }.json", body: params, basic_auth: { username: api_model.auth_token }
           check_exception_for(party_response, { rate_limit: true, subdomain_or_token: true, id: true })
-          hash = JSON::parse party_response.body                        
+          hash = party_response..parsed_response                      
           if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
             api_model.parse(hash)
           end

data/lib/quaderno-ruby/tax.rb

@@ -0,0 +1,16 @@
+module Quaderno
+  class Tax < Base
+    api_model Quaderno::Tax
+    api_path 'taxes'
+    
+    class << self
+      undef :all, :find, :create, :update, :delete, :parse
+    end
+    
+    def self.calculate(params)
+      party_response = get("#{self.base_url}/api/v1/taxes/calculate.json", query: params, basic_auth: { username: api_model.auth_token } )
+      check_exception_for(party_response, { rate_limit: true, subdomain_or_token: true, id: true })
+      new party_response.parsed_response
+    end
+  end
+end

data/lib/quaderno-ruby.rb

@@ -2,7 +2,7 @@ require 'ostruct'
 
 require 'quaderno-ruby/exceptions/exceptions'
 %w(crud deliver payment).each { |filename| require "quaderno-ruby/behavior/#{ filename }" }
-%w(base contact item invoice estimate expense document_item payment webhook).each { |filename| require "quaderno-ruby/#{ filename }" }
+%w(base contact item invoice estimate expense document_item payment webhook tax).each { |filename| require "quaderno-ruby/#{ filename }" }
 
 module Quaderno
 

data/quaderno.gemspec

@@ -2,15 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: quaderno 1.3.2 ruby lib
+# stub: quaderno 1.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "quaderno"
-  s.version = "1.3.2"
+  s.version = "1.4.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 = "2014-07-01"
+  s.date = "2014-11-27"
   s.description = "longer description of your gem"
   s.email = "carlos@recrea.es"
   s.extra_rdoc_files = [
@@ -40,9 +41,9 @@ Gem::Specification.new do |s|
     "lib/quaderno-ruby/invoice.rb",
     "lib/quaderno-ruby/item.rb",
     "lib/quaderno-ruby/payment.rb",
+    "lib/quaderno-ruby/tax.rb",
     "lib/quaderno-ruby/webhook.rb",
     "quaderno.gemspec",
-    "test/fixtures/.DS_Store",
     "test/fixtures/quaderno_cassettes/.DS_Store",
     "test/fixtures/quaderno_cassettes/all_contacts.yml",
     "test/fixtures/quaderno_cassettes/all_estimates.yml",
@@ -50,6 +51,7 @@ Gem::Specification.new do |s|
     "test/fixtures/quaderno_cassettes/all_invoices.yml",
     "test/fixtures/quaderno_cassettes/all_items.yml",
     "test/fixtures/quaderno_cassettes/all_webhooks.yml",
+    "test/fixtures/quaderno_cassettes/calculate_tax.yml",
     "test/fixtures/quaderno_cassettes/deleted_contact.yml",
     "test/fixtures/quaderno_cassettes/deleted_estimate.yml",
     "test/fixtures/quaderno_cassettes/deleted_expense.yml",
@@ -81,18 +83,19 @@ Gem::Specification.new do |s|
     "test/fixtures/quaderno_cassettes/updated_invoice.yml",
     "test/fixtures/quaderno_cassettes/updated_item.yml",
     "test/fixtures/quaderno_cassettes/updated_webhook.yml",
+    "test/fixtures/quaderno_cassettes/wrong_token.yml",
     "test/helper.rb",
     "test/unit/test_quaderno_contacts.rb",
     "test/unit/test_quaderno_estimates.rb",
     "test/unit/test_quaderno_expenses.rb",
     "test/unit/test_quaderno_invoices.rb",
     "test/unit/test_quaderno_items.rb",
+    "test/unit/test_quaderno_tax.rb",
     "test/unit/test_quaderno_webhooks.rb"
   ]
   s.homepage = "http://github.com/recrea/quaderno-ruby"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "2.1.11"
+  s.rubygems_version = "2.2.2"
   s.summary = "one-line summary of your gem"
 
   if s.respond_to? :specification_version then

data/test/fixtures/quaderno_cassettes/calculate_tax.yml

@@ -0,0 +1,109 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://fMLf9TGWrRqNxJ4chcVi@assur-744.quadernoapp.com/api/v1/taxes/calculate.json?country=ES&postal_code=08080
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      authorization:
+      - Basic Zk1MZjlUR1dyUnFOeEo0Y2hjVmk6
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/1.6.0
+      date:
+      - Thu, 27 Nov 2014 12:26:48 GMT
+      content-type:
+      - application/json; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      status:
+      - 200 OK
+      x-ratelimit-limit:
+      - '2000'
+      x-ratelimit-remaining:
+      - '1972'
+      x-ua-compatible:
+      - IE=Edge,chrome=1
+      etag:
+      - '"f878d3db85579985c01bbf45f95467be"'
+      cache-control:
+      - must-revalidate, private, max-age=0
+      set-cookie:
+      - ahoy_visitor=79b5dcb1-53a0-4442-a610-9ce1b6eedc78; domain=.quadernoapp.com;
+        path=/; expires=Sun, 27-Nov-2016 12:26:48 GMT
+      - ahoy_visit=e7d4c176-89dc-45eb-a6ee-ec4192de018b; domain=.quadernoapp.com;
+        path=/; expires=Thu, 27-Nov-2014 16:26:48 GMT
+      - ahoy_track=true; domain=.quadernoapp.com; path=/
+      x-request-id:
+      - f54a921a8b1a89be6571392105406e1c
+      x-runtime:
+      - '0.121124'
+      x-rack-cache:
+      - miss
+    body:
+      encoding: UTF-8
+      string: '{"name":"VAT","rate":21.0,"notes":null}'
+    http_version: '1.1'
+  recorded_at: Thu, 27 Nov 2014 12:17:23 GMT
+- request:
+    method: get
+    uri: https://fMLf9TGWrRqNxJ4chcVi@assur-744.quadernoapp.com/api/v1/taxes/calculate.json?country=ES&postal_code=35007
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      authorization:
+      - Basic Zk1MZjlUR1dyUnFOeEo0Y2hjVmk6
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/1.6.0
+      date:
+      - Thu, 27 Nov 2014 12:26:49 GMT
+      content-type:
+      - application/json; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      status:
+      - 200 OK
+      x-ratelimit-limit:
+      - '2000'
+      x-ratelimit-remaining:
+      - '1971'
+      x-ua-compatible:
+      - IE=Edge,chrome=1
+      etag:
+      - '"f6483dc8ea6256ea8793f35f31b443ab"'
+      cache-control:
+      - must-revalidate, private, max-age=0
+      set-cookie:
+      - ahoy_visitor=70bfb475-e0d9-4e88-af9d-fb8379142175; domain=.quadernoapp.com;
+        path=/; expires=Sun, 27-Nov-2016 12:26:49 GMT
+      - ahoy_visit=b8e08a6f-e4b1-4063-a6ab-c55e11f30ff4; domain=.quadernoapp.com;
+        path=/; expires=Thu, 27-Nov-2014 16:26:49 GMT
+      - ahoy_track=true; domain=.quadernoapp.com; path=/
+      x-request-id:
+      - 76c7b54377e3eaa47c9f1f3378d46cf1
+      x-runtime:
+      - '0.087348'
+      x-rack-cache:
+      - miss
+    body:
+      encoding: UTF-8
+      string: '{"name":null,"rate":0.0,"notes":"VAT reverse charged"}'
+    http_version: '1.1'
+  recorded_at: Thu, 27 Nov 2014 12:17:24 GMT
+recorded_with: VCR 2.9.2

data/test/fixtures/quaderno_cassettes/wrong_token.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://7h15154f4k370k3n@assur-744.quadernoapp.com/api/v1/taxes/calculate.json?country=ES&postal_code=08080
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      authorization:
+      - Basic N2gxNTE1NGY0azM3MGszbjo=
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      server:
+      - nginx/1.6.0
+      date:
+      - Thu, 27 Nov 2014 12:26:50 GMT
+      content-type:
+      - application/json; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      status:
+      - 401 Unauthorized
+      x-ua-compatible:
+      - IE=Edge,chrome=1
+      cache-control:
+      - no-cache, private
+      set-cookie:
+      - ahoy_visitor=8e8063c8-23dd-4de2-bddc-6fe1f6f70c09; domain=.quadernoapp.com;
+        path=/; expires=Sun, 27-Nov-2016 12:26:50 GMT
+      - ahoy_visit=3be8bbfd-9aca-4073-99f0-061791482dc9; domain=.quadernoapp.com;
+        path=/; expires=Thu, 27-Nov-2014 16:26:50 GMT
+      - ahoy_track=true; domain=.quadernoapp.com; path=/
+      x-request-id:
+      - 3461fad34aa3517acf73bd10a9aa9cfa
+      x-runtime:
+      - '0.036473'
+      x-rack-cache:
+      - miss
+    body:
+      encoding: UTF-8
+      string: '{"error":"Wrong API key or the user does not exist."}'
+    http_version: '1.1'
+  recorded_at: Thu, 27 Nov 2014 12:17:25 GMT
+recorded_with: VCR 2.9.2

data/test/unit/test_quaderno_tax.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class TestQuadernoTax < Test::Unit::TestCase
+  context "A user with an authenticate token with webhooks" do
+
+    setup do
+      Quaderno::Base.configure do |config|
+        config.auth_token = 'fMLf9TGWrRqNxJ4chcVi'
+        config.subdomain = 'assur-744'
+      end   
+    end
+
+    should "raise exception if pass wrong arguments" do
+      assert_raise ArgumentError do
+        Quaderno::Tax.calculate 1, 2, 3
+      end
+    end
+
+    should "raise exception if token is wrong" do
+      VCR.use_cassette('wrong token') do
+        assert_raise Quaderno::Exceptions::InvalidSubdomainOrToken do
+          Quaderno::Base.auth_token = '7h15154f4k370k3n'
+          Quaderno::Tax.calculate(country: 'ES', postal_code: '08080')
+        end
+      end
+    end
+
+    should "calculate tax" do
+      VCR.use_cassette('calculate tax') do
+        tax = Quaderno::Tax.calculate(country: 'ES', postal_code: '08080')
+        assert_equal 'VAT', tax.name
+        assert_equal 21.0, tax.rate
+
+        tax = Quaderno::Tax.calculate(country: 'ES', postal_code: '35007')
+        assert tax.name.nil?
+        assert tax.rate.zero?
+        assert_equal 'VAT reverse charged', tax.notes 
+      end
+    end
+  end
+end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: quaderno
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Recrea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
 description: longer description of your gem
@@ -60,7 +60,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .document
+- ".document"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -82,9 +82,9 @@ files:
 - lib/quaderno-ruby/invoice.rb
 - lib/quaderno-ruby/item.rb
 - lib/quaderno-ruby/payment.rb
+- lib/quaderno-ruby/tax.rb
 - lib/quaderno-ruby/webhook.rb
 - quaderno.gemspec
-- test/fixtures/.DS_Store
 - test/fixtures/quaderno_cassettes/.DS_Store
 - test/fixtures/quaderno_cassettes/all_contacts.yml
 - test/fixtures/quaderno_cassettes/all_estimates.yml
@@ -92,6 +92,7 @@ files:
 - test/fixtures/quaderno_cassettes/all_invoices.yml
 - test/fixtures/quaderno_cassettes/all_items.yml
 - test/fixtures/quaderno_cassettes/all_webhooks.yml
+- test/fixtures/quaderno_cassettes/calculate_tax.yml
 - test/fixtures/quaderno_cassettes/deleted_contact.yml
 - test/fixtures/quaderno_cassettes/deleted_estimate.yml
 - test/fixtures/quaderno_cassettes/deleted_expense.yml
@@ -123,12 +124,14 @@ files:
 - test/fixtures/quaderno_cassettes/updated_invoice.yml
 - test/fixtures/quaderno_cassettes/updated_item.yml
 - test/fixtures/quaderno_cassettes/updated_webhook.yml
+- test/fixtures/quaderno_cassettes/wrong_token.yml
 - test/helper.rb
 - test/unit/test_quaderno_contacts.rb
 - test/unit/test_quaderno_estimates.rb
 - test/unit/test_quaderno_expenses.rb
 - test/unit/test_quaderno_invoices.rb
 - test/unit/test_quaderno_items.rb
+- test/unit/test_quaderno_tax.rb
 - test/unit/test_quaderno_webhooks.rb
 homepage: http://github.com/recrea/quaderno-ruby
 licenses:
@@ -140,17 +143,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: one-line summary of your gem