quaderno 1.5.5 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98753153861313b8fbd91c202177ce9d5ce69bef
-  data.tar.gz: 0f4511dbc171e602d2e8c3d75094d6c0fd3eb5e6
+  metadata.gz: 10e786f848a333e58dafe450b1fcb622a3cbcf13
+  data.tar.gz: fddcc9ef2fa5114cccb87ccd468ad56b1e99b05c
 SHA512:
-  metadata.gz: 8560b831b7468536fa745ad7c2fa25de3f5445139efb9f536517c67ad57ba413fba06c256238ec4b3128b1b6caf78c174388633a33dcd77d6095e4dbb7c9b82d
-  data.tar.gz: 88af0056f9c137aba2af39250031bcb10611a174cd36050afcc24156f14dc460ac6da1e22fe9b8a85efbff1179c239e9779cd12b64f33855d23939992419b1eb
+  metadata.gz: 04264160f3ba28f6befa0a8d08c6a2af0ecab800e97f5ec2772f3799bc0cd3939dde8ec2f301b07dfffbf7cf456a089e645218ab64f19dd1e6c4f16d476689dc
+  data.tar.gz: 72a81ae2697a902ac166eaa9c0feeed11afa2f4fcd8fe8767d08b9feb00bd6f12b26550f6cbde11aa0aad30802d1d6accd509b7db600a2a4d5ca0ad9ac91dc8c

data/README.md

@@ -1,9 +1,9 @@
 # quaderno-ruby
 
-Quaderno-ruby is a ruby wrapper for [Quaderno API] (https://github.com/quaderno/quaderno-api). 
+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.5.5. See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
+Current version is 1.6.0. See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
 
 ## Installation & Configuration
 
@@ -31,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/v1/"}}
 ```
 
 `environment` is an optional argument. By passing `:sandbox`, you will retrieve your credentials for the sandbox environment and not for production.
@@ -39,8 +39,8 @@ You can get your account subdomain by grabbing it from your account url or by ca
 This will return a hash with the information about your api url, which includes the account subdomain.
 
 ## Ping the service
- You can ping the service in order to check if it is up with: 
- 
+ You can ping the service in order to check if it is up with:
+
 ```ruby
   Quaderno::Base.ping #=> Boolean
 ```
@@ -50,7 +50,7 @@ This will return true if the service is up or false if it is not.
 ## Check the rate limit
 
 ```ruby
-  Quaderno::Base.rate_limit_info #=>  {:reset=>4, :remaining=>0} 
+  Quaderno::Base.rate_limit_info #=>  {:reset=>4, :remaining=>0}
 ```
 
 This will return a hash with information about the seconds until the rate limit reset and your remaining requests per minute ([check the API documentation for more information](https://github.com/quaderno/quaderno-api#rate-limiting)).
@@ -60,14 +60,14 @@ This will return a hash with information about the seconds until the rate limit
 Quaderno-ruby parses all the json responses in human readable data, so you can access each value just like this:
 
 ```ruby
-  contact.id 
+  contact.id
   invoice.items
   estimates.payments
   etc.
 ```
 
 ## Managing contacts
- 
+
 ### Getting contacts
 ```ruby
  Quaderno::Contact.all() #=> Array
@@ -75,11 +75,11 @@ Quaderno-ruby parses all the json responses in human readable data, so you can a
 ```
 
  will return an array with all your contacts on the first page. You can also pass query strings using the attribute :q in order to filter the results by contact name. For example:
- 
+
 ```ruby
  Quaderno::Contact.all(q: 'John Doe') #=> Array
 ```
- 
+
 ### Finding a contact
 ```ruby
  Quaderno::Contact.find(id) #=> Quaderno::Contact
@@ -154,7 +154,7 @@ will delete the item with the id passed as parameter.
   Quaderno::Invoice.all(page: 1) #=> Array
 ```
 
- will return an array with all your invoices on the first page. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date 
+ will return an array with all your invoices on the first page. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
 
 ### Finding an invoice
 ```ruby
@@ -186,10 +186,10 @@ will update the specified invoice with the data of the hash passed as second par
 
 will delete the invoice with the id passed as parameter.
 
- 
+
 ###Adding or removing a payment
  In order to  add a payment you will need the Invoice instance you want to update.
- 
+
 ```ruby
   invoice = Quaderno::Invoice.find(invoice_id)
   invoice.add_payment(params) #=> Quaderno::Payment
@@ -198,22 +198,90 @@ will delete the invoice with the id passed as parameter.
 Where params is a hash with the payment information. The method will return an instance of Quaderno::Payment wich contains the information of the payment.
 
 In order to  remove a payment you will need the Invoice instance you want to update.
- 
+
 ```ruby
   invoice = Quaderno::Invoice.find(invoice_id)
   invoice.remove_payment(payment_id) #=> Boolean
-``` 
- 
+```
+
 ###Delivering the invoice
 
   In order to deliver the estimate to the default recipient you will need the estimate you want to send.
-  
+
 ```ruby
   invoice = Quaderno::Invoice.find(invoice_id)
   invoice.deliver
 ```
 
 
+## Managing credits
+
+### Getting credits
+```ruby
+  Quaderno::Credit.all #=> Array
+  Quaderno::Credit.all(page: 1) #=> Array
+```
+
+ will return an array with all your credit notes on the first page. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date
+
+### Finding an credit
+```ruby
+  Quaderno::Credit.find(id) #=> Quaderno::Credit
+```
+
+will return the credit with the id passed as parameter.
+
+### Creating a new credit
+
+```ruby
+  Quaderno::Credit.create(params) #=> Quaderno::Credit
+```
+
+will create an credit using the information of the hash passed as parameter.
+
+### Updating an existing credit
+```ruby
+  Quaderno::Credit.update(id, params) #=> Quaderno::Credit
+```
+
+will update the specified credit with the data of the hash passed as second parameter.
+
+### Deleting an credit
+
+```ruby
+  Quaderno::Credit.delete(id) #=> Boolean
+```
+
+will delete the credit with the id passed as parameter.
+
+
+###Adding or removing a payment
+ In order to  add a payment you will need the Credit instance you want to update.
+
+```ruby
+  credit = Quaderno::Credit.find(credit_id)
+  credit.add_payment(params) #=> Quaderno::Payment
+```
+
+Where params is a hash with the payment information. The method will return an instance of Quaderno::Payment wich contains the information of the payment.
+
+In order to  remove a payment you will need the Credit instance you want to update.
+
+```ruby
+  credit = Quaderno::Credit.find(credit_id)
+  credit.remove_payment(payment_id) #=> Boolean
+```
+
+###Delivering the credit
+
+  In order to deliver the estimate to the default recipient you will need the estimate you want to send.
+
+```ruby
+  credit = Quaderno::Credit.find(credit_id)
+  credit.deliver
+```
+
+
 ## Managing estimates
 
 
@@ -224,7 +292,7 @@ In order to  remove a payment you will need the Invoice instance you want to upd
 ```
 
  will return an array with all your estimates on the first page.
- 
+
 ### Finding an estimate
 ```ruby
   Quaderno::Estimate.find(id) #=> Quaderno::Estimate
@@ -255,10 +323,10 @@ will update the specified estimate with the data of the hash passed as second pa
 
 will delete the estimate with the id passed as parameter.
 
- 
+
 ###Adding or removing a payment
  In order to add a payment you will need the estimate you want to update.
- 
+
 ```ruby
   estimate = Quaderno::Estimate.find(estimate_id)
   estimate.add_payment(params) #=> Quaderno::Payment
@@ -267,21 +335,21 @@ will delete the estimate with the id passed as parameter.
 Where params is a hash with the payment information. The method will return an instance of Quaderno::Payment wich contains the information of the payment.
 
 In order to  remove a payment you will need the estimate you want to update.
- 
+
 ```ruby
   estimate = Quaderno::Estimate.find(estimate_id)
   estimate.remove_payment(payment_id) #=> Boolean
-``` 
- 
+```
+
 ###Delivering the estimate
   In order to deliver the estimate to the default recipient you will need the estimate you want to send.
-  
+
 ```ruby
   estimate = Quaderno::Estimate.find(estimate_id)
   estimate.deliver
 ```
 
- 
+
 ## Managing expenses
 
 ### Getting expenses
@@ -291,7 +359,7 @@ In order to  remove a payment you will need the estimate you want to update.
 ```
 
  will return an array with all your expenses on the first page. You can also pass query strings using the attribute :q in order to filter the results by contact name, :state to filter by state or :date to filter by date.
- 
+
 ### Finding an expense
 ```ruby
  Quaderno::Expense.find(id) #=> Quaderno::Expense
@@ -329,7 +397,7 @@ will delete the expense with the id passed as parameter.
 ```
 
  will return an array with all the webhooks you have subscribed.
- 
+
 ### Finding an webhook
 ```ruby
  Quaderno::Webhook.find(id) #=> Quaderno::Webhook

data/VERSION

@@ -1 +1 @@
-1.5.5
+1.6.1

data/changelog.md

@@ -1,4 +1,8 @@
 #Changelog
+##1.6.0
+ * Crud module refactor
+ * Added support for credit notes
+
 ##1.5.5
  * Move rdoc as a development dependency
 

data/lib/quaderno-ruby/base.rb

@@ -1,16 +1,16 @@
 module Quaderno
   require 'httparty'
   require 'json'
-  
+
   class Base < OpenStruct
     include HTTParty
     include Quaderno::Exceptions
-    include Quaderno::Behavior::Crud    
-    
+    include Quaderno::Behavior::Crud
+
     PRODUCTION_URL = 'https://quadernoapp.com'
     SANDBOX_URL = 'http://sandbox-quadernoapp.com'
 
-    @@auth_token = nil 
+    @@auth_token = nil
     @@subdomain = 'subdomain'
     @@rate_limit_info = nil
     @@base_url = PRODUCTION_URL
@@ -29,12 +29,12 @@ module Quaderno
         end
       END
     end
-    
+
     def self.configure
       yield self
       @@base_url = @@environment == :sandbox && !@@subdomain.nil? ? "http://#{@@subdomain}.sandbox-quadernoapp.com" : "https://#{@@subdomain}.quadernoapp.com"
     end
-     
+
     def self.environment=(mode)
       @@environment = mode
     end
@@ -42,11 +42,11 @@ module Quaderno
     def self.auth_token=(auth_token)
       @@auth_token = auth_token
     end
-    
+
     def self.subdomain=(subdomain)
       @@subdomain = subdomain
     end
-    
+
     def self.authorization(auth_token, mode = nil)
       begin
         mode ||= @@environment
@@ -68,7 +68,7 @@ module Quaderno
       end
       true
     end
-    
+
     #Returns the rate limit information: limit and remaining requests
     def self.rate_limit_info
       party_response = get("#{@@base_url}/api/v1/ping.json", basic_auth: { username: auth_token })
@@ -80,7 +80,7 @@ module Quaderno
     def to_hash
       self.marshal_dump
     end
-    
+
     private
     def self.auth_token
       @@auth_token
@@ -89,7 +89,7 @@ module Quaderno
     def self.base_url
       @@base_url
     end
-    
+
     def self.subdomain
       @_subdomain = @@subdomain
     end
@@ -98,5 +98,9 @@ module Quaderno
     def self.api_path(api_path = nil)
       @_api_path ||= api_path
     end
+
+    def self.is_a_document?(document = nil)
+      @_document ||= document
+    end
   end
 end

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

@@ -1,6 +1,6 @@
 module Quaderno
   module Behavior
-    module Crud         
+    module Crud
       def self.included(receiver)
         receiver.send :extend, ClassMethods
       end
@@ -10,6 +10,7 @@ module Quaderno
           klass.new hash
         end
 
+        # Parse nested elements of a document
         def parse(element)
           payments_collection = []
           element['payments'].each do |payment|
@@ -32,48 +33,52 @@ module Quaderno
           check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true })
           array = party_response.parsed_response
           collection = []
-          array.each do |element|  
-            if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
+
+          if is_a_document?
+            array.each do |element|
               api_model.parse(element)
+              collection << (new element)
             end
-            collection << (new element)
-          end          
+          else
+            array.each { |element| collection << (new element) }
+          end
+
           collection
         end
 
         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 })       
+          check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true, id: true })
           hash = party_response.parsed_response
-          if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
-            api_model.parse(hash)
-          end
-          new hash          
+
+          api_model.parse(hash) if is_a_document?
+
+          new hash
         end
 
         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 = party_response.parsed_response
-          if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
-            api_model.parse(hash)
-          end
+
+          api_model.parse(hash) if is_a_document?
+
           new hash
         end
 
         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 = party_response.parsed_response                      
-          if (api_model == Quaderno::Invoice) || (api_model == Quaderno::Estimate) || (api_model == Quaderno::Expense)
-            api_model.parse(hash)
-          end
+          hash = party_response.parsed_response
+
+          api_model.parse(hash) if is_a_document?
+
           new hash
         end
 
         def delete(id)
           party_response = HTTParty.delete "#{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, has_documents: true })         
+          check_exception_for(party_response,  { rate_limit: true, subdomain_or_token: true, id: true, has_documents: true })
           true
         end
       end

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

@@ -1,17 +1,17 @@
 module Quaderno
   module Behavior
     module Deliver
-  
+
       def self.included(base)
         base.send :include, InstanceMethods
       end
-      
+
       module InstanceMethods
         def deliver
           party_response = api_model.get("#{api_model.base_url}/api/v1/#{ api_model.api_path }/#{ id }/deliver.json", basic_auth: { username: api_model.auth_token })
           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 
+        end
       end
     end
   end

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

@@ -1,17 +1,17 @@
 module Quaderno
   module Behavior
-    module Payment 
+    module Payment
       def self.included(base)
         base.send :include, InstanceMethods
       end
-      
+
       module InstanceMethods
         def to_instance(klass, parsed)
           klass.new(parsed)
         end
-        
+
         def add_payment(params)
-          party_response = api_model.post "#{api_model.base_url}/api/v1/#{ api_model.api_path }/#{ id }/payments.json", body: params, basic_auth: { username: api_model.auth_token }            
+          party_response = api_model.post "#{api_model.base_url}/api/v1/#{ api_model.api_path }/#{ id }/payments.json", body: params, basic_auth: { username: api_model.auth_token }
           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)
@@ -29,7 +29,7 @@ module Quaderno
             end
           end
           payments.delete(to_delete)
-          api_model.check_exception_for(party_response, { rate_limit: true, subdomain_or_token: true, id: true }) 
+          api_model.check_exception_for(party_response, { rate_limit: true, subdomain_or_token: true, id: true })
           true
         end
       end

data/lib/quaderno-ruby/contact.rb

@@ -1,8 +1,7 @@
 module Quaderno
   class Contact < Base
-    
+
     api_model Quaderno::Contact
     api_path 'contacts'
-    
   end
 end

data/lib/quaderno-ruby/credit.rb

@@ -0,0 +1,10 @@
+module Quaderno
+  class Credit < Base
+    include Quaderno::Behavior::Deliver
+    include Quaderno::Behavior::Payment
+
+    api_model Quaderno::Credit
+    api_path 'credits'
+    is_a_document? true
+  end
+end

data/lib/quaderno-ruby/estimate.rb

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

data/lib/quaderno-ruby/expense.rb

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

data/lib/quaderno-ruby/invoice.rb

@@ -2,8 +2,9 @@ module Quaderno
   class Invoice < Base
     include Quaderno::Behavior::Deliver
     include Quaderno::Behavior::Payment
-    
+
     api_model Quaderno::Invoice
-    api_path 'invoices'   
+    api_path 'invoices'
+    is_a_document? true
   end
 end

data/lib/quaderno-ruby/item.rb

@@ -1,8 +1,7 @@
 module Quaderno
   class Item < Base
-    
+
     api_model Quaderno::Item
     api_path 'items'
-    
   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 tax).each { |filename| require "quaderno-ruby/#{ filename }" }
+%w(base contact item invoice credit estimate expense 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.5.5 ruby lib
+# stub: quaderno 1.6.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "quaderno"
-  s.version = "1.5.5"
+  s.version = "1.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Recrea"]
-  s.date = "2015-04-01"
+  s.date = "2015-04-13"
   s.description = " A ruby wrapper for Quaderno API "
   s.email = "carlos@recrea.es"
   s.extra_rdoc_files = [
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
     "lib/quaderno-ruby/behavior/deliver.rb",
     "lib/quaderno-ruby/behavior/payment.rb",
     "lib/quaderno-ruby/contact.rb",
+    "lib/quaderno-ruby/credit.rb",
     "lib/quaderno-ruby/document_item.rb",
     "lib/quaderno-ruby/estimate.rb",
     "lib/quaderno-ruby/exceptions/exceptions.rb",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quaderno
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.6.1
 platform: ruby
 authors:
 - Recrea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -75,6 +75,7 @@ files:
 - lib/quaderno-ruby/behavior/deliver.rb
 - lib/quaderno-ruby/behavior/payment.rb
 - lib/quaderno-ruby/contact.rb
+- lib/quaderno-ruby/credit.rb
 - lib/quaderno-ruby/document_item.rb
 - lib/quaderno-ruby/estimate.rb
 - lib/quaderno-ruby/exceptions/exceptions.rb