require 'octokit/connection' require 'octokit/warnable' require 'octokit/arguments' require 'octokit/repo_arguments' require 'octokit/configurable' require 'octokit/authentication' require 'octokit/gist' require 'octokit/rate_limit' require 'octokit/repository' require 'octokit/user' require 'octokit/organization' require 'octokit/client/authorizations' require 'octokit/client/commits' require 'octokit/client/commit_comments' require 'octokit/client/contents' require 'octokit/client/downloads' require 'octokit/client/deployments' require 'octokit/client/emojis' require 'octokit/client/events' require 'octokit/client/feeds' require 'octokit/client/gists' require 'octokit/client/gitignore' require 'octokit/client/hooks' require 'octokit/client/issues' require 'octokit/client/labels' require 'octokit/client/legacy_search' require 'octokit/client/licenses' require 'octokit/client/meta' require 'octokit/client/markdown' require 'octokit/client/milestones' require 'octokit/client/notifications' require 'octokit/client/objects' require 'octokit/client/organizations' require 'octokit/client/pages' require 'octokit/client/pub_sub_hubbub' require 'octokit/client/pull_requests' require 'octokit/client/rate_limit' require 'octokit/client/refs' require 'octokit/client/releases' require 'octokit/client/repositories' require 'octokit/client/say' require 'octokit/client/search' require 'octokit/client/service_status' require 'octokit/client/stats' require 'octokit/client/statuses' require 'octokit/client/users' module Octokit # Client for the GitHub API # # @see https://developer.github.com class Client include Octokit::Authentication include Octokit::Configurable include Octokit::Connection include Octokit::Warnable include Octokit::Client::Authorizations include Octokit::Client::Commits include Octokit::Client::CommitComments include Octokit::Client::Contents include Octokit::Client::Deployments include Octokit::Client::Downloads include Octokit::Client::Emojis include Octokit::Client::Events include Octokit::Client::Feeds include Octokit::Client::Gists include Octokit::Client::Gitignore include Octokit::Client::Hooks include Octokit::Client::Issues include Octokit::Client::Labels include Octokit::Client::LegacySearch include Octokit::Client::Licenses include Octokit::Client::Meta include Octokit::Client::Markdown include Octokit::Client::Milestones include Octokit::Client::Notifications include Octokit::Client::Objects include Octokit::Client::Organizations include Octokit::Client::Pages include Octokit::Client::PubSubHubbub include Octokit::Client::PullRequests include Octokit::Client::RateLimit include Octokit::Client::Refs include Octokit::Client::Releases include Octokit::Client::Repositories include Octokit::Client::Say include Octokit::Client::Search include Octokit::Client::ServiceStatus include Octokit::Client::Stats include Octokit::Client::Statuses include Octokit::Client::Users # Header keys that can be passed in options hash to {#get},{#head} CONVENIENCE_HEADERS = Set.new([:accept, :content_type]) def initialize(options = {}) # Use options passed in, but fall back to module defaults Octokit::Configurable.keys.each do |key| instance_variable_set(:"@#{key}", options[key] || Octokit.instance_variable_get(:"@#{key}")) end login_from_netrc unless user_authenticated? || application_authenticated? end # Text representation of the client, masking tokens and passwords # # @return [String] def inspect inspected = super # mask password inspected = inspected.gsub! @password, "*******" if @password inspected = inspected.gsub! @management_console_password, "*******" if @management_console_password # Only show last 4 of token, secret if @access_token inspected = inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}" end if @client_secret inspected = inspected.gsub! @client_secret, "#{'*'*36}#{@client_secret[36..-1]}" end inspected end # Duplicate client using client_id and client_secret as # Basic Authentication credentials. # @example # Octokit.client_id = "foo" # Octokit.client_secret = "bar" # # # GET https://api.github.com/?client_id=foo&client_secret=bar # Octokit.get "/" # # Octokit.client.as_app do |client| # # GET https://foo:bar@api.github.com/ # client.get "/" # end def as_app(key = client_id, secret = client_secret, &block) if key.to_s.empty? || secret.to_s.empty? raise ApplicationCredentialsRequired, "client_id and client_secret required" end app_client = self.dup app_client.client_id = app_client.client_secret = nil app_client.login = key app_client.password = secret yield app_client if block_given? end # Set username for authentication # # @param value [String] GitHub username def login=(value) reset_agent @login = value end # Set password for authentication # # @param value [String] GitHub password def password=(value) reset_agent @password = value end # Set OAuth access token for authentication # # @param value [String] 40 character GitHub OAuth access token def access_token=(value) reset_agent @access_token = value end # Set OAuth app client_id # # @param value [String] 20 character GitHub OAuth app client_id def client_id=(value) reset_agent @client_id = value end # Set OAuth app client_secret # # @param value [String] 40 character GitHub OAuth app client_secret def client_secret=(value) reset_agent @client_secret = value end end end