syro 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c674acd1e5f50201c1a6d8ba682f73376922bf06
+  data.tar.gz: cf8130872298e53a52b0da3358c8c7929b81ce4b
+SHA512:
+  metadata.gz: 8fb83225dc60423a43c56147159e679be6349a5da972ba9183b7bcbfe12091c630046c8e0f28d9570609f1bf64e082802c7aac7c42ac56c4025dd796cd0b08b9
+  data.tar.gz: a9ed177ed81d563450db71b2b30053ee2bf8c11f40dc1df3778de92de71ec7b3606895cc90413aba84af78bdb435c00fbee85483aecabefb2674bb94aec3dc01

data/.gems

@@ -0,0 +1,4 @@
+rack -v 1.6.0
+rack-test -v 0.6.3
+cutest -v 1.2.2
+seg -v 0.0.1

data/CONTRIBUTING

@@ -0,0 +1,19 @@
+This code tries to solve a particular problem with a very simple
+implementation. We try to keep the code to a minimum while making
+it as clear as possible. The design is very likely finished, and
+if some feature is missing it is possible that it was left out on
+purpose. That said, new usage patterns may arise, and when that
+happens we are ready to adapt if necessary.
+
+A good first step for contributing is to meet us on IRC and discuss
+ideas. We spend a lot of time on #lesscode at freenode, always ready
+to talk about code and simplicity. If connecting to IRC is not an
+option, you can create an issue explaining the proposed change and
+a use case. We pay a lot of attention to use cases, because our
+goal is to keep the code base simple. Usually the result of a
+conversation is the creation of a different tool.
+
+Please don't start the conversation with a pull request. The code
+should come at last, and even though it may help to convey an idea,
+more often than not it draws the attention to a particular
+implementation.

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Michel Martens
+
+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,211 @@
+Syro
+====
+
+Simple router for web applications.
+
+Description
+-----------
+
+Syro is a very simple router for web applications. It was created
+in the tradition of libraries like [Rum][rum] and [Cuba][cuba], but
+it promotes a less flexible usage pattern. The design is inspired
+by the way some Cuba applications are architected: modularity is
+encouraged and sub-applications can be dispatched without any
+significant performance overhead.
+
+[rum]: http://github.com/chneukirchen/rum
+[cuba]: http://cuba.is
+
+Usage
+-----
+
+An example of a modular application would look like this:
+
+```ruby
+admin = Syro.new {
+  get {
+    res.write "Hello from admin!"
+  }
+}
+
+app = Syro.new {
+  on("admin") {
+    run(admin)
+  }
+}
+```
+
+The block is evaluated in a sandbox where the following methods are
+available: `env`, `req`, `res`, `inbox`, `call`, `run`, `halt`,
+`match`, `on`, `root?`, `root`, `get?`, `post?`, `patch?`, `delete?`,
+`get`, `post`, `patch` and `delete`.
+
+As a recommendation, user created variables should be instance
+variables. That way they won't mix with the API methods defined in
+the sandbox. All the internal instance variables defined by Syro
+are prefixed by `syro_`, like in `@syro_inbox`.
+
+API
+---
+
+`env`: Environment variables for the request.
+
+`req`: Helper object for accessing the request variables. It's an
+instance of `Rack::Request`.
+
+`res`: Helper object for creating the response. It's an instance
+of `Syro::Response`.
+
+`inbox`: Hash with captures and potentially other variables local
+to the request.
+
+`call`: Entry point for the application. It receives the environment
+and optionally an inbox.
+
+`run`: Runs a sub app, and accepts an inbox as an optional second
+argument.
+
+`halt`: Terminates the request. It receives an array with the
+response as per Rack's specification.
+
+`match`: Receives a String, a Symbol or a boolean, and returns true
+if it matches the request.
+
+`on`: Receives a value to be matched, and a block that will be
+executed only if the request is matched.
+
+`root?`: Returns true if the path yet to be consumed is empty.
+
+`root`: Receives a block and calls it only if `root?` is true.
+
+`get?`: Returns true if the `REQUEST_METHOD` is `GET`.
+
+`get`: Receives a block and calls it only if `root?` and `get?` are
+true.
+
+`post?`: Returns true if the `REQUEST_METHOD` is `POST`.
+
+`post`: Receives a block and calls it only if `root?` and `post?`
+are true.
+
+`patch?`: Returns true if the `REQUEST_METHOD` is `PATCH`.
+
+`patch`: Receives a block and calls it only if `root?` and `patch?`
+are true.
+
+`delete?`: Returns true if the `REQUEST_METHOD` is `DELETE`.
+
+`delete`: Receives a block and calls it only if `root?` and `delete?`
+are true.
+
+Examples
+--------
+
+In the following examples, the response string represents
+the request path that was sent.
+
+```ruby
+app = Syro.new {
+  get {
+    res.write "GET /"
+  }
+
+  post {
+    res.write "POST /"
+  }
+
+  on("users") {
+    on(:id) {
+
+      # Captured values go to the inbox
+      @user = User[inbox[:id]]
+
+      get {
+        res.write "GET /users/42"
+      }
+
+      patch {
+        res.write "PATCH /users/42"
+      }
+
+      delete {
+        res.write "DELETE /users/42"
+      }
+    }
+
+    get {
+      res.write "GET /users"
+    }
+
+    post {
+      res.write "POST /users"
+    }
+  }
+}
+```
+
+Matches
+-------
+
+The `on` method can receive a `String` to perform path matches; a
+`Symbol` to perform path captures; and a boolean to match any true
+values.
+
+Each time `on` matches or captures a segment of the PATH, that part
+of the path is consumed. The current and previous paths can be
+queried by calling `prev` and `curr` on the `path` object: `path.prev`
+returns the part of the path already consumed, and `path.curr`
+provides the current version of the path.
+
+Any expression that evaluates to a boolean can also be used as a
+matcher.  For example, a common pattern is to follow some route
+only if a user is authenticated. That can be accomplished with
+`on(authenticated(User))`. That example assumes there's a method
+called `authenticated` that returns true or false depending on
+whether or not an instance of `User` is authenticated. As a side
+note, [Shield][shield] is a library that provides just that.
+
+[shield]: https://github.com/cyx/shield
+
+Captures
+--------
+
+When a symbol is provided, `on` will try to consume a segment of
+the path. A segment is defined as any sequence of characters after
+a slash and until either another slash or the end of the string.
+The captured value is stored in the `inbox` hash under the key that
+was provided as the argument to `on`. For example, after a call to
+`on(:user_id)`, the value for the segment will be stored at
+`inbox[:user_id]`. When mounting an application called `users` with
+the command `run(users)`, an inbox can be provided as the second
+argument: `run(users, inbox)`. That allows apps to share previous
+captures.
+
+Security
+--------
+
+There are no security features built into this routing library. A
+framework using this library should implement the security layer.
+
+Rendering
+---------
+
+There are no rendering features built into this routing library. A
+framework that uses this routing library can easily implement helpers
+for rendering.
+
+Trivia
+------
+
+The name comes from SImple ROuter, so it more or less rhymes with
+"zero". An initial idea was to release a new version of Cuba that
+broke backward compatibility, but in the end my friends suggested
+to release this as a separate library. In the future, some ideas
+of this library could be included in Cuba as well.
+
+Installation
+------------
+
+```
+$ gem install syro
+```

data/lib/syro.rb

@@ -0,0 +1,257 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2015 Michel Martens
+# 
+# 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.
+
+require "rack"
+require "seg"
+
+class Syro
+
+  # Method override parameter
+  OVERRIDE = "_method".freeze
+
+  # HTTP environment variables
+  PATH_INFO = "PATH_INFO".freeze
+  SCRIPT_NAME = "SCRIPT_NAME".freeze
+  REQUEST_METHOD = "REQUEST_METHOD".freeze
+
+  # Response headers
+  LOCATION = "Location".freeze
+  CONTENT_TYPE = "Content-Type".freeze
+  CONTENT_LENGTH = "Content-Length".freeze
+  CONTENT_TYPE_DEFAULT = "text/html".freeze
+
+  # Request methods
+  GET = 'GET'.freeze
+  POST = 'POST'.freeze
+  PATCH = 'PATCH'.freeze
+  DELETE = 'DELETE'.freeze
+
+  # Available methods
+  METHODS = [GET, POST, PATCH, DELETE].freeze
+
+  class Response
+    attr_accessor :status
+
+    attr :body
+    attr :headers
+
+    def initialize(headers = {})
+      @status  = nil
+      @headers = headers
+      @body    = []
+      @length  = 0
+    end
+
+    def [](key)
+      @headers[key]
+    end
+
+    def []=(key, value)
+      @headers[key] = value
+    end
+
+    def write(str)
+      s = str.to_s
+
+      @length += s.bytesize
+      @headers[Syro::CONTENT_LENGTH] = @length.to_s
+      @body << s
+    end
+
+    def redirect(path, status = 302)
+      @headers[Syro::LOCATION] = path
+      @status  = status
+    end
+
+    def finish
+      [@status, @headers, @body]
+    end
+
+    def set_cookie(key, value)
+      Rack::Utils.set_cookie_header!(@headers, key, value)
+    end
+
+    def delete_cookie(key, value = {})
+      Rack::Utils.delete_cookie_header!(@headers, key, value)
+    end
+  end
+
+  class Sandbox
+    def initialize(code)
+      @syro_code = code
+    end
+
+    def env
+      @syro_env
+    end
+
+    def req
+      @syro_req
+    end
+
+    def res
+      @syro_res
+    end
+
+    def path
+      @syro_path
+    end
+
+    def inbox
+      @syro_inbox
+    end
+
+    def call(env, inbox)
+      @syro_env = env
+      @syro_req = Rack::Request.new(env)
+      @syro_res = Syro::Response.new({})
+      @syro_path = Seg.new(env.fetch(Syro::PATH_INFO))
+      @syro_inbox = inbox
+
+
+      if env[Syro::REQUEST_METHOD] == Syro::POST
+        value = @syro_req.POST[Syro::OVERRIDE]
+
+        if value != nil
+          env[Syro::REQUEST_METHOD] = value.upcase
+        end
+      end
+
+      @syro_method = Syro::METHODS.index(env[Syro::REQUEST_METHOD])
+
+      result = catch(:halt) do
+        instance_eval(&@syro_code)
+
+        @syro_res.status = 404
+        @syro_res.finish
+      end
+
+      if result[0].nil?
+        if result[2].empty?
+          result[0] = 404
+        else
+          result[1][Syro::CONTENT_TYPE] ||=
+                    Syro::CONTENT_TYPE_DEFAULT
+          result[0] = 200
+        end
+      end
+
+      result
+    end
+
+    def run(app, inbox = {})
+      env[Syro::PATH_INFO] = @syro_path.curr
+      env[Syro::SCRIPT_NAME] = @syro_path.prev
+
+      halt(app.call(env, inbox))
+    end
+
+    def halt(response)
+      throw(:halt, response)
+    end
+
+    def match(arg)
+      case arg
+      when String then @syro_path.consume(arg)
+      when Symbol then @syro_path.capture(arg, inbox)
+      when true   then true
+      else false
+      end
+    end
+
+    def on(arg)
+      if match(arg)
+        yield
+
+        halt(res.finish)
+      end
+    end
+
+    def root?
+      @syro_path.root?
+    end
+
+    def root
+      if root?
+        yield
+
+        halt(res.finish)
+      end
+    end
+
+    def get?
+      @syro_method == 0
+    end
+
+    def post?
+      @syro_method == 1
+    end
+
+    def patch?
+      @syro_method == 2
+    end
+
+    def delete?
+      @syro_method == 3
+    end
+
+    def get
+      if root? && get?
+        yield
+
+        halt(res.finish)
+      end
+    end
+
+    def post
+      if root? && post?
+        yield
+
+        halt(res.finish)
+      end
+    end
+
+    def patch
+      if root? && patch?
+        yield
+
+        halt(res.finish)
+      end
+    end
+
+    def delete
+      if root? && delete?
+        yield
+
+        halt(res.finish)
+      end
+    end
+  end
+
+  def initialize(&block)
+    @sandbox = Sandbox.new(block)
+  end
+
+  def call(env, inbox = {})
+    @sandbox.call(env, inbox)
+  end
+end

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest -r ./test/helper.rb ./test/*.rb

data/syro.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name              = "syro"
+  s.version           = "0.0.1"
+  s.summary           = "Simple router"
+  s.description       = "Simple router for web applications"
+  s.authors           = ["Michel Martens"]
+  s.email             = ["michel@soveran.com"]
+  s.homepage          = "https://github.com/soveran/syro"
+  s.license           = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "seg"
+  s.add_dependency "rack"
+  s.add_development_dependency "cutest"
+  s.add_development_dependency "rack-test"
+end

data/test/all.rb

@@ -0,0 +1,159 @@
+admin = Syro.new {
+  get {
+    res.write "GET /admin"
+  }
+}
+
+platforms = Syro.new {
+  @id = inbox.fetch(:id)
+
+  get {
+    res.write "GET /platforms/#{@id}"
+  }
+}
+
+comments = Syro.new {
+  get {
+    res.write sprintf("GET %s/%s/comments",
+      inbox[:path],
+      inbox[:post_id])
+  }
+}
+
+app = Syro.new {
+  get {
+    res.write "GET /"
+  }
+
+  post {
+    on(req.POST["user"] != nil) {
+      res.write "POST / (user)"
+    }
+
+    on(true) {
+      res.write "POST / (none)"
+    }
+  }
+
+  on("foo") {
+    on("bar") {
+      on("baz") {
+        res.write("error")
+      }
+
+      get {
+        res.write("GET /foo/bar")
+      }
+
+      post {
+        res.write("POST /foo/bar")
+      }
+
+      patch {
+        res.write("PATCH /foo/bar")
+      }
+
+      delete {
+        res.write("DELETE /foo/bar")
+      }
+    }
+  }
+
+  on("bar/baz") {
+    get {
+      res.write("GET /bar/baz")
+    }
+  }
+
+  on("admin") {
+    run(admin)
+  }
+
+  on("platforms") {
+    run(platforms, id: 42)
+  }
+
+  on("users") {
+    on(:id) {
+      res.write(sprintf("GET /users/%s", inbox[:id]))
+    }
+  }
+
+  on("posts") {
+    @path = path.prev
+
+    on(:post_id) {
+      on("comments") {
+        run(comments, inbox.merge(path: @path))
+      }
+    }
+  }
+}
+
+setup do
+  Driver.new(app)
+end
+
+test "path + verb" do |f|
+  f.get("/foo/bar")
+  assert_equal 200, f.last_response.status
+  assert_equal "GET /foo/bar", f.last_response.body
+
+  f.patch("/foo/bar")
+  assert_equal 200, f.last_response.status
+  assert_equal "PATCH /foo/bar", f.last_response.body
+
+  f.post("/foo/bar")
+  assert_equal 200, f.last_response.status
+  assert_equal "POST /foo/bar", f.last_response.body
+
+  f.delete("/foo/bar")
+  assert_equal 200, f.last_response.status
+  assert_equal "DELETE /foo/bar", f.last_response.body
+end
+
+test "verbs match only on root" do |f|
+  f.get("/bar/baz/foo")
+  assert_equal "", f.last_response.body
+  assert_equal 404, f.last_response.status
+end
+
+test "mounted app" do |f|
+  f.get("/admin")
+  assert_equal "GET /admin", f.last_response.body
+  assert_equal 200, f.last_response.status
+end
+
+test "mounted app + inbox" do |f|
+  f.get("/platforms")
+  assert_equal "GET /platforms/42", f.last_response.body
+  assert_equal 200, f.last_response.status
+end
+
+test "root" do |f|
+  f.get("/")
+  assert_equal "GET /", f.last_response.body
+  assert_equal 200, f.last_response.status
+end
+
+test "captures" do |f|
+  f.get("/users/42")
+  assert_equal "GET /users/42", f.last_response.body
+  assert_equal 200, f.last_response.status
+end
+
+test "post values" do |f|
+  f.post("/", "user" => { "username" => "foo" })
+  assert_equal "POST / (user)", f.last_response.body
+  assert_equal 200, f.last_response.status
+
+  f.post("/")
+  assert_equal "POST / (none)", f.last_response.body
+  assert_equal 200, f.last_response.status
+end
+
+test "inherited inbox" do |f|
+  f.get("/posts/42/comments")
+  assert_equal "GET /posts/42/comments", f.last_response.body
+  assert_equal 200, f.last_response.status
+end

data/test/helper.rb

@@ -0,0 +1,15 @@
+require_relative "../lib/syro"
+require "rack/test"
+
+class Driver
+  include Rack::Test::Methods
+
+  def initialize(app)
+    @app = app
+  end
+
+  def app
+    @app
+  end
+end
+

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: syro
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: seg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple router for web applications
+email:
+- michel@soveran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gems
+- CHANGELOG
+- CONTRIBUTING
+- LICENSE
+- README.md
+- lib/syro.rb
+- makefile
+- syro.gemspec
+- test/all.rb
+- test/helper.rb
+homepage: https://github.com/soveran/syro
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Simple router
+test_files: []