sansom 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c54015af146ba89239c6199fa38f6d32674f274
+  data.tar.gz: 01b09122f5014d586311449942d84962a51b1a89
+SHA512:
+  metadata.gz: 806566785d4903fb29413b9c4606f259b154b2f6dc946139e20341ed69a08385c533818bbd1a5eab8553c3622387a22e51261a910b309e0e22810c0eba4f6733
+  data.tar.gz: 5805d9c95195d8b5b9ce80f20b0dbee5df425877f28ff63dba3f34dee3198969fd3ce4ee57282ec84e8f2c5f82aca291aa71be03fd8df5bc1aedb6542b4d3914

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nathaniel Symer
+
+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,173 @@
+Sansom
+===
+
+Flexible, versatile, light web framework named after Sansom street in Philly.
+
+Installation
+-
+
+Add this line to your application's Gemfile:
+
+    gem '.'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install .
+
+Usage
+-
+
+It's pretty simple. Instead of `Class`s storing routes, `Object`s store routes.
+
+There are two ways you can deploy `Sansom`:
+
+    # app.rb
+    
+    #!/usr/bin/env ruby
+
+	require "sansom"
+
+    s = Sansom.new
+    s.get "/" do |r|
+      # r is a Rack::Request
+      [200, { "Content-Type" => "text/plain" }, ["Hello Sansom"]]
+    end
+    s.start
+
+Or, the more production-ready version:
+
+    # config.ru
+    
+    require "sansom"
+    
+    s = Sansom.new
+    
+    s.get "/" do |r|
+      # r is a Rack::Request
+      [200, { "Content-Type" => "text/plain" }, ["Hello Sansom"]]
+    end
+    
+    run s
+    
+But `Sansom` can do more than just that:
+
+It can be used in a similar fashion to Sinatra:
+
+    # myapi.rb
+    
+    #!/usr/bin/env ruby
+    
+    require "sansom"
+    
+    class MyAPI < Sansom
+      # This method is used to define Sansom routes
+      def template
+        get "/" do |r|
+          [200, { "Content-Type" => "text/plain" }, ["Hello Sansom"]]
+          # r is a Rack::Request
+        end
+      end
+    end
+    
+And your `config.ru` file
+
+    # config.ru
+    
+    require "sansom"
+    require "./myapi"
+    
+    run MyAPI.new
+    
+Sansom can also map other instances of Sansom to a route. Check this:
+    
+    # myapi.rb
+    
+    #!/usr/bin/env ruby
+    
+    require "sansom"
+    
+    class MyAPI < Sansom
+      # This method is used to define Sansom routes
+      def template
+        get "/" do |r|
+          [200, { "Content-Type" => "text/plain" }, ["Hello Sansom"]]
+          # r is a Rack::Request
+        end
+      end
+    end
+    
+Let's say you've written a new version of your api. No problem.
+    
+    # app.rb
+    
+    require "sansom"
+    
+    s = Sansom.new
+    s.map "/v1", MyAPI.new
+    s.map "/v2", MyNewAPI.new
+    s.start
+    
+Or maybe you want to mount your Rails/Sinatra/whatever app
+
+    # app.rb
+    
+    require "sansom"
+    
+    s = Sansom.new
+    s.map "/api", SinatraApp.new
+    s.map "/", RailsApp.new
+    s.start
+    
+Lastly, any object can become a "`Sansom`" through a mixin:
+
+    # mixin.ru
+    
+    class Mixin < Hash
+      include Sansomable
+  
+      def template
+        get "/sansomable" do |r|
+          [200, { "Content-Type" => "text/plain"}, ["Sansomable Hash"]]
+        end
+      end
+    end
+    
+    run Mixin.new
+    
+If you look at how `Sansom` is defined, it makes sense:
+
+    Sansom = Class.new Object
+    Sansom.include Sansomable
+    
+Matching
+-
+
+`Sansom` uses trees to match routes. It follows a certain set of rules:
+
+  - A matching order is enforced:
+  	1. The route matching the path and verb
+  	2. The first Subsansom that matches the route & verb
+  	3. The first mounted non-`Sansom` rack app matching the route
+
+Notes
+-
+
+- `Sansom` does not pollute _any_ `Object` methods, including `initialize`
+- `Sansom` is under **140** lines of code at the time of writing. This includes
+	* Everything above
+	* Custom routing
+
+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 a new Pull Request
+
+**Please make sure you don't add tons and tons of code. Part of `Sansom`'s beauty is is brevity.**

data/examples/generic.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+require "json"
+require "sansom"
+
+class Sansom
+  def food_response r
+    [200, { "Content-Type" => "text/plain"}, [{ :type => self.class.to_s, :name => r.path_info.split("/").reject(&:empty?).last}.to_json]]
+  end
+end
+
+class Meat < Sansom
+  def template
+    get "/pork" do |r|
+      food_response r
+    end
+  end
+end
+
+class NonAnimal < Sansom
+  def template
+    get "/quinoa" do |r|
+      food_response r
+    end
+    
+    get "/tahini" do |r|
+      food_response r
+    end
+    
+    get "/squash" do |r|
+      food_response r
+    end
+  end
+end
+
+class AnimalProducts < Sansom
+  def template
+    get "/eggs" do |r|
+      food_response r
+    end
+  
+    get "/milk" do |r|
+      food_response r
+    end
+  end
+end
+
+class FoodTypes < Sansom
+  def template
+    map "/carnivorous", Meat.new
+    map "/vegetarian", NonAnimal.new
+    map "/vegetarian", AnimalProducts.new
+    map "/vegan", NonAnimal.new
+  end
+end
+
+class Food < Sansom
+  def template
+    get "/sushi" do |r|
+      [200, { "Content-Type" => "text/plain"}, ["Quite delicious, especially cucumber"]]
+    end
+    
+    map "/types", FoodTypes.new
+  end
+end
+
+s = Sansom.new
+
+s.get "/" do |r|
+  [200, { "Content-Type" => "text/plain"}, ["root"]]
+end
+
+s.get "/something" do |r|
+  [200, { "Content-Type" => "text/plain"}, ["something"]]
+end
+
+s.map "/food", Food.new
+
+s.start 2000

data/examples/mixin.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require "sansom"
+
+class Mixin < Hash
+  include Sansomable
+  
+  def template
+    get "/sansomable" do |r|
+      [200, { "Content-Type" => "text/plain"}, ["Sansomable Hash"]]
+    end
+  end
+end
+
+s = Sansom.new
+
+s.get "/" do |r| 
+  [200, { "Content-Type" => "text/plain"}, ["root"]] 
+end
+
+s.map "/mixins", Mixin.new
+s.start 3002

data/lib/sansom.rb

@@ -0,0 +1,139 @@
+#!/usr/bin/env ruby
+
+require "rack"
+require "tree" # rubytree
+
+module Sansomable
+  class TreeContent
+    attr_accessor :items
+    def initialize
+      @items = []
+      @map = {}
+    end
+  
+    def []=(k,v)
+      @items << v if k == :map
+      @map[k] = v unless k == :map
+    end
+    
+    def [](k)
+      @items[k] if Numeric === k
+      @map[k] unless Numeric === k
+    end
+  end
+  
+  InvalidRouteError = Class.new StandardError
+  NoRoutesError = Class.new StandardError
+  InclusionError = Class.new StandardError
+  
+  HTTP_VERBS = ["GET","HEAD","POST","PUT","DELETE","PATCH","OPTIONS"].freeze
+  HANDLERS = ["puma", "unicorn", "thin", "webrick"].freeze
+  NOT_FOUND = [404, {"Content-Type" => "text/plain"}, ["Not found."]].freeze
+
+  def tree
+    @tree ||= nil
+    if @tree.nil?
+      @tree = Tree::TreeNode.new("ROOT", "ROOT")
+      template if respond_to? :template
+    end
+    @tree
+  end
+
+  def match http_method, path
+    components = s_parse_path(path)
+    matched_components = []
+    
+    walk = components.inject(tree) do |node, component| 
+      child = node[component]
+      
+      if child.nil?
+        node
+      else
+        matched_components << component unless component == "/"
+        child
+      end
+    end
+
+    tc = walk.content
+    
+    return nil if tc == "ROOT"
+    
+    matched_path = "/" + matched_components.join("/")
+
+    match = tc[http_method] # Check for route
+    match ||= tc.items.select(&method(:sansom?)).reject { |item| item.match(http_method, s_truncate_path(path, matched_path)).nil? }.first rescue nil # Check subsansoms
+    match ||= tc.items.reject(&method(:sansom?)).first rescue nil # Check for mounted rack apps
+    [match, matched_path]
+  end
+  
+  def call env
+    return NOT_FOUND if tree.children.empty?
+    
+    r = Rack::Request.new env
+
+    m = match r.request_method, r.path_info
+    item = m.first
+    
+    if item.nil?
+      NOT_FOUND
+    elsif Proc === item
+      item.call r
+    elsif sansom? item
+      item.call(env.dup.merge({ "PATH_INFO" => s_truncate_path(r.path_info, m.last) }))
+    else
+      raise InvalidRouteError, "Invalid route handler, it must be a block (proc/lambda) or a subclass of Sansom."
+    end
+  end
+  
+  def start port=3001
+    raise NoRoutesError if tree.children.empty?
+    Rack::Handler.pick(HANDLERS).run self, :Port => port
+  end
+  
+  def method_missing(meth, *args, &block)
+    _args = args.dup.push block
+    super unless _args.count >= 2 
+    
+    path = _args[0].dup
+    item = _args[1].dup
+    
+    return super if item == self
+    
+    verb = meth.to_s.strip.upcase
+    return super unless HTTP_VERBS.include?(verb) || meth == :map
+    verb = :map if meth == :map
+    
+    components = s_parse_path path
+    components.each_with_index.inject(tree) do |node,(component, idx)|
+      child = node[component]
+
+      if child.nil?
+        newvalue = Tree::TreeNode.new(component, TreeContent.new)
+        node << newvalue
+        child = newvalue
+      end
+
+      child.content[verb] = item if idx == components.count-1
+      child
+    end
+  end
+  
+  private
+  
+  def sansom? obj
+    return true if Sansom === obj
+    return true if obj.class.included_modules.include? Sansomable
+    false
+  end
+  
+  def s_parse_path path
+    path.split("/").reject(&:empty?).unshift("/")
+  end
+  
+  def s_truncate_path truncated, truncator
+    "/" + s_parse_path(truncated)[s_parse_path(truncator).count..-1].join("/")
+  end
+end
+
+Sansom = Class.new Object
+Sansom.include Sansomable

data/lib/sansom/version.rb

@@ -0,0 +1,3 @@
+module Sansom
+  VERSION = "0.0.2"
+end

data/sansom.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sansom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sansom"
+  spec.version       = Sansom::VERSION
+  spec.authors       = ["Nathaniel Symer"]
+  spec.email         = ["nate@natesymer.com"]
+  spec.summary       = %q{Flexible, versatile, light web framework named after Sansom street in Philly.}
+  spec.description   = %q{Flexible, versatile, light web framework named after Sansom street in Philly. It's under 140 lines of code & and it's lightning fast.}
+  spec.homepage      = "http://github.com/fhsjaagshs/sansom"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_dependency "rubytree", "~> 0.9"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: sansom
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Nathaniel Symer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-29 00:00:00.000000000 Z
+dependencies:
+- !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: rubytree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Flexible, versatile, light web framework named after Sansom street in
+  Philly. It's under 140 lines of code & and it's lightning fast.
+email:
+- nate@natesymer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- examples/generic.rb
+- examples/mixin.rb
+- lib/sansom.rb
+- lib/sansom/version.rb
+- sansom.gemspec
+homepage: http://github.com/fhsjaagshs/sansom
+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: Flexible, versatile, light web framework named after Sansom street in Philly.
+test_files: []