vert 0.2.1 → 0.3.0

data/lib/vert.rb

@@ -15,7 +15,7 @@ module Vert
   EMPTY_ERROR = "The hash is empty." 
   EMPTY_ERROR_KEY = :empty
 
-  ABSENT_KEY_ERROR = "The data does not contain the following key/s"  
+  ABSENT_KEY_ERROR = "The data does not contain one or more required keys."  
   ABSENT_KEY_ERROR_KEY = :absent_key
  
   ARRAY_TYPE_ERROR = "The following key/s do not have Array type values." 
@@ -30,7 +30,7 @@ module Vert
   HASH_EMPTY_ERROR = "The following hash key/s are empty."
   HASH_EMPTY_ERROR_KEY = :hash_empty
 
-  #error messages for json validation
+  #error messages for JSON validation
   NOT_A_STRING_ERROR = "Not a JSON string."
   NOT_A_STRING_ERROR_KEY = :not_a_string
 
@@ -40,21 +40,21 @@ module Vert
   EMPTY_JSON_OBJECT_ERROR = "The JSON object is empty."
   EMPTY_JSON_OBJECT_ERROR_KEY = :empty_json_object
 
-  MALFORMED_JSON_ERROR = "The JSON string is malformed."
+  MALFORMED_JSON_ERROR = "The JSON string is malformed"
   MALFORMED_JSON_ERROR_KEY = :malformed_json
 
   #error messages for avro verification
-  INVALID_AVRO_SCHEMA_ERROR = "The avro schema is invalid."
+  INVALID_AVRO_SCHEMA_ERROR = "The avro schema is invalid"
   INVALID_AVRO_SCHEMA_ERROR_KEY = :invalid_avro_schema
 
-  INVALID_AVRO_DATUM_ERROR = "The JSON provided is not an instance of the schema:"
+  INVALID_AVRO_DATUM_ERROR = "The JSON provided is not an instance of the schema."
   INVALID_AVRO_DATUM_ERROR_KEY = :invalid_avro_datum
 
   #Enums 
   TYPE_ENUM = {array_keys: Array, hash_keys: Hash}
   OPTIONS_HASH_ENUM = [:keys, :custom_errors]
   OPTIONS_JSON_HASH_ENUM = [:schema, :custom_errors]
-  KEYS_ENUM = [:value_keys, :array_keys, :hash_keys]
+  KEYS_ENUM = [:required_keys, :array_keys, :hash_keys]
   ERROR_KEY_ENUM = {
     NOT_A_HASH_ERROR_KEY => NOT_A_HASH_ERROR,
     EMPTY_ERROR_KEY => EMPTY_ERROR,
@@ -74,6 +74,8 @@ module Vert
   #input validation
   OPTIONS_HASH_EMPTY = "The options hash must contain keys"
   OPTIONS_NOT_A_HASH = "The options parameter must be a hash"
+  OPTIONS_HASH_FORMAT = "{:keys => {}, :custom_errors => {}}"
+  OPTIONS_JSON_HASH_FORMAT = "{:schema => \"avro shcema\", :custom_errors => {}}"
   OPTIONS_HASH_MISSING_VALID_KEYS = "The options hash contains no valid keys. The valid symbol keys are - "
   KEYS_HASH_MISSING_VALID_KEYS = "The options hash contains no valid keys for the :keys hash. The valid symbol keys are - "
   CUSTOM_ERRORS_HASH_MISSING_VALID_KEYS = "The options hash contains no valid keys for the :custom_errors hash. The valid symbol keys are - "
@@ -82,7 +84,7 @@ module Vert
 
   def validate(hash, options = nil) 
     unless options.nil?
-      check_options_format(options)
+      check_options_format(options, OPTIONS_HASH_FORMAT)
       check_options(options)
     end
     test_validations(hash, options)
@@ -106,7 +108,7 @@ module Vert
 
   def validate_json(json, options = nil)
     unless options.nil?
-      check_options_format(options)
+      check_options_format(options, OPTIONS_JSON_HASH_FORMAT)
       check_json_options(options) 
     end
     test_validations_json(json, options)
@@ -138,8 +140,8 @@ module Vert
     end
   end
 
-  def check_options_format(options) 
-    raise InputError, OPTIONS_NOT_A_HASH unless options.is_a?(Hash)
+  def check_options_format(options, options_format) 
+    raise InputError, "#{OPTIONS_NOT_A_HASH}. The options hash has the following format:- #{options_format}" unless options.is_a?(Hash)
     raise InputError, OPTIONS_HASH_EMPTY if options.empty?
     if options.keys.include?(:custom_errors)
       raise_when_all_keys_missing(options[:custom_errors], CUSTOM_ERRORS_HASH_MISSING_VALID_KEYS, ERROR_KEY_ENUM.keys)
@@ -148,8 +150,8 @@ module Vert
 
   def test_validations(hash, options)
     test_for_default_hash_errors(hash, options)
-    if options_key_types_present?(options, :value_keys)
-      raise_when_keys_absent(hash, options, :value_keys) 
+    if options_key_types_present?(options, :required_keys)
+      raise_when_keys_absent(hash, options, :required_keys) 
     elsif options_key_types_present?(options, :array_keys)
       test_for_array_key_errors(hash, options)
     elsif options_key_types_present?(options, :hash_keys)
@@ -256,7 +258,7 @@ module Vert
   end
 
   def build_missing_key_error(options, missing_keys_array)
-    "#{build_error_message(options, ABSENT_KEY_ERROR_KEY)} Missing keys:- #{missing_keys_array*", "}"
+    "#{build_error_message(options, ABSENT_KEY_ERROR_KEY)}\nMissing key/s: #{missing_keys_array*", "}"
   end
 
   def build_error_message(options, error_key)
@@ -347,7 +349,7 @@ module Vert
     raise_custom_error(hash, options, EMPTY_JSON_OBJECT_ERROR_KEY){|hash| hash.empty?}
   rescue Oj::ParseError => exception
     detail = "#{exception.message.gsub( /\[.+\]/, "").rstrip}."
-    raise ValidationError, "#{build_error_message(options, MALFORMED_JSON_ERROR_KEY)}. #{detail}"
+    raise ValidationError, "#{build_error_message(options, MALFORMED_JSON_ERROR_KEY)}, #{detail}"
   else
     hash
   end

metadata

@@ -1,72 +1,78 @@
 --- !ruby/object:Gem::Specification
 name: vert
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Eskimo Bear
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-23 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
   name: avro
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.5
-  type: :runtime
-  prerelease: false
+        version: 1.7.7
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.5
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
   name: oj
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.10.2
-  type: :runtime
-  prerelease: false
+        version: '0'
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.10.2
-description: Vert is a library for verifying and validating data.
+        version: '0'
+description: Validate hashes and JSON data and output custom errors
 email: dev@eskimobear.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/vert.rb
-homepage: https://github.com/EskimoBear/Vert/
+homepage: https://github.com/EskimoBear/vert/
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
-summary: Keep your data clean
+specification_version: 3
+summary: Keep your data clean without the boilerplate
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: cc6d3bfb12ff30eaad91ca1aaa5d1cb3b22e9f57
-  data.tar.gz: 6ab62d9c55248d41c3fa360714b585e54d87924a
-SHA512:
-  metadata.gz: 516fe980cc3e286f8f08fed032e79dd2f0b2a98c9770bee92e416e3f93cd82295aa2b9ac98a4e72d918950b5da8282b5ff3e6c4a91558605b10e51a77b0524a4
-  data.tar.gz: 97164fdcc94904f226b4a3a2a33bc1756a62cb7992bbfb352ebe5a2560e29b4eef3ed09415b2fabb1956f6f8410321b75045df12f3082263dff58e4a78b266dc