validator.nu 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David Rice
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= validator.nu
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 David Rice. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "validator.nu"
+    gem.summary = %Q{ruby client library for the validator.nu HTML5 validation API}
+    gem.description = %Q{ruby client library for the validator.nu HTML5 validation API}
+    gem.email = "me@davidjrice.co.uk"
+    gem.homepage = "http://github.com/davidjrice/validator.nu"
+    gem.authors = ["David Rice"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "validator.nu #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/validator.nu.rb

@@ -0,0 +1,78 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'net/http'
+require 'cgi'
+
+module Validator
+  
+  # http://about.validator.nu/#api
+  # http://wiki.whatwg.org/wiki/Validator.nu_Web_Service_Interface
+
+  # INPUT
+  #
+  # Document URL as a GET parameter; the service retrieves the document by URL over HTTP or HTTPS.
+  # Document POSTed as the HTTP entity body; parameters in query string as with GET.
+  # Document POSTed as a textarea value.
+  # Document POSTed as a form-based file upload.
+
+  # OUTPUT
+  #
+  # HTML with microformat-style class annotations (default output; should not be assumed to be forward-compatibly stable).
+  # XHTML with microformat-style class annotations (append &out=xhtml to URL; should not be assumed to be forward-compatibly stable).
+  # XML (append &out=xml to URL).
+  # JSON (append &out=json to URL).
+  # GNU error format (append &out=gnu to URL).
+  # Human-readably plain text (append &out=text to URL; should not be assumed to be forward-compatibly stable for machine parsing—use the GNU format for that).
+ 
+  # COMPRESSION
+
+  # Request Compression
+  # Validator.nu supports HTTP request compression. To use it, compress the request entity body using gzip and specify Content-Encoding: gzip as a request header.
+  #
+  # Response Compression
+  # Validator.nu supports HTTP response compression. Please use it. Response compression is orthogonal to the input methods and output formats.
+  # The standard HTTP gzip mechanism is used. To indicated that you prepared to handle gzipped responses, include the Accept-Encoding: gzip request header. When the header is present, Validator.nu will gzip compress the response. You should also be prepared to receive an uncompressed, though, since in the future it may make sense to turn off compression under heavy CPU load.
+  
+
+  class << self
+    class RemoteException < StandardError; end;
+
+    HOST = "validator.nu"
+    PORT = 80
+
+    def nu(url_or_document)
+      get(url_or_document)
+    end
+
+
+    def get(url)
+      begin
+        http = Net::HTTP.new(HOST, PORT)
+        # http.set_debug_output STDERR
+        # http.use_ssl = true if SSL
+        uri = "/?&doc=#{CGI::escape(url)}&out=json"
+        # headers = method.to_s == 'errors' ? { 'Content-Type' => 'application/x-gzip', 'Accept' => 'application/x-gzip' } : {}
+
+        # compressed_data = CGI::escape(Zlib::Deflate.deflate(data, Zlib::BEST_SPEED))
+        # STDERR.puts uri
+        response = http.start do |http|
+          http.get(uri)
+        end
+        
+        if response.kind_of? Net::HTTPSuccess
+          return response.body
+        else
+          STDERR.puts response.body.inspect
+          raise RemoteException.new("#{response.code}: #{response.message}")
+        end
+
+      rescue Exception => e
+        STDERR.puts "Error contacting validator.nu: #{e}"
+        STDERR.puts e.backtrace.join("\n"), 'debug'
+        raise e
+      end
+    end
+
+  end
+
+end

data/spec/fixtures/fatal-error.json

@@ -0,0 +1 @@
+{"url":"http://hsivonen.iki.fi/test/moz/messages-types/fatal.xhtml","messages":[{"type":"info","message":"The Content-Type was “application/xhtml+xml”. Using the XML parser (not resolving external entities)."},{"type":"info","message":"Using the preset for XHTML5+ARIA, SVG 1.1 plus MathML 2.0 (experimental) based on the root namespace."},{"type":"error","lastLine":6,"lastColumn":10,"subType":"fatal","message":"name expected","extract":"body>\n<p>Fatal & erro","hiliteStart":15,"hiliteLength":1}]}

data/spec/fixtures/info.json

@@ -0,0 +1 @@
+{"url":"http://hsivonen.iki.fi/test/moz/messages-types/info.svg","messages":[{"type":"info","message":"The Content-Type was “image/svg+xml”. Using the XML parser (not resolving external entities)."},{"type":"info","message":"Using the preset for SVG 1.1+IRI, XHTML5+ARIA plus MathML 2.0 (experimental) based on the root namespace."}]}

data/spec/fixtures/no-message.json

@@ -0,0 +1 @@
+{"url":"http://hsivonen.iki.fi/test/moz/messages-types/no-message.html","messages":[{"type":"info","message":"The Content-Type was “text/html”. Using the HTML parser."},{"type":"info","message":"Using the schema for HTML5+ARIA (experimental)."}]}

data/spec/fixtures/non-document-error.json

@@ -0,0 +1 @@
+{"url":"http://hsivonen.iki.fi/test/moz/messages-types/404.html","messages":[{"type":"non-document-error","subType":"io","message":"HTTP resource not retrievable. The HTTP status from the remote server was: 404."}]}

data/spec/fixtures/precise-error.json

@@ -0,0 +1 @@
+{"url":"http://hsivonen.iki.fi/test/moz/messages-types/precise-error.html","messages":[{"type":"info","message":"The Content-Type was “text/html”. Using the HTML parser."},{"type":"info","message":"Using the schema for HTML5+ARIA (experimental)."},{"type":"error","lastLine":7,"lastColumn":4,"message":"“&” did not start a character reference. (“&” probably should have been escaped as “&amp;”.)","extract":"ead>\n<body>\n<p>&a</p>","hiliteStart":15,"hiliteLength":1}]}

data/spec/fixtures/range-error.json

@@ -0,0 +1 @@
+{"url":"http://hsivonen.iki.fi/test/moz/messages-types/range-error.html","messages":[{"type":"info","message":"The Content-Type was “text/html”. Using the HTML parser."},{"type":"info","message":"Using the schema for HTML5+ARIA (experimental)."},{"type":"error","lastLine":7,"lastColumn":13,"firstColumn":10,"message":"End tag for “p” seen, but there were unclosed elements.","extract":"\n<p><span></p>\n</bod","hiliteStart":10,"hiliteLength":4}]}

data/spec/fixtures/warning.json

@@ -0,0 +1 @@
+{"url":"http://hsivonen.iki.fi/test/moz/messages-types/warning.html","messages":[{"type":"info","message":"The Content-Type was “text/html”. Using the HTML parser."},{"type":"info","message":"Using the schema for HTML5+ARIA (experimental)."},{"type":"error","lastLine":7,"lastColumn":13,"message":"“<” in an unquoted attribute value. Probable cause: Missing “>” immediately before.","extract":"y>\n<p class=foo<bar><","hiliteStart":15,"hiliteLength":1}]}

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../lib/validator.nu.rb'

data/spec/validator_spec.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+describe Validator do
+
+
+  describe "Validator.nu" do
+
+   it "should receive a no message result" do
+      fixture = File.open("#{File.dirname(__FILE__)}/fixtures/no-message.json").read
+
+      Validator.nu(
+      "http://hsivonen.iki.fi/test/moz/messages-types/no-message.html"
+      ).should == fixture
+    end
+
+    # http://hsivonen.iki.fi/test/moz/messages-types/info.svg
+    it "should receive an info result" do
+      fixture = File.open("#{File.dirname(__FILE__)}/fixtures/info.json").read
+
+
+      Validator.nu(
+      "http://hsivonen.iki.fi/test/moz/messages-types/info.svg"
+      ).should == fixture
+    end
+
+    it "should receive a warning result" do
+      fixture = File.open("#{File.dirname(__FILE__)}/fixtures/warning.json").read
+
+
+      Validator.nu(
+      "http://hsivonen.iki.fi/test/moz/messages-types/warning.html"
+      ).should == fixture
+    end
+
+    it "should receive a non-document result" do
+      fixture = File.open("#{File.dirname(__FILE__)}/fixtures/non-document-error.json").read
+
+
+      Validator.nu(
+      "http://hsivonen.iki.fi/test/moz/messages-types/404.html"
+      ).should == fixture
+    end
+
+    it "should receive a precise error result" do
+      fixture = File.open("#{File.dirname(__FILE__)}/fixtures/precise-error.json").read
+
+      Validator.nu(
+      "http://hsivonen.iki.fi/test/moz/messages-types/precise-error.html"
+      ).should == fixture
+    end
+
+    it "should receive a range error result" do
+      fixture = File.open("#{File.dirname(__FILE__)}/fixtures/range-error.json").read
+      Validator.nu(
+      "http://hsivonen.iki.fi/test/moz/messages-types/range-error.html"
+      ).should == fixture
+    end
+
+    it "should receive a fatal error result" do
+      fixture = File.open("#{File.dirname(__FILE__)}/fixtures/fatal-error.json").read
+      Validator.nu(
+        "http://hsivonen.iki.fi/test/moz/messages-types/fatal.xhtml"
+      ).should == fixture
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'validator.nu'
+
+class Test::Unit::TestCase
+end

data/test/test_validator.nu.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestValidator.nu < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/validator.nu.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{validator.nu}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Rice"]
+  s.date = %q{2010-04-06}
+  s.description = %q{ruby client library for the validator.nu HTML5 validation API}
+  s.email = %q{me@davidjrice.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/validator.nu.rb",
+     "spec/fixtures/fatal-error.json",
+     "spec/fixtures/info.json",
+     "spec/fixtures/no-message.json",
+     "spec/fixtures/non-document-error.json",
+     "spec/fixtures/precise-error.json",
+     "spec/fixtures/range-error.json",
+     "spec/fixtures/warning.json",
+     "spec/spec_helper.rb",
+     "spec/validator_spec.rb",
+     "test/helper.rb",
+     "test/test_validator.nu.rb",
+     "validator.nu.gemspec"
+  ]
+  s.homepage = %q{http://github.com/davidjrice/validator.nu}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{ruby client library for the validator.nu HTML5 validation API}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/validator_spec.rb",
+     "test/helper.rb",
+     "test/test_validator.nu.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: validator.nu
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Rice
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-06 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: ruby client library for the validator.nu HTML5 validation API
+email: me@davidjrice.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/validator.nu.rb
+- spec/fixtures/fatal-error.json
+- spec/fixtures/info.json
+- spec/fixtures/no-message.json
+- spec/fixtures/non-document-error.json
+- spec/fixtures/precise-error.json
+- spec/fixtures/range-error.json
+- spec/fixtures/warning.json
+- spec/spec_helper.rb
+- spec/validator_spec.rb
+- test/helper.rb
+- test/test_validator.nu.rb
+- validator.nu.gemspec
+has_rdoc: true
+homepage: http://github.com/davidjrice/validator.nu
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: ruby client library for the validator.nu HTML5 validation API
+test_files: 
+- spec/spec_helper.rb
+- spec/validator_spec.rb
+- test/helper.rb
+- test/test_validator.nu.rb