rack-domain 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f490d3f568d69528c7cc2079b82eb2eaa884096
+  data.tar.gz: 8f884b4ae54e454b95e5084c7476e79b3046bb16
+SHA512:
+  metadata.gz: 3bf3fb2d14a573071bb4d42e26dbbae1d74f7c1ded555d546160b21c8200703e7f5c8672062f2438c5775f665d5d090f6f2d056d2f50689065b8d2b7e621a86a
+  data.tar.gz: dc2f9e6d7c1bc047cd8ecdfb2c9d00460286b14a0ed62447cd74c603d7c7c8052837b946a26697ccc8b20bc927f3bb9b49fb4b787f26886864a742b6daa00fe6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.3
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rack-test',
+  '>= 0.4',
+  require: 'rack/test',
+  group: :test
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrea Leopardi
+
+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,28 @@
+# Rack::Domain
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-domain'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-domain
+
+
+## Contributing
+
+Fork, make changes, commit, open Pull Request! Read the [GitHub guide to
+forking][forking] if you don't know how to.
+
+
+
+[forking]: https://help.github.com/articles/fork-a-repo/

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/lib/rack/domain/dsl.rb

@@ -0,0 +1,16 @@
+require 'rack/domain'
+
+# This class is monkeypatched with the `#domain` method.
+class Rack::Builder
+  # Behaves just like `use Rack::Domain`, but with a simpler and clearer syntax.
+  #
+  # @param [String, Regexp] filter The filter used to match the domain.
+  # @param [Hash] opts An hash of options.
+  # @option opts [#call, nil] :run The app to run if the domain matches.
+  #
+  # @raise [ArgumentError] if no app to run or block were passed, or if both
+  #   were passed.
+  def domain(filter, opts = {}, &block)
+    use(Rack::Domain, filter, opts, &block)
+  end
+end

data/lib/rack/domain/version.rb

@@ -0,0 +1,7 @@
+# Extensions to the `Rack` module.
+module Rack
+  class Domain
+    # The version of this gem.
+    VERSION = '0.1.0'
+  end
+end

data/lib/rack/domain.rb

@@ -0,0 +1,63 @@
+require 'rack/domain/version'
+
+# This Rack middleware allows to intercept requests and route them to different
+# apps based on the domain (full, with subdomains and the TLD).
+class Rack::Domain
+  # Create a new instance of this middleware.
+  # **Note** that this method is the method called by `Rack::Builder#use`.
+  #
+  # @param [#call] next_app The next app on the stack, filled automatically by
+  #   Rack when building the middlware chain.
+  # @param [String, Regexp] filter The filter used to, well, filter the domain.
+  #   If `filter` is a `String`, it will be matched *at the beginning* of the
+  #   domain name; this is done so that it's easy to match subdomains and
+  #   domains without TLDs.
+  # @param [Hash] opts An hash of options.
+  # @option opts [#call, nil] :run The Rack app to run if the domain matches the
+  #   filter. If you don't want to pass a ready application, you can pass a
+  #   block with `Rack::Builder` syntax which will create a Rack app on-the-fly.
+  # @raise [ArgumentError] if both a building block and an app to run were
+  #   passed to this function.
+  def initialize(next_app, filter, opts = {}, &block)
+    if opts[:run] && block_given?
+      fail ArgumentError, 'Pass either an app to run or a block, not both'
+    end
+
+    @next_app = next_app
+    @filter = filter
+    @app_to_run = opts[:run]
+    @dsl_block = block
+  end
+
+  # The `call` method as per the Rack middleware specification.
+  # @param [Hash] env The environment passed around in the middlware chain.
+  def call(env)
+    @domain = Rack::Request.new(env).host
+    app = domain_matches? ? app_or_dsl_block : @next_app
+    app.call(env)
+  end
+
+  private
+
+  # Return the app that was specified to be run if the domain matches or, if the
+  # app was specified on-the-fly with a builder block, return a new app created
+  # with that block (and `Rack::Builder`).
+  # @return [#call]
+  def app_or_dsl_block
+    @app_to_run || Rack::Builder.new(&@dsl_block)
+  end
+
+  # Return `true` if the domain of the current request matches the given
+  # `@filter`, `false` otherwise.
+  # @return [Boolean]
+  def domain_matches?
+    case @filter
+    when Regexp
+      @filter =~ @domain
+    when String
+      @domain.start_with?(@filter)
+    else
+      fail 'The filter must be a Regexp or a String'
+    end
+  end
+end

data/rack-domain.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/domain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-domain'
+  spec.version       = Rack::Domain::VERSION
+  spec.authors       = ['Andrea Leopardi']
+  spec.email         = 'an.leopardi@gmail.com'
+  spec.homepage      = 'https://github.com/whatyouhide/rack-domain'
+  spec.license       = 'MIT'
+  spec.summary       = <<-SUMMARY
+    Rack middleware for dispatching Rack apps based on the domain'
+  SUMMARY
+  spec.description   = <<-DESCRIPTION
+    This Rack middleware allows you to run specific apps when the request
+    domain matches a given filter. The filter can be provided in a number of
+    ways, for example as a regex or as a string.
+  DESCRIPTION
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency 'rack', '>= 1.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'minitest', '~> 5'
+  spec.add_development_dependency 'minitest-reporters', '~> 1'
+end

data/test/subdomainer_test.rb

@@ -0,0 +1,106 @@
+require_relative 'test_helper'
+
+NOT_FOUNDER = lambda { |env| [404, {}, ['Error']] }
+LOBSTER = Rack::Builder.new do
+  map('/lobster') { run Rack::Lobster.new }
+  map('/') { run NOT_FOUNDER }
+end
+
+class DomainTest < Minitest::Test
+  include Rack::Test::Methods
+
+  BASE_URL = 'http://example.com'
+  BASE_URL_WITH_SUBDOMAIN = 'http://api.example.com'
+
+  def test_with_a_string
+    %w(api api.example api.example.com).each do |str|
+      set_app_to do
+        use Rack::Domain, str, run: Rack::Lobster.new
+        run NOT_FOUNDER
+      end
+
+      assert_dispatches_to_the_right_app
+    end
+  end
+
+  def test_with_regexps
+    [/^api\./, /.+/, /example/, /\.com$/].each do |regexp|
+      set_app_to do
+        use Rack::Domain, regexp, run: Rack::Lobster.new
+        run NOT_FOUNDER
+      end
+
+      assert_dispatches_to_the_right_app
+    end
+  end
+
+  def test_with_a_block
+    ['api', 'api.exam', /example/, /\.com$/].each do |filter|
+      set_app_to do
+        use Rack::Domain, filter do
+          run Rack::Lobster.new
+        end
+
+        run NOT_FOUNDER
+      end
+
+      assert_dispatches_to_the_right_app
+    end
+  end
+
+  def test_rack_builder_dsl_extension
+    require 'rack/domain/dsl'
+
+    set_app_to do
+      domain 'api', run: Rack::Lobster.new
+      run NOT_FOUNDER
+    end
+    assert_dispatches_to_the_right_app
+
+    set_app_to do
+      domain /^api\./, run: Rack::Lobster.new
+      run NOT_FOUNDER
+    end
+    assert_dispatches_to_the_right_app
+  end
+
+  def test_argument_errors
+    assert_app_raises ArgumentError do
+      lob = Rack::Lobster.new
+      use(Rack::Domain, 'api', { run: Rack::Lobster.new }) { lob }
+      run lob
+    end
+  end
+
+  private
+
+  def set_app_to(app = nil, &block)
+    define_singleton_method(:app) do
+      app || Rack::Builder.new(&block)
+    end
+  end
+
+  def assert_app_raises(error, &block)
+    assert_raises error do
+      set_app_to(&block)
+      get '/'
+    end
+  end
+
+  def assert_dispatches_to_the_right_app
+    get BASE_URL
+    assert last_response.not_found?,
+      'The app was intercepted when it should not have been'
+
+    get BASE_URL_WITH_SUBDOMAIN
+    assert_lobster_responded
+  end
+
+  def assert_lobster_responded
+    assert last_response.ok?,
+      "The response was #{last_response.status} instead of 200 OK"
+    assert last_response.body.include?('Lobstericious'),
+      'The run app was not Rack::Lobster'
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/reporters'
+require 'rack/test'
+require 'rack/lobster'
+
+require 'rack/domain'
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rack-domain
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrea Leopardi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: |2
+      This Rack middleware allows you to run specific apps when the request
+      domain matches a given filter. The filter can be provided in a number of
+      ways, for example as a regex or as a string.
+email: an.leopardi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/domain.rb
+- lib/rack/domain/dsl.rb
+- lib/rack/domain/version.rb
+- rack-domain.gemspec
+- test/subdomainer_test.rb
+- test/test_helper.rb
+homepage: https://github.com/whatyouhide/rack-domain
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rack middleware for dispatching Rack apps based on the domain'
+test_files:
+- test/subdomainer_test.rb
+- test/test_helper.rb
+has_rdoc: