rails-env-credentials 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d78adffc34dff2155539ea82f80c48473b7bc7a6eb727cc2eb9f80e980a1fd69
-  data.tar.gz: d0b9157de3b987a3ed45167790205c1a843f7b49fcfd05e5d8fb693346848b7f
+  metadata.gz: b00045c815c0c178127b86ff25286eeeb749ab09bae4a622afba98e717613ee5
+  data.tar.gz: 86783e049e9a8a65ca9cf26c904a8eaf4b7bc91ff5b2793972f9c978efc3d988
 SHA512:
-  metadata.gz: d4aa859a411576964f9663d8207404e238cc5c85620396a0622bb6b76957978b7c7ffe8959e8077fe1eb3be3150e24c4f3ef490f720dd90a7a45e832d3fd6799
-  data.tar.gz: 2bc47ca19aa56f05e25b6791cd2b027888f238174900c67bc6b93f2472ce16cf4ba2ff329323c9c2080d59a4186a6cfd4a78aac292e961be6b3027e7edc4487a
+  metadata.gz: feec5ed1204093d7861abe7e3862ced93c1a776234b710c905d717a5c2153dcc84dba1f0e695f1b6e3056f925c5f25b08e17f0b403c0f5dacd51c9195e16cdaa
+  data.tar.gz: 66d272c94707a1d032a256cc2a25ca6c013157365561a0b3285106a9c60ce2cef770c8e5a80b615199baf2fb9de341d3fadbedd610fe29fd553eacd5eb3f9f26

data/.github/workflows/main.yml

@@ -0,0 +1,31 @@
+name: Ruby
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+        gemfile:
+          - rails_52
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

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

data/README.md

@@ -1,26 +1,10 @@
 [![Gem Version](https://badge.fury.io/rb/rails-env-credentials.svg)](https://badge.fury.io/rb/rails-env-credentials)
-[![Build Status](https://travis-ci.org/sinsoku/rails-env-credentials.svg?branch=master)](https://travis-ci.org/sinsoku/rails-env-credentials)
+[![Ruby](https://github.com/sinsoku/rails-env-credentials/actions/workflows/main.yml/badge.svg)](https://github.com/sinsoku/rails-env-credentials/actions/workflows/main.yml)
 
 # RailsEnvCredentials
 
 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,55 @@ $ 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
+```
+
+It also manages environment variables for each env.
+
+```
+RAILS_MASTER_KEY_DEVELOPMENT
+RAILS_MASTER_KEY_TEST
+RAILS_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 +81,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 +105,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.
@@ -91,4 +135,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rails::Env::Credentials project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sinsoku/rails-env-credentials/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rails::Env::Credentials project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sinsoku/rails-env-credentials/blob/main/CODE_OF_CONDUCT.md).

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/railtie.rb

@@ -1,9 +1,18 @@
 # frozen_string_literal: true
 
 module RailsEnvCredentials
+  module CredentialsOverwrite
+    def credentials
+      @credentials ||= RailsEnvCredentials.credentials
+    end
+  end
+
   class Railtie < ::Rails::Railtie
-    initializer 'rails-env-credentials' do
-      is_credentials_command = Rails::Command.const_defined?(:CredentialsCommand) && !Rails::Command.const_defined?(:EnvCredentialsCommand)
+    config.before_configuration do
+      is_credentials_command = Rails.const_defined?(:Command) &&
+        Rails::Command.const_defined?(:CredentialsCommand) &&
+        !Rails::Command.const_defined?(:EnvCredentialsCommand)
+
       Rails::Application.prepend(CredentialsOverwrite) unless is_credentials_command
     end
   end

data/lib/rails_env_credentials/version.rb

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

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"
 
@@ -26,7 +25,7 @@ module RailsEnvCredentials
     end
 
     def credentials
-      ActiveSupport::EncryptedConfiguration.new(options)
+      ActiveSupport::EncryptedConfiguration.new(**options)
     end
   end
 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.1
+  version: 0.1.5
 platform: ruby
 authors:
 - sinsoku
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-02-10 00:00:00.000000000 Z
+date: 2021-09-26 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
@@ -87,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -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
@@ -114,7 +114,7 @@ homepage: https://github.com/sinsoku/rails-env-credentials
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,9 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: It enhances the credentials configuration introduced by Rails v5.2.0
 test_files: []

data/.travis.yml

@@ -1,19 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.0
-  - 2.4.2
-  - ruby-head
-gemfile:
-  - Gemfile
-  - gemfiles/rails_edge.gemfile
-matrix:
-  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/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