sesame-cli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8946385f1c8994446d910c37ecab7b3fe5497d7753f156c47ba9f3d70d655631
-  data.tar.gz: 515d7680020974e60217383d1245e829ff8b0486e915b072a0950c2acf41ad1c
+  metadata.gz: 7e9e49b899f85759b86942eb6a051205e3db2f5adef20d6026ca31862b2724af
+  data.tar.gz: 84ae67770bb80de8854a1044b35f4b19364715383b18065507ba5cc5c8e9e183
 SHA512:
-  metadata.gz: 1796899e14a5bbc257b7ad781be05a64ede3e2b3c673bf44fd49ff67b7dc5fa40d5b45e40fe7f82140a3553f61628e761a49e790ebb072e3dc8d4d51f1882b58
-  data.tar.gz: bcbefe388969f696f1dfc778837991543b0fdc1f6811ae7e968529ac353a514ec2ce74c267c09204f93d4239f93e32182555dfb2c1beebc2456331adf0b9e5d8
+  metadata.gz: '07078b42b50a933caeb46187d494fb0981439a963d48e3445e0b3b6c6ef3e8328460ea39baa994152dd28c319d44aebf9f7a46b6b486f245de16b62b3e113834'
+  data.tar.gz: 14607f8208e44a33833ca234ebf5c441a0e2bdca8e3eb02336a70cd14ec63260979f06a83ef7e85d76f2da25332598238a3a7ddd0d4f08589a60c330fe91e3ac

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - sesame-cli.gemspec 
+Metrics:
+  Enabled: false

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gem 'bases', '~> 1.0'
 gem 'clipboard', '~> 1.1'
@@ -15,6 +17,7 @@ group :development do
   gem 'jeweler', '~> 2.3.9'
   gem 'rdoc', '~> 6.0'
   gem 'rspec', '~> 3.7'
+  gem 'rubocop', '~> 0.55'
   gem 'simplecov', '~> 0.15'
   gem 'yard', '~> 0.9'
 end

data/Gemfile.lock

@@ -2,6 +2,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.4.0)
+    ast (2.4.0)
     awesome_print (1.8.0)
     bases (1.0.2)
     builder (3.2.3)
@@ -54,8 +55,13 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
     psych (3.0.2)
     rack (2.0.4)
+    rainbow (3.0.0)
     rake (12.3.1)
     rbnacl (5.0.0)
       ffi
@@ -75,6 +81,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
     semver2 (3.4.2)
     simplecov (0.16.1)
       docile (~> 1.1)
@@ -83,6 +97,7 @@ GEM
     simplecov-html (0.10.2)
     slop (4.6.2)
     thread_safe (0.3.6)
+    unicode-display_width (1.3.2)
     yard (0.9.12)
 
 PLATFORMS
@@ -101,6 +116,7 @@ DEPENDENCIES
   rbnacl-libsodium (~> 1.0)
   rdoc (~> 6.0)
   rspec (~> 3.7)
+  rubocop (~> 0.55)
   simplecov (~> 0.15)
   slop (~> 4.6)
   yard (~> 0.9)

data/README.md

@@ -5,7 +5,8 @@
 Sesame
 ======
 
-Sesame is a simple password manager for the command-line.
+Sesame is a simple password manager for the command-line. See the [full
+documentation](http://www.rubydoc.info/gems/sesame-cli).
 
 Creating a Cave
 ---------------
@@ -20,7 +21,7 @@ passphrase; omit `--echo` to have this copied to the clipboard instead.
 
 ```
 $ gem install sesame
-$ sesame --echo
+$ sesame --echo --interactive
 ╔═════════════════════════════════════╗
 ║ ┏━━━┓ ┏━━━┓ ┏━━━┓  ┏━┓  ┏┓ ┏┓ ┏━━━┓ ║
 ║ ┗━╋━┓ ┣━━┫  ┗━╋━┓ ┏┻━┻┓ ┃┗┳┛┃ ┣━━┫  ║
@@ -44,9 +45,9 @@ mammal glue wage paper store detail weave date
 sky tea ant ice
 ```
 
-You will notice that Sesame enters interactive mode, allowing you to issue
-multiple commands in a single session. When you exit from interactive mode, the
-cave will be locked with a short code.
+You will notice that Sesame enters interactive mode when the `--interactive`
+argument is given, allowing you to issue multiple commands in a single session.
+When you exit from interactive mode, the cave will be locked with a short code.
 
 Remembering the Passphrase
 --------------------------
@@ -58,7 +59,7 @@ home, from the front door to the bathroom).
 
 * I enter the front door. On the side table a mammal is glueing their wages together.
 * Turning left into the kitchen, I see the drawer where I store my paper.
-* Looking down the corridor, I notice a detailed weave of a date on the bathroom door.
+* Looking down the corridor, I notice a detailed weaving of a date on the bathroom door.
 
 Lame perhaps, but easier to remember than `58qWT6jHpA566MX` (and just as
 secure).
@@ -100,9 +101,9 @@ Listing Services
 ```
 > list
 🧞 - "Behold! Tremble in awe at the greatness of these heroes!"
-twitter
-facebook
+facebook (lloyd@kranzky.com)
 google (2)
+twitter (kranzky)
 ```
 
 If several user accounts exist for the same service, a number will be displayed
@@ -135,8 +136,19 @@ particular service. The `next` command allows you to do that.
 
 ```
 > next google lloyd@kranzky.com
+🧞 - "I have recast the magic words for lloyd@kranzky.com of google..."
+chore proud barrel docile
 ```
 
+You can also update the lock code in a similar way.
+
+```
+> next sesame
+🧞 - "I shall forge you a new key for locking your cave."
+```
+
+The new code will be used when you next exit from interactive mode.
+
 Removing a Service
 ------------------
 
@@ -144,6 +156,8 @@ You can delete services from your cave.
 
 ```
 > delete google pazu@kranzky.com
+🧞 - "These magic words for pazy@kranzky.com of google are no more..."
+lazy cape green badge
 ```
 
 Recovering a Lost Cave
@@ -167,25 +181,26 @@ Run with the `--help` argument to view all options.
 $ sesame --help
 usage: ./bin/sesame [options]
     -p, --path         the path to the sesame cave; overrides $SESAME_PATH and .sesamerc
-    -s, --service      the name of the service (e.g. Twitter)
-    -u, --user         the username for the given service (e.g. user@test.com)
-    -o, --offset       the password index for the service and username (defaults to 0)
+    -q, --quiet        silence the welcome banner and the jinn
     -e, --echo         display passwords in plain text instead of adding to the clipboard
-    -i, --interactive  launch an interactive cli, allowing commands to be issued
     -r, --reconstruct  reconstruct a sesame cave from an existing passphrase
-    -x, --expunge      remove the temporary lock; the full passphrase will be required
+    -k, --lock         create a temporary lock; no passphrase required on next run
+    -x, --expunge      remove the temporary lock; full passphrase required on next run
+    -i, --interactive  launch an interactive cli, allowing commands to be issued
     -c, --command      the command to execute; one of: list, get, add, next, delete
     -l, --list         show all services and usernames
     -a, --add          add a new service and username
-    -g, --get          get the current password for an existing service and username
-    -n, --next         generate a new password for an existing service and username
+    -g, --get          get the password for a service and username
+    -n, --next         generate a new password for a service and username
     -d, --delete       remove an existing service and username
-    -q, --quiet        silence the jinn
+    -s, --service      the name of the service (e.g. Facebook)
+    -u, --user         the username for the service (e.g. user@test.com)
+    -o, --offset       the password offset to use (overrides current)
     -v, --version      print the version and exit
     -h, --help         all of that up there ^
 ```
 
-You can issue commands directly, which will suppress interactive mode.
+You can issue commands directly, rather than running in interactive mode.
 
 ```
 $ sesame -qegs twitter
@@ -205,15 +220,14 @@ stored.
 
 Sesame will also look for a file named `.sesamerc` or `sesame.cfg` in the
 current directory and in your home directory. This file should be in the JSON
-format, and can specify the `path`, `user`, `echo` and `quiet` options. For
-example, here is the configuration file used by Lloyd Kranzky:
+format, and can specify the `path`, `echo`, `interactive` and `quiet` options.
+For example:
 
 ```
   {
     "path": "~/Dropbox",
-    "user": "lloyd@kranzky.com",
-    "echo": "false",
-    "quiet": "true"
+    "interactive": false,
+    "quiet": true
   }
 ```
 

data/Rakefile

@@ -1,28 +1,26 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "sesame-cli"
-  gem.homepage = "http://github.com/kranzky/sesame-cli"
-  gem.license = "UNLICENSE"
-  gem.summary = %Q{Sesame is a simple password manager for the command-line.}
-  gem.description = %Q{Sesame is a simple password manager for the command-line.}
-  gem.email = "jasonhutchens@gmail.com"
-  gem.authors = ["Jason Hutchens", "Jack Casey"]
-  gem.required_ruby_version = "~> 2.1"
-  # dependencies defined in Gemfile
+  gem.name = 'sesame-cli'
+  gem.homepage = 'http://github.com/kranzky/sesame-cli'
+  gem.license = 'UNLICENSE'
+  gem.summary = %(🧞 - "Sesame is a simple password manager for the command-line!")
+  gem.description = %(🧞 - "Sesame is a simple password manager for the command-line!")
+  gem.email = 'jasonhutchens@gmail.com'
+  gem.authors = ['Jason Hutchens', 'Jack Casey']
+  gem.required_ruby_version = '~> 2.1'
 end
 Jeweler::RubygemsDotOrgTasks.new
 
@@ -32,13 +30,13 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-desc "Code coverage detail"
+desc 'Code coverage detail'
 task :simplecov do
-  ENV['COVERAGE'] = "true"
+  ENV['COVERAGE'] = 'true'
   Rake::Task['spec'].execute
 end
 
-task :default => :spec
+task default: :spec
 
 require 'yard'
 YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/sesame

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'sesame'
 require 'slop'
@@ -7,20 +8,21 @@ opts =
   begin
     Slop.parse do |o|
       o.string '-p', '--path', 'the path to the sesame cave; overrides $SESAME_PATH and .sesamerc'
-      o.string '-s', '--service', 'the name of the service (e.g. Twitter)'
-      o.string '-u', '--user', 'the username for the given service (e.g. user@test.com)'
-      o.integer '-o', '--offset', 'the password index for the service and username (defaults to 0)'
+      o.bool '-q', '--quiet', 'silence the welcome banner and the jinn'
       o.bool '-e', '--echo', 'display passwords in plain text instead of adding to the clipboard'
-      o.bool '-i', '--interactive', 'launch an interactive cli, allowing commands to be issued'
       o.bool '-r', '--reconstruct', 'reconstruct a sesame cave from an existing passphrase'
-      o.bool '-x', '--expunge', 'remove the temporary lock; the full passphrase will be required'
+      o.bool '-k', '--lock', 'create a temporary lock; no passphrase required on next run'
+      o.bool '-x', '--expunge', 'remove the temporary lock; full passphrase required on next run'
+      o.bool '-i', '--interactive', 'launch an interactive cli, allowing commands to be issued'
       o.string '-c', '--command', 'the command to execute; one of: list, get, add, next, delete'
       o.bool '-l', '--list', 'show all services and usernames'
       o.bool '-a', '--add', 'add a new service and username'
-      o.bool '-g', '--get', 'get the current password for an existing service and username'
-      o.bool '-n', '--next', 'generate a new password for an existing service and username'
+      o.bool '-g', '--get', 'get the password for a service and username'
+      o.bool '-n', '--next', 'generate a new password for a service and username'
       o.bool '-d', '--delete', 'remove an existing service and username'
-      o.bool '-q', '--quiet', 'silence the jinn'
+      o.string '-s', '--service', 'the name of the service (e.g. Facebook)'
+      o.string '-u', '--user', 'the username for the service (e.g. user@test.com)'
+      o.integer '-o', '--offset', 'the password offset to use (overrides current)'
       o.on '-v', '--version', 'print the version and exit' do
         say(File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')))
         exit
@@ -31,10 +33,10 @@ opts =
       end
     end
   rescue Slop::Error => e
-    say(e.message + " (try --help)")
+    say(e.message + ' (try --help)')
     exit 1
   end
-if opts.arguments.count > 0
+if opts.arguments.count.positive?
   say("extraneous arguments: #{opts.arguments.join(' ')} (try --help)")
   exit 1
 end