jist 0.9.2 → 0.10.0.pre.1

data/bin/jist

@@ -13,7 +13,7 @@ opts = OptionParser.new do |opts|
   opts.banner = <<-EOS
 Jist (v#{Jist::VERSION}) lets you upload to https://gist.github.com/
 
-Usage: #{executable_name} [-p] [-d DESC] [-t TOKEN|-a] [-u URL] [-f NAME]* [FILE]*
+Usage: #{executable_name} [-o|-c] [-p] [-d DESC] [-t TOKEN|-a] [-u URL] [-f NAME]* [FILE]*
        #{executable_name} --login
 
 The content to be uploaded can be passed as a list of files, if none are
@@ -32,6 +32,10 @@ Anonymous gists are not associated with your GitHub account, they can be created
 with "-a" even after you have used "jist --login". If you already have an access
 token with the "gist" scope, you can pass that with "-t".
 
+To copy the resulting URL to your clipboard you can use the -c option, or to just
+open it directly in your browser, use -o. You can add `alias jist='jist -c'` to
+your shell's rc file to configure this behaviour by default.
+
 Instead of creating a new jist, you can update an existing one by passing its ID
 or URL with "-u". For this to work, you must be logged in, and have created the
 original gist with the same GitHub account.
@@ -68,6 +72,14 @@ original gist with the same GitHub account.
     options[:access_token] = token
   end
 
+  opts.on("-c", "--copy", "Copy the resulting URL to the clipboard") do
+    options[:copy] = true
+  end
+
+  opts.on("-o", "--open", "Open the resulting URL in a browser") do
+    options[:open] = true
+  end
+
   opts.on_tail("-h","--help", "Show this message.") do
     puts opts
     exit

data/lib/jist.rb

@@ -4,13 +4,21 @@ require 'json'
 
 # It just gists.
 module Jist
+  extend self
 
-  VERSION = '0.9.2'
+  VERSION = '0.10.0.pre.1'
+
+  # A list of clipboard commands with copy and paste support.
+  CLIPBOARD_COMMANDS = {
+    'xclip'   => 'xclip -o',
+    'xsel'    => 'xsel -o',
+    'pbcopy'  => 'pbpaste',
+    'putclip' => 'getclip'
+  }
 
   # Exception tag for errors raised while gisting.
   module Error; end
 
-  module_function
   # Upload a gist to https://gist.github.com
   #
   # @param [String] content  the code you'd like to gist
@@ -22,6 +30,8 @@ module Jist
   # @option options [Boolean] :anonymous  (false) is this gist anonymous
   # @option options [String] :access_token  (`File.read("~/.jist")`) The OAuth2 access token.
   # @option options [String] :update  the URL or id of a gist to update
+  # @option options [Boolean] :copy  (false) Copy resulting URL to clipboard, if successful.
+  # @option options [Boolean] :open  (false) Open the resulting URL in a browser.
   #
   # @return [Hash]  the decoded JSON response from the server
   # @raise [Jist::Error]  if something went wrong
@@ -42,6 +52,8 @@ module Jist
   # @option options [Boolean] :anonymous  (false) is this gist anonymous
   # @option options [String] :access_token  (`File.read("~/.jist")`) The OAuth2 access token.
   # @option options [String] :update  the URL or id of a gist to update
+  # @option options [Boolean] :copy  (false) Copy resulting URL to clipboard, if successful.
+  # @option options [Boolean] :open  (false) Open the resulting URL in a browser.
   #
   # @return [Hash]  the decoded JSON response from the server
   # @raise [Jist::Error]  if something went wrong
@@ -79,7 +91,7 @@ module Jist
     begin
       response = http(request)
       if Net::HTTPSuccess === response
-        JSON.parse(response.body)
+        on_success(response.body, options)
       else
         raise "Got #{response.class} from gist: #{response.body}"
       end
@@ -152,4 +164,75 @@ module Jist
   rescue Timeout::Error
     raise "Could not connect to https://api.github.com/"
   end
+
+  # Called after an HTTP response to gist to perform post-processing.
+  #
+  # @param [String] body  the HTTP-200 response
+  # @param [Hash] options  any options
+  # @option options [Boolean] :copy  copy the URL to the clipboard
+  # @return [Hash]  the parsed JSON response from the server
+  def on_success(body, options={})
+    json = JSON.parse(body)
+
+    Jist.copy(json['html_url']) if options[:copy]
+    Jist.open(json['html_url']) if options[:open]
+
+    json
+  end
+
+  # Copy a string to the clipboard.
+  #
+  # @param [String] content
+  # @raise [RuntimeError] if no clipboard integration could be found
+  #
+  # This method was heavily inspired by defunkt's Gist#copy,
+  # @see https://github.com/defunkt/gist/blob/bca9b29/lib/gist.rb#L178
+  def copy(content)
+    IO.popen(clipboard_command(:copy), 'r+') { |clip| clip.print content }
+    raise "Copying to clipboard failed" unless paste == content
+  end
+
+  # Get a string from the clipboard.
+  #
+  # @param [String] content
+  # @raise [RuntimeError] if no clipboard integration could be found
+  def paste
+    `#{clipboard_command(:paste)}`
+  end
+
+  # Get the command to use for the clipboard action.
+  #
+  # @param [Symbol] action  either :copy or :paste
+  # @return [String]  the command to run
+  # @raise [RuntimeError] if no clipboard integration could be found
+  def clipboard_command(action)
+    command = CLIPBOARD_COMMANDS.keys.detect do |cmd|
+      system("type #{cmd} >/dev/null 2>&1")
+    end
+    raise "Could not find copy command, tried: #{CLIPBOARD_COMMANDS}" unless command
+    action == :copy ? command : CLIPBOARD_COMMANDS[command]
+  end
+
+  # Open a URL in a browser.
+  #
+  # @param [String] url
+  # @raise [RuntimeError] if no browser integration could be found
+  #
+  # This method was heavily inspired by defunkt's Gist#open,
+  # @see https://github.com/defunkt/gist/blob/bca9b29/lib/gist.rb#L157
+  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
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jist
 version: !ruby/object:Gem::Version
-  version: 0.9.2
-  prerelease: 
+  version: 0.10.0.pre.1
+  prerelease: 7
 platform: ruby
 authors:
 - Conrad Irwin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
+date: 2012-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -27,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides a single function (Jist.gist) that uploads a gist.
 email: conrad.irwin@gmail.com
 executables:
@@ -51,9 +83,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24