public
Fork of bentlegen/freshbooks.rb
Description: FreshBooks API wrapper
Homepage: http://freshbooks.rubyforge.org
Clone URL: git://github.com/bcurren/freshbooks.rb.git
name age message
file .gitignore Fri Jun 12 14:16:57 -0700 2009 Adding in start_session code so that we can use... [williamc]
file History.txt Thu Feb 26 07:56:56 -0800 2009 Updated history. [bcurren]
file LICENSE Sat Sep 15 08:02:39 -0700 2007 git-svn-id: svn+ssh://rubyforge.org/var/svn/fre... [bentlegen]
file Manifest.txt Mon Jul 06 14:06:40 -0700 2009 Fixed a typo in the Manifest file. [bcurren]
file README Mon Jul 06 13:58:41 -0700 2009 Updated the README file. [bcurren]
file Rakefile Wed Feb 25 08:32:24 -0800 2009 Update base to be able to define a schema and s... [bcurren]
file freshbooks.rb.gemspec Fri Aug 21 10:20:05 -0700 2009 Increase the version number. [bcurren]
directory lib/ Fri Aug 21 10:20:05 -0700 2009 Increase the version number. [bcurren]
directory script/ Tue Feb 24 20:58:55 -0800 2009 Refactored and added unit tests for invoice. St... [bcurren]
directory test/ Tue Aug 18 15:09:41 -0700 2009 Detect no pagination support and fake it. [bcurren]
README
= About

FreshBooks.rb is a Ruby interface to the FreshBooks API. It exposes easy-to-use classes and methods for interacting with 
your FreshBooks account.

NOTE: These examples are out of date and need to be updated. I will be writing documentation for all the updates soon 
and will be pushing the changes to rubyforge in the near future.

= Examples

Initialization:

  FreshBooks::Base.establish_connection('sample.freshbooks.com', 'mytoken')

Updating a client name:

  clients = FreshBooks::Client.list
  client = clients[0]
  client.first_name = 'Suzy'
  client.update

Updating an invoice:

  invoice = FreshBooks::Invoice.get(4)
  invoice.lines[0].quantity += 1
  invoice.update

Creating a new item

  item = FreshBooks::Item.new
  item.name = 'A sample item'
  item.create

= License

This work is distributed under the MIT License. Use/modify the code however you like.

= Download

gem sources -a http://gems.github.com
sudo gem install bcurren-freshbooks.rb

= Credits

FreshBooks.rb is written and maintained by Ben Curren at Outright.com. Ben Vinegar was the original developer and we 
have taken over maintenance of the gem from now on.