nuclear_secrets 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e6143ce94a195360d3b2574234b667df27c026a
+  data.tar.gz: ec0e4d6a79022de8341f61b10a922ae11c071307
+SHA512:
+  metadata.gz: 95eb9e5a7034fcb774df6df36fdb281c3f7fafc640e7e5b8fd035d0c4b48eeb4d1b1d2b5b353c4f496fd997e3e3481fc060346163a6618db05ddde09dcf5c123
+  data.tar.gz: ecab8f9d5e067b069f1f910f42f77cc77d3524b7a52154c1fa6f34d8a4c2d83c51e10464f7bf1a6f968bf457389bd781dd5d62bb38d615b2e5717162b628b479

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Nick Benoit
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# NuclearSecrets
+Quell rails secret espionage by verifying what secrets exist and their types in your rails application
+
+## Usage
+Record all application secrets and their appropriate types in Nuclear Secrets initializer.
+If your application loads secrets that are not recorded, or your app does not load a
+required secret, your rails app will crash and inform you of what missing or extra
+secrets exist.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nuclear_secrets'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Add initializer to your rails application at `config/initializers/nuclear_secrets.rb`
+```ruby
+NuclearSecrets.configure do |config|
+  config.required_secrets = {
+    my_string_secret: String,
+    my_numeric_secret: Fixnum,
+  }
+end
+```
+Include all secrets that your application utilizes, and their types, in `required_secrets` hash
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NuclearSecrets'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/config/initializers/nuclear_secrets.rb

@@ -0,0 +1,7 @@
+module NuclearSecrets
+  class Application < Rails::Application
+    config.after_initialize do
+      NuclearSecrets::check_secrets(Rails.application.secrets)
+    end
+  end
+end

data/lib/nuclear_secrets.rb

@@ -0,0 +1,61 @@
+require "nuclear_secrets/engine"
+
+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 RequiredSecretsListMissing < NuclearSecretError
+    def message
+      "You must include a required_secrets key in your config/secrets.yml file"
+    end
+  end
+
+  class SecretsMissingError < NuclearSecretError
+    def initialize(secrets)
+      super(secrets: secrets)
+    end
+
+    def message
+      "Missing secrets: \n#{get_error_list}"
+    end
+  end
+
+  class ExtraSecretsError < NuclearSecretError
+    def initialize(secrets)
+      super(secrets: secrets)
+    end
+
+    def message
+      "Secrets not included in required_secrets list: \n#{get_error_list}"
+    end
+  end
+
+  class << self
+    attr_accessor(:required_secrets)
+
+    def configure
+      yield self if block_given?
+    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] }
+
+      missing_secrets = req_secret_pairs - types
+      extra_secrets = types - req_secret_pairs
+
+      raise SecretsMissingError.new(missing_secrets) unless missing_secrets.empty?
+      raise ExtraSecretsError.new(extra_secrets) unless extra_secrets.empty?
+    end
+  end
+end

data/lib/nuclear_secrets/engine.rb

@@ -0,0 +1,5 @@
+module NuclearSecrets
+  class Engine < ::Rails::Engine
+    isolate_namespace NuclearSecrets
+  end
+end

data/lib/nuclear_secrets/version.rb

@@ -0,0 +1,3 @@
+module NuclearSecrets
+  VERSION = "1.0.0".freeze
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: nuclear_secrets
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Atomic Jolt
+- Nick Benoit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails secrets checker
+email:
+- nick.benoit14@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- config/initializers/nuclear_secrets.rb
+- lib/nuclear_secrets.rb
+- lib/nuclear_secrets/engine.rb
+- lib/nuclear_secrets/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Quell rails secret espionage by verifying what secrets exist and their types
+  in your rails application
+test_files: []