rack-conditional-forms 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+# Specify your gem's dependencies in rack-conditional-forms.gemspec
+gemspec
+
+group :development do
+  gem 'rack'
+  gem 'rack-test'
+  gem 'minitest'
+  gem 'json'  
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jamie Hodge
+
+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,35 @@
+# Rack::Conditional::Forms
+
+Rack::ConditionalForms allows forms to override `If-Match` and `If-Unmodified-Since` headers in forms, using `_if_match` and `_if_unmodified_since` keys, respectively,
+allowing conditional `POST`, `PUT` and `DELETE` requests from the browser.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-conditional-forms'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-conditional-forms
+
+## Usage
+
+    require 'rack/conditional-forms'
+    use Rack::ConditionalForms
+    
+To use Rack::SslEnforcer in your Rails application, add the following line to your application config file (config/application.rb for Rails 3, config/environment.rb for Rails 2):
+
+    config.middleware.use Rack::ConditionalForms
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/rack/conditional-forms/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class ConditionalForms
+    VERSION = "0.0.1"
+  end
+end

data/lib/rack/conditional-forms.rb

@@ -0,0 +1,46 @@
+require_relative 'conditional-forms/version'
+
+module Rack
+
+  class ConditionalForms
+    
+    IF_MATCH_PARAM_KEY = '_if_match'.freeze
+    IF_UNMODIFIED_SINCE_KEY = '_if_unmodified_since'.freeze
+    
+    def initialize(app)
+      @app = app
+    end
+    
+    def call(env)
+      if (match = if_match(env)) && !match.empty?
+        env['rack.conditionalforms.original_match'] = env['HTTP_IF_MATCH']
+        env['HTTP_IF_MATCH'] = if_match(env)
+      end
+      
+      if (unmodified_since = if_unmodified_since(env)) && !unmodified_since.empty?
+        env['rack.conditionalforms.original_unmodified_since'] = env['HTTP_IF_UNMODIFIED_SINCE']
+        env['HTTP_IF_UNMODIFIED_SINCE'] = if_unmodified_since(env)
+      end
+      
+      @app.call(env)
+    end
+    
+    def if_match(env)
+      request_value(env, IF_MATCH_PARAM_KEY)
+    end
+    
+    def if_unmodified_since(env)
+      request_value(env, IF_UNMODIFIED_SINCE_KEY)
+    end
+    
+    def request_value(env, key)
+      req = Request.new(env)
+      value = req.POST[key]
+      value.to_s.upcase
+    rescue EOFError
+      ""
+    end
+    
+  end
+  
+end

data/lib/rack-conditional-forms.rb

@@ -0,0 +1 @@
+require 'rack/ssl-conditional-forms'

data/rack-conditional-forms.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rack/conditional-forms/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jamie Hodge"]
+  gem.email         = ["jamiehodge@me.com"]
+  gem.description   = %q{A Rack middleware to support conditional requests from the browser}
+  gem.summary       = %q{Rack::ConditionalForms is a Rack middleware to support conditional requests from the browser}
+  gem.homepage      = "http://github.com/jamiehodge/rack-conditional-forms"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "rack-conditional-forms"
+  gem.require_paths = ["lib"]
+  gem.version       = Rack::ConditionalForms::VERSION
+end

data/spec/conditional-forms-spec.rb

@@ -0,0 +1,75 @@
+require_relative 'helper'
+
+describe Rack::ConditionalForms do
+  
+  def app
+    mock_app
+  end
+  
+  describe 'If-Match' do
+    
+    it 'must override If-Match on POST' do
+      post '/', _if_match: '123'
+      JSON.parse(last_response.body)['HTTP_IF_MATCH'].must_equal '123'
+    end
+    
+    it 'wont override If-Match on POST if not present' do
+      post '/'
+      JSON.parse(last_response.body)['HTTP_IF_MATCH'].must_be_nil
+    end
+  
+    it 'must override If-Match on PUT' do
+      put '/', _if_match: '123'
+      JSON.parse(last_response.body)['HTTP_IF_MATCH'].must_equal '123'
+    end
+    
+    it 'wont override If-Match on PUT if not present' do
+      put '/'
+      JSON.parse(last_response.body)['HTTP_IF_MATCH'].must_be_nil
+    end
+  
+    it 'must override If-Match on DELETE' do
+      delete '/', _if_match: '123'
+      JSON.parse(last_response.body)['HTTP_IF_MATCH'].must_equal '123'
+    end
+    
+    it 'wont override If-Match on DELETE if not present' do
+      delete '/'
+      JSON.parse(last_response.body)['HTTP_IF_MATCH'].must_be_nil
+    end
+  end
+  
+  describe 'If-Unmodified-Since' do
+    
+    it 'must override If-Unmodified-Since on POST' do
+      post '/', _if_unmodified_since: '123'
+      JSON.parse(last_response.body)['HTTP_IF_UNMODIFIED_SINCE'].must_equal '123'
+    end
+    
+    it 'wont override If-Unmodified-Since on POST if not present' do
+      post '/'
+      JSON.parse(last_response.body)['HTTP_IF_UNMODIFIED_SINCE'].must_be_nil
+    end
+  
+    it 'must override If-Unmodified-Since on PUT' do
+      put '/', _if_unmodified_since: '123'
+      JSON.parse(last_response.body)['HTTP_IF_UNMODIFIED_SINCE'].must_equal '123'
+    end
+    
+    it 'wont override If-Unmodified-Since on PUT if not present' do
+      put '/'
+      JSON.parse(last_response.body)['HTTP_IF_UNMODIFIED_SINCE'].must_be_nil
+    end
+  
+    it 'must override If-Unmodified-Since on DELETE' do
+      delete '/', _if_unmodified_since: '123'
+      JSON.parse(last_response.body)['HTTP_IF_UNMODIFIED_SINCE'].must_equal '123'
+    end
+    
+    it 'wont override If-Unmodified-Since on DELETE if not present' do
+      delete '/'
+      JSON.parse(last_response.body)['HTTP_IF_UNMODIFIED_SINCE'].must_be_nil
+    end
+  end
+end
+

data/spec/helper.rb

@@ -0,0 +1,28 @@
+require 'rack/test'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'json'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack/conditional-forms'
+
+class MiniTest::Spec
+  include Rack::Test::Methods
+  
+  def app
+    Rack::Lint.new(@app)
+  end
+  
+  def mock_app
+    main_app = lambda { |env|
+      request = Rack::Request.new(env)
+      headers = { 'Content-Type' => 'text/html' }
+      [200, headers, { 'HTTP_IF_MATCH' => request.env['HTTP_IF_MATCH'], 'HTTP_IF_UNMODIFIED_SINCE' => request.env['HTTP_IF_UNMODIFIED_SINCE'] }.to_json ]
+    }
+    
+    builder = Rack::Builder.new
+    builder.use Rack::ConditionalForms
+    builder.run main_app
+    @app = builder.to_app
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: rack-conditional-forms
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jamie Hodge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-08 00:00:00.000000000 Z
+dependencies: []
+description: A Rack middleware to support conditional requests from the browser
+email:
+- jamiehodge@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-conditional-forms.rb
+- lib/rack/conditional-forms.rb
+- lib/rack/conditional-forms/version.rb
+- rack-conditional-forms.gemspec
+- spec/conditional-forms-spec.rb
+- spec/helper.rb
+homepage: http://github.com/jamiehodge/rack-conditional-forms
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Rack::ConditionalForms is a Rack middleware to support conditional requests
+  from the browser
+test_files:
+- spec/conditional-forms-spec.rb
+- spec/helper.rb