creds 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 586a8999485b4530fe262e7779b739821f68949d815ae68e0f2021651b636f29
+  data.tar.gz: cd2181a15b91c0e6a79ebbdd8acf2d52a79a97773638b3c8a42d5395c4b5a327
+SHA512:
+  metadata.gz: ad21fecefc0484a84113c27394f761c3c0bceceaf718fb3f2069f575015e07e72c4ef4146d2b7e3c55a2e9e923615fe377ba24a4dd09b095260d16cb1bb25127
+  data.tar.gz: 4f059e592baca5be3fcb5ea7edc5ffbd9f850ee3a1fd2fd0619e7a28b1119a548c85a0812ae866168482c4869589d4ffaff30255196bcc894609e670ec311f84

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler
+notifications:
+  disabled: true
+script:
+  - bundle exec rake test

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in creds.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    creds (0.2.0)
+      activesupport (>= 5.2.0.rc2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0.rc2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (12.3.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.16)
+  creds!
+  minitest (>= 5.0)
+  rake (>= 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Wojciech Wnętrzak
+
+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,63 @@
+# Creds
+
+Manage encrypted credentials (added in Rails 5.2.0) with multiple environments.
+
+## Installation
+
+Available as a gem [`creds`](https://rubygems.org/gems/creds)
+
+## Usage
+
+Using Rails command, generate new encrypted file by
+```
+bin/rails encrypted:edit config/credentials-production.yml.enc --key config/master-production.key
+```
+If `config/master-production.key` doesn't exist yet, run `bin/rails generate master_key` and adjust naming to match desired one.
+Content of file can be displayed by
+```
+bin/rails encrypted:show config/credentials-production.yml.enc --key config/master-production.key
+```
+
+Add to `config/environments/production.rb` (or any other env)
+```ruby
+config.creds = Creds.new("config/credentials-production.yml.enc")
+```
+
+In the code:
+```ruby
+Rails.configuration.creds.aws_access_key_id
+```
+
+To ease working in development/test environments with the same API, add `config/credentials-plain.yml` with key/value pairs
+nested under environment name, like:
+```yml
+development:
+  aws_access_key_id: "aws-key-id"
+```
+
+Then add to `config/environments/development.rb`
+```ruby
+config.creds = Creds.new("config/credentials-plain.yml", env: "development")
+```
+
+### Additions
+
+* To raise error in case of missing key you can add bang to the name, like `Rails.configuration.creds.database_url!`
+* To list all defined key/value pairs call `config`, like `Rails.configuration.creds.config`
+* If `secret_key_base` is specified in credentials file, it will be assigned to `Rails.configuration.secret_key_base`, as it is required by Rails
+
+## Development
+
+[![Build Status](https://travis-ci.org/freeletics/creds.svg?branch=master)](https://travis-ci.org/freeletics/creds)
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/freeletics/creds
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "creds"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/creds.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "creds/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "creds"
+  spec.version       = Creds::VERSION
+  spec.authors       = ["Wojciech Wnętrzak"]
+  spec.email         = ["w.wnetrzak@gmail.com", "eng@freeletics.com"]
+
+  spec.summary       = %q{Encrypted Credentials for multiple environments}
+  spec.description   = %q{Unified interface for encrypted credentials and plain text file based}
+  spec.homepage      = "https://github.com/freeletics/creds"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.2.0.rc2"
+
+  spec.add_development_dependency "bundler", ">= 1.16"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "minitest", ">= 5.0"
+end

data/lib/creds.rb

@@ -0,0 +1,33 @@
+require "creds/version"
+require "creds/plain_configuration"
+
+require "active_support/core_ext/module/attribute_accessors" # https://github.com/rails/rails/pull/32383
+require "active_support/core_ext/module/delegation"
+require "active_support/encrypted_configuration"
+
+require "creds/railtie" if defined?(Rails)
+
+class Creds
+  delegate_missing_to :configuration
+
+  def initialize(file_path, key_path: "config/master.key", env_key: "RAILS_MASTER_KEY", raise_if_missing_key: true, env: nil)
+    @file_path            = file_path
+    @key_path             = key_path
+    @env_key              = env_key
+    @raise_if_missing_key = raise_if_missing_key
+    @env                  = env
+  end
+
+  def configuration
+    @configuration ||= if @file_path.end_with?(".enc")
+      ActiveSupport::EncryptedConfiguration.new(
+        config_path: @file_path,
+        key_path: @key_path,
+        env_key: @env_key,
+        raise_if_missing_key: @raise_if_missing_key
+      )
+    else
+      Creds::PlainConfiguration.new(@file_path, env: @env)
+    end
+  end
+end

data/lib/creds/plain_configuration.rb

@@ -0,0 +1,26 @@
+# Based on http://api.rubyonrails.org/classes/Rails/Application.html#method-i-config_for
+require "yaml"
+require "erb"
+require "pathname"
+require "active_support/core_ext/hash/keys"
+require "active_support/ordered_options"
+require "active_support/core_ext/module/delegation"
+
+class Creds::PlainConfiguration
+  delegate_missing_to :options
+
+  def initialize(file_path, env:)
+    @file = Pathname.new(file_path)
+    @env = env
+  end
+
+  def config
+    @config ||= (YAML.load(ERB.new(@file.read).result) || {}).fetch(@env, {}).deep_symbolize_keys
+  end
+
+  private
+
+  def options
+    @options ||= ActiveSupport::InheritableOptions.new(config)
+  end
+end

data/lib/creds/railtie.rb

@@ -0,0 +1,12 @@
+require "rails/railtie"
+
+class Creds::Railtie < Rails::Railtie
+  # Secret key base is required in Rails.
+  # By default it is taken from one of: env variable, credentials or secrets with fallback
+  # to config which is set here if present.
+  initializer "creds.set_secret_key_base", before: :load_config_initializers do
+    if config.respond_to?(:creds) && config.creds.secret_key_base
+      Rails.configuration.secret_key_base ||= config.creds.secret_key_base
+    end
+  end
+end

data/lib/creds/version.rb

@@ -0,0 +1,3 @@
+class Creds
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: creds
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Wojciech Wnętrzak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0.rc2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Unified interface for encrypted credentials and plain text file based
+email:
+- w.wnetrzak@gmail.com
+- eng@freeletics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- creds.gemspec
+- lib/creds.rb
+- lib/creds/plain_configuration.rb
+- lib/creds/railtie.rb
+- lib/creds/version.rb
+homepage: https://github.com/freeletics/creds
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Encrypted Credentials for multiple environments
+test_files: []