muchkeys 0.3.7 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ad2ab8e2bfa75fd797b36be39c1a8184ce7484e
-  data.tar.gz: 3f21dc427fb84b6f2d7b23238e1200d5578620bc
+  metadata.gz: 93107ba506bcfe9a978c302c6da035e01adb775b
+  data.tar.gz: e868c16a3959356cf283f12c97db3ea29e09a6ab
 SHA512:
-  metadata.gz: 64c72caa89877fb1e9b091efe521b45378fb7b5da1ae6133e4f976252b398d2a54e0a7afda1cbe6cf0c8f8b8215eab4e0ab84fc86e527185e22df6b8af9ee812
-  data.tar.gz: 6456d2da5d388abc0b095af75dcd87237415659a6db16cbeaef92e5b33dbf246d61dcb28415631869e9996e87a8a36827da1d70554531b6959e5cb3c81509ea7
+  metadata.gz: 736c887f3c13d2b1061492a5dee846233ee13c5a5e87973e7914bd7828a4c467fece8cf15b8cfc6bcecdca6418bb67bc89182170ade846c288825355b0b71657
+  data.tar.gz: b93afaebd935a0a55c2008ff9d164dceca7c6ad71711a743dc93257a05a3e6dc289596918677ec0679de00a67c1b69e262c673af9797804b7472b397f2d184a6

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in muchkeys.gemspec
 gemspec
+
+gem 'pry-byebug'

data/exe/muchkeys

@@ -2,5 +2,4 @@
 
 require "muchkeys"
 
-cli = MuchKeys::CLI.new ARGV
-cli.run
+MuchKeys::CLI.start

data/lib/muchkeys.rb

@@ -4,7 +4,6 @@ require "muchkeys/configuration"
 require "muchkeys/secret"
 require "muchkeys/key_validator"
 require "muchkeys/cli"
-require "muchkeys/cli/validator"
 
 require "net/http"
 

data/lib/muchkeys/cli.rb

@@ -1,144 +1,51 @@
-require "slop"
+require 'thor'
 
 module MuchKeys
-  class CLI
-    attr_reader :mode
+  class CLI < Thor
+    include Thor::Actions
 
-    def initialize(arguments)
-      # I'd like to not be doing this kind of check
-      # But this is tricky because we need to know
-      # later if help was invoked so we don't execute run with blank options.
-      @cli_should_exit = false
-      parsed = parse_options(arguments)
-    end
-
-    def parse_options(arguments)
-      @opts = Slop.parse arguments do |o|
-        o.bool "-e", "--encrypt", "Encrypt keys from a file to put in consul."
-        o.bool "-d", "--decrypt", "Decrypt keys from consul."
-        o.bool "-p", "--plain",   "Fetch plaintext key from consul."
+    map %w[--version -v] => :__version
 
-        o.string "--consul_url", "Consul server http address", default: "http://localhost:8500"
-        o.string "--private_key", "Location of your private key"
-        o.string "--public_key", "Location of your public key"
+    class_option :consule_url, type: :string, default: 'http://localhost:8500'
 
-        o.string "-f", "--file", "File to encrypt"
-        o.string "-c", "--consul_key", "Consul key to decrypt"
-
-        o.bool "-h", "--help", "Shows usage"
-        o.bool "-v", "--version", "Prints the version number"
-      end
+    desc "encrypt FILE", "encrypt keys from a file to put in consul"
+    method_option :public_key, type: :string, required: true
+    def encrypt(file)
+      say MuchKeysExecutor.encrypt(file, options[:public_key])
     end
 
-    def set_primary_mode(options=@opts)
-      MuchKeys::CLI::Validator.validate_primary_mode_option(options)
-      @mode = select_primary_mode(options)
+    desc "decrypt KEY", "decrypt keys from consul"
+    method_option :public_key, type: :string, required: true
+    method_option :private_key, type: :string, required: true
+    def decrypt(consul_key)
+      say MuchKeysExecutor.decrypt(consul_key, options[:public_key], options[:private_key])
     end
 
-    def configure_muchkeys(options=@opts)
-      MuchKeys.configure do |config|
-        config.consul_url  = options[:consul_url]
-        config.public_key  = options[:public_key]
-        config.private_key = options[:private_key]
-      end
+    desc "fetch KEY", "fetch plaintext key from consul"
+    def fetch(consul_key)
+      say MuchKeysExecutor.fetch(consul_key)
     end
 
-    # this guy figures out the appropriate action to take given CLI options
-    def run
-
-      check_for_early_exit_actions
-      return if @cli_should_exit
-
-      begin
-        set_primary_mode
-      rescue MuchKeys::CLIOptionsError => e
-        puts e.message
-        puts @opts
-      end
-
-      return if @cli_should_exit
-
-      configure_muchkeys
-
-      if @opts[:encrypt]
-        options = { file: @opts[:file], public_key: @opts[:public_key] }
-        validation = MuchKeys::CLI::Validator.validate_encrypt_options(options)
-
-        if validation.valid?
-          encrypt(@opts[:file], @opts[:public_key])
-        else
-          puts validation.errors
-          return
-        end
-      elsif @opts[:decrypt]
-        options = { consul_key: @opts[:consul_key], public_key: @opts[:public_key], private_key: @opts[:private_key] }
-        validation = MuchKeys::CLI::Validator.validate_decrypt_options(options)
-
-        if validation.valid?
-          decrypt(@opts[:consul_key], @opts[:public_key], @opts[:private_key])
-        else
-          puts validation.errors
-          return
-        end
-      elsif @opts[:plain]
-        options = { consul_key: @opts[:consul_key] }
-        validation = MuchKeys::CLI::Validator.validate_plain_options(options)
-
-        if validation.valid?
-          plain(@opts[:consul_key])
-        else
-          puts validation.errors
-          return
-        end
-      end
-
+    desc "--version", "Print the version"
+    def __version
+      say MuchKeys::VERSION
     end
 
-    def encrypt(file, public_key)
-      string_to_encrypt = File.read(file)
-      puts secret_adapter.encrypt_string(string_to_encrypt, public_key)
-    end
-
-    def decrypt(consul_key, public_key, private_key)
-      puts MuchKeys.fetch_key(consul_key, public_key:public_key, private_key:private_key)
-    end
-
-    def plain(consul_key)
-      puts MuchKeys.fetch_key(consul_key)
-    end
-
-    def print_version_number
-      puts MuchKeys::VERSION
-      @cli_should_exit = true
-    end
+    module MuchKeysExecutor
+      extend self
 
-    def print_help
-      # this is how the slop gem prints help
-      puts @opts
-      @cli_should_exit = true
-    end
-
-
-    private
-    def select_primary_mode(options)
-      possible_primary_modes = { encrypt: options[:encrypt], decrypt: options[:decrypt], plain: options[:plain] }
-      primary_mode = possible_primary_modes.select {|k,v| v == true }  # validation has already happened, we can access modes safely
-      primary_mode.keys.first
-    end
-
-    def secret_adapter
-      MuchKeys::Secret
-    end
+      def encrypt(file, public_key)
+        string_to_encrypt = File.read(file)
+        MuchKeys::Secret.encrypt_string(string_to_encrypt, public_key)
+      end
 
-    def check_for_early_exit_actions
-      if @opts[:help]
-        print_help
+      def decrypt(consul_key, public_key, private_key)
+        MuchKeys.fetch_key(consul_key, public_key: public_key, private_key:private_key)
       end
 
-      if @opts[:version]
-        print_version_number
+      def fetch(consul_key)
+        MuchKeys.fetch_key(consul_key)
       end
     end
-
   end
 end

data/lib/muchkeys/secret.rb

@@ -42,7 +42,6 @@ class MuchKeys::Secret
       OpenSSL::PKCS7.new(val).decrypt(key, cert)
     end
 
-
     private
 
     def read_ssl_key(file_name)

data/lib/muchkeys/version.rb

@@ -1,3 +1,3 @@
 module MuchKeys
-  VERSION = "0.3.7"
+  VERSION = "0.4.0"
 end

data/muchkeys.gemspec

@@ -19,16 +19,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # slop 4 was a rewrite and it breaks a few gems:
-  # guard / pry.  This is sad for development but slop4 is better than slop3.
-  spec.add_runtime_dependency "slop", "~> 4.2"
+  spec.add_runtime_dependency "thor"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.3"
   spec.add_development_dependency "webmock", "~> 1.20"
   spec.add_development_dependency "vcr", "~> 2.9"
-
-  # slop 4 really, really needs this version of pry since they vendored it
-  spec.add_development_dependency "pry", '=0.10.3'
+  spec.add_development_dependency "aruba", "~> 0.14.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: muchkeys
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.0
 platform: ruby
 authors:
 - Pat O'Brien
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -96,19 +96,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.9'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.14.2
 description: MuchKeys can handle app configuration and appsecrets
 email:
 - pobrien@goldstar.com
@@ -120,6 +120,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - Guardfile
@@ -130,8 +131,6 @@ files:
 - exe/muchkeys
 - lib/muchkeys.rb
 - lib/muchkeys/cli.rb
-- lib/muchkeys/cli/validation.rb
-- lib/muchkeys/cli/validator.rb
 - lib/muchkeys/configuration.rb
 - lib/muchkeys/errors.rb
 - lib/muchkeys/key_validator.rb
@@ -158,9 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: MuchKeys fetches keys from the ENV and then falls back to consul
 test_files: []
-has_rdoc: 

data/lib/muchkeys/cli/validation.rb

@@ -1,17 +0,0 @@
-module MuchKeys
-  class CLI
-
-    class Validation
-      attr_accessor :errors
-
-      def initialize
-        @errors = []
-      end
-
-      def valid?
-        errors.length < 1
-      end
-    end
-
-  end
-end

data/lib/muchkeys/cli/validator.rb

@@ -1,66 +0,0 @@
-require_relative "../errors"
-require_relative "./validation"
-
-class MuchKeys::CLI::Validator
-
-    def self.validate_primary_mode_option(options)
-      raise MuchKeys::CLIOptionsError, primary_mode_error_message unless options_has_one_mode?(options)
-    end
-
-    def self.validate_encrypt_options(options)
-      validation = MuchKeys::CLI::Validation.new
-      if !options[:file] || !options[:public_key]
-        validation.errors << "--decrypt needs the --file and --public_key set."
-      end
-
-      validation
-    end
-
-    def self.validate_decrypt_options(options)
-      validation = MuchKeys::CLI::Validation.new
-      if options[:consul_key] && options[:public_key] && options[:private_key]
-        validate_automatic_certificate(validation, options)
-      else
-        validation.errors << "--decrypt needs the --consul_key, --public_key and --private_key set."
-      end
-
-      validation
-    end
-
-    def self.validate_automatic_certificate(chained_validation, options)
-      # i won't mutate chained_validation on principle
-      validation = MuchKeys::CLI::Validation.new
-      validation.errors = chained_validation.errors.dup
-      key_name = options[:consul_key]
-
-      if !secret_adapter.auto_certificates_exist_for_key?(key_name)
-        certfile_expected = secret_adapter.certfile_name(key_name)
-        validation.errors << "--decrypt needs the --public_key option passed or a PEM file needs to be at #{certfile_expected}."  if !options[:public_key]
-        validation.errors << "--decrypt needs the --private_key option passed or a PEM file needs to be at #{certfile_expected}." if !options[:private_key]
-      end
-
-      validation
-    end
-
-    def self.validate_plain_options(options)
-      validation = MuchKeys::CLI::Validation.new
-      if !options[:consul_key]
-        validation.errors << "--plain needs the --consul_key option passed."
-      end
-
-      validation
-    end
-
-    def self.options_has_one_mode?(options)
-      [ options[:encrypt], options[:decrypt], options[:plain] ].count(true) == 1
-    end
-
-    def self.primary_mode_error_message
-      "You must pass only one and at least one of the following flags: --encrypt, --decrypt, or --plain"
-    end
-
-    def self.secret_adapter
-      MuchKeys::Secret
-    end
-
-end