route_downcaser 0.2.1 → 0.2.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmNmOWFjODRlN2U1ZDZjNzkwMzBmMGZiMDc5NTZhMWVmZjM2YTE4Zg==
+  data.tar.gz: !binary |-
+    MmU0OTljZTQwZDE4ZjgxZjNkYmE5ZjI5ZWU3ZWM1YmYyZjc2NzY2MA==
+SHA512:
+  metadata.gz: !binary |-
+    NjlhYWRiMWM5MzI2ZWJmYjdlZmYyZDZkMTgxMTc1NGNhMmRjNDI4ODA1MTJm
+    YWU0MDJmZWRiNDY5MjZkN2MzM2Q1NDI3ODA2NWYyZDljYjJmM2E1MmRiMWZk
+    M2ZkMDhkMGNmNTkyMzMxY2VhYmQ2ZWNlZjIwMDk0NzA0MTI5YWQ=
+  data.tar.gz: !binary |-
+    MDk0YTJmNTUwZGU4N2ZlZjc5NjVkMzZmMzNkODdlMGQyZmY1NjBhYzJiYTU2
+    ZDRhMDIyMzkxYzNmOWFmNDE4MGI1OTI3ZWY0NWI4MDE1YmJhNWIwMzQzOTk2
+    ODhmZTU3MDU3YjRiYjQxYzRjZWY4Nzk3YzA1OGZhNTU0OTQ1YWU=

data/README.rdoc

@@ -16,7 +16,7 @@ If you want this functionality in a Rails 2.x application, please refer to {this
 
 === Rails
 
-Just add the gem to your gemfile and run bundle 
+Just add the gem to your gemfile and run bundle
 
       gem 'route_downcaser'
 
@@ -74,8 +74,26 @@ At first I just made this code as a snippet and published it {on my blog}[http:/
 
 All it really does is to take the path and downcase it before dispatching. Querystring parameters are NOT touched, they keep their casing, since it may have some contextual meaning.
 
+== Configuration Options
+
+Configuration options can be set using an initializer in your application like so:
+
+      # config/initializers/route_downcaser.rb
+
+      RouteDowncaser.configuration do |config|
+        config.redirect = true
+      end
+
+=== Redirect
+
+With this configuration option set to `true`, the middleware will 301 redirect all routes to their downcased version. Example: `http://localhost:3000/Foo` will redirect to `http://localhost:3000/foo`.
+
 == Changelog
 
+=== 0.2.2
+
+Redirection is now possible as a configurable option. Thanks goes to {Mike Ackerman}[https://github.com/mackermedia]
+
 === 0.2.1
 
 The gem has now been tested to work with Rails 4.0 (it mostly involved changes in the test dummy-app because of deprecations between Rails 3.2 and 4.0)

data/lib/configuration.rb

@@ -0,0 +1,26 @@
+module Configuration
+
+  def configuration
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+  private
+
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+end

data/lib/route_downcaser/downcase_route_middleware.rb

@@ -5,10 +5,16 @@ module RouteDowncaser
     end
 
     def call(env)
+      @env = env
+
       if env['REQUEST_URI']
-        uri_items = env['REQUEST_URI'].split('?')
-        uri_items[0].downcase!
-        env['REQUEST_URI'] = uri_items.join('?')
+        if RouteDowncaser.redirect == true
+          if path != path.downcase
+            return [301, {'Location' => downcased_uri, 'Content-Type' => 'text/html'}, []]
+          end
+        else
+          env['REQUEST_URI'] = downcased_uri
+        end
       end
 
       if env['PATH_INFO'] =~ /assets\//i
@@ -20,5 +26,27 @@ module RouteDowncaser
 
       @app.call(env)
     end
+
+    private
+
+    def uri_items
+      @env['REQUEST_URI'].split('?')
+    end
+
+    def path
+      uri_items[0]
+    end
+
+    def query?
+      uri_items.length > 1
+    end
+
+    def downcased_uri
+      if query?
+        "#{path.downcase!}?#{uri_items[1]}"
+      else
+        path.downcase!
+      end
+    end
   end
 end

data/lib/route_downcaser/version.rb

@@ -1,3 +1,3 @@
 module RouteDowncaser
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/route_downcaser.rb

@@ -1,5 +1,9 @@
 require 'route_downcaser/downcase_route_middleware'
 require 'route_downcaser/railtie' if defined? Rails
+require 'configuration'
 
 module RouteDowncaser
+  extend Configuration
+
+  define_setting :redirect, false
 end

data/test/dummy/log/test.log

@@ -237,3 +237,11 @@ Started GET "/HELLO/WORLD" for 127.0.0.1 at 2013-09-02 10:00:29 +0200
   Processing by HelloController#world as HTML
 Rendered text template (0.0ms)
 Completed 200 OK in 47ms (Views: 45.9ms)
+Started GET "/HELLO/WORLD" for 127.0.0.1 at 2014-12-19 18:53:00 +0100
+Processing by HelloController#world as HTML
+  Rendered text template (0.0ms)
+Completed 200 OK in 22.0ms (Views: 21.8ms)
+Started GET "/HELLO/WORLD" for 127.0.0.1 at 2014-12-19 18:56:30 +0100
+Processing by HelloController#world as HTML
+  Rendered text template (0.0ms)
+Completed 200 OK in 6.2ms (Views: 5.9ms)

data/test/integration/route_middleware_test.rb

@@ -1,7 +1,11 @@
 require 'test_helper'
- 
+
 class RouteMiddlewareTest < ActionDispatch::IntegrationTest
   test "Middleware is installed and working" do
+    RouteDowncaser.configuration do |config|
+      config.redirect = false
+    end
+
     get "HELLO/WORLD"
     assert_response :success
     assert_equal("anybody out there?", @response.body)

data/test/route_downcaser_test.rb

@@ -40,4 +40,17 @@ class RouteDowncaserTest < ActiveSupport::TestCase
 
     assert_equal("assets/images/SpaceCat.jpeg", app.env['PATH_INFO'])
   end
+
+  test "when redirect is set to true it redirects" do
+    app = MockApp.new
+    env = { 'REQUEST_URI' => "HELLO/WORLD" }
+    RouteDowncaser.configuration do |config|
+      config.redirect = true
+    end
+
+    assert_equal(
+      RouteDowncaser::DowncaseRouteMiddleware.new(app).call(env),
+      [301, {'Location' => "hello/world", 'Content-Type' => 'text/html'}, []]
+    )
+  end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: route_downcaser
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.2.2
 platform: ruby
 authors:
 - Carsten Gehling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-02 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies: []
 description: This gem hooks into the Rack middleware of Rails. This way all paths
   are downcased before dispatching to Rails' routing mechanism. Querystring parameters
@@ -20,76 +19,70 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/configuration.rb
+- lib/route_downcaser.rb
 - lib/route_downcaser/downcase_route_middleware.rb
-- lib/route_downcaser/version.rb
 - lib/route_downcaser/railtie.rb
-- lib/route_downcaser.rb
+- lib/route_downcaser/version.rb
 - lib/tasks/route_downcaser_tasks.rake
-- MIT-LICENSE
-- Rakefile
-- README.rdoc
-- test/dummy/log/test.log
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/422.html
-- test/dummy/public/404.html
-- test/dummy/config/locales/en.yml
+- test/dummy/Rakefile
+- test/dummy/app/assets/images/SpaceCat.jpeg
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/hello_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
 - test/dummy/config/database.yml
 - test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/routes.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/application.rb
-- test/dummy/Rakefile
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/controllers/hello_controller.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/assets/images/SpaceCat.jpeg
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/config.ru
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/log/test.log
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
 - test/dummy/script/rails
 - test/integration/route_middleware_test.rb
 - test/route_downcaser_test.rb
 - test/test_helper.rb
 homepage: https://github.com/carstengehling/route_downcaser
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4407952237472228384
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4407952237472228384
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Makes routing in Rails case-insensitive
 test_files:
 - test/dummy/log/test.log