living-validator 0.1.0 → 0.2.0

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+*.swp
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -1,5 +1,7 @@
 #LivingValidator gem
 
+## `gem install living-validator`
+
 This gem is designed to integrate with the http://validator.nu service. It will work with the public instance or a private instance. The source for the validator is available here: [BitBucket Repo](https://bitbucket.org/validator/build/src). 
 
 The functionality here is pretty basic. You may query the validator, receive a response, and go through the messages it gives you. There are convenience methods for getting only the error messages, getting the total number of error messages, or getting the total number of messages.
@@ -14,6 +16,8 @@ The functionality here is pretty basic. You may query the validator, receive a r
 
 ##Public Instance
 
+	require 'rubygems' # Only for Ruby 1.8
+	require 'living-validator'
     result = LivingValidator::Validator.check 'http://github.com'
 	puts "There were #{result.errorCount} errors found!"
 	if result.errorCount > 0
@@ -22,6 +26,8 @@ The functionality here is pretty basic. You may query the validator, receive a r
 
 ##Private Instance
 
+	require 'rubygems' # Only for Ruby 1.8
+	require 'living-validator'
 	result = LivingValidator::Validator.check 'http://github.com', {:endpoint => 'localhost:8888'}
 	puts "There were #{result.errorCount} errors found!"
 	if result.errorCount > 0
@@ -30,6 +36,8 @@ The functionality here is pretty basic. You may query the validator, receive a r
 
 ##Lax Content-Type Checking
 
+	require 'rubygems' # Only for Ruby 1.8
+	require 'living-validator'
 	result = LivingValidator::Validator.check 'http://github.com', {:lax_type => true}
 	puts "There were #{result.errorCount} errors found!"
 	if result.errorCount > 0
@@ -38,6 +46,6 @@ The functionality here is pretty basic. You may query the validator, receive a r
 
 # License / Copyright
 
-Copyright (c) 2012 DyanmiX Web Design, LLC (http://dynamixwebdesign.com)
+Copyright (c) 2012 DynamiX Web Design, LLC (http://www.dynamixwebdesign.com)
 
 Licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported. More info in the LICENSE file.

data/lib/living-validator.rb

@@ -1,3 +1,7 @@
+# @copyright 2012 (c) Dynamix Web Design, LLC
+# @author Whit Marbut
+# @license See LICENSE file in gem file or project repository
+
 require 'rubygems'
 require 'httparty'
 require 'json'
@@ -18,6 +22,15 @@ module LivingValidator
 	# Validator class. Should be accesses statically
 	#
 	class Validator
+		
+		# Perform the validation on a given URL against the validator endpoint.
+		# Has two options `:endpoint` and `:lax_type`. The endpoint option configures where the
+		# validator instance is running. It defaults to validator.nu. The lax type option
+		# allows for lax type checking. The default for this is false. Make sure to test the
+		# result of this method for a false falue as this is the failure output.
+		# @param string url The url of the page to validate
+		# @param hash options (optional) The options to use.
+		# @return [LivingValidator::Result,boolean] Returns a result or false for failure.
 		def self.check(url, options = {})
 			# Determine the endpoint url
 			endpoint = options[:endpoint] || ENDPOINT
@@ -63,6 +76,12 @@ module LivingValidator
 			@url = url
 		end
 
+		# Declares a document valid if no error messages were raised
+		# @return boolean True for a valid document
+		def valid?
+			(self.errorCount) == 0? true : false
+		end
+
 		#
 		# Get the number of errors returned
 		# @return integer the error count
@@ -70,6 +89,13 @@ module LivingValidator
 			(self.errors()).length
 		end
 
+		#
+		# Get the number of info messages returned
+		# @return integer the info count
+		def infoCount
+			(self.infos()).length
+		end
+
 		#
 		# Get only the error messages
 		# @return array the error messages
@@ -77,6 +103,12 @@ module LivingValidator
 			@messages.select{|msg| msg['type'] == 'error'}
 		end
 
+		# Get only the info messages
+		# @return array the info messages
+		def infos
+			@messages.select{|msg| msg['type'] == 'info'}
+		end
+
 		#
 		# Get the total messages count
 		# @return integer the messages count

data/lib/living-validator/version.rb

@@ -1,3 +1,3 @@
 module LivingValidator
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
 end

data/living-validator.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'httparty', '>= 0.9.0'
   gem.add_dependency 'json', '1.7.5'
+  
+  
+  gem.post_install_message = "Thank you for using our gem. Check us out on the web at http://www.dynamixwebdesign.com\n-The DynamiX Team"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: living-validator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-28 00:00:00.000000000 Z
+date: 2012-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -61,7 +61,9 @@ files:
 homepage: https://bitbucket.org/dynamixwd/living-validator
 licenses:
 - Creative Commons Attribution-ShareAlike 3.0 Unported
-post_install_message: 
+post_install_message: ! 'Thank you for using our gem. Check us out on the web at http://www.dynamixwebdesign.com
+
+  -The DynamiX Team'
 rdoc_options: []
 require_paths:
 - lib
@@ -84,3 +86,4 @@ signing_key:
 specification_version: 3
 summary: A simple suite for querying the validator.nu service (or your own instance).
 test_files: []
+has_rdoc: