Rubox

A Ruby based client library for the Box.net REST API.

Author

Bob Nadler, Jr.

Website

bobnadler.com

Email

thethirdswitch [at] gmail [dot] com

Docs

rdoc.info/projects/bnadlerjr/rubox

Installation

Git

git clone [http://bnadlerjr.github.com/rubox]

Gem

sudo gem install rubox

Description

Provides a client interface to the Box.net API. It relies on the REST version of the API, version 1.0. For a listing of available API calls see the documentation for the Box.net API which can be found at developers.box.net/ApiOverview.

This library has two main parts: Rubox::Client and Rubox::Parser. From an end user perspective you will only need to interact directly with Rubox::Client.

After creating a new Rubox::Client object with your API key, it will accept any valid Box.net API action as a message. If the API action requires any parameters, they can be passed as a Hash. Once the Rubox::Client makes the API call, the response is parsed by the Rubox::Parser and returned.

If the response includes an API object, that object is returned (i.e. Rubox::User, Rubox::File, Rubox::Folder, or Rubox::Info).

Usage

require "rubox"

client = Rubox::Client.new('your_api_key')

client.get_ticket # => 'an_api_ticket'

client.set_description(:target => 'file', :target_id => '123', :description => 'My description.') # => true

Contributing

Issues / Roadmap

Use Github issues for reporting bug and feature requests. A public version of the project is available on Pivotal Tracker for viewing backlog.

Patches / Pull Requests

  1. Fork the project.

  2. Create a separate branch for each feature addition or bug fix.

  3. Make your feature addition or bug fix.

  4. Add tests; contributions without tests won't be accepted.

  5. Do not touch VERSION.

  6. Send pull request.

Project Layout

/lib

Main project source code.

/test

All test source code and data samples.

rakefile

Rake tasks for the project.

README.rdoc

This file.

HISTORY.txt

History of release notes, patches, bug fixes, etc.

License

(The MIT License)

Copyright © 2010 Bob Nadler, Jr.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.