Module: Jist

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

Overview

It just gists.

Defined Under Namespace

Modules: Error Classes: ClipboardError

Constant Summary collapse

VERSION = 
'1.3.0'
CLIPBOARD_COMMANDS =

A list of clipboard commands with copy and paste support.

{
  'xclip'   => 'xclip -o',
  'xsel'    => 'xsel -o',
  'pbcopy'  => 'pbpaste',
  'putclip' => 'getclip'
}
GITHUB_API_URL = 
URI("https://api.github.com/")
GIT_IO_URL = 
URI("http://git.io")

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:



266
267
268
269
270
271
272
273
274
275
 
# File 'lib/jist.rb', line 266

def clipboard_command(action)
  command = CLIPBOARD_COMMANDS.keys.detect do |cmd|
    which cmd
  end
  raise ClipboardError, <<-EOT unless command
Could not find copy command, tried:
  #{CLIPBOARD_COMMANDS.values.join(' || ')}
  EOT
  action == :copy ? command : CLIPBOARD_COMMANDS[command]
end

#copy(content) ⇒ Object

Copy a string to the clipboard.

Parameters:

  • content (String)

Raises:

  • (Jist::Error) —

    if no clipboard integration could be found



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

def copy(content)
  IO.popen(clipboard_command(:copy), 'r+') { |clip| clip.print content }
  raise Error, 'Copying to clipboard failed.' unless paste == content
rescue Error => e
  raise ClipboardError, e.message + "\nAttempted to copy: #{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:



46
47
48
49
 
# File 'lib/jist.rb', line 46

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

#http(url, request) ⇒ Net::HTTPResponse

Run an HTTP operation

Parameters:

  • The (URI::HTTP) —

    URI to which to connect

  • The (Net::HTTPRequest) —

    request to make

Returns:

  • (Net::HTTPResponse) 


200
201
202
203
204
205
206
 
# File 'lib/jist.rb', line 200

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

#http_connection(uri) ⇒ Net::HTTP

Return HTTP connection

Parameters:

  • The (URI::HTTP) —

    URI to which to connect

Returns:

  • (Net::HTTP) 


178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/jist.rb', line 178

def http_connection(uri)
  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)
               else
                 Net::HTTP.new(uri.host, uri.port)
               end
  if uri.scheme == "https"
    connection.use_ssl = true
    connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
  end
  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:



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
166
167
168
169
170
171
172
 
# File 'lib/jist.rb', line 138

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(GITHUB_API_URL, 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:



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
109
110
111
112
113
 
# File 'lib/jist.rb', line 69

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(GITHUB_API_URL, 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



214
215
216
217
218
219
220
221
222
 
# File 'lib/jist.rb', line 214

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:



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/jist.rb', line 284

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:

  • (Jist::Error) —

    if no clipboard integration could be found



240
241
242
 
# File 'lib/jist.rb', line 240

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

#shorten(url) ⇒ String

Convert long github urls into short git.io ones

Parameters:

  • url (String)

Returns:

  • (String) —

    shortened url, or long url if shortening fails



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/jist.rb', line 119

def shorten(url)
  request = Net::HTTP::Post.new("/")
  request.set_form_data(:url => url)
  response = http(GIT_IO_URL, request)
  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



249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/jist.rb', line 249

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