jist 0.2 → 0.3

data/bin/jist

@@ -11,44 +11,71 @@ options = {}
 opts = OptionParser.new do |opts|
   executable_name = File.split($0)[1]
   opts.banner = <<-EOS
-Jist is a simple command that let's you create new gists from the terminal.
+Jist (v#{Jist::VERSION}) let's you upload to https://gist.github.com/
+
+Usage: #{executable_name} [-p] [-d DESC] [-t TOKEN] [-f FILENAME] [FILE]
+       #{executable_name} --login
+
+When used with no arguments, jist creates an Anonymous, private, gist, with
+no description. The FILENAME defaults to "a.rb" and we read the contents of
+STDIN.
+
+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 `jist --login` to obtain
+an Oauth2 access token. This is stored and used for all future uses of jist.
+
+If you're calling jist from another program that already has an access_token
+with the "gist" scope, then pass it using `jist -t`.
+
+If you specify a FILE on the command line, then jist will use that as the
+default value for FILENAME too. If not, jist will assume that the file you
+provide on STDIN is called "a.rb". The FILENAME is mostly important for
+determining which language to use for syntax highlighting.
+
+Making a gist public causes it to have a prettier, guessable url. And adding
+a description can provide useful context to people who stumble across your
+gist.
 
-Usage: #{executable_name} [options] file
   EOS
-  
-  opts.on("-a", "--auth USERNAME,PASSWORD", Array, "Provide a USERNAME and PASSWORD to log in and post an authenticated gist") do |one,two|
-    options[:username] = one
-    options[:password] = two
+
+  opts.on("--login", "Authenticate jist on this computer.") do
+    Jist.login!
+    exit
   end
 
-  opts.on("-f", "--filename [NAME.EXTENSION]", Array,"Change the syntax highlighting (default is a.rb)") do |filename,b|
+  opts.on("-f", "--filename [NAME.EXTENSION]", "Sets the filename and syntax type.") do |filename|
     options[:filename] = filename
-    options[:derp] = b
   end
 
-  opts.on("-p", "--public", "Add this flag you want your gist to have a guessable url") do |public|
+  opts.on("-p", "--public", "Makes your gist public.") do |public|
     options[:public] = public
   end
 
-  opts.on("-d", "--description DESCRIPTION", "Adds a description to your gist") do |description|
+  opts.on("-d", "--description DESCRIPTION", "Adds a description to your gist.") do |description|
     options[:description] = description
   end
-  
-  opts.on_tail("-h","--help", "Show this message") do
-    $stdout.puts opts
+
+  opts.on("-t", "--token OAUTH_TOKEN", "The OAuth2 access_token to use.") do |token|
+    options[:access_token] = token
+  end
+
+  opts.on_tail("-h","--help", "Show this message.") do
+    puts opts
     exit
   end
 
-  opts.on_tail("-v", "--version") do
-    puts "jist v#{Jist::VERSION}" # hardcoded for now
+  opts.on_tail("-v", "--version", "Print the version.") do
+    puts "jist v#{Jist::VERSION}"
     exit
   end
 
 end
 opts.parse!
 
-if ARGV.empty?
-  $stdout << opts.help
+if ARGV.size == 0
+  puts Jist.gist(ARGF.read, options)['html_url']
+elsif ARGV.size == 1
+  puts Jist.gist(File.read(File.expand_path(ARGV[0])), {:filename => File.basename(ARGV[0])}.merge(options))['html_url']
 else
-  $stdout.puts Jist.gist(ARGF.read, options)["html_url"]
+  puts opts
 end

data/lib/jist.rb

@@ -1,24 +1,27 @@
 require 'net/https'
+require 'cgi'
 require 'multi_json'
 
 # It just gists.
 module Jist
 
-  VERSION = '0.2'
+  VERSION = '0.3'
 
   module_function
-  # Upload a gist to https://gist.github.com/
+  # Upload a gist to https://gist.github.com
   #
-  # @param content  the code you'd like to gist
+  # @param [String] content  the code you'd like to gist
+  # @param [Hash] options  more detailed options
   #
-  # @option :description  the description
-  # @option :filename  the filename (default 'a.rb')
-  # @option :public  to make it a public gist (default private)
-  # @option :username  if you wish to log in to github
-  # @option :password  (required if username is set)
+  # @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 [String] :access_token  (`File.read("~/.jist")`) The OAuth2 access token.
   #
-  # @return Hash  the decoded JSON response from the server
-  # @raise Exception  if something went wrong
+  # @return [Hash]  the decoded JSON response from the server
+  # @raise [Exception]  if something went wrong
+  #
+  # @see http://developer.github.com/v3/gists/
   def gist(content, options={})
     json = {}
 
@@ -33,25 +36,74 @@ module Jist
       }
     }
 
-    connection = Net::HTTP.new("api.github.com", 443)
-    connection.use_ssl = true
-    connection.read_timeout = 10
+    access_token = (options[:access_token] || File.read(File.expand_path("~/.jist")) rescue nil)
 
-    request = Net::HTTP::Post.new("/gists")
+    url = "/gists"
+    url << "?access_token=" << CGI.escape(access_token) if access_token.to_s != ''
+
+    request = Net::HTTP::Post.new(url)
     request.body = MultiJson.encode(json)
 
-    if options[:username]
-      request.basic_auth(options[:username], options[:password])
+    response = http(request)
+
+    if Net::HTTPCreated === response
+      MultiJson.decode(response.body)
+    else
+      raise RuntimeError.new "Got #{response.class} from gist: #{response.body}"
     end
+  end
 
-    response = connection.start do |http|
-                 http.request(request)
-               end
+  # Log the user into jist.
+  #
+  # This method asks the user for a username and password, and tries to obtain
+  # and OAuth2 access token, which is then stored in ~/.jist
+  def login!
+    puts "Obtaining OAuth2 access_token from github."
+    print "Github username: "
+    username = gets.strip
+    print "Github password: "
+    password = begin
+      `stty -echo 2>/dev/null`
+      gets.strip
+    ensure
+      `stty echo 2>/dev/null`
+    end
+    puts ""
+
+    request = Net::HTTP::Post.new("/authorizations")
+    request.body = MultiJson.encode({
+      :scopes => [:gist],
+      :note => "The jist gem",
+      :note_url => "https://github.com/ConradIrwin/jist"
+    })
+    request.basic_auth(username, password)
+
+    response = http(request)
 
     if Net::HTTPCreated === response
-      MultiJson.decode(response.body)
+      File.open(File.expand_path("~/.jist"), 'w') do |f|
+        f.write MultiJson.decode(response.body)['token']
+      end
+      puts "Success! https://github.com/settings/applications"
     else
       raise RuntimeError.new "Got #{response.class} from gist: #{response.body}"
     end
   end
+
+  private
+
+  module_function
+  # Run an HTTP operation against api.github.com
+  #
+  # @param [Net::HTTP::Request]
+  # @return [Net::HTTP::Response]
+  def http(request)
+    connection = Net::HTTP.new("api.github.com", 443)
+    connection.use_ssl = true
+    connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    connection.read_timeout = 10
+    connection.start do |http|
+      http.request request
+    end
+  end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: jist
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Conrad Irwin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-22 00:00:00 Z
+date: 2012-06-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: multi_json