env-checker 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcca1afc9d8e9b643130ad0acc664d52628187c6
-  data.tar.gz: dfd883610347cdfac5112599fa332c8671dcc7b4
+  metadata.gz: 3b69d2729808eb8df421332bd614066c161fdeda
+  data.tar.gz: 6a78a5b6c6e31ba5e25f7e8f52d0e92797f46197
 SHA512:
-  metadata.gz: 1fea0979d2f9412ee81e4eca2251ec6cca3b3ae32aec6f5602265f426880a10d183ed6ca94a3d8c0c30eb8f8ca3a8b805c9ad41fb8d76b9681872a3e0e0cc272
-  data.tar.gz: 99a3af47a75a5635155be3671b1cd05075e46548389096334ab12479822116209257fb185b413550f210c16532cc2db0aeace7c604dc9e76546825c39090d09a
+  metadata.gz: 6377aec544e2d13020113253fdf63eb35fefa0a008ce0067e99c96599bb2bb81a7894bfc9eaf00ff109e5e23d1d64a8ff7663539d7be8be8ccb2c71d06b6b0a1
+  data.tar.gz: c38c14c7ea5b277e1658718c47e70d1a1f2b6d50cfac3f66e1d3578bf24ac6c40273353f05fc599f890c026b8e1cfb3ab47240ab607cb8b220111974c689bc91

data/.rubocop_todo.yml

@@ -1,18 +1,39 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-11-05 22:54:49 +0100 using RuboCop version 0.45.0.
+# on 2016-11-08 20:21:40 +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
+Metrics/AbcSize:
+  Max: 16
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/BlockLength:
+  Max: 30
+
+# Offense count: 1
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 84
+  Max: 81
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 11
 
-# Offense count: 13
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
+Style/ExtraSpacing:
+  Exclude:
+    - 'env-checker.gemspec'
+
+# Offense count: 15
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: when_needed, always
@@ -22,7 +43,9 @@ Style/FrozenStringLiteralComment:
     - 'Rakefile'
     - 'bin/console'
     - 'env-checker.gemspec'
+    - 'exe/env-checker'
     - 'lib/env_checker.rb'
+    - 'lib/env_checker/cli.rb'
     - 'lib/env_checker/configuration.rb'
     - 'lib/env_checker/missing_keys_error.rb'
     - 'lib/env_checker/version.rb'
@@ -32,7 +55,7 @@ Style/FrozenStringLiteralComment:
     - 'spec/env_checker_spec.rb'
     - 'spec/spec_helper.rb'
 
-# Offense count: 1
+# Offense count: 5
 # Cop supports --auto-correct.
 # Configuration parameters: SupportedStyles, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
 # SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
@@ -45,13 +68,6 @@ Style/MutableConstant:
   Exclude:
     - 'lib/env_checker/version.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'env-checker.gemspec'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: SupportedStyles.
@@ -59,8 +75,9 @@ Style/PercentLiteralDelimiters:
 Style/RaiseArgs:
   EnforcedStyle: compact
 
-# Offense count: 2
+# Offense count: 1
 # Cop supports --auto-correct.
-Style/UnneededPercentQ:
+# Configuration parameters: AllowForAlignment.
+Style/SpaceAroundOperators:
   Exclude:
     - 'env-checker.gemspec'

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    env-checker (0.1.1)
+    env-checker (0.1.2)
+      thor (~> 0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -8,10 +8,21 @@
 [![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/ryanfox1985/env-checker/blob/master/LICENSE)
 
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/env_checker`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
+Don't forget your environment variables when your app changes the environment.
+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 in the
+middle of the process. Also when you migrate the app to another server is easy
+to forget an environment variable.  
+
+You can define two variable lists:
+- **required_variables:** These variables are mandatory (Your app cannot run
+  without these variables, like `DATABASE_URL`)
+- **optional_variables:** These variables are from secondary services (Your app
+  can run without these variables, like some `THRESHOLD`)
+
+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.
 
 ## Installation
 
@@ -44,8 +55,16 @@ environment variables. Example:
 require 'env_checker'
 
 EnvChecker.configure do |config|
-  config.optional_variables = %w(MyVar1 MyVar2)
-  config.required_variables = %w(MyVar1 MyVar2)
+  config.optional_variables = %w(MyOptVar1 MyOptVar2)
+  config.required_variables = %w(MyReqVar1 MyReqVar2)
+
+  # ENVIRONMENT
+  # ===========
+  # Default is:
+  # environment = ENV['RACK_ENV'] || ENV['RAILS_ENV']
+  #
+  # Other possible value
+  # config.environment = 'MyEnv'  
 
   # LOGGER
   # ======
@@ -73,9 +92,19 @@ end
 ```
 
 
-### Standalone and CLI
+### Standalone and CLI usages
+
+#### Check optional and required variables
+
+    $ env-checker check --optional MyOptVar1 MyOptVar2 --required MyReqVar1 MyReqVar2
+
+#### Show help
+
+    $ env-checker help
+
+#### Show version
 
-TODO: Write usage instructions here
+    $ env-checker version
 
 
 ## Contributing

data/env-checker.gemspec

@@ -9,8 +9,18 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Guillermo Guerrero Ibarra']
   spec.email         = ['guillermo@guerreroibarra.com']
 
-  spec.summary       = %q{Check your environment variables and don't forget anyone.}
-  spec.description   = %q{Check your environment variables and don't forget anyone.}
+  spec.summary       = <<-EOF
+    Don't forget your environment variables when your app changes the
+    environment.
+  EOF
+
+  spec.description   = <<-EOF
+    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
+    in the middle of the process. Also when you migrate the app to another
+    server is easy to forget an environment variable.
+  EOF
+
   spec.homepage      = 'https://github.com/ryanfox1985/env-checker'
   spec.license       = 'MIT'
 
@@ -20,7 +30,9 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   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'

data/exe/env-checker

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'env_checker'
+
+CLI.start(ARGV)

data/lib/env_checker.rb

@@ -3,12 +3,15 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'env_checker/version'
 require 'env_checker/missing_keys_error'
 require 'env_checker/configuration'
+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
 
@@ -20,40 +23,64 @@ module EnvChecker
       yield(configuration)
     end
 
+    def cli_configure_and_check(options)
+      return if !options[:optional] && !options[:required]
+
+      self.configuration = create_config_from_parameters(options)
+
+      begin
+        check_environment_variables ? exit(true) : exit(1)
+      rescue EnvChecker::MissingKeysError
+        exit 2
+      end
+    end
+
     private
 
+    def create_config_from_parameters(options)
+      config = Configuration.new
+      config.optional_variables = options[:optional] if options[:optional]
+      config.required_variables = options[:required] if options[:required]
+
+      config
+    end
+
     def check_optional_variables
-      if configuration.optional_variables
-        missing_keys = missing_keys_env(configuration.optional_variables)
-        log_message(:warning, "EnvChecker: Warning missing these optional
-          variables: [#{missing_keys}]")
+      return true if
+        !configuration.optional_variables ||
+        configuration.optional_variables.empty?
 
-        return missing_keys.empty?
-      end
+      missing_keys = missing_keys_env(configuration.optional_variables)
+      log_message(:warning,
+                  configuration.environment,
+                  "Warning! Missing these optional variables: #{missing_keys}")
 
-      true
+      missing_keys.empty?
     end
 
     def check_required_variables
-      if configuration.required_variables
-        missing_keys = missing_keys_env(configuration.required_variables)
+      return true if
+        !configuration.required_variables ||
+        configuration.required_variables.empty?
+
+      missing_keys = missing_keys_env(configuration.required_variables)
 
-        if missing_keys.any?
-          log_message(:error, "EnvChecker: Error missing these required
-            variables: [#{missing_keys}]")
+      if missing_keys.any?
+        log_message(:error,
+                    configuration.environment,
+                    "Error! Missing these required variables: #{missing_keys}")
 
-          raise MissingKeysError.new(missing_keys)
-        end
+        raise MissingKeysError.new(missing_keys)
       end
 
       true
     end
 
-    def log_message(type, message)
-      return unless configuration
+    def log_message(type, environment, error_message)
+      return unless error_message
 
+      message = format_error_message(environment, error_message)
       # TODO: add other integrations like slack, email...
-
       return unless configuration.logger
 
       case type
@@ -66,6 +93,14 @@ module EnvChecker
       end
     end
 
+    def format_error_message(environment, error_message)
+      messages = []
+      messages << '[EnvChecker]'
+      messages << "[#{environment}]" if environment
+      messages << error_message
+      messages.join(' ')
+    end
+
     def missing_keys_env(keys)
       keys.flatten - ::ENV.keys
     end

data/lib/env_checker/cli.rb

@@ -0,0 +1,21 @@
+require 'thor'
+
+class CLI < Thor
+  desc 'version', 'EnvChecker version.'
+  def version
+    puts "EnvChecker #{EnvChecker::VERSION}"
+  end
+
+  option :required, :aliases => :r, :type => :array
+  option :optional, :aliases => :o, :type => :array
+  desc 'check', 'check environment variables'
+  def check
+    output = []
+    output << 'Variables: '
+    output << "- Optional: #{options[:optional]}" if options[:optional]
+    output << "- Required: #{options[:required]}" if options[:required]
+    puts output.join("\n")
+
+    EnvChecker.cli_configure_and_check(options)
+  end
+end

data/lib/env_checker/configuration.rb

@@ -2,10 +2,11 @@ require 'logger'
 
 module EnvChecker
   class Configuration
-    attr_accessor :required_variables, :optional_variables, :logger
+    attr_accessor :required_variables, :optional_variables, :logger, :environment
 
     # Has default settings, which can be overridden in the initializer.
     def initialize
+      @environment = ENV['RACK_ENV'] || ENV['RAILS_ENV']
       @required_variables = []
       @optional_variables = []
       @logger = Logger.new(STDERR)

data/lib/env_checker/version.rb

@@ -1,3 +1,3 @@
 module EnvChecker
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: env-checker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Guillermo Guerrero Ibarra
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-05 00:00:00.000000000 Z
+date: 2016-11-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,10 +108,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Check your environment variables and don't forget anyone.
+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
+      in the middle of the process. Also when you migrate the app to another
+      server is easy to forget an environment variable.
 email:
 - guillermo@guerreroibarra.com
-executables: []
+executables:
+- env-checker
 extensions: []
 extra_rdoc_files: []
 files:
@@ -115,7 +134,9 @@ files:
 - bin/console
 - bin/setup
 - env-checker.gemspec
+- exe/env-checker
 - lib/env_checker.rb
+- lib/env_checker/cli.rb
 - lib/env_checker/configuration.rb
 - lib/env_checker/missing_keys_error.rb
 - lib/env_checker/version.rb
@@ -131,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -142,5 +163,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Check your environment variables and don't forget anyone.
+summary: Don't forget your environment variables when your app changes the environment.
 test_files: []