agouti 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbc9f2fca59ad3b615499be8155878ccaa9267f9
+  data.tar.gz: 10a0ff265c3886f821d05901e8f8361dbf3cfbee
+SHA512:
+  metadata.gz: 34b66fbb60d367a245c65b7b210fb6fc3bb9de556961549f2104019dcb2727119d4e08a2ec578b8507a7efe11289c5badafbb2495cc251f79e7fa1df82a152ff
+  data.tar.gz: 6bbb152fd5e018607e4fdf0c92b2170a19d8b5b4cd017d8f5066be70115a33319093ecfa4fd0b70f5d254aaeed634ccff64f80a11bca1973fbc18b34d7583caf

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in agouti.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 dwayhs
+
+MIT License
+
+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,54 @@
+# Agouti
+
+Gem for testing above the fold render on the first tcp round trip.
+
+This gem is a Rack middleware that truncates the gzipped response to 14kb.
+
+Usefull for testing [critical rendering path optimization](https://developers.google.com/web/fundamentals/performance/critical-rendering-path/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'agouti'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install agouti
+
+## Usage
+
+To enable the middleware, it is necessary to add the following header to the request:
+```
+X-Agouti-Enable: 1
+```
+
+It is possible to customize the length of the content that the server will respond with the following header:
+```
+X-Agouti-Limit: 14000
+```
+
+### Example usage with Cucumber, Capybara and Poltergeist
+```
+Given /^(?:|I )navigate to '(.+)'$/ do |page_path|
+  visit page_path
+
+Given /^(?:|I )navigate to '(.+)' waiting only one tcp round trip$/ do |page_path|
+  page.driver.add_header("X-Agouti-Enable", "1", permanent: false)
+  visit page_path
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/CWISoftware/agouti/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/agouti.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'agouti/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "agouti"
+  spec.version       = Agouti::VERSION
+  spec.authors       = ["dwayhs"]
+  spec.email         = ["danielwayhs@gmail.com"]
+  spec.summary       = 'Gem for testing above the fold render on the first tcp round trip.'
+  spec.description   = ''
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rack", "~> 1.5"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/agouti.rb

@@ -0,0 +1,4 @@
+require "agouti/version"
+require "agouti/rack/package_limiter"
+
+require 'agouti/railtie' if defined?(Rails)

data/lib/agouti/rack/package_limiter.rb

@@ -0,0 +1,82 @@
+module Agouti
+
+  module Rack
+
+    class PackageLimiter
+
+      ENABLE_HEADER = 'X-Agouti-Enable'
+      LIMIT_HEADER = 'X-Agouti-Limit'
+      DEFAULT_LIMIT = 14000
+
+      ##
+      # Creates Agouti::Rack::PackageLimiter middleware.
+      #
+      # [app] rack app instance
+      # [options] hash of package limiter options, i.e.
+      #           'if' - a lambda enabling / disabling deflation based on returned boolean value
+      #                  e.g use Rack::Deflater, :if => lambda { |env, status, headers, body| body.length > 512 }
+      def initialize(app, options = {})
+        @app = app
+        @condition = options[:if]
+        @limit = options[:limit] || 14000
+      end
+
+      def get_http_header env, header
+        env["HTTP_#{header.upcase.gsub('-', '_')}"]
+      end
+
+      def call(env)
+        status, headers, body = @app.call(env)
+
+        set_limit(env)
+
+        if enabled?(env)
+          # Just execute for html
+          # TODO: find a better way of doing it
+          unless (headers.has_key? 'Content-Type' and headers['Content-Type'].include? 'text/html')
+            # Returns empty responses for requests that are not html
+            return [204, {}, []]
+          end
+
+          headers = ::Rack::Utils::HeaderHash.new(headers)
+
+          headers['Content-Encoding'] = "gzip"
+          headers.delete('Content-Length')
+          mtime = headers.key?("Last-Modified") ? Time.httpdate(headers["Last-Modified"]) : Time.now
+
+          [status, headers, GzipTruncatedStream.new(body, mtime, @limit)]
+        else
+          [status, headers, body]
+        end
+      end
+
+      private
+
+      def enabled? env
+        get_http_header(env, ENABLE_HEADER) and get_http_header(env, ENABLE_HEADER) == '1'
+      end
+
+      def set_limit env
+        @limit = (get_http_header(env, LIMIT_HEADER)) ?  get_http_header(env, LIMIT_HEADER).to_i : DEFAULT_LIMIT
+      end
+
+      class GzipTruncatedStream < ::Rack::Deflater::GzipStream
+        def initialize body, mtime, byte_limit
+          super body, mtime
+          @byte_limit = byte_limit
+          @total_sent_bytes = 0
+        end
+
+        def write(data)
+          # slices data if total sent bytes reaches byte limit
+          if @total_sent_bytes + data.bytesize > @byte_limit
+            data = data.byteslice(0, @byte_limit - @total_sent_bytes)
+          end
+
+          @total_sent_bytes += data.bytesize
+          @writer.call(data)
+        end
+      end
+    end
+  end
+end

data/lib/agouti/railtie.rb

@@ -0,0 +1,10 @@
+require 'agouti/rack/package_limiter'
+require 'rails/railtie'
+
+module Agouti
+  class Railtie < ::Rails::Railtie
+    initializer 'agouti.rails_initialization' do | app |
+      app.config.middleware.use Agouti::Rack::PackageLimiter
+    end
+  end
+end

data/lib/agouti/version.rb

@@ -0,0 +1,3 @@
+module Agouti
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: agouti
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- dwayhs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-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.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: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ''
+email:
+- danielwayhs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- agouti.gemspec
+- lib/agouti.rb
+- lib/agouti/rack/package_limiter.rb
+- lib/agouti/railtie.rb
+- lib/agouti/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for testing above the fold render on the first tcp round trip.
+test_files: []