rack-hackery 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab296157b15534cdd3251e991126f9debbd5bcdd
+  data.tar.gz: de3c37a2eec9f218a83e8d8c43e62c9a6d515d80
+SHA512:
+  metadata.gz: 88d50ea51c9110e40b51bc3a5ae1cfd93898d7305af11fbde0bbc500a45e027818d2c2d3d6813b3d07c8bdd13bf03848d4394084659db94e6499aeb981a59591
+  data.tar.gz: 14d583ec230f011d28ec4e8dabfa62415d9d50b548b57499aa06de08114fa07039e02c35ccc319c460d982e8f55b964f7807d12aaf7c3c918b9d8622c2d21f5e

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Latchezar Tzvetkoff
+
+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,40 @@
+# Rack::Hackery
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'rack-hackery'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-hackery
+
+## What's included
+
+Currently, the only thing here is a modified version of `Rack::ETag` that's supposed to fix the ugly Safari 7/8 ETag
+caching problem.
+
+## Usage
+
+In in either `config/application.rb` or `config/environments/{development,production}.rb`:
+
+``` ruby
+config.middleware.swap Rack::ETag, Rack::Hackery::ETag
+```
+
+## Contributing
+
+1. [Fork it](https://github.com/tzvetkoff/rack-hackery/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/lib/rack/hackery/etag.rb

@@ -0,0 +1,72 @@
+require 'digest/md5'
+
+module Rack
+  module Hackery
+    # Automatically sets the ETag header on all String bodies.
+    #
+    # The ETag header is skipped if ETag or Last-Modified headers are sent or if
+    # a sendfile body (body.responds_to :to_path) is given (since such cases
+    # should be handled by apache/nginx).
+    #
+    # On initialization, you can pass two parameters: a Cache-Control directive
+    # used when Etag is absent and a directive when it is present. The first
+    # defaults to nil, while the second defaults to "max-age=0, private, must-revalidate"
+    class ETag
+      DEFAULT_CACHE_CONTROL = 'max-age=0, private, must-revalidate'.freeze
+
+      def initialize(app, no_cache_control = nil, cache_control = DEFAULT_CACHE_CONTROL)
+        @app = app
+        @cache_control = cache_control
+        @no_cache_control = no_cache_control
+      end
+
+      def call(env)
+        status, headers, body = @app.call(env)
+
+        if !etag_buggy?(env) && etag_status?(status) && etag_body?(body) && !skip_caching?(headers)
+          digest, body = digest_body(body)
+          headers['ETag'] = %("#{digest}") if digest
+        end
+
+        unless headers['Cache-Control']
+          if digest
+            headers['Cache-Control'] = @cache_control if @cache_control
+          else
+            headers['Cache-Control'] = @no_cache_control if @no_cache_control
+          end
+        end
+
+        [status, headers, body]
+      end
+
+      private
+
+      def etag_buggy?(env)
+        http_user_agent = env['HTTP_USER_AGENT']
+        http_user_agent && http_user_agent.include?('Safari/') &&
+            (http_user_agent.include?('Version/7') || http_user_agent.include?('Version/8'))
+      end
+
+      def etag_status?(status)
+        status == 200 || status == 201
+      end
+
+      def etag_body?(body)
+        !body.respond_to?(:to_path)
+      end
+
+      def skip_caching?(headers)
+        (headers['Cache-Control'] && headers['Cache-Control'].include?('no-cache')) ||
+            headers.key?('ETag') || headers.key?('Last-Modified')
+      end
+
+      def digest_body(body)
+        parts = []
+        body.each { |part| parts << part }
+        string_body = parts.join
+        digest = Digest::MD5.hexdigest(string_body) unless string_body.empty?
+        [digest, parts]
+      end
+    end
+  end
+end

data/lib/rack/hackery/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Hackery
+    VERSION = '0.0.2'
+  end
+end

data/lib/rack/hackery.rb

@@ -0,0 +1,2 @@
+require 'rack/hackery/version'
+require 'rack/hackery/etag'

data/rack-hackery.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/hackery/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-hackery'
+  spec.version       = Rack::Hackery::VERSION
+  spec.authors       = ['Latchezar Tzvetkoff']
+  spec.email         = ['latchezar@tzvetkoff.net']
+  spec.summary       = %q{A small collection of Rack hacks.}
+  spec.description   = %q{A small collection of Rack hacks.}
+  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_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: rack-hackery
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Latchezar Tzvetkoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-14 00:00:00.000000000 Z
+dependencies:
+- !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: A small collection of Rack hacks.
+email:
+- latchezar@tzvetkoff.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/hackery.rb
+- lib/rack/hackery/etag.rb
+- lib/rack/hackery/version.rb
+- rack-hackery.gemspec
+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: A small collection of Rack hacks.
+test_files: []