@@ -1,48 +1,45 @@ -=Freshbooks API for Ruby - -Freshbooks is a popular web-based invoicing application for small and medium businesses. This library makes it easy to write Ruby code that communicates with your Freshbooks account using their public XML-based API. - - http://www.freshbooks.com - FreshBooks Home - -=Installation - -This library is distributed as a single file: freshbooks.rb. Put it wherever you keep your other library files. For Rails applications, this would be /lib. - - require 'lib/freshbooks' - -For examples, read on. - -=Examples - -Before doing anything, you need to initialize a base Freshbooks object with your account details. - - account = Freshbooks.new('YourCompany', 'username', 'password') - -To add a new client, instantiate a new Freshbooks::Client object and send it to Freshbooks#add_client. - - client = Freshbooks::Client.new - - client.first_name = 'Donna' - client.last_name = 'Changstein' - client.username = 'dchangstein' - client.email_address = 'dchangstein@xyz.com' - client.orgname = 'XYZ Corp' - - account.add_client(client) - -Basically, client attributes are the same as specified in the API, except that where the API uses CamelCase, I've inserted underscores in an attempt to stick with Ruby coding conventions. - -Modifying client details is just as easy. Just make sure the username is identical, and you're golden. - - client.last_name = 'Chang' - - account.modify_client(client) - -More examples on their way. - -=License - -The Freshbooks API for Ruby is distributed under the MIT License. - -(c) 2007 Ben Vinegar - += 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. + += Examples + +Initialization: + + FreshBooks.setup('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 + +FreshBooks.rb is distributed as a gem via Rubyforge. The easiest way to install it is like so: + + gem install freshbooks + +Alternatively, you can download it from the Rubyforge project page. + += Credits + +FreshBooks.rb is written and maintained by Ben Vinegar, with contributions from Flinn Meuller, Kenneth Kalmer, and others. + README de72fb0fb01f420500e331be7f457f299421d909 Ben Vinegar ben@benlog.org http://github.com/bentlegen/freshbooks.rb/commit/7d0525b7f0e15b245c83126ac9ae8dd59f305d03 7d0525b7f0e15b245c83126ac9ae8dd59f305d03 2008-08-06T20:33:46-07:00 2008-08-06T20:33:46-07:00 Updated README; more like docs at http://freshbooks.rubyforge.org 71877f469def6448befa77e4ab379d19c11d1197 Ben Vinegar ben@benlog.org