jist 1.3.1 → 1.4.0

data/README.md

@@ -28,6 +28,12 @@ $ jist a.rb
 https://gist.github.com/0d07bc98c139810a4075
 ```
 
+Upload multiple files : 
+```shell
+$ jist a b c
+$ jist *.rb
+```
+
 By default it reads from STDIN, and you can set a filename with `-f`.
 
 ```shell
@@ -62,6 +68,12 @@ $ jist -c <a.rb
 https://gist.github.com/7db51bb5f4f35c480fc8
 ```
 
+If you'd like to copy the resulting embeddable URL to your clipboard, use `--copy-js`.
+
+```shell
+$ jist --copy-js <a.rb
+<script src="https://gist.github.com/7db51bb5f4f35c480fc8"></script>
+```
 And you can just ask jist to open a browser window directly with `-o`.
 
 ```shell

data/bin/jist

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-
-require 'jist'
+require File.expand_path('../../lib/jist', __FILE__)
 
 # For the holdings of options.
 options = {}
@@ -33,14 +32,15 @@ If you would like to shorten the resulting gist URL, use the -s flag. This will
 use GitHub's URL shortener, git.io.
 
 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.
+open it directly in your browser, use -o. Using the -e option will copy the embeddable
+URL to the clipboard. 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.
 
-Usage: #{executable_name} [-o|-c] [-p] [-s] [-d DESC] [-t TOKEN|-a] [-u URL] [-P] [-f NAME]* FILE*
+Usage: #{executable_name} [-o|-c|-e] [-p] [-s] [-d DESC] [-t TOKEN|-a] [-u URL] [-P] [-f NAME]* FILE*
        #{executable_name} --login
 
   EOS
@@ -82,6 +82,10 @@ Usage: #{executable_name} [-o|-c] [-p] [-s] [-d DESC] [-t TOKEN|-a] [-u URL] [-P
   opts.on("-c", "--copy", "Copy the resulting URL to the clipboard") do
     options[:copy] = true
   end
+  opts.on("-e", "--embed", "Copy the embed code for the gist to the clipboard") do
+    options[:embed] = true
+    options[:copy] = true
+  end
 
   opts.on("-o", "--open", "Open the resulting URL in a browser") do
     options[:open] = true
@@ -105,11 +109,21 @@ end
 opts.parse!
 
 begin
+  options[:output] = if options[:embed] && options[:shorten]
+                       raise Jist::Error, "--embed does not make sense with --shorten"
+                     elsif options[:embed]
+                       :javascript
+                     elsif options[:shorten]
+                       :short_url
+                     else
+                       :html_url
+                     end
+
   if options[:paste]
-    puts Jist.gist(Jist.paste, options)['html_url']
+    puts Jist.gist(Jist.paste, options)
   elsif ARGV.size == 0
     $stderr.puts "(type a gist. <ctrl-c> to cancel, <ctrl-d> when done)" if $stdin.tty?
-    puts Jist.gist(ARGF.read, options)['html_url']
+    puts Jist.gist(ARGF.read, options)
   else
     files = {}
     ARGV.zip(filenames).each do |(file, name)|
@@ -120,7 +134,7 @@ begin
       end
     end
 
-    puts Jist.multi_gist(files, options)['html_url']
+    puts Jist.multi_gist(files, options)
   end
 rescue Jist::Error => e
   puts "Error: #{e.message}"

data/lib/jist.rb

@@ -7,7 +7,7 @@ require 'uri'
 module Jist
   extend self
 
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 
   # A list of clipboard commands with copy and paste support.
   CLIPBOARD_COMMANDS = {
@@ -21,26 +21,18 @@ module Jist
   GIT_IO_URL     = URI("http://git.io")
 
   # Exception tag for errors raised while gisting.
-  module Error; end
+  module Error;
+    def self.exception(*args)
+      RuntimeError.new(*args).extend(self)
+    end
+  end
   class ClipboardError < RuntimeError; include Error end
 
   # Upload a gist to https://gist.github.com
   #
   # @param [String] content  the code you'd like to gist
-  # @param [Hash] options  more detailed options
-  #
-  # @option options [String] :description  the description
-  # @option options [String] :filename  ('a.rb') the filename
-  # @option options [Boolean] :public  (false) is this gist public
-  # @option options [Boolean] :anonymous  (false) is this gist anonymous
-  # @option options [Boolean] :shorten  (false) Shorten the resulting URL using git.io.
-  # @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
+  # @param [Hash] options  more detailed options, see
+  #   the documentation for {multi_gist}
   #
   # @see http://developer.github.com/v3/gists/
   def gist(content, options = {})
@@ -56,13 +48,17 @@ module Jist
   # @option options [String] :description  the description
   # @option options [Boolean] :public  (false) is this gist public
   # @option options [Boolean] :anonymous  (false) is this gist anonymous
-  # @option options [Boolean] :shorten  (false) Shorten the resulting URL using git.io.
   # @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.
+  # @option options [Symbol] :output (:all) The type of return value you'd like:
+  #   :html_url gives a String containing the url to the gist in a browser
+  #   :short_url gives a String contianing a  git.io url that redirects to html_url
+  #   :javascript gives a String containing a script tag suitable for embedding the gist
+  #   :all gives a Hash containing the parsed json response from the server
   #
-  # @return [Hash]  the decoded JSON response from the server
+  # @return [String, Hash]  the return value as configured by options[:output]
   # @raise [Jist::Error]  if something went wrong
   #
   # @see http://developer.github.com/v3/gists/
@@ -207,18 +203,27 @@ module Jist
 
   # 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
+  # @param [String] body  the text body from the github api
+  # @param [Hash] options  more detailed options, see
+  #   the documentation for {multi_gist}
   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]
+    output = case options[: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 options[:copy]
     Jist.open(json['html_url']) if options[:open]
 
-    json
+    output
   end
 
   # Copy a string to the clipboard.

data/spec/clipboard_spec.rb

@@ -9,10 +9,10 @@ describe '...' do
   end
 
   def ask_for_copy
-    Jist.on_success({'html_url' => @bobo_url}.to_json, :copy => true )
+    Jist.on_success({'html_url' => @bobo_url}.to_json, :copy => true, :output => :html_url)
   end
   def jist_but_dont_ask_for_copy
-    Jist.on_success({'html_url' => 'http://example.com/'}.to_json)
+    Jist.on_success({'html_url' => 'http://example.com/'}.to_json, :output => :html_url)
   end
 
   it 'should try to copy the url when the clipboard option is passed' do
@@ -20,6 +20,12 @@ describe '...' do
     ask_for_copy
   end
 
+  it 'should try to copy the embed url when the clipboard-js option is passed' do
+    js_link = %Q{<script src="#{@bobo_url}.js"></script>}
+    Jist.should_receive(:copy).with(js_link)
+    Jist.on_success({'html_url' => @bobo_url}.to_json, :copy => true, :output => :javascript)
+  end
+
   it "should not copy when not asked to" do
     Jist.should_not_receive(:copy).with(@bobo_url)
     jist_but_dont_ask_for_copy

data/spec/shorten_spec.rb

@@ -5,7 +5,7 @@ describe '...' do
   end
 
   it "should return a shortened version of the URL" do
-    Jist.gist("Test gist", :shorten => true).should == {"html_url" => "http://git.io/XXXXXX"}
+    Jist.gist("Test gist", :output => :short_url).should == "http://git.io/XXXXXX"
   end
 end
 

metadata

@@ -1,24 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: jist
 version: !ruby/object:Gem::Version
+  version: 1.4.0
   prerelease: 
-  version: 1.3.1
 platform: ruby
 authors:
 - Conrad Irwin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-31 00:00:00.000000000 Z
+date: 2013-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  type: :runtime
+  name: json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -26,15 +27,15 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: json
 - !ruby/object:Gem::Dependency
-  type: :development
+  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
@@ -42,15 +43,15 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: rake
 - !ruby/object:Gem::Dependency
-  type: :development
+  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
@@ -58,15 +59,15 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: rspec
 - !ruby/object:Gem::Dependency
-  type: :development
+  name: webmock
   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
@@ -74,7 +75,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: webmock
 description: Provides a single function (Jist.gist) that uploads a gist.
 email: conrad.irwin@gmail.com
 executables:
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Just allows you to upload gists