sekreto 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab381faa21b251cd3abadcc6c2d854dac68a4f9af5d2a507b6eb060f67bdd385
-  data.tar.gz: 97760f0f1a7cecf45bfa98263b3be0a0f7144227f82fbc0eff2fd8e930b97b76
+  metadata.gz: 740dfb4e957a3391c16a07fef0e8b2b4a5894c3f024c5ebed9479b04cc07b0a1
+  data.tar.gz: 12762eb844417916b3ddd203cd3dc1a890b0e66a263a9fd6bf96602c80d3f2be
 SHA512:
-  metadata.gz: 7e68a1eb57ce8c74025391b1856211e3bd1458003bc12f618e1a08bad9f0448ee1f1b8800d8294e20cfd10f82aba8adef0525b3edadbd6316f22cb874aea20f9
-  data.tar.gz: 7a05fbb69de6d2952fce1477d72daee5601ee6c52c46436b0eeb25aff59fe180375b17b849300c3609f0456deb5f650378dd6cdc6d3960a75c3ec5f45d9260c9
+  metadata.gz: bc14a8a054c3d85f7dbe55da4200e1cd675f6dd98f9a3e207ab78f2d84c31bfd8b473bbdddf233afa22ec51765d5855889c83a83f92b946154659405a72bc7f7
+  data.tar.gz: 88f2691b301e269b1aba1c410d06f40940cd18e08ea25fc2584670ff80dd81c3500317cd435d7f7d3ca46c6555a6d2e621f9139fc680f6cb638f81e1867b8f91

data/lib/sekreto.rb

@@ -6,13 +6,30 @@ require 'sekreto/config'
 
 require 'sekreto/railtie' if defined?(Rails)
 
-# Sekreto holds configuration and interface for getting secrets
+# Sekreto allows you to interact with the AWS Secrets Manager to
+# retrieve your secrets from Ruby. This exposes a thin wrapper around
+# the AWS SecretsManager SDK.
 module Sekreto
   class << self
+    ##
+    # Set up the Sekreto gem configuration
+    #
+    # @yieldreturn [Sekreto::Config]
+    #
+    # @example Configuring Sekreto
+    #   Sekreto.setup do |setup|
+    #     setup.prefix = 'app-prefix'
+    #   end
     def setup
       yield config if block_given?
     end
 
+    ##
+    #
+    # Get the value given a secret
+    #
+    # @param secret_id [String] - The secret ID to get the value for
+    # @return [String] - The value of the stored secret
     def get_value(secret_id)
       fail 'Not allowed env' unless config.is_allowed_env.call
       response = secrets_manager.get_secret_value(secret_id: secret_name(secret_id))
@@ -22,11 +39,22 @@ module Sekreto
       config.fallback_lookup.call(secret_id)
     end
 
+    ##
+    #
+    # Get the JSON value of a secret
+    #
+    # @param secret_id [String] - The secret ID to get the value for
+    # @return [Hash] - The parsed JSON value of the secret
     def get_json_value(secret_id)
       response = get_value(secret_id)
       MultiJson.load(response)
     end
 
+    ##
+    #
+    # Get the configuration for Sekreto
+    #
+    # @return [Sekreto::Config] - The configuration
     def config
       @config ||= Config.new
     end

data/lib/sekreto/config.rb

@@ -1,6 +1,8 @@
 require 'logger'
 
 module Sekreto
+  ##
+  # Config class for setting up Sekreto for usage
   class Config
     attr_accessor :prefix
     attr_accessor :is_allowed_env
@@ -8,6 +10,11 @@ module Sekreto
     attr_accessor :secrets_manager
     attr_accessor :logger
 
+    ##
+    #
+    # Initialize a new Config
+    #
+    # @return [Sekreto::Config]
     def initialize
       @prefix = 'secrets'
       @is_allowed_env = -> { true }

data/lib/sekreto/railtie.rb

@@ -1,7 +1,11 @@
 module Sekreto
   # Rails Railtie to set up the Sekreto configuration
+  #
+  # Defaults the secrets Manager to Aws::SecretsManager::Client.new
+  # Defaults the prefix to Rails app name and Rails.env e.g. foo-staging
+  # Defaults allowed envs to check Rails.env is production or staging
   class Railtie < ::Rails::Railtie
-    config.after_initialize do
+    config.before_initialize do
       app_name = ::Rails.application.class.to_s.split('::').first.downcase
 
       Sekreto.setup do |setup|

data/lib/sekreto/version.rb

@@ -1,3 +1,3 @@
 module Sekreto
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sekreto
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Autolist Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2018-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-secretsmanager
@@ -38,26 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: autocop
   requirement: !ruby/object:Gem::Requirement
@@ -156,7 +136,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Manage AWS Secrets from Rails
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: Manage AWS Secrets from Ruby
 email:
 - dev@autolist.com
 executables: []
@@ -193,5 +187,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: AwsSecretsManager for Rails
+summary: AwsSecretsManager for Ruby
 test_files: []