ensure_subdomain 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bfbed2cb42ec1dec6b7db959362ceea0cb69744
-  data.tar.gz: 108f8ddd0931f49a7b23a4b4a9a6065133f0a0ac
+  metadata.gz: d92f9be5e9736803dcf8624689996509100ccc21
+  data.tar.gz: ddf4448c07e20ba6e4a812c94e4a9f95d1e658ab
 SHA512:
-  metadata.gz: f7433c9c8ac9f077ac8939b4e2c5ae155f829a03ede929b01789ddd03eff470566ac2dd9b1b6a3f0e4580bd10a0611396b4576854455f6bfaeba44987d4d8fbe
-  data.tar.gz: 408da1bae5482b9d43066c1c22f4f8c11629d1ba17f88808003796ea751b6ca3c4c3a5cebf9a724279ae92b92c21cc70a37aa84a60f3268bfe5e4595e928b01f
+  metadata.gz: 3ffcbea839fd66d15f6410f732d6d398253a6147fb58e35a2e2f982863e86049faf25a10c5094c8388f29fa4e96f62dbb0a1abec603e91e7a49f35ef75e867f1
+  data.tar.gz: 02ca130fd3eeb8c3ca996562ac1b8af5b5070f411726b98a0395ee448c14b3031250c1ee09df528bb2b729257d4efaadd0a8d07f743590696d3d184fa64ac5cc

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/LICENSE

@@ -1,20 +1,13 @@
-The MIT License (MIT)
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE 
+Version 2, December 2004 
 
-Copyright (c) 2013 Jacob Evan Shreve
+Copyright (C) 2014 Jacob Evan Shreve
 
-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:
+Everyone is permitted to copy and distribute verbatim or modified 
+copies of this license document, and changing it is allowed as long 
+as the name is changed. 
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE 
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 
 
-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.
+0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -2,6 +2,9 @@
 
 _an ActionDispatch extension to handle subdomain redirects_
 
+[![Gem Version](https://badge.fury.io/rb/ensure_subdomain.png)](http://badge.fury.io/rb/ensure_subdomain)
+[![Code Climate](https://codeclimate.com/github/shreve/ensure_subdomain.png)](https://codeclimate.com/github/shreve/ensure_subdomain)
+
 Let's say you believe that [using the www subdomain is dumb](http://no-www.org).
 
 Ensuring your rails app doesn't use this subdomain is pretty easy, but now it's easier.
@@ -11,7 +14,7 @@ Ensuring your rails app doesn't use this subdomain is pretty easy, but now it's
 gem 'ensure_subdomain'
 
 # Preferred terminal
-`bundle install`
+bundle install
 
 # config/routes.rb
 Rails.application.routes.draw do
@@ -21,11 +24,15 @@ Rails.application.routes.draw do
 end
 ```
 
-GET www.example.com   → 301   example.com
+```
+$ curl -I http://www.example.com
+HTTP/1.1 301 Moved Permanently
+Location: http://example.com
+```
 
 Simple as that.
 
-Conversely, if you are wrong and think you should use www, there's a method for that.
+Conversely, if you _do_ want to use the www subdomain, there's also a method for that.
 
 ```ruby
 # config/routes.rb
@@ -34,23 +41,53 @@ Rails.application.routes.draw do
 end
 ```
 
-GET example.com  → 301  www.example.com
-
+```
+$ curl -I http://example.com
+HTTP/1.1 301 Moved Permanently
+Location: http://www.example.com
+```
 
-If you've got some other domain, there's a method for that too.
+There's also a method for whatever custom domain or domains you'd like.
 
 ```ruby
 # config/routes.rb
 Rails.application.routes.draw do
+  # Single domain
+  # The only allowed subdomain is blog. All others will redirect.
   ensure_subdomain 'blog'
 end
 ```
 
-GET example.com  → 301  blog.example.com
+```
+$ curl -I http://example.com
+HTTP/1.1 301 Moved Permanently
+Location: http://blog.example.com
 
-GET www.example.com  → 301  blog.example.com
+$ curl -I http://www.example.com
+HTTP/1.1 301 Moved Permanently
+Location: http://blog.example.com
+```
 
-What if you want to control the direction for different environments? I've got ya.
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  # Multiple domains
+  # All of these subdomains are allowed. If another subdomain is requested, the
+  # response will redirect to en because it's first.
+  ensure_subdomains %w(en es fr jp)
+end
+```
+
+```
+$ curl -I http://jp.example.com
+HTTP/1.1 200 OK
+
+$ curl -I http://example.com
+HTTP/1.1 301 Moved Permanently
+Location: http://en.example.com
+```
+
+We've even got you covered if you want different rules for different environments.
 
 ```ruby
 # config/routes.rb
@@ -61,6 +98,9 @@ Rails.application.routes.draw do
 end
 ```
 
+Please note that multiple rules don't work together well. It's recommended to
+just add a single ensure rule at the top of your routes.
+
 Also recently added, and somewhat experimental, _not fucking up on Heroku!_
 
 *Before:* GET application.herokuapp.com  → 301  herokuapp.com  → 301  heroku.com

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake/testtask'
+
+task :default do
+  Dir.glob('./test/*_test.rb').each { |f| require f }
+end

data/ensure_subdomain.gemspec

@@ -1,5 +1,4 @@
 # -*- encoding: utf-8 -*-
-
 require File.expand_path('../lib/ensure_subdomain/version', __FILE__)
 
 Gem::Specification.new do |s|
@@ -7,11 +6,10 @@ Gem::Specification.new do |s|
   s.version = EnsureSubdomain::VERSION::STRING
   s.platform = Gem::Platform::RUBY
   s.authors = "Jacob Evan Shreve"
-  s.email = %w(jacob@shreve.ly)
   s.summary = 'Ensure requests are going to the right subdomain.'
   s.description = 'Ensure requests are going to the right subdomain to avoid competing with yourself for dem SERPs. Adds a couple methods to ActionDispatch for routes.'
   s.homepage = 'https://github.com/shreve/ensure_subdomain'
-  s.license = 'MIT'
+  s.license = 'WTFPL'
 
   s.add_runtime_dependency 'actionpack', '>= 3.2.0'
 

data/lib/action_dispatch/routing/mapper/http_helpers.rb

@@ -0,0 +1,30 @@
+module ActionDispatch::Routing::Mapper::HttpHelpers
+  def ensure_no_www
+    ensure_subdomain ''
+  end
+  alias_method :ensure_non_www, :ensure_no_www
+  alias_method :ensure_apex, :ensure_no_www
+
+  def ensure_www
+    ensure_subdomain 'www'
+  end
+
+  def ensure_on(environments)
+    environments.each_pair do |env, domain|
+      if Rails.env.to_sym == env
+        ensure_subdomain domain
+      end
+    end
+  end
+
+  def ensure_subdomain(subdomain, options={})
+    redirector = ::EnsureSubdomain.new( subdomain )
+    verbs = options[:via] || [:get, :post, :put, :patch, :delete]
+    constraints( redirector ) do
+      match '/', to: redirect { |params, request| redirector.to params, request }, via: verbs
+      match '/*path', to: redirect { |params, request| redirector.to params, request }, via: verbs
+    end
+  end
+  alias_method :ensure_subdomains, :ensure_subdomain
+end
+

data/lib/ensure_subdomain.rb

@@ -1,58 +1,55 @@
+require_relative './action_dispatch/routing/mapper/http_helpers'
+
 class EnsureSubdomain
-  attr_accessor :subdomain
+  attr_accessor :subdomains
 
-  def initialize(subdomain)
-    self.subdomain = subdomain.sub(/\.$/, '')
+  def initialize(subdomains)
+    subdomains = [subdomains] unless subdomains.respond_to?(:map)
+    self.subdomains = subdomains.map { |s| s.sub(/\.$/, '') }
   end
 
   def matches?(request)
-    # don't deal with addresses like http://0.0.0.0:3000
-    request.domain.present? and
-    # ''.match('www') #=> nil, which is is the opposite of what we want
-      ((self.subdomain.empty? and request.subdomain.present?) or
-        request.subdomain.match(self.subdomain).nil?)
+    # Don't deal with addresses like http://0.0.0.0:3000
+    request.domain.present? and requires_redirect?(request)
   end
 
+  # Only called when not on an appropriate domain
   def to(params, request)
     url = request.protocol
-    url << "#{self.subdomain}." if self.subdomain.present?
-    url << "#{request.subdomain}." if vendor_url?(request)
-    url << request.domain
+    url << redirect_to_full_domain(request)
     url << "/#{params[:path]}" if params[:path].present?
     url
   end
 
   private
-  def vendor_url?(request)
-    request.domain.match /heroku/
+  def redirect_to_full_domain(request)
+    parts = []
+    parts << self.subdomains.first if self.subdomains.any?
+    parts << request.subdomain if vendor_url?(request)
+    parts << request.domain
+    parts.reject(&:empty?).join('.')
   end
-end
 
-module ActionDispatch::Routing::Mapper::HttpHelpers
-  def ensure_no_www
-    ensure_subdomain ''
+  def requires_redirect?(request)
+    shouldnt_have_a_subdomain?(request) or !on_allowed_subdomain?(request)
   end
-  alias_method :ensure_non_www, :ensure_no_www
-  alias_method :ensure_apex, :ensure_no_www
 
-  def ensure_www
-    ensure_subdomain 'www'
+  def shouldnt_have_a_subdomain?(request)
+    # ''.match('www') #=> nil, which is is the opposite of what we want
+    apex_required? and request.subdomain.present?
+  end
+
+  def on_allowed_subdomain?(request)
+    self.subdomains.select do |subdomain|
+      request.subdomain == subdomain
+    end.size > 0
   end
 
-  def ensure_on(environments)
-    environments.each_pair do |env, domain|
-      if Rails.env.to_sym == env
-        ensure_subdomain domain
-      end
-    end
+  def apex_required?
+    self.subdomains.size == 1 && self.subdomains.first == ''
   end
 
-  def ensure_subdomain(subdomain, options={})
-    redirector = EnsureSubdomain.new( subdomain )
-    verbs = options[:via] || [:get, :post, :put, :patch, :delete]
-    constraints( redirector ) do
-      match '/', to: redirect { |params, request| redirector.to params, request }, via: verbs
-      match '/*path', to: redirect { |params, request| redirector.to params, request }, via: verbs
-    end
+  def vendor_url?(request)
+    request.domain.match /heroku/
   end
 end

data/lib/ensure_subdomain/version.rb

@@ -1,8 +1,8 @@
 class EnsureSubdomain
   module VERSION
     MAJOR = 1
-    MINOR = 0
-    TINY = 3
+    MINOR = 1
+    TINY = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/ensure_subdomain_test.rb

@@ -1,6 +1,6 @@
-require 'test_helper'
+require_relative './test_helper'
 
-class TestEnsureSubdomain < MiniTest::Unit::TestCase
+class TestEnsureSubdomain < MiniTest::Test
 =begin
   Test that the EnsureSubdomain constraint matching works.
   Involves class initialization, and the matches method

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ensure_subdomain
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Jacob Evan Shreve
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2014-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -26,24 +26,26 @@ dependencies:
         version: 3.2.0
 description: Ensure requests are going to the right subdomain to avoid competing with
   yourself for dem SERPs. Adds a couple methods to ActionDispatch for routes.
-email:
-- jacob@shreve.ly
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Guardfile
 - LICENSE
 - README.md
+- Rakefile
 - ensure_subdomain.gemspec
+- lib/action_dispatch/routing/mapper/http_helpers.rb
 - lib/ensure_subdomain.rb
 - lib/ensure_subdomain/version.rb
 - test/ensure_subdomain_test.rb
 - test/test_helper.rb
 homepage: https://github.com/shreve/ensure_subdomain
 licenses:
-- MIT
+- WTFPL
 metadata: {}
 post_install_message: 
 rdoc_options: []