dotenv-sync 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b02e9462d0390c20b7d34aa33ba5c049f102bf84
-  data.tar.gz: c9ae0ea8edc992bbde2148bc0b346ac12cb860c3
+  metadata.gz: e1e441e6e49904c9d2666f7cd8adf95849076005
+  data.tar.gz: d77ebd70e530109d051d8bbd7e9ce5b9867dd80a
 SHA512:
-  metadata.gz: f129ee0b0592460be1fb71e1cee694282ce3ae341ebba56c267679c999c9ed8414c7b9988cff4a691f712a733a2d866aaa19d247e788a869fd3142526e8f6188
-  data.tar.gz: 9091c22e319a27bcad226a379ae700e0945c2a5a01f6ad3ec0f81c0ab2ba7de2526728a3b5610d40ad6ffc169f89bfb08036d496bdb0ec1348bc3206fa788cfd
+  metadata.gz: 42357a7d1e303fc001327885ebc4002562a7a39f4474f13625da7b6e26b293dab16edc35259d57463f299c39a0e54255c14ff591fa434fb6a2650d207e470697
+  data.tar.gz: 296c1f0ac1558d11893e268f7c3e571b2f34ab4d3fc15553f1c6ff42ed30fe747dbe68c9e521c2964efbb1a15088ca7dbf5c9d05475968e632e443959f41461c

data/.gitignore

@@ -120,4 +120,46 @@
 /var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160704-23542-x5q8i
 # Dotenv syncing
 /var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160704-23542-pxcwjq
-/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160704-23542-jexlno
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160704-23542-jexlno
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2867-1ac2bnv
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2867-wrb7sd
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2867-1g1t8m3
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2867-9svacm
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2867-1u4m03v
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2867-jlhqdj
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2867-1a3kcuu
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2867-1fn9k45
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2867-oqf5fr
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2909-i1qw1
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2909-14uyd56
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2909-eg0ogd
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2909-alvi48
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2909-87aai8
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2909-1v5dyt
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2909-e8jgjb
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2909-1t8qkgv
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2909-di8x5t
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2925-15tu0cv
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2925-1oh539b
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2925-g3nhyd
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2925-llt3nb
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2925-1memalx
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2925-1o3evp1
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2925-nzud1j
+# Dotenv syncing
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2925-1f53g9s
+/var/folders/gt/k34d1gd555vcr5x0wtz5gf_r0000gn/T/20160717-2925-4ncar9

data/README.md

@@ -1,6 +1,6 @@
-# Dotenv::Sync
+# dotenv-sync
 
-Dotenv-sync is a small utility that lets you sync `.env` secrets in your repo.
+dotenv-sync is a small utility that lets you sync `.env` secrets in your repo.
 
 This assumes you use [dotenv](https://github.com/bkeepers/dotenv) to manage and load your environment variables locally and relies on the fact that _dotenv_ supports environment specific dotenv files.
 
@@ -12,10 +12,14 @@ dotenv-sync assumes you have two seperate files:
 .env.local  - contatins only the secrets and is not shared on git directly
 ```
 
-This gem then uses a shared secret keyfile which can be managed in any way __important to not commit this file__,
+This gem then uses a shared secret keyfile `.env-key` __which should not be commited__,
 to encrypt and decrypt the `.env.local` file and share it in the repo as `.env-encrypted`.
 
-You can use _1Password for teams_ or _Vault_ for sharing your secret key file.
+You can use _1Password for teams_ or _Vault_ for sharing your secret keyfile.
+
+### Overview
+![](/docs/dotenv-sync.png)
+
 
 ## Installation
 
@@ -41,6 +45,7 @@ Dotenv-sync provides a command line file with several commands to run.
 dotenv-sync [command]                # Runs the command while loading the env variables from .env (based on the dotenv gem)
 dotenv-sync generate_key             # Generate a new key file
 dotenv-sync pull                     # Update your .env.local file from the encrypted version
+dotenv-sync merge                    # Update your .env.local file from the encrypted version (retains local changes)
 dotenv-sync push                     # Update the encrypted file from your version of .env.local
 dotenv-sync sort [DOTENV_FILE=.env]  # Sorts your .env file
 dotenv-sync help [COMMAND]           # Describe available commands or one specific command
@@ -50,7 +55,7 @@ dotenv-sync help [COMMAND]           # Describe available commands or one specif
 When initializing a new project you need to run `dotenv-sync generate_key` followed by `dotenv-sync push` to create the key which should be securely shared and the `.env-encrypted` file which can be commited.
 
 ### Subsequent uses
-If you're updating `.env.local` and want to share a change run `dotenv-sync push` and commit the change `.env-encrypted` file.
+If you're updating `.env.local` and want to share a change run `dotenv-sync push` and then commit the changed `.env-encrypted` file.
 
 If you're pulling a change from git and see that `.env-encypted` changed run `dotenv-sync pull` to update your local `.env.local`
 

data/lib/dotenv/sync/command_line.rb

@@ -38,6 +38,14 @@ module Dotenv
         Syncer.new(options).pull
       end
 
+      option :key, desc: "The keyfile", default: Syncer::DEFAULT_KEY_FILE, aliases: :k
+      option :encrypted, desc: "The shared encrypted file", default: Syncer::DEFAULT_ENCRYPTED_FILE, aliases: :e
+      option :secret, desc: "The private secret file", default: Syncer::DEFAULT_SECRET_FILE, aliases: :s
+      desc "merge", "Update your .env.local file from the encrypted version (preserving local changes)"
+      def merge
+        Syncer.new(options).merge
+      end
+
       option :key, desc: "The keyfile", default: Syncer::DEFAULT_KEY_FILE, aliases: :k
       option :encrypted, desc: "The shared encrypted file", default: Syncer::DEFAULT_ENCRYPTED_FILE, aliases: :e
       option :secret, desc: "The private secret file", default: Syncer::DEFAULT_SECRET_FILE, aliases: :s

data/lib/dotenv/sync/syncer.rb

@@ -43,6 +43,28 @@ module Dotenv
       end
 
       def pull
+        data = load_data
+        write(@secret_filename, data)
+        puts "Successfully decrypted #{@secret_filename}"
+        data
+      end
+
+      def merge
+        existing_data = read(@secret_filename)
+        merged_data = merge_lines(load_data, existing_data)
+        write(@secret_filename, merged_data)
+        puts "Successfully merged #{@secret_filename}"
+        merged_data
+      end
+
+      def merge_lines(left, right)
+        left_lines = left.lines.map(&:strip)
+        right_lines = right.lines.map(&:strip)
+        merged = left_lines + (right_lines - left_lines)
+        sort_lines(merged)
+      end
+
+      def load_data
         validate_file! @encrypted_filename
         key = read_key!
         data = read_64 @encrypted_filename
@@ -51,9 +73,6 @@ module Dotenv
         cipher.iv = iv
         cipher.key = key
         data = cipher.update(encrypted) + cipher.final
-        write(@secret_filename, data)
-        puts "Successfully decrypted #{@secret_filename}"
-        data
       end
 
       def sort(filename)

data/lib/dotenv/sync/version.rb

@@ -1,5 +1,5 @@
 module Dotenv
   module Sync
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotenv-sync
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - yonbergman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-04 00:00:00.000000000 Z
+date: 2016-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -85,6 +85,7 @@ files:
 - bin/console
 - bin/dotenv-sync
 - bin/setup
+- docs/dotenv-sync.png
 - dotenv-sync.gemspec
 - lib/dotenv/sync.rb
 - lib/dotenv/sync/command_line.rb