Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Light weight Ruby wrapper for Github v3 api
tree: f54946f752

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
lib
test
.DS_Store
.gitignore
Gemfile
README.markdown
Rakefile
fuselage.gemspec

README.markdown

Fuselage

Fuselage is a light weight Ruby wrapper for the Github v3 api. It was inspired by the Github v2 Ruby wrapper octopi.

It was created for Gitpilot. Check us out at: http://www.gitpilot.com

Credits

  • Corey Collins
  • JP Richardson

Install

Fuselage can easily be installed as a Ruby gem:

$ [sudo] gem install fuselage

Usage

To use fuselage just include it in your script:

require 'fuselage'

include Fuselage

Authenicated

If you have genereated a access token through github, then you can use the authenicated api with this method:

authenicated do
  repo = Repository.find('private-repo')
end

Anonymous

Otherwise, if you are not authenticated there is no need to wrap your method call in the block. Like:

repo = Repository.find('public-repo')

API Completed

This is still a work in progress and not all of the api has been mapped yet. So far these have been mapped.

1. Users

2. Repos

3. Git Data

License

Copyright (c) 2011, Gitpilot LLC

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Something went wrong with that request. Please try again.