rails-creds 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 497fb39a0aa27697fe83d1d9e67072e4ec36810bfd3eed590ddad0ffc53b7d79
-  data.tar.gz: befd5d2e8f5edde45600a541fd7295460ec2f3ca59963f4c825249c0f45f957f
+  metadata.gz: 869c29c1e36634cdcf8a8ebb845adefec90b04e01ca50f4009dc2b5c994a8d95
+  data.tar.gz: e7df049073d9d67617ab65eebc893734ca29942848483b0afd28e9aa87ecab84
 SHA512:
-  metadata.gz: 5859ffeb2a62357f628370ffc511fd6323d6cbda3ee912512feadae76dfa6468c80e9747ee243bd165a3afba53fe0fd42465485b00cf4ec6bd81508599532dc0
-  data.tar.gz: 366f49854ac673e5ac2ed9249fc296076ba923ba6b6b1184c4888a5d6a9654a2d26656a7d08f57dcb980d8fe697d1a4925bc7ad025515a6914c40eed4dc24777
+  metadata.gz: '01209c664af0dfc8040b7376461a6850f23296ef289ef09fb7a465d06531bde89f46bc33b1380b714e0bb439d43f6c599ed6dc2a6d066499b75fd83d9f77f8dc'
+  data.tar.gz: a06fe617ba442d248fc1c07217b8fdb0f3cdbf88e3efc378660d498dd13cde67637a36e674a20a8eb1a51a7de778af6b5121c1c55eb31fa3d99f607b6b751cdd

data/.rubocop.yml

@@ -5,3 +5,6 @@ AllCops:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
+
+Style/MethodMissingSuper:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# 0.2.0
+
+Changed:
+
+  - Creds will now warn about missing credentials when the encrypted file isn't
+    found. It will afterwards be a Null Object and return `nil` on every key.
+  - When encrypted credentials are found but the master key file AND env
+    variable is missing, Creds will return a special error with explanation.
+
+# 0.1.0
+
+Initial version

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    creds (0.1.0)
+    rails-creds (0.2.0)
       rails (~> 5.2)
 
 GEM
@@ -57,7 +57,7 @@ GEM
     erubi (1.7.1)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
-    i18n (1.0.0)
+    i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     loofah (2.2.2)
       crass (~> 1.0.2)
@@ -71,14 +71,14 @@ GEM
     mini_mime (1.0.0)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
-    nio4r (2.3.0)
+    nio4r (2.3.1)
     nokogiri (1.8.2)
       mini_portile2 (~> 2.3.0)
     parallel (1.12.1)
     parser (2.5.0.5)
       ast (~> 2.4.0)
     powerpack (0.1.1)
-    rack (2.0.4)
+    rack (2.0.5)
     rack-test (1.0.0)
       rack (>= 1.0, < 3)
     rails (5.2.0)
@@ -149,7 +149,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
-  creds!
+  rails-creds!
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop (~> 0.54)

data/README.md

@@ -1,5 +1,7 @@
 <h1><img src='https://s3.brnbw.com/logo-2x-SiurkO6hTL.png' alt='' width='220' /></h1>
 
+[![Build Status](https://travis-ci.org/mikker/rails-creds.svg?branch=master)](https://travis-ci.org/mikker/rails-creds) [![Gem version](https://img.shields.io/gem/v/rails-creds.svg)](https://rubygems.org/gems/rails-creds)
+
 `Creds` is both **a)** a shortcut for the dreadfully long `Rails.application.credentials` and **b)** bringing environment scoping back (from when it was called _secrets_).
 
 ## Usage

data/lib/creds.rb

@@ -1,66 +1,69 @@
 # frozen_string_literal: true
 
-require 'creds/version'
-require 'ostruct'
-require 'singleton'
-
 require 'rails'
 
-# The main module
-class Creds
-  class MissingKeyError < StandardError
-    MESSAGE = 'Key :%<key>s missing from credentials in "%<env>s" env'.freeze
-  end
-
-  class MissingEnvError < StandardError
-    # rubocop:disable Layout/TrailingWhitespace
-    MESSAGE = <<-MSG
-  Creds scopes credentials to the current Rails environment.
-  It seems you are missing a scope for the environment "%<env>s".
-
-  Here's an example of how your credentials could look:
+require 'creds/version'
+require 'creds/errors'
 
-  ---
-  default: &default
-    aws_key: 'shared between environments'
+# The main module of rails-creds
+class Creds
+  include Singleton
 
-  development:
-    <<: *default
+  # Credentials that are always nil
+  class NullCredentials
+    def respond_to_missing?(_name)
+      true
+    end
 
-  test:
-    <<: *default
+    def method_missing(*_args)
+      nil
+    end
 
-  production:
-    <<: *default
-    aws_key: 'you can override defaults for individual environments'
-  MSG
-              .strip_heredoc.freeze
-    # rubocop:enable Layout/TrailingWhitespace
+    def nil?
+      true
+    end
   end
 
-  include Singleton
+  def self.respond_to_missing?(_name)
+    true
+  end
 
-  # rubocop:disable Style/MethodMissing
   def self.method_missing(name, *_args)
     instance.credentials.fetch(name)
   rescue KeyError
-    raise(
-      MissingKeyError,
-      format(MissingKeyError::MESSAGE, key: name, env: Rails.env)
-    )
+    raise MissingKeyError.new(name, Rails.env)
   end
-  # rubocop:enable Style/MethodMissing
 
   def self.to_h
     instance.credentials
   end
 
   def credentials
+    unless encrypted_credentials_exist?
+      Rails.logger.warn MissingCredentialsWarning
+      return NullCredentials.new
+    end
+
+    raise MissingMasterKeyError unless master_key_present?
+
+    fetch_credentials_for_current_env
+  end
+
+  private
+
+  def fetch_credentials_for_current_env
     Rails.application.credentials.fetch(Rails.env.to_sym)
   rescue KeyError
-    raise(
-      MissingEnvError,
-      format(MissingEnvError::MESSAGE, env: Rails.env)
-    )
+    raise MissingEnvError, Rails.env
+  end
+
+  def encrypted_credentials_exist?
+    File.exist? Rails.root.join('config', 'credentials.yml.enc')
+  end
+
+  def master_key_present?
+    return true if ENV['RAILS_MASTER_KEY']
+    return true if File.exist?(Rails.root.join('config', 'master.key'))
+    false
   end
 end

data/lib/creds/errors.rb

@@ -0,0 +1,69 @@
+class Creds
+  class MissingCredentialsWarning
+    MESSAGE =
+      <<-MSG
+      You have no encrypted credentials at config/credentials.yml.enc.
+      Creds will return nil for any key.
+      Run this to generate your credentials file:
+        $ bin/rails credentials:edit
+        MSG
+      .strip_heredoc.freeze
+  end
+
+  # @api private
+  class MissingKeyError < StandardError
+    MESSAGE = 'Key :%<key>s missing from credentials in "%<env>s" env'.freeze
+
+    def initialize(key, env)
+      super format(MESSAGE, key: key, env: env)
+    end
+  end
+
+  # @api private
+  class MissingEnvError < StandardError
+    # rubocop:disable Layout/TrailingWhitespace
+    MESSAGE =
+      <<-MSG
+  Creds scopes credentials to the current Rails environment.
+  It seems you are missing a scope for the environment "%<env>s".
+
+  Here's an example of how your credentials could look:
+
+  ---
+  default: &default
+    aws_key: 'shared between environments'
+  
+  development:
+    <<: *default
+  
+  test:
+    <<: *default
+  
+  production:
+    <<: *default
+    aws_key: 'you can override defaults for individual environments'
+      MSG
+      .strip_heredoc.freeze
+    # rubocop:enable Layout/TrailingWhitespace
+
+    def initialize(env)
+      super format(MESSAGE, env: env)
+    end
+  end
+
+  # @api private
+  class MissingMasterKeyError < StandardError
+    MESSAGE =
+      <<-MSG
+        You have encrypted credentials but no master key.
+
+        Either get or recover the file config/master.key
+        or set the environment variable RAILS_MASTER_KEY
+      MSG
+      .strip_heredoc.freeze
+
+    def initalize
+      super(MESSAGE)
+    end
+  end
+end

data/lib/creds/version.rb

@@ -1,3 +1,3 @@
 class Creds
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-creds
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mikkel Malmberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2018-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -91,6 +91,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -100,6 +101,7 @@ files:
 - config/master.key
 - creds.gemspec
 - lib/creds.rb
+- lib/creds/errors.rb
 - lib/creds/version.rb
 - lib/rails-creds.rb
 homepage: https://github.com/mikker/rails-creds