roger_w3cvalidator 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDRjZTczMWJiZTczZjI1MzkxYjZlYmFiZjU0NTJiMzgyNWY3OGM0MQ==
+  data.tar.gz: !binary |-
+    Mjg5NmVhYWE2ZmQ3NzU4ZDQ4OTJlY2QxODgwYzllZmQ2OTcyZDkyMQ==
+SHA512:
+  metadata.gz: !binary |-
+    YzgzZWIyOTY2YjA3YTA3N2E1ZGFmYzlhNzNlMDYwYWYyNGY3MGU2YThjZjRl
+    YTU5ZDYxMGNmMjI1OWNkMDUwNjI3MWYxM2NmOTRhZjU5Njk3YmQ4MjAyOGNk
+    Y2ZjMDAzNTY1ZWViODk4Mzc5NTZjODUxNmI4MmRjODEzNDFjZjE=
+  data.tar.gz: !binary |-
+    NWE4NTgzYjhkZmY5NWY5OTE4MjQ5ZWFiNGVjNjkzZjAyM2QzMzVjNjRhOTE2
+    MzIwYTlkYjdhMGQyM2ZkOTM5NTk1ZDRiNGMxZDFkYmQ1MGE0MDBhODUxYzMw
+    NmM4ZmIyZjFiNzAwMzZhNzQwYzFiMzI3YjFjY2M5ZWVmYzQ3ZWY=

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## Version 1.0.0
+* First version extracted from Roger

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 DigitPaint
+
+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.md

@@ -0,0 +1,20 @@
+# Roger W3CValidator
+
+[![Gem Version](https://badge.fury.io/rb/roger_w3cvalidator.png)](http://badge.fury.io/rb/roger_w3cvalidator)
+
+W3CValidator consists of two parts:
+
+* Middleware (`RogerW3cvalidator::Middleware`) to validate each HTML request (quite slow)
+* Test to use on your mockup
+
+## Changes and versions
+
+Have a look at the [CHANGELOG](CHANGELOG.md) to see what's new.
+
+## Contributors
+
+[View contributors](https://github.com/digitpaint/roger_w3cvalidator/graphs/contributors)
+
+## License
+
+MIT License, see [LICENSE](LICENSE) for more info.

data/lib/roger_w3cvalidator.rb

@@ -0,0 +1,5 @@
+module RogerW3cvalidator; end
+
+# Load modules
+require File.dirname(__FILE__) + "/roger_w3cvalidator/test"
+require File.dirname(__FILE__) + "/roger_w3cvalidator/middleware"

data/lib/roger_w3cvalidator/middleware.rb

@@ -0,0 +1,25 @@
+require 'rack/request'
+require 'rack/response'
+require File.dirname(__FILE__) + "/w3c_validator"
+
+module RogerW3cvalidator
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+    
+    def call(env)
+      resp = @app.call(env)
+      if resp[1]["Content-Type"].to_s.include?("html")
+        str = ""
+        resp[2].each{|c| str << c}
+        validator = W3CValidator.new(str)
+        validator.validate!
+        if !validator.valid
+          env["rack.errors"].puts "Validation failed on #{env["PATH_INFO"]}: (errors: #{validator.errors}, warnings: #{validator.warnings})"
+        end
+      end
+      resp
+    end    
+  end
+end

data/lib/roger_w3cvalidator/test.rb

@@ -0,0 +1,42 @@
+require 'roger/test'
+require File.dirname(__FILE__) + "/w3c_validator"
+
+module RogerW3cvalidator
+  class Test
+
+    def initialize(options={})
+      @options = {
+        :match => ["html/**/*.html"],
+        :skip => []
+      }
+      @options.update(options) if options            
+    end
+
+    def call(test, options={})
+      options = {}.update(@options).update(options)
+
+      test.log(self, "Validating all files matching #{options[:match].inspect}")
+
+      success = true
+      test.get_files(options[:match], options[:skip]).each do |file_path|
+        validator = W3CValidator.new(File.read(file_path))
+        validator.validate!
+        if !validator.valid
+          test.log(self, "#{file_path} is invalid (errors: #{validator.errors}, warnings: #{validator.warnings})") do
+            validator.response["messages"].each do |message|
+              test.debug(self, message["message"])
+            end
+          end
+          success = false
+        else
+          test.debug(self, "#{file_path} is valid")
+        end
+      end
+
+      success
+    end
+
+  end
+end
+
+Roger::Test.register :w3cvalidator, RogerW3cvalidator::Test

data/lib/roger_w3cvalidator/w3c_validator.rb

@@ -0,0 +1,129 @@
+require 'cgi'
+require 'net/http'
+require 'uri'
+require 'yaml'
+
+module RogerW3cvalidator
+  class W3CValidator
+  
+    ValidationUri = "http://validator.w3.org/check"
+    
+    class RequestError < StandardError; end
+  
+    attr_reader :valid,:response,:errors,:warnings,:status
+  
+    class << self
+      def validation_uri
+        @uri ||= URI.parse(ValidationUri)
+      end
+    end 
+  
+    def initialize(html)
+      @html = html
+    end
+  
+    def validate!
+      @status = @warnings = @errors = @response = @valid = nil
+      options = {"output" => "json"}
+      query,headers = build_post_query(options)
+      response =  self.request(:post, self.class.validation_uri.path,query,headers)
+      @status,@warnings,@errors = response["x-w3c-validator-status"],response["x-w3c-validator-warnings"].to_i,response["x-w3c-validator-errors"].to_i
+    
+      if @status == "Valid" && @warnings == 0 && @errors == 0
+        return @valid = true
+      else
+        begin
+          @response = YAML.load(response.body)
+        rescue 
+        end
+        return (@valid = (@errors == 0))
+      end
+    
+    end
+  
+    protected
+  
+    def build_post_query(options)
+      boundary = "validate-this-content-please"
+      headers = {"Content-type" => "multipart/form-data, boundary=" + boundary + " "}
+    
+      parts = []
+      options.each do |k,v|
+        parts << post_param(k,v)
+      end
+      parts << file_param("uploaded_file","index.html",@html,"text/html")
+    
+      q = parts.map{|p| "--#{boundary}\r\n#{p}"}.join("") + "--#{boundary}--"
+      [q,headers]
+    end
+  
+    def post_param(k,v)
+      "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"\r\n\r\n#{v}\r\n"
+    end
+  
+    def file_param(k,filename,content,mime_type)
+      out = []
+      out << "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"; filename=\"#{filename}\""
+      out << "Content-Transfer-Encoding: binary"
+      out << "Content-Type: #{mime_type}"
+      out.join("\r\n") + "\r\n\r\n" + content + "\r\n"
+    end
+    
+    # Makes request to remote service.
+    def request(method, path, *arguments)
+      perform_request(method, path, arguments, 3)
+    end
+    
+    def perform_request(method, path, arguments, tries=3)
+      result = nil
+      result = http.send(method, path, *arguments)
+      handle_response(result)
+    rescue RequestError => e
+      if tries > 0
+        perform_request(method, path, arguments, tries-1)
+      else
+        raise
+      end
+    rescue Timeout::Error => e
+      raise       
+    end
+  
+    # Handles response and error codes from remote service.
+    def handle_response(response)
+      case response.code.to_i
+        when 301,302
+          raise "Redirect"
+        when 200...400
+          response
+        when 400
+          raise "Bad Request"
+        when 401
+          raise "Unauthorized Access"
+        when 403
+          raise "Forbidden Access"
+        when 404
+          raise "Rescoure not found"
+        when 405
+          raise "Method not allowed"
+        when 409
+          raise RequestError.new("Rescource conflict")
+        when 422
+          raise RequestError.new("Resource invalid")
+        when 401...500
+          raise "Client error"
+        when 500...600
+          raise RequestError.new("Server error")
+        else
+          raise "Unknown response: #{response.code.to_i}"
+      end
+    end
+        
+    def http
+      site = self.class.validation_uri
+      http = Net::HTTP.new(site.host, site.port)
+  #    http.use_ssl = site.is_a?(URI::HTTPS)
+  #    http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl
+      http
+    end      
+  end
+end

data/roger_w3cvalidator.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "roger_w3cvalidator"
+  s.version = "0.1.0"
+  
+  s.authors = ["Flurin Egger"]
+  s.email = ["info@digitpaint.nl", "flurin@digitpaint.nl"]  
+  s.homepage = "http://github.com/digitpaint/roger_w3cvalidator"
+  s.summary = "Middleware and Tester to validate your HTML within Roger"
+  s.licenses = ["MIT"]
+
+  s.date = Time.now.strftime("%Y-%m-%d")
+  
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]  
+  
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.add_dependency("rack", [">= 1.0.0"])
+  s.add_dependency("roger", [">= 0.11.0"])
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: roger_w3cvalidator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Flurin Egger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: roger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: 
+email:
+- info@digitpaint.nl
+- flurin@digitpaint.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/roger_w3cvalidator.rb
+- lib/roger_w3cvalidator/middleware.rb
+- lib/roger_w3cvalidator/test.rb
+- lib/roger_w3cvalidator/w3c_validator.rb
+- roger_w3cvalidator.gemspec
+homepage: http://github.com/digitpaint/roger_w3cvalidator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: Middleware and Tester to validate your HTML within Roger
+test_files: []