rack-www 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1a573de69069e3e4dba5fa155a61171e7f2a5db
-  data.tar.gz: 1eccb6a5132455dac0d7a3e52870ef3fc8999292
+  metadata.gz: 67bab3314c14a6baf165bf7697f2640e290cd9f9
+  data.tar.gz: 39c53a98db554ad2a7d178d9c62aa0fdac9b5deb
 SHA512:
-  metadata.gz: 793e64555ba1265be7ac95a543920aeb2156a64636153ae6f16b35bf77393b40638f886b0c38227a778c1f35f0067a44064d451eafeade87450e049332ccde64
-  data.tar.gz: 4ae7ab8da7a192df653a069118b97db41b7b38a3f61c47c2b6f332dd4fdc9dbf3a452c1356d408d7e7d07236527c59239347bb58f0baa3a7395b6c77db3fa957
+  metadata.gz: 8b3c507ada98ad3a4489c21a791b660257cb67db00ade55983ca8fecb2d5e35c77042736ad8295e257a75790558d8b14c17d874e8dc2c09e4689431302d3c307
+  data.tar.gz: 429293155e765b0fda94c704577b80f00a990715fb3a50be42a68c444d65f563006b2e8695d45761386a9cf8b0e23a77b6f1cb5d0ffe2695be51c202b00e9402

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.1
+
+- Ignore rack-www when request host is an IP address
+
 ## 2.0
 
 - Update EVERYTHING

data/Gemfile.lock

@@ -1,22 +1,79 @@
 PATH
   remote: .
   specs:
-    rack-www (2.0.0)
+    rack-www (2.1.0)
       rack (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    coderay (1.1.0)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.4)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    guard-rubocop (1.2.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    listen (3.0.5)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
     minitest (5.8.3)
+    nenv (0.2.0)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)
+    rainbow (2.0.0)
     rake (10.4.2)
+    rb-fsevent (0.9.6)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rubocop (0.35.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.3.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      tins (<= 1.6.0)
+    ruby-progressbar (1.7.5)
+    shellany (0.0.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    tins (1.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  guard (~> 2.13)
+  guard-minitest (~> 2.4)
+  guard-rubocop (~> 1.2)
   minitest (~> 5.8)
   rack-test (~> 0.6)
   rack-www!

data/Guardfile

@@ -0,0 +1,11 @@
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end
+
+guard :rubocop do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/Rakefile

@@ -1,9 +1,9 @@
 require 'rake/testtask'
 
-task :default => :test
+task default: :test
 
 Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
   t.warning = true
 end

data/lib/rack/www.rb

@@ -1,13 +1,15 @@
 require 'rack'
 require 'rack/request'
+require 'ipaddr'
 
 module Rack
+  # Rack::WWW
   class WWW
     def initialize(app, options = {})
-      @options = {:subdomain => "www"}.merge(options)
+      @options = { subdomain: 'www' }.merge(options)
       @app = app
 
-      @redirect = @options[:www] != nil ? @options[:www] : true
+      @redirect = !@options[:www].nil? ? @options[:www] : true
       @message = @options[:message]
       @subdomain = @options[:subdomain]
       @predicate = @options[:predicate]
@@ -22,9 +24,10 @@ module Rack
     end
 
     private
+
     def redirect(env)
       url = prepare_url(env)
-      headers = {"Content-Type" => "text/html", "location" => url}
+      headers = { 'Content-Type' => 'text/html', 'location' => url }
 
       if @message.respond_to?(:each)
         message = @message
@@ -35,7 +38,7 @@ module Rack
     end
 
     def redirect?(env)
-      predicate?(env) && change_subdomain?(env)
+      predicate?(env) && change_subdomain?(env) && !ip_request?(env)
     end
 
     def predicate?(env)
@@ -51,27 +54,36 @@ module Rack
         !@redirect && already_subdomain?(env)
     end
 
+    def ip_request?(env)
+      IPAddr.new(env['SERVER_NAME'].to_s
+        .gsub(/^(#{@subdomain}\.)/, '')
+        .gsub(/^(www\.)/, ''))
+    rescue IPAddr::InvalidAddressError
+      false
+    end
+
     def already_subdomain?(env)
-      env["HTTP_HOST"].to_s.downcase =~ /^(#{@subdomain}\.)/
+      env['HTTP_HOST'].to_s.downcase =~ /^(#{@subdomain}\.)/
     end
 
     def prepare_url(env)
-      scheme = env["rack.url_scheme"]
-      host = env["SERVER_NAME"].to_s.gsub(/^(#{@subdomain}\.)/, "").gsub(/^(www\.)/, "")
-      port = env['SERVER_PORT'] == '80' ? '' : ":#{env['SERVER_PORT']}"
-      path = env["PATH_INFO"]
-
-      unless env["QUERY_STRING"].empty?
-        query_string = "?" + env["QUERY_STRING"]
-      end
+      scheme = env['rack.url_scheme']
+      host, port, path, query_string = extract_host(env)
 
       if @redirect == true
         host = "://#{@subdomain}." + host
       else
-        host = "://" + host
+        host = '://' + host
       end
 
       "#{scheme}#{host}#{port}#{path}#{query_string}"
     end
+
+    def extract_host(env)
+      [env['SERVER_NAME'].to_s.gsub(/^(#{@subdomain}\.|www\.)/, ''),
+       env['SERVER_PORT'] == '80' ? '' : ":#{env['SERVER_PORT']}",
+       env['PATH_INFO'],
+       env['QUERY_STRING'].empty? ? '' : '?' + env['QUERY_STRING'].to_s]
+    end
   end
 end

data/rack-www.gemspec

@@ -1,21 +1,24 @@
 Gem::Specification.new do |s|
   s.name        = 'rack-www'
-  s.version     = '2.0.0'
+  s.version     = '2.1.0'
   s.date        = '2015-12-02'
-  s.homepage    = "https://github.com/stjhimy/rack-www"
-  s.email       = "stjhimy@gmail.com"
-  s.summary     = "Force redirects to a any given subdomain, example: www or www2"
-  s.description = "Rack middleware to force subdomain redirects."
-  s.licenses    = ["MIT"]
-  s.authors     = ["Jhimy Fernandes Villar"]
+  s.homepage    = 'https://github.com/stjhimy/rack-www'
+  s.email       = 'stjhimy@gmail.com'
+  s.summary     = 'Force redirects to a any given subdomain.'
+  s.description = 'Rack middleware to force subdomain redirects.'
+  s.licenses    = ['MIT']
+  s.authors     = ['Jhimy Fernandes Villar']
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
   s.required_ruby_version = '>= 1.9.3'
 
   s.add_runtime_dependency 'rack', '~> 1.0'
   s.add_development_dependency 'rake', '~> 10.4'
   s.add_development_dependency 'rack-test', '~> 0.6'
   s.add_development_dependency 'minitest', '~> 5.8'
+  s.add_development_dependency 'guard', '~> 2.13'
+  s.add_development_dependency 'guard-minitest', '~> 2.4'
+  s.add_development_dependency 'guard-rubocop', '~> 1.2'
 end

data/test/helper.rb

@@ -1,4 +1,4 @@
-require "rack/www"
+require 'rack/www'
 require 'minitest/autorun'
 require 'rack/test'
 
@@ -6,11 +6,10 @@ class TestClass < MiniTest::Test
   include Rack::Test::Methods
 
   def default_app
-    lambda { |env|
-      headers = {'Content-Type' => "text/html"}
-      headers['Set-Cookie'] = "id=1; path=/\ntoken=abc; path=/; secure; HttpOnly"
-      [200, headers, ["default body"]]
-    }
+    lambda do |_env|
+      headers = { 'Content-Type' => 'text/html' }
+      [200, headers, ['default body']]
+    end
   end
 
   def app

data/test/predicate_test.rb

@@ -1,20 +1,27 @@
-require "helper"
+require 'helper'
 
 class PredicateTest < TestClass
   def test_predicate_false
-    self.app = Rack::WWW.new(default_app, :predicate => lambda { |env| false } )
-    get_example
+    self.app = Rack::WWW.new(default_app, predicate: ->(_env) { false })
+    example
     assert_equal last_response.status, 200
   end
 
   def test_predicate_true
-    self.app = Rack::WWW.new(default_app, :predicate => lambda { |env| true } )
-    get_example
-    assert_equal "http://www.example.com/", last_response.headers['Location']
+    self.app = Rack::WWW.new(default_app, predicate: ->(_env) { true })
+    example
+    assert_equal 'http://www.example.com/', last_response.headers['Location']
+  end
+
+  def test_ignore_www_when_ip_request
+    get 'http://111.111.111.111/'
+    assert_equal last_response.status, 200
+    assert_equal '', last_response.headers['Location'].to_s
   end
 
   private
-  def get_example
-    get "http://example.com/"
+
+  def example
+    get 'http://example.com/'
   end
 end

data/test/subdomain_test.rb

@@ -1,43 +1,56 @@
-require "helper"
+require 'helper'
 
 class SubdomainTest < TestClass
   def setup
-    self.app = Rack::WWW.new(default_app, :subdomain => "secure")
+    self.app = Rack::WWW.new(default_app, subdomain: 's')
   end
 
   def test_if_allow_custom_subdomain
     get 'http://example.com'
-    assert_equal 'http://secure.example.com/', last_response.headers['Location']
+    assert_equal 'http://s.example.com/',
+                 last_response.headers['Location']
   end
 
   def test_custom_subdomain_with_path
-    get "http://example.com/path/1"
-    assert_equal "http://secure.example.com/path/1", last_response.headers['Location']
+    get 'http://example.com/path/1'
+    assert_equal 'http://s.example.com/path/1',
+                 last_response.headers['Location']
   end
 
   def test_custom_subdomain_with_path_and_www
-    get "http://www.example.com/path/1"
-    assert_equal "http://secure.example.com/path/1", last_response.headers['Location']
+    get 'http://www.example.com/path/1'
+    assert_equal 'http://s.example.com/path/1',
+                 last_response.headers['Location']
   end
 
   def test_custom_subdomain_with_query
-    get "http://example.com/path/1?test=true"
-    assert_equal "http://secure.example.com/path/1?test=true", last_response.headers['Location']
+    get 'http://example.com/path/1?test=true'
+    assert_equal 'http://s.example.com/path/1?test=true',
+                 last_response.headers['Location']
   end
 
   def test_custom_subdomain_with_query_and_www
-    get "http://www.example.com/path/1?test=true"
-    assert_equal "http://secure.example.com/path/1?test=true", last_response.headers['Location']
+    get 'http://www.example.com/path/1?test=true'
+    assert_equal 'http://s.example.com/path/1?test=true',
+                 last_response.headers['Location']
   end
 
   def test_body_with_custom_subdomain_and_message
-    self.app = Rack::WWW.new(default_app, :subdomain => "secure", :message => "redirecting now!")
-    get "http://example.com/"
-    assert_equal last_response.body, "redirecting now!"
+    self.app = Rack::WWW.new(default_app,
+                             subdomain: 'secure',
+                             message: 'redirecting now!')
+    get 'http://example.com/'
+    assert_equal last_response.body, 'redirecting now!'
   end
 
   def test_body_with_custom_subdomain_without_message
-    get "http://example.com/"
-    assert_equal last_response.body, ""
+    get 'http://example.com/'
+    assert_equal last_response.body, ''
+  end
+
+  def test_ignore_www_when_ip_request
+    get 'http://111.111.111.111/'
+    assert_equal last_response.status, 200
+    assert_equal '', last_response.headers['Location'].to_s
   end
 end

data/test/www_false_test.rb

@@ -1,27 +1,36 @@
-require "helper"
+require 'helper'
 
 class FalseWWW < TestClass
   def setup
-    self.app = Rack::WWW.new(default_app, :www => false)
+    self.app = Rack::WWW.new(default_app, www: false)
   end
 
   def test_www_false
-    get "http://www.example.com/"
-    assert_equal "http://example.com/", last_response.headers['Location']
+    get 'http://www.example.com/'
+    assert_equal 'http://example.com/',
+                 last_response.headers['Location']
   end
 
   def test_www_false_with_path
-    get "http://www.example.com/path/1"
-    assert_equal "http://example.com/path/1", last_response.headers['Location']
+    get 'http://www.example.com/path/1'
+    assert_equal 'http://example.com/path/1',
+                 last_response.headers['Location']
   end
 
   def test_www_false_with_query
-    get "http://www.example.com/path/1?param=test"
-    assert_equal "http://example.com/path/1?param=test", last_response.headers['Location']
+    get 'http://www.example.com/path/1?param=test'
+    assert_equal 'http://example.com/path/1?param=test',
+                 last_response.headers['Location']
   end
 
   def test_www_false_non_www
-    get "http://example.com/"
+    get 'http://example.com/'
     assert last_response.ok?
   end
+
+  def test_ignore_www_when_ip_request
+    get 'http://111.111.111.111/'
+    assert_equal last_response.status, 200
+    assert_equal '', last_response.headers['Location'].to_s
+  end
 end

data/test/www_true_test.rb

@@ -1,58 +1,70 @@
-require "helper"
+require 'helper'
 
 class TrueWWW < TestClass
   def setup
-    self.app = Rack::WWW.new(default_app, :www => true)
+    self.app = Rack::WWW.new(default_app, www: true)
   end
 
   def test_response_200
-    get "http://www.example.com"
+    get 'http://www.example.com'
     assert_equal last_response.status, 200
   end
 
   def test_response_301
-    get "http://example.com"
+    get 'http://example.com'
     assert_equal last_response.status, 301
   end
 
   def test_redirects
-    get "http://example.com/"
-    assert_equal "http://www.example.com/", last_response.headers['Location']
+    get 'http://example.com/'
+    assert_equal 'http://www.example.com/', last_response.headers['Location']
   end
 
   def test_www_true
-    get "http://example.com/"
-    assert_equal "http://www.example.com/", last_response.headers['Location']
+    get 'http://example.com/'
+    assert_equal 'http://www.example.com/', last_response.headers['Location']
   end
 
   def test_www_true_with_path
-    get "http://example.com/path/1"
-    assert_equal "http://www.example.com/path/1", last_response.headers['Location']
+    get 'http://example.com/path/1'
+    assert_equal 'http://www.example.com/path/1',
+                 last_response.headers['Location']
   end
 
   def test_www_true_with_query
-    get "http://example.com/path/1?param=test"
-    assert_equal "http://www.example.com/path/1?param=test", last_response.headers['Location']
+    get 'http://example.com/path/1?param=test'
+    assert_equal 'http://www.example.com/path/1?param=test',
+                 last_response.headers['Location']
   end
 
   def test_body_with_message
-    self.app = Rack::WWW.new(default_app, :www => true, :message => "redirecting now!")
-    get "http://example.com/"
-    assert_equal last_response.body, "redirecting now!"
+    self.app = Rack::WWW.new(default_app,
+                             www: true,
+                             message: 'redirecting now!')
+    get 'http://example.com/'
+    assert_equal last_response.body, 'redirecting now!'
   end
 
   def test_body_without_message
-    get "http://example.com/"
-    assert_equal last_response.body, ""
+    get 'http://example.com/'
+    assert_equal last_response.body, ''
   end
 
   def test_server_port
-    get "http://example.com:8080/"
-    assert_equal "http://www.example.com:8080/",last_response.headers['Location']
+    get 'http://example.com:8080/'
+    assert_equal 'http://www.example.com:8080/',
+                 last_response.headers['Location']
   end
 
   def test_server_port_80
-    get "http://example.com:80/"
-    assert_equal "http://www.example.com/",last_response.headers['Location']
+    get 'http://example.com:80/'
+    assert_equal 'http://www.example.com/',
+                 last_response.headers['Location']
+  end
+
+  def test_ignore_www_when_ip_request
+    get 'http://111.111.111.111/'
+    assert_equal last_response.status, 200
+    assert_equal '', last_response.headers['Location'].to_s
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-www
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jhimy Fernandes Villar
@@ -66,6 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Rack middleware to force subdomain redirects.
 email: stjhimy@gmail.com
 executables: []
@@ -78,11 +120,12 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
-- lib/rack-www.rb
 - lib/rack/www.rb
+- lib/rack_www.rb
 - rack-www.gemspec
 - test/helper.rb
 - test/predicate_test.rb
@@ -112,7 +155,7 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: 'Force redirects to a any given subdomain, example: www or www2'
+summary: Force redirects to a any given subdomain.
 test_files:
 - test/helper.rb
 - test/predicate_test.rb