service_skeleton 0.0.0.34.g4f6fdb0 → 0.0.0.41.g9507cda

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e45890d70da0bc9118d5b96a8d697197cfd05fb6463ff3e84f048ceb4246b55
-  data.tar.gz: bb5bafb7ce4cd3e68143fbb179fd630cec02e9c2b1587afa7a601513efb826a1
+  metadata.gz: e4ef4c44c6af279c8870e58b4bf078424a30c87b6d979d2513fe093c15926287
+  data.tar.gz: 5a9d7d4fc51bae03eac369f6f902dabcfea925d3fd175b69e7888d4368fe87f0
 SHA512:
-  metadata.gz: 68f83da9df7a513d4664c94c01f6c48102012f6b8de6cf89641f48f617441e23d9ffdd408a879f9ca17a39e2debeed55750265b6ee03a16210e66a9d730adb5f
-  data.tar.gz: 64ddeaacdb65c61af8c745a4b2acb30857c3481641530e1968d29cf6aea0b29a341ff16d00259d05b8529793012da3b0eda9abd2c82e9b5e3f1a45cfe51f589f
+  metadata.gz: 353f92e555ba95c3e5776a0acb10119500671182a0efc082ff0d9e91a247f14209ff23dbc0f64cec73df445daba2435acac7104f18bef0e6cccd01a48e6b4954
+  data.tar.gz: c0c3341e8ab56f4cfed5809a94b6a9b8295e30b59a04977e1b45a24c1d64b3a5ad8f14927e0453145a4bcf93d94579b08d1e432bee49d0e8ac5352f88da6f3f9

data/lib/service_skeleton.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "service_skeleton/config"
 require_relative "service_skeleton/config_variables"
 require_relative "service_skeleton/logging_helpers"
@@ -184,22 +186,22 @@ class ServiceSkeleton
   end
 
   @registered_variables = [
-    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_LEVEL) { "INFO" },
-    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOGSTASH_SERVER) { "" },
-    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_ENABLE_TIMESTAMPS) { false },
-    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_FILE) { nil },
-    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_MAX_FILE_SIZE) { 1048576 },
-    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_MAX_FILES) { 3 },
-    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_METRICS_PORT) { nil },
+    { name: :SERVICE_SKELETON_LOG_LEVEL,             class: ConfigVariable::String,  opts: { default: "INFO" } },
+    { name: :SERVICE_SKELETON_LOG_ENABLE_TIMESTAMPS, class: ConfigVariable::Boolean, opts: { default: false } },
+    { name: :SERVICE_SKELETON_LOG_FILE,              class: ConfigVariable::String,  opts: { default: nil } },
+    { name: :SERVICE_SKELETON_LOG_MAX_FILE_SIZE,     class: ConfigVariable::Integer, opts: { default: 1048576, range: 0..Float::INFINITY } },
+    { name: :SERVICE_SKELETON_LOG_MAX_FILES,         class: ConfigVariable::Integer, opts: { default: 3, range: 0..Float::INFINITY } },
+    { name: :SERVICE_SKELETON_LOGSTASH_SERVER,       class: ConfigVariable::String,  opts: { default: nil } },
+    { name: :SERVICE_SKELETON_METRICS_PORT,          class: ConfigVariable::Integer, opts: { default: nil, range: 1..65535 } },
   ]
 
   def self.inherited(subclass)
     subclass.string(:"#{subclass.service_name.upcase}_LOG_LEVEL", default: "INFO")
-    subclass.string(:"#{subclass.service_name.upcase}_LOGSTASH_SERVER", default: "")
     subclass.boolean(:"#{subclass.service_name.upcase}_LOG_ENABLE_TIMESTAMPS", default: false)
     subclass.string(:"#{subclass.service_name.upcase}_LOG_FILE", default: nil)
     subclass.integer(:"#{subclass.service_name.upcase}_LOG_MAX_FILE_SIZE", default: 1048576, range: 0..Float::INFINITY)
     subclass.integer(:"#{subclass.service_name.upcase}_LOG_MAX_FILES", default: 3, range: 1..Float::INFINITY)
+    subclass.string(:"#{subclass.service_name.upcase}_LOGSTASH_SERVER", default: "")
     subclass.integer(:"#{subclass.service_name.upcase}_METRICS_PORT", default: nil, range: 1..65535)
   end
 end

data/lib/service_skeleton/background_worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ServiceSkeleton
   module BackgroundWorker
     include ServiceSkeleton::LoggingHelpers

data/lib/service_skeleton/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "to_regexp"
 
 require_relative "./filtering_logger"
@@ -11,8 +13,14 @@ class ServiceSkeleton
     def initialize(env, svc)
       @svc = svc
 
-      parse_registered_variables(env)
+      # Parsing registered variables will redact the environment, so we want
+      # to take a private unredacted copy before that happens
       @env = env.to_hash.dup.freeze
+
+      parse_registered_variables(env)
+
+      # Sadly, we can't setup the logger until we know *how* to setup the
+      # logger, which requires parsing config variables
       setup_logger
     end
 
@@ -23,26 +31,23 @@ class ServiceSkeleton
     private
 
     def parse_registered_variables(env)
-      @svc.registered_variables.each do |var|
-        val = var.value(env)
+      (@svc.registered_variables || []).map do |var|
+        var[:class].new(var[:name], env, **var[:opts])
+      end.each do |var|
+        val = var.value
+        method_name = var.method_name(@svc.service_name).to_sym
 
-        define_singleton_method(var.method_name(@svc.service_name)) do
+        define_singleton_method(method_name) do
           val
         end
 
-        define_singleton_method(var.method_name(@svc.service_name) + "=") do |v|
-          val = v
+        define_singleton_method(:"#{method_name}=") do |new_value|
+          val = new_value
         end
-
-        if var.sensitive?
-          if env.object_id != ENV.object_id
-            raise ServiceSkeleton::Error::CannotSanitizeEnvironmentError,
-                  "Attempted to sanitize sensitive variable #{var.name}, but was not passed the ENV object"
-          end
-
-          var.env_keys(env).each do |k|
-            env[k] = "*SENSITIVE*"
-          end
+      end.each do |var|
+        if var.redact!(env) && env.object_id != ENV.object_id
+          raise ServiceSkeleton::Error::CannotSanitizeEnvironmentError,
+                "Attempted to sanitize sensitive variable #{var.name}, but we're not operating on the process' environment"
         end
       end
     end

data/lib/service_skeleton/config_variable.rb

@@ -1,35 +1,39 @@
+# frozen_string_literal: true
+
 class ServiceSkeleton
   class ConfigVariable
-    attr_reader :name, :key_pattern
+    attr_reader :name, :value
 
-    def initialize(name, **opts, &blk)
+    def initialize(name, env, **opts, &blk)
       @name = name
       @opts = opts
       @blk  = blk
-    end
 
-    def method_name(svc_name)
-      name.to_s.gsub(/\A#{Regexp.quote(svc_name)}_/i, '').downcase
+      @value = pluck_value(env)
     end
 
-    def sensitive?
-      !!@opts[:sensitive]
+    def method_name(svc_name)
+      @name.to_s.gsub(/\A#{Regexp.quote(svc_name)}_/i, '').downcase
     end
 
-    def value(env)
-      if @opts[:key_pattern]
-        matches = env.select { |k, _| @opts[:key_pattern] === k.to_s }
-        @blk.call(matches)
-      else
-        @blk.call(env[@name.to_s])
+    def redact!(env)
+      if @opts[:sensitive]
+        env[@name.to_s] = "*SENSITIVE*" if env.has_key?(@name.to_s)
       end
     end
 
-    def env_keys(env)
-      if @opts[:key_pattern]
-        env.keys.select { |k| @opts[:key_pattern] === k.to_s }
+    private
+
+    def maybe_default(env)
+      if env.has_key?(@name.to_s)
+        yield
       else
-        env.keys.include?(@name.to_s) ? [@name.to_s] : []
+        if @opts.has_key?(:default)
+          @opts[:default]
+        else
+          raise ServiceSkeleton::Error::InvalidEnvironmentError,
+                "Value for required environment variable #{@name} not specified"
+        end
       end
     end
   end

data/lib/service_skeleton/config_variable/boolean.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "service_skeleton/config_variable"
+
+class ServiceSkeleton::ConfigVariable::Boolean < ServiceSkeleton::ConfigVariable
+  private
+
+  def pluck_value(env)
+    maybe_default(env) do
+      case env[@name.to_s]
+      when /\A(no|n|off|0|false)\z/i
+        false
+      when /\A(yes|y|on|1|true)\z/i
+        true
+      else
+        raise ServiceSkeleton::Error::InvalidEnvironmentError,
+              "Value #{env[@name.to_s].inspect} for environment variable #{@name} is not a valid boolean value"
+      end
+    end
+  end
+end

data/lib/service_skeleton/config_variable/enum.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "service_skeleton/config_variable"
+
+class ServiceSkeleton::ConfigVariable::Enum < ServiceSkeleton::ConfigVariable
+  private
+
+  def pluck_value(env)
+    maybe_default(env) do
+      v = env[@name.to_s]
+
+      if @opts[:values].is_a?(Array)
+        unless @opts[:values].include?(v)
+          raise ServiceSkeleton::Error::InvalidEnvironmentError,
+                "Invalid value for #{@name}; must be one of #{@opts[:values].join(", ")}"
+        end
+        v
+      elsif @opts[:values].is_a?(Hash)
+        unless @opts[:values].keys.include?(v)
+          raise ServiceSkeleton::Error::InvalidEnvironmentError,
+                "Invalid value for #{@name}; must be one of #{@opts[:values].keys.join(", ")}"
+        end
+        @opts[:values][v]
+      end
+    end
+  end
+end

data/lib/service_skeleton/config_variable/float.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "service_skeleton/config_variable"
+
+class ServiceSkeleton::ConfigVariable::Float < ServiceSkeleton::ConfigVariable
+  private
+
+  def pluck_value(env)
+    maybe_default(env) do
+      value = env[@name.to_s]
+
+      if value =~ /\A-?\d+.?\d*\z/
+        value.to_f.tap do |f|
+          unless @opts[:range].include?(f)
+            raise ServiceSkeleton::Error::InvalidEnvironmentError,
+                  "Value #{f} for environment variable #{@name} is out of the valid range (must be between #{@opts[:range].first} and #{@opts[:range].last} inclusive)"
+          end
+        end
+      else
+        raise ServiceSkeleton::Error::InvalidEnvironmentError,
+              "Value #{value.inspect} for environment variable #{@name} is not a valid numeric value"
+      end
+    end
+  end
+end

data/lib/service_skeleton/config_variable/integer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "service_skeleton/config_variable"
+
+class ServiceSkeleton::ConfigVariable::Integer < ServiceSkeleton::ConfigVariable
+  private
+
+  def pluck_value(env)
+    maybe_default(env) do
+      value = env[@name.to_s]
+
+      if value =~ /\A-?\d+\z/
+        value.to_i.tap do |i|
+          unless @opts[:range].include?(i)
+            raise ServiceSkeleton::Error::InvalidEnvironmentError,
+                  "Value #{i} for environment variable #{@name} is out of the valid range (must be between #{@opts[:range].first} and #{@opts[:range].last} inclusive)"
+          end
+        end
+      else
+        raise ServiceSkeleton::Error::InvalidEnvironmentError,
+              "Value #{value.inspect} for environment variable #{@name} is not a valid integer value"
+      end
+    end
+  end
+end

data/lib/service_skeleton/config_variable/kv_list.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "service_skeleton/config_variable"
+
+class ServiceSkeleton::ConfigVariable::KVList < ServiceSkeleton::ConfigVariable
+  def redact!(env)
+    env.keys.each { |k| env[k] = "*SENSITIVE*" if k =~ @opts[:key_pattern] }
+  end
+
+  private
+
+  def pluck_value(env)
+    matches = env.select { |k, _| k.to_s =~ @opts[:key_pattern] }
+
+    if matches.empty?
+      if @opts.has_key?(:default)
+        @opts[:default]
+      else
+        raise ServiceSkeleton::Error::InvalidEnvironmentError,
+              "no keys for key-value list #{@name} specified"
+      end
+    else
+      matches.transform_keys { |k| @opts[:key_pattern].match(k.to_s)[1].to_sym }
+    end
+  end
+end

data/lib/service_skeleton/config_variable/path_list.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "service_skeleton/config_variable"
+
+class ServiceSkeleton::ConfigVariable::PathList < ServiceSkeleton::ConfigVariable
+  private
+
+  def pluck_value(env)
+    maybe_default(env) do
+      env[@name.to_s].split(":")
+    end
+  end
+end

data/lib/service_skeleton/config_variable/string.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "service_skeleton/config_variable"
+
+class ServiceSkeleton::ConfigVariable::String < ServiceSkeleton::ConfigVariable
+  private
+
+  def pluck_value(env)
+    maybe_default(env) do
+      env[@name.to_s]
+    end
+  end
+end

data/lib/service_skeleton/config_variable/url.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "service_skeleton/config_variable"
+
+class ServiceSkeleton::ConfigVariable::URL < ServiceSkeleton::ConfigVariable
+  def redact!(env)
+    if env.has_key?(@name.to_s)
+      super
+      uri = URI(env[@name.to_s])
+      if uri.password
+        uri.password = "*REDACTED*"
+        env[@name.to_s] = uri.to_s
+      end
+    end
+  end
+
+  private
+
+  def pluck_value(env)
+    maybe_default(env) do
+      begin
+        v = env[@name.to_s]
+        URI(v)
+      rescue URI::InvalidURIError
+        raise ServiceSkeleton::Error::InvalidEnvironmentError,
+              "Value for #{@name} (#{v}) does not appear to be a valid URL"
+      end
+
+      v
+    end
+  end
+end

data/lib/service_skeleton/config_variables.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "./error"
 
 require "service_skeleton/config_variable"
@@ -6,107 +8,67 @@ class ServiceSkeleton
   module ConfigVariables
     attr_reader :registered_variables
 
-    UNDEFINED = Class.new
+    UNDEFINED = Module.new
     private_constant :UNDEFINED
 
-    def register_variable(name, **opts, &callback)
+    def register_variable(name, klass, **opts)
       @registered_variables ||= []
 
-      @registered_variables << ServiceSkeleton::ConfigVariable.new(name, **opts, &callback)
+      if opts[:default] == UNDEFINED
+        opts.delete(:default)
+      end
+
+      @registered_variables << {
+        name: name,
+        class: klass,
+        opts: opts,
+      }
     end
 
     def string(var_name, default: UNDEFINED, sensitive: false)
-      register_variable(var_name, sensitive: sensitive) do |value|
-        maybe_default(value, default, var_name) do
-          value
-        end
-      end
+      register_variable(var_name, ConfigVariable::String, default: default, sensitive: sensitive)
     end
 
     def boolean(var_name, default: UNDEFINED, sensitive: false)
-      register_variable(var_name, sensitive: sensitive) do |value|
-        maybe_default(value, default, var_name) do
-          case value
-          when /\A(no|n|off|0|false)\z/i
-            false
-          when /\A(yes|y|on|1|true)\z/i
-            true
-          else
-            raise ServiceSkeleton::Error::InvalidEnvironmentError,
-                  "Value #{value.inspect} for environment variable #{var_name} is not a valid boolean value"
-          end
-        end
-      end
+      register_variable(var_name, ConfigVariable::Boolean, default: default, sensitive: sensitive)
     end
 
     def integer(var_name, default: UNDEFINED, sensitive: false, range: -Float::INFINITY..Float::INFINITY)
-      register_variable(var_name, sensitive: sensitive) do |value|
-        maybe_default(value, default, var_name) do
-          if value =~ /\A-?\d+\z/
-            value.to_i.tap do |i|
-              unless range.include?(i)
-                raise ServiceSkeleton::Error::InvalidEnvironmentError,
-                  "Value #{i} for environment variable #{var_name} is out of the valid range (must be between #{range.first} and #{range.last} inclusive)"
-              end
-            end
-          else
-            raise ServiceSkeleton::Error::InvalidEnvironmentError,
-                  "Value #{value.inspect} for environment variable #{var_name} is not a valid integer value"
-          end
-        end
-      end
+      register_variable(var_name, ConfigVariable::Integer, default: default, sensitive: sensitive, range: range)
     end
 
     def float(var_name, default: UNDEFINED, sensitive: false, range: -Float::INFINITY..Float::INFINITY)
-      register_variable(var_name, sensitive: sensitive) do |value|
-        maybe_default(value, default, var_name) do
-          if value =~ /\A-?\d+.?\d*\z/
-            value.to_f.tap do |i|
-              unless range.include?(i)
-                raise ServiceSkeleton::Error::InvalidEnvironmentError,
-                  "Value #{i} for environment variable #{var_name} is out of the valid range (must be between #{range.first} and #{range.last} inclusive)"
-              end
-            end
-          else
-            raise ServiceSkeleton::Error::InvalidEnvironmentError,
-                  "Value #{value.inspect} for environment variable #{var_name} is not a valid numeric value"
-          end
-        end
-      end
+      register_variable(var_name, ConfigVariable::Float, default: default, sensitive: sensitive, range: range)
     end
 
     def path_list(var_name, default: UNDEFINED, sensitive: false)
-      register_variable(var_name, sensitive: sensitive) do |value|
-        maybe_default(value, default, var_name) do
-          value.split(":")
-        end
-      end
+      register_variable(var_name, ConfigVariable::PathList, default: default, sensitive: sensitive)
     end
 
-    def kv_list(var_name, default: UNDEFINED, sensitive: false, key_pattern: nil)
-      key_pattern ||= /\A#{var_name}_(.*)\z/
-      register_variable(var_name, sensitive: sensitive, key_pattern: key_pattern) do |matches|
-        maybe_default(matches, default, var_name) do
-          matches.transform_keys do |k|
-            key_pattern.match(k)[1].to_sym
-          end
-        end
-      end
+    def kv_list(var_name, default: UNDEFINED, sensitive: false, key_pattern: /\A#{var_name}_(.*)\z/)
+      register_variable(var_name, ConfigVariable::KVList, default: default, sensitive: sensitive, key_pattern: key_pattern)
     end
 
-    private
-
-    def maybe_default(value, default, var_name)
-      if value.nil? || value == {}
-        if default == UNDEFINED
-          raise ServiceSkeleton::Error::InvalidEnvironmentError,
-                "Value for required environment variable #{var_name} not specified"
-        else
-          default
-        end
-      else
-        yield
+    def enum(var_name, values:, default: UNDEFINED, sensitive: false)
+      unless values.is_a?(Hash) || values.is_a?(Array)
+        raise ArgumentError,
+              "values option to enum must be a hash or array"
       end
+
+      register_variable(var_name, ConfigVariable::Enum, default: default, sensitive: sensitive, values: values)
+    end
+
+    def url(var_name, default: UNDEFINED, sensitive: false)
+      register_variable(var_name, ConfigVariable::URL, default: default, sensitive: sensitive)
     end
   end
 end
+
+require_relative "config_variable/string"
+require_relative "config_variable/boolean"
+require_relative "config_variable/integer"
+require_relative "config_variable/float"
+require_relative "config_variable/path_list"
+require_relative "config_variable/kv_list"
+require_relative "config_variable/enum"
+require_relative "config_variable/url"

data/lib/service_skeleton/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ServiceSkeleton
   class Error < StandardError
     class InvalidEnvironmentError < Error; end

data/lib/service_skeleton/filtering_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 module FilteringLogger

data/lib/service_skeleton/logging_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ServiceSkeleton
   module LoggingHelpers
     private

data/lib/service_skeleton/metrics_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ServiceSkeleton
   module MetricsMethods
     def service=(svc)

data/lib/service_skeleton/signal_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "./background_worker"
 require_relative "./logging_helpers"
 

data/service_skeleton.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'git-version-bump'
 rescue LoadError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_skeleton
 version: !ruby/object:Gem::Version
-  version: 0.0.0.34.g4f6fdb0
+  version: 0.0.0.41.g9507cda
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-17 00:00:00.000000000 Z
+date: 2019-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: frankenstein
@@ -274,6 +274,14 @@ files:
 - lib/service_skeleton/background_worker.rb
 - lib/service_skeleton/config.rb
 - lib/service_skeleton/config_variable.rb
+- lib/service_skeleton/config_variable/boolean.rb
+- lib/service_skeleton/config_variable/enum.rb
+- lib/service_skeleton/config_variable/float.rb
+- lib/service_skeleton/config_variable/integer.rb
+- lib/service_skeleton/config_variable/kv_list.rb
+- lib/service_skeleton/config_variable/path_list.rb
+- lib/service_skeleton/config_variable/string.rb
+- lib/service_skeleton/config_variable/url.rb
 - lib/service_skeleton/config_variables.rb
 - lib/service_skeleton/error.rb
 - lib/service_skeleton/filtering_logger.rb
@@ -299,7 +307,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: The bare bones of a service