Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Ruby CSS Shell

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
README.md

README.md

octopi

Description

A Ruby interface to GitHub API v2 http://developer.github.com
Fork it away!

Features

  • High level interface
  • Change resources a la ActiveRecord

Examples

Choose your flavor

DSL flavor (work in progress)

include Octopi
connect "username", "<<user-token>>" do |git|
  # the contents of the key whose title is "Local Server"
  puts git.keys.find { |k| k.title == "Local Server" }.key

  # prints current user name
  puts git.user.name

  # sets user name to Fernanda
  # and saves it on GitHub
  git.user.name = "Fernanda"
  git.user.save
end

API flavor

# initializes the API and authenticates the user
github = Octopi::Api.new('fcoury', '<<user-token>>')

# the contents of the key whose title is "Local Server"
puts github.keys.find { |k| k.title == "Local Server" }.key

# retrieves current user information and prints the name
user = github.user
puts user.name

# sets user name to Fernanda
# and saves it on GitHub
user.name = "Fernanda"
user.save

Bugs and Feedback

Drop me a line at githuby@felipecoury.com.

Copyright © 2009 Felipe Coury
http://felipecoury.com

Something went wrong with that request. Please try again.