Module: Jist
Overview
It just gists.
Defined Under Namespace
Modules: Error Classes: ClipboardError
Constant Summary collapse
- VERSION =
'1.5.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")
- GITHUB_BASE_PATH =
""
- GHE_BASE_PATH =
"/api/v3"
- URL_ENV_NAME =
"GITHUB_URL"
Instance Method Summary collapse
-
#api_url ⇒ Object
Get the API URL.
- #auth_token_file ⇒ Object
-
#base_path ⇒ Object
Get the API base path.
-
#clipboard_command(action) ⇒ String
Get the command to use for the clipboard action.
-
#copy(content) ⇒ Object
Copy a string to the clipboard.
-
#gist(content, options = {}) ⇒ Object
Upload a gist to gist.github.com.
-
#http(url, request) ⇒ Net::HTTPResponse
Run an HTTP operation.
-
#http_connection(uri) ⇒ Net::HTTP
Return HTTP connection.
-
#login! ⇒ Object
Log the user into jist.
-
#multi_gist(files, options = {}) ⇒ String, Hash
Upload a gist to gist.github.com.
-
#on_success(body, options = {}) ⇒ Object
Called after an HTTP response to gist to perform post-processing.
-
#open(url) ⇒ Object
Open a URL in a browser.
-
#paste ⇒ Object
Get a string from the clipboard.
-
#shorten(url) ⇒ String
Convert long github urls into short git.io ones.
-
#which(cmd, path = ) ⇒ String
Find command from PATH environment.
Instance Method Details
#api_url ⇒ Object
Get the API URL
331 332 333 |
# File 'lib/jist.rb', line 331 def api_url ENV.key?(URL_ENV_NAME) ? URI(ENV[URL_ENV_NAME]) : GITHUB_API_URL end |
#auth_token_file ⇒ Object
335 336 337 338 339 340 341 |
# File 'lib/jist.rb', line 335 def auth_token_file if ENV.key?(URL_ENV_NAME) File. "~/.jist.#{ENV[URL_ENV_NAME].gsub(/[^a-z.]/, '')}" else File. "~/.jist" end end |
#base_path ⇒ Object
Get the API base path
326 327 328 |
# File 'lib/jist.rb', line 326 def base_path ENV.key?(URL_ENV_NAME) ? GHE_BASE_PATH : GITHUB_BASE_PATH end |
#clipboard_command(action) ⇒ String
Get the command to use for the clipboard action.
285 286 287 288 289 290 291 292 293 294 |
# File 'lib/jist.rb', line 285 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.
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/jist.rb', line 239 def copy(content) IO.popen(clipboard_command(:copy), 'r+') { |clip| clip.print content } unless paste == content = 'Copying to clipboard failed.' if ENV["TMUX"] && clipboard_command(:copy) == 'pbcopy' << "\nIf you're running tmux on a mac, try http://robots.thoughtbot.com/post/19398560514/how-to-copy-and-paste-with-tmux-on-mac-os-x" end raise Error, end rescue Error => e raise ClipboardError, e. + "\nAttempted to copy: #{content}" end |
#gist(content, options = {}) ⇒ Object
Upload a gist to gist.github.com
43 44 45 46 |
# File 'lib/jist.rb', line 43 def gist(content, = {}) filename = [:filename] || "a.rb" multi_gist({filename => content}, ) end |
#http(url, request) ⇒ Net::HTTPResponse
Run an HTTP operation
201 202 203 204 205 206 207 |
# File 'lib/jist.rb', line 201 def http(url, request) http_connection(url).start do |http| http.request request end rescue Timeout::Error raise "Could not connect to #{api_url}" end |
#http_connection(uri) ⇒ Net::HTTP
Return HTTP connection
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/jist.rb', line 179 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
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 173 |
# File 'lib/jist.rb', line 139 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("#{base_path}/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(api_url, request) if Net::HTTPCreated === response File.open(auth_token_file, 'w') do |f| f.write JSON.parse(response.body)['token'] end puts "Success! #{ENV[URL_ENV_NAME] || "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 = {}) ⇒ String, Hash
Upload a gist to gist.github.com
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 114 |
# File 'lib/jist.rb', line 70 def multi_gist(files, ={}) json = {} json[:description] = [:description] if [:description] json[:public] = !![: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 = [:update].to_s.split("/").last if [:anonymous] access_token = nil else access_token = ([:access_token] || File.read(auth_token_file) rescue nil) end url = "#{base_path}/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(api_url, request) if Net::HTTPSuccess === response on_success(response.body, ) 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 = {}) ⇒ Object
Called after an HTTP response to gist to perform post-processing.
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/jist.rb', line 214 def on_success(body, ={}) json = JSON.parse(body) output = case [:output] when :javascript %Q{<script src="#{json['html_url']}.js"></script>} when :html_url json['html_url'] when :short_url shorten(json['html_url']) else json end Jist.copy(output.to_s) if [:copy] Jist.open(json['html_url']) if [:open] output end |
#open(url) ⇒ Object
Open a URL in a browser.
This method was heavily inspired by defunkt’s Gist#open,
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/jist.rb', line 303 def open(url) command = if ENV['BROWSER'] ENV['BROWSER'] elsif RUBY_PLATFORM =~ /darwin/ 'open' elsif RUBY_PLATFORM =~ /linux/ %w( sensible-browser firefox firefox-bin ).detect do |cmd| which cmd end 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.
259 260 261 |
# File 'lib/jist.rb', line 259 def paste `#{clipboard_command(:paste)}` end |
#shorten(url) ⇒ String
Convert long github urls into short git.io ones
120 121 122 123 124 125 126 127 128 129 130 |
# File 'lib/jist.rb', line 120 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.
268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/jist.rb', line 268 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 |