rack-compress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f39deacc15e2eab7f57931ee5b7995ebb86307d8acab163fc8a98fa0b8e9648
+  data.tar.gz: 32e598f17eb9257a5294ea828faaa0c904a7da25c9afb70b662e77ecef0048e5
+SHA512:
+  metadata.gz: 158674e688d525c79dd061c51b956233620955cf474a59b32865c6ef6205d21001f5dac346e3d16472d087b9f98bb217d8e83642469f6a6999efda3586ead73a
+  data.tar.gz: 99613bc5f42a865b981dae1713e606623cbddf7c059c6e65b263010b7a4fda21e1bc5bd5bb4763bcdca13ef27d7f6991bd15d458f01f94703402b45e5401240f

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,70 @@
+[![Gem Version](https://badge.fury.io/rb/rack-compress.svg)](https://badge.fury.io/rb/rack-compress) [![Build Status](https://github.com/andrepiske/rack-compress/actions/workflows/test.yml/badge.svg)](https://github.com/andrepiske/rack-compress/actions/workflows/test.yml)
+
+# Rack::Compress
+
+
+`Rack::Compress` compresses `Rack` responses using [Google's Brotli](https://github.com/google/brotli) and [Facebook's Zstandard](https://github.com/facebook/zstd) compression algorithms.
+
+Those generally compresses better than `gzip` for the same CPU cost.
+Brotli is supported by [Chrome, Firefox, IE and Opera](http://caniuse.com/#feat=brotli), while
+Zstandard (aka. Zstd) began making its way into major browsers and as of today it's available on Chrome behind feature flags, see [the caniuse page](https://caniuse.com/zstd).
+
+### Use
+
+Install gem:
+
+    gem install rack-compress
+
+Requiring `'rack/compress'` will autoload `Rack::compress` module.
+The following example shows what a simple rackup
+(`config.ru`) file might look like:
+
+```ruby
+require 'rack'
+require 'rack/compress'
+
+use Rack::Compress
+
+run theapp
+```
+
+Note that it is up to the browser or the HTTP client to choose the compression algorithm.
+This occurs via the [accept-encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding)
+header. `Rack::Compress` always gives priority to `zstd` when the client supports it, since
+it should perform better than Brotli
+[according to benchmarking](https://github.com/andrepiske/compress-benchmark#conclusions).
+
+It's possible to also customize the compression levels for each algorithm:
+
+```ruby
+use Rack::Compress, {
+  levels: {
+    brotli: 11, # must be between 0 and 11
+    zstd: 19 # must be between 1 and 19
+  }
+}
+```
+
+In case you want to better control which MIME types get compressed:
+
+```ruby
+use Rack::Compress, { include: [
+  'text/html',
+  'text/css',
+  'application/javascript',
+] }
+```
+
+The above will compress all those MIME types and not any other.
+
+### Testing
+
+To run the entire test suite, run 
+
+    rake test
+
+### Acknowledgements
+
+Thanks to [Marco Costa](https://github.com/marcotc) for the original gem form which this one
+was forked from.
+

data/lib/rack/compress/deflater.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require 'rack/utils'
+require 'zstd-ruby'
+require 'brotli'
+
+module Rack::Compress
+  # This middleware enables compression of http responses.
+  #
+  # Currently supported compression algorithms:
+  #
+  #   * br # gem 'brotli'
+  #   * zstd # gem 'extlz4'
+  #
+  # 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::Compress 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
+    #           'levels' - Compression levels
+    def initialize(app, options = {})
+      @app = app
+
+      @condition = options[:if]
+      @compressible_types = options[:include]
+      @levels_options = { brotli: 4, zstd: 5 }.merge(options[:levels] || {})
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      headers = Rack::Utils::HeaderHash.new(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(zstd br), request.accept_encoding)
+
+      return [status, headers, body] unless encoding
+
+      # 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 "zstd"
+        headers['content-encoding'] = "zstd"
+        headers.delete(Rack::CONTENT_LENGTH)
+        [status, headers, ZstandardStream.new(body, @levels_options[:zstd])]
+      when "br"
+        headers['content-encoding'] = "br"
+        headers.delete(Rack::CONTENT_LENGTH)
+        [status, headers, BrotliStream.new(body, @levels_options[:brotli])]
+      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, {Rack::CONTENT_TYPE => "text/plain", Rack::CONTENT_LENGTH => message.length.to_s}, bp]
+      end
+    end
+
+    class BrotliStream
+      include Rack::Utils
+
+      def initialize(body, level)
+        @body = body
+        @level = level
+      end
+
+      def each(&block)
+        @writer = block
+        # Use String.new instead of '' to support environments with strings frozen by default.
+        buffer = String.new
+        @body.each do |part|
+          buffer << part
+        end
+
+        # TODO: implement Brotli using streaming classes
+
+        yield ::Brotli.deflate(buffer, { quality: @level })
+      ensure
+        @writer = nil
+      end
+
+      def close
+        @body.close if @body.respond_to?(:close)
+      end
+    end
+
+    class ZstandardStream
+      include Rack::Utils
+
+      def initialize(body, level)
+        @body = body
+        @level = level
+        @compressor = ::Zstd::StreamingCompress.new(level)
+      end
+
+      def each(&block)
+        @writer = block
+
+        @body.each do |part|
+          @compressor << part
+        end
+
+        yield @compressor.finish
+      ensure
+        @writer = nil
+      end
+
+      def close
+        @body.close if @body.respond_to?(:close)
+      end
+    end
+
+    private
+
+    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.include?(status) ||
+          headers[Rack::CACHE_CONTROL].to_s =~ /\bno-transform\b/ ||
+         (headers['content-encoding'] && 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?(Rack::CONTENT_TYPE) && @compressible_types.include?(headers[Rack::CONTENT_TYPE][/[^;]*/]))
+
+      # Skip if @condition lambda is given and evaluates to false
+      return false if @condition && !@condition.call(env, status, headers, body)
+
+      true
+    end
+  end
+end

data/lib/rack/compress/version.rb

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

data/lib/rack/compress.rb

@@ -0,0 +1,14 @@
+require_relative 'compress/deflater'
+require_relative 'compress/version'
+
+module Rack
+  module Compress
+    def self.release
+      Version.to_s
+    end
+
+    def self.new(app, options={})
+      Rack::Compress::Deflater.new(app, options)
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: rack-compress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- André Diego Piske
+- Marco Costa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: brotli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+- !ruby/object:Gem::Dependency
+  name: zstd-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: Rack::Compress enables Zstd and Brotli compression on HTTP responses
+email: andrepiske@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- COPYING
+files:
+- COPYING
+- README.md
+- lib/rack/compress.rb
+- lib/rack/compress/deflater.rb
+- lib/rack/compress/version.rb
+homepage: http://github.com/andrepiske/rack-compress/
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 2
+summary: Compression for Rack responses
+test_files: []