rack-no-www 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.0.2 (June 14, 2011)
+
+- Populate CHANGELOG.
+- Streamline package files and spec helper.
+- FIX: Spec for Ruby 1.9.2 compatibility.
+- FIX: Add `Content-Type` header for 301 Redirect.
+- Update content, format, and whitespace of README.
+
+
+## 0.0.1 (June 22, 2010)
+
+- Initial release

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.md

@@ -0,0 +1,63 @@
+rack-no-www
+===========
+
+This piece of simple middlweware catches requests that begin with "www" 
+and redirects them to the equivalent "non-www" address. For example, a 
+request to "http://www.example.org" will be redirected to 
+"http://example.org".
+
+This kind of redirect adheres to the [no-www philosophy][1], which 
+advocates websites having a canonical address without the wasteful "www" 
+subdomain. For a site to have a canonical address, it must have a 
+single, preferred URL. If a site has multiple URLs that return the same 
+content (e.g., a CNAME alias for "http://www.example.org" that points to 
+"http://example.org"), search engines might interpret these URLs as 
+*different* resources, thus [affecting search rankings and their 
+appearance][2]. That's why a site should have a canonical URL. But since 
+many users still think "www" is a necessary part of a web address, it's 
+important to allow "www" requests and redirect these requests to the 
+"non-www" equivalent.
+
+Redirecting to a canonical URL might better be performed at the DNS 
+level, or directly by the webserver (e.g., [Apache][3] or [nginx][4]). 
+Alas, not all DNS services allow such configuration, and some 
+cloud-based hosting solutions, (e.g., [Heroku][5]) don't allow explicit 
+server configuration. Hence this piece of middleware.
+
+
+Installation
+------------
+
+    $ gem install rack-no-www
+
+
+Usage
+-----
+
+Simply `require 'rack/no-www'` where appropriate, and then include the 
+middleware in the Rack stack. In Rails 3, for example, the 
+`config/application.rb` might be adjusted accordingly to place the 
+middleware at the top of the Rack stack::
+
+    Module MyApp
+      class Application < Rails::Application
+        ...
+        if Rails.env.production?
+          config.middleware.insert_before Rack::Lock, Rack::NoWWW
+        end
+      end
+    end
+
+
+Credits
+-------
+
+This gem is simply a packaged version (with tests) of the idea outlined [here][6] by Trevor Turk.
+
+
+[1]: http://no-www.org
+[2]: http://www.google.com/support/webmasters/bin/answer.py?answer=139066
+[3]: http://www.plexusweb.com/staff/travis/blog/post/274/Redirect-www-Subdomain-to-no-www
+[4]: http://snippets.aktagon.com/snippets/59-How-to-improve-your-PageRank-with-301-permanent-redirects-when-using-Nginx
+[5]: http://heroku.com
+[6]: http://trevorturk.com/2009/11/05/no-www-rack-middleware/

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/rack/no-www/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class NoWWW
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/rack/no-www.rb

@@ -19,7 +19,8 @@ module Rack
 
     private
     def no_www_request(env)
-      { 'Location' => Rack::Request.new(env).url.sub(/www\./i, '') }
+      { 'Location' => Rack::Request.new(env).url.sub(/www\./i, ''),
+        'Content-Type' => 'text/html' }
     end
 
   end

data/rack-no-www.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack/no-www/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-no-www"
+  s.version     = Rack::NoWWW::VERSION
+  s.authors     = ["logicaltext"]
+  s.email       = ["logicaltext@logicaltext.com"]
+  s.homepage    = "http://github.com/logicaltext/rack-no-www"
+  s.summary     = "Rack middleware for redirecting 'www' requests"
+  s.description = "Rack middleware for redirecting 'www' requests, " \
+                  "based on the original idea by trevorturk "\
+                  "(http://trevorturk.com/2009/11/05/no-www-rack-middleware/)."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "rack-no-www"
+
+  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "rack-test"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/spec/rack_no_www_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe "Rack::NoWWW" do
+
+  include Rack::Test::Methods
+
+  def app
+    mock_endpoint = lambda { |env| [200, {}, ['Hello, world.']] }
+    app = Rack::NoWWW.new(mock_endpoint)
+  end
+
+  describe "when receiving a request with a 'www'" do
+
+    before(:each) do
+      request '/', {'HTTP_HOST' => 'www.example.org' }
+    end
+
+    it "should issue a 301 redirect" do
+      last_response.status.should == 301
+    end
+
+    it "should redirect to the URL without the 'www'" do
+      last_response.headers['Location'].should == "http://example.org/"
+    end
+
+    it "should have a text/html content type" do
+      last_response.headers['Content-Type'].should == "text/html"
+    end
+
+    it "should have a body of 'Moved Permanently\\n'" do
+      last_response.body.should == "Moved Permanently\n"
+    end
+    
+  end
+
+  describe "when receiving a request without a 'www'" do
+    it "should fall through to the app" do
+      get '/'
+      last_response.status.should == 200
+      last_response.body.should == "Hello, world."
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "rubygems"
+require "bundler/setup"
+require "rack/test"
+require "rack/no-www"

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: rack-no-www
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors: 
 - logicaltext
@@ -15,10 +10,30 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-22 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
+date: 2011-06-15 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: Rack middleware for redirecting 'www' requests, based on the original idea by trevorturk (http://trevorturk.com/2009/11/05/no-www-rack-middleware/).
 email: 
 - logicaltext@logicaltext.com
@@ -29,11 +44,18 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/rack/no-www/version.rb
-- lib/rack/no-www.rb
-- lib/rack-no-www.rb
+- CHANGELOG.md
+- Gemfile
 - LICENSE
-has_rdoc: true
+- README.md
+- Rakefile
+- autotest/discover.rb
+- lib/rack-no-www.rb
+- lib/rack/no-www.rb
+- lib/rack/no-www/version.rb
+- rack-no-www.gemspec
+- spec/rack_no_www_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/logicaltext/rack-no-www
 licenses: []
 
@@ -47,27 +69,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: rack-no-www
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Rack middleware for redirecting 'www' requests
-test_files: []
-
+test_files: 
+- spec/rack_no_www_spec.rb
+- spec/spec_helper.rb