gist 3.0.2 → 4.0.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,149 @@
+gist(1) -- upload code to https://gist.github.com
+=================================================
+
+## Synopsis
+
+The gist gem provides a `gist` command that you can use from your terminal to
+upload content to https://gist.github.com/.
+
+## Installation
+
+‌If you have ruby installed:
+
+    gem install gist
+
+‌If you're using Bundler:
+
+    source :rubygems
+    gem 'gist'
+
+## Command
+
+‌To upload the contents of `a.rb` just:
+
+    gist a.rb
+
+‌Upload multiple files:
+
+    gist a b c
+    gist *.rb
+
+‌By default it reads from STDIN, and you can set a filename with `-f`.
+
+    gist -f test.rb <a.rb
+
+‌Alternatively, you can just paste from the clipboard:
+
+    gist -P
+
+‌Use `-p` to make the gist private:
+
+    gist -p a.rb
+
+‌Use `-d` to add a description:
+
+    gist -d "Random rbx bug" a.rb
+
+‌You can update existing gists with `-u`:
+
+    gist lib/gist.rb bin/gist -u 42f2c239d2eb57299408
+
+‌If you'd like to copy the resulting URL to your clipboard, use `-c`.
+
+    gist -c <a.rb
+
+‌If you'd like to copy the resulting embeddable URL to your clipboard, use `--copy-js`.
+
+    gist --copy-js <a.rb
+
+‌And you can just ask gist to open a browser window directly with `-o`.
+
+    gist -o <a.rb
+
+‌See `gist --help` for more detail.
+
+## Login
+
+If you want to associate your gists with your GitHub account, you need to login
+with gist. It doesn't store your username and password, it just uses them to get
+an OAuth2 token (with the "gist" permission).
+
+    gist --login
+    Obtaining OAuth2 access_token from github.
+    GitHub username: ConradIrwin
+    GitHub password:
+    Success! https://github.com/settings/applications
+
+This token is stored in `~/.gist` 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`.
+
+    gist -a a.rb
+
+# Library
+
+‌You can also use Gist as a library from inside your ruby code:
+
+    Gist.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("~/.gist")).
+* `: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:
+
+    Gist.multi_gist("a.rb" => "Foo.bar", "a.py" => "Foo.bar")
+
+‌If you'd rather use gist's builtin access_token, then you can force the user
+  to obtain one by calling:
+
+    Gist.login!
+
+‌This will take them through the process of obtaining an OAuth2 token, and storing it
+in `~/.gist`, where it can later be read by `Gist.gist`
+
+## GitHub enterprise
+
+‌If you'd like `gist` to use your locally installed [GitHub Enterprise](https://enterprise.github.com/),
+you need to export the `GITHUB_URL` environment variable in your `~/.bashrc`.
+
+    export GITHUB_URL=http://github.internal.example.com/
+
+‌Once you've done this and restarted your terminal (or run `source ~/.bashrc`), gist will
+automatically use github enterprise instead of the public github.com
+
+## Configuration
+
+‌If you'd like `-o` or `-c` to be the default when you use the gist executable, add an
+alias to your `~/.bashrc` (or equivalent). For example:
+
+    alias gist='gist -c'
+
+‌If you'd prefer gist to open a different browser, then you can export the BROWSER
+environment variable:
+
+    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 gist will use it.
+
+## Meta-fu
+
+Thanks to @defunkt and @indirect for writing and maintaining versions 1 through 3.
+Thanks to @rking and @ConradIrwin for maintaining version 4.
+
+Licensed under the MIT license. Bug-reports, and pull requests are welcome.

data/Rakefile

@@ -1,51 +1,19 @@
-begin
-  require "mg"
-  MG.new("gist.gemspec")
-rescue LoadError
-  nil
-end
-
-desc "Build standalone script and manpages"
-task :build => [ :standalone, :build_man ]
-
-desc "Build standalone script"
-task :standalone => :load_gist do
-  require 'gist/standalone'
-  Gist::Standalone.save('gist')
-end
-
-desc "Build gist manual"
-task :build_man do
-  sh "ronn -br5 --organization=GITHUB --manual='Gist Manual' man/*.ron"
-end
+# encoding: utf-8
+#
+task :default => :test
 
-desc "Show gist manual"
-task :man => :build_man do
-  exec "man man/gist.1"
+desc 'run the tests' # that's non-DRY
+task :test do
+  sh 'rspec spec'
 end
 
-task :load_gist do
-  $LOAD_PATH.unshift 'lib'
-  require 'gist'
+task :clipfailtest do
+  sh 'PATH=/ /usr/bin/ruby -Ilib -S bin/gist -ac < lib/gist.rb'
 end
 
-Rake::TaskManager.class_eval do
-  def remove_task(task_name)
-    @tasks.delete(task_name.to_s)
-  end
+task :man do
+  File.write "README.md.ron", File.read("README.md").gsub(?‌, "* ")
+  sh 'ronn --roff --manual="Gist manual" README.md.ron'
+  rm 'README.md.ron'
+  sh 'man ./README.1'
 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/bin/gist

@@ -1,20 +1,157 @@
 #!/usr/bin/env ruby
-#
-# = gist(1)
-#
-# == USAGE
-#  gist < file.txt
-#  echo secret | gist -p  # or --private
-#  echo "puts :hi" | gist -t rb
-#  gist script.py
-#
-# == INSTALL
-# RubyGem:
-#     gem install gist
-# Old school:
-#     curl -s http://github.com/defunkt/gist/raw/master/gist > gist &&
-#     chmod 755 gist &&
-#     mv gist /usr/local/bin/gist
-
-require 'gist'
-Gist.execute(*ARGV)
+
+require 'optparse'
+require File.expand_path('../../lib/gist', __FILE__)
+
+# For the holdings of options.
+options = {}
+filenames = []
+
+opts = OptionParser.new do |opts|
+  executable_name = File.split($0)[1]
+  opts.banner = <<-EOS
+Gist (v#{Gist::VERSION}) lets you upload to https://gist.github.com/
+
+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
+to do this is to change the syntax highlighting.
+
+If you'd like your gists to be associated with your GitHub account, so that you
+can edit them and find them in future, first use `gist --login` to obtain an
+Oauth2 access token. This is stored and used by gist in the future.
+
+Private gists do not have guessable URLs and can be created with "-p", you can
+also set the description at the top of the gist by passing "-d".
+
+Anonymous gists are not associated with your GitHub account, they can be created
+with "-a" even after you have used "gist --login".
+
+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. Using the -e option will copy the
+embeddable URL to the clipboard. You can add `alias gist='gist -c'` to your
+shell's rc file to configure this behaviour by default.
+
+Instead of creating a new gist, 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|-e] [-p] [-s] [-d DESC] -a] [-u URL] [-P] [-f NAME|-t EXT]* FILE*
+       #{executable_name} --login
+
+  EOS
+
+  opts.on("--login", "Authenticate gist on this computer.") do
+    Gist.login!
+    exit
+  end
+
+  opts.on("-f", "--filename [NAME.EXTENSION]", "Sets the filename and syntax type.") do |filename|
+    filenames << filename
+    options[:filename] = filename
+  end
+
+  opts.on("-t", "--type [EXTENSION]", "Sets the file extension and syntax type.") do |extension|
+    filenames << "foo.#{extension}"
+    options[:filename] = "foo.#{extension}"
+  end
+
+  opts.on("-p", "--private", "Makes your gist private.") do
+    options[:private] = true
+  end
+
+  opts.on("--no-private") do
+    options[:private] = false
+  end
+
+  opts.on("-d", "--description DESCRIPTION", "Adds a description to your gist.") do |description|
+    options[:description] = description
+  end
+
+  opts.on("-s", "--shorten", "Shorten the gist URL using git.io.") do |shorten|
+    options[:shorten] = shorten
+  end
+
+  opts.on("-u", "--update [ URL | ID ]", "Update an existing gist.") do |update|
+    options[:update] = update
+  end
+
+  opts.on("-a", "--anonymous", "Create an anonymous gist.") do
+    options[:anonymous] = true
+  end
+
+  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
+  end
+
+  opts.on("--no-open")
+
+  opts.on("-P", "--paste", "Paste from the clipboard to gist") do
+    options[:paste] = true
+  end
+
+  opts.on_tail("-h","--help", "Show this message.") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-v", "--version", "Print the version.") do
+    puts "gist v#{Gist::VERSION}"
+    exit
+  end
+
+end
+opts.parse!
+
+begin
+  options[:output] = if options[:embed] && options[:shorten]
+                       raise Gist::Error, "--embed does not make sense with --shorten"
+                     elsif options[:embed]
+                       :javascript
+                     elsif options[:shorten]
+                       :short_url
+                     else
+                       :html_url
+                     end
+
+  options[:public] = Gist.should_be_public?(options)
+
+  if options[:paste]
+    puts Gist.gist(Gist.paste, options)
+  else
+    to_read = ARGV.empty? ? ['-'] : ARGV
+    files = {}
+    to_read.zip(filenames).each do |(file, name)|
+      files[name || file] =
+        begin
+          if file == '-'
+            $stderr.puts "(type a gist. <ctrl-c> to cancel, <ctrl-d> when done)" if $stdin.tty?
+            STDIN.read
+          else
+            File.read(File.expand_path(file))
+          end
+        rescue => e
+          raise e.extend(Gist::Error)
+        end
+    end
+
+    puts Gist.multi_gist(files, options)
+  end
+rescue Gist::Error => e
+  puts "Error: #{e.message}"
+  exit 1
+rescue Interrupt
+  # bye!
+end

data/gist.gemspec

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