gpgenv 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f53c68a5984ba9f9b5e583242c21319cd8b378fb
-  data.tar.gz: 117960f3ebbccd6744e3afabb7dae6a519e40638
+  metadata.gz: 4134e591d0fa638a7abbdb84f88cc52b356d16ea
+  data.tar.gz: 908031007c8d67fa59ceea449d390de988b3e35e
 SHA512:
-  metadata.gz: de27f8b06e937383264654be602747a3281aba890bb65c3a775b4de4ae6605ee929659868c19230e7c504a36aba8ee844c884f4f876d9fed46881040def87754
-  data.tar.gz: 4ca93d6e4ffd4a1134708107b79f586797baa28ebe15517eae860d30c2c71c24eab8d5d7d5b5b9792b9120438d2b172864a32f1e8b55930b0c6ed8d6f35fb2ac
+  metadata.gz: 41df5b4c20ed2e4d84ea414374d5d4ca243f459d9ae04fd392fbc2212b32301dcb3119250b70c96913ff6f00d6acb1b54857c5bfb1b5dc2973d1d73e84004dd0
+  data.tar.gz: 979419629cbc17df4052bdffb11780b5dc7d1faf639414c327c5f0c249d7d41c33c3c3210f4c86926ce91e3257c66c02c10d270031693ee6defda593d1d523c9

data/README.md

@@ -14,38 +14,56 @@ export them as environment variables, and never store sensitive information in p
 I hope that you find `gpgenv` useful, and you use it to avoid security sins.
 
 ## Installation
-```gem install gpgenv```
+`gem install gpgenv`
 
 ## Usage
 
 ### Setup
 ```bash
-# You might want to add this to your profile.
+# Add this to your profile:
 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 create a new .gpgenv 
-directory or edit the keys and values in an existing one.
+files permanently on disk. Use `gpgenv edit` to edit a `yaml` file using `$EDITOR`.
+When you are done editing the file, it will be parsed and saved to your `.gpgenv` directory.
 
-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.
+You can also use `gpgenv import` to convert a `.env` file in the current directory to a `.gpgenv`
+directory.
 
 ### Run a process
 Gpgenv can spawn a child process that inherits environment variables like so:
 ```bash
-gpgenv "process_to_run argument1 argument2"
+gpgenv exec <command>  arg1 arg2 ...
 ```
 
 ### Export environment variables
 Gpgenv can export environment variables in your current shell session, like so:
+
 ```bash
 cd /dir/that/contains/.gpgenv
 eval `gpgshell`
 ```
 
+### Profiles
+
+Gpgenv supports profiles. Create a ~/.gpgenvrc file like this:
+
+```yaml
+---
+profile1:
+  - /home/YOU/.gpgenv/dir1
+  - /home/YOU/.gpgenv/extra_stuff
+profile2:
+  - /home/YOU/.gpgenv/dir1
+```
+
+You can then pass a `-p` parameter to `gpenv exec` or `gpgenv shell` specifying
+which profile to use, rather than using the `.gpgenv` directory relative to the current path.
+All of the directories specified in the profile will be loaded sequentially.
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/gpgenv/fork )

data/lib/gpgenv/base_command.rb

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

data/lib/gpgenv/edit_command.rb

@@ -1,45 +1,57 @@
-require 'fileutils'
 require 'clamp'
+require 'fileutils'
 require 'gpgenv'
 require 'gpgenv/base_command'
 require 'tempfile'
-
+require 'yaml'
 
 class Gpgenv
   class EditCommand < Gpgenv::BaseCommand
 
     def execute
-      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")
-        end
+      env = gpgenv.read_files
+      Tempfile.open(['env', '.yaml'], ENV.fetch('TMPDIR', '/tmp')) do |f|
+        f.write(env.to_yaml)
 
-        f.close
-        system("#{ENV['EDITOR']} #{f.path}")
-        f.open
+        done = false
+        new_env = nil
+        begin
+          # Write out current env to the file, as yaml.
+          f.close
 
-        f.rewind
-        lines = f.read.split("\n")
+          # Run the user's choice of editor on the file, wait until they're done.
+          system("#{ENV['EDITOR']} #{f.path}")
 
-        ::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]
-          new_env[key] = value
-        end
+          # Reopen the file, return to the start, load yaml from it.
+          f.open
+          f.rewind
+
+          file_contents = f.read
 
+          begin
+            new_env = YAML.load(file_contents)
+          rescue Psych::SyntaxError => e
+            puts e.message
+            STDOUT.write "Invalid yaml file. Try again (y/n)? " 
+            fail("Aborted") unless STDIN.gets.downcase.strip == 'y'
+            f.rewind
+          end
+
+          # Keep looping until we get valid yaml.
+        end until new_env
+
+        # Write out yaml to gpgenv.
+        ::FileUtils.mkdir_p(gpgenv.dir)
         new_env.each do |key, value|
-          gpgenv.set(key, from_editable(value))
+          gpgenv.set(key, value)
         end
 
+        # Calculate missing keys
         missing_keys = env.keys.select do |k|
           !new_env.keys.include?(k)
         end
 
+        # Delete missing keys.
         missing_keys.each do |missing_key|
           gpgenv.set(missing_key, nil)
         end
@@ -59,16 +71,6 @@ class Gpgenv
       end
     end
 
-    # Convert from editable back to the format to write to the file.
-    # Replace literal \n with newines, strip quotes.
-    def from_editable(str)
-      if str =~ /\\n/
-        str.gsub(/\\n/, "\n")
-      else
-        str
-      end
-    end
-
   end
 
 end

data/lib/gpgenv/exec_command.rb

@@ -1,10 +1,12 @@
 require 'clamp'
+require 'gpgenv'
 require 'gpgenv/base_command'
+require 'gpgenv/executor_provider'
 require 'gpgenv/profile'
-require 'gpgenv'
 
 class Gpgenv
   class ExecCommand < Gpgenv::BaseCommand
+    include ExecutorProvider
 
     option ['-p', '--profile'], "PROFILE", "Profile to use, from ~/.gpgenvrc", attribute_name: :profile
     parameter "ARGUMENTS ...", "arguments", :attribute_name => :args
@@ -13,19 +15,5 @@ class Gpgenv
       executor.exec_command args[0..-1].join(' ')
     end
 
-    def executor
-      # If GPGENV_PRPOFILE is set or a profile is passed on the CLI, use the given profile
-      # Otherwise use a standard Gpgenv object to execute.
-      if prof
-        Profile.new("#{ENV['HOME']}/.gpgenvrc", prof)
-      else
-        gpgenv
-      end  
-    end
-
-    def prof
-      profile || ENV['GPGENV_PROFILE']
-    end
-
   end
 end

data/lib/gpgenv/executor_provider.rb

@@ -0,0 +1,18 @@
+require 'gpgenv/profile'
+class Gpgenv
+  module ExecutorProvider
+    def executor
+      # If GPGENV_PRPOFILE is set or a profile is passed on the CLI, use the given profile
+      # Otherwise use a standard Gpgenv object to execute.
+      if prof
+        Profile.new("#{ENV['HOME']}/.gpgenvrc", prof)
+      else
+        gpgenv
+      end  
+    end
+
+    def prof
+      profile || ENV['GPGENV_PROFILE']
+    end
+  end
+end

data/lib/gpgenv/profile.rb

@@ -12,8 +12,6 @@ class Gpgenv
       exec(read_files, cmd)
     end
 
-    private
-
     def read_files
       hash = {}
       gpgenvs.each do |gpgenv|
@@ -22,10 +20,14 @@ class Gpgenv
       hash
     end
 
+    private
+
     def gpgenvs
       fail(".gpgenvrc file does not exist") unless File.exist?(file)
+
       yaml = YAML.load(File.read(file))
       fail("Invalid .gpgenvrc file") unless yaml.is_a?(Hash)
+
       value = yaml[name]
 
       fail("No such profile: #{name} in .gpgenvrc") unless value

data/lib/gpgenv/shell_command.rb

@@ -1,16 +1,23 @@
-require 'gpgenv'
-require 'shellwords'
 require 'clamp'
+require 'gpgenv'
 require 'gpgenv/base_command'
+require 'gpgenv/executor_provider'
+require 'shellwords'
 
 class Gpgenv
+
   class ShellCommand  < Gpgenv::BaseCommand
 
+    include ExecutorProvider
+
+    option ['-p', '--profile'], "PROFILE", "Profile to use, from ~/.gpgenvrc", attribute_name: :profile
+
     def execute
-      gpgenv.read_files.each do |k, v|
-        puts "export #{k}=#{Shellwords.escape(v)}"
+      executor.read_files.each do |k, v|
+        puts "export #{k}='#{v.gsub("'", "\'").gsub("\n", "\\n")}'"
       end
     end
 
   end
+
 end

data/lib/gpgenv/version.rb

@@ -1,3 +1,3 @@
 class Gpgenv
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/lib/gpgenv.rb

@@ -16,7 +16,6 @@ class Gpgenv
     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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gpgenv
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Michael Shea
@@ -141,6 +141,7 @@ files:
 - lib/gpgenv/edit_command.rb
 - lib/gpgenv/error.rb
 - lib/gpgenv/exec_command.rb
+- lib/gpgenv/executor_provider.rb
 - lib/gpgenv/export_command.rb
 - lib/gpgenv/gpgenv_command.rb
 - lib/gpgenv/import_command.rb