env-checker 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f282676d3c5ae43ac48a7f113ee2b431bcc99b8a
-  data.tar.gz: 0eb4785314b9a54a23f18d0f34d8f5e02f11b05b
+  metadata.gz: 4c947e5de754d1f3516256571096b944fda28114
+  data.tar.gz: 2e9491a8e67ab09847f242d6e69bfcd426bc386c
 SHA512:
-  metadata.gz: e8b80854cb56561b72c4392f6b54ba8325e095333822904ccab9258176acce7d07c96a9faaaa2a80678c33e2fda69affdd9174afcebf6e4d825ecc608057422b
-  data.tar.gz: 84f4880d192b258c34b3c3b95d9f74e800fe84c4768cd2be0448110275e340c29c2e861e1abdfea52a4445bf26060b532e8eeaf279bf3e6ff52bbf6b68a12c65
+  metadata.gz: 468664562b4cdcf6237f7d3cba41472b88290db4fbfff3520ada45467fc98b363b91edf573f9c4650db1bef1ddb649d75b4ef1fa0ba4fef7dd673c844dea02fc
+  data.tar.gz: 74fa44ecf12cec49fd81199fb5cc83a5acc37f1f43bd070aa45abf70b62d07bd0657f7e4bfee41df28c969d76722d54b1eb6fa3471a456c5aac9458bd570f5cf

data/.rubocop_todo.yml

@@ -1,14 +1,14 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-11-17 20:42:19 +0100 using RuboCop version 0.45.0.
+# on 2016-11-21 18:20:26 +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: 3
+# Offense count: 2
 Metrics/AbcSize:
-  Max: 29
+  Max: 27
 
 # Offense count: 1
 # Configuration parameters: CountComments.
@@ -21,15 +21,10 @@ Metrics/BlockLength:
 Metrics/LineLength:
   Max: 95
 
-# Offense count: 5
+# Offense count: 4
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 22
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ModuleLength:
-  Max: 109
+  Max: 23
 
 # Offense count: 1
 # Cop supports --auto-correct.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    env-checker (0.1.7)
+    env-checker (0.1.8)
       slack-notifier (~> 1.5)
       thor (~> 0.19.1)
 

data/README.md

@@ -93,23 +93,36 @@ end
 
 Inline passing the variables with the shell:
 
-    $ env-checker check --optional MyOptVar1 MyOptVar2 --required MyReqVar1 MyReqVar2
-
-    Usage:
-      env-checker check
+```shell
+$ env-checker check --optional MyOptVar1 MyOptVar2 --required MyReqVar1 MyReqVar2
+
+Usage:
+  env-checker check
+
+Options:
+  e, [--environment=ENVIRONMENT]
+  cf, [--config-file=CONFIG_FILE]
+  r, required, [--required-variables=one two three]
+  o, optional, [--optional-variables=one two three]
+  slack, [--slack-webhook-url=SLACK_WEBHOOK_URL]
+          [--run=RUN]
+```
 
-    Options:
-      e, [--environment=ENVIRONMENT]
-      cf, [--config-file=CONFIG_FILE]
-      r, required, [--required-variables=one two three]
-      o, optional, [--optional-variables=one two three]
-      slack, [--slack-webhook-url=SLACK_WEBHOOK_URL]
-              [--run=RUN]
+- All the parameters can be set by environment variables like:
 
+```shell
+$ export ENV_CHECKER_ENVIRONMENT=staging
+$ export ENV_CHECKER_REQUIRED_VARIABLES=one two three
+$ export ENV_CHECKER_OPTIONAL_VARIABLES=one two three
+$ export ENV_CHECKER_SLACK_WEBHOOK_URL=https://hooks.slack.com/services/.../.../.../
+$ env-checker check
+```
 
-Example with a `.yml` [example file](https://raw.githubusercontent.com/ryanfox1985/env-checker/master/sample_config.yml):
+- Example with a `.yml` [example file](https://raw.githubusercontent.com/ryanfox1985/env-checker/master/sample_config.yml):
 
-    $ env-checker check --config_file sample_config.yml
+```shell
+$ env-checker check --config_file sample_config.yml
+```
 
 #### Show help
 

data/lib/env_checker.rb

@@ -5,7 +5,6 @@ require 'env_checker/version'
 require 'env_checker/missing_keys_error'
 require 'env_checker/configuration'
 require 'env_checker/cli'
-require 'byebug'
 
 module EnvChecker
   class << self
@@ -58,26 +57,23 @@ module EnvChecker
     def create_config_from_parameters(options)
       config = Configuration.new
 
+      attributes = %w(environment
+                      optional_variables
+                      required_variables
+                      slack_webhook_url)
+
       if options[:config_file]
         from_file = YAML.load_file(options[:config_file])
-        config.optional_variables = from_file['optional_variables']
-        config.required_variables = from_file['required_variables']
-        config.slack_webhook_url = from_file['slack_webhook_url']
 
-        return { 'global' => config }
-      end
-
-      config.environment = options[:environment] if options[:environment]
-      if options[:optional_variables]
-        config.optional_variables = options[:optional_variables]
-      end
+        attributes.each do |a|
+          config.public_send("#{a}=", from_file[a]) if from_file[a]
+        end
 
-      if options[:required_variables]
-        config.required_variables = options[:required_variables]
+        return { 'global' => config }
       end
 
-      if options[:slack_webhook_url]
-        config.slack_webhook_url = options[:slack_webhook_url]
+      attributes.each do |a|
+        config.public_send("#{a}=", options[a.to_sym]) if options[a.to_sym]
       end
 
       { 'global' => config }
@@ -123,19 +119,9 @@ module EnvChecker
 
       message = format_error_message(environment, error_message)
 
-      configuration.slack_notifier &&
-        configuration.slack_notifier.ping(message)
+      configuration.notify_slack(message)
       # TODO: add other integrations like email...
-
-      configuration.logger &&
-        case type
-        when :warning
-          configuration.logger.warn(message)
-        when :error
-          configuration.logger.error(message)
-        else
-          configuration.logger.info(message)
-        end
+      configuration.notify_logger(type, message)
     end
 
     def format_error_message(environment, error_message)

data/lib/env_checker/cli.rb

@@ -27,11 +27,12 @@ module EnvChecker
 
       my_options = {}
       variables.each do |v|
-        if ENV[v.upcase]
-          my_options[v.to_sym] ||= if v.upcase.include?('VARIABLES')
-                                     ENV[v.upcase].split(' ')
+        env_var_name = "env_checker_#{v}".upcase
+        if ENV[env_var_name]
+          my_options[v.to_sym] ||= if env_var_name.include?('_VARIABLES')
+                                     ENV[env_var_name].split(' ')
                                    else
-                                     ENV[v.upcase]
+                                     ENV[env_var_name]
                                    end
         end
         my_options[v.to_sym] = options[v.to_sym] if options[v.to_sym]

data/lib/env_checker/configuration.rb

@@ -35,6 +35,24 @@ module EnvChecker
       true
     end
 
+    def notify_slack(message)
+      slack_notifier && slack_notifier.ping(message)
+    rescue StandardError => e
+      notify_logger(:error, e)
+    end
+
+    def notify_logger(type, message)
+      logger &&
+        case type
+        when :warning
+          logger.warn(message)
+        when :error
+          logger.error(message)
+        else
+          logger.info(message)
+        end
+    end
+
     private
 
     def valid?

data/lib/env_checker/version.rb

@@ -1,3 +1,3 @@
 module EnvChecker
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

data/sample_config.yml

@@ -1,3 +1,8 @@
+environments:
+  - staging
+  - production
+  - test
+
 optional_variables:
   - MyOptVar1
   - MyOptVar2
@@ -6,3 +11,23 @@ required_variables:
   - MyReqVar2
 
 slack_webhook_url: https://hooks.slack.com/services/.../.../...
+
+staging:
+  optional_variables:
+    - Staging_MyOptVar1
+    - Staging_MyOptVar2
+  required_variables:
+    - Staging_MyReqVar1
+    - Staging_MyReqVar2
+
+  slack_webhook_url: https://hooks.slack.com/services/.../.../...
+
+production:
+  optional_variables:
+    - Production_MyOptVar1
+    - Production_MyOptVar2
+  required_variables:
+    - Production_MyReqVar1
+    - Production_MyReqVar2
+
+  slack_webhook_url: https://hooks.slack.com/services/.../.../...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env-checker
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Guillermo Guerrero Ibarra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2016-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor