Class: Octokit::Client

Inherits:

Object

• Object
• Octokit::Client

Includes:

Authentication, Authorizations, Commits, Contents, Downloads, Emojis, Events, Gists, GitHub, Gitignore, Issues, Labels, Markdown, Milestones, Notifications, Objects, Organizations, PubSubHubbub, PubSubHubbub::ServiceHooks, Pulls, RateLimit, Refs, Repositories, Say, Stats, Statuses, Users, Connection, Request

Defined in:

lib/octokit/client.rb,
lib/octokit/client/say.rb,
lib/octokit/client/refs.rb,
lib/octokit/client/gists.rb,
lib/octokit/client/pulls.rb,
lib/octokit/client/stats.rb,
lib/octokit/client/users.rb,
lib/octokit/client/emojis.rb,
lib/octokit/client/events.rb,
lib/octokit/client/github.rb,
lib/octokit/client/issues.rb,
lib/octokit/client/labels.rb,
lib/octokit/client/commits.rb,
lib/octokit/client/objects.rb,
lib/octokit/client/contents.rb,
lib/octokit/client/markdown.rb,
lib/octokit/client/statuses.rb,
lib/octokit/client/downloads.rb,
lib/octokit/client/gitignore.rb,
lib/octokit/client/milestones.rb,
lib/octokit/client/rate_limit.rb,
lib/octokit/client/repositories.rb,
lib/octokit/client/notifications.rb,
lib/octokit/client/organizations.rb,
lib/octokit/client/authorizations.rb,
lib/octokit/client/pub_sub_hubbub.rb,
lib/octokit/client/pub_sub_hubbub/service_hooks.rb

Defined Under Namespace

Modules: Authorizations, Commits, Contents, Downloads, Emojis, Events, Gists, GitHub, Gitignore, Issues, Labels, Markdown, Milestones, Notifications, Objects, Organizations, PubSubHubbub, Pulls, RateLimit, Refs, Repositories, Say, Stats, Statuses, Users

Instance Method Summary

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

  A new instance of Client.

Methods included from GitHub

#github_meta

Methods included from Gitignore

#gitignore_template, #gitignore_templates

Methods included from RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Stats

#code_frequency_stats, #commit_activity_stats, #contributors_stats, #participation_stats, #punch_card_stats

Methods included from Say

#say

Methods included from Statuses

#create_status, #github_status, #github_status_last_message, #github_status_messages, #statuses

Methods included from Emojis

#emojis

Methods included from Markdown

#markdown

Methods included from Contents

#archive_link, #contents, #create_contents, #delete_contents, #readme, #update_contents

Methods included from Refs

#create_ref, #delete_ref, #ref, #refs, #update_ref

Methods included from Authorizations

#authorization, #authorizations, #create_authorization, #delete_authorization, #scopes, #update_authorization

Methods included from Notifications

#delete_thread_subscription, #mark_notifications_as_read, #mark_repository_notifications_as_read, #mark_thread_as_read, #notifications, #repository_notifications, #thread_notifications, #thread_subscription, #update_thread_subscription

Methods included from Events

#organization_events, #organization_public_events, #public_events, #received_events, #received_public_events, #repository_events, #repository_network_events, #user_events, #user_public_events

Methods included from Users

#access_token, #add_email, #add_key, #all_users, #emails, #follow, #followers, #following, #follows?, #key, #keys, #remove_email, #remove_key, #search_users, #starred, #starred?, #subscriptions, #unfollow, #update_key, #update_user, #user, #user_keys, #validate_credentials, #watched

Methods included from Repositories

#add_collaborator, #add_deploy_key, #all_repositories, #branch, #branches, #check_assignee, #collaborators, #contributors, #create_hook, #create_repository, #delete_repository, #delete_subscription, #deploy_keys, #edit_hook, #edit_repository, #fork, #forks, #hook, #hooks, #languages, #remove_collaborator, #remove_deploy_key, #remove_hook, #repositories, #repository, #repository?, #repository_assignees, #repository_issue_events, #repository_teams, #search_repositories, #set_private, #set_public, #star, #stargazers, #subscribers, #subscription, #tags, #test_hook, #unstar, #unwatch, #update_subscription, #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_comment, #create_pull_request_comment_reply, #create_pull_request_for_issue, #delete_pull_request_comment, #merge_pull_request, #pull_merged?, #pull_request, #pull_request_comment, #pull_request_comments, #pull_request_commits, #pull_request_files, #pull_requests, #pull_requests_comments, #update_pull_request, #update_pull_request_comment

Methods included from Organizations

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

Methods included from Objects

#blob, #create_blob, #create_tag, #create_tree, #tag, #tree

Methods included from Milestones

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

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, #issues_comments, #list_issues, #org_issues, #reopen_issue, #search_issues, #update_comment, #update_issue, #user_issues

Methods included from Gists

#create_gist, #create_gist_comment, #delete_gist, #delete_gist_comment, #edit_gist, #fork_gist, #gist, #gist_comment, #gist_comments, #gist_starred?, #gists, #public_gists, #star_gist, #starred_gists, #unstar_gist, #update_gist_comment

Methods included from Downloads

#create_download, #delete_download, #download, #downloads

Methods included from Commits

#commit, #commit_comment, #commit_comments, #commits, #commits_before, #commits_between, #commits_on, #commits_since, #compare, #create_commit, #create_commit_comment, #delete_commit_comment, #list_commit_comments, #merge, #update_commit_comment

Methods included from Request

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

Methods included from Authentication

#authenticated?, #authentication, #login_and_password_from_netrc, #oauthed?, #unauthed_rate_limit_params, #unauthed_rate_limited?

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.

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

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

  login_and_password_from_netrc(options[:netrc])
end