Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neovintage/zoho_invoice
Wrapper around the Zoho Invoice API
https://github.com/neovintage/zoho_invoice
Last synced: 3 months ago
JSON representation
Wrapper around the Zoho Invoice API
- Host: GitHub
- URL: https://github.com/neovintage/zoho_invoice
- Owner: neovintage
- License: mit
- Created: 2013-03-25T15:54:24.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2017-01-18T23:53:10.000Z (almost 8 years ago)
- Last Synced: 2024-10-25T02:06:00.178Z (3 months ago)
- Language: Ruby
- Size: 461 KB
- Stars: 6
- Watchers: 1
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Zoho Invoice
[](https://travis-ci.org/neovintage/zoho_invoice)
[](https://coveralls.io/r/neovintage/zoho_invoice)
Need to interact with the Zoho Invoice API? The zoho_invoice gem has your back.
Until the gem reaches 1.0, the interface for interacting with the gem could change. On top of that the gem does not support the entire API just yet. Just the minimum number of domain objects to actually create customers and invoices. This will change over time.
## Status
This README covers Zoho's old Invoice API v2. Work has started on integrating version three of the API and that can be found on the version_three branch.
## Installation
Add this line to your application's Gemfile:
gem 'zoho_invoice'
And then execute:
$ bundle
Or install it yourself as:
$ gem install zoho_invoice
## Configuration
The Zoho Invoice API service requires that you generate an auth token ahead of time using the API, just once. Fortunately, the gem can handle that in console for you, all you need is your username and password.
Then you can save the authtoken in your project based on however you do your configuration.
```
homebase $ irb
> require 'zoho_invoice'
=> true
> result = ZohoInvoice::AuthToken.generate_authtoken('[email protected]', 'thisismysweetpassword')
=> #
> result.success?
=> true
> result.authtoken
=> "blahblahblahnumbersnstuff"
```
## Client Setup
One of the great things about zoho_invoice is the ability for clients to inherit from a global config and override it if need be.
```
homebase $ irb
> require 'zoho_invoice'
=> true
> ZohoInvoice.authtoken = 'first_authtoken'
=> "first_authtoken"
> ZohoInvoice.apikey = 'first_apikey'
=> "first_apikey"
> client = ZohoInvoice::Client.new
=> #"https://invoice.zoho.com"}>
> another_client = ZohoInvoice::Client.new(:authtoken => "override_authtoken")
=> #"https://invoice.zoho.com"}>
```
## Usage
```ruby
require 'zoho_invoice'
client = ZohoInvoice::Client.new(:authtoken => 'my authtoken', :apikey => 'my apikey')
invoice = ZohoInvoice::Invoice.new(client, :customer_id => 'asdf')
invoice.save
```
If you're so inclined, you can scope the resources through the client.
```ruby
require 'zoho_invoice'
client = ZohoInvoice::Client.new(:authtoken => 'my authtoken', :apikey => 'my apikey')
invoice = client.invoices.new(:customer_id => 'asdf')
invoice.save
```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request