chambermaid 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6d34e355553e694cc493b9fbae6200d0d508d4ada00f4e5f6b934a0582996a2
-  data.tar.gz: a02864caeeeddf4237aa412a2d8b53ffb626f301e7cd1d037287ae75d37d7c83
+  metadata.gz: bac5b5a18928996ec0eff656de94105639482b427795b54cddf825232ff83667
+  data.tar.gz: 4382e36051f155568e2a77a84a79bdb39d55eb0f9e640941aa6d0b85c1071661
 SHA512:
-  metadata.gz: 2777ce46568aeebb40defa53d0a3acaf64b8e5812ffc7b4381b19bf2318255990be65d28d8cd628664bdb4fc15e5c87bdaec924b3a01329e9acbb3567f0cd14b
-  data.tar.gz: b8e8ed1343b17c9d7db2c05f9569fff8eae5b958e9744f8561e315369727d3692baea182815e52072c03f6591d4d8260cc819c62c5df8795551722f06dad3549
+  metadata.gz: e28ac0a2b70366e8f60b882ff2e6e62b5261f6d7056f0f95e4ffd2a4c15ba9431ba8ae3610cd7be6faa040207c6edf3a3a9e0ef11d99359c1f597b25250d19bd
+  data.tar.gz: 80f638eb0c1c445c73e37dda7e9c67c08c3009d012cb28ed8e203f5063675b79cac9cd60dc01847630eaa2ddc3c7c160be0bb9a999b5bf15d373530b1312dc25

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.5.4](https://github.com/mileszim/chambermaid/compare/v0.5.3...v0.5.4) (2020-08-03)
+
+### Bug Fixes
+
+- **release:** chmod 0600 ~/.gem/credentials after generating ([ed85d5b](https://github.com/mileszim/chambermaid/commit/ed85d5b1d9b76762bcc50734c806a6e1cd224ad5))
+
 ## [0.5.3](https://github.com/mileszim/chambermaid/compare/v0.5.2...v0.5.3) (2020-08-03)
 
 ### Bug Fixes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chambermaid (0.5.4)
+    chambermaid (0.5.5)
       aws-sdk-ssm (~> 1.85)
 
 GEM

data/README.md

@@ -4,6 +4,8 @@ Companion RubyGem for [chamber](https://github.com/segmentio/chamber).
 
 Chambermaid injects AWS SSM params into your ENV. Plays nice with other ENV gems like dotenv.
 
+ - [RubyDocs](https://rubydoc.info/gems/chambermaid)
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/chambermaid.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/mileszim/chambermaid"
   spec.metadata["changelog_uri"] = "https://github.com/mileszim/chambermaid/blob/master/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/chambermaid"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/mileszim/chambermaid/issues"
 
   # 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.

data/lib/chambermaid/environment.rb

@@ -1,4 +1,9 @@
 module Chambermaid
+  # Environment keeps a set of params available to load into ENV. It also
+  # maintains a copy of ENV at the time of its initialization, in order to
+  # restore it.
+  #
+  # @attr_reader [Hash] params
   class Environment < Hash
     attr_reader :params
 
@@ -35,16 +40,22 @@ module Chambermaid
     end
 
     # Inject into ENV without overwriting duplicates
+    #
+    # @return [Hash]
     def load!
       each { |k, v| ENV[k] ||= v }
     end
 
     # Inject into ENV and overwrite duplicates
+    #
+    # @return [Hash]
     def overload!
       each { |k, v| ENV[k] = v }
     end
 
     # Restore to original ENV
+    #
+    # @return [ENV]
     def unload!
       ENV.replace(@_original_env)
     end

data/lib/chambermaid/namespace.rb

@@ -1,4 +1,6 @@
 module Chambermaid
+  # Namespaces each contain a ParameterStore and Environment instance,
+  # along with the overload flag
   class Namespace
     # @param [String] path
     # @param [Boolean] overload
@@ -10,23 +12,45 @@ module Chambermaid
       @env = Environment.new({})
     end
 
+    # Create a namespace and immediately fetch and inject params to ENV
+    #
+    # @see Chambermaid::Namespace.load!
+    #
+    # @param [String] path
+    # @param [Boolean] overload
+    #
+    # @return [Chambermaid::Namespace]
     def self.load!(path:, overload: false)
       namespace = new(path: path, overload: overload)
       namespace.load!
       namespace
     end
 
+    # Load ParameterStore and inject into ENV
+    #
+    # @see Chambermaid::ParameterStore#load!
+    # @see Chambermaid::Environment#load!
+    # @see Chambermaid::Environment#overload!
     def load!
       @store.load!
       load_env!
     end
 
+    # Unload params from ENV, reload ParameterStore, and inject into ENV
+    #
+    # @see Chambermaid::Environment#unload!
+    # @see Chambermaid::ParameterStore#reload!
+    # @see Chambermaid::Environment#load!
+    # @see Chambermaid::Environment#overload!
     def reload!
       @env.unload!
       @store.reload!
       load_env!
     end
 
+    # Unload params from ENV
+    #
+    # @see Chambermaid::Environment#unload!
     def unload!
       @env.unload!
       Chambermaid.logger.info("unloaded #{@env.size} params from ENV")

data/lib/chambermaid/parameter_store.rb

@@ -1,30 +1,52 @@
 require "aws-sdk-ssm"
 
 module Chambermaid
+  # ParameterStore instances fetch all parameters under a namespace/path
+  # from AWS SSM
+  #
+  # @note AWS authentication requires configuration via ENV (IAM credentials/STS)
   class ParameterStore
+    # @param [String] path
     def initialize(path:)
       @path = path
     end
 
+    # Fetch and decrypt all parameters selected by a namespace/path string
+    #
+    # @return [Boolean]
     def load!
       fetch_ssm_params!
     end
 
+    # Clear cached parameters and re-fetch parameters from AWS SSM
+    #
+    # @return [Boolean]
     def reload!
       clear_params!
       fetch_ssm_params!
     end
 
+    # Returns true if parameters have been fetched from AWS SSM
+    #
+    # @return [Boolean]
     def loaded?
       !@params_list.empty?
     end
 
+    # Create a ParameterStore and fetch from AWS SSM immediately
+    #
+    # @see Chambermaid::ParameterStore#load!
+    #
+    # @return [Chambermaid::ParameterStore]
     def self.load!(path:)
       store = new(path: path)
       store.load!
       store
     end
 
+    # ENV formatted Hash of parameters loaded from AWS SSM
+    #
+    # @return [Hash]
     def params
       @params ||= @param_list.map { |p|
         [p.name.split("/").last.upcase, p.value]

data/lib/chambermaid/version.rb

@@ -1,3 +1,3 @@
 module Chambermaid
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chambermaid
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Miles Zimmerman
@@ -88,6 +88,8 @@ metadata:
   homepage_uri: https://github.com/mileszim/chambermaid
   source_code_uri: https://github.com/mileszim/chambermaid
   changelog_uri: https://github.com/mileszim/chambermaid/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/chambermaid
+  bug_tracker_uri: https://github.com/mileszim/chambermaid/issues
 post_install_message: 
 rdoc_options: []
 require_paths: