quaderno 1.7.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ce3b824827732c0cf058860e1214ae0b4ffb731
-  data.tar.gz: aa1b3180548004212bce574d2e00d15e4e79c15c
+  metadata.gz: 423898afe9290b9d5a056ed17c7e0ec2cb50e777
+  data.tar.gz: 7617314a3d1c18d9db47729030b8232f4de2011b
 SHA512:
-  metadata.gz: 2d06bfee33d9ee87a0dac839a20187e022567d1ee5df572e40adcb66e1672099d80f3ba659e61f05987ec0e6efb5dad988227b6fa20052a24e0f92fa46f773f8
-  data.tar.gz: 9664ede64110b77aa953e6fda25edab0ed78639a4795f9341e6633970c97a6ee9d25fe05f5da887d9a0db4c2b1fed5a196776d00a00aaaeddbce6ce2ed691d77
+  metadata.gz: ed38c65f4f96f9999c85b0b19f9fa9c31ae59db0c3ea2420600acab0f48e4f4a20434fa5a7ac86384ffb612dc4d3f774bbf8d034beb6fad96a82dc561fa25136
+  data.tar.gz: 1a9c6a1d1b737c3304bc7a5dbffab9d51c0ff74f8ddc7df571e8ae405566be39c40effdf9798a34279dd6b841c68a0a58926f4855ada5dec8dc2099ce89ea7ab

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.7.2 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
+Current version is 1.8.0 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
 
 ## Installation & Configuration
 
@@ -205,13 +205,62 @@ In order to  remove a payment you will need the Invoice instance you want to upd
 
 ###Delivering the invoice
 
-  In order to deliver the estimate to the default recipient you will need the estimate you want to send.
+  In order to deliver the invoice to the default recipient you will need the invoice you want to send.
 
 ```ruby
   invoice = Quaderno::Invoice.find(invoice_id)
   invoice.deliver
 ```
 
+## Managing receipts
+
+### Getting receipts
+```ruby
+  Quaderno::Receipt.all #=> Array
+  Quaderno::Receipt.all(page: 1) #=> Array
+```
+
+ will return an array with all your receipts 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 a receipt
+```ruby
+  Quaderno::Receipt.find(id) #=> Quaderno::Receipt
+```
+
+will return the receipt with the id passed as parameter.
+
+### Creating a new receipt
+
+```ruby
+  Quaderno::Receipt.create(params) #=> Quaderno::Receipt
+```
+
+will create an receipt using the information of the hash passed as parameter.
+
+### Updating an existing receipt
+```ruby
+  Quaderno::Receipt.update(id, params) #=> Quaderno::Receipt
+```
+
+will update the specified receipt with the data of the hash passed as second parameter.
+
+### Deleting an receipt
+
+```ruby
+  Quaderno::Receipt.delete(id) #=> Boolean
+```
+
+will delete the receipt with the id passed as parameter.
+
+###Delivering the receipt
+
+  In order to deliver the receipt to the default recipient you will need the receipt you want to send.
+
+```ruby
+  receipt = Quaderno::Receipt.find(receipt_id)
+  receipt.deliver
+```
+
 
 ## Managing credits
 
@@ -273,7 +322,7 @@ In order to  remove a payment you will need the Credit instance you want to upda
 
 ###Delivering the credit
 
-  In order to deliver the estimate to the default recipient you will need the estimate you want to send.
+  In order to deliver the credit to the default recipient you will need the credit you want to send.
 
 ```ruby
   credit = Quaderno::Credit.find(credit_id)

data/VERSION

@@ -1 +1 @@
-1.7.3
+1.8.0

data/changelog.md

@@ -1,6 +1,12 @@
 #Changelog
+
+##1.8.0
+ * Add Quaderno::Receipt support
+ * Fix errors in README
+
 ##1.7.3
  * Raise exception on failed updates
+
 ##1.7.2
  * Fix URL in Quaderno::Tax.calculate by [**@jcxplorer**] (https://github.com/jcxplorer)
 

data/lib/quaderno-ruby/receipt.rb

@@ -0,0 +1,9 @@
+module Quaderno
+  class Receipt < Base
+    include Quaderno::Behavior::Deliver
+
+    api_model Quaderno::Receipt
+    api_path 'receipts'
+    is_a_document? true
+  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 credit estimate expense recurring document_item payment webhook tax).each { |filename| require "quaderno-ruby/#{ 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.7.3 ruby lib
+# stub: quaderno 1.8.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "quaderno"
-  s.version = "1.7.3"
+  s.version = "1.8.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-04-15"
+  s.date = "2016-05-09"
   s.description = " A ruby wrapper for Quaderno API "
   s.email = "carlos@recrea.es"
   s.extra_rdoc_files = [
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
     "lib/quaderno-ruby/invoice.rb",
     "lib/quaderno-ruby/item.rb",
     "lib/quaderno-ruby/payment.rb",
+    "lib/quaderno-ruby/receipt.rb",
     "lib/quaderno-ruby/recurring.rb",
     "lib/quaderno-ruby/tax.rb",
     "lib/quaderno-ruby/webhook.rb",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quaderno
 version: !ruby/object:Gem::Version
-  version: 1.7.3
+  version: 1.8.0
 platform: ruby
 authors:
 - Recrea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -83,6 +83,7 @@ files:
 - lib/quaderno-ruby/invoice.rb
 - lib/quaderno-ruby/item.rb
 - lib/quaderno-ruby/payment.rb
+- lib/quaderno-ruby/receipt.rb
 - lib/quaderno-ruby/recurring.rb
 - lib/quaderno-ruby/tax.rb
 - lib/quaderno-ruby/webhook.rb