env-checker 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 157bc8d87b47465463bf92d1f36cabd512383af7
-  data.tar.gz: 38eb8608f2b9ec6bc737da8150eecddc4a0c7d65
+  metadata.gz: 1f0f0740e16308b5524249cb91466b74335522f0
+  data.tar.gz: 54bf8b5c0295e8e77c65186a59f996e4391b82cd
 SHA512:
-  metadata.gz: 5207f2040ab213eb3fae659885f674ea09f04d2f19271a21b52d3aa531ce310fd7928f2a57e11506e4b044ee0d3d432098696ee0798b12bf4a510cae139cc359
-  data.tar.gz: dc18440c297ef31674862717097829cd008526492f5fc7e25a16ea7cef02484b04f1630e48da427e17ade50bf40e66c5ac48e1f939c24e268a73ca084aac1b6b
+  metadata.gz: c81fc0e2b03c48cef8e37d6800362aa3e6f35d02109f17f2599d3f330a712cbcc298c8bbb75fce557725c2f36b7bdc8e056b48051ada02170742da61629bde7d
+  data.tar.gz: 38ed741d13ca139d1012450271dab20479e1252114e8c4928bd0cf1df035e3891ef6c07a46c6f12918112004435497a748bc42317eb7ad0ba076ff587c9511ed

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    env-checker (0.1.3)
-      thor
+    env-checker (0.1.4)
+      slack-notifier (~> 1.5.1)
+      thor (~> 0.19.1)
 
 GEM
   remote: https://rubygems.org/
@@ -48,6 +49,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
+    slack-notifier (1.5.1)
     term-ansicolor (1.4.0)
       tins (~> 1.0)
     thor (0.19.1)
@@ -58,14 +60,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (>= 1.13)
-  byebug (>= 9.0.5)
-  coveralls
+  bundler (~> 1.13)
+  byebug (~> 9.0)
+  coveralls (~> 0.8)
   env-checker!
-  rake (>= 10.0)
-  rspec (>= 3.0)
-  rubocop
-  simplecov
+  rake (~> 11.3)
+  rspec (~> 3.5)
+  rubocop (~> 0.45)
+  simplecov (~> 0.12)
 
 BUNDLED WITH
    1.13.6

data/README.md

@@ -55,6 +55,7 @@ environment variables. Example:
 require 'env_checker'
 
 EnvChecker.configure do |config|
+  config.slack_webhook_url = 'https://hooks.slack.com/services/.../.../.../'
   config.optional_variables = %w(MyOptVar1 MyOptVar2)
   config.required_variables = %w(MyReqVar1 MyReqVar2)
 

data/env-checker.gemspec

@@ -32,12 +32,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_runtime_dependency 'thor', '>= 0'
-  spec.add_development_dependency 'bundler', '>= 1.13'
-  spec.add_development_dependency 'rake', '>= 10.0'
-  spec.add_development_dependency 'rspec', '>= 3.0'
-  spec.add_development_dependency 'rubocop', '>= 0'
-  spec.add_development_dependency 'coveralls', '>= 0'
-  spec.add_development_dependency 'simplecov', '>= 0'
-  spec.add_development_dependency 'byebug', '>= 9.0.5'
+  spec.add_runtime_dependency 'thor', '~> 0.19.1'
+  spec.add_runtime_dependency 'slack-notifier', '~> 1.5.1'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.45'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'byebug', '~> 9.0'
 end

data/lib/env_checker.rb

@@ -22,6 +22,9 @@ module EnvChecker
     def configure
       self.configuration = Configuration.new
       yield(configuration)
+
+      configuration.valid? &&
+        configuration.after_initialize
     end
 
     def cli_configure_and_check(options)
@@ -47,12 +50,14 @@ module EnvChecker
         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 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
     end
@@ -63,11 +68,13 @@ module EnvChecker
         configuration.optional_variables.empty?
 
       missing_keys = missing_keys_env(configuration.optional_variables)
+      return true if missing_keys.empty?
+
       log_message(:warning,
                   configuration.environment,
-                  "Warning! Missing these optional variables: #{missing_keys}")
+                  "Warning! Missing optional variables: #{missing_keys}")
 
-      missing_keys.empty?
+      false
     end
 
     def check_required_variables
@@ -80,7 +87,7 @@ module EnvChecker
       if missing_keys.any?
         log_message(:error,
                     configuration.environment,
-                    "Error! Missing these required variables: #{missing_keys}")
+                    "Error! Missing required variables: #{missing_keys}")
 
         raise MissingKeysError.new(missing_keys)
       end
@@ -92,20 +99,25 @@ module EnvChecker
       return unless error_message
 
       message = format_error_message(environment, error_message)
-      # TODO: add other integrations like slack, email...
-      return unless configuration.logger
-
-      case type
-      when :warning
-        configuration.logger.warn(message)
-      when :error
-        configuration.logger.error(message)
-      else
-        configuration.logger.info(message)
-      end
+
+      configuration.slack_notifier &&
+        configuration.slack_notifier.ping(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
     end
 
     def format_error_message(environment, error_message)
+      return [] unless error_message
+
       messages = []
       messages << '[EnvChecker]'
       messages << "[#{environment}]" if environment

data/lib/env_checker/cli.rb

@@ -10,13 +10,18 @@ module EnvChecker
     option :config_file, :aliases => :cf, :type => :string
     option :required, :aliases => :r, :type => :array
     option :optional, :aliases => :o, :type => :array
+    option :slack_webhook_url, :aliases => :slack, :type => :string
     desc 'check', 'Check optional and required environment variables.'
     def check
       output = []
       output << 'Variables: '
-      output << "- Config file: #{options[:config_file]}" if options[:config_file]
-      output << "- Optional: #{options[:optional]}" if options[:optional]
-      output << "- Required: #{options[:required]}" if options[:required]
+
+      variables = %w(config_file slack_webhook_url optional required)
+      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 << "- Config file: #{options[v.to_sym]}" if options[v.to_sym]
+      end
       puts output.join("\n")
 
       EnvChecker.cli_configure_and_check(options)

data/lib/env_checker/configuration.rb

@@ -1,15 +1,34 @@
 require 'logger'
+require 'slack-notifier'
 
 module EnvChecker
+  class ConfigurationError < StandardError; end
+
   class Configuration
-    attr_accessor :required_variables, :optional_variables, :logger, :environment
+    attr_accessor :required_variables, :optional_variables, :logger,
+                  :environment, :slack_webhook_url, :slack_notifier
 
     # Has default settings, which can be overridden in the initializer.
     def initialize
       @environment = ENV['RACK_ENV'] || ENV['RAILS_ENV']
       @required_variables = []
       @optional_variables = []
+      @slack_webhook_url = nil
+      @slack_notifier = nil
       @logger = Logger.new(STDERR)
     end
+
+    def valid?
+      # TODO: check types and raise invalid config
+      true
+    end
+
+    def after_initialize
+      @slack_webhook_url &&
+        @slack_webhook_url != '' &&
+        @slack_notifier = Slack::Notifier.new(@slack_webhook_url)
+
+      true
+    end
   end
 end

data/lib/env_checker/version.rb

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

data/sample_config.yml

@@ -3,4 +3,6 @@ optional_variables:
   - MyOptVar2
 required_variables:
   - MyReqVar1
-  - MyReqVar2  
+  - MyReqVar2
+
+slack_webhook_url: https://hooks.slack.com/services/.../.../...

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: env-checker
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Guillermo Guerrero Ibarra
@@ -14,114 +14,128 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.45'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.45'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.0.5
+        version: '9.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.0.5
+        version: '9.0'
 description: |2
       When you are developing a new feature if your app have some environments
       like test, staging and production is easy to forget an environment variable