gpgenv 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d779ed0c8aed80a81a2db211b6990d2653910ee2
-  data.tar.gz: 6a9afb2072364af270d5456decdb633f362140e7
+  metadata.gz: 23dabff81dce36a19ee497ea877ba0c953d5fcad
+  data.tar.gz: bfda2ffd3841dc7755d5b51022b306fadcacfeb1
 SHA512:
-  metadata.gz: 37458f219f3b15e4a6802a37d02b0c923716c778065721799192445baa2e54b9594d9ea8ac4240595a7f6adc93927c77b2d354a0a2dcb8cdc6a267b7e0be5a2b
-  data.tar.gz: ea868f8200878b67c4026264dfe12052eaa2dff8b238659d59c77b1bf8b62bc52e81766485427ccfc7f128c60626d7e14a3c9b0f6308e1d2faad72c852cc686f
+  metadata.gz: 4b52ad37a810bc6174d6550e725c353e053dff9ac44d5a3224625a9b56b79ed0bc33d68f402b650cb933d10e1ec1ecd05c06120ec6cb425b469445e8c483ebf3
+  data.tar.gz: 614b4e19d4a87e0d803f4b691559a31d13ac8dcd8a1791adecc2ee1e8e6a98184c89183e10d7b7dcb16580b3ad8d3aa7866fa38c2d9dc29ee0a04a6038c7a041

data/.gitignore

@@ -11,3 +11,4 @@
 *.gem
 .gpgenv/**/*
 .env
+/tags

data/README.md

@@ -10,8 +10,10 @@ As an admin, I am guilty of occasionally storing sensitive credentials on disk.
 extremely common. Your .netrc file probably contains all sorts of sensitive data, and even if you use a gpg-encrypted .netrc file, many tools
 simply don't understand gpg. Storing this stuff in plaintext is dangerous - but you do it anyway because the alternatives are just too painful.
 
-I love [pass](http://www.passwordstore.org/), because it makes it easy to store passwords encrypted. But it doesn't make it easy to *use* them in any capacity other than copy-and-pasting them. I wrote `gpgenv` to bridge that gap, and make it easy for me to never store sensitive information in an unencrypted format 
-on my own machine. I hope that you find it useful as well, and you use it to stop yourself from committing security sins.
+I love [pass](http://www.passwordstore.org/), because it makes it easy to store passwords encrypted. But it doesn't make it easy to *use* 
+them in any capacity other than copy-and-pasting them. I wrote `gpgenv` to bridge that gap: Easily edit gpg-encrypted files, easily
+export them as environment variables, and never store sensitive information in plaintext on your machine. 
+I hope that you find `gpgenv` useful, and you use it to avoid security sins.
 
 ## Installation
 ```gem install gpgenv```
@@ -27,8 +29,8 @@ export GPGENV_KEY_ID=<key-id-to-use-to-encrypt-stuff>
 ### Create or update files in a .gpgenv directory
 
 Gpgenv can create a .gpgenv directory without you ever needing to store plaintext 
-files permanently on disk. Simply run `gpgedit` to either create a new .gpgenv 
-directory, or edit the keys and values in an existing one.
+files permanently on disk. Simply run `gpgedit` to create a new .gpgenv 
+directory or edit the keys and values in an existing one.
 
 Alternatively, if you have a .env file and you'd like to switch to gpgenv, run
 `dotenv2gpg`. You can switch back by running `gpg2dotenv`, if you choose.
@@ -42,7 +44,7 @@ gpgenv "process_to_run argument1 argument2"
 ### Export environment variables
 Gpgenv can export environment variables in your current shell session, like so:
 ```bash
-cd /dir/that/has/a/.gpgenv/subdirectory
+cd /dir/that/contains/.gpgenv
 eval `gpgshell`
 ```
 

data/gpgenv.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'clamp'
 
   spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec"

data/lib/gpgenv/base_command.rb

@@ -0,0 +1,12 @@
+require 'clamp'
+class Gpgenv
+  class BaseCommand < Clamp::Command
+
+    option ['-d', '--dir'], "DIR", "Directory to read env files from", default: "#{Dir.pwd}/.gpgenv"
+
+    def gpgenv
+      @gpgenv ||= Gpgenv.new(dir: dir) 
+    end
+
+  end
+end

data/lib/gpgenv/edit_command.rb

@@ -1,14 +1,15 @@
 require 'fileutils'
 require 'clamp'
 require 'gpgenv'
+require 'gpgenv/base_command'
 require 'tempfile'
 
 
-module Gpgenv
-  class EditCommand < Clamp::Command
+class Gpgenv
+  class EditCommand < Gpgenv::BaseCommand
 
     def execute
-      env = Hash[Gpgenv.read_files.map{|k,v| [ k, to_editable(v) ] }]
+      env = Hash[gpgenv.read_files.map{|k,v| [ k, to_editable(v) ] }]
       Tempfile.open('.env', ENV.fetch('TMPDIR', '/tmp')) do |f|
         env.each do |k,v|
           f.write("#{k}=#{v}\n")
@@ -21,13 +22,28 @@ module Gpgenv
         f.rewind
         lines = f.read.split("\n")
 
-        ::FileUtils.mkdir_p(Gpgenv.dir)
-        lines.each do |line|
+        ::FileUtils.mkdir_p(gpgenv.dir)
+        new_env = {}
+        lines.each_with_index do |line, index|
           i = line.index('=')
+          fail("Line #{index+1} is invalid") unless i
           key = line[0..i-1]
           value = line[i+1..-1]
-          Gpgenv.set(key, from_editable(value))
+          new_env[key] = value
         end
+
+        new_env.each do |key, value|
+          gpgenv.set(key, from_editable(value))
+        end
+
+        missing_keys = env.keys.select do |k|
+          !new_env.keys.include?(k)
+        end
+
+        missing_keys.each do |missing_key|
+          gpgenv.set(missing_key, nil)
+        end
+
       end
     end
 
@@ -54,4 +70,5 @@ module Gpgenv
     end
 
   end
+
 end

data/lib/gpgenv/error.rb

@@ -1,4 +1,4 @@
-module Gpgenv
+class Gpgenv
   class Error < StandardError
   end
 end

data/lib/gpgenv/exec_command.rb

@@ -1,13 +1,14 @@
 require 'clamp'
+require 'gpgenv/base_command'
 require 'gpgenv'
 
-module Gpgenv
-  class ExecCommand < Clamp::Command
+class Gpgenv
+  class ExecCommand < Gpgenv::BaseCommand
 
     parameter "ARGUMENTS ...", "arguments", :attribute_name => :args
 
     def execute
-      Gpgenv.exec_command args[0..-1].join(' ')
+      gpgenv.exec_command args[0..-1].join(' ')
     end
 
   end

data/lib/gpgenv/export_command.rb

@@ -1,9 +1,10 @@
 require 'gpgenv'
+require 'gpgenv/base_command'
 require 'shellwords'
 require 'clamp'
 
-module Gpgenv
-  class ExportCommand  < Clamp::Command
+class Gpgenv
+  class ExportCommand  < Gpgenv::BaseCommand
 
     option ['-f', '--force'], :flag, "Force overwrite of existing .env file"
 
@@ -13,7 +14,7 @@ module Gpgenv
       end
 
       File.open('.env', 'w') do |f|
-        Gpgenv.read_files.each do |k, v|
+        gpgenv.read_files.each do |k, v|
           f.write "#{k}=#{Shellwords.escape(v)}"
         end
       end

data/lib/gpgenv/import_command.rb

@@ -1,24 +1,25 @@
 require 'fileutils'
 require 'gpgenv'
+require 'gpgenv/base_command'
 require 'shellwords'
 require 'clamp'
 
-module Gpgenv
-  class ImportCommand  < Clamp::Command
+class Gpgenv
+  class ImportCommand  < Gpgenv::BaseCommand
 
     option ['-f', '--force'], :flag, "Force overwrite of existing .gpg directory, totally erases it."
 
     def execute
-      if File.exist?(Gpgenv.dir) && !force?
-        fail("#{Gpgenv.dir} already exists. Use --force to overwrite it.")
+      if File.exist?(gpgenv.dir) && !force?
+        fail("#{gpgenv.dir} already exists. Use --force to overwrite it.")
       end
 
-      ::FileUtils.mkdir_p(Gpgenv.dir)
+      ::FileUtils.mkdir_p(gpgenv.dir)
       File.open('.env', 'r').each_line do |line|
         i = line.index('=')
         key=line[0..i-1]
         value=line[i+1..-1]
-        Gpgenv.set(key, value)
+        gpgenv.set(key, value)
       end
     end
 

data/lib/gpgenv/set_command.rb

@@ -1,17 +1,18 @@
 require 'clamp'
 require 'gpgenv'
+require 'gpgenv/base_command'
 
-module Gpgenv
-  class SetCommand < Clamp::Command
+class Gpgenv
+  class SetCommand < Gpgenv::BaseCommand 
 
     parameter "ARGUMENTS ...", "arguments", :attribute_name => :args
 
     def execute
       FileUtils.mkdir_p(Gpgenv.dir)
       if args.size == 1
-        Gpgenv.set(args[0], STDIN.read)
+        gpgenv.set(args[0], STDIN.read)
       elsif args.size == 2
-        Gpgenv.set(args.first, args.last)
+        gpgenv.set(args.first, args.last)
       else 
         fail("Usage: gpgset KEY [VALUE]")
       end

data/lib/gpgenv/shell_command.rb

@@ -1,12 +1,13 @@
 require 'gpgenv'
 require 'shellwords'
 require 'clamp'
+require 'gpgenv/base_command'
 
-module Gpgenv
-  class ShellCommand  < Clamp::Command
+class Gpgenv
+  class ShellCommand  < Gpgenv::BaseCommand
 
     def execute
-      Gpgenv.read_files.each do |k, v|
+      gpgenv.read_files.each do |k, v|
         puts "export #{k}=#{Shellwords.escape(v)}"
       end
     end

data/lib/gpgenv/version.rb

@@ -1,3 +1,3 @@
-module Gpgenv
-  VERSION = "0.1.4"
+class Gpgenv
+  VERSION = "0.1.5"
 end

data/lib/gpgenv.rb

@@ -2,11 +2,21 @@ require "gpgenv/version"
 require 'gpgenv/error'
 require 'shellwords'
 
-module Gpgenv
+class Gpgenv
 
-  def self.read_files
+  attr_reader :dir
+
+  def initialize(dir:)
+    @dir = dir
+  end
+
+  def read_files
     hash = {}
 
+    fail("#{dir} does not exist.") unless File.exist?(dir)
+    fail("#{dir} is not a directory.") unless File.directory?(dir)
+
+
     Dir.glob("#{dir}/*.gpg").each do |f|
       ext = File.extname(f)
       var = File.basename(f, ext)
@@ -21,19 +31,20 @@ module Gpgenv
     hash
   end
 
-  def self.set(key, value)
-    system "echo #{Shellwords.shellescape(value)} | gpg --batch --yes -e -r #{key_id} -o #{dir}/#{key}.gpg"
+  def set(key, value)
+    if value.nil?
+      File.delete("#{dir}/#{key}.gpg")
+    else
+      system "echo #{Shellwords.shellescape(value)} | gpg --batch --yes -e -r #{key_id} -o #{dir}/#{key}.gpg"
+    end
   end
 
-  def self.exec_command(cmd)
+  def exec_command(cmd)
     exec(read_files, cmd)
   end
 
-  def self.dir
-    "#{Dir.pwd}/.gpgenv"
-  end
-
-  def self.key_id
+  def key_id
     ENV['GPGENV_KEY_ID'] || fail("GPGENV_KEY_ID must be set.")
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gpgenv
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Michael Shea
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +129,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bang
 - bin/dotenv2gpg
 - bin/gpg2dotenv
 - bin/gpgedit
@@ -124,6 +137,7 @@ files:
 - bin/gpgshell
 - gpgenv.gemspec
 - lib/gpgenv.rb
+- lib/gpgenv/base_command.rb
 - lib/gpgenv/edit_command.rb
 - lib/gpgenv/error.rb
 - lib/gpgenv/exec_command.rb