early_hints_header 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f9c4dda9525bf1414aaa190e19b155ef1cc3614d87a78ba0975f0266c2e2d08
+  data.tar.gz: 171b758f20d848fa02f5aac5c0f6c068f9a9c35fae253fb7d752d324ed146a49
+SHA512:
+  metadata.gz: 60510a78ddc33e8ecbb76668a82a155ea336c33071c4553fe679baec4f301e9fed72c2c67a67e5f749c5318ee66addca77d470330b243dc5aed42243fcd95016
+  data.tar.gz: a470a078a77f9de11a3c62e93119466665c92e121c837479c7ce52de572cb4f0ff41672ab8b5d2128a5f66fa84123693b09b794a97599ba10cf39a373ef835ee

data/.github/workflows/ruby.yml

@@ -0,0 +1,22 @@
+---
+name: Ruby
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2020-05-14
+
+### Added
+
+- Initial gem extraction from [@ianks](https://github.com/ianks).

data/CODE_OF_CONDUCT.md

@@ -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 i.kerseymer@gmail.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,11 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in early_hints_header.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "fast_woothee"
+gem "rack"
+gem "rack-test", group: :test
+gem "standardrb"

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    early_hints_header (1.0.0)
+      fast_woothee
+      rack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    fast_woothee (1.6.0)
+      thermite (~> 0.13.0)
+    jaro_winkler (1.5.4)
+    minitar (0.9)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    standard (0.4.1)
+      rubocop (~> 0.82.0)
+      rubocop-performance (~> 1.5.2)
+    standardrb (1.0.0)
+      standard
+    thermite (0.13.0)
+      minitar (~> 0.5)
+      rake (>= 10)
+      tomlrb (~> 1.2)
+    tomlrb (1.3.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  early_hints_header!
+  fast_woothee
+  rack
+  rack-test
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  standardrb
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ian Ker-Seymer
+
+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,75 @@
+# EarlyHintsHeader
+
+![Ruby](https://github.com/ianks/early_hints_header/workflows/Ruby/badge.svg)
+
+An early hints Ruby / Rack middleware which just sets Link headers.
+
+This means you can use early hints _without_ having to use the HTTP 103
+status code, i.e. [nginx's
+http2_push_preload](https://www.nginx.com/blog/nginx-1-13-9-http2-server-push/#automatic-push).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'early_hints_header'
+gem 'fast_woothee' # optional: for blocking broken client like iOS
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install early_hints_header
+
+## Usage
+
+```ruby
+# In config.ru
+
+require "early_hints_header/middleware"
+
+use EarlyHintsHeader::Middleware
+```
+
+## Caveats
+
+When using HTTP2 push, be aware of potential clients that do not properly
+support preloading. For example, [certain older Safari
+versions](https://jakearchibald.com/2017/h2-push-tougher-than-i-thought/) do
+not work properly. This gem will handle that if you have
+[fast_woothee](https://github.com/ianks/fast_woothee) installed.
+
+## 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/ianks/early_hints_header. 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/ianks/early_hints_header/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 EarlyHintsHeader project's codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/ianks/early_hints_header/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec, :standard]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "early_hints_header"
+
+# 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/early_hints_header.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/early_hints_header/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "early_hints_header"
+  spec.version = EarlyHintsHeader::VERSION
+  spec.authors = ["Ian Ker-Seymer"]
+  spec.email = ["i.kerseymer@gmail.com"]
+
+  spec.summary = "An early hints Ruby / Rack middleware which just sets Link headers (i.e. for nginx http2_push_preload)"
+  spec.homepage = "https://github.com/ianks/early_hints_header"
+  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/ianks/early_hints_header"
+  spec.metadata["changelog_uri"] = "https://github.com/ianks/early_hints_header/blob/master/CHANGELOG.md"
+
+  # 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.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fast_woothee"
+  spec.add_runtime_dependency "rack"
+end

data/lib/early_hints_header.rb

@@ -0,0 +1,7 @@
+require "early_hints_header/version"
+require "early_hints_header/middleware"
+
+module EarlyHintsHeader
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/early_hints_header/middleware.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+begin
+  require "fast_woothee"
+rescue LoadError
+  # ok
+end
+
+module EarlyHintsHeader
+  class Middleware
+    RACK_KEY = "early_hints.links"
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      env["rack.early_hints"] = proc do |header|
+        env[RACK_KEY] ||= []
+        env[RACK_KEY] << header["Link"]
+      end
+
+      status, headers, body = @app.call(env)
+      assign_headers(headers, env)
+      clear_thread_locals
+
+      [status, headers, body]
+    end
+
+    private
+
+    def build_link_header(headers, env)
+      links = [headers.delete("Link"), *env[RACK_KEY]]
+      links.compact!
+      links.join(",") if env.key?(RACK_KEY)
+    end
+
+    def clear_thread_locals
+      Thread.current[:__hanami_assets] = nil
+    end
+
+    def pushable?(env)
+      return true unless defined?(FastWoothee)
+      return false unless env.key?(RACK_KEY)
+
+      # ios caching with http2 push is unpredictable
+      !FastWoothee.ios?(env["HTTP_USER_AGENT"])
+    end
+
+    def assign_headers(headers, env)
+      return unless pushable?(env)
+
+      headers["Link"] = build_link_header(headers, env)
+    end
+  end
+end

data/lib/early_hints_header/version.rb

@@ -0,0 +1,3 @@
+module EarlyHintsHeader
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: early_hints_header
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ian Ker-Seymer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fast_woothee
+  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: rack
+  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: 
+email:
+- i.kerseymer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- early_hints_header.gemspec
+- lib/early_hints_header.rb
+- lib/early_hints_header/middleware.rb
+- lib/early_hints_header/version.rb
+homepage: https://github.com/ianks/early_hints_header
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ianks/early_hints_header
+  source_code_uri: https://github.com/ianks/early_hints_header
+  changelog_uri: https://github.com/ianks/early_hints_header/blob/master/CHANGELOG.md
+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.1.2
+signing_key: 
+specification_version: 4
+summary: An early hints Ruby / Rack middleware which just sets Link headers (i.e.
+  for nginx http2_push_preload)
+test_files: []