0.0
Low commit activity in last 3 years
A long-lived project that still receives updates
Wrapper for the easybill REST api
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

>= 0.16.3, < 0.19.0
 Project Readme

Maintainability Test Coverage

Easybill::Api

This is the ruby wrapper for the easybill REST Api.

Installation

Add this line to your application's Gemfile:

gem 'easybill-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install easybill-api

Usage

Initialize a new api client:

@api = Easybill::Api::Client.new(<YOUR API TOKEN>)

Example calls based on the customers resource:

# Fetch all customers

customers = @api.customers.list["items"]
# Fetch one customers

customer = @api.customers.find(<ID>)
fist_name = response["first_name"]
# Create a customer

customer_hash = {
  first_name: "fabio",
  last_name: "lorenzo",
  ...
}

customer = @api.customers.create(customer_hash)
# => 201 created
# Update a customer

update_customer_hash = {
  country: "UK",
  ...
}

customer = @api.customers.update(<ID>, update_customer_hash)
# => 200 ok
# Delete a customer

@api.customers.destroy(<ID>)
# => 204 deleted

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/schnika/easybill-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Unlicense

The gem is available as open source under the terms of the Unlicense.