Skip to content

Commit

Permalink
Build v6.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@ConradIrwin
ConradIrwin committed Aug 27, 2020
1 parent 17f0f3d commit d854c15
Show file tree
Hide file tree
Showing 2 changed files with 129 additions and 35 deletions.
97 changes: 81 additions & 16 deletions build/gist
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1318,7 +1318,7 @@ end
module Gist
extend self

VERSION = '5.1.0'
VERSION = '6.0.0'

# A list of clipboard commands with copy and paste support.
CLIPBOARD_COMMANDS = {
Expand All @@ -1329,12 +1329,16 @@ module Gist
}

GITHUB_API_URL = URI("https://api.github.com/")
GITHUB_URL = URI("https://github.com/")
GIT_IO_URL = URI("https://git.io")

GITHUB_BASE_PATH = ""
GHE_BASE_PATH = "/api/v3"

GITHUB_CLIENT_ID = '4f7ec0d4eab38e74384e'

URL_ENV_NAME = "GITHUB_URL"
CLIENT_ID_ENV_NAME = "GIST_CLIENT_ID"

USER_AGENT = "gist/#{VERSION} (Net::HTTP, #{RUBY_DESCRIPTION})"

Expand All @@ -1350,7 +1354,7 @@ module Gist
module AuthTokenFile
def self.filename
if ENV.key?(URL_ENV_NAME)
File.expand_path "~/.gist.#{ENV[URL_ENV_NAME].gsub(/:/, '.').gsub(/[^a-z0-9.]/, '')}"
File.expand_path "~/.gist.#{ENV[URL_ENV_NAME].gsub(/:/, '.').gsub(/[^a-z0-9.-]/, '')}"
else
File.expand_path "~/.gist"
end
Expand Down Expand Up @@ -1506,19 +1510,12 @@ module Gist
url = "#{base_path}"

if user == ""
access_token = auth_token()
if access_token.to_s != ''
url << "/gists?per_page=100"
get_gist_pages(url, access_token)
else
raise Error, "Not authenticated. Use 'gist --login' to login or 'gist -l username' to view public gists."
end

url << "/gists?per_page=100"
else
url << "/users/#{user}/gists?per_page=100"
get_gist_pages(url)
end

get_gist_pages(url, auth_token())
end

def read_gist(id, file_name=nil)
Expand Down Expand Up @@ -1642,15 +1639,71 @@ module Gist

# Log the user into gist.
#
def login!(credentials={})
if (login_url == GITHUB_URL || ENV.key?(CLIENT_ID_ENV_NAME)) && credentials.empty? && !ENV.key?('GIST_USE_USERNAME_AND_PASSWORD')
device_flow_login!
else
access_token_login!(credentials)
end
end

def device_flow_login!
puts "Requesting login parameters..."
request = Net::HTTP::Post.new("/login/device/code")
request.body = JSON.dump({
:scope => 'gist',
:client_id => client_id,
})
request.content_type = 'application/json'
request['accept'] = "application/json"
response = http(login_url, request)

if response.code != '200'
raise Error, "HTTP #{response.code}: #{response.body}"
end

body = JSON.parse(response.body)

puts "Please sign in at #{body['verification_uri']}"
puts " and enter code: #{body['user_code']}"
device_code = body['device_code']
interval = body['interval']

loop do
sleep(interval.to_i)
request = Net::HTTP::Post.new("/login/oauth/access_token")
request.body = JSON.dump({
:client_id => client_id,
:grant_type => 'urn:ietf:params:oauth:grant-type:device_code',
:device_code => device_code
})
request.content_type = 'application/json'
request['Accept'] = 'application/json'
response = http(login_url, request)
if response.code != '200'
raise Error, "HTTP #{response.code}: #{response.body}"
end
body = JSON.parse(response.body)
break unless body['error'] == 'authorization_pending'
end

if body['error']
raise Error, body['error_description']
end

AuthTokenFile.write JSON.parse(response.body)['access_token']

puts "Success! #{ENV[URL_ENV_NAME] || "https://github.com/"}settings/connections/applications/#{client_id}"
end

# Logs the user into gist.
#
# This method asks the user for a username and password, and tries to obtain
# and OAuth2 access token, which is then stored in ~/.gist
#
# @raise [Gist::Error] if something went wrong
# @param [Hash] credentials login details
# @option credentials [String] :username
# @option credentials [String] :password
# @see http://developer.github.com/v3/oauth/
def login!(credentials={})
def access_token_login!(credentials={})
puts "Obtaining OAuth2 access_token from GitHub."
loop do
print "GitHub username: "
Expand Down Expand Up @@ -1707,7 +1760,11 @@ module Gist
env = ENV['http_proxy'] || ENV['HTTP_PROXY']
connection = if env
proxy = URI(env)
Net::HTTP::Proxy(proxy.host, proxy.port).new(uri.host, uri.port)
if proxy.user
Net::HTTP::Proxy(proxy.host, proxy.port, proxy.user, proxy.password).new(uri.host, uri.port)
else
Net::HTTP::Proxy(proxy.host, proxy.port).new(uri.host, uri.port)
end
else
Net::HTTP.new(uri.host, uri.port)
end
Expand Down Expand Up @@ -1861,11 +1918,19 @@ Could not find copy command, tried:
ENV.key?(URL_ENV_NAME) ? GHE_BASE_PATH : GITHUB_BASE_PATH
end

def login_url
ENV.key?(URL_ENV_NAME) ? URI(ENV[URL_ENV_NAME]) : GITHUB_URL
end

# Get the API URL
def api_url
ENV.key?(URL_ENV_NAME) ? URI(ENV[URL_ENV_NAME]) : GITHUB_API_URL
end

def client_id
ENV.key?(CLIENT_ID_ENV_NAME) ? URI(ENV[CLIENT_ID_ENV_NAME]) : GITHUB_CLIENT_ID
end

def legacy_private_gister?
return unless which('git')
`git config --global gist.private` =~ /\Ayes|1|true|on\z/i
Expand Down
67 changes: 48 additions & 19 deletions build/gist.1
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIST" "1" "May 2018" "" "Gist manual"
.TH "GIST" "1" "August 2020" "" "Gist manual"
.
.SH "NAME"
\fBgist\fR \- upload code to https://gist\.github\.com
Expand Down Expand Up @@ -29,6 +29,12 @@ For OS X, gist lives in Homebrew
.IP
brew install gist
.
.IP "\(bu" 4
For FreeBSD, gist lives in ports
.
.IP
pkg install gist
.
.IP "" 0
.
.SH "Command"
Expand Down Expand Up @@ -121,14 +127,45 @@ See \fBgist \-\-help\fR for more detail\.
.IP "" 0
.
.SH "Login"
If you want to associate your gists with your GitHub account, you need to login with gist\. It doesn\'t store your username and password, it just uses them to get an OAuth2 token (with the "gist" permission)\.
Before you use \fBgist\fR for the first time you will need to log in\. There are two supported login flows:
.
.IP "1." 4
The Github device\-code Oauth flow\. This is the default for authenticating to github\.com, and can be enabled for Github Enterprise by creating an Oauth app, and exporting the environment variable \fBGIST_CLIENT_ID\fR with the client id of the Oauth app\.
.
.IP "2." 4
The (deprecated) username and password token exchange flow\. This is the default for GitHub Enterprise, and can be used to log into github\.com by exporting the environment variable \fBGIST_USE_USERNAME_AND_PASSWORD\fR\.
.
.IP "" 0
.
.SS "The device\-code flow"
This flow allows you to obtain a token by logging into GitHub in the browser and typing a verification code\. This is the preferred mechanism\.
.
.IP "" 4
.
.nf

gist \-\-login
Requesting login parameters\.\.\.
Please sign in at https://github\.com/login/device
and enter code: XXXX\-XXXX
Success! https://github\.com/settings/connections/applications/4f7ec0d4eab38e74384e
.
.fi
.
.IP "" 0
.
.P
The returned access_token is stored in \fB~/\.gist\fR and used for all future gisting\. If you need to you can revoke access from https://github\.com/settings/connections/applications/4f7ec0d4eab38e74384e\.
.
.SS "The username\-password flow"
This flow asks for your GitHub username and password (and 2FA code), and exchanges them for a token with the "gist" permission (your username and password are not stored)\. This mechanism is deprecated by GitHub, but may still work with GitHub Enterprise\.
.
.IP "" 4
.
.nf

gist \-\-login
Obtaining OAuth2 access_token from github\.
Obtaining OAuth2 access_token from GitHub\.
GitHub username: ConradIrwin
GitHub password:
2\-factor auth code:
Expand All @@ -141,19 +178,11 @@ Success! https://github\.com/settings/tokens
.P
This token is stored in \fB~/\.gist\fR and used for all future gisting\. If you need to you can revoke it from https://github\.com/settings/tokens, or just delete the file\.
.
.IP "\(bu" 4
After you\'ve done this, you can still upload gists anonymously with \fB\-a\fR\.
.
.IP
gist \-a a\.rb
.
.IP "" 0
.
.P
If you have a complicated authorization requirement you can manually create a token file by pasting a Github token with only the \fBgist\fR permission into a file called \fB~/\.gist\fR\. You can create one from https://github\.com/settings/tokens
If you have a complicated authorization requirement you can manually create a token file by pasting a GitHub token with \fBgist\fR scope (and maybe the \fBuser:email\fR for GitHub Enterprise) into a file called \fB~/\.gist\fR\. You can create one from https://github\.com/settings/tokens
.
.P
This file should contain only the token (~40 hex characters), and to make it easier to edit, can optionally have a final newline (\en or \er\en)\.
This file should contain only the token (~40 hex characters), and to make it easier to edit, can optionally have a final newline (\fB\en\fR or \fB\er\en\fR)\.
.
.P
For example, one way to create this file would be to run:
Expand All @@ -162,12 +191,15 @@ For example, one way to create this file would be to run:
.
.nf

echo MY_SECRET_TOKEN > ~/\.gist
(umask 0077 && echo MY_SECRET_TOKEN > ~/\.gist)
.
.fi
.
.IP "" 0
.
.P
The \fBumask\fR ensures that the file is only accessible from your user account\.
.
.SS "GitHub Enterprise"
If you\'d like \fBgist\fR to use your locally installed GitHub Enterprise \fIhttps://enterprise\.github\.com/\fR, you need to export the \fBGITHUB_URL\fR environment variable (usually done in your \fB~/\.bashrc\fR)\.
.
Expand All @@ -182,7 +214,7 @@ export GITHUB_URL=http://github\.internal\.example\.com/
.IP "" 0
.
.P
Once you\'ve done this and restarted your terminal (or run \fBsource ~/\.bashrc\fR), gist will automatically use github enterprise instead of the public github\.com
Once you\'ve done this and restarted your terminal (or run \fBsource ~/\.bashrc\fR), gist will automatically use GitHub Enterprise instead of the public github\.com
.
.P
Your token for GitHub Enterprise will be stored in \fB\.gist\.<protocol>\.<server\.name>[\.<port>]\fR (e\.g\. \fB~/\.gist\.http\.github\.internal\.example\.com\fR for the GITHUB_URL example above) instead of \fB~/\.gist\fR\.
Expand Down Expand Up @@ -218,9 +250,6 @@ If you need more advanced features you can also pass:
\fB:update\fR to update an existing gist (can be a URL or an id)\.
.
.IP "\(bu" 4
\fB:anonymous\fR to submit an anonymous gist (default is false)\.
.
.IP "\(bu" 4
\fB:copy\fR to copy the resulting URL to the clipboard (default is false)\.
.
.IP "\(bu" 4
Expand All @@ -229,7 +258,7 @@ If you need more advanced features you can also pass:
.IP "" 0
.
.P
NOTE: The access_token must have the "gist" scope\.
NOTE: The access_token must have the \fBgist\fR scope and may also require the \fBuser:email\fR scope\.
.
.IP "\(bu" 4
If you want to upload multiple files in the same gist, you can:
Expand Down

0 comments on commit d854c15

Please sign in to comment.