Project

curdbee

0.01
No release in over 3 years
Low commit activity in last 3 years
Ruby wrapper for the CurdBee API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0
~> 0.1.8
~> 0.9.0
>= 0
 Project Readme

CurdBee

Ruby wrapper for the CurdBee API. Through this library you can perform actions on following resources:

  • Invoices
  • Estimates
  • Recurring Profiles
  • Clients
  • Items
  • Payments

Installation

sudo gem install curdbee

Configuration

Before your code communicate with the CurdBee API, do the following:

require 'curdbee'

# set the API key and subdomain for your account.
CurdBee::Config.api_key = "Your API Key"
CurdBee::Config.subdomain = "Your Subdomain"

To find your API Token, please login to your CurdBee account and visit Settings > Account Information

Examples

Check examples/ directory for example usage.

How to Contribute?

You will need to have bundler gem installed in your system.

$ sudo gem install bundler
$ git clone git://github.com/vesess/curdbee.git
$ cd curdbee
$ bundle install

Copyright

See LICENSE for details.