rack3-brotli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee389cffae09bf684808d32bb04f226a53d1d7b71eb617b1f1632c8405ec295a
+  data.tar.gz: 5726d77510b5f1cc5928ddcad90ef893f61a26c7e2d6b1a22da8bf3593bc6808
+SHA512:
+  metadata.gz: 9d3a7cd8ecfc15638b256b488e0216f786bdea3e290326a5f06f6b0ec52609013307b81352517075c79444134affe60c168c1c6f47996ff66edf4e7214fd75c4
+  data.tar.gz: bcdacd25233f4c5470d46db9181122b7cc26035ab3d8912552d8177457664f74e472e9fccaed6d4a83c1ff1499ac0cf1775a3b14d1f81e48559f0cc0ca9f86ec

data/lib/rack/brotli/deflater.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "brotli"
+require "rack/deflater"
+require "rack/utils"
+
+module Rack
+  module Brotli
+    # This middleware enables content encoding of http responses,
+    # usually for purposes of compression.
+    #
+    # Currently supported encodings:
+    #
+    # * br
+    #
+    # This middleware automatically detects when encoding is supported
+    # and allowed. For example no encoding is made when a cache
+    # directive of 'no-transform' is present, when the response status
+    # code is one that doesn't allow an entity body, or when the body
+    # is empty.
+    #
+    class Deflater < ::Rack::Deflater
+      def initialize(app, options = {})
+        super
+
+        @deflater_options = { quality: 5 }.merge(options[:deflater] || {})
+      end
+
+      def call(env)
+        status, headers, body = response = @app.call(env)
+
+        return response unless should_deflate?(env, status, headers, body)
+
+        request = Request.new(env)
+
+        encoding = Utils.select_best_encoding(%w[br identity],
+                                              request.accept_encoding)
+
+        # Set the Vary HTTP header.
+        vary = headers["vary"].to_s.split(",").map(&:strip)
+        unless vary.include?("*") || vary.any? { |v| v.downcase == "accept-encoding" }
+          headers["vary"] = vary.push("Accept-Encoding").join(",")
+        end
+
+        case encoding
+        when "br"
+          headers["content-encoding"] = "br"
+          headers.delete(CONTENT_LENGTH)
+          response[2] = BrotliStream.new(body, @sync, @deflater_options)
+          response
+        when "identity"
+          response
+        else # when nil
+          # Only possible encoding values here are 'br', 'identity', and 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
+
+      # :nodoc:
+      class BrotliStream
+        BUFFER_LENGTH = 128 * 1_024
+
+        def initialize(body, sync, options)
+          @body = body
+          @sync = sync
+          @options = options
+        end
+
+        # Yield gzip compressed strings to the given block.
+        def each(&block)
+          @writer = block
+          br = ::Brotli::Writer.new(self, @options)
+          # @body.each is equivalent to @body.gets (slow)
+          if @body.is_a?(::File) # XXX: Should probably be ::IO
+            while (file_part = @body.read(BUFFER_LENGTH))
+              br.write(file_part)
+              br.flush if @sync
+            end
+          else
+            @body.each do |part|
+              # Skip empty strings, as they would result in no output,
+              # and flushing empty parts would raise Zlib::BufError.
+              next if part.empty?
+
+              br.write(part)
+              br.flush if @sync
+            end
+          end
+        ensure
+          br.finish
+        end
+
+        # Call the block passed to #each with the deflated data.
+        def write(data)
+          @writer.call(data)
+        end
+
+        # Close the original body if possible.
+        def close
+          @body.close if @body.respond_to?(:close)
+        end
+      end
+      private_constant :BrotliStream
+    end
+  end
+end

data/lib/rack/brotli/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rack
+  module Brotli
+    VERSION = "1.0.0"
+  end
+end

data/lib/rack/brotli.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "brotli/deflater"
+
+module Rack
+  module Brotli
+    def self.new(*args)
+      Deflater.new(*args)
+    end
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: rack3-brotli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cody Cutrer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: brotli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.22
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.22
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.22'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-inst
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Rack::Brotli enables Google's Brotli compression on HTTP responses
+email:
+- cody@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack/brotli.rb
+- lib/rack/brotli/deflater.rb
+- lib/rack/brotli/version.rb
+homepage: https://github.com/instructure/rack3-brotli
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/instructure/rack3-brotli
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Brotli compression for Rack 3 responses
+test_files: []