encrypted_settings 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8b0b2a65890a02884e727f8dce6fbba39b67037d7c5d6ac7e3fd4f5f206f6db
+  data.tar.gz: aa36aa5aa1659467ff85e451fd7414dc2a1f37c9b540c99b025e4b3017a9d1f9
+SHA512:
+  metadata.gz: 6310e897d16401c67d3f02a6de8f1d1f430dce66c9ff5c4decac96de508654e8735e857bb0193ffcd378a9f55899320fa18443e1fc4ba834230083953e97638a
+  data.tar.gz: 0b77a382747724f2ef1c091f594b1e37f1c832e0a7f8d4a097820de7d083e7e3b6a862abe0c34c7ca1c5d5c667cfcae4fa83ac3532d40678293b8743ce7b9925

data/.gitignore

@@ -0,0 +1,37 @@
+config
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.settings_encryption_key

@@ -0,0 +1 @@
+18167e5c72e6408075cfd60f416cea88

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+
+branches:
+  only: master
+
+language: ruby
+
+cache: bundler
+
+script: ./bin/test
+
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    encrypted_settings (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.2)
+    coderay (1.1.0)
+    method_source (0.8.2)
+    minitest (5.8.4)
+    minitest-reporters (1.1.7)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    ruby-progressbar (1.7.5)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  encrypted_settings!
+  minitest-reporters
+  pry
+  rake
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Krzysztof K.
+
+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,36 @@
+# Encrypted Settings
+A gem like Rails 5 settings but with multiple environments.
+
+# Usage
+
+Implemented a library similar to rails 5 encrypted settings.
+
+To read the settings and print out to STDOUT:
+```bash
+rake settings:read
+```
+
+To edit settings:
+```bash
+rake settings:edit
+```
+
+You might need to pass some environment variables:
+```bash
+RACK_ENV=development SETTINGS_ENCRYPTOION_KEY=DevelopmentSecretIsHardToBreak!! rake settings:edit
+```
+
+The key can also be put in a `.settings_encryption_key` file. In that case just:
+```bash
+RACK_ENV=production rake settings:edit
+```
+
+By default, it would use sublime (`sub --wait`) to edit the settings. If you prefer another editor you can pass the command in `EDITOR` env variable, eg.
+```bash
+EDITOR=vim rake settings:edit
+```
+
+The environment will be determined like this:
+```ruby
+environment = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || ENV["ENV"] || ENV["ENVIRONMENT"] || "development"
+```

data/Rakefile

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("./lib")
+
+environment = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || ENV["ENV"] || ENV["ENVIRONMENT"] || "development"
+
+Encoding.default_external = "UTF-8"
+
+require "encrypted_settings"
+require "pry"
+require "rake/testtask"
+
+Rake::TestTask.new do |task|
+  task.libs << %w(test lib)
+  task.pattern = "test/test_*.rb"
+end
+
+task default: :test
+
+namespace :settings do
+desc "Initialize or edit encrypted settings file."
+  task :edit do
+    EncryptedSettings.new(environment).edit
+  end
+
+  desc "Read settings and print ot STDOUT"
+  task :read do
+    EncryptedSettings.new(environment).read
+      .then(&OpenStructToHash.method(:parse))
+      .then(&YAML.method(:dump))
+      .then(&self.method(:puts))
+  end
+end
+
+module OpenStructToHash
+  def self.parse(object)
+    object.marshal_dump.transform_values do |val|
+      val.is_a?(OpenStruct) ? parse(val) : val
+    end
+  end
+end

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "settings"
+
+# 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

data/bin/setup

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

data/bin/test

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -e
+cd `dirname $0`/..
+
+set -v
+eval "bundle exec rake test"

data/encrypted_settings.gemspec

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "encrypted_settings/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "encrypted_settings"
+  spec.version       = SignedApiRequest::VERSION
+  spec.authors       = ["Krzysztof Kaczmarczyk"]
+
+  spec.summary       = "Encrypts settings so that they can be stored in the repository."
+  spec.description   = "Similar to Rails encrypted secrets but with multiple environments."
+  spec.homepage      = "https://github.com/krzyczak/encrypted_settings"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org by setting "allowed_push_host", or
+  # # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to "http://mygemserver.com""
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "pry"
+end

data/lib/encrypted_settings.rb

@@ -0,0 +1,79 @@
+# signed_api_request
+# encrypted_settings
+
+# SignedApiRequest
+# EncryptedSettings
+
+# frozen_string_literal: true
+
+require "openssl"
+require "yaml"
+require "tempfile"
+require "ostruct"
+require "fileutils"
+require "json"
+
+class EncryptedSettings
+  KEY_FILE_PATH = ".settings_encryption_key"
+
+  def initialize(env, editor: ENV["EDITOR"], key: nil)
+    key ||= ENV["SETTINGS_ENCRYPTION_KEY"]
+    key = File.read(KEY_FILE_PATH).strip if key.nil? && File.exist?(KEY_FILE_PATH)
+    raise "Invalid Encryption Key" if key.nil? || key.length != 32
+
+    @key = key
+    @editor = editor || "sub --wait"
+
+    @settings_path = "config/settings_#{env}.yml.enc"
+  end
+
+  def read
+    File.binread(settings_path)
+      .then(&self.method(:decrypt))
+      .then(&YAML.method(:load))
+      .then(&JSON.method(:dump))
+      .then { |config| JSON.parse(config, object_class: OpenStruct) }
+  end
+
+  def edit
+    # TODO: refactor into a few smaller methods.
+    FileUtils.mkdir_p("config")
+    content = ""
+    content = File.binread(settings_path) if File.exist?(settings_path)
+    tmp = Tempfile.new(["settings", ".yml"])
+    tmp.rewind
+    tmp.write(YAML.safe_load(decrypt(content)).to_yaml) unless content.empty?
+    tmp.close
+    system("#{editor} #{tmp.path}")
+
+    File.unlink(settings_path) if File.exist?(settings_path)
+
+    File.binwrite(settings_path, encrypt(File.read(tmp.path)))
+
+    tmp.unlink
+  end
+
+  private
+
+  attr_reader :key, :editor, :settings_path
+
+  def encrypt(plain_text)
+    cipher = OpenSSL::Cipher::AES256.new(:CBC)
+    cipher.encrypt
+    cipher.iv = "\xAA6RC\x98:?o_\xBD\x95|\xF6\x0E\xD7\xC5" # cipher.random_iv
+    cipher.key = key
+    cipher.update(plain_text) + cipher.final
+  rescue ArgumentError
+    ""
+  end
+
+  def decrypt(cipher_text)
+    decipher = OpenSSL::Cipher::AES256.new(:CBC)
+    decipher.decrypt
+    decipher.iv = "\xAA6RC\x98:?o_\xBD\x95|\xF6\x0E\xD7\xC5"
+    decipher.key = key
+    decipher.update(cipher_text) + decipher.final
+  end
+end
+
+

data/lib/encrypted_settings/version.rb

@@ -0,0 +1,3 @@
+module SignedApiRequest
+  VERSION = "0.0.2"
+end

data/lib/settings.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("./lib")
+
+Encoding.default_external = "UTF-8"
+
+require "encrypted_settings"
+
+# module Settings
+#   class << self
+#     attr_accessor :config
+
+#     def configure
+#       self.config ||= UidsEncoder.new
+#       yield(config)
+#     end
+#   end
+# end
+
+environment = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || ENV["ENV"] || ENV["ENVIRONMENT"] || "development"
+Settings = EncryptedSettings.new(environment).read

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: encrypted_settings
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Krzysztof Kaczmarczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Similar to Rails encrypted secrets but with multiple environments.
+email: 
+executables:
+- console
+- setup
+- test
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".settings_encryption_key"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/test
+- encrypted_settings.gemspec
+- lib/encrypted_settings.rb
+- lib/encrypted_settings/version.rb
+- lib/settings.rb
+homepage: https://github.com/krzyczak/encrypted_settings
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Encrypts settings so that they can be stored in the repository.
+test_files: []