gist 2.0.4 → 3.0.0

data/README.markdown

@@ -8,69 +8,80 @@ Installation
 
 [homebrew](http://mxcl.github.com/homebrew/):
 
-    brew install gist
-    gist -h
+```bash
+$ brew install gist
+$ gist -h
+```
 
 RubyGems:
 
-    gem install gist
-    gist -h
+```bash
+$ gem install gist
+$ gist -h
+```
 
 Old school:
 
-    curl -s https://github.com/defunkt/gist/raw/master/gist > gist &&
-    chmod 755 gist &&
-    mv gist /usr/local/bin/gist
+```bash
+$ curl -s https://raw.github.com/defunkt/gist/master/gist > gist &&
+$ chmod 755 gist &&
+$ mv gist /usr/local/bin/gist
+```
 
 Ubuntu:
 
-    sudo apt-get install ruby
-    sudo apt-get install rubygems
-    sudo apt-get install libopenssl-ruby
-    sudo gem install gist
-    sudo cp /var/lib/gems/1.8/bin/gist /usr/local/bin/
-    gist -h
-
-
+```bash
+$ sudo apt-get install ruby
+$ sudo apt-get install rubygems
+$ sudo apt-get install libopenssl-ruby
+$ sudo gem install gist
+$ sudo cp /var/lib/gems/1.8/bin/gist /usr/local/bin/
+$ gist -h
+```
 
 Use
 ---
 
-    $ gist < file.txt
-    $ echo secret | gist --private # or -p
-    $ echo "puts :hi" | gist -t rb
-    $ gist script.py
-    $ gist script.js notes.txt
-    $ gist -
-    the quick brown fox jumps over the lazy dog
-    ^D
-
+```bash
+$ gist < file.txt
+$ echo secret | gist --private # or -p
+$ echo "puts :hi" | gist -t rb
+$ gist script.py
+$ gist script.js notes.txt
+$ pbpaste | gist -p # Copy from clipboard - OSX Only
+$ gist -
+the quick brown fox jumps over the lazy dog
+^D
+```
 
 Authentication
 --------------
-There are two ways to set GitHub user and token info:
+There are two ways to set GitHub user and password info:
 
-Using env vars GITHUB_USER and GITHUB_TOKEN:
+Using env vars GITHUB_USER and GITHUB_PASSWORD:
 
-    $ export GITHUB_USER="your-github-username"
-    $ export GITHUB_TOKEN="your-github-token"
-    $ gist ~/example
+```bash
+$ export GITHUB_USER="your-github-username"
+$ export GITHUB_PASSWORD="your-github-password"
+$ gist ~/example
+```
 
-Or by having your git config set up with your GitHub username and token.
+Or by having your git config set up with your GitHub username and password.
 
-    git config --global github.user "your-github-username"
-    git config --global github.token "your-github-token"
+```bash
+git config --global github.user "your-github-username"
+git config --global github.password "your-github-password"
+```
 
-You can find your token under [your account](https://github.com/account).
-
-You can also define github.token to be a command which returns the
-actual token on stdout by setting the variable to a command string
+You can also define github.password to be a command which returns the
+actual password on stdout by setting the variable to a command string
 prefixed with `!`. For example, the following command fetches the
-token from a password item named "github.token" on the Mac OS
+password from an item named "github.password" on the Mac OS
 Keychain:
 
-    token = !security 2>&1 >/dev/null find-generic-password -gs github.token | ruby -e 'print $1 if STDIN.gets =~ /^password: \\\"(.*)\\\"$/'
-
+```bash
+password = !security 2>&1 >/dev/null find-generic-password -gs github.password | ruby -e 'print $1 if STDIN.gets =~ /^password: \\\"(.*)\\\"$/'
+```
 
 Defaults
 --------
@@ -91,15 +102,18 @@ Proxies
 
 Set the HTTP_PROXY env variable to use a proxy.
 
-    $ HTTP_PROXY=host:port gist file.rb
-
+```bash
+$ HTTP_PROXY=host:port gist file.rb
+```
 
 Manual
 ------
 
 Visit <http://defunkt.github.com/gist/> or use:
 
-    $ gist -m
+```bash
+$ gist -m
+```
 
 Bugs
 ----

data/Rakefile

@@ -1,4 +1,9 @@
-require 'bundler/gem_tasks'
+begin
+  require "mg"
+  MG.new("gist.gemspec")
+rescue LoadError
+  nil
+end
 
 desc "Build standalone script and manpages"
 task :build => [ :standalone, :build_man ]
@@ -23,3 +28,24 @@ task :load_gist do
   $LOAD_PATH.unshift 'lib'
   require 'gist'
 end
+
+Rake::TaskManager.class_eval do
+  def remove_task(task_name)
+    @tasks.delete(task_name.to_s)
+  end
+end
+
+# Remove mg's install task
+Rake.application.remove_task(:install)
+
+desc "Install standalone script and man pages"
+task :install => :standalone do
+  prefix = ENV['PREFIX'] || ENV['prefix'] || '/usr/local'
+
+  FileUtils.mkdir_p "#{prefix}/bin"
+  FileUtils.cp "gist", "#{prefix}/bin"
+
+  FileUtils.mkdir_p "#{prefix}/share/man/man1"
+  FileUtils.cp "man/gist.1", "#{prefix}/share/man/man1"
+end
+

data/lib/gist.rb

@@ -2,6 +2,10 @@ require 'open-uri'
 require 'net/https'
 require 'optparse'
 
+require 'rubygems'
+require 'json'
+require 'base64'
+
 require 'gist/manpage' unless defined?(Gist::Manpage)
 require 'gist/version' unless defined?(Gist::Version)
 
@@ -23,8 +27,8 @@ require 'gist/version' unless defined?(Gist::Version)
 module Gist
   extend self
 
-  GIST_URL   = 'https://gist.github.com/%s.txt'
-  CREATE_URL = 'https://gist.github.com/gists'
+  GIST_URL   = 'https://api.github.com/gists/%s'
+  CREATE_URL = 'https://api.github.com/gists'
 
   if ENV['HTTPS_PROXY']
     PROXY = URI(ENV['HTTPS_PROXY'])
@@ -42,6 +46,7 @@ module Gist
     gist_filename = nil
     gist_extension = defaults["extension"]
     browse_enabled = defaults["browse"]
+    description = nil
 
     opts = OptionParser.new do |opts|
       opts.banner = "Usage: gist [options] [filename or stdin] [filename] ...\n" +
@@ -56,6 +61,10 @@ module Gist
         gist_extension = '.' + extension
       end
 
+      opts.on('-d','--description DESCRIPTION', 'Set description of the new gist') do |d|
+        description = d
+      end
+
       opts.on('-o','--[no-]open', 'Open gist in browser') do |o|
         browse_enabled = o
       end
@@ -75,9 +84,10 @@ module Gist
       end
     end
 
-    opts.parse!(args)
-
     begin
+
+      opts.parse!(args)
+
       if $stdin.tty? && args[0] != '-'
         # Run without stdin.
 
@@ -93,7 +103,7 @@ module Gist
 
           files.push({
             :input     => File.read(file),
-            :filename  => File.basename(file),
+            :filename  => file,
             :extension => (File.extname(file) if file.include?('.'))
           })
         end
@@ -104,7 +114,7 @@ module Gist
         files = [{:input => input, :extension => gist_extension}]
       end
 
-      url = write(files, private_gist)
+      url = write(files, private_gist, description)
       browse(url) if browse_enabled
       puts copy(url)
     rescue => e
@@ -114,7 +124,7 @@ module Gist
   end
 
   # Create a gist on gist.github.com
-  def write(files, private_gist = false)
+  def write(files, private_gist = false, description = nil)
     url = URI.parse(CREATE_URL)
 
     if PROXY_HOST
@@ -129,12 +139,16 @@ module Gist
     http.ca_file = ca_cert
 
     req = Net::HTTP::Post.new(url.path)
-    req.form_data = data(files, private_gist)
+    req.body = JSON.generate(data(files, private_gist, description))
+
+    if auth_header = auth()
+      req.add_field('Authorization', auth_header)
+    end
 
     response = http.start{|h| h.request(req) }
     case response
-    when Net::HTTPRedirection
-      response['Location']
+    when Net::HTTPCreated
+      JSON.parse(response.body)['html_url']
     else
       puts "Creating gist failed: #{response.code} #{response.message}"
       exit(false)
@@ -143,7 +157,8 @@ module Gist
 
   # Given a gist id, returns its content.
   def read(gist_id)
-    open(GIST_URL % gist_id).read
+    data = JSON.parse(open(GIST_URL % gist_id).read)
+    data["files"].map{|name, content| content['content'] }.join("\n\n")
   end
 
   # Given a url, tries to open it in your browser.
@@ -151,6 +166,8 @@ module Gist
   def browse(url)
     if RUBY_PLATFORM =~ /darwin/
       `open #{url}`
+    elsif RUBY_PLATFORM =~ /linux/
+       `#{ENV['BROWSER']} #{url}`
     elsif ENV['OS'] == 'Windows_NT' or
       RUBY_PLATFORM =~ /djgpp|(cyg|ms|bcc)win|mingw|wince/i
       `start "" "#{url}"`
@@ -178,27 +195,32 @@ module Gist
 private
   # Give an array of file information and private boolean, returns
   # an appropriate payload for POSTing to gist.github.com
-  def data(files, private_gist)
-    data = {}
+  def data(files, private_gist, description)
+    i = 0
+    file_data = {}
     files.each do |file|
-      i = data.size + 1
-      data["file_ext[gistfile#{i}]"]      = file[:extension] ? file[:extension] : '.txt'
-      data["file_name[gistfile#{i}]"]     = file[:filename]
-      data["file_contents[gistfile#{i}]"] = file[:input]
+      i = i + 1
+      filename = file[:filename] ? file[:filename] : "gistfile#{i}"
+      file_data[filename] = {:content => file[:input]}
     end
-    data.merge(private_gist ? { 'action_button' => 'private' } : {}).merge(auth)
+
+    data = {"files" => file_data}
+    data.merge!({ 'description' => description }) unless description.nil?
+    data.merge!({ 'public' => false }) if private_gist
+    data
   end
 
-  # Returns a hash of the user's GitHub credentials if set.
+  # Returns a basic auth string of the user's GitHub credentials if set.
   # http://github.com/guides/local-github-config
   def auth
     user  = config("github.user")
-    token = config("github.token")
+    password = config("github.password")
 
-    if user.to_s.empty? || token.to_s.empty?
-      {}
+    if user.to_s.empty? || password.to_s.empty?
+      nil
     else
-      { :login => user, :token => token }
+      auth_str = Base64.encode64("#{user}:#{password}")
+      "Basic #{auth_str}"
     end
   end
 
@@ -211,24 +233,23 @@ private
   # gist.extension - string
   def defaults
     extension = config("gist.extension")
-    extension = nil if extension && extension.empty?
 
     return {
       "private"   => config("gist.private"),
       "browse"    => config("gist.browse"),
-      "extension" => extension,
+      "extension" => extension
     }
   end
 
   # Reads a config value using:
-  # => Environement: GITHUB_TOKEN, GITHUB_USER
-  #                  like vim gist plugin
+  # => Environment: GITHUB_PASSWORD, GITHUB_USER
+  #                 like vim gist plugin
   # => git-config(1)
   #
   # return something useful or nil
   def config(key)
     env_key = ENV[key.upcase.gsub(/\./, '_')]
-    return env_key if env_key and not env_key.empty?
+    return env_key if env_key and not env_key.strip.empty?
 
     str_to_bool `git config --global #{key}`.strip
   end

data/lib/gist/version.rb

@@ -1,3 +1,3 @@
 module Gist
-  VERSION = Version = '2.0.4'
+  VERSION = Version = '3.0.0'
 end

data/man/gist.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "GIST" "1" "April 2011" "GITHUB" "Gist Manual"
+.TH "GIST" "1" "March 2012" "GITHUB" "Gist Manual"
 .
 .SH "NAME"
 \fBgist\fR \- gist on the command line
@@ -19,7 +19,7 @@ If standard input is supplied, it will be used as the content of the new gist\.
 Once your gist is successfully created, the URL will be copied to your clipboard\. If you are on OS X, \fBgist\fR will open the gist in your browser, too\.
 .
 .SH "OPTIONS"
-\fBgist\fR\'s default mode of operation is to read content from standard input and create a public, text gist from it, tied to your GitHub account if you user and token are provided (see \fBCONFIGURATION\fR)\.
+\fBgist\fR\'s default mode of operation is to read content from standard input and create a public, text gist without description from it, tied to your GitHub account if you user and passwordare provided (see \fBCONFIGURATION\fR)\.
 .
 .P
 These options can be used to change this behavior:
@@ -30,7 +30,11 @@ Create a private gist instead of a public gist\.
 .
 .TP
 \fB\-t\fR, \fB\-\-type\fR
-Set the file extension explicitly\. Passing a type of \fBrb\fR ensure the gist is created as a Ruby file\.
+Set the file extension explicitly\. Passing a type of \fBrb\fR ensures the gist is created as a Ruby file\.
+.
+.TP
+\fB\-d\fR, \fB\-\-description\fR
+Set a description\.
 .
 .TP
 \fB\-o\fR, \fB\-\-[no\-]open\fR
@@ -48,16 +52,16 @@ Print help\.
 Display this man page\.
 .
 .SH "AUTHENTICATION"
-There are two ways to set GitHub user and token info:
+There are two ways to set GitHub user and password info:
 .
 .IP "\(bu" 4
-Using env vars GITHUB_USER and GITHUB_TOKEN
+Using environment vars GITHUB_USER and GITHUB_PASSWORD
 .
 .IP
 $ export GITHUB_USER=johndoe
 .
 .br
-$ export GITHUB_TOKEN=mysecretgithubtoken
+$ export GITHUB_PASSWORD=mysecretgithubpassword
 .
 .br
 $ gist ~/example

data/man/gist.1.html

@@ -64,7 +64,7 @@
     <a href="#BUGS">BUGS</a>
     <a href="#AUTHOR">AUTHOR</a>
     <a href="#SEE-ALSO">SEE ALSO</a>
-    </div>
+  </div>
 
   <ol class='man-decor man-head man head'>
     <li class='tl'>gist(1)</li>
@@ -98,15 +98,17 @@ browser, too.</p>
 <h2 id="OPTIONS">OPTIONS</h2>
 
 <p><code>gist</code>'s default mode of operation is to read content from standard
-input and create a public, text gist from it, tied to your GitHub
-account if you user and token are provided (see <code>CONFIGURATION</code>).</p>
+input and create a public, text gist without description from it, tied
+to your GitHub account if you user and passwordare provided (see
+<code>CONFIGURATION</code>).</p>
 
 <p>These options can be used to change this behavior:</p>
 
 <dl>
 <dt><code>-p</code>, <code>--private</code></dt><dd><p>Create a private gist instead of a public gist.</p></dd>
-<dt><code>-t</code>, <code>--type</code></dt><dd><p>Set the file extension explicitly. Passing a type of <code>rb</code> ensure
+<dt><code>-t</code>, <code>--type</code></dt><dd><p>Set the file extension explicitly. Passing a type of <code>rb</code> ensures
 the gist is created as a Ruby file.</p></dd>
+<dt><code>-d</code>, <code>--description</code></dt><dd><p>Set a description.</p></dd>
 <dt><code>-o</code>, <code>--[no-]open</code></dt><dd><p>Open the gist in your browser after creation. Or don't. Defaults
 to --open</p></dd>
 </dl>
@@ -122,13 +124,13 @@ to --open</p></dd>
 
 <h2 id="AUTHENTICATION">AUTHENTICATION</h2>
 
-<p>There are two ways to set GitHub user and token info:</p>
+<p>There are two ways to set GitHub user and password info:</p>
 
 <ul>
-<li><p>Using env vars GITHUB_USER and GITHUB_TOKEN</p>
+<li><p>Using environment vars GITHUB_USER and GITHUB_PASSWORD</p>
 
 <p>$ export GITHUB_USER=johndoe<br />
-$ export GITHUB_TOKEN=mysecretgithubtoken<br />
+$ export GITHUB_PASSWORD=mysecretgithubpassword<br />
 $ gist ~/example</p></li>
 <li><p>Using <span class="man-ref">git-config<span class="s">(1)</span></span></p></li>
 </ul>
@@ -198,7 +200,7 @@ the quick brown fox jumps over the lazy dog
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'>GITHUB</li>
-    <li class='tc'>April 2011</li>
+    <li class='tc'>March 2012</li>
     <li class='tr'>gist(1)</li>
   </ol>
 

data/man/gist.1.ron

@@ -22,8 +22,9 @@ browser, too.
 ## OPTIONS
 
 `gist`'s default mode of operation is to read content from standard
-input and create a public, text gist from it, tied to your GitHub
-account if you user and token are provided (see `CONFIGURATION`).
+input and create a public, text gist without description from it, tied
+to your GitHub account if you user and passwordare provided (see
+`CONFIGURATION`).
 
 These options can be used to change this behavior:
 
@@ -31,9 +32,12 @@ These options can be used to change this behavior:
     Create a private gist instead of a public gist.
 
   * `-t`, `--type`:
-    Set the file extension explicitly. Passing a type of `rb` ensure
+    Set the file extension explicitly. Passing a type of `rb` ensures
     the gist is created as a Ruby file.
 
+  * `-d`, `--description`:
+    Set a description.
+
   * `-o`, `--[no-]open`:
     Open the gist in your browser after creation. Or don't. Defaults
     to --open
@@ -48,12 +52,12 @@ You may additionally ask for help:
 
 ## AUTHENTICATION
 
-There are two ways to set GitHub user and token info:
+There are two ways to set GitHub user and password info:
 
-  * Using env vars GITHUB_USER and GITHUB_TOKEN
+  * Using environment vars GITHUB_USER and GITHUB_PASSWORD
 
     $ export GITHUB_USER=johndoe  
-    $ export GITHUB_TOKEN=mysecretgithubtoken  
+    $ export GITHUB_PASSWORD=mysecretgithubpassword  
     $ gist ~/example  
 
   * Using git-config(1)

metadata

@@ -2,12 +2,12 @@
 name: gist
 version: !ruby/object:Gem::Version 
   hash: 7
-  prerelease: false
+  prerelease: 
   segments: 
-  - 2
+  - 3
   - 0
-  - 4
-  version: 2.0.4
+  - 0
+  version: 3.0.0
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -16,25 +16,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-27 00:00:00 -07:00
+date: 2012-03-20 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 0
-        - 14
-        version: 1.0.14
-  type: :development
-  version_requirements: *id001
+dependencies: []
+
 description: "  Creates Gists (pastes) on gist.github.com from standard input or\n  arbitrary files. Can link to your GitHub account, create private gists,\n  and enable syntax highlighting.\n"
 email: andre@arko.net
 executables: 
@@ -56,7 +41,7 @@ files:
 - man/gist.1
 - man/gist.1.html
 - man/gist.1.ron
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/defunkt/gist
 licenses: []
 
@@ -86,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Creates Gists from STDIN or files.