rack-conditional_get 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e43394b566495b4bcd183a9541d63b6f8e0d4520
+  data.tar.gz: 501c66fc4e6180b3ce7b58fc319db07b056e000a
+SHA512:
+  metadata.gz: 57ab4e5495636a9f77b16becde50e28d2e159d10a62cf2147b2c182c92ddea08a8199be6a76d793e16997d82404d735c03fad949b60ac9de83f4098ee8e7151f
+  data.tar.gz: 55f972698c82008e91e2efaf0f6fcd1ff220d1c8bb44cfe55107292330c64cc43bcea2e606f516887be2b5a6357265cd15ad88a1329b6fb1b38cb3d9e6db81d9

data/lib/rack/conditional_get/version.rb

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

data/lib/rack/conditional_get.rb

@@ -0,0 +1,90 @@
+module Rack
+  # Middleware that enables conditional GET using If-None-Match and
+  # If-Modified-Since. The application should set either or both of the
+  # Last-Modified or Etag response headers according to RFC 2616. When
+  # either of the conditions is met, the response body is set to be zero
+  # length and the response status is set to 304 Not Modified.
+  #
+  # Applications that defer response body generation until the body's each
+  # message is received will avoid response body generation completely when
+  # a conditional GET matches.
+  #
+  # Adapted from Michael Klishin's Merb implementation:
+  # https://github.com/wycats/merb/blob/master/merb-core/lib/merb-core/rack/middleware/conditional_get.rb
+  module ConditionalGet
+    require_relative "conditional_get/version"
+    VERB_KEY = "REQUEST_METHOD"
+    MODIFIED_SINCE_KEY = "HTTP_IF_MODIFIED_SINCE"
+    NONE_MATCH_KEY = "HTTP_IF_NONE_MATCH"
+    ETAG_KEY = "ETag"
+    LAST_MODIFIED_KEY = "Last-Modified"
+
+    def initialize(stack)
+      @stack = stack
+    end
+
+    def call(env)
+      @env = env
+      @status, @headers, @body = @app.call(environment)
+      if (get? || head?) && (@status == 200 && fresh?)
+        @status = 304
+        headers.delete("Content-Type")
+        headers.delete("Content-Length")
+        body = Rack::BodyProxy.new([]) do
+          @body.close if @body.respond_to?(:close)
+        end
+        [@status, @headers, body]
+      else
+        @app.call(env)
+      end
+    end
+
+    private def fresh?
+      modified_since || etag_matches?
+    end
+
+    private def env
+      @env
+    end
+
+    private def headers
+      @headers
+    end
+
+    private def none_match
+      @env[NONE_MATCH_KEY]
+    end
+
+    private def etag
+      headers[ETAG_KEY]
+    end
+
+    private def etag_matches?
+      etag && none_match && etag == none_match
+    end
+
+    private def modified_since
+      @env[MODIFIED_SINCE_KEY]
+    end
+
+    private def last_modified
+      headers[LAST_MODIFIED_KEY]
+    end
+
+    private def modified_since?
+      last_modified && modified_since && modified_since >= last_modified
+    end
+
+    private def get?
+      verb == "GET"
+    end
+
+    private def get?
+      verb == "HEAD"
+    end
+
+    private def verb
+      env[VERB_KEY]
+    end
+  end
+end

data/lib/rack-conditional_get.rb

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

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

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

data/spec/lib/rack/conditional_get_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Rack::ConditionalGet 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
+    context "with If-Modified-Since set" do
+      let(:modified_sense) { Time.now }
+      it "returns 304"
+      it "removes Content-Type"
+      it "removes Content-Length"
+    end
+
+    context "with If-None-Match set" do
+      let(:none_match) { Time.now }
+      it "returns 304"
+      it "removes Content-Type"
+      it "removes Content-Length"
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: rack-conditional_get
+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: Middleware that catches Last-Modified and Etag requests
+email:
+- me@kurtisrainboltgreene.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack-conditional_get.rb
+- lib/rack/conditional_get.rb
+- lib/rack/conditional_get/version.rb
+- spec/lib/rack/conditional_get/version_spec.rb
+- spec/lib/rack/conditional_get_spec.rb
+- spec/spec_helper.rb
+homepage: http://krainboltgreene.github.io/rack/conditional_get
+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: Middleware that catches Last-Modified and Etag requests
+test_files:
+- spec/lib/rack/conditional_get/version_spec.rb
+- spec/lib/rack/conditional_get_spec.rb
+- spec/spec_helper.rb
+has_rdoc: