Ruby wrapper library for the Cashboard API
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
lib
test
.autotest
.gitignore
LICENSE
README.textile
Rakefile
cashboard.gemspec

README.textile

Cashboard-rb

This project is the official Ruby wrapper for the Cashboard API created and maintained by Subimage LLC.

Cashboard is an online service that allows you to track time, create estimates, invoice your clients, and collect payments via credit cards or PayPal.

Installation

sudo gem install cashboard

Example Code

require 'rubygems'
require 'cashboard'

Cashboard::Base.authenticate('your_subdomain', 'your_api_key')

puts "Employees:"
Cashboard::Employee.list.each { |emp| puts emp.inspect }

puts "Client Companies:"
Cashboard::ClientCompany.list.each { |client| puts client.inspect }

puts "Projects:"
Cashboard::Project.list.each { |prj| puts prj.inspect }

There are more examples in the /examples directory of this project.

Links

Contributing

If you’d like to contribute to this project, please fork it and add your code with working tests.

Testing

Tests are handled with Test::Unit and Fakeweb.
There’s a complete test suite you can run by invoking:
ruby test/full.rb

The project is also setup to use autotest.

If you add any code please ensure all tests continue to run properly by running the test suite.

License

Cashboard-rb is released under the MIT License.
Tweak it, fork it, twerk it and translate it to other languages…please!