rack-etag 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aa54891c355e2dea74d0459816d642d0995d4e7
+  data.tar.gz: e912c52ccbf508a8117b10a7412e9e80499b3317
+SHA512:
+  metadata.gz: 8779b919edb649f0a09fd9b2d47bb2bba5595ef3bbbee77365da3e9e7a7bfd5b574d394f9f1447a840a00b6af9ffbfb0bab3c332ed33c339f5b776fe8467e1e7
+  data.tar.gz: 567b4e0b94afea0900bb6857d04cfaa35a67765c06bbeb9ffdc7507cf78ed4d844cc787b22d7ea2f511e76e738849f6d216987e1a50e000c16f0f5728fa058aa

data/lib/rack-etag.rb

@@ -0,0 +1,3 @@
+module Rack
+  require_relative "rack/etag"
+end

data/lib/rack/etag.rb

@@ -0,0 +1,70 @@
+module Rack
+  # 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"
+  module ETag
+    require_relative "etag/version"
+    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_status?(status) && etag_body?(body) && !skip_caching?(headers)
+        original_body = body
+        digest, new_body = digest_body(body)
+        body = Rack::BodyProxy.new(new_body) do
+          original_body.close if original_body.respond_to?(:close)
+        end
+        headers["ETag"] = %|W/"#{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_status?(status)
+      status == 200 || status == 201
+    end
+
+    private def etag_body?(body)
+      !body.respond_to?(:to_path)
+    end
+
+    private def skip_caching?(headers)
+      (headers["Cache-Control"] && headers["Cache-Control"].include?("no-cache")) || headers.key?("ETag") || headers.key?("Last-Modified")
+    end
+
+    private def digest_body(body)
+      parts = []
+      digest = nil
+
+      body.each do |part|
+        parts << part
+        unless part.empty?
+          (digest ||= Digest::MD5.new) << part
+        end
+      end
+
+      [digest && digest.hexdigest, parts]
+    end
+  end
+end

data/lib/rack/etag/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module ETag
+    VERSION = "1.0.0"
+  end
+end

data/spec/lib/rack/etag.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Rack::ETag do
+  let(:application) { instance_double("Application") }
+  let(:middleware) { described_class.new(application) }
+  let(:verb) { "GET" }
+  let(:status) { 200 }
+  let(:headers) do
+    {
+      "REQUEST_METHOD" => verb,
+      "Content-Type" => "text/plain",
+      "Content-Length" => "0"
+    }
+  end
+  let(:body) { "" }
+
+  before(:each) do
+    allow(application).to receive(:call).and_return([status, headers, body])
+  end
+
+  describe "#call" do
+
+  end
+end

data/spec/lib/rack/etag/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Rack::ETag::VERSION do
+  it "should be a string" do
+    expect(Rack::ETag::VERSION).to be_kind_of(String)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "pry"
+require "rspec"
+require "rack/etag"

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rack-etag
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kurtis Rainbolt-Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Writes ETag to responses
+email:
+- me@kurtisrainboltgreene.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack-etag.rb
+- lib/rack/etag.rb
+- lib/rack/etag/version.rb
+- spec/lib/rack/etag.rb
+- spec/lib/rack/etag/version_spec.rb
+- spec/spec_helper.rb
+homepage: http://krainboltgreene.github.io/rack-etag
+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: Writes ETag to responses
+test_files:
+- spec/lib/rack/etag/version_spec.rb
+- spec/lib/rack/etag.rb
+- spec/spec_helper.rb
+has_rdoc: