opt_parse_validator 0.0.13.7 → 0.0.13.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b0b19c4ac86b581d9ef569f2de3179b28580055
-  data.tar.gz: 333ffe9bef4c43a2446a6af4eb49e2a8ea82e24c
+  metadata.gz: f8b96bf2df00c21b5dd5be7b553495196f7f7190
+  data.tar.gz: 7091246c62fe01bb6a1437ba265ef5d755409d46
 SHA512:
-  metadata.gz: 56a49fcad03a6a9e42cb299488aab56a26fda9c73d96df6e10d76be98e09dcfd73b5f32f15fa5bb326d5132d5fecb9f9b5687da718ee6cb31b837c84a5b6c3b8
-  data.tar.gz: cf48d2ee2a29e1913930513fd886b1ffcee8677dd60f125dc0d2e108de8d2aa05300f888f9875a74d816bfd74b5dd58c7b58cd5912329eb173deb97d890d244e
+  metadata.gz: '0338d5ddadd4aeef34af392f5aa3d51ada1deb93cffe3f04cb7fb86073c6c8613e8b9b70f78b833a2106e2ff9ac35605b9b65b792cb3f66eb2ecf859c7fcea5f'
+  data.tar.gz: b0641b222b4f7ff8136e5bfaa4d6fb2d2e61543ed1fd915e526470b4ae03282b38ac9ee143bce8f077f0f9180053bbd17fbc021028cc3b7e22f8a6c09a05d317

data/README.md

@@ -8,7 +8,46 @@ OptParseValidator
 [![Dependency Status](https://img.shields.io/gemnasium/wpscanteam/OptParseValidator.svg)](https://gemnasium.com/wpscanteam/OptParseValidator)
 
 
-### Available Validators & associated attributes:
+### Installation
+
+```gem install opt_parse_validator```
+
+### Usage Example
+
+```ruby
+# test.rb
+
+require 'opt_parse_validator'
+
+# For contructor options, such as setting a banner, the summary width and indent,
+# see http://ruby-doc.org/stdlib-2.4.2/libdoc/optparse/rdoc/OptionParser.html#method-c-new
+parser = OptParseValidator::OptParser.new
+
+parser.add(
+  OptParseValidator::OptString.new(['-m', '--mandatory PARAM', 'A Mandatory CLI option'], required: true),
+  OptParseValidator::OptBoolean.new(['--test', '-t', 'Option Helper Message']),
+  OptParseValidator::OptFilePath.new(['-o', '--output FILE', 'Output to FILE'], writable: true, exists: false)
+)
+
+begin
+  p parser.results
+rescue OptParseValidator::Error => e
+  puts 'Parsing Error: ' + e.message
+end
+```
+
+Then have a play with
+```ruby test.rb -h```
+```ruby test.rb -m hh -t```
+```ruby test.rb -t```
+
+For more option examples, see
+ - https://github.com/wpscanteam/CMSScanner/blob/master/app/controllers/core/cli_options.rb
+ - https://github.com/wpscanteam/wpscan-v3/blob/master/app/controllers/enumeration/cli_options.rb
+
+Please Feel free to send Pull Requests to improve this Readme
+
+### Available Validators & Associated Attributes:
 - Array
   - :separator (default: ',')
 - Boolean

data/lib/opt_parse_validator.rb

@@ -46,7 +46,7 @@ module OptParseValidator
       on(*opt.option) do |arg|
         begin
           @results[opt.to_sym] = opt.normalize(opt.validate(arg))
-        rescue => e
+        rescue StandardError => e
           # Adds the long option name to the message
           # And raises it as an OptParseValidator::Error if not already one
           # e.g --proxy Invalid Scheme format.
@@ -72,7 +72,7 @@ module OptParseValidator
       post_processing
 
       @results
-    rescue => e
+    rescue StandardError => e
       # Raise it as an OptParseValidator::Error if not already one
       raise e.is_a?(Error) ? e.class : Error, e.message
     end

data/lib/opt_parse_validator/opts/headers.rb

@@ -4,6 +4,7 @@ module OptParseValidator
     # @return [ Void ]
     def append_help_messages
       option << "Separator to use between the headers: '; '"
+      option << "Examples: 'X-Forwarded-For: 127.0.0.1', 'X-Forwarded-For: 127.0.0.1; Another: aaa'"
     end
 
     # @param [ String ] value

data/lib/opt_parse_validator/version.rb

@@ -1,4 +1,4 @@
 # Gem Version
 module OptParseValidator
-  VERSION = '0.0.13.7'.freeze
+  VERSION = '0.0.13.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opt_parse_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.13.7
+  version: 0.0.13.8
 platform: ruby
 authors:
 - WPScanTeam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-16 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable