rails-env-credentials 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff8e93cc13d8dbc2879268b9387e84e4204cf37933d33286de1a4388ae49d416
-  data.tar.gz: 95dcc000417251e220a997e1c7c70fada09f64761e06def1f80a906fe6582188
+  metadata.gz: 7f9a2c3494b0a68a461f7d60931e994b303dbff851004365adf2d4d1ea70ceca
+  data.tar.gz: 8329cb9beef080f6811a989136c26034a63bc5e702c806507cd3da349700c339
 SHA512:
-  metadata.gz: 9c7e87b48c6327d9e11db23a83380bdd9f10988f9780170ba285feebc8162b77444c254b5d65b351228b2741835dbd25dbe0dcce685a2516e6e3288040680af5
-  data.tar.gz: ccaf140230e8ddf441c0a86b9b50ee21ca957aed569691803be88297e73c9b138e1bd2b2437137fa4a0b651896b5d8f5aace06366536ae3c16a736088cc3536c
+  metadata.gz: 9e89fc46f511cc717e0a7f1ddf6f20a6d4c0f134874e33e8c96338100289e61fbfab5c899c58d37e7246514e2af8877ec9d41e25128ed44dfd7f49e167782a0e
+  data.tar.gz: 7f3f223e5a1ee75825b1f0208d438021279111a00554dc6a858dbd820c8f8e10ae6d750f19c35b0a1834f7ef7a126b023c2fd2a1d8dced9e254fae71fe301fe3

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 
 Gemfile.lock
+gemfiles/*.lock

data/.travis.yml

@@ -1,19 +1,27 @@
 sudo: false
 language: ruby
+
 rvm:
-  - 2.5.0
-  - 2.4.2
+  - 2.4
+  - 2.5
+  - 2.6
   - ruby-head
+
 gemfile:
-  - Gemfile
+  - gemfiles/rails_52.gemfile
   - gemfiles/rails_edge.gemfile
+
+before_install:
+  - gem update --system
+  - gem update bundler
+
+cache: bundler
+
 matrix:
+  exclude:
+    - rvm: 2.4
+      gemfile: gemfiles/rails_edge.gemfile
+
   allow_failures:
     - rvm: ruby-head
     - gemfile: gemfiles/rails_edge.gemfile
-before_install: gem install bundler -v 1.16.1
-cache: bundler
-notifications:
-  email:
-    on_success: never
-    on_failure: change

data/README.md

@@ -5,22 +5,6 @@
 
 It enhances the Credentials feature introduced by Rails v5.2.0.
 
-## Why make it?
-
-Credentials is a good feature, but we cannot use it on development and test environment.
-
-DHH wrote as follow in the pull request for initial implementation:
-
-> It's only in production (and derivative environments, like exposed betas) where the secret actually needs to be secret.
->
-> refs: https://github.com/rails/rails/pull/30067
-
-However, I have to manage secrets in the staging environment.
-
-I do not have the confidence to explain explicit use cases to Rails team, so I implemented as a gem.
-
-If many people use it, I would like to send a pull request to Rails.:octocat::heart:
-
 ## Installation
 
 Add this line to your Rails application's Gemfile:
@@ -39,13 +23,47 @@ $ bundle
 
 ## Usage
 
-RailsEnvCredentials will automatically generate encrypted file and the master key when you starts editing credentials at first:
+RailsEnvCredentials manages credentials and key pairs with the following:
+
+```
+config/credentials-development.yml.enc
+config/credentials-test.yml.enc
+config/credentials.yml.enc
+master-development.key
+master-test.key
+master.key
+```
+
+You can use appropriate credentials depending on `Rails.env`.
+
+```console
+$ rails env_credentials:show -e development
+# config/credentials-development.yml.enc
+aws:
+  bucket: foo-dev
+
+$ rails env_credentials:show -e production
+# config/credentials.yml.enc
+aws:
+  bucket: foo-prod
+
+$ rails runner -e development 'pp Rails.application.credentials.aws.bucket'
+"foo-dev"
+$ rails runner -e production 'pp Rails.application.credentials.aws.bucket'
+"foo-prod"
+```
+
+## Generating secrets and a master key
+
+It automatically generate encrypted file and the master key when you starts editing credentials at first:
 
 ```
 $ rails env_credentials:edit -e development
 ```
 
-If you want to see decrypted contents, use `env_credentials:show`
+## Show secrets
+
+You want to see decrypted contents, use `env_credentials:show`:
 
 ```
 $ rails env_credentials:show -e development
@@ -55,7 +73,11 @@ $ rails env_credentials:show -e development
 
 ### Other environments support
 
-For example, if the `config/environments/staging.rb` exists, RailsEnvCredentials will automatically generate `config/credentials-staging.yml.enc`.
+For example, if the `config/environments/staging.rb` exists, you will generate `config/credentials-staging.yml.enc`.
+
+```
+$ rails env_credentials:edit -e staging
+```
 
 ### Display a diff
 
@@ -75,6 +97,20 @@ $ git config diff.env_credentials.textconv 'rails env_credentials:show --file'
 
 This tells Git that encrypted files should decrypt by the `env_credentials:show` task when you try to display a diff.
 
+## Why make this gem?
+
+Credentials is a good feature, but we cannot use it on development and test environment.
+
+DHH wrote as follow in the pull request for initial implementation:
+
+> It's only in production (and derivative environments, like exposed betas) where the secret actually needs to be secret.
+>
+> refs: https://github.com/rails/rails/pull/30067
+
+However, I have to manage secrets and a master key different from production for testing in the staging environment.
+
+I do not have the confidence to explain explicit use cases to Rails team, so I implemented as a gem.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "rails/env/credentials"
+require "rails-env-credentials"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/gemfiles/rails_52.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+
+gemspec path: ".."

data/lib/rails_env_credentials.rb

@@ -2,7 +2,6 @@
 
 require "rails"
 require "rails_env_credentials/config"
-require "rails_env_credentials/credentials_overwrite"
 require "rails_env_credentials/railtie"
 require "rails_env_credentials/version"
 

data/lib/rails_env_credentials/railtie.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 module RailsEnvCredentials
+  module CredentialsOverwrite
+    def credentials
+      @credentials ||= RailsEnvCredentials.credentials
+    end
+  end
+
   class Railtie < ::Rails::Railtie
     config.before_configuration do
       is_credentials_command = Rails.const_defined?(:Command) &&

data/lib/rails_env_credentials/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsEnvCredentials
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/rails-env-credentials.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rails", ">= 5.2.0.rc1"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "simplecov"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-env-credentials
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - sinsoku
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-25 00:00:00.000000000 Z
+date: 2019-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -101,12 +101,12 @@ files:
 - config/environments/production.rb
 - config/environments/staging.rb
 - config/environments/test.rb
+- gemfiles/rails_52.gemfile
 - gemfiles/rails_edge.gemfile
 - lib/rails-env-credentials.rb
 - lib/rails/commands/env_credentials_command.rb
 - lib/rails_env_credentials.rb
 - lib/rails_env_credentials/config.rb
-- lib/rails_env_credentials/credentials_overwrite.rb
 - lib/rails_env_credentials/railtie.rb
 - lib/rails_env_credentials/version.rb
 - rails-env-credentials.gemspec
@@ -129,8 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: It enhances the credentials configuration introduced by Rails v5.2.0

data/lib/rails_env_credentials/credentials_overwrite.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module RailsEnvCredentials
-  module CredentialsOverwrite
-    def credentials
-      @credentials ||= RailsEnvCredentials.credentials
-    end
-  end
-end