rack-brotli 0.0.0.1.ENOTAG

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d9b8c8a82c1721978996d011aa30e6beff3c11b
+  data.tar.gz: ee682fe690ebd3b7b7585dca14f16b801da1da74
+SHA512:
+  metadata.gz: e57f60b8f3aa5cd79b7577ee1e870e0ddb8042358222a609e8c2141c8baae50711c387c7a6b4867d2f88c1d24ec4a96a5f254719482ba4f54b8d87b0a98fa71b
+  data.tar.gz: b141f4f16448b10c3d8a27284367574df4e129a3c373b3987872a62f94ce64737a62e5ca81b8da3f6223a18ae25545d522b79174294312ffd59ca662b76852c9

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,35 @@
+# 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
+
+Gems are available too:
+
+    gem install rack-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
+```
+
+### 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/deflater.rb

@@ -0,0 +1,110 @@
+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]
+      @deflater_options = options[:deflater]
+    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(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 "br"
+        headers['Content-Encoding'] = "br"
+        headers.delete(Rack::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, {Rack::CONTENT_TYPE => "text/plain", Rack::CONTENT_LENGTH => message.length.to_s}, bp]
+      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
+
+    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/rack-brotli.rb

@@ -0,0 +1,12 @@
+require 'rack'
+require 'git-version-bump'
+
+module Rack
+  module Brotli
+    def self.release
+      GVB.version
+    end
+  end
+
+  autoload :Brotli, "rack/brotli/deflater"
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: rack-brotli
+version: !ruby/object:Gem::Version
+  version: 0.0.0.1.ENOTAG
+platform: ruby
+authors:
+- Marco Costa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-28 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: git-version-bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: github-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !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::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/deflater.rb
+- lib/rack/rack-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 2
+summary: Brotli compression for Rack responses
+test_files: []