path_router 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+/*.gem
+/.bundle
+/Gemfile.lock
+/pkg/*
+
+/path_router.rb

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# see path_router.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    eventmachine (0.12.10)
+    proxymachine (1.2.4)
+      eventmachine (>= 0.12.10)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  proxymachine
+  rspec

data/README.md

@@ -0,0 +1,67 @@
+path_router
+===========
+
+HTTP routing by URL path, built on the excellent [ProxyMachine](https://github.com/mojombo/proxymachine) by the GitHub guys.
+
+GitHub uses ProxyMachine to service millions of git connections every day.
+
+
+Install
+-------
+
+```
+gem install path_router  # installs path_router and proxymachine
+path_router init         # creates example path_router.rb
+vim path_router.rb       # specify your backends and URL patterns
+path_router              # fire it up, optionally with -h host and -p port
+```
+
+Routes
+------
+
+See `example_path_router.rb` to get the general idea.
+
+```ruby
+PathRouter::Router.instance.reset.tap do |r|
+
+  r.backends = {
+    rails:  "127.0.0.1:3000", # default
+    static: "127.0.0.1:8080",
+    wordpress: "10.0.0.1:80",
+  }
+
+  r.connect :static,
+    %r{^/robots.txt},
+    %r{^/(?:images|stylesheets|javascripts)/}
+
+  r.connect :wordpress,
+    %r{^/blog/},
+    %r{^/feed}
+
+end
+```
+
+The only non-obvious point is that the first backend in the hash is the default catch-all.
+Ruby 1.8 users get random default backend; think of it as an easter egg ;)
+
+
+Tests
+-----
+
+```
+$ rspec spec/*_spec.rb
+
+PathRouter::Router
+  routes by specified patterns
+  defaults to first backend for unmatched requests
+
+Finished in 0.00056 seconds
+2 examples, 0 failures
+```
+
+
+Meh.
+----
+
+(c) 2011 Paul Annesley, MIT licence.
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/path_router

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+BASEDIR = File.realpath(File.join(File.dirname(__FILE__), ".."))
+
+if ARGV.include? "init"
+  require "fileutils"
+  dest = "./path_router.rb"
+  FileUtils.cp File.join(BASEDIR, "example_path_router.rb"), dest
+  puts "Created example #{dest}"
+  exit
+end
+
+args = [ "--config", File.join(BASEDIR, "proxymachine_config.rb") ]
+
+OptionParser.new do |opts|
+    opts.banner = <<-EOF
+
+  path_router init
+    Creates example path_router.rb into the current directory.
+
+  path_router [-h <host>] [-p <port>]
+    Start ProxyMachine with path_router config loaded from path_router.rb in
+    the current directory.
+
+  Options:
+EOF
+  opts.on("-hHOST", "--host HOST", "Hostname to bind. Default 0.0.0.0") do |host|
+    args += [ "--host", host ]
+  end
+  opts.on("-pPORT", "--port PORT", "Port to listen on. Default 5432") do |port|
+    args += [ "--port", port ]
+  end
+end.parse!
+
+exec "proxymachine", *args

data/example_path_router.rb

@@ -0,0 +1,17 @@
+PathRouter::Router.instance.reset.tap do |r|
+
+  r.backends = {
+    rails:  "127.0.0.1:3000", # default
+    static: "127.0.0.1:8080",
+    wordpress: "10.0.0.1:80",
+  }
+
+  r.connect :static,
+    %r{^/robots.txt},
+    %r{^/(?:images|stylesheets|javascripts)/}
+
+  r.connect :wordpress,
+    %r{^/blog/},
+    %r{^/feed}
+
+end

data/lib/path_router/router.rb

@@ -0,0 +1,46 @@
+module PathRouter
+  class Router
+
+    def self.instance
+      @instance ||= new
+    end
+
+    def initialize
+      reset
+    end
+
+    def reset
+      @backends = {}
+      @routes = {}
+      self
+    end
+
+    def load_routes(file = "path_router.rb")
+      puts "Loading routes from #{file}"
+      load file
+    rescue LoadError => e
+      puts "Failed to load routes: " << e.message
+    end
+
+    # Hash of backends, { Regexp => "ip:port", ... }
+    def backends=(backends)
+      backends.default = backends.values.first
+      @backends = backends
+    end
+
+    # Connect patterns to the given backend.
+    def connect(backend, *patterns)
+      patterns.each { |p| @routes[p] = backend }
+    end
+
+    # method e.g. "GET", currently unused
+    # path e.g. "/some/path?including=query+string"
+    def lookup(method, path)
+      _, backend = @routes.detect do |pattern, _|
+        path =~ pattern
+      end
+      @backends[backend]
+    end
+
+  end
+end

data/lib/path_router/version.rb

@@ -0,0 +1,3 @@
+module PathRouter
+  VERSION = "0.0.1"
+end

data/lib/path_router.rb

@@ -0,0 +1,2 @@
+module PathRouter
+end

data/path_router.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "path_router/version"
+
+Gem::Specification.new do |s|
+  s.name        = "path_router"
+  s.version     = PathRouter::VERSION
+  s.authors     = ["Paul Annesley"]
+  s.email       = ["paul@annesley.cc"]
+  s.homepage    = ""
+  s.summary     = %q{HTTP routing by URL path, built on ProxyMachine.}
+  s.description = %q{Easily route HTTP requests to different backends by pattern matching the URL path.}
+
+  s.rubyforge_project = "path_router"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "proxymachine", "~> 1.2.4"
+  s.add_development_dependency "rspec"
+end

data/proxymachine_config.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift "./lib"
+require "path_router/router"
+
+module PathRouter
+
+  Signal.trap("USR2") { Router.instance.load_routes }
+
+  Router.instance.load_routes
+
+  proxy do |data|
+    if data =~ %r{^(\w+) (\S+) HTTP/\d.\d\r\n}
+      { remote: Router.instance.lookup($1, $2) }
+    else
+      { noop: true }
+    end
+  end
+
+end

data/spec/path_router_spec.rb

@@ -0,0 +1,36 @@
+require_relative "spec_helper"
+
+module PathRouter
+  describe Router do
+
+    let(:router) do
+      Router.new.tap do |r|
+
+        r.backends = {
+          rails:  "127.0.0.1:3000",
+          static: "127.0.0.1:8080",
+          api:    "api:80"
+        }
+
+        r.connect :static,
+          %r{^/robots.txt},
+          %r{^/(?:images|stylesheets|javascripts)/}
+
+        r.connect :api,
+          %r{^/api/}
+
+      end
+    end
+
+    it "routes by specified patterns" do
+      router.lookup("GET", "/robots.txt").should == "127.0.0.1:8080"
+      router.lookup("GET", "/images/logo.png").should == "127.0.0.1:8080"
+      router.lookup("GET", "/api/list").should == "api:80"
+    end
+
+    it "defaults to first backend for unmatched requests" do
+      router.lookup("GET", "/anything/else").should == "127.0.0.1:3000"
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift "./lib"
+
+require "path_router/router"

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: path_router
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Annesley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: proxymachine
+  requirement: &2169316300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *2169316300
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2169315880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2169315880
+description: Easily route HTTP requests to different backends by pattern matching
+  the URL path.
+email:
+- paul@annesley.cc
+executables:
+- path_router
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/path_router
+- example_path_router.rb
+- lib/path_router.rb
+- lib/path_router/router.rb
+- lib/path_router/version.rb
+- path_router.gemspec
+- proxymachine_config.rb
+- spec/path_router_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: path_router
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: HTTP routing by URL path, built on ProxyMachine.
+test_files:
+- spec/path_router_spec.rb
+- spec/spec_helper.rb