sesame-cli 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e9e49b899f85759b86942eb6a051205e3db2f5adef20d6026ca31862b2724af
-  data.tar.gz: 84ae67770bb80de8854a1044b35f4b19364715383b18065507ba5cc5c8e9e183
+  metadata.gz: 5f22b05a9ccfb4ed20090fe15a4688435773a2fc75dc45c6360f184806a1e0b7
+  data.tar.gz: 02ff7c0924ce62da164a8b2243292d6fa2db0c5c729d0eb48840956de7854467
 SHA512:
-  metadata.gz: '07078b42b50a933caeb46187d494fb0981439a963d48e3445e0b3b6c6ef3e8328460ea39baa994152dd28c319d44aebf9f7a46b6b486f245de16b62b3e113834'
-  data.tar.gz: 14607f8208e44a33833ca234ebf5c441a0e2bdca8e3eb02336a70cd14ec63260979f06a83ef7e85d76f2da25332598238a3a7ddd0d4f08589a60c330fe91e3ac
+  metadata.gz: 710f4c9022e30461b894edb497d956a0be95e0235756b3e27ffb0921efc7e744fb2edc607987b5b887d25bbf39152eec6a064b6b420a0fdb3b28c9fdcc5ef327
+  data.tar.gz: cd10c77c1879a964ab3998b22e705efd63663127629d93505d713fe86f89a37670950b99f7908bfbf05fcbd28e1fee7c490a067cfb38b5705ff111f90374c27e

data/README.md

@@ -42,7 +42,7 @@ mammal glue wage paper store detail weave date
 
 > exit
 🧞 - "I have secured your treasure with this key..."
-sky tea ant ice
+tea old ant ice
 ```
 
 You will notice that Sesame enters interactive mode when the `--interactive`

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/lib/sesame/cave.rb

@@ -121,6 +121,7 @@ module Sesame
       @item = nil
       @store = nil
       @secret = nil
+      @dirty = false
     end
 
     # Lock the cave by encrypting and saving the secret to a lock file, and then
@@ -212,11 +213,11 @@ module Sesame
     # True if a particular service has exactly one username.
     def unique?(service)
       raise Fail, 'Cannot test service uniqueness; store not open' unless open?
-      return if @store[service].nil?
+      raise Fail, 'No such service' if @store[service].nil?
       @store[service].count < 2
     end
 
-    # Generate and return the passpgrase for a service and username.
+    # Generate and return the passphrase for a service and username.
     def get(service, user = nil, index = nil)
       raise Fail, 'Cannot get service details; store not open' unless open?
       raise Fail, 'Cannot get the sesame service' if service.casecmp('sesame').zero?
@@ -233,8 +234,7 @@ module Sesame
       end
       raise Fail, 'Service cannot be empty' if service.strip.length.zero?
       raise Fail, 'User cannot be empty' if user.nil? || user.strip.length.zero?
-      item = _find(service, user)
-      raise Fail, 'Service and/or user already exists' unless item.nil?
+      raise Fail, 'User already exists for that service' unless @store[service].nil? || @store[service][user].nil?
       @store[service] ||= {}
       @store[service][user] = index || 0
       @dirty = true
@@ -248,7 +248,6 @@ module Sesame
     def update(service, user = nil, index = nil)
       raise Fail, 'Cannot update service details; store not open' unless open?
       item = _find(service, user)
-      raise Fail, 'Unable to find that service and/or user' if item.nil?
       index = item[:index] + 1 if index.nil?
       index = 0 if index.negative?
       user = item[:user]
@@ -263,7 +262,6 @@ module Sesame
       raise Fail, 'Cannot delete service details; store not open' unless open?
       raise Fail, 'Cannot delete the sesame service' if service.casecmp('sesame').zero?
       item = _find(service, user)
-      raise Fail, 'Unable to find that service and/or user' if item.nil?
       user = item[:user]
       @store[service].delete(user)
       @store.delete(service) if @store[service].count.zero?
@@ -284,9 +282,10 @@ module Sesame
     end
 
     def _find(service, user)
-      return nil if service.nil? || @store[service].nil?
+      raise Fail, 'No such service' if service.nil? || @store[service].nil?
       @item =
         if user.nil?
+          raise Fail, 'No unique user for service' unless unique?(service)
           item = @store[service].first
           {
             service: service,
@@ -294,7 +293,7 @@ module Sesame
             index: item.last
           }
         elsif @store[service][user].nil?
-          nil
+          raise Fail, 'No such service or user'
         else
           index = @store[service][user]
           {

data/lib/sesame/jinn.rb

@@ -7,39 +7,40 @@ require 'clipboard'
 module Sesame
   # The Jinn class is wholly responsible for interacting with the terminal.
   class Jinn
-    # Pass in parsed command-line options as a Slop instance.
-    def initialize(opts)
+    # Pass in parsed command-line options as a Slop instance. The optional pow
+    # parameter should only be used to speed up tests.
+    def initialize(opts, pow = 30)
       I18n.load_path = Dir[File.join(File.dirname(__FILE__), 'lang', '*yml')]
       @opts = opts
       _config
       _parse
       _welcome
-      @sesame = Cave.new(@opts[:path])
+      @cave = Cave.new(@opts[:path], pow)
     rescue Fail => e
       _error(e.message)
     end
 
     # Process the users request, possibly starting an interactive session.
     def process!
-      return if @sesame.nil?
+      return if @cave.nil?
       @was_locked = false
       raise Fail, 'Cannot lock and expunge simultaneously' if @opts.lock? && @opts.expunge?
-      if @sesame.exists?
+      if @cave.exists?
         raise Fail, 'Please remove the cave before attempting to reconstruct' if @opts.reconstruct?
-        raise Fail, 'Cannot expunge lock; it doesn\'t exist' if @opts.expunge? && !@sesame.locked?
+        raise Fail, 'Cannot expunge lock; it doesn\'t exist' if @opts.expunge? && !@cave.locked?
         raise Fail, 'Please specify a command (or use interactive mode)' if !@opts.interactive? && @opts[:command].nil? && !@opts.lock? && !@opts.expunge?
-        if @sesame.locked? && @opts.expunge?
-          @sesame.forget
+        if @cave.locked? && @opts.expunge?
+          @cave.forget
           _warn('Lock expunged')
         end
-        if @sesame.locked?
+        if @cave.locked?
           _unlock
           @was_locked = true
         else
           _open
         end
       else
-        @sesame.forget if @sesame.locked?
+        @cave.forget if @cave.locked?
         _new
       end
       _process(@opts[:command])
@@ -49,12 +50,12 @@ module Sesame
           break if _prompt
         end
         if @opts.expunge?
-          @sesame.close
+          @cave.close
         else
           _lock
         end
       elsif @opts.expunge? || (!@was_locked && !@opts.lock?)
-        @sesame.close
+        @cave.close
       else
         _lock
       end
@@ -203,7 +204,7 @@ module Sesame
         _info('reconstruct')
         words = ask('🔑  ') { |q| q.echo = '*' }
       end
-      phrase = @sesame.create!(words)
+      phrase = @cave.create!(words)
       if words.nil?
         _info('new')
         _show(phrase)
@@ -215,26 +216,26 @@ module Sesame
     def _open
       _info('open')
       words = ask('🔑  ') { |q| q.echo = '*' }
-      @sesame.open(words)
-      _info('path', path: @sesame.path)
+      @cave.open(words)
+      _info('path', path: @cave.path)
     end
 
     def _unlock
       _info('unlock')
       key = ask('🔑  ') { |q| q.echo = '*' }
-      @sesame.unlock(key)
-      _info('path', path: @sesame.path)
+      @cave.unlock(key)
+      _info('path', path: @cave.path)
     end
 
     def _forget
       _info('forgot')
-      @sesame.forget
+      @cave.forget
     end
 
     def _list
       _info('list')
       if @opts[:service].nil? || @opts[:service].length.zero?
-        @sesame.index.each do |service, users|
+        @cave.index.each do |service, users|
           next if service == 'sesame'
           if users.count > 1
             say("#{service} (#{users.count})")
@@ -243,7 +244,7 @@ module Sesame
           end
         end
       else
-        users = @sesame.index[@opts[:service]]
+        users = @cave.index[@opts[:service]]
         raise Fail, 'No such service found, you must be thinking of some other cave' if users.nil? || @opts[:service] == 'sesame'
         users.sort.each do |user, _|
           say(user)
@@ -252,37 +253,37 @@ module Sesame
     end
 
     def _get
-      phrase = @sesame.get(*_question, @opts[:offset])
-      _info('get', @sesame.item)
+      phrase = @cave.get(*_question, @opts[:offset])
+      _info('get', @cave.item)
       _show(phrase)
     end
 
     def _add
-      phrase = @sesame.insert(*_question(true), @opts[:offset])
-      _info('add', @sesame.item)
+      phrase = @cave.insert(*_question(true), @opts[:offset])
+      _info('add', @cave.item)
       _show(phrase)
     end
 
     def _next
-      phrase = @sesame.update(*_question, @opts[:offset])
+      phrase = @cave.update(*_question, @opts[:offset])
       if phrase.nil?
         _info('next_key')
         @was_locked = false
         _set_opt(:lock, true)
       else
-        _info('next', @sesame.item)
+        _info('next', @cave.item)
         _show(phrase)
       end
     end
 
     def _delete
-      phrase = @sesame.delete(*_question)
+      phrase = @cave.delete(*_question)
       _info('delete')
       _show(phrase)
     end
 
     def _lock
-      key = @sesame.lock
+      key = @cave.lock
       return if @was_locked
       _info('lock')
       _show(key)
@@ -348,7 +349,7 @@ module Sesame
         _info('service')
         service = ask('🏷  ')
       end
-      if user.nil? && (user_required || !@sesame.unique?(service))
+      if user.nil? && (user_required || !@cave.unique?(service))
         _info('user')
         user = ask('👤  ')
       end

data/sesame-cli.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: sesame-cli 0.2.0 ruby lib
+# stub: sesame-cli 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "sesame-cli".freeze
-  s.version = "0.2.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Jason Hutchens".freeze, "Jack Casey".freeze]
-  s.date = "2018-04-24"
+  s.date = "2018-04-25"
   s.description = "\u{1F9DE} - \"Sesame is a simple password manager for the command-line!\"".freeze
   s.email = "jasonhutchens@gmail.com".freeze
   s.executables = ["sesame".freeze]

data/spec/cave_spec.rb

@@ -4,11 +4,15 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Sesame::Cave do
   let(:cave) { Sesame::Cave.new(Dir.tmpdir, 20) }
+  let(:deep_cave) { Sesame::Cave.new(Dir.tmpdir) }
 
   after do
     cave.close if cave.open?
     cave.forget if cave.locked?
     File.delete(cave.path) if cave.exists?
+    deep_cave.close if deep_cave.open?
+    deep_cave.forget if deep_cave.locked?
+    File.delete(deep_cave.path) if deep_cave.exists?
   end
 
   describe '#path' do
@@ -145,44 +149,349 @@ describe Sesame::Cave do
   end
 
   describe '#open?' do
+    context 'by default' do
+      it 'returns false' do
+        expect(cave.open?).to be false
+      end
+    end
+
+    context 'after #create!' do
+      before do
+        cave.create!
+      end
+      it 'returns true' do
+        expect(cave.open?).to be true
+      end
+    end
+
+    context 'after #create! and #close' do
+      before do
+        cave.create!
+        cave.close
+      end
+      it 'returns false' do
+        expect(cave.open?).to be false
+      end
+    end
+
+    context 'after #create! and #lock' do
+      before do
+        cave.create!
+        cave.lock
+      end
+      it 'returns false' do
+        expect(cave.open?).to be false
+      end
+    end
+
+    context 'after @create! and #close and #open' do
+      before do
+        phrase = cave.create!
+        cave.insert('foo', 'bar')
+        cave.close
+        cave.open(phrase)
+      end
+      it 'returns true' do
+        expect(cave.open?).to be true
+      end
+    end
   end
 
   describe '#dirty?' do
+    context 'by default' do
+      it 'returns false' do
+        expect(cave.dirty?).to be false
+      end
+    end
+
+    context 'after #create!' do
+      before do
+        cave.create!
+      end
+      it 'returns true' do
+        expect(cave.dirty?).to be true
+      end
+    end
+
+    context 'after #create! and #close' do
+      before do
+        cave.create!
+        cave.close
+      end
+      it 'returns false' do
+        expect(cave.dirty?).to be false
+      end
+    end
+
+    context 'after #create! and #lock' do
+      before do
+        cave.create!
+        cave.lock
+      end
+      it 'returns false' do
+        expect(cave.dirty?).to be false
+      end
+    end
+
+    context 'after @create! and #close and #open' do
+      before do
+        phrase = cave.create!
+        cave.insert('foo', 'bar')
+        cave.close
+        cave.open(phrase)
+      end
+      it 'returns false' do
+        expect(cave.dirty?).to be false
+      end
+    end
+
+    context 'after #open and #insert' do
+      before do
+        phrase = cave.create!
+        cave.insert('foo', 'bar')
+        cave.close
+        cave.open(phrase)
+        cave.insert('bar', 'foo')
+      end
+      it 'returns true' do
+        expect(cave.dirty?).to be true
+      end
+    end
+
+    context 'after #open and #update' do
+      before do
+        phrase = cave.create!
+        cave.insert('foo', 'bar')
+        cave.close
+        cave.open(phrase)
+        cave.update('foo', 'bar')
+      end
+      it 'returns true' do
+        expect(cave.dirty?).to be true
+      end
+    end
+
+    context 'after #open and #delete' do
+      before do
+        phrase = cave.create!
+        cave.insert('foo', 'bar')
+        cave.close
+        cave.open(phrase)
+        cave.delete('foo', 'bar')
+      end
+      it 'returns true' do
+        expect(cave.dirty?).to be true
+      end
+    end
   end
 
   describe '#create!' do
+    context 'by default' do
+      before do
+        cave.create!
+      end
+
+      it 'creates a new cave' do
+        expect(cave.exists?).to be false
+        expect(cave.locked?).to be false
+        expect(cave.open?).to be true
+      end
+    end
+
+    context 'with a pass phrase' do
+      before do
+        deep_cave.create!('mammal glue wage paper store detail weave date')
+        deep_cave.insert('twitter', 'kranzky')
+      end
+
+      it 'reconstructs an old cave' do
+        expect(deep_cave.exists?).to be false
+        expect(deep_cave.locked?).to be false
+        expect(deep_cave.open?).to be true
+        expect(deep_cave.get('twitter')).to eq('nylon sand slice party')
+      end
+    end
   end
 
   describe '#open' do
+    before do
+      phrase = cave.create!
+      cave.insert('foo', 'bar')
+      cave.close
+      cave.open(phrase)
+      cave.get('foo')
+    end
+    it 'opens an existing cave' do
+      expect(cave.exists?).to be true
+      expect(cave.locked?).to be false
+      expect(cave.open?).to be true
+      expect(cave.item[:user]).to eq('bar')
+    end
   end
 
   describe '#close' do
+    before do
+      cave.create!
+      cave.insert('foo', 'bar')
+      cave.close
+    end
+    it 'closes a cave' do
+      expect(cave.exists?).to be true
+      expect(cave.locked?).to be false
+      expect(cave.open?).to be false
+    end
   end
 
   describe '#lock' do
+    before do
+      cave.create!
+      cave.insert('foo', 'bar')
+      cave.lock
+    end
+    it 'locks a cave' do
+      expect(cave.exists?).to be true
+      expect(cave.locked?).to be true
+      expect(cave.open?).to be false
+    end
   end
 
   describe '#unlock' do
+    context 'with a word phrase' do
+      before do
+        cave.create!
+        cave.insert('foo', 'bar')
+        phrase = cave.lock
+        cave.unlock(phrase)
+        cave.get('foo')
+      end
+      it 'unlocks a cave' do
+        expect(cave.exists?).to be true
+        expect(cave.locked?).to be false
+        expect(cave.open?).to be true
+        expect(cave.item[:user]).to eq('bar')
+      end
+    end
+
+    context 'with a character code' do
+      before do
+        cave.create!
+        cave.insert('foo', 'bar')
+        code = cave.lock.split(' ').map { |w| w[0] }.join
+        cave.unlock(code)
+        cave.get('foo')
+      end
+      it 'unlocks a cave' do
+        expect(cave.exists?).to be true
+        expect(cave.locked?).to be false
+        expect(cave.open?).to be true
+        expect(cave.item[:user]).to eq('bar')
+      end
+    end
   end
 
   describe '#forget' do
+    before do
+      cave.create!
+      cave.insert('foo', 'bar')
+      cave.lock
+      cave.forget
+    end
+    it 'removes the lock file' do
+      expect(cave.exists?).to be true
+      expect(cave.locked?).to be false
+      expect(cave.open?).to be false
+    end
   end
 
   describe '#index' do
+    before do
+      cave.create!
+      cave.insert('foo', 'bar')
+      cave.insert('foo', 'xxx')
+      cave.insert('bar', 'foo')
+    end
+    let(:index) { cave.index }
+    it 'returns the contents of the cave' do
+      expect(index.count).to eq(3)
+      expect(index.keys[0]).to eq('bar')
+      expect(index.keys[2]).to eq('sesame')
+      expect(index['foo'].count).to eq(2)
+      expect(index['foo']['xxx']).to eq(0)
+    end
   end
 
   describe '#unique?' do
+    before do
+      cave.create!
+      cave.insert('foo', 'bar')
+      cave.insert('foo', 'xxx')
+      cave.insert('bar', 'foo')
+    end
+    it 'returns true for services that contain exactly one user' do
+      expect(cave.unique?('foo')).to be false
+      expect(cave.unique?('bar')).to be true
+      expect { cave.unique?('xxx') }.to raise_error(Sesame::Fail)
+    end
   end
 
   describe '#get' do
+    before do
+      cave.create!
+      cave.insert('foo', 'bar')
+      cave.insert('foo', 'xxx')
+    end
+    let!(:phrase) { cave.insert('bar', 'foo') }
+    it 'returns the phrase' do
+      expect(cave.item[:index]).to eq(0)
+      expect(cave.get('bar')).to eq(phrase)
+      expect(cave.get('bar', 'foo')).to eq(phrase)
+      expect { cave.get('foo') }.to raise_error(Sesame::Fail)
+      expect { cave.get('xxx') }.to raise_error(Sesame::Fail)
+      expect(cave.get('foo', 'xxx').split(' ').count).to eq(4)
+    end
   end
 
   describe '#insert' do
+    before do
+      cave.create!
+      cave.insert('foo', 'bar')
+    end
+    it 'inserts the item' do
+      expect(cave.item[:service]).to eq('foo')
+      expect(cave.item[:user]).to eq('bar')
+      expect(cave.item[:index]).to eq(0)
+      expect { cave.insert('foo', 'bar') }.to raise_error(Sesame::Fail)
+      expect(cave.insert('foo', 'xxx').split(' ').count).to eq(4)
+      expect(cave.item[:user]).to eq('xxx')
+    end
   end
 
   describe '#update' do
+    before do
+      cave.create!
+    end
+    let!(:phrase) { cave.insert('foo', 'bar') }
+    it 'updates the item' do
+      expect(cave.item[:index]).to eq(0)
+      expect(cave.get('foo')).to eq(phrase)
+      expect(cave.update('foo')).not_to eq(phrase)
+      expect(cave.item[:index]).to eq(1)
+      expect(cave.get('foo')).not_to eq(phrase)
+    end
   end
 
   describe '#delete' do
+    before do
+      cave.create!
+      cave.insert('foo', 'bar')
+    end
+    let!(:phrase) { cave.insert('bar', 'foo') }
+    it 'deletes the item' do
+      expect(cave.get('bar')).to eq(phrase)
+      expect(cave.delete('bar')).to eq(phrase)
+      expect { cave.get('bar') }.to raise_error(Sesame::Fail)
+      expect(cave.item[:service]).to eq('bar')
+      expect { cave.get('xxx') }.to raise_error(Sesame::Fail)
+    end
   end
 end

data/spec/jinn_spec.rb

@@ -3,5 +3,39 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Sesame::Jinn do
-  let(:jinn) { Sesame::Jinn.new(opts) }
+  let(:opts) { double('opts') }
+  let(:jinn) { Sesame::Jinn.new(opts, 20) }
+
+  before do
+    option = double('option')
+    allow(opts).to receive(:echo?) { true }
+    allow(opts).to receive(:interactive?) { false }
+    allow(opts).to receive(:quiet?) { true }
+    allow(opts).to receive(:list?) { false }
+    allow(opts).to receive(:add?) { false }
+    allow(opts).to receive(:get?) { false }
+    allow(opts).to receive(:next?) { false }
+    allow(opts).to receive(:delete?) { false }
+    allow(opts).to receive(:lock?) { false }
+    allow(opts).to receive(:expunge?) { false }
+    allow(opts).to receive(:reconstruct?) { false }
+    allow(opts).to receive(:[]) { '/tmp' }
+    allow(opts).to receive(:option) { option }
+    allow(option).to receive(:ensure_call)
+  end
+
+  after do
+    cave = jinn.instance_variable_get(:@cave)
+    cave.close if cave.open?
+    cave.forget if cave.locked?
+    File.delete(cave.path) if cave.exists?
+  end
+
+  describe '#process!' do
+    context 'no arguments supplied' do
+      it 'exits with an error message' do
+        jinn.process!
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sesame-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jason Hutchens
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bases