nunchaku 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85e68ba556c156c4f52a40427ea5e7003946ed4b
+  data.tar.gz: dd044567c165768235b66ff5617f86966ad338e5
+SHA512:
+  metadata.gz: e7a7029ce24f2dbf674adcc793adbe4e68fce786720f3e9cbb3f65d4266fae81b09145c4edf986e0af224f47661a7d3570b1a78a8067b5c65d48f14f47cad49d
+  data.tar.gz: 522ed0a7b1cddad886c57b342e4018305d7ff113a5a8b33444ee6053f27aedbf5ecfa07244a4a2183961a8fb1062c2c73c6dc185c4e20f76d09ef6459a8ed869

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nunchaku.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jaime Iniesta
+
+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,88 @@
+# Nunchaku
+
+Nunchaku is a Ruby client for the [Nu HTML Checker](https://github.com/validator/validator). It lets you easily check HTML markup of web pages, by querying a remote instance of the checker.
+
+![Nunchaku image](https://dl.dropboxusercontent.com/u/2268180/nunchaku/Nunchaku.png "Nunchaku image taken from http://commons.wikimedia.org/wiki/File:Nunchaku.png")
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nunchaku'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nunchaku
+
+## Usage
+
+To check HTML on a web page, just pass it the URL to check, like this:
+
+```ruby
+checker = Nunchaku.check('http://example.com')
+```
+
+Then, you can check the JSON response like this:
+
+```ruby
+checker.raw # {
+            #   "url": "http://validationhell.com",
+            #   "messages": [{
+            #                  "type": "error",
+            #                  "lastLine": 73,
+            #                  "lastColumn": 67,
+            #                  "firstColumn": 64,
+            #                  "message": "Stray end tag “a”.",
+            #                  "extract": "idates</a></a></li>\n",
+            #                  "hiliteStart": 10,
+            #                  "hiliteLength": 4
+            #                 }, (...)
+
+```
+
+Every message returned will also be accessible in a more friendly way like this:
+
+```ruby
+msg = checker.messages.first
+
+msg.type          # "error"
+msg.last_line     # 73
+msg.first_column  # 64
+msg.last_column   # 67
+msg.message       # "Stray end tag “a”."
+msg.extract       # "idates</a></a></li>\n"
+msg.hilite_start  # 10
+msg.hilite_length # 4
+```
+
+The `messages` array contains all messages returned by the checker, but you'll typically be more interested in `errors` (that contains all messages of type "error") and `warnings` (that contains all messages of subtype "warning").
+
+## Using an alternate server
+
+By default, Nunchaku will query the Nu HTML Checker at https://html5.validator.nu, but you're encouraged to install your own instance and use it instead. You can follow the [Nu installation instructions](https://github.com/validator/validator) and then specify the alternate server like this:
+
+```ruby
+checker = Nunchaku.check('http://example.com', checker_uri: 'http://mychecker.example.com')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To run the specs, run `bundle exec rake`.
+
+## Contributing
+
+1. Fork it ( https://github.com/sitevalidator/nunchaku/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new :spec
+
+task :default  => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nunchaku"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nunchaku.rb

@@ -0,0 +1,9 @@
+require "nunchaku/version"
+require "nunchaku/checker"
+require "nunchaku/message"
+
+module Nunchaku
+  def self.check(url, options = {})
+    Nunchaku::Checker.new(url, options)
+  end
+end

data/lib/nunchaku/checker.rb

@@ -0,0 +1,37 @@
+require 'httparty'
+require 'json'
+
+module Nunchaku
+  class Checker
+    attr_reader :url, :checker_uri
+
+    def initialize(url, options = {})
+      options = defaults.merge(options)
+
+      @url         = url
+      @checker_uri = options[:checker_uri]
+    end
+
+    def raw
+      @raw ||= JSON.parse HTTParty.get("#{checker_uri}?out=json&doc=#{@url}").body
+    end
+
+    def messages
+      @messages ||= raw['messages'].map { |message| Nunchaku::Message.new(message) }
+    end
+
+    def errors
+      messages.select { |message| message.type == 'error' }
+    end
+
+    def warnings
+      messages.select { |message| message.subtype == 'warning' }
+    end
+
+    private
+
+    def defaults
+      { checker_uri: 'https://html5.validator.nu/' }
+    end
+  end
+end

data/lib/nunchaku/message.rb

@@ -0,0 +1,20 @@
+module Nunchaku
+  class Message
+    attr_reader :type, :subtype, :first_line, :last_line,
+                :first_column, :last_column, :message,
+                :extract, :hilite_start, :hilite_length
+
+    def initialize(data)
+      @type           = data['type']
+      @subtype        = data['subType']
+      @first_line     = data['firstLine']
+      @last_line      = data['lastLine']
+      @first_column   = data['firstColumn']
+      @last_column    = data['lastColumn']
+      @message        = data['message']
+      @extract        = data['extract']
+      @hilite_start   = data['hiliteStart']
+      @hilite_length  = data['hiliteLength']
+    end
+  end
+end

data/lib/nunchaku/version.rb

@@ -0,0 +1,3 @@
+module Nunchaku
+  VERSION = "0.1.0"
+end

data/nunchaku.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nunchaku/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nunchaku"
+  spec.version       = Nunchaku::VERSION
+  spec.authors       = ["Jaime Iniesta"]
+  spec.email         = ["jaimeiniesta@gmail.com"]
+
+  spec.summary       = %q{Ruby client for the Nu HTML Checker}
+  spec.description   = %q{Ruby client to check HTML markup using the Nu HTML Checker at https://html5.validator.nu/}
+  spec.homepage      = "https://github.com/sitevalidator/nunchaku"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency     "httparty", "~> 0.13"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.2"
+  spec.add_development_dependency "webmock", "~> 1.20"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: nunchaku
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jaime Iniesta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: Ruby client to check HTML markup using the Nu HTML Checker at https://html5.validator.nu/
+email:
+- jaimeiniesta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nunchaku.rb
+- lib/nunchaku/checker.rb
+- lib/nunchaku/message.rb
+- lib/nunchaku/version.rb
+- nunchaku.gemspec
+homepage: https://github.com/sitevalidator/nunchaku
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Nu HTML Checker
+test_files: []