Module: Jist

Extended by:
Jist
Included in:
Jist
Defined in:
lib/jist.rb

Overview

It just gists.

Defined Under Namespace

Modules: Error

Constant Summary collapse

VERSION = 
'1.2.0'
CLIPBOARD_COMMANDS =

A list of clipboard commands with copy and paste support.

{
  'xclip'   => 'xclip -o',
  'xsel'    => 'xsel -o',
  'pbcopy'  => 'pbpaste',
  'putclip' => 'getclip'
}

Instance Method Summary collapse

Instance Method Details

#clipboard_command(action) ⇒ String

Get the command to use for the clipboard action.

Parameters:

  • action (Symbol) —

    either :copy or :paste

Returns:

  • (String) —

    the command to run

Raises:

  • (RuntimeError) —

    if no clipboard integration could be found



256
257
258
259
260
261
262
 
# File 'lib/jist.rb', line 256

def clipboard_command(action)
  command = CLIPBOARD_COMMANDS.keys.detect do |cmd|
    which cmd
  end
  raise "Could not find copy command, tried: #{CLIPBOARD_COMMANDS}" unless command
  action == :copy ? command : CLIPBOARD_COMMANDS[command]
end

#copy(content) ⇒ Object

Copy a string to the clipboard.

This method was heavily inspired by defunkt’s Gist#copy,

Parameters:

  • content (String)

Raises:

  • (RuntimeError) —

    if no clipboard integration could be found

See Also:



221
222
223
224
 
# File 'lib/jist.rb', line 221

def copy(content)
  IO.popen(clipboard_command(:copy), 'r+') { |clip| clip.print content }
  raise "Copying to clipboard failed" unless paste == content
end

#gist(content, options = {}) ⇒ Hash

Upload a gist to gist.github.com

Parameters:

  • content (String) —

    the code you’d like to gist

  • options (Hash) (defaults to: {}) —

    more detailed options

Options Hash (options):

  • :description (String) —

    the description

  • :filename (String) — default: 'a.rb' —

    the filename

  • :public (Boolean) — default: false —

    is this gist public

  • :anonymous (Boolean) — default: false —

    is this gist anonymous

  • :shorten (Boolean) — default: false —

    Shorten the resulting URL using git.io.

  • :access_token (String) — default: `File.read("~/.jist")` —

    The OAuth2 access token.

  • :update (String) —

    the URL or id of a gist to update

  • :copy (Boolean) — default: false —

    Copy resulting URL to clipboard, if successful.

  • :open (Boolean) — default: false —

    Open the resulting URL in a browser.

Returns:

  • (Hash) —

    the decoded JSON response from the server

Raises:

See Also:



41
42
43
44
 
# File 'lib/jist.rb', line 41

def gist(content, options = {})
  filename = options[:filename] || "a.rb"
  multi_gist({filename => content}, options)
end

#http(request) ⇒ Net::HTTPResponse

Run an HTTP operation against api.github.com

Parameters:

  • request (Net::HTTPRequest)

Returns:

  • (Net::HTTPResponse) 


190
191
192
193
194
195
196
 
# File 'lib/jist.rb', line 190

def http(request)
  http_connection().start do |http|
    http.request request
  end
rescue Timeout::Error
  raise "Could not connect to https://api.github.com/"
end

#http_connection ⇒ Net::HTTP

Return HTTP connection

Returns:

  • (Net::HTTP) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/jist.rb', line 170

def http_connection
  env = ENV['http_proxy'] || ENV['HTTP_PROXY']
  connection = if env
                 uri = URI(env)
                 proxy_host, proxy_port = uri.host, uri.port
                 Net::HTTP::Proxy(proxy_host, proxy_port).new("api.github.com", 443)
               else
                 Net::HTTP.new("api.github.com", 443)
               end
  connection.use_ssl = true
  connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
  connection.open_timeout = 10
  connection.read_timeout = 10
  connection
end

#login! ⇒ Object

Log the user into jist.

This method asks the user for a username and password, and tries to obtain and OAuth2 access token, which is then stored in ~/.jist

Raises:

See Also:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/jist.rb', line 131

def login!
  puts "Obtaining OAuth2 access_token from github."
  print "Github username: "
  username = $stdin.gets.strip
  print "Github password: "
  password = begin
    `stty -echo` rescue nil
    $stdin.gets.strip
  ensure
    `stty echo` rescue nil
  end
  puts ""

  request = Net::HTTP::Post.new("/authorizations")
  request.body = JSON.dump({
    :scopes => [:gist],
    :note => "The jist gem",
    :note_url => "https://github.com/ConradIrwin/jist"
  })
  request.content_type = 'application/json'
  request.basic_auth(username, password)

  response = http(request)

  if Net::HTTPCreated === response
    File.open(File.expand_path("~/.jist"), 'w') do |f|
      f.write JSON.parse(response.body)['token']
    end
    puts "Success! https://github.com/settings/applications"
  else
    raise "Got #{response.class} from gist: #{response.body}"
  end
rescue => e
  raise e.extend Error
end

#multi_gist(files, options = {}) ⇒ Hash

Upload a gist to gist.github.com

Parameters:

  • files (Hash) —

    the code you’d like to gist: filename => content

  • options (Hash) (defaults to: {}) —

    more detailed options

Options Hash (options):

  • :description (String) —

    the description

  • :public (Boolean) — default: false —

    is this gist public

  • :anonymous (Boolean) — default: false —

    is this gist anonymous

  • :shorten (Boolean) — default: false —

    Shorten the resulting URL using git.io.

  • :access_token (String) — default: `File.read("~/.jist")` —

    The OAuth2 access token.

  • :update (String) —

    the URL or id of a gist to update

  • :copy (Boolean) — default: false —

    Copy resulting URL to clipboard, if successful.

  • :open (Boolean) — default: false —

    Open the resulting URL in a browser.

Returns:

  • (Hash) —

    the decoded JSON response from the server

Raises:

See Also:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/jist.rb', line 64

def multi_gist(files, options={})
  json = {}

  json[:description] = options[:description] if options[:description]
  json[:public] = !!options[:public]
  json[:files] = {}

  files.each_pair do |(name, content)|
    raise "Cannot gist empty files" if content.to_s.strip == ""
    json[:files][File.basename(name)] = {:content => content}
  end

  existing_gist = options[:update].to_s.split("/").last
  if options[:anonymous]
    access_token = nil
  else
    access_token = (options[:access_token] || File.read(File.expand_path("~/.jist")) rescue nil)
  end

  url = "/gists"
  url << "/" << CGI.escape(existing_gist) if existing_gist.to_s != ''
  url << "?access_token=" << CGI.escape(access_token) if access_token.to_s != ''

  request = Net::HTTP::Post.new(url)
  request.body = JSON.dump(json)
  request.content_type = 'application/json'

  retried = false

  begin
    response = http(request)
    if Net::HTTPSuccess === response
      on_success(response.body, options)
    else
      raise "Got #{response.class} from gist: #{response.body}"
    end
  rescue => e
    raise if retried
    retried = true
    retry
  end

rescue => e
  raise e.extend Error
end

#on_success(body, options = {}) ⇒ Hash

Called after an HTTP response to gist to perform post-processing.

Parameters:

  • body (String) —

    the HTTP-200 response

  • options (Hash) (defaults to: {}) —

    any options

Options Hash (options):

  • :copy (Boolean) —

    copy the URL to the clipboard

Returns:

  • (Hash) —

    the parsed JSON response from the server



204
205
206
207
208
209
210
211
212
 
# File 'lib/jist.rb', line 204

def on_success(body, options={})
  json = JSON.parse(body)

  json['html_url'] = shorten(json['html_url']) if options[:shorten]
  Jist.copy(json['html_url']) if options[:copy]
  Jist.open(json['html_url']) if options[:open]

  json
end

#open(url) ⇒ Object

Open a URL in a browser.

This method was heavily inspired by defunkt’s Gist#open,

Parameters:

  • url (String)

Raises:

  • (RuntimeError) —

    if no browser integration could be found

See Also:



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/jist.rb', line 271

def open(url)
  command = if ENV['BROWSER']
              ENV['BROWSER']
            elsif RUBY_PLATFORM =~ /darwin/
              'open'
            elsif RUBY_PLATFORM =~ /linux/
              'sensible-browser'
            elsif ENV['OS'] == 'Windows_NT' || RUBY_PLATFORM =~ /djgpp|(cyg|ms|bcc)win|mingw|wince/i
              'start ""'
            else
              raise "Could not work out how to use a browser."
            end

  `#{command} #{url}`
end

#paste ⇒ Object

Get a string from the clipboard.

Parameters:

  • content (String)

Raises:

  • (RuntimeError) —

    if no clipboard integration could be found



230
231
232
 
# File 'lib/jist.rb', line 230

def paste
  `#{clipboard_command(:paste)}`
end

#shorten(url) ⇒ String

Convert long github urls into shotr git.io ones

Parameters:

  • url (String)

Returns:

  • (String) —

    shortened url, or long url if shortening fails



114
115
116
117
118
119
120
121
122
 
# File 'lib/jist.rb', line 114

def shorten(url)
  response = Net::HTTP.post_form(URI("http://git.io/"), :url => url)
  case response.code
  when "201"
    response['Location']
  else
    url
  end
end

#which(cmd, path = ) ⇒ String

Find command from PATH environment.

Parameters:

  • cmd (String) —

    command name to find

  • options (String) —

    PATH environment variable

Returns:

  • (String) —

    the command found



239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/jist.rb', line 239

def which(cmd, path=ENV['PATH'])
  if RUBY_PLATFORM.downcase =~ /mswin(?!ce)|mingw|bccwin|cygwin/
    path.split(File::PATH_SEPARATOR).each {|dir|
      f = File.join(dir, cmd+".exe")
      return f if File.executable?(f) && !File.directory?(f)
    }
    nil
  else
    return system("which #{cmd} > /dev/null 2>&1")
  end
end