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.4. See the changelog here
To install add the following to your Gemfile:
gem 'quaderno', require: 'quaderno-ruby'
To configure just add this to your initializers
Quaderno::Base.configure do |config|
config.auth_token = 'my_authenticate_token'
config.subdomain = 'my_subdomain'
config.environment = :production
end
The environment
attribute is optional and set to :production
by default. Optionally, you can set it to :sandbox
in order to test your application before deploying it to production.
You can get your account subdomain by grabbing it from your account url or by calling the authorization method with your personal api token.
Quaderno::Base.authorization 'my_authenticate_token', environment
# => {"identity"=>{"id"=>737000, "name"=>"Walter White", "email"=>"[email protected]", "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.
This will return a hash with the information about your api url, which includes the account subdomain.
You can ping the service in order to check if it is up with:
Quaderno::Base.ping #=> Boolean
This will return true if the service is up or false if it is not.
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).
Quaderno-ruby parses all the json responses in human readable data, so you can access each value just like this:
contact.id
invoice.items
estimates.payments
etc.
Quaderno::Contact.all() #=> Array
Quaderno::Contact.all(page: 1) #=> Array
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:
Quaderno::Contact.all(q: 'John Doe') #=> Array
Quaderno::Contact.find(id) #=> Quaderno::Contact
will return the contact with the id passed as parameter.
Quaderno::Contact.create(params) #=> Quaderno::Contact
will create a contact using the information of the hash passed as parameter and return an instance of Quaderno::Contact with the created contact.
Quaderno::Contact.update(id, params) #=> Quaderno::Contact
will update the specified contact with the data of the hash passed as second parameter.
Quaderno::Contact.delete(id) #=> Boolean
will delete the contact with the id passed as parameter.
Quaderno::Item.all() #=> Array
will return an array with all your items.
Quaderno::Item.find(id) #=> Quaderno::Item
will return the items with the id passed as parameter.
Quaderno::Item.create(params) #=> Quaderno::Item
will create an item using the information of the hash passed as parameter and return an instance of Quaderno::Item with the created contact.
Quaderno::Item.update(id, params) #=> Quaderno::Item
will update the specified item with the data of the hash passed as second parameter.
Quaderno::Item.delete(id) #=> Boolean
will delete the item with the id passed as parameter.
Quaderno::Invoice.all #=> Array
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
Quaderno::Invoice.find(id) #=> Quaderno::Invoice
will return the invoice with the id passed as parameter.
Quaderno::Invoice.create(params) #=> Quaderno::Invoice
will create an invoice using the information of the hash passed as parameter.
Quaderno::Invoice.update(id, params) #=> Quaderno::Invoice
will update the specified invoice with the data of the hash passed as second parameter.
Quaderno::Invoice.delete(id) #=> Boolean
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.
invoice = Quaderno::Invoice.find(invoice_id)
invoice.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 Invoice instance you want to update.
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.
invoice = Quaderno::Invoice.find(invoice_id)
invoice.deliver
Quaderno::Estimate.all() #=> Array
Quaderno::Estimate.all(page: 1) #=> Array
will return an array with all your estimates on the first page.
Quaderno::Estimate.find(id) #=> Quaderno::Estimate
will return the estimate with the id passed as parameter.
Quaderno::Estimate.create(params) #=> Quaderno::Estimate
will create an estimate using the information of the hash passed as parameter.
Quaderno::Estimate.update(id, params)
will update the specified estimate with the data of the hash passed as second parameter.
Quaderno::Estimate.delete(id) #=> Boolean
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.
estimate = Quaderno::Estimate.find(estimate_id)
estimate.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 estimate you want to update.
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.
estimate = Quaderno::Estimate.find(estimate_id)
estimate.deliver
Quaderno::Expense.all() #=> Array
Quaderno::Expense.all(page: 1) #=> Array
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.
Quaderno::Expense.find(id) #=> Quaderno::Expense
will return the expense with the id passed as parameter.
Quaderno::Expense.create(params) #=> Quaderno::Expense
will create an expense using the information of the hash passed as parameter and return an instance of Quaderno::Expense with the created expense.
Quaderno::Expense.update(id, params) #=> Quaderno::Expense
will update the specified expense with the data of the hash passed as second parameter.
Quaderno::Expense.delete(id) #=> Boolean
will delete the expense with the id passed as parameter.
Quaderno::Webhook.all() #=> Array
will return an array with all the webhooks you have subscribed.
Quaderno::Webhook.find(id) #=> Quaderno::Webhook
will return the webhook with the id passed as parameter.
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.
Quaderno::Webhook.update(id, params) #=> Quaderno::Webhook
will update the specified webhook with the data of the hash passed as second parameter.
Quaderno::Webhook.delete(id) #=> Boolean
will delete the webhook with the id passed as parameter.
Quaderno::Tax.calculate(params) #=> Quaderno::Tax
will calculate the taxes applied for a customer based on the data pased as parameters.
Quaderno-ruby exceptions raise depending on the type of error:
Quaderno::Exceptions::InvalidSubdomainOrToken # Raised when the credentials are wrong, missing or do not match the permission for some object.
Quaderno::Exceptions::RateLimitExceeded # Raised when the rate limit is exceeded.
Quaderno::Exceptions::RequiredFieldsEmptyOrInvalid # Raised if the format of the request is right but some validations failed.
Remember this is only a ruby wrapper for the original API. If you want more information about the API itself, head to the original API documentation.
(The MIT License)
Copyright © 2013-2015 Quaderno
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.