handsomefencer-environment 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b77e623586da124d51c5005461619f94df0dc300fda62938fcd5ba5baf92cdcf
-  data.tar.gz: e38c8d0ea5e90551acd9ecce6bdb8189274908e4998e1e8d1f3101deb15ce565
+  metadata.gz: 4a022cae1c1d3ab7e88af0fb276719d54fd6ff0b1771221f32890adc2d2505c8
+  data.tar.gz: cf6c3c59a01bd32cba79299fc19a9d4eefb7156cfc5b232b70df7d348cce92cf
 SHA512:
-  metadata.gz: a214d95cbf7d3fcd22ec73a9480fc093a46a135e1cada6a47b4dbaf1b73b4436275047611b1da1e0ee1542490d044d84b8e6acb503ceafff3dc57aedbb54b7bc
-  data.tar.gz: 2ec84bc56f81fd8851d0c3ec4aa87256fd82b1e53ebbf81262ce67c9e105e3374183db4788a59e560e5be3c9d70dcaff55fd1f566b5e23ff4770f05a152f95e3
+  metadata.gz: 5b0989d9804b89e7ff45f4244ef3f08c16e2b4f6af2eddab6d08ee13437e3e98e793ebb739de16455fafdc2a5e85db7e8b5b77370f90b5f0c253e1fff15308aa
+  data.tar.gz: c11b2b5d43f637d559ed378ad17675d1a57434f314fb65194aeb3c3cf29ef7c62b50a2795da4e7f363f1282e788bb21da2d9e1527173fdfc4fc88238384f83b8

data/.gitignore

@@ -9,6 +9,7 @@
 .byebug_history
 /.byebug_history
 
-.env/**/*.enc
-/test/handsomefencer/dummy/local/.env/**/*.enc
-/config/deploy.key
+/.env/
+/config/
+/test/handsomefencer/dummy/.env/*
+/test/handsomefencer/dummy/config/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    handsomefencer-environment (0.2.4)
+    handsomefencer-environment (0.2.6)
 
 GEM
   remote: https://rubygems.org/

data/Guardfile

@@ -15,11 +15,11 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-guard :minitest do
+guard :minitest, all_on_start: false do
   # with Minitest::Unit
-  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  # watch(%r{^test/(.*)\/?test_(.*)\.rb$})
   watch(%r{^test/(.*)\/?(.*)_test\.rb$})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  # watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
   watch(%r{^test/test_helper\.rb$})      { 'test' }
   watch(%r{^lib/(.*)\/?(.*)\.rb$})  { 'test' }
 

data/README.md

@@ -1,7 +1,6 @@
 # Handsomefencer::Environment
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/handsomefencer/environment`. To experiment with that code, run `bin/console` for an interactive prompt.
-
+Obscure your environment files in source control, expose them for deploys.
 
 ## Installation
 
@@ -21,24 +20,60 @@ Or install it yourself as:
 
 ## Usage
 
-I like to keep environment variables out of source control. But I also like deploying from circleci, which means I have to get those variables from my local machine into circleci. That can kind of be a pain. With this gem you can .gitignore all your environment files, push to source control, and then when circleci pulls your code to run it for a deploy, all you need is to set one variable equal to whatever password you used to obfuscate your environment files. In a rails 5.2 app, you can use config/master.key.
+Create a .env directory at the root of your app. In it, place any environment files you'd like to obfuscate in source control:
 
-From the root of your
+.env/development.env
+.env/staging.env
+.env/production.env
 
-## Development
+Or you can namespace them like so:
+
+.env/production/database.env  
+
+If you aren't using Rails, or don't otherwise already have a config directory, go ahead and create one because we're going to generate a deploy.key to put inside it:
+
+`$ mkdir config`
+
+Then write a ruby script at the root of your project called obfuscate_env.rb and put code like this inside:
+
+```ruby
+require 'handsomefencer/environment'
+cipher = Handsomefencer::Environment::Crypto.new
+cipher.obfuscate
+```
+
+Now you should be able to run the script like so:
+
+`$ ruby obfuscate_env.rb`
+
+You should now have a config/deploy.key file as well as an encoded version of each .env file in your .env directory. For example:
 
-After checking out the repo, run `bundle` to install dependencies. Then, run `guard` to run the tests.
+.env/development.env
+.env/development.env.enc
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+You may wish to confirm that the deploy key and the .env files have been added to your .gitignore, and also that they are not still cached in your repo.
+
+Next, write a ruby script at the root of your project called expose_env.rb and put code like this inside:
+
+```ruby
+require 'handsomefencer/environment'
+cipher = Handsomefencer::Environment::Crypto.new
+cipher.expose
+
+```
+
+Once your code is on the deploy server, you can either create a deploy key with the correct key inside, or set it as a DEPLOY_KEY environment variable. Then you can expose the variables with:
+
+`$ ruby expose_env.rb`
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. There are some issues with the test_helper loading that I don't understand at the moment, but the tests will run automatically and correctly when saved, after running `bundle exec guard`. 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/schadenfred/handsomefencer-environment. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/schadenfred/handsomefencer-environment.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Handsomefencer::Environment project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/schadenfred/handsomefencer-environment/blob/master/CODE_OF_CONDUCT.md).

data/handsomefencer-environment.gemspec

@@ -34,10 +34,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "minitest-given"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-given"
   spec.add_development_dependency "rb-readline"
   spec.add_development_dependency "byebug"
 end

data/lib/handsomefencer/environment/crypto.rb

@@ -20,12 +20,18 @@ class Handsomefencer::Environment::Crypto
   def save_deploy_key
     @new_key = @cipher.random_key
     write_to_file Base64.encode64(@new_key), dkfile
-    unless File.read('.gitignore').match dkfile
-      open('.gitignore', 'a') { |f| f << "/" + dkfile }
-    end
+    ignore_sensitive_files
     read_deploy_key
   end
 
+  def ignore_sensitive_files
+    ["/#{dkfile}", "/.env/*"].each do |pattern|
+      unless File.read('.gitignore').match pattern
+        open('.gitignore', 'a') { |f| f << pattern }
+      end
+    end
+  end
+
   def read_deploy_key
     File.exist?(dkfile) ? Base64.decode64(File.read dkfile) : nil
   end
@@ -61,7 +67,6 @@ class Handsomefencer::Environment::Crypto
     source_files(directory, extension).each { |file| decrypt(file) }
   end
 
-
   private
 
     def dkfile

data/lib/handsomefencer/environment/version.rb

@@ -1,5 +1,5 @@
 module Handsomefencer
   module Environment
-    VERSION = "0.2.4"
+    VERSION = "0.2.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: handsomefencer-environment
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - schadenfred
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-given
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: minitest-given
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -130,9 +130,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env/backup.env"
-- ".env/circle.env"
-- ".env/development/backup.env"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
@@ -154,7 +151,6 @@ files:
 - lib/tasks/environment/expose.rake
 - lib/tasks/environment/obfuscate.rake
 - obfuscate_env.rb
-- sourcefiles/circle.env
 homepage: https://github.com/schadenfred/handsomefencer-environment
 licenses:
 - MIT

data/.env/backup.env

@@ -1,4 +0,0 @@
-DATABASE_HOST=database
-SERVER_HOST=somehost
-SERVER_USER=root
-SERVER_PORT=22

data/.env/circle.env

@@ -1,4 +0,0 @@
-DATABASE_HOST=database
-SERVER_HOST=somehost
-SERVER_USER=root
-SERVER_PORT=22

data/.env/development/backup.env

@@ -1,4 +0,0 @@
-DATABASE_HOST=database
-SERVER_HOST=somehost
-SERVER_USER=root
-SERVER_PORT=22

data/sourcefiles/circle.env

@@ -1,4 +0,0 @@
-DATABASE_HOST=database
-SERVER_HOST=somehost
-SERVER_USER=root
-SERVER_PORT=22