Class: GitHub::Client

Inherits:
Object
  • Object
show all
Includes:
Commits, Contents, Events, Feeds, Gists, Gitignore, Issues, Markdown, Milestones, OAuth, Octocat, Orgs, PullRequests, Repos, Stats, Users, HTTParty
Defined in:
lib/github_api_v3/client.rb,
lib/github_api_v3/client/orgs.rb,
lib/github_api_v3/client/feeds.rb,
lib/github_api_v3/client/gists.rb,
lib/github_api_v3/client/oauth.rb,
lib/github_api_v3/client/repos.rb,
lib/github_api_v3/client/stats.rb,
lib/github_api_v3/client/users.rb,
lib/github_api_v3/client/events.rb,
lib/github_api_v3/client/issues.rb,
lib/github_api_v3/client/commits.rb,
lib/github_api_v3/client/octocat.rb,
lib/github_api_v3/client/contents.rb,
lib/github_api_v3/client/markdown.rb,
lib/github_api_v3/client/gitignore.rb,
lib/github_api_v3/client/milestones.rb,
lib/github_api_v3/client/pull_requests.rb

Overview

The main client for the API.

See Also:

Defined Under Namespace

Modules: Commits, Contents, Events, Feeds, Gists, Gitignore, Issues, Markdown, Milestones, OAuth, Octocat, Orgs, PullRequests, Repos, Stats, Users

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Users

#create_key, #delete_key, #emails, #follow, #followers, #following, #following?, #follows?, #key, #keys, #notifications, #organizations, #rate_limit, #repo_notifications, #starring, #starring?, #unfollow, #update_key, #user, #users, #watching

Methods included from Stats

#code_frequency, #commit_activity, #contributors_list, #participation, #punch_card

Methods included from Repos

#add_collaborator, #all_repos, #assignee?, #assignees, #branch, #branches, #collaborator?, #collaborators, #contributors, #create_repo, #delete_repo, #edit_repo, #languages, #org_repos, #remove_collaborator, #repo, #repos, #star, #stargazers, #subscribe, #subscription, #tags, #unstar, #unsubscribe, #watchers

Methods included from PullRequests

#create_pull_request, #create_pull_request_comment, #delete_pull_request_comment, #edit_pull_request_comment, #merge_pull_request, #pull_request, #pull_request_comment, #pull_request_comments, #pull_request_commits, #pull_request_files, #pull_request_merged?, #pull_requests, #repo_pull_request_comments, #update_pull_request

Methods included from Orgs

#add_team_member, #add_team_repo, #create_team, #delete_team, #edit_organization, #edit_team, #organization, #organization_member?, #organization_members, #organization_public_member?, #organization_public_members, #publicize_membership, #remove_organization_member, #remove_team_member, #remove_team_repo, #team, #team_member?, #team_members, #team_repo?, #team_repos, #teams, #unpublicize_membership

Methods included from Octocat

#octocat

Methods included from OAuth

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

Methods included from Milestones

#create_milestone, #delete_milestone, #milestone, #milestones, #update_milestone

Methods included from Markdown

#markdown

Methods included from Issues

#create_issue, #create_issue_comment, #delete_issue_comment, #edit_issue, #edit_issue_comment, #issue, #issue_comment, #issue_comments, #issue_event, #issue_events, #issues, #issues_comments, #org_issues, #repo_issues, #user_issues

Methods included from Gists

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

Methods included from Gitignore

#gitignore, #gitignore_list

Methods included from Feeds

#feeds

Methods included from Events

#events, #organization_events, #public_received_events, #public_user_events, #received_events, #repo_events, #repo_issue_events, #repo_network_events, #user_events, #user_organization_events

Methods included from Contents

#archive, #contents, #create_file, #delete_file, #readme, #update_file

Methods included from Commits

#commit, #commits, #compare_commits

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.



51
52
53
54
55
 
# File 'lib/github_api_v3/client.rb', line 51

def initialize(options={})
  @login = options[:login]
  @access_token = options[:access_token] if options[:access_token]
  @password = options[:password] if options[:password]
end

Instance Attribute Details

#access_token ⇒ Object

Returns the value of attribute access_token.



49
50
51
 
# File 'lib/github_api_v3/client.rb', line 49

def access_token
  @access_token
end

#login ⇒ Object

Returns the value of attribute login.



49
50
51
 
# File 'lib/github_api_v3/client.rb', line 49

def 
  @login
end

#password ⇒ Object

Returns the value of attribute password.



49
50
51
 
# File 'lib/github_api_v3/client.rb', line 49

def password
  @password
end