chambermaid 0.0.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07456ca91b66f62c0c8184a33622d02cf18075e56f75872b5ffa79ef243074fb
-  data.tar.gz: 120815ce7e083a74b30ff62e4679e66e9b3217ab7022bec3b43eb971dd1a92f5
+  metadata.gz: fbcb610044b8dd8ff4487cb6729889f18dde9a32bd09b25620b53b6c6336a9e9
+  data.tar.gz: 80abde8476c848335de1f9557f49557322a1463f36419fe8c986a53ee18cb816
 SHA512:
-  metadata.gz: 73ea6ab93523e9e4e8e472140a314c5fd6d0661ed95b0591f53db345e2bffa5aec455cfa426e873e1102ec2c7881bed0170d6d66c2f6032f2fde9fbb5cdafb55
-  data.tar.gz: 1c0010e8ef0c9005a46a7831ec343dcaaf17a78dce974250225777dabd2f9be49ce41c8716b5b59c3b82cc77b46f79b7fa99b96b1ca7b125a83f29b00a14ea14
+  metadata.gz: beb4b9d61c45e48bd48497e2cf27fec7cd5055447aac237324b298ba343b3d4bed49a46151aff364a90049ac31ae78b2c9dcf51b42cfa3cf000c3adde06a9552
+  data.tar.gz: 4228d741b603f187e69d3c900efae0241808eccabd4e3227b745cfd4e75e9c570949071c5d46c079d3ecd34992704c0390cea0f6b174c8560c2ce8ba3fe361f9

data/Gemfile

@@ -2,6 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in chambermaid.gemspec
 gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    chambermaid (0.0.1)
+    chambermaid (0.3.2)
       aws-sdk-ssm (~> 1.85)
 
 GEM
   remote: https://rubygems.org/
   specs:
     aws-eventstream (1.1.0)
-    aws-partitions (1.348.0)
+    aws-partitions (1.349.0)
     aws-sdk-core (3.104.3)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)

data/README.md

@@ -1,4 +1,4 @@
-# Chambermaid
+# Chambermaid [![Gem Version](https://badge.fury.io/rb/chambermaid.svg)](https://badge.fury.io/rb/chambermaid) [![Build Status](https://travis-ci.com/mileszim/chambermaid.svg?branch=master)](https://travis-ci.com/mileszim/chambermaid)
 
 Companion RubyGem for [chamber](https://github.com/segmentio/chamber).
 
@@ -22,18 +22,39 @@ Or install it yourself as:
 
 ## Usage
 
+**Standalone**
+
+```ruby
+Chambermaid.add_namespace("/my/param/namespace")
+Chambermaid.add_service("my-chamber-service")
+```
+
+**Configuration Block**
+
 ```ruby
 # config/initializers/chambermaid.rb
 
 Chambermaid.configure do |config|
   config.add_namespace("/my/param/namespace")
+  config.add_service("my-chamber-service")
 
-  # Set `priority: true` to choose these params over existing
+  # Set `overload: true` to choose these params over existing
   # ones in ENV when they are merged together
-  config.add_namespace("/my/important/namespace", priority: true)
+  config.add_namespace("/my/important/namespace", overload: true)
 end
 ```
 
+**Reload SSM into ENV**
+```ruby
+Chambermaid.reload!
+```
+
+**Restore ENV to original state**
+```ruby
+Chambermaid.restore!
+Chambermaid.reset! # alias of .restore!
+```
+
 ## 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.

data/chambermaid.gemspec

@@ -28,4 +28,6 @@ Gem::Specification.new do |spec|
 
   # Gems
   spec.add_dependency("aws-sdk-ssm", "~> 1.85")
+  spec.add_development_dependency("rspec", "~> 3.0")
+  spec.add_development_dependency("rake", "~> 12.0")
 end

data/lib/chambermaid.rb

@@ -1,6 +1,8 @@
+require "chambermaid/base"
 require "chambermaid/version"
 
 module Chambermaid
   class Error < StandardError; end
-  # Your code goes here...
+
+  extend Base
 end

data/lib/chambermaid/base.rb

@@ -0,0 +1,113 @@
+require "chambermaid/environment"
+require "chambermaid/namespace"
+require "chambermaid/parameter_store"
+
+module Chambermaid
+  module Base
+    def self.extended(base)
+      # Make a copy of ENV before we mess it all up
+      @@_original_env = ENV.to_h.dup.freeze
+    end
+
+    extend self
+
+    def configure
+      yield self
+      load!
+    end
+
+    # @todo
+    def configuration
+      raise "Namespaces must be defined" unless @namespaces
+    end
+
+    # Load SSM into ENV
+    def load!
+      @namespaces.each(&:load!)
+    end
+
+    # @todo
+    def reload!
+      @namespaces.each(&:reload!)
+    end
+
+    def unload!
+      @namespaces.each(&:unload!)
+    end
+
+    # Restore ENV to its original state
+    def restore!
+      ENV.replace(@@_original_env)
+    end
+    alias :reset! :restore!
+
+    # Add an AWS SSM parameter namespace to ENV
+    #
+    # @param [String] path
+    # @param [Boolean] overload
+    #   true  - replace any duplicate ENV keys with new params
+    #   false - keep any existing duplicate ENV key values
+    #
+    # @raise [ArgumentError]
+    #   when `path` is not a string
+    #
+    # @example
+    #   Chambermaid.add_namespace("/my/param/namespace")
+    #
+    # @example overload duplicate ENV vars
+    #   Chambermaid.add_namespace("/my/param/namespace", overload: true)
+    def add_namespace(path, overload: false)
+      raise ArgumentError.new("`path` must be a string") unless path.is_a?(String)
+      raise ArgumentError.new("`overload` must be a boolean") unless [true, false].include?(overload)
+
+      namespaces << Namespace.new(path: path, overload: overload)
+    end
+
+    # Immediately load an AWS SSM parameter namespace to ENV
+    #
+    # @param [String] path
+    # @param [Boolean] overload
+    #   true  - replace any duplicate ENV keys with new params
+    #   false - keep any existing duplicate ENV key values
+    #
+    # @raise [ArgumentError]
+    #   when `path` is not a string
+    #
+    # @example
+    #   Chambermaid.add_namespace!("/my/param/namespace")
+    #
+    # @example overload duplicate ENV vars
+    #   Chambermaid.add_namespace("/my/param/namespace", overload: true)
+    def add_namespace!(path, overload: false)
+      raise ArgumentError.new("`path` must be a string") unless path.is_a?(String)
+      raise ArgumentError.new("`overload` must be a boolean") unless [true, false].include?(overload)
+
+      namespaces << Namespace.load!(path: path, overload: overload)
+    end
+
+    # Add all secrets from Chamber service to ENV
+    #
+    # @param [String] service
+    # @param [Boolean] overload
+    #   true  - replace any duplicate ENV keys with new params
+    #   false - keep any existing duplicate ENV key values
+    #
+    # @example
+    #   Chambermaid.add_service("my-chamber-service")
+    #
+    # @example overload duplicate ENV vars
+    #   Chambermaid.add_service("my-chamber-service", overload: true)
+    #
+    # @see {Chambermaid::Base.add_namespace}
+    def add_service(service, overload: false)
+      service = "/#{service}" unless service[0] == "/"
+      add_namespace(service)
+    end
+
+    private
+
+    def namespaces
+      @namespaces ||= []
+    end
+  end
+end

data/lib/chambermaid/environment.rb

@@ -0,0 +1,68 @@
+module Chambermaid
+  class Environment < Hash
+    attr_reader :params
+
+    # Create new Chambermaid::Environment
+    #
+    # @param [Hash] params
+    #
+    # @raise [ArgumentError]
+    #   if params is not type Hash
+    #
+    # @return [Chambermaid::Environment]
+    def initialize(params)
+      validate_params!(params)
+      stash_current_env!
+      update(format_env(params))
+    end
+
+    # Generate a dotenv (.env) compatible string
+    #
+    # @return [String] dotenv compatible string
+    def to_dotenv
+      to_h.inject("") do |env_str, param|
+        env_str + "#{param[0]}=#{param[1]}\n"
+      end
+    end
+
+    # Write a .env file
+    #
+    # @param [String] file_path
+    def to_file!(file_path)
+      File.open(file_path, "wb") do |f|
+        f.write(to_dotenv)
+      end
+    end
+
+    # Inject into ENV without overwriting duplicates
+    def load!
+      each { |k, v| ENV[k] ||= v }
+    end
+
+    # Inject into ENV and overwrite duplicates
+    def overload!
+      each { |k, v| ENV[k] = v }
+    end
+
+    # Restore to original ENV
+    def unload!
+      ENV.replace(@_original_env)
+    end
+
+    private
+
+    def stash_current_env!
+      @_original_env ||= ENV.to_h.dup.freeze
+    end
+
+    def format_env(params)
+      params.map{|k,v| [k.upcase, v]}.to_h
+    end
+
+    def validate_params!(params)
+      unless params.is_a?(Hash)
+        raise ArgumentError.new("`params` must be a hash")
+      end
+    end
+  end
+end

data/lib/chambermaid/namespace.rb

@@ -0,0 +1,42 @@
+module Chambermaid
+  class Namespace
+    # @param [String] path
+    # @param [Boolean] overload
+    def initialize(path:, overload: false)
+      @path = path
+      @overload = overload
+
+      @store = ParameterStore.new(path: path)
+      @env = Environment.new({})
+    end
+
+    def self.load!(path:, overload: false)
+      namespace = new(path: path, overload: overload)
+      namespace.load!
+      namespace
+    end
+
+    def load!
+      @store.load!
+      load_env!
+    end
+
+    def reload!
+      @env.unload!
+      @store.reload!
+      load_env!
+    end
+
+    def unload!
+      @env.unload!
+    end
+
+    private
+
+    # Inject into ENV
+    def load_env!
+      @env.replace(@store.params)
+      @overload ? @env.overload! : @env.load!
+    end
+  end
+end

data/lib/chambermaid/parameter_store.rb

@@ -0,0 +1,67 @@
+require "aws-sdk-ssm"
+
+module Chambermaid
+  class ParameterStore
+    def initialize(path:)
+      @path = path
+    end
+
+    def load!
+      fetch_ssm_params!
+    end
+
+    def reload!
+      clear_params!
+      fetch_ssm_params!
+    end
+
+    def loaded?
+      !@params_list.empty?
+    end
+
+    def self.load!(path:)
+      store = new(path: path)
+      store.load!
+      store
+    end
+
+    def params
+      @params ||= @param_list.map { |p|
+        [p.name.split("/").last.upcase, p.value]
+      }.to_h
+    end
+
+    alias :to_h :params
+
+    private
+
+    def client
+      @client ||= Aws::SSM::Client.new
+    end
+
+    def fetch_ssm_params!
+      @param_list = []
+      response = nil
+      loop do
+        response = fetch_ssm_param_batch!(response&.next_token)
+        @param_list.concat(response.parameters)
+
+        break unless response.next_token
+      end
+    end
+
+    def fetch_ssm_param_batch!(next_token = nil)
+      client.get_parameters_by_path(
+        path: @path,
+        with_decryption: true,
+        recursive: true,
+        next_token: next_token
+      )
+    end
+
+    def clear_params!
+      @params = nil
+      @params_list = []
+    end
+  end
+end

data/lib/chambermaid/version.rb

@@ -1,3 +1,3 @@
 module Chambermaid
-  VERSION = "0.0.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chambermaid
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Miles Zimmerman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ssm
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.85'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 description: 
 email:
 - miles@asktrim.com
@@ -44,6 +72,10 @@ files:
 - bin/setup
 - chambermaid.gemspec
 - lib/chambermaid.rb
+- lib/chambermaid/base.rb
+- lib/chambermaid/environment.rb
+- lib/chambermaid/namespace.rb
+- lib/chambermaid/parameter_store.rb
 - lib/chambermaid/version.rb
 homepage: https://github.com/mileszim/chambermaid
 licenses: