syro 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0861a7a3ac07757e8fb462b0a61b5dc734cade04
-  data.tar.gz: 3cba990483608d42a41c7b1f80e50dec57ef2945
+  metadata.gz: 26150785e6dd591e63f5e670b6dcc2a27dd01c08
+  data.tar.gz: ea5d9a93323838ee03e3ca140946cee52a8cf339
 SHA512:
-  metadata.gz: 7f13c5c536db61588a19a5b45d49dcf9f48509e9b8a8deda5ccf95761b417523456f81f6d070518d0935ba2348cf5507d429f9437510f43d789ce2c07165c20a
-  data.tar.gz: 9c0ef31436e67e67fa0def5e8b770bc838fb545cce5d636a1882216b4e6124a0206a707d5a9847f628861df9926dfcd3b4947be33bbdb4e0dd545c29d2107b53
+  metadata.gz: e07343b0890bf4820471ebe54a7947713956e506465b0b5eff37c42fbeb50b0bf0957f57693d34118b0dcbe40ccd669689d11d4f3263330f712bdb2a0eaf2739
+  data.tar.gz: 50a533a7933292c1b29fbcfd0bd8f8347128e7b6110ba97ce063939086cd86ffd52b2e4023e8800efee0aed43fa8f24a1a713a99317064140abbbdfc231acce6

data/CHANGELOG

@@ -1,3 +1,9 @@
+3.0.0
+
+* Change how status codes are set.
+* Change how the Content-Type is set.
+* Add Content-Type helpers to Syro::Response.
+
 2.2.0
 
 * Change gemspec to allow Rack 2.

data/README.md

@@ -239,6 +239,61 @@ the command `run(Users)`, an inbox can be provided as the second
 argument: `run(Users, inbox)`. That allows apps to share previous
 captures.
 
+Status code
+-----------
+
+By default the status code is set to `404`. If both path and request
+method are matched, the status is automatically changed to `200`.
+You can change the status code by assigning a number to `res.status`,
+for example:
+
+```ruby
+post do
+  ...
+  res.status = 201
+end
+```
+
+Content type
+------------
+
+There's no default value for the content type header, but there's
+a handy way of setting the desired value.
+
+In order to write the body of the response, the `res.write` method
+is used:
+
+```ruby
+res.write "hello world"
+```
+
+It has the drawback of leaving the `Content-Type` header empty.
+Three alternative methods are provided, and more can be added by
+using custom Decks.
+
+Setting the Content-Type as `"text/plain"`:
+
+```ruby
+res.text "hello world"
+```
+
+Setting the Content-Type as `"text/html"`:
+
+```ruby
+res.html "hello world"
+```
+
+Setting the Content-Type as `"application/json"`:
+
+```ruby
+res.json "hello world"
+```
+
+Note that aside from writing the response body and setting the value
+for the Content-Type header, no encoding or serialization takes
+place. If you want to return a JSON encoded response, make sure to
+encode the objects yourself (i.e., `res.json JSON.dump(...)`).
+
 Security
 --------
 
@@ -260,7 +315,6 @@ just use `Rack::Builder`:
 
 ```ruby
 App = Rack::Builder.new do
-
   use Rack::Session::Cookie, secret: "..."
 
   run Syro.new do
@@ -268,7 +322,6 @@ App = Rack::Builder.new do
       res.write("Hello, world")
     end
   end
-
 end
 ```
 

data/lib/syro.rb

@@ -28,7 +28,12 @@ class Syro
 
   class Response
     LOCATION = "Location".freeze # :nodoc:
-    DEFAULT = "text/html".freeze # :nodoc:
+
+    module ContentType
+      HTML = "text/html".freeze        # :nodoc:
+      TEXT = "text/plain".freeze       # :nodoc:
+      JSON = "application/json".freeze # :nodoc:
+    end
 
     # The status of the response.
     #
@@ -58,7 +63,7 @@ class Syro
     attr_reader :headers
 
     def initialize(headers = {})
-      @status  = nil
+      @status  = 404
       @headers = headers
       @body    = []
       @length  = 0
@@ -103,6 +108,24 @@ class Syro
       @body << s
     end
 
+    # Write response body as text/plain
+    def text(str)
+      @headers[Rack::CONTENT_TYPE] = ContentType::TEXT
+      write(str)
+    end
+
+    # Write response body as text/html
+    def html(str)
+      @headers[Rack::CONTENT_TYPE] = ContentType::HTML
+      write(str)
+    end
+
+    # Write response body as application/json
+    def json(str)
+      @headers[Rack::CONTENT_TYPE] = ContentType::JSON
+      write(str)
+    end
+
     # Sets the `Location` header to `path` and updates the status to
     # `status`. By default, `status` is `302`.
     #
@@ -121,10 +144,10 @@ class Syro
       @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`.
+    # Returns an array with three elements: the status, headers and
+    # body. If the status is not set, the status is set to 404. If
+    # a match is found for both path and request method, the status
+    # is changed to 200.
     #
     #     res.status = 200
     #     res.finish
@@ -140,12 +163,6 @@ class Syro
     #     # => [200, { "Content-Type" => "text/html" }, ["syro"]]
     #
     def finish
-      @status ||= (@body.empty?) ? 404 : 200
-
-      if @body.any?
-        @headers[Rack::CONTENT_TYPE] ||= DEFAULT
-      end
-
       [@status, @headers, @body]
     end
 
@@ -314,31 +331,31 @@ class Syro
       end
 
       def get
-        root { yield } if req.get?
+        root { res.status = 200; yield } if req.get?
       end
 
       def put
-        root { yield } if req.put?
+        root { res.status = 200; yield } if req.put?
       end
 
       def head
-        root { yield } if req.head?
+        root { res.status = 200; yield } if req.head?
       end
 
       def post
-        root { yield } if req.post?
+        root { res.status = 200; yield } if req.post?
       end
 
       def patch
-        root { yield } if req.patch?
+        root { res.status = 200; yield } if req.patch?
       end
 
       def delete
-        root { yield } if req.delete?
+        root { res.status = 200; yield } if req.delete?
       end
 
       def options
-        root { yield } if req.options?
+        root { res.status = 200; yield } if req.options?
       end
     end
 

data/syro.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = "syro"
-  s.version           = "2.2.0"
+  s.version           = "3.0.0"
   s.summary           = "Simple router"
   s.description       = "Simple router for web applications"
   s.authors           = ["Michel Martens"]
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
 
   s.add_dependency "seg"
-  s.add_dependency "rack", ">= 1.6.0"
+  s.add_dependency "rack", "~> 2"
   s.add_development_dependency "cutest"
   s.add_development_dependency "rack-test"
 end

data/test/all.rb

@@ -6,9 +6,9 @@ class RackApp
   end
 end
 
-class TextualDeck < Syro::Deck
-  def text(str)
-    res[Rack::CONTENT_TYPE] = "text/plain"
+class MarkdownDeck < Syro::Deck
+  def markdown(str)
+    res[Rack::CONTENT_TYPE] = "text/markdown"
     res.write(str)
   end
 end
@@ -41,9 +41,9 @@ class CustomRequestAndResponse < Syro::Deck
   end
 end
 
-textual = Syro.new(TextualDeck) do
+markdown = Syro.new(MarkdownDeck) do
   get do
-    text("GET /textual")
+    markdown("GET /markdown")
   end
 end
 
@@ -182,15 +182,15 @@ app = Syro.new do
     end
   end
 
-  on "textual" do
-    run(textual)
+  on "markdown" do
+    run(markdown)
   end
 
   on "headers" do
     run(default_headers)
   end
 
-  on "json" do
+  on "custom" do
     run(json)
   end
 
@@ -198,6 +198,22 @@ app = Syro.new do
     res.status = 401
     res.write("Unauthorized")
   end
+
+  on "write" do
+    res.write "nil!"
+  end
+
+  on "text" do
+    res.text "plain!"
+  end
+
+  on "html" do
+    res.html "html!"
+  end
+
+  on "json" do
+    res.json "json!"
+  end
 end
 
 setup do
@@ -209,6 +225,10 @@ test "path + verb" do |f|
   assert_equal 200, f.last_response.status
   assert_equal "GET /foo/bar", f.last_response.body
 
+  f.get("/bar/baz")
+  assert_equal 404, f.last_response.status
+  assert_equal "", f.last_response.body
+
   f.put("/foo/bar")
   assert_equal 200, f.last_response.status
   assert_equal "PUT /foo/bar", f.last_response.body
@@ -267,7 +287,9 @@ 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
+
+  # As the verb was not mached, the status is 404.
+  assert_equal 404, f.last_response.status
 end
 
 test "post values" do |f|
@@ -306,9 +328,9 @@ test "redirect" do |f|
 end
 
 test "custom deck" do |f|
-  f.get("/textual")
-  assert_equal "GET /textual", f.last_response.body
-  assert_equal "text/plain", f.last_response.headers["Content-Type"]
+  f.get("/markdown")
+  assert_equal "GET /markdown", f.last_response.body
+  assert_equal "text/markdown", f.last_response.headers["Content-Type"]
   assert_equal 200, f.last_response.status
 end
 
@@ -321,15 +343,29 @@ end
 test "custom request and response class" do |f|
   params = JSON.generate(foo: "foo")
 
-  f.post("/json", params)
+  f.post("/custom", params)
 
   assert_equal params, f.last_response.body
 end
 
-test "set content type if body is set" do |f|
+test "don't set content type by default" do |f|
   f.get("/private")
 
   assert_equal 401, f.last_response.status
   assert_equal "Unauthorized", f.last_response.body
+  assert_equal nil, f.last_response.headers["Content-Type"]
+end
+
+test "content type" do |f|
+  f.get("/write")
+  assert_equal nil, f.last_response.headers["Content-Type"]
+
+  f.get("/text")
+  assert_equal "text/plain", f.last_response.headers["Content-Type"]
+
+  f.get("/html")
   assert_equal "text/html", f.last_response.headers["Content-Type"]
+
+  f.get("/json")
+  assert_equal "application/json", f.last_response.headers["Content-Type"]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syro
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: seg
@@ -28,16 +28,16 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: cutest
   requirement: !ruby/object:Gem::Requirement