syro 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 658a95591ca492f8ef93c5bf53fec487241fe19a
-  data.tar.gz: 544c047d077ede271e2a07a87a2ab90b7d6c89fd
+  metadata.gz: ef99afaf8d8d2f03d42a66cf16b3aa8e76c91a66
+  data.tar.gz: 416d45ed7ca4d2c8e995e1b71d7a603f6b655d80
 SHA512:
-  metadata.gz: 82e8ee02485eec1edd424f2a02a530a2b14fc1fa5625f1490c3b2b6ce30fc0214e9331139d07ba923af04ff9b86bbbff640bea5ddab38d2446a588b07b4f0629
-  data.tar.gz: 07a12905d58b323509195f95065bcc6c739115a44345cfd2b5d2f5aff8becc4ba7360d0bd59a3f879aba4dff966fd8e9d375e84a0ce2d05daef447d78d7f161a
+  metadata.gz: c755f0d05b8c8c8e7ffa3b1b811e658c7b9182a0632d9b5d15031414295cd97630166c773fc505d87c186d2c2a92e437512b8da6880bd8ae0c903223de7d98c6
+  data.tar.gz: 4cf42a210e82910a6997a7f7b54273ff98c2c0442978797d87f98a22aeac21355962f1eaca8024ae9b316a0aa0378e913fab54d41ac3d8ee308edd9052c27993

data/CHANGELOG

@@ -1,3 +1,7 @@
+2.1.0
+
+* Add matchers for head and options
+
 2.0.0
 
 * No changes since 2.0.0.rc1

data/README.md

@@ -49,8 +49,8 @@ app = Syro.new {
 The block is evaluated in a sandbox where the following methods are
 available: `env`, `req`, `res`, `path`, `inbox`, `call`, `run`,
 `halt`, `consume`, `capture`, `root?` `match`, `default`, `on`,
-`root`,`get`, `put`, `post`, `patch` and `delete`. Three other
-methods are available for customizations: `default_headers`,
+`root`,`get`, `put`, `head`, `post`, `patch`, `delete` and `options`.
+Three other methods are available for customizations: `default_headers`,
 `request_class` and `response_class`.
 
 As a recommendation, user created variables should be instance
@@ -106,6 +106,9 @@ true.
 `put`: Receives a block and calls it only if `root?` and `req.put?` are
 true.
 
+`head`: Receives a block and calls it only if `root?` and `req.head?`
+are true.
+
 `post`: Receives a block and calls it only if `root?` and `req.post?`
 are true.
 
@@ -115,6 +118,9 @@ are true.
 `delete`: Receives a block and calls it only if `root?` and `req.delete?`
 are true.
 
+`options`: Receives a block and calls it only if `root?` and
+`req.options?` are true.
+
 Decks
 -----
 

data/lib/syro.rb

@@ -24,7 +24,7 @@ require "rack"
 require "seg"
 
 class Syro
-  INBOX = "syro.inbox".freeze
+  INBOX = "syro.inbox".freeze # :nodoc:
 
   class Response
     LOCATION = "Location".freeze # :nodoc:
@@ -48,14 +48,14 @@ class Syro
     #     res.body
     #     # => ["there is", "no try"]
     #
-    attr :body
+    attr_reader :body
 
     # Returns a hash with the response headers.
     #
     #     res.headers
     #     # => { "Content-Type" => "text/html", "Content-Length" => "42" }
     #
-    attr :headers
+    attr_reader :headers
 
     def initialize(headers = {})
       @status  = nil
@@ -179,10 +179,14 @@ class Syro
       Rack::Utils.set_cookie_header!(@headers, key, value)
     end
 
-    # Deletes cookie.
+    # Deletes given cookie.
     #
     #     res.set_cookie("foo", "bar")
     #     res["Set-Cookie"]
+    #     # => "foo=bar"
+    #
+    #     res.delete_cookie("foo")
+    #     res["Set-Cookie"]
     #     # => "foo=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"
     #
     def delete_cookie(key, value = {})
@@ -200,10 +204,24 @@ class Syro
         @syro_env
       end
 
+      # Returns the incoming request object. This object is an
+      # instance of Rack::Request.
+      #
+      #     req.post?      # => true
+      #     req.params     # => { "username" => "bob", "password" => "secret" }
+      #     req[:username] # => "bob"
+      #
       def req
         @syro_req
       end
 
+      # Returns the current response object. This object is an
+      # instance of Syro::Response.
+      #
+      #     res.status = 200
+      #     res["Content-Type"] = "text/html"
+      #     res.write("<h1>Welcome back!</h1>")
+      # 
       def res
         @syro_res
       end
@@ -217,7 +235,7 @@ class Syro
       end
 
       def default_headers
-        return {}
+        {}
       end
 
       def request_class
@@ -254,6 +272,13 @@ class Syro
         env[Rack::PATH_INFO], env[Rack::SCRIPT_NAME] = path, script
       end
 
+      # Immediately stops the request and returns `response`
+      # as per Rack's specification.
+      #
+      #     halt([200, { "Content-Type" => "text/html" }, ["hello"]])
+      #     halt([res.status, res.headers, res.body])
+      #     halt(res.finish)
+      #
       def halt(response)
         throw(:halt, response)
       end
@@ -299,6 +324,10 @@ class Syro
         root { yield } if req.put?
       end
 
+      def head
+        root { yield } if req.head?
+      end
+
       def post
         root { yield } if req.post?
       end
@@ -310,6 +339,10 @@ class Syro
       def delete
         root { yield } if req.delete?
       end
+
+      def options
+        root { yield } if req.options?
+      end
     end
 
     include API

data/syro.gemspec

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

data/test/all.rb

@@ -108,6 +108,10 @@ app = Syro.new {
         res.write("PUT /foo/bar")
       }
 
+      head {
+        res.write("HEAD /foo/bar")
+      }
+
       post {
         res.write("POST /foo/bar")
       }
@@ -119,6 +123,10 @@ app = Syro.new {
       delete {
         res.write("DELETE /foo/bar")
       }
+
+      options {
+        res.write("OPTIONS /foo/bar")
+      }
     }
   }
 
@@ -200,6 +208,10 @@ test "path + verb" do |f|
   assert_equal 200, f.last_response.status
   assert_equal "PUT /foo/bar", f.last_response.body
 
+  f.head("/foo/bar")
+  assert_equal 200, f.last_response.status
+  assert_equal "HEAD /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
@@ -211,6 +223,10 @@ test "path + verb" do |f|
   f.delete("/foo/bar")
   assert_equal 200, f.last_response.status
   assert_equal "DELETE /foo/bar", f.last_response.body
+
+  f.options("/foo/bar")
+  assert_equal 200, f.last_response.status
+  assert_equal "OPTIONS /foo/bar", f.last_response.body
 end
 
 test "verbs match only on root" do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syro
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-05 00:00:00.000000000 Z
+date: 2015-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: seg