achecker 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzlmYzU0ZTFjOWYzMGQwNmI3NzA2MDhkZDIwM2JiNjEwYWIzYzMwOQ==
+  data.tar.gz: !binary |-
+    YzhhOTZhMTFhMzJjMzRiOGRkYWU3N2NhNDZjODc5NDQxOWQ1MDRiYw==
+SHA512:
+  metadata.gz: !binary |-
+    MmY4N2RhMzZlODU3OWZhMmQyN2EzNTA1NDBjMDQxMjhjODc1OTQ1ODMyMmNk
+    OGVjY2Q1N2Y3MGE0YWM4M2U2MWRkYjNkNTc1YjdjMzU1MDY1Y2E2ZWZjMzgy
+    N2JlZGUxODYyN2RhNWZhZDc3NDhjZTNjMmJhZTc2ZGExMzJhZGE=
+  data.tar.gz: !binary |-
+    MjYzYmE3NTc0Njc2ZWE3ZWMxNDEzODYwNzhiNTM5ZWVhN2ZhYjg4ZDA2ZmRh
+    YzE4MWFkZWQ1ZDMzMGVlZmEzYzc3NDQ4M2M0Zjk2YTAxZWM5MWViMjU2MWY4
+    YzUzZDE0YTI1Yzk4YmJlNjgzNDExMjdkMzU0ZDUzN2I0MDY2NDY=

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--warnings

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+rvm:
+- 1.9.2
+- 1.9.3
+- 2.0.0
+- 2.1.0
+- 2.1.1
+- 2.1.2
+- ruby-head
+- jruby-19mode
+- jruby
+- jruby-head
+matrix:
+  allow_failures:
+  - rvm: jruby-head
+  - rvm: ruby-head
+deploy:
+  provider: rubygems
+  api_key:
+    secure: nNu6E7wClBo6DEkl+0Rd0ouQr29YwwruhqCI0op/N1AdL5Vq2DW3pSKHZYHHE36T3y5sudV9GPddnJ2O+hhNsp3pMacC7hkfs/L1Gi5WkJ2s421McX13TGfilX22iEMj4Ezlskka1ovAUuzewri0W3UAX8gNiN6RgaMTS6zRivU=
+  gem: achecker
+  on:
+    tags: true
+    all_branches: true
+    repo: rmagrin/achecker

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rafael Magrin
+
+MIT License
+
+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,63 @@
+# AChecker [![Build Status](https://travis-ci.org/rmagrin/achecker.svg?branch=master)](https://travis-ci.org/rmagrin/achecker) [![Dependency Status](https://gemnasium.com/rmagrin/achecker.svg)](https://gemnasium.com/rmagrin/achecker) [![Code Climate](https://codeclimate.com/github/rmagrin/achecker.png)](https://codeclimate.com/github/rmagrin/achecker)
+
+Ruby wrapper for [AChecker Web Accessibility Checker](http://achecker.ca)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'achecker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install achecker
+
+## Usage
+
+```ruby
+   require 'achecker'
+
+   # replace with the web service id provided for registered users of achecker.
+   id = "222c0b31450b95b0e010f5f83d9c9683f95ca89a"
+   checker = AChecker::Api.new(id)
+   result = checker.check("http://example.com")
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/rmagrin/achecker/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
+
+## License
+
+Copyright (c) 2014 Rafael Magrin
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/achecker.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'achecker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "achecker"
+  spec.version       = AChecker::VERSION
+  spec.authors       = ["Rafael Magrin"]
+  spec.email         = ["rafael.magrin@gmail.com"]
+  spec.summary       = "Wrapper for AChecker Web Accessibility Checker"
+  spec.description   = "Wrapper for AChecker Web Accessibility Checker"
+  spec.homepage      = "https://github.com/rmagrin/achecker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "webmock", "~> 1.18"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/achecker.rb

@@ -0,0 +1,2 @@
+require "achecker/version"
+require "achecker/api"

data/lib/achecker/api.rb

@@ -0,0 +1,25 @@
+require 'net/http'
+require 'achecker/url_builder'
+require 'achecker/check_result_builder'
+
+module AChecker
+
+  class Api
+
+    def initialize(id)
+      @url_builder = UrlBuilder.new(id)
+      @result_builder = CheckResultBuilder.new
+    end
+
+    def check(target_url)
+      url = @url_builder.build(target_url, "rest")
+      response = Net::HTTP.get_response(url)
+
+      raise "Error processing \"#{target_url}\". Response status code #{response.code}" unless response.kind_of?(Net::HTTPSuccess)
+
+      @result_builder.build(target_url, @url_builder.build(target_url, "html"), response.body)
+    end
+
+  end
+
+end

data/lib/achecker/check_result.rb

@@ -0,0 +1,19 @@
+module AChecker
+
+  class CheckResult
+
+    attr_reader :url, :achecker_url, :num_errors
+
+    def initialize(url, achecker_url, num_errors)
+      @url = url
+      @achecker_url = achecker_url
+      @num_errors = num_errors
+    end
+
+    def has_errors
+      @num_errors > 0
+    end
+
+  end
+
+end

data/lib/achecker/check_result_builder.rb

@@ -0,0 +1,21 @@
+require 'nokogiri'
+
+require 'achecker/check_result'
+
+module AChecker
+
+  class CheckResultBuilder
+
+    def build(url, achecker_url, xml)
+      xml_doc = Nokogiri::XML(xml)
+
+      CheckResult.new(
+        url,
+        achecker_url,
+        xml_doc.xpath("//summary/NumOfErrors")[0].text.to_i
+      )
+    end
+
+  end
+
+end

data/lib/achecker/url_builder.rb

@@ -0,0 +1,21 @@
+require 'cgi'
+
+module AChecker
+
+  class UrlBuilder
+
+    BASE_URL = "http://achecker.ca/checkacc.php"
+
+    def initialize(id = nil)
+      @id = id
+    end
+
+    def build(target_url, output)
+      url = "#{BASE_URL}?uri=#{CGI::escape(target_url)}&output=#{output}"
+      url = "#{url}&id=#{@id}" if output == "rest"
+      URI(url)
+    end
+
+  end
+
+end

data/lib/achecker/version.rb

@@ -0,0 +1,3 @@
+module AChecker
+  VERSION = "0.0.1"
+end

data/spec/achecker/api_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'cgi'
+require 'webmock'
+
+include WebMock::API
+
+module AChecker
+
+  describe Api do
+
+    describe "#check" do
+
+      it "should check url" do
+        id = "12345678"
+        url = CGI::escape("http://example.com/some-resource/")
+        xml = <<-eos
+          <?xml version="1.0" encoding="ISO-8859-1"?>
+          <resultset>
+            <summary>
+              <NumOfErrors>30</NumOfErrors>
+            </summary>
+          </resultset>
+        eos
+
+
+        stub_request(:get, "achecker.ca/checkacc.php")
+          .with(:query => {"uri" => url, "id" => id, "output" => "rest"})
+          .to_return(:body => xml)
+
+        api = Api.new(id)
+
+        result = api.check(url)
+
+        expect(result.url).to eq(url)
+        expect(result.num_errors).to eq(30)
+      end
+
+    end
+
+  end
+
+end

data/spec/achecker/check_result_builder_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module AChecker
+
+  describe CheckResultBuilder do
+
+    let (:builder) { CheckResultBuilder.new }
+
+    describe "#build" do
+
+      it "should set numbers of errors" do
+
+        xml = <<-eos
+          <?xml version="1.0" encoding="ISO-8859-1"?>
+          <resultset>
+            <summary>
+              <status>FAIL</status>
+              <sessionID>ce2a543670703b6d37dc613deda3e64389ad038d</sessionID>
+              <NumOfErrors>35</NumOfErrors>
+              <NumOfLikelyProblems>0</NumOfLikelyProblems>
+              <NumOfPotentialProblems>0</NumOfPotentialProblems>
+              <guidelines><guideline>WCAG 2.0 (Level AA)</guideline></guidelines>
+            </summary>
+          </resultset>
+        eos
+
+        result = builder.build("url", "achecker_url", xml)
+
+        expect(result.num_errors).to eq(35)
+      end
+
+    end
+
+  end
+
+end

data/spec/achecker/check_result_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module AChecker
+
+  describe CheckResult do
+
+    describe "#has_errors" do
+
+      context "when result does not have errors" do
+        it "should return false" do
+          result = CheckResult.new("url", "achecker_url", 0)
+          expect(result.has_errors).to be_falsy
+        end
+      end
+
+      context "when result has errors" do
+        it "should return true" do
+          result = CheckResult.new("url", "achecker_url", 1)
+          expect(result.has_errors).to be_truthy
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/achecker/url_builder_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module AChecker
+
+  describe UrlBuilder do
+
+    let(:id) { "12345" }
+    let(:builder) { UrlBuilder.new(id) }
+
+    describe "#build" do
+
+      context "when output is rest" do
+        it "should set the id" do
+          url = builder.build("http://target.url", "rest").to_s
+          expect(url).to include("id=#{id}")
+        end
+      end
+
+      context "when output is html" do
+        it "should not set the id" do
+          url = builder.build("http://target.url", "html").to_s
+          expect(url).not_to include("id=#{id}")
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'achecker'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: achecker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rafael Magrin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Wrapper for AChecker Web Accessibility Checker
+email:
+- rafael.magrin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- achecker.gemspec
+- lib/achecker.rb
+- lib/achecker/api.rb
+- lib/achecker/check_result.rb
+- lib/achecker/check_result_builder.rb
+- lib/achecker/url_builder.rb
+- lib/achecker/version.rb
+- spec/achecker/api_spec.rb
+- spec/achecker/check_result_builder_spec.rb
+- spec/achecker/check_result_spec.rb
+- spec/achecker/url_builder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rmagrin/achecker
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Wrapper for AChecker Web Accessibility Checker
+test_files:
+- spec/achecker/api_spec.rb
+- spec/achecker/check_result_builder_spec.rb
+- spec/achecker/check_result_spec.rb
+- spec/achecker/url_builder_spec.rb
+- spec/spec_helper.rb