simple_parameter_store 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b2dc9f14a795d916ad62a2e0bc0c856af6f8ab1e50dc3e33e952b35334cb34d2
+  data.tar.gz: ffa943b5a34efac86836b506e40560b9bf3bc7c4fde5ccaeb96f5822db02fba2
+SHA512:
+  metadata.gz: c793cdc5b16b1bed1b5f801fb5277a47848326c288191588fa16f6a21dd05debdd1d1fdf9e870c2225cecf4d55a48e493835ce13ffa692708d10201c8d6c235b
+  data.tar.gz: 4faa3f5f51d78c6c2b8f0dc385990efe021a741a92333fb458413cc283dcc4209e0ddc550752dd3131e1cc097c91df189f226acb82ed0befee4fda95c2d6b231

data/.github/main.workflow

@@ -0,0 +1,19 @@
+workflow "CI" {
+  on = "push"
+  resolves = [
+    "CI - Ruby 2.5",
+    "CI - Ruby 2.6"
+  ]
+}
+
+action "CI - Ruby 2.5" {
+  uses = "docker://ruby:2.5"
+  runs = "bash"
+  args = ["-c", "gem install bundler:2.0.1 && bundle && bundle exec rake test"]
+}
+
+action "CI - Ruby 2.6" {
+  uses = "docker://ruby:2.6"
+  runs = "bash"
+  args = ["-c", "gem install bundler:2.0.1 && bundle && bundle exec rake test"]
+}

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'test/**/*.rb'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'test/**/*.rb'

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_parameter_store.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    simple_parameter_store (0.1.0)
+      aws-sdk-ssm
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.157.0)
+    aws-sdk-core (3.49.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-ssm (1.43.0)
+      aws-sdk-core (~> 3, >= 3.48.2)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    jaro_winkler (1.5.2)
+    jmespath (1.4.0)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.68.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.1.0)
+      rubocop (>= 0.67.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rubocop
+  rubocop-performance
+  simple_parameter_store!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Timo Schilling
+
+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,58 @@
+# SimpleParameterStore
+
+`SimpleParameterStore` gives you an nice abstraction over the AWS SSM Parameter Store.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_parameter_store'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_parameter_store
+
+## Usage
+
+```ruby
+require 'simple_parameter_store'
+
+parameters = SimpleParameterStore.new(
+  client: Aws::SSM::Client.new,                           # optional, default: `Aws::SSM::Client.new`, can be used to set custom args for the SSM client
+  prefix: "/#{ENV['ENVIRONMENT']}",                       # optional, default: `nil`, can be used to prefix all parameter names with `/production`
+  expires_after: 3600,                                    # optional, default: `nil`, time in seconds after the store will be refreshed
+  decryp: true,                                           # optional, default: `true`, enable/disable automatic parameter decryption
+  names: {                                                # requires, hash with mapping of parameter names, the key will be used for the store index
+    foo: '/bar',                                          # aliased the key `/bar` (if prefix is `nil`) under the `:foo` in the store
+    max: ['max', :to_i.to_proc],                          # the value can be an array with the key as first and a caster as second value,
+    key: ['private_key', OpenSSL::PKey::RSA.method(:new)] # the caster must be respond to `call` and return the converted value
+  }
+)
+
+parameters[:foo] # => `'bar'`
+parameters[:max] # => `123`
+parameters[:key].class # => OpenSSL::PKey::RSA
+
+parameters.refresh           # forces an store refresh
+parameters.refresh_if_needed # refreshes the store is expired
+```
+
+## Development
+
+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/COMPEON/simple_parameter_store.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'simple_parameter_store'
+
+# 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/simple_parameter_store/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class SimpleParameterStore
+  VERSION = '0.1.0'
+end

data/lib/simple_parameter_store.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'simple_parameter_store/version'
+
+class SimpleParameterStore
+  class SSMKeyError < KeyError; end
+
+  def initialize(names:, client: nil, prefix: nil, decrypt: true, expires_after: nil)
+    @client = client || Aws::SSM::Client.new
+    @prefix = prefix
+    @decrypt = decrypt
+    @expires_after = expires_after
+
+    @mappings = {}
+    @casters = {}
+    @cache = {}
+
+    prepaire(names)
+    refresh
+  end
+
+  attr_reader :client, :prefix, :decrypt, :expires_after, :expires_at
+
+  def refresh
+    fetch.parameters.each do |parameter|
+      key, = @mappings.rassoc(parameter.name)
+      caster = @casters.fetch(key)
+      value = caster.call(parameter.value)
+      @cache[key] = value
+    end
+
+    @expires_at = Time.now + expires_after if expires_after
+  end
+
+  def refresh_if_needed
+    refresh if expired?
+  end
+
+  def expired?
+    expires_after && expires_at < Time.now
+  end
+
+  def [](key)
+    refresh_if_needed
+    @cache.fetch(key)
+  end
+
+  private
+
+  def fetch
+    result = client.get_parameters(names: @mappings.values, with_decryption: decrypt)
+    raise SSMKeyError if result.invalid_parameters.any?
+
+    result
+  end
+
+  def prepaire(names)
+    names.each_pair do |key, (name, caster)|
+      @mappings[key] = "#{prefix}#{name}"
+      @casters[key] = caster || :itself.to_proc
+    end
+  end
+end

data/simple_parameter_store.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_parameter_store/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_parameter_store'
+  spec.version       = SimpleParameterStore::VERSION
+  spec.authors       = ['Timo Schilling']
+  spec.email         = ['timo@schilling.io']
+
+  spec.summary       = 'Simple abstraction of AWS SSM Parameter Store.'
+  spec.description   = 'Simple abstraction of AWS SSM Parameter Store.'
+  spec.homepage      = 'https://github.com/COMPEON/simple_parameter_store'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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 'aws-sdk-ssm'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: simple_parameter_store
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Timo Schilling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ssm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+- !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: rubocop
+  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: rubocop-performance
+  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: Simple abstraction of AWS SSM Parameter Store.
+email:
+- timo@schilling.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/main.workflow"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_parameter_store.rb
+- lib/simple_parameter_store/version.rb
+- simple_parameter_store.gemspec
+homepage: https://github.com/COMPEON/simple_parameter_store
+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: Simple abstraction of AWS SSM Parameter Store.
+test_files: []