Class: Octokit::Client

Inherits:

Object

• Object
• Octokit::Client

Includes:

Authentication, Commits, Downloads, Events, Gists, Issues, Labels, Milestones, Network, Objects, Organizations, PubSubHubbub, PubSubHubbub::ServiceHooks, Pulls, Repositories, Timelines, Users, Connection, Request

Defined in:

lib/octokit/client.rb,
lib/octokit/client/gists.rb,
lib/octokit/client/pulls.rb,
lib/octokit/client/users.rb,
lib/octokit/client/events.rb,
lib/octokit/client/issues.rb,
lib/octokit/client/labels.rb,
lib/octokit/client/commits.rb,
lib/octokit/client/network.rb,
lib/octokit/client/objects.rb,
lib/octokit/client/downloads.rb,
lib/octokit/client/timelines.rb,
lib/octokit/client/milestones.rb,
lib/octokit/client/repositories.rb,
lib/octokit/client/organizations.rb,
lib/octokit/client/pub_sub_hubbub.rb,
lib/octokit/client/pub_sub_hubbub/service_hooks.rb

Defined Under Namespace

Modules: Commits, Downloads, Events, Gists, Issues, Labels, Milestones, Network, Objects, Organizations, PubSubHubbub, Pulls, Repositories, Timelines, Users

Constant Summary

Constants included from Users

Users::EMAIL_RE

Instance Method Summary

• #initialize(options = {}) ⇒ Client constructor

  A new instance of Client.

Methods included from Events

#public_events, #repository_events, #user_events

Methods included from Users

#add_email, #add_key, #emails, #follow, #followers, #following, #follows?, #keys, #remove_email, #remove_key, #search_users, #unfollow, #update_user, #user, #watched

Methods included from Timelines

#timeline, #user_timeline

Methods included from Repositories

#add_collaborator, #add_deploy_key, #branches, #collaborators, #contributors, #create_hook, #create_repository, #deploy_keys, #edit_hook, #edit_repository, #fork, #forks, #hook, #hooks, #languages, #pushable, #remove_collaborator, #remove_deploy_key, #remove_hook, #repositories, #repository, #repository_issue_events, #repository_teams, #search_repositories, #set_private, #set_public, #tags, #test_hook, #unwatch, #watch, #watchers

Methods included from PubSubHubbub::ServiceHooks

#subscribe_service_hook, #unsubscribe_service_hook

Methods included from PubSubHubbub

#subscribe, #unsubscribe

Methods included from Pulls

#create_pull_request, #create_pull_request_for_issue, #pull_request, #pull_requests

Methods included from Organizations

#add_team_member, #add_team_repository, #create_team, #delete_team, #organization, #organization_members, #organization_repositories, #organization_teams, #organizations, #publicize_membership, #remove_team_member, #remove_team_repository, #team, #team_members, #team_repositories, #unpublicize_membership, #update_organization, #update_team

Methods included from Objects

#blob, #blob_metadata, #blobs, #raw, #tree, #tree_metadata

Methods included from Milestones

#create_milestone, #delete_milestone, #list_milestones, #milestone, #update_milestone

Methods included from Network

#network_data, #network_meta

Methods included from Labels

#add_label, #add_labels_to_an_issue, #delete_label!, #label, #labels, #labels_for_issue, #labels_for_milestone, #remove_all_labels, #remove_label, #replace_all_labels, #update_label

Methods included from Issues

#add_comment, #close_issue, #create_issue, #delete_comment, #issue, #issue_comment, #issue_comments, #issue_event, #issue_events, #list_issues, #reopen_issue, #search_issues, #update_comment, #update_issue

Methods included from Gists

#create_gist, #delete_gist, #edit_gist, #fork_gist, #gist, #gist_starred?, #gists, #public_gists, #star_gist, #starred_gists, #unstar_gist

Methods included from Downloads

#download, #downloads

Methods included from Commits

#commit, #commit_comment, #commit_comments, #commits, #list_commit_comments

Methods included from Request

#delete, #get, #patch, #post, #put

Methods included from Authentication

#authenticated?, #authentication, #oauthed?

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.

# File 'lib/octokit/client.rb', line 28

def initialize(options={})
  options = Octokit.options.merge(options)
  Configuration::VALID_OPTIONS_KEYS.each do |key|
    send("#{key}=", options[key])
  end
end