syro 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72ccaea865ce6b7f9dd3c646ff3fffbe74ef3a26
-  data.tar.gz: 0254961f899a3579960d806aaeee163517064c09
+  metadata.gz: 42c57c65ec35da48059c8844925b6baa1a3a3897
+  data.tar.gz: cee94b2f71a5eeea0a07fee70d9d923d5720df7c
 SHA512:
-  metadata.gz: 1450ad36901c308e28a71ea2a085df6d9803ccfa095dec59bd55cc27f65339d0c876e957faebb9e0579de7f21fda9181c516e979d040a4ec7e7b635e88d8c057
-  data.tar.gz: 936d26d701776b2064a5913b686f5660efb389399500048262ebd78357cd377b6960ccb9792b57524cbd10f6b4fe85cf4fedce7b20ad0bb09183180c4bdb3e9c
+  metadata.gz: 79191f17a6cb4b4bdf8c2b4a8456e59ec15f5cc1ac33911502117103ad122f3a492fb80b359e6990754b8a1cd049b50da0a2b813355fd869d8e88052922e7a4f
+  data.tar.gz: 97ab83421c8cb0b3772404d91494f6e08389cc96d85542e4c1f355ac0bd2a9222654e530a7180902f184f4241b7085eaeee8ba6e05420d9420fe18b6b7103c54

data/CHANGELOG

@@ -1,3 +1,9 @@
+1.1.0
+
+* Move Deck methods to the Deck::API module
+
+* Add support for custom response and request classes
+
 1.0.0
 
 * Yield captures as an alternative API

data/lib/syro.rb

@@ -27,12 +27,34 @@ class Syro
   INBOX = "syro.inbox".freeze
 
   class Response
-    LOCATION = "Location".freeze
-    DEFAULT = "text/html".freeze
-
+    LOCATION = "Location".freeze # :nodoc:
+    DEFAULT = "text/html".freeze # :nodoc:
+
+    # The status of the response.
+    #
+    #     res.status = 200
+    #     res.status # => 200
+    #
     attr_accessor :status
 
+    # Returns the body of the response.
+    #
+    #     res.body
+    #     # => []
+    #
+    #     res.write("there is")
+    #     res.write("no try")
+    #
+    #     res.body
+    #     # => ["there is", "no try"]
+    #
     attr :body
+
+    # Returns a hash with the response headers.
+    #
+    #     res.headers
+    #     # => { "Content-Type" => "text/html", "Content-Length" => "42" }
+    #
     attr :headers
 
     def initialize(headers = {})
@@ -42,14 +64,37 @@ class Syro
       @length  = 0
     end
 
+    # Returns the response header corresponding to `key`.
+    #
+    #     res["Content-Type"]   # => "text/html"
+    #     res["Content-Length"] # => "42"
+    #
     def [](key)
       @headers[key]
     end
 
+    # Sets the given `value` with the header corresponding to `key`.
+    #
+    #     res["Content-Type"] = "application/json"
+    #     res["Content-Type"] # => "application/json"
+    #
     def []=(key, value)
       @headers[key] = value
     end
 
+    # Appends `str` to `body` and updates the `Content-Length` header.
+    #
+    #     res.body # => []
+    #
+    #     res.write("foo")
+    #     res.write("bar")
+    #
+    #     res.body
+    #     # => ["foo", "bar"]
+    #
+    #     res["Content-Length"]
+    #     # => 6
+    #
     def write(str)
       s = str.to_s
 
@@ -58,11 +103,42 @@ class Syro
       @body << s
     end
 
+    # Sets the `Location` header to `path` and updates the status to
+    # `status`. By default, `status` is `302`.
+    #
+    #     res.redirect("/path")
+    #
+    #     res["Location"] # => "/path"
+    #     res.status      # => 302
+    #
+    #     res.redirect("http://syro.ru", 303)
+    #
+    #     res["Location"] # => "http://syro.ru"
+    #     res.status      # => 303
+    #
     def redirect(path, status = 302)
       @headers[LOCATION] = path
       @status = status
     end
 
+    # Returns an array with three elements: the status, headers and body.
+    # If the status is not set, the status is set to 404 if empty body,
+    # otherwise the status is set to 200 and updates the `Content-Type`
+    # header to `text/html`.
+    #
+    #     res.status = 200
+    #     res.finish
+    #     # => [200, {}, []]
+    #
+    #     res.status = nil
+    #     res.finish
+    #     # => [404, {}, []]
+    #
+    #     res.status = nil
+    #     res.write("syro")
+    #     res.finish
+    #     # => [200, { "Content-Type" => "text/html" }, ["syro"]]
+    #
     def finish
       if @status.nil?
         if @body.empty?
@@ -76,142 +152,183 @@ class Syro
       [@status, @headers, @body]
     end
 
+    # Sets a cookie into the response.
+    #
+    #     res.set_cookie("foo", "bar")
+    #     res["Set-Cookie"] # => "foo=bar"
+    #
+    #     res.set_cookie("foo2", "bar2")
+    #     res["Set-Cookie"] # => "foo=bar\nfoo2=bar2"
+    #
+    #     res.set_cookie("bar", {
+    #       domain: ".example.com",
+    #       path: "/",
+    #       # max_age: 0,
+    #       # expires: Time.now + 10_000,
+    #       secure: true,
+    #       httponly: true,
+    #       value: "bar"
+    #     })
+    #
+    #     res["Set-Cookie"].split("\n").last
+    #     # => "bar=bar; domain=.example.com; path=/; secure; HttpOnly
+    #
+    # **NOTE:** This method doesn't sign and/or encrypt the value of the cookie.
+    #
     def set_cookie(key, value)
       Rack::Utils.set_cookie_header!(@headers, key, value)
     end
 
+    # Deletes cookie.
+    #
+    #     res.set_cookie("foo", "bar")
+    #     res["Set-Cookie"]
+    #     # => "foo=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"
+    #
     def delete_cookie(key, value = {})
       Rack::Utils.delete_cookie_header!(@headers, key, value)
     end
   end
 
   class Deck
-    def initialize(code)
-      @syro_code = code
-    end
+    module API
+      def initialize(code)
+        @syro_code = code
+      end
 
-    def env
-      @syro_env
-    end
+      def env
+        @syro_env
+      end
 
-    def req
-      @syro_req
-    end
+      def req
+        @syro_req
+      end
 
-    def res
-      @syro_res
-    end
+      def res
+        @syro_res
+      end
 
-    def path
-      @syro_path
-    end
+      def path
+        @syro_path
+      end
 
-    def inbox
-      @syro_inbox
-    end
+      def inbox
+        @syro_inbox
+      end
 
-    def default_headers
-      return {}
-    end
+      def default_headers
+        return {}
+      end
 
-    def call(env, inbox)
-      @syro_env = env
-      @syro_req = Rack::Request.new(env)
-      @syro_res = Syro::Response.new(default_headers)
-      @syro_path = Seg.new(env.fetch(Rack::PATH_INFO))
-      @syro_inbox = inbox
+      def request_class
+        Rack::Request
+      end
 
-      catch(:halt) do
-        instance_eval(&@syro_code)
+      def response_class
+        Syro::Response
+      end
+
+      def call(env, inbox)
+        @syro_env = env
+        @syro_req = request_class.new(env)
+        @syro_res = response_class.new(default_headers)
+        @syro_path = Seg.new(env.fetch(Rack::PATH_INFO))
+        @syro_inbox = inbox
+
+        catch(:halt) do
+          instance_eval(&@syro_code)
 
-        @syro_res.finish
+          @syro_res.finish
+        end
       end
-    end
 
-    def run(app, inbox = {})
-      path, script = env[Rack::PATH_INFO], env[Rack::SCRIPT_NAME]
+      def run(app, inbox = {})
+        path, script = env[Rack::PATH_INFO], env[Rack::SCRIPT_NAME]
 
-      env[Rack::PATH_INFO] = @syro_path.curr
-      env[Rack::SCRIPT_NAME] = @syro_path.prev
-      env[Syro::INBOX] = inbox
+        env[Rack::PATH_INFO] = @syro_path.curr
+        env[Rack::SCRIPT_NAME] = @syro_path.prev
+        env[Syro::INBOX] = inbox
 
-      halt(app.call(env))
-    ensure
-      env[Rack::PATH_INFO], env[Rack::SCRIPT_NAME] = path, script
-    end
+        halt(app.call(env))
+      ensure
+        env[Rack::PATH_INFO], env[Rack::SCRIPT_NAME] = path, script
+      end
 
-    def halt(response)
-      throw(:halt, response)
-    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
+      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
-    end
 
-    def on(arg)
-      if match(arg)
-        yield(inbox[arg])
+      def on(arg)
+        if match(arg)
+          yield(inbox[arg])
 
-        halt(res.finish)
+          halt(res.finish)
+        end
       end
-    end
 
-    def root?
-      @syro_path.root?
-    end
+      def root?
+        @syro_path.root?
+      end
 
-    def root
-      if root?
-        yield
+      def root
+        if root?
+          yield
 
-        halt(res.finish)
+          halt(res.finish)
+        end
       end
-    end
 
-    def get
-      if root? && req.get?
-        yield
+      def get
+        if root? && req.get?
+          yield
 
-        halt(res.finish)
+          halt(res.finish)
+        end
       end
-    end
 
-    def put
-      if root? && req.put?
-        yield
+      def put
+        if root? && req.put?
+          yield
 
-        halt(res.finish)
+          halt(res.finish)
+        end
       end
-    end
 
-    def post
-      if root? && req.post?
-        yield
+      def post
+        if root? && req.post?
+          yield
 
-        halt(res.finish)
+          halt(res.finish)
+        end
       end
-    end
 
-    def patch
-      if root? && req.patch?
-        yield
+      def patch
+        if root? && req.patch?
+          yield
 
-        halt(res.finish)
+          halt(res.finish)
+        end
       end
-    end
 
-    def delete
-      if root? && req.delete?
-        yield
+      def delete
+        if root? && req.delete?
+          yield
 
-        halt(res.finish)
+          halt(res.finish)
+        end
       end
     end
+
+    include API
   end
 
   def initialize(deck = Deck, &code)

data/syro.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "syro"
-  s.version           = "1.0.0"
+  s.version           = "1.1.0"
   s.summary           = "Simple router"
   s.description       = "Simple router for web applications"
   s.authors           = ["Michel Martens"]

data/test/all.rb

@@ -1,3 +1,5 @@
+require "json"
+
 class RackApp
   def call(env)
     [200, {"Content-Type" => "text/html"}, ["GET /rack"]]
@@ -17,6 +19,28 @@ class DefaultHeaders < Syro::Deck
   end
 end
 
+class CustomRequestAndResponse < Syro::Deck
+  class JSONRequest < Rack::Request
+    def params
+      JSON.parse(body.read)
+    end
+  end
+
+  class JSONResponse < Syro::Response
+    def write(s)
+      super(JSON.generate(s))
+    end
+  end
+
+  def request_class
+    JSONRequest
+  end
+
+  def response_class
+    JSONResponse
+  end
+end
+
 textual = Syro.new(TextualDeck) {
   get {
     text("GET /textual")
@@ -25,6 +49,14 @@ textual = Syro.new(TextualDeck) {
 
 default_headers = Syro.new(DefaultHeaders) { }
 
+json = Syro.new(CustomRequestAndResponse) {
+  root {
+    params = req.params
+
+    res.write(params)
+  }
+}
+
 admin = Syro.new {
   get {
     res.write("GET /admin")
@@ -155,6 +187,10 @@ app = Syro.new {
   on("headers") {
     run(default_headers)
   }
+
+  on("json") {
+    run(json)
+  }
 }
 
 setup do
@@ -270,3 +306,11 @@ test "default headers" do |f|
 
   assert_equal "text/html", f.last_response.headers["Content-Type"]
 end
+
+test "custom request and response class" do |f|
+  params = JSON.generate(foo: "foo")
+
+  f.post("/json", params)
+
+  assert_equal params, f.last_response.body
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syro
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: seg