shellject 0.3.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f852ab84afcd6024a06c8800f9548070d46fab84
-  data.tar.gz: 265c5405d7f35afa07ff55ba6713299baa3d1359
+  metadata.gz: 1adad2b5bf6230314ff760499cc1d72499bdaf42
+  data.tar.gz: 0ed395b9b253f34fa69f8273b1964acf61194381
 SHA512:
-  metadata.gz: b683257c6b4260a07cfb8ea57e3fd99d113c8c7b50f3c17dc933fb0f59649979dd7d033c306a55ef0070e837861211bf9c898ae250f8e60129d6afe829def48e
-  data.tar.gz: d4100ca8c408ba0875d5ce6fed1b65360a37ff5edb73b71feea306e6b491926019a45d859780709651e326467103c75b9c6d1a3c64644d4ddbb624a7f1919c7e
+  metadata.gz: 245b13ce9b263102c7fa8a583b78fe2c4e204fef29be582ff3bc844140025e62a1d64b47a79268e5d3ceb819f338724bff5b6ccd98b24425c9e8a0d6820dc23a
+  data.tar.gz: 571f066016d01375efb5fcfc9dcd7a9b8f4354c499a2f00e5e1e0ec43b936dd6e95531335e149f12797d35187941eb04cbe8bdc0ebaa77dd2613fcb95ab3916f

data/README.md

@@ -41,8 +41,30 @@ Store your secret environment variables (API keys, AWS secrets etc.) with GPGME,
 
 ## Usage
 
-    $ shellject --help
-
+### Creating a new shelljection
+   1. Create a text file with the shell code you wish to have securely injected. Here's one we prepared earlier:
+     
+    `$ cat my-secret-stuff.sh`
+     ```
+     export SECRET_APIKEY=abc123
+     export OTHER_VAR=stuff
+     ```
+   1. Save the file contents as a shelljection:
+     `$ shellject save --name stuff my-secret-stuff.sh`
+   1. Test the shelljection:
+   
+     `$ shellject load stuff`
+
+     `echo $SECRET_APIKEY # "abc123"`
+     
+     `echo $OTHER_VAR # "stuff"`
+   1. *REMOVE THE ORIGINAL FILE!*
+   1. Now, you can securely load the enviroment variables whenever you wish:
+   
+     `$ shellject load stuff`
+
+###For further help and options:
+`$ shellject --help`
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec shellject` to use the code located in this directory, ignoring other installed copies of this gem.

data/lib/shellject/crypto_factory.rb

@@ -0,0 +1,8 @@
+module Shellject
+  # Factory method for creating crypto instances.
+  module CryptoFactory
+    def self.create
+      GPGME::Crypto.new always_trust: true
+    end
+  end
+end

data/lib/shellject/tasks/crypto_task.rb

@@ -0,0 +1,10 @@
+module Shellject
+  module Tasks
+    # A task that needs access to a crypto instance
+    module CryptoTask
+      def crypto
+        @crypto ||= CryptoFactory.create
+      end
+    end
+  end
+end

data/lib/shellject/tasks/load.rb

@@ -2,6 +2,7 @@ module Shellject
   module Tasks
     # Loads, decrypts, and outputs a shelljection
     class Load
+      include CryptoTask
       attr_reader :save_directory, :name
 
       def initialize(save_directory, name)
@@ -20,7 +21,7 @@ module Shellject
       private
 
       def ensure_readable
-        fail ShelljectError, "Could not read file #{path}" unless readable?
+        raise ShelljectError, "Could not read file #{path}" unless readable?
       end
 
       def readable?
@@ -30,10 +31,6 @@ module Shellject
       def path
         @path ||= save_directory.path_for name
       end
-
-      def crypto
-        GPGME::Crypto.new always_trust: true
-      end
     end
   end
 end

data/lib/shellject/tasks/save.rb

@@ -2,6 +2,7 @@ module Shellject
   module Tasks
     # Encrypts and saves a file as a shelljection.
     class Save
+      include CryptoTask
       attr_reader :save_directory, :input_path, :name
 
       def initialize(save_directory, input_path, name = nil)
@@ -31,7 +32,7 @@ module Shellject
 
       def ensure_writable
         FileUtils.mkdir_p(output_path.parent)
-        fail ShelljectError, "Cannot save to #{output_path}" unless writable?
+        raise ShelljectError, "Cannot save to #{output_path}" unless writable?
       end
 
       def writable?
@@ -39,7 +40,7 @@ module Shellject
       end
 
       def ensure_readable
-        fail ShelljectError, "Cannot read file #{input_path}" unless readable?
+        raise ShelljectError, "Cannot read file #{input_path}" unless readable?
       end
 
       def readable?
@@ -53,10 +54,6 @@ module Shellject
       def name
         @name ||= File.basename(input_path)
       end
-
-      def crypto
-        GPGME::Crypto.new always_trust: true
-      end
     end
   end
 end

data/lib/shellject/version.rb

@@ -1,4 +1,4 @@
 # Provides the gem version.
 module Shellject
-  VERSION = '0.3.0'
+  VERSION = '1.0.1'.freeze
 end

data/lib/shellject.rb

@@ -5,6 +5,8 @@ require 'gpgme'
 
 require 'shellject/version'
 require 'shellject/save_directory'
+require 'shellject/crypto_factory'
+require 'shellject/tasks/crypto_task'
 require 'shellject/tasks/load'
 require 'shellject/tasks/save'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellject
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Sergei Matheson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gpgme
@@ -188,7 +188,9 @@ files:
 - config.reek
 - exe/shellject
 - lib/shellject.rb
+- lib/shellject/crypto_factory.rb
 - lib/shellject/save_directory.rb
+- lib/shellject/tasks/crypto_task.rb
 - lib/shellject/tasks/load.rb
 - lib/shellject/tasks/save.rb
 - lib/shellject/version.rb