quaderno 1.9.1 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6699c1ffde675d6d20e1bc6a89b411c24a5e684
-  data.tar.gz: 56b5cd78c82c019eebe55d28cd100e7f124b047d
+  metadata.gz: ba3feaca76f5023f241d8fd0b6014bfa44c1f428
+  data.tar.gz: 16c5c2dae1a59d643531a94fae1ebae837d25b5d
 SHA512:
-  metadata.gz: c1ac26cc48424b25301e43fa60a36dfbab5fccf0214e87577b69ca6b2f84f7603e8459a3110c9dc58a5067d4309245dde28f1a1a88a940bc55b59be76680e58d
-  data.tar.gz: 79e42d2edfd106aba7cc750e03fe408da27aada6bd96b60e084b83d1a3cf5ec86e683b68cb25fb68b0dc409bbd963cb89a4fefef68f61a70b96b8a98db83c1af
+  metadata.gz: b6cfe30aed9a4441fa0c1ce7ad42f8bbed1059f5001ce018b4339a5fdbd338648542bb799729653c8968a0d7ebd13b0a723c576f785d54d4066fbe451913f1e1
+  data.tar.gz: 64d9a7b1c72c1b2c75865032208033715644e8c18dbe506fbc73acf4749b5ee939997e45bf03d49e37f373579a1663fe5c836d89b51289ab51b99cb70c1b5175

data/Gemfile

@@ -1,17 +1,17 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gem 'httparty', '~> 0.13.1'
 
 group :development do
-  gem "jeweler", "~> 2.0.1"
-  gem "rdoc",    "~> 3.12"
+  gem 'jeweler', '~> 2.0.1'
+  gem 'rdoc',    '~> 3.12'
 end
 
 group :test do
-  gem "bundler", ">= 1.0.0"
+  gem 'bundler', '>= 1.0.0'
   gem 'fakeweb'
   gem 'minitest', '~> 4.7.5 '
-  gem "simplecov", ">= 0"
-  gem "shoulda", ">= 0"
+  gem 'simplecov', '>= 0'
+  gem 'shoulda', '>= 0'
   gem 'vcr', :require => 'vcr'
 end

data/Gemfile.lock

@@ -11,7 +11,7 @@ GEM
     builder (3.2.2)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    docile (1.1.4)
+    docile (1.1.5)
     fakeweb (1.3.0)
     faraday (0.9.0)
       multipart-post (>= 1.2, < 3)
@@ -64,11 +64,11 @@ GEM
     shoulda-context (1.2.1)
     shoulda-matchers (2.6.1)
       activesupport (>= 3.0.0)
-    simplecov (0.8.2)
+    simplecov (0.11.2)
       docile (~> 1.1.0)
-      multi_json
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     thread_safe (0.3.4)
     tzinfo (0.3.39)
     vcr (2.9.2)
@@ -86,3 +86,6 @@ DEPENDENCIES
   shoulda
   simplecov
   vcr
+
+BUNDLED WITH
+   1.11.2

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.9.1 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
+Current version is 1.9.2 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
 
 ## Installation & Configuration
 
@@ -87,6 +87,12 @@ Quaderno-ruby parses all the json responses in human readable data, so you can a
 
 will return the contact with the id passed as parameter.
 
+## Retrieving a customer contact by its payment gatewaycustomer ID
+```ruby
+ Quaderno::Contact.retrieve_customer(PAYMENT_GATEWAY_CUSTOMER_ID, PAYMENT_GATEWAY) #=> Quaderno::Contact
+```
+will return the contact with the customer id passed as parameter.
+
 ### Creating a new contact
 ```ruby
  Quaderno::Contact.create(params) #=> Quaderno::Contact

data/VERSION

@@ -1 +1 @@
-1.9.1
+1.9.2

data/changelog.md

@@ -1,5 +1,10 @@
 #Changelog
 
+##1.9.2
+ * Added `Quaderno::Contact.retrieve` method
+ * Code cleanup
+ * Update tests
+
 ##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**

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

@@ -6,37 +6,30 @@ module Quaderno
       end
 
       module ClassMethods
-        def to_instance(klass, hash)
-          klass.new hash
-        end
-
-        # Parse nested elements of a document
-        def parse(element)
-          payments_collection = []
-          (element['payments'] || []).each do |payment|
-            payments_collection << api_model.to_instance(Quaderno::Payment, payment)
-          end unless api_model == Quaderno::Estimate
-          element['payments'] = payments_collection
-
-          items_collection = []
-          element['items'].each do |item|
-            items_collection << api_model.to_instance(Quaderno::DocumentItem, item)
+        def parse_nested(element)
+          if element.has_key?('payments')
+            payments_collection = Array.new
+            (element['payments'] || Array.new).each { |payment| payments_collection << Quaderno::Payment.new(payment) }
+            element['payments'] = payments_collection
           end
+
+          items_collection = Array.new
+          element['items'].each { |item| items_collection << Quaderno::DocumentItem.new(item) }
           element['items'] = items_collection
+          element['contact'] = Quaderno::Contact.new(element['contact'])
 
-          contact = api_model.to_instance(Quaderno::Contact, element['contact'])
-          element['contact'] = contact
+          element
         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 }, headers: version_header)
-          check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true })
-          array = party_response.parsed_response
-          collection = []
+          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(response, { rate_limit: true, subdomain_or_token: true })
+          array = response.parsed_response
+          collection = Array.new
 
           if is_a_document?
             array.each do |element|
-              api_model.parse(element)
+              api_model.parse_nested(element)
               collection << (new element)
             end
           else
@@ -47,38 +40,39 @@ 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 }, headers: version_header
-          check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true, id: true })
-          hash = party_response.parsed_response
+          response = get "#{api_model.url}#{ api_model.api_path }/#{ 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
 
-          api_model.parse(hash) if is_a_document?
+          api_model.parse_nested(hash) if is_a_document?
 
           new hash
         end
 
         def create(params)
-          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
+          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(response, { rate_limit: true, subdomain_or_token: true, required_fields: true })
+          hash = response.parsed_response
 
-          api_model.parse(hash) if is_a_document?
+          api_model.parse_nested(hash) if is_a_document?
 
           new hash
         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 }, 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
+          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(response, { rate_limit: true, required_fields: true, subdomain_or_token: true, id: true })
+          hash = response.parsed_response
 
-          api_model.parse(hash) if is_a_document?
+          api_model.parse_nested(hash) if is_a_document?
 
           new hash
         end
 
         def delete(id)
-          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 })
+          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(response, { rate_limit: true, subdomain_or_token: true, id: true, has_documents: true })
+
           true
         end
       end

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

@@ -6,30 +6,23 @@ module Quaderno
       end
 
       module InstanceMethods
-        def to_instance(klass, parsed)
-          klass.new(parsed)
-        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 }, 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)
-          payments << instance
-          Quaderno::Payment.new parsed
+          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)
+          self.payments << instance
+
+          Quaderno::Payment.new instance
         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 }, headers: self.class.version_header
-          to_delete = nil
-          payments.each do |payment|
-            if payment.id == payment_id
-              to_delete = payment
-              break
-            end
-          end
-          payments.delete(to_delete)
-          api_model.check_exception_for(party_response, { rate_limit: true, subdomain_or_token: true, id: true })
+          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
+          api_model.check_exception_for(response, { rate_limit: true, subdomain_or_token: true, id: true })
+
+          self.payments.delete_if { |payment| payment.id == payment_id }
+
           true
         end
       end

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

@@ -0,0 +1,20 @@
+module Quaderno
+  module Behavior
+    module Retrieve
+      def self.included(receiver)
+        receiver.send :extend, ClassMethods
+      end
+
+      module ClassMethods
+
+        def retrieve_customer(customer_id, gateway = nil)
+          response = get "#{api_model.url}#{gateway || 'stripe'}/customers/#{customer_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
+
+          new hash
+        end
+      end
+    end
+  end
+end

data/lib/quaderno-ruby/contact.rb

@@ -1,5 +1,6 @@
 module Quaderno
   class Contact < Base
+    include Quaderno::Behavior::Retrieve
 
     api_model Quaderno::Contact
     api_path 'contacts'

data/lib/quaderno-ruby/payment.rb

@@ -1,6 +1,4 @@
 module Quaderno
-  
   class Payment < OpenStruct
   end
-  
 end

data/lib/quaderno-ruby/tax.rb

@@ -2,11 +2,11 @@ module Quaderno
   class Tax < Base
     api_model Quaderno::Tax
     api_path 'taxes'
-    
+
     class << self
-      undef :all, :find, :create, :update, :delete, :parse
+      undef :all, :find, :create, :update, :delete, :parse_nested
     end
-    
+
     def self.calculate(params)
       party_response = get("#{self.url}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 })

data/lib/quaderno-ruby/webhook.rb

@@ -1,8 +1,6 @@
 module Quaderno
   class Webhook < Base
-    
     api_model Quaderno::Webhook
     api_path 'webhooks'
-    
   end
 end

data/lib/quaderno-ruby.rb

@@ -1,7 +1,7 @@
 require 'ostruct'
 
 require 'quaderno-ruby/exceptions/exceptions'
-%w(crud deliver payment).each { |filename| require "quaderno-ruby/behavior/#{ filename }" }
+%w(crud deliver payment retrieve).each { |filename| require "quaderno-ruby/behavior/#{ filename }" }
 %w(base contact item invoice receipt credit estimate expense recurring document_item 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.9.1 ruby lib
+# stub: quaderno 1.9.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "quaderno"
-  s.version = "1.9.1"
+  s.version = "1.9.2"
 
   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-06-21"
+  s.date = "2016-06-23"
   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/crud.rb",
     "lib/quaderno-ruby/behavior/deliver.rb",
     "lib/quaderno-ruby/behavior/payment.rb",
+    "lib/quaderno-ruby/behavior/retrieve.rb",
     "lib/quaderno-ruby/contact.rb",
     "lib/quaderno-ruby/credit.rb",
     "lib/quaderno-ruby/document_item.rb",
@@ -53,27 +54,36 @@ Gem::Specification.new do |s|
     "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_estimate.yml",
     "test/fixtures/quaderno_cassettes/deleted_expense.yml",
     "test/fixtures/quaderno_cassettes/deleted_invoice.yml",
     "test/fixtures/quaderno_cassettes/deleted_item.yml",
+    "test/fixtures/quaderno_cassettes/deleted_receipt.yml",
     "test/fixtures/quaderno_cassettes/deleted_webhook.yml",
     "test/fixtures/quaderno_cassettes/delivered_estimate.yml",
     "test/fixtures/quaderno_cassettes/delivered_invoice.yml",
+    "test/fixtures/quaderno_cassettes/delivered_receipt.yml",
     "test/fixtures/quaderno_cassettes/found_contact.yml",
     "test/fixtures/quaderno_cassettes/found_estimate.yml",
     "test/fixtures/quaderno_cassettes/found_expense.yml",
     "test/fixtures/quaderno_cassettes/found_invoice.yml",
     "test/fixtures/quaderno_cassettes/found_item.yml",
+    "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_estimate.yml",
     "test/fixtures/quaderno_cassettes/new_expense.yml",
     "test/fixtures/quaderno_cassettes/new_invoice.yml",
     "test/fixtures/quaderno_cassettes/new_item.yml",
+    "test/fixtures/quaderno_cassettes/new_receipt.yml",
     "test/fixtures/quaderno_cassettes/new_webhook.yml",
     "test/fixtures/quaderno_cassettes/paid_expense.yml",
     "test/fixtures/quaderno_cassettes/paid_invoice.yml",
@@ -85,6 +95,7 @@ Gem::Specification.new do |s|
     "test/fixtures/quaderno_cassettes/updated_expense.yml",
     "test/fixtures/quaderno_cassettes/updated_invoice.yml",
     "test/fixtures/quaderno_cassettes/updated_item.yml",
+    "test/fixtures/quaderno_cassettes/updated_receipt.yml",
     "test/fixtures/quaderno_cassettes/updated_webhook.yml",
     "test/fixtures/quaderno_cassettes/wrong_token.yml",
     "test/helper.rb",
@@ -93,6 +104,7 @@ Gem::Specification.new do |s|
     "test/unit/test_quaderno_expenses.rb",
     "test/unit/test_quaderno_invoices.rb",
     "test/unit/test_quaderno_items.rb",
+    "test/unit/test_quaderno_receipts.rb",
     "test/unit/test_quaderno_tax.rb",
     "test/unit/test_quaderno_webhooks.rb"
   ]