chambermaid 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96de691a190b68ff6d24e2410f1191ac0f3ef29c534de37ae73b7e7a7f4d8530
-  data.tar.gz: 16b2fb406a93c823bba30938594294fdcad94a1588718327c57b1d10fddf7f0a
+  metadata.gz: 7205cca8ffd4e9f7b2e20eb02239fd42be4f9dcdbd7c85eafb2e74c000d39be6
+  data.tar.gz: a1b394c7dd79578e738defb6657276aa6988185d432153f900dab3b2bfeda97d
 SHA512:
-  metadata.gz: 4d73421e3cdac6a8e835b745df14a2fe012f4785183e4cc28c4222358553a8ac29a12f5e7cd256af7d7bf2bfcbf5bf8cf2783d089dbb09e435d07f717a359269
-  data.tar.gz: 7d7a11dbb825742c23bd9a1d8b2ac10cabb44c92b66d6fea40ae828c01862611d97b5422efafd3f57f9c5826e39648240eb389f69d9d98acf0635118908c266a
+  metadata.gz: 4ef58ed041bd944a89d06a72c4b4f71dfe7695ef86aa4c2a28edf6d32d6a8b46122c1bfe7b1f6461cf9199dfbe73cfcf9fadd7ee101b54f0e86be5d36cd76c9d
+  data.tar.gz: 9cb1b2f1781b2903a9af7121e7720a8c2f875a28472f8d0ded8b455560262917f2fec5e0cb8584886257de8141fabc90ca7d244d86435004b9c1377a121d4ee2

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.1.0)
+    chambermaid (0.4.0)
       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).
 
@@ -26,6 +26,7 @@ Or install it yourself as:
 
 ```ruby
 Chambermaid.add_namespace("/my/param/namespace")
+Chambermaid.add_service("my-chamber-service")
 ```
 
 **Configuration Block**
@@ -34,14 +35,50 @@ Chambermaid.add_namespace("/my/param/namespace")
 # config/initializers/chambermaid.rb
 
 Chambermaid.configure do |config|
+  # Load all values from SSM Namespace path
   config.add_namespace("/my/param/namespace")
 
-  # Set `overwrite_duplicates: true` to choose these params over existing
+  # Load values from chamber-cli service
+  config.add_service("my-chamber-service")
+
+  # Set `overload: true` to choose these params over existing
   # ones in ENV when they are merged together
-  config.add_namespace("/my/important/namespace", overwrite_duplicates: true)
+  config.add_namespace("/my/important/namespace", overload: true)
 end
+
+# Load after configuration
+Chambermaid.load!
+```
+
+**Reload SSM into ENV**
+```ruby
+Chambermaid.reload!
 ```
 
+**Restore ENV to original state**
+```ruby
+Chambermaid.restore!
+Chambermaid.reset! # alias of .restore!
+```
+
+**Configure Logging**
+```ruby
+Chambermaid.configure do |config|
+  # ... other config ...
+
+  # Change log level
+  config.log_level = :debug
+
+  # Set custom logger instance
+  config.logger = MyCoolLogger.new
+end
+
+# Outside of config block
+Chambermaid.log_level = :warn
+```
+
+_Note: Chambermaid.logger is set to Rails.logger automatically if including inside a rails app_
+
 ## 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,5 +1,6 @@
 require "chambermaid/base"
 require "chambermaid/version"
+require "chambermaid/railtie" if defined?(Rails)
 
 module Chambermaid
   class Error < StandardError; end

data/lib/chambermaid/base.rb

@@ -1,7 +1,16 @@
+require "logger"
+
+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
@@ -13,43 +22,126 @@ module Chambermaid
       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] overwrite_duplicates
+    # @param [Boolean] overload
     #   true  - replace any duplicate ENV keys with new params
     #   false - keep any existing duplicate ENV key values
     #
-    # @raise
-    def add_namespace(path, overwrite_duplicates: false)
-      @namespaces ||= {}
-      raise "namespace already included in ENV" unless @namespaces[path].nil?
+    # @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[path] = ParameterStore.load!(path: path)
-      update_env!(
-        params: @namespaces[path].params,
-        overwrite_duplicates: overwrite_duplicates
-      )
+      namespaces << Namespace.new(path: path, overload: overload)
     end
 
-    # Inject into ENV
+    # Immediately load an AWS SSM parameter namespace to ENV
     #
-    # @param [Hash] params
-    # @param [Boolean] overwrite_duplicates
+    # @param [String] path
+    # @param [Boolean] overload
     #   true  - replace any duplicate ENV keys with new params
     #   false - keep any existing duplicate ENV key values
-    def update_env!(params:, overwrite_duplicates:)
-      if overwrite_duplicates
-        ENV.update(params)
-      else
-        current_env = ENV.to_h.dup
-        new_env = params.merge(current_env)
-        ENV.replace(new_env)
-      end
+    #
+    # @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
+
+    # !@attribute [r] logger
+    #   @return [Logger]
+    def logger
+      @logger ||= Logger.new(STDOUT,
+        level: log_level,
+        progname: "Chambermaid"
+      )
+    end
+
+    # !@attribute [w] logger
+    #   @return [Logger]
+    def logger=(val)
+      @logger = val
+      @logger.progname = "Chambermaid"
+      logger
+    end
+
+    # !@attribute [r] log_level
+    #   @return [Symbol] (default = :info) current logger level
+    def log_level
+      return logger.level unless @logger.nil?
+      return @log_level unless @log_level.nil?
+      return :info
+    end
+
+    # !@attribute [w] log_level
+    #   @return [Symbol] (default = :info) current logger level
+    def log_level=(val = :info)
+      @logger.level = val unless @logger.nil?
+      @log_level = val
+      val
+    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,44 @@
+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!
+      Chambermaid.logger.info("unloaded #{@env.size} params from ENV")
+    end
+
+    private
+
+    # Inject into ENV
+    def load_env!
+      @env.replace(@store.params)
+      @overload ? @env.overload! : @env.load!
+      Chambermaid.logger.info("loaded #{@env.size} params into ENV from `#{@path}`")
+    end
+  end
+end

data/lib/chambermaid/parameter_store.rb

@@ -10,6 +10,15 @@ module Chambermaid
       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!
@@ -24,12 +33,6 @@ module Chambermaid
 
     alias :to_h :params
 
-    def to_env
-      params.inject("") do |env_str, param|
-        env_str + "#{param[0]}=#{param[1]}\n"
-      end
-    end
-
     private
 
     def client
@@ -37,14 +40,20 @@ module Chambermaid
     end
 
     def fetch_ssm_params!
+      Chambermaid.logger.debug("fetching AWS SSM parameters from `#{@path}`")
       @param_list = []
       response = nil
       loop do
         response = fetch_ssm_param_batch!(response&.next_token)
         @param_list.concat(response.parameters)
 
-        break unless response.next_token
+        if response.next_token
+          Chambermaid.logger.debug("response.next_token found, continuing fetch")
+        else
+          break
+        end
       end
+      Chambermaid.logger.debug("fetched #{@param_list.size} parameters from `#{@path}`")
     end
 
     def fetch_ssm_param_batch!(next_token = nil)
@@ -55,5 +64,10 @@ module Chambermaid
         next_token: next_token
       )
     end
+
+    def clear_params!
+      @params = nil
+      @params_list = []
+    end
   end
 end

data/lib/chambermaid/railtie.rb

@@ -0,0 +1,8 @@
+module Chambermaid
+  class Railtie < Rails::Railtie
+    config.before_configuration do
+      Chambermaid.logger = Rails.logger
+      Chambermaid.load!
+    end
+  end
+end

data/lib/chambermaid/version.rb

@@ -1,3 +1,3 @@
 module Chambermaid
-  VERSION = "0.1.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chambermaid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Miles Zimmerman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-01 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
@@ -45,7 +73,10 @@ files:
 - chambermaid.gemspec
 - lib/chambermaid.rb
 - lib/chambermaid/base.rb
+- lib/chambermaid/environment.rb
+- lib/chambermaid/namespace.rb
 - lib/chambermaid/parameter_store.rb
+- lib/chambermaid/railtie.rb
 - lib/chambermaid/version.rb
 homepage: https://github.com/mileszim/chambermaid
 licenses: