Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Ruby CSS Shell JavaScript

Merge pull request #76 from bitdeli-chef/master

Add a Bitdeli Badge to README
latest commit 0c0655ec6b
@fcoury authored
Failed to load latest commit information.
contrib Use new .all_issues method.
doc Begin documentation, namespace the *Set classes.
examples Commit tests are now complete. Added the ability to pass a class to f…
lib Bump to 0.4.5
real_world_test Added real world tests. Whilst fakes are great for testing that Nothi…
test Add tree support, for finding lists of files at a specific revision
.gitignore Ignore .rbc files
.yardoc Remove methods we have other ways of getting to. Changelogs make it easier to know what happened when.
Gemfile Add Gemfile for easier development
Gemfile.lock fixing authentication with yml file
LICENSE Gem specification
Rakefile Switch to using Bundler for total gem management
octopi.gemspec Switch to using Bundler for total gem management
test_auth.rb Send auth parameters along with the request.



Octopi is a Ruby interface to GitHub API v2 (

To install it as a Gem, just run:

gem install octopi

To include it in your modules or in irb use:

include Octopi

Get notifications via Twitter, following @octopi_gem:

Authenticated Usage

Seamless authentication using .gitconfig defaults

If you have your ~/.gitconfig file in place, and you have a [github] section (if you don't, take a look at this GitHub Guides entry, you can use seamless authentication using this method:

authenticated do
  repo = Repository.find(:name => "api-labrat", :user => "fcoury")

Explicit authentication

Sometimes, you may not want to get authentication data from ~/.gitconfig. You want to use GitHub API authenticated as a third party. For this use case, you have a couple of options too.

1. Providing login and token inline:

authenticated_with :login => "mylogin", :token => "mytoken" do
  repo = Repository.find(:name => "api-labrat", :user => "fcoury")
  issue = :repo => repo, :params => {
    :title => "Sample issue", :body => "This issue was opened using GitHub API and Octopi" }
  puts issue.number

2. Providing login and password inline:

authenticated_with :login => "mylogin", :password => "password" do
  repo = Repository.find(:name => "api-labrat", :user => "fcoury")
  issue = :repo => repo, :params => {
    :title => "Sample issue", :body => "This issue was opened using GitHub API and Octopi" }
  puts issue.number

3. Providing a YAML file with authentication information:

Use the following format:

# Octopi GitHub API configuration file

# GitHub user login and token
  user: github-username
  token: github-token

# Trace level
# Possible values:
#   false - no tracing, same as if the param is ommited
#   true  - will output each POST or GET operation to the stdout
#   curl  - same as true, but in addition will output the curl equivalent of each command (for debugging)
trace: curl

And change the way you connect to:

authenticated :config => "github.yml") do

Anonymous Usage

This reflects the usage of the API to retrieve information on a read-only fashion, where the user doesn't have to be authenticated.

Users API

Getting user information

user = User.find("fcoury")
puts "#{} is being followed by #{user.followers.join(", ")} and following #{user.following.join(", ")}"

The bang methods followers! and following! retrieves a full User object for each user login returned, so it has to be used carefully.

user.followers!.each do |u|
  puts "  - #{} (#{u.login}) has #{u.public_repo_count} repo(s)"

Searching for user

users = User.find_all("silva")
puts "#{users.size} users found for 'silva':"
users.each do |u|
  puts "  - #{}"

Repositories API

repo = user.repository("octopi") # same as: Repository.find("fcoury", "octopi")
puts "Repository: #{} - #{repo.description} (by #{repo.owner}) - #{repo.url}"
puts "      Tags: #{repo.tags and {|t|}.join(", ")}"


repos = Repository.find_all("ruby", "git")
puts "#{repos.size} repository(ies) with 'ruby' and 'git':"
repos.each do |r|
  puts "  - #{}"

Issues API integrated into the Repository object:

issue = repo.issues.first
puts "First open issue: #{issue.number} - #{issue.title} - Created at: #{issue.created_at}"

Single issue information:

issue = repo.issue(11)

Commits API information from a Repository object:

first_commit = Commit.find(:user => repo.user, :repo =>, :sha =>
puts "First commit: #{} - #{first_commit.message} - by #{['name']}"

Single commit information:

puts "Diff:"
first_commit.details.modified.each {|m| puts "#{m['filename']} DIFF: #{m['diff']}" }



In alphabetical order:

Thanks guys!


Copyright (c) 2009 Felipe Coury. See LICENSE for details.

Bitdeli Badge

Something went wrong with that request. Please try again.