jist 0.9.2 → 1.1.0

data/.gitignore

@@ -0,0 +1,8 @@
+.rvmrc
+Gemfile.lock
+
+# OS X
+.DS_Store
+.yardoc
+doc
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+-r ./spec/spec_helper.rb

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.MIT

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Conrad Irwin <conrad.irwin@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,164 @@
+Jist is a gem that allows you to publish a [gist](https://gist.github.com) from Ruby.
+
+# Installation
+
+As with all ruby gems, you can install Jist (assuming you have ruby and rubygems) with:
+
+```shell
+$ gem install jist
+```
+
+If you want to use the library in your application, and you're using Bundler. Add the
+following to your Gemfile.
+
+```ruby
+source :rubygems
+gem 'jist'
+```
+
+# Command
+
+The jist gem provides a `jist` command that you can use from your terminal to
+upload content to https://gist.github.com/.
+
+It's easy to use. To upload the contents of `a.rb` just:
+
+```shell
+$ jist a.rb
+https://gist.github.com/0d07bc98c139810a4075
+```
+
+By default it reads from STDIN, and you can set a filename with `-f`.
+
+```shell
+$ jist -f test.rb <a.rb
+https://gist.github.com/7db51bb5f4f35c480fc8
+```
+
+Alternatively, you can just paste from the clipboard:
+
+```shell
+$ jist -P
+https://gist.github.com/6a330a11a0db8e52a6ee
+```
+
+Use `-p` to make the gist public and `-d` to add a description.
+```shell
+$ jist -p -d "Random rbx bug" a.rb
+https://gist.github.com/2977722
+```
+
+You can update existing gists with `-u`:
+
+```shell
+$ jist lib/jist.rb bin/jist -u 42f2c239d2eb57299408
+https://gist.github.com/42f2c239d2eb57299408
+```
+
+If you'd like to copy the resulting URL to your clipboard, use `-c`.
+
+```shell
+$ jist -c <a.rb
+https://gist.github.com/7db51bb5f4f35c480fc8
+```
+
+And you can just ask jist to open a browser window directly with `-o`.
+
+```shell
+$ jist -o <a.rb
+https://gist.github.com/7db51bb5f4f35c480fc8
+```
+
+See `jist --help` for more detail.
+
+## Login
+
+If you want to associate your gists with your github account, you need to login
+with jist. It doesn't store your username and password, it just uses them to get
+an OAuth2 token (with the "gist" permission).
+
+```shell
+jist --login
+Obtaining OAuth2 access_token from github.
+Github username: ConradIrwin
+Github password:
+Success! https://github.com/settings/applications
+```
+
+This token is stored in `~/.jist` and used for all future gisting. If you need to
+you can revoke it from https://github.com/settings/applications, or just delete the
+file.
+
+After you've done this, you can still upload gists anonymously with `-a`.
+
+```shell
+jist -a a.rb
+https://gist.github.com/6bf7ec379fc9119b1f15
+```
+
+# Library
+
+You can also use Jist as a library from inside your ruby code:
+
+```ruby
+Jist.gist("Look.at(:my => 'awesome').code")
+```
+
+If you need more advanced features you can also pass:
+
+* `:access_token` to authenticate using OAuth2 (default is `File.read("~/.jist")).
+* `:filename` to change the syntax highlighting (default is `a.rb`).
+* `:public` if you want your gist to have a guessable url.
+* `:description` to add a description to your gist.
+* `:update` to update an existing gist (can be a URL or an id).
+* `:anonymous` to submit an anonymous gist (default is false).
+* `:copy` to copy the resulting URL to the clipboard (default is false).
+* `:open` to open the resulting URL in a browser (default is false).
+
+NOTE: The access_token must have the "gist" scope.
+
+If you want to upload multiple files in the same gist, you can:
+
+```ruby
+Jist.multi_gist("a.rb" => "Foo.bar", "a.py" => "Foo.bar")
+```
+
+If you'd rather use jist's builtin access_token, then you can force the user to
+obtain one by calling:
+
+```ruby
+Jist.login!
+```
+
+This will take them through the process of obtaining an OAuth2 token, and storing it
+in `~/.jist`, where it can later be read by `Jist.gist`
+
+Configuration
+=============
+
+If you'd like `-o` or `-c` to be the default when you use the jist executable, add an
+alias to your `~/.bashrc` (or equivalent). For example:
+
+```ruby
+alias jist='jist -c'
+```
+
+If you'd prefer jist to open a different browser, then you can export the BROWSER
+environment variable:
+
+```ruby
+export BROWSER=google-chrome
+```
+
+If clipboard or browser integration don't work on your platform, please file a bug or
+(more ideally) a pull request.
+
+If you need to use an HTTP proxy to access the internet, export the `HTTP_PROXY` or
+`http_proxy` environment variable and jist will use it.
+
+Meta-fu
+=======
+
+I wrote this because the `gist` gem is out of action, and has been for many months.
+
+It's licensed under the MIT license, and bug-reports, and pull requests are welcome.

data/Rakefile

@@ -0,0 +1,6 @@
+task :default => :test
+
+desc 'run the tests' # that's non-DRY
+task :test do
+  sh 'rspec spec'
+end

data/bin/jist

@@ -13,9 +13,6 @@ 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]*
-       #{executable_name} --login
-
 The content to be uploaded can be passed as a list of files, if none are
 specified STDIN will be read. The default filename for STDIN is "a.rb", and all
 filenames can be overridden by repeating the "-f" flag. The most useful reason
@@ -32,10 +29,17 @@ 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.
 
+Usage: #{executable_name} [-o|-c] [-p] [-d DESC] [-t TOKEN|-a] [-u URL] [-P] [-f NAME]* FILE*
+       #{executable_name} --login
+
   EOS
 
   opts.on("--login", "Authenticate jist on this computer.") do
@@ -68,6 +72,18 @@ 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("-P", "--paste", "Paste from the clipboard to jist") do
+    options[:paste] = true
+  end
+
   opts.on_tail("-h","--help", "Show this message.") do
     puts opts
     exit
@@ -82,7 +98,9 @@ end
 opts.parse!
 
 begin
-  if ARGV.size == 0
+  if options[:paste]
+    puts Jist.gist(Jist.paste, options)['html_url']
+  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']
   else

data/jist.gemspec

@@ -0,0 +1,20 @@
+require './lib/jist'
+Gem::Specification.new do |s|
+  s.name          = 'jist'
+  s.version       = Jist::VERSION
+  s.summary       = 'Just allows you to upload gists'
+  s.description   = 'Provides a single function (Jist.gist) that uploads a gist.'
+  s.homepage      = 'https://github.com/ConradIrwin/jist'
+  s.email         = 'conrad.irwin@gmail.com'
+  s.authors       = ['Conrad Irwin']
+  s.license       = 'MIT'
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.executables << 'jist'
+
+  s.add_dependency 'json'
+  %w(rake rspec).each do |gem|
+    s.add_development_dependency gem
+  end
+end

data/lib/jist.rb

@@ -4,13 +4,21 @@ require 'json'
 
 # It just gists.
 module Jist
+  extend self
 
-  VERSION = '0.9.2'
+  VERSION = '1.1.0'
+
+  # 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
@@ -136,20 +148,105 @@ module Jist
     raise e.extend Error
   end
 
-  # Run an HTTP operation against api.github.com
+  # Return HTTP connection
   #
-  # @param [Net::HTTPRequest] request
-  # @return [Net::HTTPResponse]
-  def http(request)
-    connection = Net::HTTP.new("api.github.com", 443)
+  # @return [Net::HTTP]
+  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.start do |http|
+    connection
+  end
+
+  # Run an HTTP operation against api.github.com
+  #
+  # @param [Net::HTTPRequest] request
+  # @return [Net::HTTPResponse]
+  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
+
+  # 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

data/spec/clipboard_spec.rb

@@ -0,0 +1,34 @@
+describe '...' do
+  before do
+    @saved_path = ENV['PATH']
+    @bobo_url = 'http://example.com'
+  end
+
+  after do
+    ENV['PATH'] = @saved_path
+  end
+
+  def ask_for_copy
+    Jist.on_success({'html_url' => @bobo_url}.to_json, :copy => true )
+  end
+  def jist_but_dont_ask_for_copy
+    Jist.on_success({'html_url' => 'http://example.com/'}.to_json)
+  end
+
+  it 'should try to copy the url when the clipboard option is passed' do
+    Jist.should_receive(:copy).with(@bobo_url)
+    ask_for_copy
+  end
+
+  it "should not copy when not asked to" do
+    Jist.should_not_receive(:copy).with(@bobo_url)
+    jist_but_dont_ask_for_copy
+  end
+
+  it "should raise an error if no copying mechanisms are available" do
+    ENV['PATH'] = ''
+    lambda{
+      ask_for_copy
+    }.should raise_error(/Could not find copy command/)
+  end
+end

data/spec/proxy_spec.rb

@@ -0,0 +1,19 @@
+describe '...' do
+  before do
+    @saved_env = ENV['HTTP_PROXY']
+  end
+
+  after do
+    ENV['HTTP_PROXY'] = @saved_env
+  end
+
+  it "should be Net::HTTP when $HTTP_PROXY wasn't set" do
+    ENV['HTTP_PROXY'] = ''
+    Jist.http_connection().should be_an_instance_of(Net::HTTP)
+  end
+
+  it "should be Net::HTTP::Proxy when $HTTP_PROXY was set" do
+    ENV['HTTP_PROXY'] = 'http://proxy.example.com:8080'
+    Jist.http_connection().should_not be_an_instance_of(Net::HTTP)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+require_relative '../lib/jist'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jist
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
+date: 2012-10-18 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:
@@ -34,10 +66,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/jist.rb
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.MIT
+- README.md
+- Rakefile
 - bin/jist
+- jist.gemspec
+- lib/jist.rb
+- spec/clipboard_spec.rb
+- spec/proxy_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/ConradIrwin/jist
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths: