nuclear_secrets 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57e88636b13f8f0b1e9697a6dc9621f9a3d2a8ba
-  data.tar.gz: 823b10f98e3078d78fea563e33455ea03ce188b6
+  metadata.gz: 175b07894161bdae17411c570da95b2378fb64a8
+  data.tar.gz: ed3c759584c3e898ecf93461df2a6705c1d76368
 SHA512:
-  metadata.gz: c48b0e1421e051ab3d687acf119ae42e315ee7b9cc83034a6c189a797dca4e94cc6aba3aafa75aedf3631b6194f11154b3f8ffd6f496dd9162b5479e36c097e8
-  data.tar.gz: 725ad3b2597c8b97e2e3fe0ad231afc8c47a801ef89abe59938e3f25abd4c7e3c9e20d82adc2cb13f3729261440aa18aef0eadbcb10bcb1e6e17bfdc206bfec7
+  metadata.gz: 9e57fb6daf72613508d0008fe2a20a3a5f2109856b61a840fa764d5f62c10fb15d2274d153b52d94e90aaf54bff78b3b18e0df1e1a1a42b201ff705155c140ab
+  data.tar.gz: 1c71339468af3cc4f234991b9e6a7d4fdf5fa863c67eadb99ae9fc419413c64e784684aefb5e5ed2aaf8c327d4b1e9c87b50501c610cac72948148f7da4b6f4b

data/README.md

@@ -1,4 +1,4 @@
-# NuclearSecrets
+# Nuclear Secrets
 Quell rails secret espionage by verifying what secrets exist and their types in your rails application
 
 ## Usage
@@ -30,6 +30,21 @@ end
 ```
 Include all secrets that your application utilizes, and their types, in `required_secrets` hash
 
+## Advanced Usage
+In addition to being able to supply NuclearSecrets with the type of a secret,
+you can also pass a Proc or a Lambda. If the proc or lamba returns true when
+passed the value of the secret, then the secret will be allowed.
+
+```
+NuclearSecrets.configure do |config|
+  config.required_secrets = {
+    my_string_secret: String,
+    my_numeric_secret: Fixnum,
+    my_secret: Proc.new { |secret| secret.is_worthy? }
+  }
+end
+```
+
 ## Contributing
 Contribution directions go here.
 

data/lib/nuclear_secrets.rb

@@ -1,61 +1,78 @@
 require "nuclear_secrets/engine"
+require "nuclear_secrets/errors"
 
 module NuclearSecrets
-  class NuclearSecretError < StandardError
-    def initialize(secrets: [])
-      @secrets = secrets
-    end
-
-    def get_error_list
-      @secrets.reduce("") do |message, current|
-        message << "#{current.first} of type #{current.last} \n"
-      end
-    end
-  end
+  class << self
+    attr_accessor(:required_secrets)
 
-  class RequiredSecretsListMissing < NuclearSecretError
-    def message
-      "You must include a required_secrets key in your config/secrets.yml file"
+    def configure
+      yield self if block_given?
     end
-  end
 
-  class SecretsMissingError < NuclearSecretError
-    def initialize(secrets)
-      super(secrets: secrets)
+    def make_type_check(type)
+      Proc.new { |item| item.class == type }
     end
 
-    def message
-      "Missing secrets: \n#{get_error_list}"
+    # secrets: hash of given secrets
+    # required_values: hash of required secrets
+    # key: key to build tuple for
+    # returns [key, required_type, given_type]
+    def build_secret_tuple(secrets, required_values, key)
+      [key, required_values[key], secrets[key]]
     end
-  end
 
-  class ExtraSecretsError < NuclearSecretError
-    def initialize(secrets)
-      super(secrets: secrets)
+    def build_pairs(keys, secrets)
+      keys.map do |k|
+        build_secret_tuple(secrets, required_secrets, k)
+      end
     end
 
-    def message
-      "Secrets not included in required_secrets list: \n#{get_error_list}"
+    def build_assertions(secrets, existing_keys)
+      existing_keys.map do |key|
+        if required_secrets[key].class == Class
+          make_type_check(required_secrets[key])
+        elsif required_secrets[key].respond_to? :call
+          required_secrets[key]
+        else
+          raise NuclearSecrets::InvalidRequiredSecretValue.new(
+            [
+              build_secret_tuple(secrets, required_secrets, key),
+            ],
+          )
+        end
+      end
     end
-  end
-
-  class << self
-    attr_accessor(:required_secrets)
 
-    def configure
-      yield self if block_given?
+    def check_assertions(secrets, assertions)
+      secrets.to_a.zip(assertions).select do |pair|
+        result = pair.last.call(pair.first[1])
+        if !result
+          pair.first[0]
+        else
+          false
+        end
+      end.map do |pair|
+        flat_pair = pair.flatten
+        build_secret_tuple(secrets, required_secrets, flat_pair.first)
+      end
     end
 
     def check_secrets(secrets)
       raise NuclearSecrets::RequiredSecretsListMissing if required_secrets.nil?
-      req_secret_pairs = required_secrets.map { |pair| [pair.first.to_sym, pair.last.to_s] }
-      types = secrets.map { |pair| [pair.first, pair.last.class.to_s] }
+      req_keys = required_secrets.keys
+      existing_keys = secrets.keys
+
+      missing_keys = req_keys - existing_keys
+      extra_keys = existing_keys - req_keys
 
-      missing_secrets = req_secret_pairs - types
-      extra_secrets = types - req_secret_pairs
+      missing_pairs = build_pairs(missing_keys, secrets)
+      extra_pairs = build_pairs(extra_keys, secrets)
+      raise SecretsMissingError.new(missing_pairs) unless missing_keys.empty?
+      raise ExtraSecretsError.new(extra_pairs) unless extra_keys.empty?
 
-      raise SecretsMissingError.new(missing_secrets) unless missing_secrets.empty?
-      raise ExtraSecretsError.new(extra_secrets) unless extra_secrets.empty?
+      assertions = build_assertions(secrets, existing_keys)
+      error_pairs = check_assertions(secrets, assertions)
+      raise MismatchedSecretType.new(error_pairs) if !error_pairs.empty?
     end
   end
 end

data/lib/nuclear_secrets/errors.rb

@@ -0,0 +1,84 @@
+module NuclearSecrets
+  class NuclearSecretError < StandardError
+    def initialize(secrets: [])
+      @secrets = secrets
+    end
+
+    def required_type_message(req_type)
+      if req_type.nil?
+        " of value nil"
+      elsif req_type.class == Class
+        " of type #{req_type}"
+      elsif req_type.class == Proc
+        source_pair = req_type.source_location
+        " of type Proc (defined in file: #{source_pair.first}, line: #{source_pair.last})"
+      else
+        " of value #{req_type}"
+      end
+    end
+
+    def given_type_message(given_type)
+      if given_type.nil?
+        "\n"
+      elsif given_type.class == String
+        " was given \"#{given_type}\"\n"
+      else
+        " was given #{given_type}\n"
+      end
+    end
+
+    def get_error_list
+      @secrets.reduce("") do |message, current|
+        message << current.first.to_s
+        message << required_type_message(current[1])
+        message << given_type_message(current.last)
+      end
+    end
+  end
+
+  class RequiredSecretsListMissing < NuclearSecretError
+    def message
+      "You must include a NuclearSecrets initializer in your app"
+    end
+  end
+
+  class SecretsMissingError < NuclearSecretError
+    def initialize(secrets)
+      super(secrets: secrets)
+    end
+
+    def message
+      "You are not using a secret that is required in the secrets list: \n#{get_error_list}"
+    end
+  end
+
+  class ExtraSecretsError < NuclearSecretError
+    def initialize(secrets)
+      super(secrets: secrets)
+    end
+
+    def message
+      "You have used a secret that is not in included in the secrets list: \n#{get_error_list}"
+    end
+  end
+
+  class InvalidRequiredSecretValue < NuclearSecretError
+    def initialize(secrets)
+      super(secrets: secrets)
+    end
+
+    def message
+      "You used an invalid secret: \n#{get_error_list}"
+    end
+  end
+
+  class MismatchedSecretType < NuclearSecretError
+    def initialize(secrets)
+      super(secrets: secrets)
+    end
+
+    def message
+      "You included a secret of the wrong type: \n#{get_error_list}"
+    end
+  end
+end

data/lib/nuclear_secrets/version.rb

@@ -1,3 +1,3 @@
 module NuclearSecrets
-  VERSION = "1.0.1".freeze
+  VERSION = "1.0.2".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nuclear_secrets
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Atomic Jolt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2017-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,7 @@ files:
 - config/initializers/nuclear_secrets.rb
 - lib/nuclear_secrets.rb
 - lib/nuclear_secrets/engine.rb
+- lib/nuclear_secrets/errors.rb
 - lib/nuclear_secrets/version.rb
 homepage: https://github.com/atomicjolt/NuclearSecrets
 licenses:
@@ -73,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Quell rails secret espionage by verifying what secrets exist and their types