Octocat Herder Build status

Octocat Herder is a wrapper for the GitHub v3 API.

On-line documentation

Requirements

  • Gems
    • link_header
    • httparty

Basic usage

Quick start:

require 'rubygems'
=> true
require 'octocat_herder'
=> true

herder = OctocatHerder.new
=> #<OctocatHerder:0x7f792d3c4918 ...>

me = herder.user 'jhelwig'
=> #<OctocatHerder::User:0x7f792d3b6070 ...>

me.html_url
=> "https://github.com/jhelwig"

me.available_attributes.sort
=> ["avatar_url", "bio", "blog", "company", "created_at", "email", "followers", "following", "hireable", "html_url", "location", "login", "name", "public_gists", "public_repos", "url", "user_id", "user_type"]

repos = me.repositories
=> [#<OctocatHerder::Repository:0x7f792d364bf8 ...>, #<OctocatHerder::Repository:0x7f792d364bd0 ..>, #<OctocatHerder::Repository:0x7f792d364ba8 ...>, ...]

Contributing to octocat_herder

See CONTRIBUTING.markdown for further details.

Copyright (c) 2011 Jacob Helwig. See LICENSE for further details.