rack-easy_brotli 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90c6a421a62be6d4257439c1f4c3b551bbd130347746aa169a32057cb0acb77c
+  data.tar.gz: 9d07efecfaab4ea4a1e451888d21cc711a0885dff2b69ef2ffc4ef63b6f26739
+SHA512:
+  metadata.gz: adb6aebce3c4c444b6320104b5b1212cf437ae8c32cecd88a3cb75f409702f10c3d295cdb18a16c6382f71b713cc5e70a959320ea3fced996697299822b07e6e
+  data.tar.gz: a924c24565f9ce5dea893277147023622002172c10015abaf61ca6a945117ec573ac5a6d51d8dba17b21bb609e7ea0b95c783757657bb1b8a60f58334a4e6a18

data/COPYING

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+Copyright (c) 2008 The Committers
+
+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 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,40 @@
+# Rack::Brotli [![Gem Version](https://badge.fury.io/rb/rack-brotli.svg)](https://badge.fury.io/rb/rack-brotli) [![Build Status](https://travis-ci.org/marcotc/rack-brotli.svg?branch=master)](https://travis-ci.org/marcotc/rack-brotli)
+
+`Rack::Brotli` compresses `Rack` responses using [Google's Brotli](https://github.com/google/brotli) compression algorithm.
+
+Brotli generally compresses better than `gzip` for the same CPU cost and is supported by [Chrome, Firefox, IE and Opera](http://caniuse.com/#feat=brotli).
+
+### Use
+
+Install gem:
+
+    gem install rack-easy_brotli
+
+Requiring `'rack/brotli'` will autoload `Rack::Brotli` module. The following example shows what a simple rackup
+(`config.ru`) file might look like:
+
+```ruby
+require 'rack'
+require 'rack/brotli'
+
+use Rack::Brotli
+
+run theapp
+```
+
+bundler
+```ruby
+gem 'rack-easy_brotli'
+```
+
+### Testing
+
+To run the entire test suite, run 
+
+    rake test
+
+### Links
+
+* rack-brotli on GitHub:: <http://github.com/marcotc/rack-brotli>
+* Rack:: <http://rack.rubyforge.org/>
+* Rack On GitHub:: <http://github.com/rack/rack>

data/lib/rack/brotli.rb

@@ -0,0 +1,16 @@
+require_relative 'brotli/instrument'
+require_relative 'brotli/deflater'
+require_relative 'brotli/version'
+require_relative 'brotli/railtie' if defined?(::Rails)
+
+module Rack
+  module Brotli
+    def self.release
+      Version.to_s
+    end
+
+    def self.new(app, options={})
+      Rack::Brotli::Deflater.new(app, options)
+    end
+  end
+end

data/lib/rack/brotli/deflater.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "brotli"
+require 'rack/utils'
+
+module Rack::Brotli
+  # This middleware enables compression of http responses.
+  #
+  # Currently supported compression algorithms:
+  #
+  #   * br
+  #
+  # The middleware automatically detects when compression is supported
+  # and allowed. For example no transformation is made when a cache
+  # directive of 'no-transform' is present, or when the response status
+  # code is one that doesn't allow an entity body.
+  class Deflater
+    ##
+    # Creates Rack::Brotli middleware.
+    #
+    # [app] rack app instance
+    # [options] hash of deflater options, i.e.
+    #           'if' - a lambda enabling / disabling deflation based on returned boolean value
+    #                  e.g use Rack::Brotli, :if => lambda { |env, status, headers, body| body.map(&:bytesize).reduce(0, :+) > 512 }
+    #           'include' - a list of content types that should be compressed
+    #           'deflater' - Brotli compression options
+    def initialize(app, options = {})
+      @app = app
+
+      @condition = options[:if]
+      @compressible_types = options[:include]
+      if defined?(ActiveSupport::Notifications)
+        @notifier = ActiveSupport::Notifications
+      else
+        @notifier = Rack::Brotli::Instrument
+      end
+      @deflater_options = { quality: 5 }
+      @deflater_options.merge!(options[:deflater]) if options[:deflater]
+      @deflater_options
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      headers = header_hash(headers)
+
+      unless should_deflate?(env, status, headers, body)
+        return [status, headers, body]
+      end
+
+      request = Rack::Request.new(env)
+
+      encoding = Rack::Utils.select_best_encoding(%w(br),
+                                            request.accept_encoding)
+
+      return [status, headers, body] unless encoding
+
+      instrument(request) do
+        # Set the Vary HTTP header.
+        vary = headers["Vary"].to_s.split(",").map(&:strip)
+        unless vary.include?("*") || vary.include?("Accept-Encoding")
+          headers["Vary"] = vary.push("Accept-Encoding").join(",")
+        end
+
+        case encoding
+        when "br"
+          headers['Content-Encoding'] = "br"
+          headers.delete('Content-Length')
+          [status, headers, BrotliStream.new(body, @deflater_options)]
+        when nil
+          message = "An acceptable encoding for the requested resource #{request.fullpath} could not be found."
+          bp = Rack::BodyProxy.new([message]) { body.close if body.respond_to?(:close) }
+          [406, {'Content-Type' => "text/plain", 'Content-Length' => message.length.to_s}, bp]
+        end
+      end
+    end
+
+    class BrotliStream
+      include Rack::Utils
+
+      def initialize(body, options)
+        @body = body
+        @options = options
+      end
+
+      def each(&block)
+        @writer = block
+        buffer = +''
+        @body.each { |part|
+          buffer << part
+        }
+        yield ::Brotli.deflate(buffer, @options)
+      ensure
+        @writer = nil
+      end
+
+      def close
+        @body.close if @body.respond_to?(:close)
+      end
+    end
+    
+    private
+
+    # instrument for performance metrics
+    def instrument(request, &block)
+      @notifier.instrument("rack.brotli", request: request) do
+        yield
+      end
+    end
+
+    def header_hash(headers)
+      if headers.is_a?(Rack::Utils::HeaderHash)
+        header
+      else
+        Rack::Utils::HeaderHash.new(headers) # rack < 2.2
+      end
+    end
+
+    def should_deflate?(env, status, headers, body)
+      # Skip compressing empty entity body responses and responses with
+      # no-transform set.
+      if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key?(status.to_i) ||
+          /\bno-transform\b/.match?(headers['Cache-Control'].to_s) ||
+          headers['Content-Encoding']&.!~(/\bidentity\b/)
+        return false
+      end
+
+      # Skip if @compressible_types are given and does not include request's content type
+      return false if @compressible_types && !(headers.has_key?('Content-Type') && @compressible_types.include?(headers['Content-Type'][/[^;]*/]))
+
+      # Skip if @condition lambda is given and evaluates to false
+      return false if @condition && !@condition.call(env, status, headers, body)
+
+      # No point in compressing empty body, also handles usage with
+      # Rack::Sendfile.
+      return false if headers['Content-Length'] == '0'
+
+      true
+    end
+  end
+end

data/lib/rack/brotli/instrument.rb

@@ -0,0 +1,11 @@
+# dummy implementation for non-rails environments
+
+module Rack
+  module Brotli
+    class Instrument
+      def self.instrument(name, **args, &block)
+        yield
+      end
+    end
+  end
+end

data/lib/rack/brotli/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rack
+  module Brotli
+    class Railtie < ::Rails::Railtie
+      initializer "rack-brotli.middleware" do |app|
+        app.middleware.use(Rack::Brotli)
+      end
+    end
+  end
+end

data/lib/rack/brotli/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rack
+  module Brotli
+    class Version
+      def self.to_s
+        '1.2.0'
+      end
+    end
+  end
+end

data/lib/rack/easy_brotli.rb

@@ -0,0 +1 @@
+require 'rack/brotli'

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: rack-easy_brotli
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Marco Costa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: brotli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.3.1
+description: Rack::Brotli enables Google's Brotli compression on HTTP responses
+email: marco@marcotc.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- COPYING
+files:
+- COPYING
+- README.md
+- lib/rack/brotli.rb
+- lib/rack/brotli/deflater.rb
+- lib/rack/brotli/instrument.rb
+- lib/rack/brotli/railtie.rb
+- lib/rack/brotli/version.rb
+- lib/rack/easy_brotli.rb
+homepage: http://github.com/marcotc/rack-brotli/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--line-numbers"
+- "--inline-source"
+- "--title"
+- rack-brotli
+- "--main"
+- README
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.17
+signing_key:
+specification_version: 2
+summary: Brotli compression for Rack responses
+test_files: []