mortise 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 046a97517a767827bcaa186f1709f343b8b6f2f6
+  data.tar.gz: 751af607e289c6f1159a672239dcd78f10ef4274
+SHA512:
+  metadata.gz: 4eed2f7ed8c1b4c4b55bdde7754067f2ae9343130da8eccf368485606a77566c04d4d6a10a116053eac0ef0722e6037f646d434d4355ecc10709ee5e9aece211
+  data.tar.gz: 19198ef3eb4091dacda80022b6e19d2f2e0dba4971a8889d349199e4e13ab58f765c629c4bfe469f839c4ba62940ac184b76238d2c32c9b8c3f4a39f412bc105

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

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 mortise.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,80 @@
+# Mortise [![travis build status](https://secure.travis-ci.org/sitevalidator/mortise.png?branch=master)](http://travis-ci.org/sitevalidator/mortise) [![Code Climate](https://codeclimate.com/github/sitevalidator/mortise/badges/gpa.svg)](https://codeclimate.com/github/sitevalidator/mortise) [![Dependency Status](https://gemnasium.com/sitevalidator/mortise.png)](https://gemnasium.com/sitevalidator/mortise)
+
+Mortise is a Ruby client for the [Tenon.io](http://tenon.io/documentation/) accessibility checker. It lets you easily check for accessibility issues on web pages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mortise'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mortise
+
+## Usage
+
+You'll need an API Key to use Tenon.io, so first [register](http://tenon.io/register.php) and come back when you've got your API Key.
+
+To check accessibility on a web page, just pass Mortise the URL to check and the API key, like this:
+
+```ruby
+checker = Mortise.check('http://validationhell.com', 'YOUR-API-KEY')
+```
+
+Then, you can check the JSON response like this:
+
+```ruby
+checker.raw # {
+            #   "resultSet":[
+            #     {
+            #       "bpID":1,
+            #       "certainty":100,
+            #       "errorDescription":"All images must have an alt attribute...
+```
+
+Every issue returned will also accessible in a more friendly way like this, where the
+snake_cased Ruby attributes correspond to the camelCased JSON attributes:
+
+```ruby
+issue = checker.issues.first
+
+issue.bp_id
+issue.certainty
+issue.error_description
+issue.error_snippet
+issue.error_title
+issue.position
+issue.priority
+issue.result_title
+issue.signature
+issue.standards
+issue.t_id
+issue.xpath
+```
+
+The `issues` array contains all issues returned by the checker, but you'll typically be more interested in `errors` (that contains all issues with certainty >= 80) and `warnings` (that contains all issues with certainty < 80).
+
+## Using a Tenon Enterprise instance
+
+By default, Mortise will query the Tenon.io API at http://tenon.io/api/ but if you're using your own Tenon Enterprise instance you can set its location like this:
+
+Mortise.check('http://example.com', 'YOUR-API-KEY', tenon_uri: 'http://yourchecker.com')
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `bundle console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mortise/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/lib/mortise.rb

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

data/lib/mortise/checker.rb

@@ -0,0 +1,42 @@
+require 'httparty'
+require 'json'
+
+module Mortise
+  class Checker
+    attr_reader :url, :tenon_uri, :key
+
+    def initialize(url, key, options = {})
+      options = defaults.merge(options)
+
+      @url       = url
+      @key       = key
+
+      @tenon_uri = options[:tenon_uri]
+    end
+
+    def raw
+      @raw ||= JSON.parse HTTParty.post(tenon_uri,
+                                        body: { url: url, key: key },
+                                        headers: { 'Content-Type'  => 'application/x-www-form-urlencoded',
+                                                   'Cache-Control' => 'no-cache' }).body
+    end
+
+    def issues
+      @issues ||= raw['resultSet'].map { |issue| Mortise::Issue.new(issue) }
+    end
+
+    def errors
+      @errors ||= issues.select { |issue| issue.certainty >= 80 }
+    end
+
+    def warnings
+      @warnings ||= issues.select { |issue| issue.certainty < 80 }
+    end
+
+    private
+
+    def defaults
+      { tenon_uri: 'https://tenon.io/api/' }
+    end
+  end
+end

data/lib/mortise/issue.rb

@@ -0,0 +1,23 @@
+module Mortise
+  class Issue
+    attr_reader :bp_id, :certainty, :error_description, :error_snippet,
+                :error_title, :position, :priority, :result_title, :signature,
+                :standards, :t_id, :xpath
+
+    def initialize(data)
+      @bp_id             = data['bpID']
+      @certainty         = data['certainty']
+      @error_description = data['errorDescription']
+      @error_snippet     = data['errorSnippet']
+      @error_title       = data['errorTitle']
+      @position          = data['position']
+      @priority          = data['priority']
+      @result_title      = data['resultTitle']
+      @signature         = data['signature']
+      @standards         = data['standards']
+      @t_id              = data['tID']
+      @xpath             = data['xpath']
+    end
+
+  end
+end

data/lib/mortise/version.rb

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

data/mortise.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mortise/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mortise"
+  spec.version       = Mortise::VERSION
+  spec.authors       = ["Jaime Iniesta"]
+  spec.email         = ["jaimeiniesta@gmail.com"]
+
+  spec.summary       = %q{Ruby client for the Tenon accessibility checker}
+  spec.description   = %q{Ruby client to test accessibility of web pages using the Tenon.io JSON API}
+  spec.homepage      = "https://github.com/sitevalidator/mortise"
+  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 "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.2"
+  spec.add_development_dependency "webmock", "~> 1.20"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: mortise
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jaime Iniesta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-23 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: 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 test accessibility of web pages using the Tenon.io JSON
+  API
+email:
+- jaimeiniesta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mortise.rb
+- lib/mortise/checker.rb
+- lib/mortise/issue.rb
+- lib/mortise/version.rb
+- mortise.gemspec
+homepage: https://github.com/sitevalidator/mortise
+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 Tenon accessibility checker
+test_files: []