env-checker 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f0f0740e16308b5524249cb91466b74335522f0
-  data.tar.gz: 54bf8b5c0295e8e77c65186a59f996e4391b82cd
+  metadata.gz: 787f95fa9585bada75c7b3343ecde721a5a71ca0
+  data.tar.gz: d33b2fbd2ee5c321e9134ac2a37df57bd84924b7
 SHA512:
-  metadata.gz: c81fc0e2b03c48cef8e37d6800362aa3e6f35d02109f17f2599d3f330a712cbcc298c8bbb75fce557725c2f36b7bdc8e056b48051ada02170742da61629bde7d
-  data.tar.gz: 38ed741d13ca139d1012450271dab20479e1252114e8c4928bd0cf1df035e3891ef6c07a46c6f12918112004435497a748bc42317eb7ad0ba076ff587c9511ed
+  metadata.gz: 4c6ba33bc106c8c27f3fa7678c2defe258646aa270de98db4d3494a62709854414763d0268dec3d2478c1cde877da64ad489194cf579376ec0bc6a41d89ef242
+  data.tar.gz: 867efafdfb59b5232bf0fe6cb79be37a0857018a8e404e8d14251a4cc13f7bd7cfe232ccda7ccd6ce9f5dad9aac1cab132f81a982efc71014bd244d493218b2e

data/.rubocop_todo.yml

@@ -1,36 +1,34 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-11-11 15:00:02 +0100 using RuboCop version 0.45.0.
+# on 2016-11-12 02:10:52 +0100 using RuboCop version 0.45.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
+# Offense count: 4
 Metrics/AbcSize:
-  Max: 21
+  Max: 23
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/BlockLength:
-  Max: 31
+  Max: 32
 
-# Offense count: 2
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 3
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 82
+  Max: 95
 
-# Offense count: 2
+# Offense count: 4
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 11
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/EmptyLines:
-  Exclude:
-    - 'spec/env_checker/cli_spec.rb'
+  Max: 13
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -46,7 +44,7 @@ Style/ExtraSpacing:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-# Offense count: 7
+# Offense count: 9
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
 # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
@@ -61,7 +59,7 @@ Style/MutableConstant:
   Exclude:
     - 'lib/env_checker/version.rb'
 
-# Offense count: 1
+# Offense count: 4
 # Cop supports --auto-correct.
 # Configuration parameters: SupportedStyles.
 # SupportedStyles: compact, exploded

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    env-checker (0.1.4)
-      slack-notifier (~> 1.5.1)
+    env-checker (0.1.5)
+      slack-notifier (~> 1.5)
       thor (~> 0.19.1)
 
 GEM

data/README.md

@@ -78,18 +78,6 @@ EnvChecker.configure do |config|
   # config.logger = Logger.new('log/env_checker.log')   # Use this file
   # config.logger = Logger.new('/dev/null')             # Don't log at all (on a Unix system)
 end
-
-# Example to run always
-[YOUR_APP]::Application.config.after_initialize do
-  EnvChecker.check_environment_variables
-end
-
-# Example to run in specific environments
-if Rails.env.production? || Rails.env.test?
-  [YOUR_APP]::Application.config.after_initialize do
-    EnvChecker.check_environment_variables
-  end
-end
 ```
 
 

data/env-checker.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_runtime_dependency 'thor', '~> 0.19.1'
-  spec.add_runtime_dependency 'slack-notifier', '~> 1.5.1'
+  spec.add_runtime_dependency 'slack-notifier', '~> 1.5'
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 11.3'
   spec.add_development_dependency 'rspec', '~> 3.5'

data/lib/env_checker.rb

@@ -8,23 +8,13 @@ require 'env_checker/cli'
 
 module EnvChecker
   class << self
-    attr_accessor :configuration
-
-    def check_environment_variables
-      return true unless configuration
-
-      bov = check_optional_variables
-      brv = check_required_variables
-
-      bov & brv
-    end
+    attr_accessor :configurations
 
     def configure
-      self.configuration = Configuration.new
-      yield(configuration)
-
-      configuration.valid? &&
-        configuration.after_initialize
+      self.configurations ||= {}
+      configurations['global'] = Configuration.new
+      yield(configurations['global'])
+      after_configure_and_check(configurations['global'])
     end
 
     def cli_configure_and_check(options)
@@ -32,17 +22,29 @@ module EnvChecker
                 !options[:required] &&
                 !options[:config_file]
 
-      self.configuration = create_config_from_parameters(options)
+      self.configurations = create_config_from_parameters(options)
 
       begin
-        check_environment_variables ? exit(true) : exit(1)
+        exit(1) unless after_configure_and_check(configurations['global'])
+        exit(true)
       rescue EnvChecker::MissingKeysError
         exit 2
+      rescue EnvChecker::ConfigurationError
+        exit 3
       end
     end
 
     private
 
+    def after_configure_and_check(configuration)
+      configuration.after_initialize
+
+      bov = check_optional_variables(configuration)
+      brv = check_required_variables(configuration)
+
+      bov & brv
+    end
+
     def create_config_from_parameters(options)
       config = Configuration.new
 
@@ -52,17 +54,17 @@ module EnvChecker
         config.required_variables = from_file['required_variables']
         config.slack_webhook_url = from_file['slack_webhook_url']
 
-        return config
+        return { 'global' => config }
       end
 
       config.optional_variables = options[:optional] if options[:optional]
       config.required_variables = options[:required] if options[:required]
       config.slack_webhook_url = options[:slack] if options[:slack]
 
-      config
+      { 'global' => config }
     end
 
-    def check_optional_variables
+    def check_optional_variables(configuration)
       return true if
         !configuration.optional_variables ||
         configuration.optional_variables.empty?
@@ -70,14 +72,15 @@ module EnvChecker
       missing_keys = missing_keys_env(configuration.optional_variables)
       return true if missing_keys.empty?
 
-      log_message(:warning,
+      log_message(configuration,
+                  :warning,
                   configuration.environment,
                   "Warning! Missing optional variables: #{missing_keys}")
 
       false
     end
 
-    def check_required_variables
+    def check_required_variables(configuration)
       return true if
         !configuration.required_variables ||
         configuration.required_variables.empty?
@@ -85,7 +88,8 @@ module EnvChecker
       missing_keys = missing_keys_env(configuration.required_variables)
 
       if missing_keys.any?
-        log_message(:error,
+        log_message(configuration,
+                    :error,
                     configuration.environment,
                     "Error! Missing required variables: #{missing_keys}")
 
@@ -95,7 +99,7 @@ module EnvChecker
       true
     end
 
-    def log_message(type, environment, error_message)
+    def log_message(configuration, type, environment, error_message)
       return unless error_message
 
       message = format_error_message(environment, error_message)

data/lib/env_checker/cli.rb

@@ -18,9 +18,9 @@ module EnvChecker
 
       variables = %w(config_file slack_webhook_url optional required)
       variables.each do |v|
-        # TODO: get config variables from current environment
+        # TODO: get config variables from current environment
         # options[v.to_sym] ||= ENV[v.to_sym] if ENV[v.to_sym]
-        output << "- Config file: #{options[v.to_sym]}" if options[v.to_sym]
+        output << "- #{v}: #{options[v.to_sym]}" if options[v.to_sym]
       end
       puts output.join("\n")
 

data/lib/env_checker/configuration.rb

@@ -1,5 +1,6 @@
 require 'logger'
 require 'slack-notifier'
+require 'uri'
 
 module EnvChecker
   class ConfigurationError < StandardError; end
@@ -18,17 +19,32 @@ module EnvChecker
       @logger = Logger.new(STDERR)
     end
 
-    def valid?
-      # TODO: check types and raise invalid config
-      true
-    end
-
     def after_initialize
+      valid?
+
       @slack_webhook_url &&
         @slack_webhook_url != '' &&
         @slack_notifier = Slack::Notifier.new(@slack_webhook_url)
 
       true
     end
+
+    private
+
+    def valid?
+      if required_variables && required_variables.class != Array
+        raise ConfigurationError.new("Invalid value required_variables: #{required_variables}")
+      end
+
+      if optional_variables && optional_variables.class != Array
+        raise ConfigurationError.new("Invalid value optional_variables: #{optional_variables}")
+      end
+
+      if slack_webhook_url && slack_webhook_url != ~ URI.regexp
+        raise ConfigurationError.new("Invalid value slack_webhook_url: #{slack_webhook_url}")
+      end
+
+      true
+    end
   end
 end

data/lib/env_checker/version.rb

@@ -1,3 +1,3 @@
 module EnvChecker
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env-checker
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Guillermo Guerrero Ibarra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement