env-checker 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d606bb4975be0f760db096c69b4a23c746c6ec2f
-  data.tar.gz: 4d302b7b62a1dd1af3fbc4429128ed1060702a7e
+  metadata.gz: f282676d3c5ae43ac48a7f113ee2b431bcc99b8a
+  data.tar.gz: 0eb4785314b9a54a23f18d0f34d8f5e02f11b05b
 SHA512:
-  metadata.gz: 28805353881884386a46352ce6d3d6a435bcddc1394834a4d973816aabf3f46e9d428c52ae19f7e6596f10d0a7dca921160bf335d607d03b24e41d2179e0da8a
-  data.tar.gz: 01edfd571a14417c19f1d8df31b46bebe5fd1d18a73ada466cc02b8104ac8a88d25d6bae48c95e535ed0ffa6a0cfa69c1eba942c8a38603ddd288d68d41c49d9
+  metadata.gz: e8b80854cb56561b72c4392f6b54ba8325e095333822904ccab9258176acce7d07c96a9faaaa2a80678c33e2fda69affdd9174afcebf6e4d825ecc608057422b
+  data.tar.gz: 84f4880d192b258c34b3c3b95d9f74e800fe84c4768cd2be0448110275e340c29c2e861e1abdfea52a4445bf26060b532e8eeaf279bf3e6ff52bbf6b68a12c65

data/.rubocop_todo.yml

@@ -1,34 +1,35 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-11-12 02:10:52 +0100 using RuboCop version 0.45.0.
+# on 2016-11-17 20:42:19 +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: 4
+# Offense count: 3
 Metrics/AbcSize:
-  Max: 23
+  Max: 29
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/BlockLength:
   Max: 32
 
-# Offense count: 1
-Metrics/CyclomaticComplexity:
-  Max: 7
-
 # Offense count: 3
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 95
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 13
+  Max: 22
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 109
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -44,7 +45,7 @@ Style/ExtraSpacing:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-# Offense count: 9
+# Offense count: 12
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
 # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys

data/Gemfile.lock

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

data/README.md

@@ -20,10 +20,16 @@ You can define two variable lists:
 - **optional_variables:** These variables are from secondary services (Your app
   can run without these variables, like some `THRESHOLD`)
 
+By default `EnvChecker` checks the global environment and after the current
+or set environment.
+
 All the missing variables are notified by default in the `STDERR`. When a
 required variable is missing the gem raises an error `MissingKeysError` and
 stops the application.
 
+By convention all the environment variable names must be in up case, the gem
+internally parse the required_variables and optional_variables to up case.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -89,6 +95,18 @@ Inline passing the variables with the 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]
+
+
 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

data/lib/env_checker.rb

@@ -5,6 +5,7 @@ require 'env_checker/version'
 require 'env_checker/missing_keys_error'
 require 'env_checker/configuration'
 require 'env_checker/cli'
+require 'byebug'
 
 module EnvChecker
   class << self
@@ -18,23 +19,32 @@ module EnvChecker
     end
 
     def cli_configure_and_check(options)
-      return if !options[:optional] &&
-                !options[:required] &&
-                !options[:config_file]
+      if run_configure_and_check(options) && options[:run]
+        exit(system(options[:run]))
+      end
+
+      exit(true)
+    end
+
+    private
+
+    def run_configure_and_check(options)
+      return true if !options[:optional_variables] &&
+                     !options[:required_variables] &&
+                     !options[:config_file]
 
       self.configurations = create_config_from_parameters(options)
 
       begin
         exit(1) unless after_configure_and_check(configurations['global'])
-        exit(true)
       rescue EnvChecker::MissingKeysError
         exit 2
       rescue EnvChecker::ConfigurationError
         exit 3
       end
-    end
 
-    private
+      true
+    end
 
     def after_configure_and_check(configuration)
       configuration.after_initialize
@@ -58,9 +68,17 @@ module EnvChecker
       end
 
       config.environment = options[:environment] if options[:environment]
-      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]
+      if options[:optional_variables]
+        config.optional_variables = options[:optional_variables]
+      end
+
+      if options[:required_variables]
+        config.required_variables = options[:required_variables]
+      end
+
+      if options[:slack_webhook_url]
+        config.slack_webhook_url = options[:slack_webhook_url]
+      end
 
       { 'global' => config }
     end

data/lib/env_checker/cli.rb

@@ -12,20 +12,34 @@ module EnvChecker
     option :required_variables, :aliases => [:r, :required], :type => :array
     option :optional_variables, :aliases => [:o, :optional], :type => :array
     option :slack_webhook_url, :aliases => :slack, :type => :string
+    option :run, :type => :string
     desc 'check', 'Check optional and required environment variables.'
     def check
       output = []
       output << 'Variables: '
 
-      variables = %w(config_file slack_webhook_url optional required)
+      variables = %w(config_file
+                     slack_webhook_url
+                     environment
+                     run
+                     optional_variables
+                     required_variables)
+
+      my_options = {}
       variables.each do |v|
-        # TODO: get config variables from current environment
-        # options[v.to_sym] ||= ENV[v.to_sym] if ENV[v.to_sym]
-        output << "- #{v}: #{options[v.to_sym]}" if options[v.to_sym]
+        if ENV[v.upcase]
+          my_options[v.to_sym] ||= if v.upcase.include?('VARIABLES')
+                                     ENV[v.upcase].split(' ')
+                                   else
+                                     ENV[v.upcase]
+                                   end
+        end
+        my_options[v.to_sym] = options[v.to_sym] if options[v.to_sym]
+        output << "- #{v}: #{my_options[v.to_sym]}" if my_options[v.to_sym]
       end
       puts output.join("\n")
 
-      EnvChecker.cli_configure_and_check(options)
+      EnvChecker.cli_configure_and_check(my_options)
     end
   end
 end

data/lib/env_checker/configuration.rb

@@ -26,6 +26,12 @@ module EnvChecker
         @slack_webhook_url != '' &&
         @slack_notifier = Slack::Notifier.new(@slack_webhook_url)
 
+      @required_variables &&
+        @required_variables = @required_variables.map(&:upcase)
+
+      @optional_variables &&
+        @optional_variables = @optional_variables.map(&:upcase)
+
       true
     end
 

data/lib/env_checker/version.rb

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

metadata

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