class OctocatHerder

This is just a convenience class to serve as a jumping-off point into the rest of the GitHub API. You don’t have to use this, if you don’t want; you can use the other classes directly, constructing your own OctocatHerder::Connection to pass to them.

This provides convenience methods for the following:

Attributes

connection[R]

The instance of OctocatHerder::Connection used for making API requests.

@since 0.0.1

Public Class Methods

new(options={}) click to toggle source

Get a new OctocatHerder for use with the GitHub v3 API.

@since 0.0.1 @see OctocatHerder::Connection.new @param [Hash] options Passed to OctocatHerder::Connection.new

# File lib/octocat_herder.rb, line 23
def initialize(options={})
  @connection = OctocatHerder::Connection.new(options)
end

Public Instance Methods

user(user_name) click to toggle source

Fetch an OctocatHerder::User by using OctocatHerder::User.fetch and the OctocatHerder::Connection from connection

@since 0.0.1 @param [String] user_name The login name of the GitHub user to retrieve.

# File lib/octocat_herder.rb, line 32
def user(user_name)
  OctocatHerder::User.fetch(user_name, connection)
end