rack-relations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa6e3b9e72d7ae0b3c446cedcf560afaad79243c05b5f1217ae33dd6754e9bce
+  data.tar.gz: 3024e1fcc29027e639920e2945f3c13516f6d40d92eaa338e0dfe51ab2aa0666
+SHA512:
+  metadata.gz: ad9a5f3ace43e54ca9e1e4e258038b64109fcdb9b77630184a3bf4c97d84782aa12a171327df8728c433a3a18759fe4bfa1671344ca63db50e093e530660c500
+  data.tar.gz: a246162059cbe66680b630986d8a4c45743ce1c99cf3e3d9228e4bcff838d3612022b22eabd17dcc398545088da1ee3ee0879bca1f05c6accef5098c60679517

data/.gitignore

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

data/.semaphore/semaphore.yml

@@ -0,0 +1,15 @@
+version: v1.0
+name: Initial Pipeline
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+blocks:
+  - name: 'Block #1'
+    task:
+      jobs:
+        - name: 'Run tests'
+          commands:
+            - checkout
+            - bundle
+            - rake test

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.markdown

@@ -0,0 +1,5 @@
+v0.1.0
+======
+
+* Initial release
+* Rack middleware to add `rel="nofollow noopener noreferrer"` to any link not safelisted.

data/CODE_OF_CONDUCT.markdown

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 34053+pbyrne@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rack-relations.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    rack-relations (0.1.0)
+      nokogiri (~> 1.10)
+      rack (>= 2.0, < 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    mocha (1.11.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  mocha
+  pry
+  rack-relations!
+  rack-test
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Patrick Byrne
+
+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.markdown

@@ -0,0 +1,57 @@
+# Rack::Relations
+
+Dynamically add `rel="nofollow noopener noreferrer"` to links on your page, so you don't have to remember to do it yourself. This is useful if you include links in your app to user-submitted URLs, to which you don't want to confer SEO benefits nor expose your users to potential phishing via `window.opener`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-relations'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rack-relations
+
+## Usage
+
+Add to your Rack app like so:
+
+```ruby
+# Rack
+use Rack::Relations::Middleware
+
+# Rails, config/application.rb
+config.middleware.use Rack::Relations::Middleware
+```
+
+Optionally pass it domains to safelist and not apply this attribute, as an array of strings (for exact domain matches) or regular expressions (for more fine-grained specificity):
+
+```ruby
+config.middleware.use Rack::Relations::Middleware,
+  safelist_domains: ["example.com", /\.org\Z/]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/rack-relations. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rack-relations/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rack::Relations project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rack-relations/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/relations"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/rack/relations.rb

@@ -0,0 +1,12 @@
+require "rack"
+require "rack/relations/version"
+
+require "rack/relations/anchor"
+require "rack/relations/middleware"
+require "rack/relations/processor"
+
+module Rack
+  module Relations
+    Error = Class.new(StandardError)
+  end
+end

data/lib/rack/relations/anchor.rb

@@ -0,0 +1,34 @@
+require "uri"
+
+module Rack
+  module Relations
+    class Anchor
+      attr_accessor :node, :safelist_domains, :uri
+
+      def initialize(node, safelist_domains:)
+        @node = node
+        @safelist_domains = safelist_domains
+        @uri = URI(node.attr("href")) rescue nil
+      end
+
+      def modified_rel
+        "#{node.attr("rel")} nofollow noopener noreferrer".strip
+      end
+
+      def safe?
+        return true if uri.relative?
+
+        safelist_domains.any? { |matcher| match?(matcher: matcher, host: uri.host) }
+      end
+
+      private def match?(matcher:, host:)
+        case matcher
+        when String
+          host.end_with?(matcher)
+        when Regexp
+          host =~ matcher
+        end
+      end
+    end
+  end
+end

data/lib/rack/relations/middleware.rb

@@ -0,0 +1,20 @@
+module Rack
+  module Relations
+    class Middleware
+      attr_accessor :app, :processor
+
+      def initialize(app, safelist_domains: [])
+        @app = app
+        @processor = Rack::Relations::Processor.new(safelist_domains: safelist_domains)
+      end
+
+      def call(env)
+        status, headers, response = @app.call(env)
+
+        response = @processor.perform(response)
+
+        [status, headers, response]
+      end
+    end
+  end
+end

data/lib/rack/relations/processor.rb

@@ -0,0 +1,35 @@
+require "nokogiri"
+
+module Rack
+  module Relations
+    class Processor
+      # TODO rename safelist_domains, might have other safelists?
+      attr_accessor :safelist_domains
+
+      def initialize(safelist_domains:)
+        @safelist_domains = safelist_domains
+      end
+
+      def perform(body)
+        doc = parsed_body(body.join("\n"))
+
+        doc.css("a[href]").each do |node|
+          anchor = Anchor.new(node, safelist_domains: safelist_domains)
+          next if anchor.safe?
+
+          node.set_attribute("rel", anchor.modified_rel)
+        end
+
+        [doc.to_html]
+      end
+
+      private def parsed_body(text)
+        if text =~ /<!DOCTYPE/i
+          Nokogiri::HTML(text)
+        else
+          Nokogiri::HTML.fragment(text)
+        end
+      end
+    end
+  end
+end

data/lib/rack/relations/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Relations
+    VERSION = "0.1.0"
+  end
+end

data/rack-relations.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/rack/relations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-relations"
+  spec.version       = Rack::Relations::VERSION
+  spec.authors       = ["Patrick Byrne"]
+  spec.email         = ["code@patrickbyrne.net"]
+
+  spec.summary       = %q{Dynamically rewrite markup to add `rel="nofollow noopener noreferrer"` to non-safelisted links.}
+  spec.homepage      = "https://github.com/pbyrne/rack-relations.git"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/pbyrne/rack-relations.git"
+  spec.metadata["changelog_uri"] = "https://github.com/pbyrne/rack-relations.git/blob/master/CHANGELOG.markdown"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "nokogiri", "~> 1.10"
+  spec.add_runtime_dependency "rack", ">= 2.0", "< 3"
+
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rack-test"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: rack-relations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Patrick Byrne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: pry
+  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: rack-test
+  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'
+description: 
+email:
+- code@patrickbyrne.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".semaphore/semaphore.yml"
+- ".travis.yml"
+- CHANGELOG.markdown
+- CODE_OF_CONDUCT.markdown
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/relations.rb
+- lib/rack/relations/anchor.rb
+- lib/rack/relations/middleware.rb
+- lib/rack/relations/processor.rb
+- lib/rack/relations/version.rb
+- rack-relations.gemspec
+homepage: https://github.com/pbyrne/rack-relations.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/pbyrne/rack-relations.git
+  source_code_uri: https://github.com/pbyrne/rack-relations.git
+  changelog_uri: https://github.com/pbyrne/rack-relations.git/blob/master/CHANGELOG.markdown
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Dynamically rewrite markup to add `rel="nofollow noopener noreferrer"` to
+  non-safelisted links.
+test_files: []