accesslint-ci 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa3733f759107ca29fd992d26ecd88efcc9684d8
+  data.tar.gz: 63f81acd0c0e944ce91de37eab291db58e4acd9e
+SHA512:
+  metadata.gz: 2320999589fa6632918af2da7e898195120470dffca0f41f5c45ad6b1b3af2069e2744c93a682de7386c734411212e02d53ba5da0233a6191a736073030204e9
+  data.tar.gz: 4d79183eec4607ea405c7fc063bb14f2c4ad9b5f13e49ee0cea8dfb5798b7221fd521408cffc655ee54cdfb5d7be0405f93c9710e5967a006d83dd21ca971e1f

data/.env.sample

@@ -0,0 +1,5 @@
+ACCESSLINT_GITHUB_TOKEN=
+CIRCLE_BRANCH=
+CIRCLE_PROJECT_REPONAME=
+CIRCLE_PROJECT_USERNAME=
+CIRCLE_TOKEN=

data/.env.test

@@ -0,0 +1,5 @@
+CIRCLE_BRANCH=example-branch
+CIRCLE_PROJECT_REPONAME=accesslint-ci.rb
+CIRCLE_PROJECT_USERNAME=accesslint
+CIRCLE_TOKEN=ABC123
+ACCESSLINT_GITHUB_TOKEN=ABC456

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at cameron@thoughtbot.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Cameron Cundiff
+
+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,54 @@
+# Accesslint::Ci
+
+Run accesslint-cli in CircleCI
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'accesslint-ci'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install accesslint-ci
+
+## Usage
+
+general:
+  artifacts:
+    - "accesslint.log"
+
+machine:
+  node:
+    version: 6.1.0
+
+dependencies:
+  override:
+    - npm install -g accesslint-cli
+
+test:
+  post:
+    - bundle exec puma -d -C./config/puma.rb
+    - accesslint-ci scan http://localhost:3000
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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 release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/accesslint-ci.rb/accesslint-ci. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/accesslint-ci.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'accesslint/ci/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "accesslint-ci"
+  spec.version       = Accesslint::Ci::VERSION
+  spec.authors       = ["Cameron Cundiff"]
+  spec.email         = ["cameron@thoughtbot.com"]
+
+  spec.summary       = %q{Run accesslint accessibility scanner in CI}
+  spec.description   = %q{Run accesslint-cli accessibility assertions against a host url}
+  spec.homepage      = "https://www.github.com/accesslint/accesslint-ci.rb"
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv"
+
+  spec.add_dependency "rest-client"
+  spec.add_dependency "thor"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "accesslint/ci"
+
+# 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,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+brew install wget
+npm install -g accesslint-cli

data/circle.yml

@@ -0,0 +1,8 @@
+machine:
+  node:
+    version: 6.1.0
+
+dependencies:
+  override:
+    - bundle install
+    - npm install -g accesslint-cli

data/lib/accesslint/ci.rb

@@ -0,0 +1,10 @@
+require "accesslint/ci/version"
+require "accesslint/ci/cli"
+require "accesslint/ci/log_manager"
+require "accesslint/ci/commenter"
+require "accesslint/ci/scanner"
+
+module Accesslint
+  module Ci
+  end
+end

data/lib/accesslint/ci/cli.rb

@@ -0,0 +1,23 @@
+require "thor"
+
+module Accesslint
+  module Ci
+    class Cli < Thor
+      desc "scan HOST", "scan HOST"
+      option :crawl, type: :boolean
+      def scan(host)
+        current = Scanner.perform(host: host, options: options).split("\n")
+
+        if ENV.fetch("CIRCLE_BRANCH") != "master"
+          existing = LogManager.get.split("\n")
+          diff = current - existing
+
+          if diff.any?
+            Commenter.perform(diff)
+            puts diff
+          end
+        end
+      end
+    end
+  end
+end

data/lib/accesslint/ci/commenter.rb

@@ -0,0 +1,81 @@
+require "rest-client"
+
+module Accesslint
+  module Ci
+    class Commenter
+      def self.perform(*args)
+        new(*args).perform
+      end
+
+      def initialize(diff)
+        @diff = diff
+      end
+
+      def perform
+        RestClient.post(github_uri, payload)
+      end
+
+      private
+
+      attr_reader :diff
+
+      def github_uri
+        @github_uri ||= "#{github_host}/issues/#{pull_request_number}/comments"
+      end
+
+      def github_host
+        URI.join(
+          "https://#{auth}@api.github.com/",
+          "repos/",
+          project_path,
+        )
+      end
+
+      def auth
+        "accesslint-ci:#{ENV.fetch('ACCESSLINT_GITHUB_TOKEN')}"
+      end
+
+      def pull_request_number
+        if ENV["CI_PULL_REQUEST"]
+          ENV.fetch("CI_PULL_REQUEST").match(/(\d+)/)[0]
+        else
+          pull_requests[0].fetch("number")
+        end
+      end
+
+      def pull_requests
+        @prs ||= JSON.parse(
+          RestClient.get(
+            "#{github_host}/pulls?head=#{pull_request_head}"
+          )
+        )
+      end
+
+      def pull_request_head
+        "#{ENV.fetch('CIRCLE_PROJECT_USERNAME')}:#{ENV.fetch('CIRCLE_BRANCH')}"
+      end
+
+      def payload
+        {
+          body: message,
+        }.to_json
+      end
+
+      def message
+        "Found #{diff.count} new accessibility issues: \n```\n#{snippet}\n```"
+      end
+
+      def snippet
+        diff.join("\n")
+      end
+
+      def project_path
+        [
+          ENV.fetch("CIRCLE_PROJECT_USERNAME"),
+          ENV.fetch("CIRCLE_PROJECT_REPONAME"),
+        ].join("/")
+      end
+    end
+  end
+end
+

data/lib/accesslint/ci/log_manager.rb

@@ -0,0 +1,66 @@
+require "rest-client"
+require "json"
+
+module Accesslint
+  module Ci
+    class MissingArtifactError < StandardError; end
+    class LogManager
+      def self.get
+        new.get
+      end
+
+      def get
+        RestClient.get(
+          "#{artifact_url}?circle-token=#{ENV.fetch('CIRCLE_TOKEN')}"
+        )
+      rescue MissingArtifactError => e
+        puts e.message
+        "\n"
+      end
+
+      private
+
+      def artifact_url
+        @artifacts = JSON.parse(RestClient.get("#{artifacts_uri}?#{query}"))
+
+        artifact = @artifacts.first do |artifact|
+          artifact["path"].end_with?("accesslint.log")
+        end
+
+        if artifact
+          @artifact_url ||= artifact.fetch("url")
+        else
+          raise MissingArtifactError.new("No existing logs for comparison.")
+        end
+      end
+
+      def artifacts_uri
+        URI.join(
+          "https://circleci.com/",
+          "api/v1/project/",
+          project_path,
+          "latest/artifacts",
+        )
+      end
+
+      def project_path
+        [
+          ENV.fetch("CIRCLE_PROJECT_USERNAME"),
+          ENV.fetch("CIRCLE_PROJECT_REPONAME"),
+        ].join("/") + "/"
+      end
+
+      def query
+        URI.encode_www_form([
+          ["branch", branch],
+          ["filter", "successful"],
+          ["circle-token", ENV.fetch("CIRCLE_TOKEN")],
+        ])
+      end
+
+      def branch
+        "master"
+      end
+    end
+  end
+end

data/lib/accesslint/ci/scanner.rb

@@ -0,0 +1,59 @@
+require "uri"
+require "fileutils"
+
+module Accesslint
+  module Ci
+    SITE_DIR = "tmp/accesslint-site".freeze
+    LOG_FILE = "tmp/accesslint.log".freeze
+
+    class Scanner
+      def self.perform(*args)
+        new(*args).perform
+      end
+
+      def initialize(host:, options: {})
+        @host = host
+        @options = options
+      end
+
+      def perform
+        create_site_dir
+        create_log_file
+        `#{crawl_site}`
+
+        File.read(LOG_FILE)
+      end
+
+      private
+
+      attr_reader :host, :options
+
+      def create_site_dir
+        if !File.exists?(SITE_DIR)
+          FileUtils::mkdir_p(SITE_DIR)
+        end
+      end
+
+      def create_log_file
+        if File.exists?(LOG_FILE)
+          FileUtils::rm(LOG_FILE)
+        end
+      end
+
+
+      def crawl_site
+        <<-SHELL
+          wget #{host} \
+            --convert-links \
+            --html-extension \
+            --mirror \
+            --directory-prefix #{SITE_DIR} \
+            --quiet
+
+          find #{SITE_DIR} -type f -name "*.html" | \
+            xargs -n 1 -P 5 accesslint >> #{LOG_FILE}
+        SHELL
+      end
+    end
+  end
+end

data/lib/accesslint/ci/version.rb

@@ -0,0 +1,5 @@
+module Accesslint
+  module Ci
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: accesslint-ci
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cameron Cundiff
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Run accesslint-cli accessibility assertions against a host url
+email:
+- cameron@thoughtbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".env.test"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- accesslint-ci.gemspec
+- bin/console
+- bin/setup
+- circle.yml
+- lib/accesslint/ci.rb
+- lib/accesslint/ci/cli.rb
+- lib/accesslint/ci/commenter.rb
+- lib/accesslint/ci/log_manager.rb
+- lib/accesslint/ci/scanner.rb
+- lib/accesslint/ci/version.rb
+homepage: https://www.github.com/accesslint/accesslint-ci.rb
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Run accesslint accessibility scanner in CI
+test_files: []