rack-putty 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2013 Apollic Software, LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+   * Neither the name of Apollic Software, LLC nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,68 @@
+# Rack::Putty
+
+Simple web framework built on rack for mapping sinatra-like routes to middleware stacks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-putty'
+
+## Usage
+
+```ruby
+  require 'rack-putty'
+
+  module YourApp
+    class Router
+      include Rack::Putty::Router
+
+      class SerializeResponse
+        def self.call(env)
+          headers = { 'Content-Type' => 'text/plain' }.merge(env.response_headers || {})
+          if env.response
+            [200, headers, [env.response]]
+          else
+            [404, headers, ['Not Found']]
+          end
+        end
+      end
+
+      class CorsHeaders
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          status, headers, body = @app.call(env)
+          headers.merge!(
+            'Access-Control-Allow-Origin' => '*',
+          ) if env['HTTP_ORIGIN']
+          [status, headers, body]
+        end
+      end
+
+      stack_base SerializeResponse
+      middleware CorsHeaders
+
+      class HelloWorld < Rack::Putty::Middleware
+        def action(env)
+          env.response = 'Hello World'
+          env
+        end
+      end
+
+      get '/' do |builder|
+        builder.use HelloWorld
+      end
+    end
+  end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/rack-putty.rb

@@ -0,0 +1,8 @@
+require "rack-putty/version"
+
+module Rack
+  module Putty
+    autoload :Router, 'rack-putty/router'
+    autoload :Middleware, 'rack-putty/middleware'
+  end
+end

data/lib/rack-putty/middleware.rb

@@ -0,0 +1,18 @@
+module Rack
+  module Putty
+
+    class Middleware
+      def initialize(app, options = {})
+        @app, @options = app, options
+      end
+
+      def call(env)
+        response = action(env)
+
+        # Allow middleware to cause stack to end early
+        response.kind_of?(Hash) ? @app.call(env) : response
+      end
+    end
+
+  end
+end

data/lib/rack-putty/router.rb

@@ -0,0 +1,146 @@
+require 'rack/mount'
+
+class Rack::Mount::RouteSet
+  def merge_routes(routes)
+    routes.each { |r| merge_route(r) }
+    rehash
+  end
+
+  def merge_route(route)
+    @routes << route
+
+    @recognition_key_analyzer << route.conditions
+
+    @named_routes[route.name] = route if route.name
+    @generation_route_keys << route.generation_keys
+
+    expire!
+    route
+  end
+end
+
+module Rack
+  module Putty
+
+    module Router
+      MissingStackBaseError = Class.new(StandardError)
+
+      autoload :ExtractParams, 'rack-putty/router/extract_params'
+
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.routes.rehash
+      end
+
+      def call(env)
+        self.class.routes.call(env)
+      end
+
+      module ClassMethods
+        def stack_base(klass)
+          @stack_base = klass
+        end
+
+        def middleware(klass, *args)
+          @middleware ||= []
+          @middleware << [klass, args]
+        end
+
+        def mount(klass)
+          routes.merge_routes klass.routes.instance_variable_get("@routes")
+        end
+
+        def routes
+          @routes ||= Rack::Mount::RouteSet.new
+        end
+
+        #### This section heavily "inspired" by sinatra
+
+        # Defining a `GET` handler also automatically defines
+        # a `HEAD` handler.
+        def get(path, opts={}, &block)
+          route('GET', path, opts, &block)
+          route('HEAD', path, opts, &block)
+        end
+
+        def put(path, opts={}, &bk)     route 'PUT',     path, opts, &bk end
+        def post(path, opts={}, &bk)    route 'POST',    path, opts, &bk end
+        def patch(path, opts={}, &bk)   route 'PATCH',   path, opts, &bk end
+        def delete(path, opts={}, &bk)  route 'DELETE',  path, opts, &bk end
+        def head(path, opts={}, &bk)    route 'HEAD',    path, opts, &bk end
+        def options(path, opts={}, &bk) route 'OPTIONS', path, opts, &bk end
+
+        def match(path, opts={}, &bk)
+          get(path, opts, &bk)
+          put(path, opts, &bk)
+          post(path, opts, &bk)
+          patch(path, opts, &bk)
+          delete(path, opts, &bk)
+          options(path, opts, &bk)
+        end
+
+        private
+
+        def route(verb, path, options={}, &block)
+          path, params = compile_path(path)
+
+          return if route_exists?(verb, path)
+
+          unless @stack_base
+            raise MissingStackBaseError.new("You need to call `stack_base` with a base app class to be passed to Rack::Builder.new.")
+          end
+
+          builder = Rack::Builder.new(@stack_base)
+          builder.use(ExtractParams, path, params)
+
+          (@middleware || []).each do |i|
+            klass, args = i
+            builder.use(klass, *args)
+          end
+
+          block.call(builder)
+
+          routes.add_route(builder.to_app, :request_method => verb, :path_info => path)
+          routes.rehash
+        end
+
+        def route_exists?(verb, path)
+          @added_routes ||= []
+          return true if @added_routes.include?("#{verb}#{path}")
+          @added_routes << "#{verb}#{path}"
+          false
+        end
+
+        def compile_path(path)
+          keys = []
+          if path.respond_to? :to_str
+            ignore = ""
+            pattern = path.to_str.gsub(/[^\?\%\\\/\:\*\w]/) do |c|
+              ignore << escaped(c).join if c.match(/[\.@]/)
+              encoded(c)
+            end
+            pattern.gsub!(/((:\w+)|\*)/) do |match|
+              if match == "*"
+                keys << 'splat'
+                "(.*?)"
+              else
+                keys << $2[1..-1]
+                "([^#{ignore}/?#]+)"
+              end
+            end
+            [/\A#{pattern}\z/, keys]
+          elsif path.respond_to?(:keys) && path.respond_to?(:match)
+            [path, path.keys]
+          elsif path.respond_to?(:names) && path.respond_to?(:match)
+            [path, path.names]
+          elsif path.respond_to? :match
+            [path, keys]
+          else
+            raise TypeError, path
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/rack-putty/router/extract_params.rb

@@ -0,0 +1,69 @@
+module Rack
+  module Putty
+
+    module Router
+
+      class ExtractParams
+        attr_accessor :pattern, :keys
+
+        def initialize(app, pattern, keys)
+          @app, @pattern, @keys = app, pattern, keys
+        end
+
+        def call(env)
+          add_request(env)
+          extract_params(env)
+          @app.call(env)
+        end
+
+        private
+
+        def add_request(env)
+          env['request'] = Rack::Request.new(env)
+        end
+
+        def extract_params(env)
+          route = env[Rack::Mount::Prefix::KEY]
+          route = '/' if route.empty?
+          return unless match = pattern.match(route)
+          values = match.captures.to_a.map { |v| URI.decode_www_form_component(v) if v }
+
+          params = env['request'].params.dup
+
+          if env['CONTENT_TYPE'] =~ /\Amultipart/
+            env['data'] = params.select { |k,v| Hash === v && v.has_key?(:filename) }
+            params = params.reject { |k,v| Hash === v && v.has_key?(:filename) }
+          end
+
+          if values.any?
+            params.merge!('captures' => values)
+            keys.zip(values) { |k,v| Array === params[k] ? params[k] << v : params[k] = v if v }
+          end
+
+          env['params'] = indifferent_params(params)
+        end
+
+        # Enable string or symbol key access to the nested params hash.
+        def indifferent_params(object)
+          case object
+          when Hash
+            new_hash = indifferent_hash
+            object.each { |key, value| new_hash[key] = indifferent_params(value) }
+            new_hash
+          when Array
+            object.map { |item| indifferent_params(item) }
+          else
+            object
+          end
+        end
+
+        # Creates a Hash with indifferent access.
+        def indifferent_hash
+          Hash.new {|hash,key| hash[key.to_s] if Symbol === key }
+        end
+      end
+
+    end
+
+  end
+end

data/lib/rack-putty/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Putty
+    VERSION = "0.0.1"
+  end
+end

data/rack-putty.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack-putty/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rack-putty"
+  gem.version       = Rack::Putty::VERSION
+  gem.authors       = ["Jonathan Rudenberg", "Jesse Stuart"]
+  gem.email         = ["jonathan@titanous.com", "jesse@jessestuart.ca"]
+  gem.description   = %q{Simple web framework built on rack for mapping sinatra-like routes to middleware stacks.}
+  gem.summary       = %q{Simple web framework built on rack.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'rack-mount', '~> 0.8.3'
+
+  gem.add_development_dependency 'rack-test', '~> 0.6.1'
+  gem.add_development_dependency 'rspec', '~> 2.11'
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake'
+end

data/spec/integration/router_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+require 'json'
+
+describe Rack::Putty::Router do
+  include Rack::Test::Methods
+
+  class SerializeResponse
+    def self.call(env)
+      headers = { 'Content-Type' => 'text/plain' }.merge(env['response_headers'] || {})
+      if env['response']
+        [200, headers, [serialize_response(headers, env['response'])]]
+      else
+        [404, headers, ['Not Found']]
+      end
+    end
+
+    def self.serialize_response(headers, response)
+      if headers['Content-Type'] =~ /json/
+        response.to_json
+      end
+    end
+  end
+
+  class TestMiddleware < Rack::Putty::Middleware
+    def action(env)
+      env['response'] ||= {}
+      env['response']['params'] = env['params']
+      env['response_headers'] = { 'Content-Type' => 'application/json' }
+      env
+    end
+  end
+
+  class OtherTestMiddleware < Rack::Putty::Middleware
+    def action(env)
+      env['response'] ||= {}
+      env['response'][@options[:key]] = @options[:val]
+      env
+    end
+  end
+
+  class TestMiddlewarePrematureResponse < Rack::Putty::Middleware
+    def action(env)
+      [200, { 'Content-Type' => 'text/plain' }, ['Premature-Response']]
+    end
+  end
+
+  class TestMountedApp
+    include Rack::Putty::Router
+
+    stack_base SerializeResponse
+    middleware OtherTestMiddleware, :key => 'foo', :val => 'bar'
+    middleware OtherTestMiddleware, :key => 'biz', :val => 'baz'
+
+    get '/chunky/:bacon' do |b|
+      b.use TestMiddleware
+    end
+  end
+
+  class PrefixMountedApp
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      myprefix = '/prefix'
+
+      if env['PATH_INFO'].start_with?(myprefix)
+        env['SCRIPT_NAME'] = env['SCRIPT_NAME'][0..-2] if env['SCRIPT_NAME'].end_with?('/') # strip trailing slash
+        env['SCRIPT_NAME'] += myprefix
+
+        env['PATH_INFO'].sub! myprefix, ''
+        @app.call(env)
+      end
+    end
+  end
+
+  class TestApp
+    include Rack::Putty::Router
+
+    stack_base SerializeResponse
+
+    get '/foo/:bar' do |b|
+      b.use TestMiddleware
+    end
+
+    get '/premature/response' do |b|
+      b.use TestMiddlewarePrematureResponse
+      b.use TestMiddleware
+    end
+
+    post %r{^/foo/([^/]+)/bar} do |b|
+      b.use TestMiddleware
+    end
+
+    mount TestMountedApp
+  end
+
+  def app
+    TestApp.new
+  end
+
+  let(:env) { {} }
+
+  context "as a mounted app with a prefix" do
+    let(:app) { PrefixMountedApp.new(TestApp.new) }
+
+    it "still matches the path name" do
+      get '/prefix/foo/baz', {}, env
+      expect(last_response.status).to eq(200)
+      expect(JSON.parse(last_response.body)['params']['bar']).to eq('baz')
+    end
+  end
+
+  it "should extract params" do
+    get '/foo/baz', nil, env
+    expect(last_response.status).to eq(200)
+    expect(JSON.parse(last_response.body)['params']['bar']).to eq('baz')
+  end
+
+  it "should merge both sets of params" do
+    post '/foo/baz/bar?chunky=bacon', {}, env
+    expect(last_response.status).to eq(200)
+    actual_body = JSON.parse(last_response.body)
+    expect(actual_body['params']['chunky']).to eq('bacon')
+    expect(actual_body['params']['captures']).to include('baz')
+  end
+
+  it "should work with mount" do
+    get '/chunky/crunch', {}, env
+    expect(last_response.status).to eq(200)
+    body = JSON.parse(last_response.body)
+    expect(body['params']['bacon']).to eq('crunch')
+    expect(body['foo']).to eq('bar')
+    expect(body['biz']).to eq('baz')
+  end
+
+  it "should allow middleware to prematurely respond" do
+    get '/premature/response', {}, env
+    expect(last_response.body).to eq('Premature-Response')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'bundler/setup'
+require 'rack/test'
+
+require 'rack-putty'
+
+ENV['RACK_ENV'] ||= 'test'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: rack-putty
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Rudenberg
+- Jesse Stuart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-mount
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple web framework built on rack for mapping sinatra-like routes to
+  middleware stacks.
+email:
+- jonathan@titanous.com
+- jesse@jessestuart.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-putty.rb
+- lib/rack-putty/middleware.rb
+- lib/rack-putty/router.rb
+- lib/rack-putty/router/extract_params.rb
+- lib/rack-putty/version.rb
+- rack-putty.gemspec
+- spec/integration/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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple web framework built on rack.
+test_files:
+- spec/integration/router_spec.rb
+- spec/spec_helper.rb