secret_reader 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b179be44afe6f5643971ceaeec09602f929b06c5
+  data.tar.gz: 30d255d8185f762499af309bc9df10db67118d4e
+SHA512:
+  metadata.gz: 13bbe448bf2b138ad65610f9fd3f3b8681af47d11087bdfcddf1bd60ff19e9562910fdb69265fe37cd2c00701776ba5a4a47e1ab2fd988d4f2dd670e21a295dd
+  data.tar.gz: 3adec7e28daedffdac2db6a1e55c9d680b12d9b574f3f5a65623a47ca77cc16e205087c76ae50873f2f3b94aa537802c66e49e49814f60d4b91fced27b6a496b

data/.gitignore

@@ -0,0 +1,2 @@
+.idea/
+Gemfile.lock

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 secret_reader.gemspec
+gemspec

data/README.md

@@ -0,0 +1,40 @@
+# SecretReader
+
+Many secrets of a MOVEX application, i.e. database credentials, are so far stored in environment variables.
+In Docker environment reading those secrets from a file is preferred. 
+
+SecretReader helps to combine both approaches. A secret with a given name is at first attempted to be read as
+an environment variable. Only if not found it is read from a file with the fixed name __/run/secrets/secret__,
+that contains simple pairs of keys and values and is expected to be delivered by the docker engine as a secret.  
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'secret_reader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install secret_reader
+
+## Usage
+
+For instance read the database user for AMOS:
+
+SecretReader::SecretReader.read('AMOS_DBUSER')
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/secret_reader.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "secret_reader"
+
+# 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/lib/secret_reader.rb

@@ -0,0 +1,30 @@
+require 'secret_reader/version'
+require 'yaml'
+
+module SecretReader
+  # SecretReader reads a configuration with a given name.
+  # Configuration is read in following order, first match is returned
+  # 1. Environment variable
+  # 2. Property File
+  class SecretReader
+
+    if ENV['SECRET_FILE_PATH'].nil? || ENV['SECRET_FILE_PATH'].empty?
+      FILENAME = '/run/secrets/secret'
+    else
+      FILENAME = ENV['SECRET_FILE_PATH']
+    end
+
+    def self.read(name)
+      if !ENV[name].nil? && !ENV[name].empty?
+        return ENV[name]
+      end
+
+      if File.exist?(FILENAME)
+        configs = YAML.load(File.open(FILENAME, 'r'))
+        configs[name]
+      else
+        puts "Unable to open file #{FILENAME} "
+      end
+    end
+  end
+end

data/lib/secret_reader/version.rb

@@ -0,0 +1,3 @@
+module SecretReader
+  VERSION = "0.2.0"
+end

data/secret_reader.gemspec

@@ -0,0 +1,25 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "secret_reader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "secret_reader"
+  spec.version       = SecretReader::VERSION
+  spec.authors       = ["tmanig"]
+  spec.email         = ["thomas.manig@ottogroup.com"]
+
+  spec.summary       = "Read Secrets for Configuration from ENV and File"
+  spec.description   = "Read Secrets for Configuration from ENV and File"
+  spec.homepage      = ""
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: secret_reader
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- tmanig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-08 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Read Secrets for Configuration from ENV and File
+email:
+- thomas.manig@ottogroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/secret_reader.rb
+- lib/secret_reader/version.rb
+- secret_reader-0.1.0.gem
+- secret_reader.gemspec
+homepage: ''
+licenses: []
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: Read Secrets for Configuration from ENV and File
+test_files: []