sesame-cli 0.1.0

data/lib/sesame/fail.rb

@@ -0,0 +1,4 @@
+module Sesame
+  class Fail < StandardError
+  end
+end

data/lib/sesame/jinn.rb

@@ -0,0 +1,308 @@
+require 'highline/import'
+require 'i18n'
+require 'clipboard'
+
+module Sesame
+  class Jinn
+    def initialize(opts)
+      @opts = opts
+      _parse
+      _welcome
+      @sesame = Cave.new(@opts[:path])
+      I18n.load_path = Dir[File.join(File.dirname(__FILE__), 'lang', '*yml')]
+    rescue Fail => e
+      _error(e.message)
+    end
+
+    def process!
+      was_locked = false
+      if @sesame.exists?
+        @sesame.forget if @sesame.locked? && @opts.expunge?
+        if @sesame.locked?
+          _unlock
+          @sesame.forget
+          was_locked = true
+        else
+          _open
+        end
+      else
+        @sesame.forget if @sesame.locked?
+        _new
+      end
+      _process(@opts[:command])
+      if @opts[:command].nil? || @opts.interactive?
+        loop do
+          say("\n")
+          break if _prompt
+        end
+        if @opts.expunge?
+          @sesame.close
+        else
+          _lock(was_locked)
+        end
+      elsif was_locked
+        _lock(true)
+      else
+        @sesame.close
+      end
+    rescue Fail => e
+      _error(e.message)
+    end
+
+    protected
+
+    def _welcome
+      return if @opts[:quiet]
+      say(HighLine.color(<<~EOS, :bold, :yellow))
+        ╔═════════════════════════════════════╗
+        ║ ┏━━━┓ ┏━━━┓ ┏━━━┓  ┏━┓  ┏┓ ┏┓ ┏━━━┓ ║
+        ║ ┗━╋━┓ ┣━━┫  ┗━╋━┓ ┏┻━┻┓ ┃┗┳┛┃ ┣━━┫  ║
+        ║ ┗━━━┛ ┗━━━┛ ┗━━━┛ ┗   ┛ ┗   ┛ ┗━━━┛ ║
+        ╚═════════════════════════════════════╝
+      EOS
+    end
+
+    def _parse
+      _set_path
+      _set_command('list') if @opts.list?
+      _set_command('add') if @opts.add?
+      _set_command('get') if @opts.get?
+      _set_command('next') if @opts.next?
+      _set_command('delete') if @opts.delete?
+    end
+
+    def _set_path
+      # set @opts[:path] if nil from .sesamerc and then $SESAME_PATH and then current dir
+      if @opts[:path].nil?
+        @opts[:path] = _load_config || ENV.fetch('SESAME_PATH', '.')
+      end
+      @opts[:path] = File.expand_path(@opts[:path])
+      unless Dir.exist?(@opts[:path])
+        say("No such directory: #{@opts[:path]}")
+        exit 2
+      end
+    end
+
+    def _load_config(base=".")
+      path = File.join(base, '.sesamerc')
+      if File.exist?(path)
+        File.read(path)
+      elsif base == '.'
+        _load_config(Dir.home)
+      end
+    end
+
+    def _set_command(name)
+      if @opts[:command].nil?
+        @opts[:command] = name
+      else
+        say("Cannot execute command #{name}; #{@opts[:command]} already specified!")
+        exit 2
+      end
+    end
+
+    def _process(command)
+      return if command.nil?
+      case command.to_sym
+      when :list
+        _list
+      when :add
+        _add
+      when :get
+        _get
+      when :next
+        _next
+      when :delete
+        _delete
+      else
+        _error
+      end
+    end
+
+    def _prompt
+      done = false
+      _info("prompt")
+      choose do |menu|
+        menu.prompt = "\n> "
+        menu.shell = true
+        menu.choice(:list, "Display all of the services and users in your Sesame store.") do |command, args|
+          _set_opts(args)
+          _list
+        end
+        menu.choice(:add, "Add a new service and user to your Sesame store.") do |command, args|
+          _set_opts(args)
+          _add
+        end
+        menu.choice(:get, "Retrieve the pass phrase for a service and user.") do |command, args|
+          _set_opts(args)
+          _get
+        end
+        menu.choice(:next, "Generate a new passphrase for a service and user.") do |comnmand, args|
+          _set_opts(args)
+          _next
+        end
+        menu.choice(:delete, "Remove a service and user from the Sesame store.") do |command, args|
+          _set_opts(args)
+          _delete
+        end
+        menu.choice(:exit, "Close Sesame.") do
+          done = true
+        end
+      end
+      done
+    rescue Fail => e
+      _error(e.message)
+    end
+
+    def _error(details="An error occurred")
+      message =
+        if @opts[:quiet]
+          _trans("error", details: details)
+        else
+          _trans("jinn.error", details: details)
+        end
+      say(HighLine.color(message, :bold, :red))
+    end
+
+    def _new
+      words = nil
+      if @opts.reconstruct?
+        _info("reconstruct")
+        words = ask("🔑  ") { |q| q.echo = "*" }
+      end
+      phrase = @sesame.create!(words)
+      if words.nil?
+        _info("new")
+        _show(phrase)
+      else
+        _info("reconstructed")
+      end
+    end
+
+    def _open
+      _info("open")
+      words = ask("🔑  ") { |q| q.echo = "*" }
+      @sesame.open(words)
+      _info("path", path: @sesame.path)
+    end
+
+    def _unlock
+      _info("unlock")
+      key = ask("🔑  ") { |q| q.echo = "*" }
+      @sesame.unlock(key)
+      _info("path", path: @sesame.path)
+    end
+
+    def _forget
+      _info("forgot")
+      @sesame.forget
+    end
+
+    def _list
+      _info("list")
+      if @opts[:service].nil? || @opts[:service].length == 0
+        @sesame.index.each do |service, users|
+          next if service == 'sesame'
+          if users.count > 1
+            say("#{service} (#{users.count})")
+          else
+            say(service)
+          end
+        end
+      else
+        users = @sesame.index[@opts[:service]]
+        raise Fail, "No such service found, you must be thinking of some other cave" if users.nil? || @opts[:service] == "sesame"
+        users.each do |user, index|
+          say(user)
+        end
+      end
+    end
+
+    def _get
+      phrase = @sesame.get(*_question, @opts[:offset])
+      _info("get", @sesame.item)
+      _show(phrase)
+    end
+
+    def _add
+      phrase = @sesame.insert(*_question(true), @opts[:offset])
+      _info("add", @sesame.item)
+      _show(phrase)
+    end
+
+    def _next
+      phrase = @sesame.update(*_question, @opts[:offset])
+      if phrase.nil?
+        _info("next_key")
+      else
+        _info("next", @sesame.item)
+        _show(phrase)
+      end
+    end
+
+    def _delete
+      phrase = @sesame.delete(*_question)
+      _info("delete")
+      _show(phrase)
+    end
+
+    def _lock(silent=false)
+      key = @sesame.lock
+      return if silent
+      _info("lock")
+      _show(key)
+    end
+
+    def _info(message, args={})
+      message =
+        if @opts[:quiet]
+          _trans(message, args)
+        else
+          _trans("jinn.#{message}", args)
+        end
+      return if message.nil? || message.length == 0
+      say(HighLine.color(message, :bold, :green))
+    end
+
+    def _trans(message, args)
+      retval = I18n.t(message, args)
+      if retval =~ /^translation missing/
+        retval =
+          if @opts[:echo]
+            I18n.t("#{message}_echo", args)
+          else
+            I18n.t("#{message}_clip", args)
+          end
+      end
+      retval
+    end
+
+    def _show(data)
+      if @opts[:echo]
+        say(data)
+      else
+        Clipboard.copy(data)
+      end
+    end
+
+    def _set_opts(args)
+      args = args.split(" ").map(&:strip).map(&:downcase)
+      return if args.count == 0
+      @opts[:service] = args.first if args.count < 3
+      @opts[:user] = args.last if args.count == 2
+    end
+
+    def _question(user_required=false)
+      service, user = @opts[:service], @opts[:user]
+      if service.nil?
+        _info("service")
+        service = ask("🏷  ")
+      end
+      if user.nil? && (user_required || !@sesame.unique?(service))
+        _info("user")
+        user = ask("👤  ")
+      end
+      [service.downcase, user.nil? ? nil : user.downcase]
+    end
+  end
+end

data/lib/sesame/lang/en.yml

@@ -0,0 +1,50 @@
+en:
+  error: 'Error: %{details}.'
+  open: 'Enter pass phrase.'
+  unlock: 'Enter unlock code.'
+  prompt: ''
+  new_echo: 'Store created. Your passphrase is:'
+  new_clip: 'Store created. Passphrase copied to clipboard.'
+  reconstruct: 'Enter pass phrase for new store.'
+  reconstructed: 'Store created with your chosen passphrase.'
+  path: 'Opened %{path}'
+  forgot: 'Lock removed.'
+  list: ''
+  get_echo: 'Password for %{service} / %{user}:'
+  get_clip: 'Password for %{service} / %{user} copied to clipboard.'
+  add_echo: 'New password:'
+  add_clip: 'New password copied to clipboard.'
+  next_key: 'Unlock code will be updated on exit.'
+  next_echo: 'Updated password for %{service} / %{user}:'
+  next_clip: 'Updated password for %{service} / %{user} copied to clipboard.'
+  delete_echo: 'Deleted password for %{service} / %{user}:'
+  delete_clip: 'Deleted password for %{service} / %{user} copied to clipboard.'
+  lock_echo: 'Store locked with unlock code:'
+  lock_clip: 'Store locked. Unlock code copied to clipboard.'
+  service: 'Enter service name:'
+  user: 'Enter user name:'
+  jinn:
+    error: '🧞 - "A thousand apologies! %{details}."'
+    open: '🧞 - "Open sesame! Please incant the magic words..."'
+    unlock: '🧞 - "Master, your cave is locked. Do you have the key?"'
+    prompt: '🧞 - "What is your command?"'
+    new_echo: '🧞 - "Your new cave is ready, master. Please commit these magic words to memory..."'
+    new_clip: '🧞 - "Your new cave is ready, master. The magic words are in your clipboard."'
+    reconstruct: '🧞 - "Master, what are the magic words you wish to use?"'
+    reconstructed: '🧞 - "Your new cave is ready, master."'
+    path: '🧞 - "The cave is open: %{path}"'
+    forgot: '🧞 - "My pleasure, master. I seem to have misplaced the lock."'
+    list: '🧞 - "Behold! Tremble in awe at the greatness of these heroes!"'
+    get_echo: '🧞 - "Master, the magic words for %{user} of %{service} are..."'
+    get_clip: '🧞 - "Master, the magic words for %{user} of %{service} are in your clipboard."'
+    add_echo: '🧞 - "Your new magic words are..."'
+    add_clip: '🧞 - "Your new magic words are in your clipboard."'
+    next_key: '🧞 - "I shall forge you a new key for locking your cave."'
+    next_echo: '🧞 - "I have recast the magic words for %{user} of %{service}..."'
+    next_clip: '🧞 - "The recast magic words for %{user} of %{service} are in your clipboard."'
+    delete_echo: '🧞 - "These magic words for %{user} of %{service} are no more..."'
+    delete_clip: '🧞 - "The magic words for %{user} of %{service} are no more, but are still in your clipboard."'
+    lock_echo: '🧞 - "I have secured your treasure with this key..."'
+    lock_clip: '🧞 - "I have secured your treasure. The key is in your clipboard."'
+    service: '🧞 - "What be the name of the service?"'
+    user: '🧞 - "And what be the name of the user?"'

data/lib/sesame.rb

@@ -0,0 +1,4 @@
+require 'sesame/cave'
+require 'sesame/dict'
+require 'sesame/fail'
+require 'sesame/jinn'

data/sesame-cli.gemspec

@@ -0,0 +1,100 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: sesame-cli 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "sesame-cli".freeze
+  s.version = "0.1.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-20"
+  s.description = "Sesame is a simple password manager for the command-line.".freeze
+  s.email = "jasonhutchens@gmail.com".freeze
+  s.executables = ["sesame".freeze]
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "UNLICENSE",
+    "VERSION",
+    "bin/sesame",
+    "lib/sesame.rb",
+    "lib/sesame/cave.rb",
+    "lib/sesame/dict.rb",
+    "lib/sesame/fail.rb",
+    "lib/sesame/jinn.rb",
+    "lib/sesame/lang/en.yml",
+    "sesame-cli.gemspec",
+    "sesame.gemspec",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/kranzky/sesame-cli".freeze
+  s.licenses = ["UNLICENSE".freeze]
+  s.required_ruby_version = Gem::Requirement.new("~> 2.1".freeze)
+  s.rubygems_version = "2.7.3".freeze
+  s.summary = "Sesame is a simple password manager for the command-line.".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<bases>.freeze, ["~> 1.0"])
+      s.add_runtime_dependency(%q<clipboard>.freeze, ["~> 1.1"])
+      s.add_runtime_dependency(%q<digest-crc>.freeze, ["~> 0.4"])
+      s.add_runtime_dependency(%q<highline>.freeze, ["~> 1.7"])
+      s.add_runtime_dependency(%q<i18n>.freeze, ["~> 1.0"])
+      s.add_runtime_dependency(%q<rbnacl>.freeze, ["~> 5.0"])
+      s.add_runtime_dependency(%q<rbnacl-libsodium>.freeze, ["~> 1.0"])
+      s.add_runtime_dependency(%q<slop>.freeze, ["~> 4.6"])
+      s.add_development_dependency(%q<awesome_print>.freeze, ["~> 1.8.0"])
+      s.add_development_dependency(%q<byebug>.freeze, ["~> 10.0.1"])
+      s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.0"])
+      s.add_development_dependency(%q<rspec>.freeze, ["~> 3.7"])
+      s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.15"])
+      s.add_development_dependency(%q<yard>.freeze, ["~> 0.9"])
+    else
+      s.add_dependency(%q<bases>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<clipboard>.freeze, ["~> 1.1"])
+      s.add_dependency(%q<digest-crc>.freeze, ["~> 0.4"])
+      s.add_dependency(%q<highline>.freeze, ["~> 1.7"])
+      s.add_dependency(%q<i18n>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<rbnacl>.freeze, ["~> 5.0"])
+      s.add_dependency(%q<rbnacl-libsodium>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
+      s.add_dependency(%q<awesome_print>.freeze, ["~> 1.8.0"])
+      s.add_dependency(%q<byebug>.freeze, ["~> 10.0.1"])
+      s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 6.0"])
+      s.add_dependency(%q<rspec>.freeze, ["~> 3.7"])
+      s.add_dependency(%q<simplecov>.freeze, ["~> 0.15"])
+      s.add_dependency(%q<yard>.freeze, ["~> 0.9"])
+    end
+  else
+    s.add_dependency(%q<bases>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<clipboard>.freeze, ["~> 1.1"])
+    s.add_dependency(%q<digest-crc>.freeze, ["~> 0.4"])
+    s.add_dependency(%q<highline>.freeze, ["~> 1.7"])
+    s.add_dependency(%q<i18n>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<rbnacl>.freeze, ["~> 5.0"])
+    s.add_dependency(%q<rbnacl-libsodium>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
+    s.add_dependency(%q<awesome_print>.freeze, ["~> 1.8.0"])
+    s.add_dependency(%q<byebug>.freeze, ["~> 10.0.1"])
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 6.0"])
+    s.add_dependency(%q<rspec>.freeze, ["~> 3.7"])
+    s.add_dependency(%q<simplecov>.freeze, ["~> 0.15"])
+    s.add_dependency(%q<yard>.freeze, ["~> 0.9"])
+  end
+end
+

data/sesame.gemspec

@@ -0,0 +1,99 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: sesame 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "sesame".freeze
+  s.version = "0.1.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-20"
+  s.description = "Sesame is a simple password manager for the command-line.".freeze
+  s.email = "jasonhutchens@gmail.com".freeze
+  s.executables = ["sesame".freeze]
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "UNLICENSE",
+    "VERSION",
+    "bin/sesame",
+    "lib/sesame.rb",
+    "lib/sesame/cave.rb",
+    "lib/sesame/dict.rb",
+    "lib/sesame/fail.rb",
+    "lib/sesame/jinn.rb",
+    "lib/sesame/lang/en.yml",
+    "sesame.gemspec",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/kranzky/sesame-cli".freeze
+  s.licenses = ["UNLICENSE".freeze]
+  s.required_ruby_version = Gem::Requirement.new("~> 2.1".freeze)
+  s.rubygems_version = "2.7.3".freeze
+  s.summary = "Sesame is a simple password manager for the command-line.".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<bases>.freeze, ["~> 1.0"])
+      s.add_runtime_dependency(%q<clipboard>.freeze, ["~> 1.1"])
+      s.add_runtime_dependency(%q<digest-crc>.freeze, ["~> 0.4"])
+      s.add_runtime_dependency(%q<highline>.freeze, ["~> 1.7"])
+      s.add_runtime_dependency(%q<i18n>.freeze, ["~> 1.0"])
+      s.add_runtime_dependency(%q<rbnacl>.freeze, ["~> 5.0"])
+      s.add_runtime_dependency(%q<rbnacl-libsodium>.freeze, ["~> 1.0"])
+      s.add_runtime_dependency(%q<slop>.freeze, ["~> 4.6"])
+      s.add_development_dependency(%q<awesome_print>.freeze, ["~> 1.8.0"])
+      s.add_development_dependency(%q<byebug>.freeze, ["~> 10.0.1"])
+      s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 6.0"])
+      s.add_development_dependency(%q<rspec>.freeze, ["~> 3.7"])
+      s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.15"])
+      s.add_development_dependency(%q<yard>.freeze, ["~> 0.9"])
+    else
+      s.add_dependency(%q<bases>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<clipboard>.freeze, ["~> 1.1"])
+      s.add_dependency(%q<digest-crc>.freeze, ["~> 0.4"])
+      s.add_dependency(%q<highline>.freeze, ["~> 1.7"])
+      s.add_dependency(%q<i18n>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<rbnacl>.freeze, ["~> 5.0"])
+      s.add_dependency(%q<rbnacl-libsodium>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
+      s.add_dependency(%q<awesome_print>.freeze, ["~> 1.8.0"])
+      s.add_dependency(%q<byebug>.freeze, ["~> 10.0.1"])
+      s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 6.0"])
+      s.add_dependency(%q<rspec>.freeze, ["~> 3.7"])
+      s.add_dependency(%q<simplecov>.freeze, ["~> 0.15"])
+      s.add_dependency(%q<yard>.freeze, ["~> 0.9"])
+    end
+  else
+    s.add_dependency(%q<bases>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<clipboard>.freeze, ["~> 1.1"])
+    s.add_dependency(%q<digest-crc>.freeze, ["~> 0.4"])
+    s.add_dependency(%q<highline>.freeze, ["~> 1.7"])
+    s.add_dependency(%q<i18n>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<rbnacl>.freeze, ["~> 5.0"])
+    s.add_dependency(%q<rbnacl-libsodium>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
+    s.add_dependency(%q<awesome_print>.freeze, ["~> 1.8.0"])
+    s.add_dependency(%q<byebug>.freeze, ["~> 10.0.1"])
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 6.0"])
+    s.add_dependency(%q<rspec>.freeze, ["~> 3.7"])
+    s.add_dependency(%q<simplecov>.freeze, ["~> 0.15"])
+    s.add_dependency(%q<yard>.freeze, ["~> 0.9"])
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+
+require 'sesame'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end