soar_sc-rack-router 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea1b4cfbce696717b0a1ba75823c3dc7eb1ce77b
+  data.tar.gz: af2320579e449daa1b2716fbbbb4b7a7b6a15f1c
+SHA512:
+  metadata.gz: 9e412c1fbb014a7743f5950bf9a1aadd03f7b9aff5f827a1cedfd38ed66fa66582a2b67ad204f59991b89092c3e757b05a74b5e06731c92f29a6cafa8a9780f7
+  data.tar.gz: edb1ecd42f5ec8a6a3699deeaf7516cc306b01a7212a5005289087bc8ab675daa787876e2b6ec5b72532208ae43ede486a328017789536bc9c783e5a8d41b967

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in soar_sc-rack-router.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sheldon Hearn
+
+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,117 @@
+# SoarSc::Rack::Router
+
+SoarSc::Rack::Router is a middleware-centric rack router. It has three key features:
+
+* It is implemented as middleware.
+* Its routing actions are rack apps (possibly supporting middleware through Rack::Builder).
+* It supports parameterized URLs.
+
+Because it is implemented as middleware, it supports fall-through. Therefore, it is possible to layer multiple routers into a single stack.
+
+Because its routing actions are rack apps, it supports the selection of different stacks of middleware for different routes in a single router.
+
+Because it supports parameterized URLs, it is familiar to users of several Ruby web frameworks, but also supports trivial translation of routes
+into WADL and other service descriptions. The parameter support is compatible with Rack::Request, without pushing a dependency on Rack::Request
+down into the router action API; the only requirement for router actions is that they are rack apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar_sc-rack-router'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar_sc-rack-router
+
+## Usage
+
+The following are not examples of sensible ways to structure your router actions. They just demonstrate the SoarSc::Rack::Router API.
+
+An example of a mult-router stack:
+
+```ruby
+require 'soar_sc/rack/router'
+
+stack = Rack::Builder.new do
+  use SoarSc::Rack::Router do
+    map "/", ->(env) { ... }
+  end
+
+  use Authentication
+
+  use SoarSc::Rack::Router do
+    get "/business/:id", ->(env) { ... }
+    post "/business", ->(env) { ... }
+  end
+
+  run ->(env) [404, {'Content-Type' => 'text/plain'}, ['Object Not Found']]
+end
+
+run stack
+```
+
+An example of stacked routing actions under a single router:
+
+```ruby
+require 'soar_sc/rack/router'
+
+stack = Rack::Builder.new do
+  use SoarSc::Rack::Router do
+    map "/", ->(env) { ... }
+    get "/business/:id", Rack::Builder.new do
+      use Authentication
+      run ->(...)
+    end
+    post "/business", Rack::Builder.new do
+      use Authentication
+      use Auditing
+      run ->(...)
+    end
+
+    run ->(env) [404, {'Content-Type' => 'text/plain'}, ['Object Not Found']]
+  end
+end
+```
+
+An example of parameterized URL support:
+
+```ruby
+require 'soar_sc/rack/router'
+
+stack = Rack::Builder.new do
+  use SoarSc::Rack::Router do
+    get "/product/:id", ->(env) {
+      id = Rack::Request.new(env).params["id"]
+      ...
+    }
+    end
+  end
+
+  run ->(env) [404, {'Content-Type' => 'text/plain'}, ['Object Not Found']]
+end
+
+run stack
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hetznerZA/soar_sc-rack-router.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "soar_sc/rack/router"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/soar_sc/rack/router/builder_syntax.rb

@@ -0,0 +1,47 @@
+module SoarSc
+  module Rack
+    class Router
+
+      module BuilderSyntax
+
+        def map(path, app)
+          add_route(Route.new('*', path, app))
+        end
+
+        def get(path, app)
+          add_route(Route.new('GET', path, app))
+        end
+
+        def post(path, app)
+          add_route(Route.new('POST', path, app))
+        end
+
+        def put(path, app)
+          add_route(Route.new('PUT', path, app))
+        end
+
+        def delete(path, app)
+          add_route(Route.new('DELETE', path, app))
+        end
+
+        def options(path, app)
+          add_route(Route.new('OPTIONS', path, app))
+        end
+
+        def head(path, app)
+          add_route(Route.new('HEAD', path, app))
+        end
+
+        def trace(path, app)
+          add_route(Route.new('TRACE', path, app))
+        end
+
+        def connect(path, app)
+          add_route(Route.new('CONNECT', path, app))
+        end
+
+      end
+
+    end
+  end
+end

data/lib/soar_sc/rack/router/errors.rb

@@ -0,0 +1,13 @@
+module SoarSc
+  module Rack
+    class Router
+
+      class DuplicateRouteError < RuntimeError
+        def self.for_route(route)
+          new("Duplicate route for method #{route.method} on #{route.path}")
+        end
+      end
+
+    end
+  end
+end

data/lib/soar_sc/rack/router/route.rb

@@ -0,0 +1,51 @@
+module SoarSc
+  module Rack
+    class Router
+
+      class Route
+        attr_reader :method, :path, :action
+
+        def initialize(method, path, action)
+          @method, @path, @action = method, path, action
+        end
+
+        def static?
+          components(path).none? { |c| c.start_with?(":") }
+        end
+
+        def matches?(env)
+          return false unless (method == env["REQUEST_METHOD"] or method == "*")
+
+          req_components = components(request_path(env))
+          components(path).each_with_index do |c, i|
+            return false unless c.start_with?(":") or c == req_components[i]
+          end
+
+          return true
+        end
+
+        def extract_path_parameters(env)
+          req_components = components(request_path(env))
+          parameters = {}
+          components(path).each_with_index do |c, i|
+            parameters[c[1..-1]] = req_components[i] if c.start_with?(":")
+          end
+          parameters
+        end
+
+        private
+
+        def request_path(env)
+          env["SCRIPT_NAME"].to_s + env["PATH_INFO"].to_s
+        end
+
+        def components(path)
+          path.split('/')
+        end
+
+      end
+
+    end
+  end
+end
+

data/lib/soar_sc/rack/router/version.rb

@@ -0,0 +1,7 @@
+module SoarSc
+  module Rack
+    class Router
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/soar_sc/rack/router.rb

@@ -0,0 +1,53 @@
+require "soar_sc/rack/router/builder_syntax"
+require "soar_sc/rack/router/errors"
+require "soar_sc/rack/router/route"
+require "soar_sc/rack/router/version"
+
+require "uri"
+
+module SoarSc
+  module Rack
+    class Router
+
+      include BuilderSyntax
+
+      def initialize(app, routes = {}, &block)
+        @app = app
+        @static_routes = []
+        @parameterized_routes = []
+        routes.each { |(p, a)| add_route(Route.new('*', p, a)) }
+        instance_eval(&block) if block_given?
+      end
+
+      def call(env)
+        if route = @static_routes.detect { |r| r.matches?(env) }
+          route.action.call(env)
+        elsif route = @parameterized_routes.detect { |r| r.matches?(env) }
+          route.extract_path_parameters(env).each { |p, v| update_path_parameter!(env, p, v) }
+          route.action.call(env)
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+
+      # Called by BuilderSyntax methods
+      def add_route(route)
+        if (@static_routes + @parameterized_routes).detect { |r| r.path == route.path and (r.method == route.method or r.method = "*") }
+          raise DuplicateRouteError.for_route(route)
+        elsif route.static?
+          @static_routes << route
+        else
+          @parameterized_routes << route
+        end
+      end
+
+      def update_path_parameter!(env, param, value)
+        env["QUERY_STRING"] << "&" unless env["QUERY_STRING"].empty?
+        env["QUERY_STRING"] << "#{param}=#{URI.escape(value)}"
+      end
+
+    end
+  end
+end

data/soar_sc-rack-router.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_sc/rack/router/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soar_sc-rack-router"
+  spec.version       = SoarSc::Rack::Router::VERSION
+  spec.authors       = ["Sheldon Hearn"]
+  spec.email         = ["sheldonh@starjuice.net"]
+
+  spec.summary       = %q{Rack routing middleware}
+  spec.description   = %q{Rack routing middleware supporting rack apps as actions, and parameterized paths}
+  spec.homepage      = "https://github.com/hetznerZA/soar_sc-rack-router"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", "~> 1.6"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: soar_sc-rack-router
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sheldon Hearn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Rack routing middleware supporting rack apps as actions, and parameterized
+  paths
+email:
+- sheldonh@starjuice.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soar_sc/rack/router.rb
+- lib/soar_sc/rack/router/builder_syntax.rb
+- lib/soar_sc/rack/router/errors.rb
+- lib/soar_sc/rack/router/route.rb
+- lib/soar_sc/rack/router/version.rb
+- soar_sc-rack-router.gemspec
+homepage: https://github.com/hetznerZA/soar_sc-rack-router
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rack routing middleware
+test_files: []
+has_rdoc: