rack-seo_redirect 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f424acca9d2b87c96a82186e8c75b4180cf65b2b
+  data.tar.gz: 302527f61c5db299a32a87b01f99b87e15b954f7
+SHA512:
+  metadata.gz: c3924330a12af0f119cf508c67eccdcee7b6282154461614cf9edf2cfd9b4b10d7232156425a1610cfbab9b0d3cfa9b041af059d6cbb0eb478c7e3233e3f96ff
+  data.tar.gz: 784b21db6692fc02530c201fb7243a35543ffd84428d29fd2e4b7812a021c3cb3bf7ccd775679f753da1b295b0cff592270761b3e7da4e3ad9ec48e7c1d9561b

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Michael Khabarov
+
+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,73 @@
+# Rack::SeoRedirect
+
+Rack middleware for making non-www to www (and conversely) redirects and removing trailing slash in urls. Use it if you can not edit Nginx or Apache rewrite rules.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-seo_redirect'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-seo_redirect
+
+## Usage
+
+### With any Rack application
+
+    # config.ru
+    require 'rack/seo_redirect'
+    use Rack::SeoRedirect::Www
+    use Rack::SeoRedirect::TrailingSlash
+    run MyApp
+
+### With Rails
+
+Insert to the top of the Rails middleware stack:
+
+    # application.rb
+    config.middleware.insert 0, Rack::SeoRedirect::Www
+    config.middleware.insert 0, Rack::SeoRedirect::TrailingSlash
+
+## Customization
+
+### Rack::SeoRedirect::Www
+
+Your can pass *true* or *false* as a parameter to *Www* middleware. This indicates either you need *www* in your url or not.
+
+For non-www to www redirect use:
+
+    use Rack::SeoRedirect::Www, true
+
+For www to non-www redirect use:
+
+    use Rack::SeoRedirect::Www, false
+
+Default is *false* (www to non-www).
+
+### Rack::SeoRedirect::TrailingSlash
+
+Your can pass *true* or *false* as a parameter to *TrailingSlash* middleware. This indicates either you need */* in the end of your url or not.
+
+For adding */* to the end of urls use:
+
+    use Rack::SeoRedirect::TrailingSlash, true
+
+For removing */* from the end of urls use:
+
+    use Rack::SeoRedirect::TrailingSlash, false
+
+Default is *false* (removing trailing slash).
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/rack/seo_redirect.rb

@@ -0,0 +1,9 @@
+require "rack/seo_redirect/version"
+require "rack/seo_redirect/base"
+require "rack/seo_redirect/www"
+require "rack/seo_redirect/trailing_slash"
+
+module Rack
+  module SeoRedirect
+  end
+end

data/lib/rack/seo_redirect/base.rb

@@ -0,0 +1,45 @@
+require 'rack/mime'
+
+module Rack
+  module SeoRedirect
+    class Base
+      def initialize app
+        @app = app
+      end
+
+      private
+
+      def request
+        Rack::Request.new(@env)
+      end
+
+      def headers url
+        {
+          'Location' => url,
+          'Content-Type' => ::Rack::Mime.mime_type(::File.extname(request.path), 'text/html')
+        }
+      end
+
+      def redirect_message url
+        "Redirecting to <a href='#{url}'>#{url}</a>"
+      end
+
+      def build_url options = {}
+        options[:host] ||= request.host
+        options[:path] ||= request.path
+
+        url = "#{request.scheme}://#{options[:host]}"
+
+        if request.scheme == "https" && request.port != 443 ||
+          request.scheme == "http" && request.port != 80
+          url << ":#{request.port}"
+        end
+
+        url << "#{options[:path]}"
+        url << "?#{request.query_string}" unless request.query_string.empty?
+
+        url
+      end
+    end
+  end
+end

data/lib/rack/seo_redirect/trailing_slash.rb

@@ -0,0 +1,25 @@
+module Rack
+  module SeoRedirect
+    class TrailingSlash < Base
+      def initialize app, slash = false
+        super(app)
+        @should_ends_with_slash = slash
+      end
+
+      def call env
+        @env = env
+        req = Rack::Request.new(env)
+        ends_with_slash = !!(req.path =~ /\A(.*)\/\z/)
+
+        if req.get? && req.path != '/' && @should_ends_with_slash != ends_with_slash
+          path = @should_ends_with_slash ? "#{req.path}/" : "#{$1}"
+          url = build_url(:path => path)
+
+          [ 301, headers(url), [ redirect_message(url) ] ]
+        else
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/rack/seo_redirect/version.rb

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

data/lib/rack/seo_redirect/www.rb

@@ -0,0 +1,25 @@
+module Rack
+  module SeoRedirect
+    class Www < Base
+      def initialize app, www = false
+        super(app)
+        @should_starts_from_www = www
+      end
+
+      def call env
+        @env = env
+
+        starts_from_www = !!(request.host =~ /\Awww.(.*)\z/)
+
+        if request.get? && @should_starts_from_www != starts_from_www
+          host = @should_starts_from_www ? "www.#{request.host}" : $1
+          url = build_url(:host => host)
+
+          [ 301, headers(url), [ redirect_message(url) ] ]
+        else
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/rack-seo_redirect.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/seo_redirect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-seo_redirect"
+  spec.version       = Rack::SeoRedirect::VERSION
+  spec.authors       = ["Michael Khabarov"]
+  spec.email         = ["michaelkhabarov@alphastate.ru"]
+  spec.description   = %q{Remove or add www and trailing slash from urls for Rack applications. Use it if you can not edit Nginx or Apache configs.}
+  spec.summary       = %q{Make www and trailing slash redirects from Rack}
+  spec.homepage      = "https://github.com/michaelkhabarov/rack-seo_redirect"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", "~> 2.0"
+
+  spec.add_dependency "rack"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rack/seo_redirect'
+require 'rack/test'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+  config.include Rack::Test::Methods
+end

data/spec/trailing_slash_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Rack::SeoRedirect::TrailingSlash do
+
+  let(:base) { Proc.new { |env| [ 200, env, 'App' ] } }
+
+  context "default behaviour" do
+    let(:app) { Rack::SeoRedirect::TrailingSlash.new(base) }
+
+    it 'set @should_ends_with_slash to false' do
+      app.instance_variable_get('@should_ends_with_slash').should be_false
+    end
+
+    it 'removes trailing slash' do
+      get 'http://www.example.com/users/'
+      last_response.status.should == 301
+      last_response.location.should == 'http://www.example.com/users'
+    end
+  end
+
+  context "with trailing slash" do
+    let(:app) { Rack::SeoRedirect::TrailingSlash.new(base, true) }
+
+    it 'adds slash' do
+      get 'http://example.com/users'
+      last_response.status.should == 301
+      last_response.location.should == 'http://example.com/users/'
+    end
+
+    it 'adds slash preserving port and path' do
+      get 'http://example.com:3000/users?foo=bar'
+      last_response.status.should == 301
+      last_response.location.should == 'http://example.com:3000/users/?foo=bar'
+    end
+
+    it 'does not do anything if slash is already in url' do
+      get 'http://example.com/users/?foo=bar'
+      last_response.status.should == 200
+    end
+
+    it 'does not do anything for root url' do
+      get 'http://example.com'
+      last_response.status.should == 200
+
+      get 'http://example.com/'
+      last_response.status.should == 200
+    end
+  end
+
+  context "without trailing slash" do
+    let(:app) { Rack::SeoRedirect::TrailingSlash.new(base, false) }
+
+    it 'removes slash' do
+      get 'http://example.com/users/'
+      last_response.status.should == 301
+      last_response.location.should == 'http://example.com/users'
+    end
+
+    it 'adds slash preserving port and path' do
+      get 'http://example.com:3000/users/?foo=bar'
+      last_response.status.should == 301
+      last_response.location.should == 'http://example.com:3000/users?foo=bar'
+    end
+
+    it 'does not do anything if no slash in url' do
+      get 'http://example.com/users?foo=bar'
+      last_response.status.should == 200
+    end
+
+    it 'does not do anything for root url' do
+      get 'http://example.com'
+      last_response.status.should == 200
+
+      get 'http://example.com/'
+      last_response.status.should == 200
+    end
+  end
+end

data/spec/www_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Rack::SeoRedirect::Www do
+
+  let(:base) { Proc.new { |env| [ 200, env, 'App' ] } }
+
+  context "default behaviour" do
+    let(:app) { Rack::SeoRedirect::Www.new(base) }
+
+    it 'set @should_starts_from_www to false' do
+      app.instance_variable_get('@should_starts_from_www').should be_false
+    end
+
+    it 'removes www' do
+      get 'http://www.example.com/'
+      last_response.status.should == 301
+      last_response.location.should == 'http://example.com/'
+    end
+  end
+
+  context "non-www to www" do
+    let(:app) { Rack::SeoRedirect::Www.new(base, true) }
+
+    it 'adds www' do
+      get 'http://example.com/'
+      last_response.status.should == 301
+      last_response.location.should == 'http://www.example.com/'
+    end
+
+    it 'adds www preserving port and path' do
+      get 'http://example.com:3000/users?foo=bar'
+      last_response.status.should == 301
+      last_response.location.should == 'http://www.example.com:3000/users?foo=bar'
+    end
+
+    it 'does not do anything if www presence in url' do
+      get 'http://www.example.com/users?foo=bar'
+      last_response.status.should == 200
+    end
+  end
+
+  context "www to non-www" do
+    let(:app) { Rack::SeoRedirect::Www.new(base, false) }
+
+    it 'removes www' do
+      get 'http://www.example.com/'
+      last_response.status.should == 301
+      last_response.location.should == 'http://example.com/'
+    end
+
+    it 'removes www preserving port and path' do
+      get 'http://www.example.com:3000/users?foo=bar'
+      last_response.status.should == 301
+      last_response.location.should == 'http://example.com:3000/users?foo=bar'
+    end
+
+    it 'does not redirect if www not presence in url' do
+      get 'http://example.com/users?foo=bar'
+      last_response.status.should == 200
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rack-seo_redirect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Khabarov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-29 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Remove or add www and trailing slash from urls for Rack applications.
+  Use it if you can not edit Nginx or Apache configs.
+email:
+- michaelkhabarov@alphastate.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/seo_redirect.rb
+- lib/rack/seo_redirect/base.rb
+- lib/rack/seo_redirect/trailing_slash.rb
+- lib/rack/seo_redirect/version.rb
+- lib/rack/seo_redirect/www.rb
+- rack-seo_redirect.gemspec
+- spec/spec_helper.rb
+- spec/trailing_slash_spec.rb
+- spec/www_spec.rb
+homepage: https://github.com/michaelkhabarov/rack-seo_redirect
+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.1.9
+signing_key: 
+specification_version: 4
+summary: Make www and trailing slash redirects from Rack
+test_files:
+- spec/spec_helper.rb
+- spec/trailing_slash_spec.rb
+- spec/www_spec.rb