secrets_parser 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 30084b08de2283f2b2c3bb313c3dfbe3d57ca15d
-  data.tar.gz: 2715b1bc6044484f8a63f4b368c6c7223da8ae60
+SHA256:
+  metadata.gz: 482b595adb191ed6b889340e239cdcc376e84a3ee3e0e0e15a4df745ee28009f
+  data.tar.gz: 3e077fcda36d288afaebac53430bc567aae58b50e936e66cad5464e3dd4c1e9e
 SHA512:
-  metadata.gz: 0c8201ba248c880d24856bcb9b0499342ca2d854254af2779821997801ceeacfc894eddf90142811c5866d1a5808490d814f83fc0ce72c9c5b9717ddf5371701
-  data.tar.gz: ecf987be6b1e3f5eac87e55642e9636088d77ef7b7673dc48e3069d2e3853fb89c34f570f2025337ddb9a3f6248a3c9fadd7eebb35dc90288bc0bcb155cf184e
+  metadata.gz: 48775396ba15fa9ff16ec517d13ee4e53a8349072ed9704c455c24cb42c53f5c627b1f00cbfc7e6b070ce5db96ed6044aa1822299fc46656c9b6e092bb8bb851
+  data.tar.gz: eb1f9e854bb59043f2f9bc50f190b03e4177fbe76d7f110302bdd470cf769a9f449e25b64c5b1cae909a897f737aa89ade8e8420365f24e67bc7af0f65410949

data/README.md

@@ -91,3 +91,19 @@ puts JSON.pretty_generate(parsed_file)
   }
 }
 ```
+
+### Logging
+
+To enable logging feature just configure `:logger` key injecting a logger that implements [Logger interface](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html).
+
+Sample using ruby's Logger stdlib:
+
+```
+require 'secrets_parser'
+require 'logger'
+
+parser = Secrets::Parser.new
+parser.set_config do |config|
+  config[:logger] = Logger.new(STDOUT)
+end
+```

data/lib/secrets_parser/parser.rb

@@ -9,7 +9,8 @@ module Secrets
     def initialize
       @config = {
         s3_client: nil,
-        kms_client: nil
+        kms_client: nil,
+        logger: nil
       }
     end
 
@@ -25,6 +26,8 @@ module Secrets
       app_json = JSON.parse(IO.read(file_to_parse))
       app_variables = app_json[field_to_parse]
 
+      logger.info "Parsing #{field_to_parse} section of #{file_to_parse}" if logger?
+
       app_json[field_to_parse] = parse_secrets_from app_variables
 
       app_json
@@ -54,6 +57,8 @@ module Secrets
       file = file[file.index('/') + 1..file.length] + SECRETS_FILE_SUFFIX
       tmp_file = "/tmp/secrets#{SECRETS_FILE_SUFFIX}"
 
+      logger.info "Downloading #{file} from #{bucket_name}" if logger?
+
       File.open(tmp_file, 'wb') do |secret_file|
         @config[:s3_client].get_object({ bucket: bucket_name, key: file }, target: secret_file)
       end
@@ -79,23 +84,32 @@ module Secrets
     def parse_secrets_from(variables)
       secret_variables = {}
 
-      variables.each_pair do |k, v|
-        next unless secret? v
+      variables.each_pair do |key, value|
+        next unless secret?(value)
 
-        secret = v
+        secret = value
 
         secret_file = secret_file_path_from(secret)
         secret_key = secret_key_from(secret)
 
-        unless secret_variables.key? secret_file
+        unless secret_variables.key?(secret_file)
           secret_variables[secret_file] = extract_secrets_from secret_file
         end
 
-        variables[k] = secret_variables[secret_file][secret_key]
+        logger.info "Updating #{key} value" if logger?
+
+        variables[key] = secret_variables[secret_file][secret_key]
       end
 
       variables
     end
 
+    def logger?
+      !logger.nil?
+    end
+
+    def logger
+      @config[:logger]
+    end
   end
 end

data/lib/secrets_parser/version.rb

@@ -1,3 +1,3 @@
 module SecretsParser
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/secrets_parser.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/peertransfer/secrets_parser'
 
   if spec.respond_to?(:metadata)
-    #spec.metadata['allowed_push_host'] = 'https://travis-ci.org/'
+    spec.metadata['allowed_push_host'] = 'https://travis-ci.org/'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secrets_parser
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Paco Sanchez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-03 00:00:00.000000000 Z
+date: 2018-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,7 +71,8 @@ files:
 homepage: https://github.com/peertransfer/secrets_parser
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://travis-ci.org/
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -88,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Write a short summary, because RubyGems requires one.