class Travis::Tools::Github
Constants
- GITHUB_API
- GITHUB_HOST
- TOKEN_SIZE
Attributes
after_tokens[RW]
api_url[RW]
ask_login[RW]
ask_otp[RW]
ask_password[RW]
auto_password[RW]
auto_token[RW]
callback[RW]
check_token[RW]
composer_path[RW]
debug[RW]
drop_token[RW]
explode[RW]
git_config_keys[RW]
github_login[RW]
github_token[RW]
hub_path[RW]
login_header[RW]
manual_login[RW]
netrc_path[RW]
no_token[RW]
note[RW]
oauth_paths[RW]
scopes[RW]
Public Class Methods
new(options = nil) { |self| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 17 def initialize(options = nil) @check_token = true @manual_login = true @ask_login = proc { raise "ask_login callback not set" } @after_tokens = proc { } @ask_password = proc { |_| raise "ask_password callback not set" } @ask_otp = proc { |_| raise "ask_otp callback not set" } @debug = proc { |_| } @netrc_path = '~/.netrc' @hub_path = ENV['HUB_CONFIG'] || '~/.config/hub' @oauth_paths = ['~/.github-oauth-token'] @composer_path = "~/.composer/config.json" @note = 'temporary token' @git_config_keys = %w[github.token github.oauth-token] @scopes = ['user', 'user:email', 'repo'] # overridden by value from /config options.each_pair { |k,v| send("#{k}=", v) if respond_to? "#{k}=" } if options yield self if block_given? end
Public Instance Methods
acceptable?(token)
click to toggle source
# File lib/travis/tools/github.rb, line 243 def acceptable?(token) return true unless check_token gh = GH.with(:token => token) user = gh['user'] if github_login and github_login != user['login'] debug "token is not acceptable: identifies %p instead of %p" % [user['login'], github_login] false else true end rescue GH::Error => error debug "token is not acceptable: #{gh_error(error)}" false end
api_host()
click to toggle source
# File lib/travis/tools/github.rb, line 203 def api_host return GITHUB_API unless api_url api_url[%r{^(?:https?://)?([^/]+)}, 1] end
ask_credentials()
click to toggle source
# File lib/travis/tools/github.rb, line 87 def ask_credentials login_header.call if login_header user = github_login || ask_login.call password = ask_password.arity == 0 ? ask_password.call : ask_password.call(user) [user, password] end
basic_auth(user, password, die = true, otp = nil, &block)
click to toggle source
# File lib/travis/tools/github.rb, line 208 def basic_auth(user, password, die = true, otp = nil, &block) gh = GH.with(:username => user, :password => password) with_otp(gh, user, otp, &block) rescue GH::Error => error raise gh_error(error) if die end
composer_token() { |token| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 121 def composer_token file(composer_path) do |content| token = JSON.parse(content)['config'].fetch('github-oauth', {})[host] yield token if token end end
create_token(gh)
click to toggle source
# File lib/travis/tools/github.rb, line 224 def create_token(gh) gh.post('/authorizations', :scopes => scopes, :note => note) rescue GH::Error => error # token might already exist due to bug in earlier CLI version, we'll have to delete it first raise error unless error.info[:response_status] == 422 and error.info[:response_body].to_s =~ /already_exists/ raise error unless reply = gh['/authorizations'].detect { |a| a['note'] == note } gh.delete(reply['_links']['self']['href']) retry end
each_token() { |t| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 48 def each_token require 'gh' unless defined? GH possible_tokens { |t| yield(t) if acceptable?(t) } ensure callback, self.callback = self.callback, nil callback.call if callback end
git_tokens() { |token| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 111 def git_tokens return unless System.has? 'git' git_config_keys.each do |key| `git config --get-all #{key}`.each_line do |line| token = line.strip yield token unless token.empty? end end end
github_for_mac_token(&block)
click to toggle source
# File lib/travis/tools/github.rb, line 193 def github_for_mac_token(&block) command = '-s "github.com/mac"' command << " -a #{github_login}" if github_login security(:internet, :w, command, "GitHub for Mac token", &block) if host == 'github.com' end
host()
click to toggle source
# File lib/travis/tools/github.rb, line 199 def host api_host == GITHUB_API ? GITHUB_HOST : api_host end
hub()
click to toggle source
# File lib/travis/tools/github.rb, line 183 def hub file(hub_path, {}) do |contents| YAML.load(contents) end end
hub_logins() { |entry, entry| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 152 def hub_logins hub.fetch(host, []).each do |entry| next if github_login and github_login != entry["user"] yield entry["user"], entry["password"] if entry["user"] and entry["password"] end end
hub_tokens() { |entry| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 128 def hub_tokens hub.fetch(host, []).each do |entry| next if github_login and github_login != entry["user"] yield entry["oauth_token"] if entry["oauth_token"] end end
issuepost_token(&block)
click to toggle source
# File lib/travis/tools/github.rb, line 189 def issuepost_token(&block) security(:generic, :w, "-l issuepost.github.access_token", "issuepost token", &block) if host == 'github.com' end
keychain_login() { |github_login, password| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 159 def keychain_login if github_login security(:internet, :w, "-s #{host} -a #{github_login}", "#{host} password for #{github_login}") do |password| yield github_login, password if password and not password.empty? end else security(:internet, :g, "-s #{host}", "#{host} login and password") do |data| username = data[/^\s+"acct"<blob>="(.*)"$/, 1].to_s password = data[/^password: "(.*)"$/, 1].to_s yield username, password unless username.empty? or password.empty? end end end
login(user, password, die = true, otp = nil)
click to toggle source
# File lib/travis/tools/github.rb, line 215 def login(user, password, die = true, otp = nil) basic_auth(user, password, die, otp) do |gh, new_otp| reply = create_token(gh) auth_href = reply['_links']['self']['href'] self.callback = proc { with_otp(gh, user, new_otp) { |g| g.delete(auth_href) } } if drop_token reply['token'] end end
netrc()
click to toggle source
# File lib/travis/tools/github.rb, line 173 def netrc file(netrc_path, []) do |contents| contents.scan(/^\s*(\S+)\s+(\S+)\s*$/).inject([]) do |mapping, (key, value)| mapping << {} if key == "machine" mapping.last[key] = value if mapping.last mapping end end end
netrc_logins() { |entry, entry| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 144 def netrc_logins netrc.each do |entry| next unless entry["machine"] == api_host or entry["machine"] == host next if github_login and github_login != entry["login"] yield entry["login"], entry["password"] if entry["login"] and entry["password"] end end
netrc_tokens() { |entry| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 100 def netrc_tokens netrc.each do |entry| next unless entry["machine"] == api_host or entry["machine"] == host entry.values_at("token", "login", "password").each do |entry| next if entry.to_s.size != TOKEN_SIZE debug "found oauth token in netrc" yield entry end end end
oauth_file_tokens() { |token| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 135 def oauth_file_tokens(&block) oauth_paths.each do |path| file(path) do |content| token = content.strip yield token unless token.empty? end end end
possible_logins(&block)
click to toggle source
# File lib/travis/tools/github.rb, line 94 def possible_logins(&block) netrc_logins(&block) hub_logins(&block) keychain_login(&block) end
possible_tokens() { |login(user, password, false)| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 60 def possible_tokens(&block) return block[github_token] if github_token if auto_token netrc_tokens(&block) git_tokens(&block) hub_tokens(&block) oauth_file_tokens(&block) github_for_mac_token(&block) issuepost_token(&block) composer_token(&block) end if auto_password possible_logins do |user, password| yield login(user, password, false) end end if manual_login user, password = ask_credentials yield login(user, password, true) end after_tokens.call end
with_basic_auth() { |gh| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 40 def with_basic_auth(&block) user, password = ask_credentials basic_auth(user, password, true) do |gh, _| gh['user'] # so otp kicks in yield gh end end
with_otp(gh, user, otp, &block)
click to toggle source
# File lib/travis/tools/github.rb, line 234 def with_otp(gh, user, otp, &block) gh = GH.with(gh.options.merge(:headers => { "X-GitHub-OTP" => otp })) if otp block.call(gh, otp) rescue GH::Error => error raise error unless error.info[:response_status] == 401 and error.info[:response_headers]['x-github-otp'].to_s =~ /required/ otp = ask_otp.arity == 0 ? ask_otp.call : ask_otp.call(user) retry end
with_session() { |t| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 56 def with_session(&block) with_token { |t| GH.with(:token => t) { yield(t) } } end
with_token() { |t| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 36 def with_token each_token { |t| break yield(t) } end
Private Instance Methods
file(path, default = nil) { |read| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 285 def file(path, default = nil) path &&= File.expand_path(path) @file ||= {} @file[path] ||= if path and File.readable?(path) debug "reading #{path}" yield File.read(path) end @file[path] || default rescue => e raise e if explode end
gh_error(error)
click to toggle source
# File lib/travis/tools/github.rb, line 261 def gh_error(error) raise error if explode if error.info.key? :response_body JSON.parse(error.info[:response_body])["message"].to_s else "Unknown error" end end
security(type, key, arg, name) { |result| ... }
click to toggle source
# File lib/travis/tools/github.rb, line 275 def security(type, key, arg, name) return false unless System.has? 'security' return false unless system "security find-#{type}-password #{arg} 2>/dev/null >/dev/null" debug "requesting to load #{name} from keychain" result = %x[security find-#{type}-password #{arg} -#{key} 2>&1].chomp $?.success? ? yield(result) : debug("request denied") rescue => e raise e if explode end