onetime 0.3.1 → 0.4.0

data/CHANGES.txt

@@ -1,5 +1,13 @@
 ONETIME, CHANGES
 
+#### 0.4.0 (2012-01-07) ###############################
+
+* ADDED: Support for ttl, passphrase, and email recipient
+* ADDED: Better error handling
+* CHANGED: env variable ONETIME_ACCOUNT -> ONETIME_CUSTID
+* CHANGED: global option -u is now -H
+
+
 #### 0.3.1 (2012-01-06) ###############################
 
 * FIXED: Added httparty to gemspec dependencies

data/README.md

@@ -2,27 +2,75 @@
 
 **Keep sensitive info out of your chat logs & email.**
 
-### Usage ###
+## Basic Usage ##
     
+Use `onetime` to share something you know (a secret phrase, a special link, etc) or to generate a secret (e.g. a temporary password).
+
+### onetime share ###
+
+You can pipe it:
+
     $ echo "I STILL WATCH NIGHT COURT." | onetime
-    
+    https://onetimesecret.com/secret/mc5o2649tva6885wvyspm0flobsasin
+
+You can type it:
+
     $ onetime
     Paste secret here (hit control-D to continue):
     I STILL WATCH NIGHT COURT.
     https://onetimesecret.com/secret/3djys3b7tridrcvbiprqjejz0c2g07x
+
+And you can read from a file:
     
+    $ <path/2/file onetime
+    https://onetimesecret.com/secret/8f8k3ajhax87ctln3h6y11nsb4vf0wq
     
+*Note that we don't use `cat` in that example! We don't want to provoke the [ire of Randal L. Schwartz](http://partmaps.org/era/unix/award.html).*
+
+
+### onetime generate ###
     
-### Installation ###
+    $ onetime generate
+    Your secret: CttenFwzVpjs
+    https://onetimesecret.com/secret/er5djg1wodsp5m32oyym489bnuhsfp6
+
+
+## Output Format ##
+
+`onetime` also supports YAML, JSON, and to a limited extent CSV outputs. Specify the format using the `-f ` global option:
+    
+    $ onetime -f yaml generate
+    ---
+    value: MhYcuge9VxtX
+    metadata_key: 4j1122kpd6clemp80gpobu9xfxsp7zu
+    secret_key: 8f8k3ajhax87ctln3h6y11nsb4vf0wq
+    ttl: 172800
+    passphrase_required: false
+    
+## Installation ###
 
     $ [sudo] gem install onetime
 
-### More Info ###
+## More Info ##
 
 * [API docs](https://onetimesecret.com/docs/api)
 * [Codes](https://github.com/onetimesecret/onetime-ruby)
 * [Rubgems](https://rubygems.org/gems/onetime)
+* [One-Time Secret](https://onetimesecret.com/)
+
+See also:
+
+    $ onetime -h
+    $ onetime show-commands
+    $ onetime share -h
+    $ onetime generate -h
+
+## Thanks ##
+
+* Kyle Dawkins for the [perl lib](https://github.com/quile/onetime-perl)
+* Drew Carey for [tweeting about us](https://twitter.com/DrewFromTV/status/142730130689761280)
+
 
-### License ###
+## License ##
 
 See LICENSE.txt

data/VERSION.yml

@@ -1,3 +1,3 @@
 :MAJOR: 0
-:MINOR: 3
-:PATCH: 1
+:MINOR: 4
+:PATCH: 0

data/bin/onetime

@@ -12,9 +12,9 @@ class Onetime::CLI
     
     default :share
     
+    global :H, String, "Base URI (e.g. https://onetimesecret.com/api)"
     global :c, :custid, String, "Customer ID (e.g. you@yourcompany.com)"
     global :k, :apikey, String, "API key (e.g. 4eb33c6340006d6607c813fc7e707a32f8bf5342)"
-    global :u, :uri, String, "Base URI (e.g. https://onetimesecret.com/api)"
     
     global :f, :format, String, "Output format (json or yaml)"
     global :j, :json, "Shorthand for -f json"
@@ -30,6 +30,7 @@ class Onetime::CLI
     end
     
     before do |obj|
+      OT::API.base_uri obj.global.H if obj.global.H
       @api = OT::API.new obj.global.custid, obj.global.apikey
       obj.global.format = 'yaml' if obj.global.yaml
       obj.global.format = 'json' if obj.global.json
@@ -45,39 +46,71 @@ class Onetime::CLI
     after do |obj|
       case obj.global.format
       when 'json'
-        puts @ret.to_json
+        puts @res.to_json
       when 'yaml'
-        puts @ret.to_yaml
+        puts @res.to_yaml
       end
     end
     
+    usage "onetime status"
     command :status do |obj|
-      @ret = @api.get '/status'
+      @res = @api.get '/status'
+      if @res.nil?
+        raise RuntimeError, 'Could not complete request' 
+      elsif @api.response.code != 200
+        raise RuntimeError, @res['message']
+      end
       unless obj.global.format
-        puts @ret[:status]
+        msg = @api.anonymous ? 'Anonymous' : @api.custid
+        STDERR.puts '# Host: %s' % OT::API.base_uri
+        STDERR.puts '# Account: %s' % msg
+        puts 'Service Status: %s' % @res[:status]
       end
     end
     
     argv :key
+    usage "onetime metadata <KEY>"
     command :metadata do |obj|
       raise RuntimeError, "csv not supported" if obj.global.format == 'csv'
       raise RuntimeError, "Usage: #{$0} metadata <KEY>" unless obj.argv.key
-      @ret = @api.post '/metadata/%s' % obj.argv.key
+      @res = @api.post '/metadata/%s' % obj.argv.key
+      if @res.nil?
+        raise RuntimeError, 'Could not complete request' 
+      elsif @api.response.code != 200
+        raise RuntimeError, @res['message']
+      end
       unless obj.global.format
-        puts @ret.to_yaml
+        puts @res.to_yaml
       end
     end
     
+    option :p, :passphrase, String, "Passphrase to decrypt the secret (only required if one was provided to you)"
     argv :key
+    usage "onetime secret <KEY>"
+    usage "onetime secret [-p PASSPHRASE] <KEY>"
     command :secret do |obj|
       raise RuntimeError, "csv not supported" if obj.global.format == 'csv'
       raise RuntimeError, "Usage: #{$0} secret <KEY>" unless obj.argv.key
-      @ret = @api.post '/secret/%s' % obj.argv.key
+      opts = {}
+      opts[:passphrase] = obj.option.passphrase if obj.option.passphrase
+      @res = @api.post '/secret/%s' % [obj.argv.key], opts
+      if @res.nil?
+        raise RuntimeError, 'Could not complete request' 
+      elsif @api.response.code != 200
+        raise RuntimeError, @res['message']
+      end
       unless obj.global.format
-        puts @ret.to_yaml
+        puts @res.to_yaml
       end
     end
     
+    usage "onetime share"
+    usage "onetime share [-t 3600] [-p PASSPHRASE]"
+    usage "echo 'your secret' | onetime share"
+    usage "<path/2/file onetime share"
+    option :t, :ttl, Integer, "Time-to-live in seconds"
+    option :p, :passphrase, String, "Passphrase to encrypt the secret (something only you and recipient know)"
+    option :r, :recipient, Array, "Email address to deliver the secret link"
     command :share do |obj|
       begin
         if Kernel.select [$stdin], nil, nil, 0
@@ -85,39 +118,72 @@ class Onetime::CLI
         else
           STDERR.puts "Paste secret here (hit control-D to continue):"
           secret_value = ARGF.read
-          STDERR.puts "Generating link..."
+          STDERR.puts # new line to let the person know we got it.
         end
       rescue Interrupt => ex
         puts "Exiting..."
         exit 0
       end
       raise RuntimeError, "No secret provided" if secret_value.chomp.empty?
-      @ret = @api.post '/share', :secret => secret_value
-      uri = OT::API.web_uri('secret', @ret[:secret_key])
+      opts = { :secret => secret_value, :ttl => obj.option.ttl, :recipient => obj.option.recipient }
+      opts[:passphrase] = obj.option.passphrase if obj.option.passphrase
+      @res = @api.post '/share', opts
+      if @res.nil?
+        raise RuntimeError, 'Could not complete request' 
+      elsif @api.response.code != 200
+        raise RuntimeError, @res['message']
+      end
+      uri = OT::API.web_uri('secret', @res[:secret_key])
       if obj.global.format == 'csv' || obj.global.format.nil?
-        puts uri
+        if @res[:recipient] && !@res[:recipient].compact.empty?
+          STDERR.puts '# Secret link sent to: %s' % @res[:recipient].join(',')
+        else
+          puts uri
+        end
       end
     end
     
+    usage "onetime generate"
+    usage "onetime generate [-t 3600] [-p PASSPHRASE]"
+    option :t, :ttl, Integer, "Time-to-live in seconds"
+    option :p, :passphrase, String, "Passphrase to encrypt the secret (something only you and recipient know)"
+    option :r, :recipient, Array, "Email address to deliver the secret link"
     command :generate do |obj|
-      @ret = @api.post '/generate'
-      uri, secret_value = OT::API.web_uri('secret', @ret[:secret_key]), @ret[:value]
-      STDERR.puts @ret.inspect if obj.global.debug
+      opts = { :ttl => obj.option.ttl, :recipient => obj.option.recipient }
+      opts[:passphrase] = obj.option.passphrase if obj.option.passphrase
+      @res = @api.post '/generate', opts
+      if @res.nil?
+        raise RuntimeError, 'Could not complete request' 
+      elsif @api.response.code != 200
+        raise RuntimeError, @res['message']
+      end
+      uri, secret_value = OT::API.web_uri('secret', @res[:secret_key]), @res[:value]
+      STDERR.puts @res.inspect if obj.global.debug
       if obj.global.format == 'csv'
         puts [secret_value,uri].join ','
       elsif obj.global.format.nil?
         msg = 'Your secret (hit return to continue): %s' % secret_value
+        if @res[:recipient] && !@res[:recipient].compact.empty?
+          uri = "\e[K\r# Secret link sent to: %s" % [@res[:recipient].join(',').ljust(40, ' ')]
+        end
         eraser = "\e[K\r%s" % [uri]  # \e[K\r
         print msg
-        begin
-          old_stty = `stty -g`  # store tty settings
-          system "stty -echo"
-          STDIN.getc
-        rescue Interrupt
-        ensure
-          system "stty echo"
-          system "stty #{old_stty}" # restore stty settings
-          print eraser
+        # Check for tty b/c if we're receiving data via STDIN, even if
+        # we're ignoring it, the stty commands return "stdin isn't a terminal"
+        if STDIN.tty?
+          begin
+            old_stty = `stty -g`  # store tty settings
+            system "stty -echo"
+            STDIN.getc
+          rescue Interrupt
+          ensure
+            system "stty echo"
+            system "stty #{old_stty}" # restore stty settings
+            print eraser
+          end
+        else
+          puts 
+          print uri
         end
         puts
       end

data/lib/onetime/api.rb

@@ -51,7 +51,7 @@ module Onetime
     base_uri 'https://onetimesecret.com/api'
     format :json
     headers 'X-Onetime-Client' => Onetime::API::VERSION.to_s
-    attr_reader :opts, :response, :custid, :key, :default_params
+    attr_reader :opts, :response, :custid, :key, :default_params, :anonymous
     attr_accessor :apiversion
     def initialize custid=nil, key=nil, opts={}
       unless ENV['ONETIME_HOST'].to_s.empty?
@@ -60,9 +60,15 @@ module Onetime
       @apiversion = opts.delete(:apiversion) || opts.delete('apiversion') || 1
       @opts = opts
       @default_params = {}
-      @custid = custid || ENV['ONETIME_ACCOUNT']
+      @custid = custid || ENV['ONETIME_CUSTID']
       @key = key || ENV['ONETIME_APIKEY']
-      unless @custid.to_s.empty? || @key.to_s.empty?
+      if @custid.to_s.empty? && @key.to_s.empty?
+        @anonymous = true
+      elsif @custid.to_s.empty? || @key.to_s.empty?
+        raise RuntimeError, "You provided a custid without an apikey" if @key.to_s.empty?
+        raise RuntimeError, "You provided an apikey without a custid" if @custid.to_s.empty?
+      else
+        @anonymous = false
         opts[:basic_auth] ||= { :username => @custid, :password => @key }
       end
     end

data/onetime.gemspec

@@ -5,20 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = "onetime"
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Delano Mandelbaum"]
-  s.date = "2012-01-06"
+  s.date = "2012-01-07"
   s.description = "CLI tool and Ruby library for onetimesecret.com"
   s.email = "delano@onetimesecret.com"
   s.executables = ["onetime"]
   s.extra_rdoc_files = [
-    "LICENSE.txt"
+    "LICENSE.txt",
+    "README.md"
   ]
   s.files = [
     "CHANGES.txt",
     "LICENSE.txt",
+    "README.md",
     "Rakefile",
     "VERSION.yml",
     "bin/onetime",
@@ -36,13 +38,16 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<drydock>, [">= 0.6.9"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.7.7"])
       s.add_runtime_dependency(%q<json>, [">= 1.6.4"])
     else
       s.add_dependency(%q<drydock>, [">= 0.6.9"])
+      s.add_dependency(%q<httparty>, [">= 0.7.7"])
       s.add_dependency(%q<json>, [">= 1.6.4"])
     end
   else
     s.add_dependency(%q<drydock>, [">= 0.6.9"])
+    s.add_dependency(%q<httparty>, [">= 0.7.7"])
     s.add_dependency(%q<json>, [">= 1.6.4"])
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: onetime
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-06 00:00:00 Z
+date: 2012-01-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: drydock