granola 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d89e36c1e6cf872c3e3fafff7ddabd364af6a20
-  data.tar.gz: 292659322f51f57ba16ad7a47cda7aa366ce2362
+  metadata.gz: 0d181cf15a32af62964d9d54b21589ed2bfaffcf
+  data.tar.gz: 2fe3d728942d5e4dbf68b92f80c49349bed8c10d
 SHA512:
-  metadata.gz: 6a5f68618ec9682f837db0a45b033bf850dc256875d3b26fcad3b187a26401bcd0bc569fc3512ab63e29781a7e2215838670de4695b31fbc568a3251276d761a
-  data.tar.gz: e64ee844b50f5ee5b2081988406bf408f9b3bd51e35e406795b3c188b078c32a3a0b2dd8059df701471de60b9e094fa436f54b4fee87d2d787f50dbb4cc17f11
+  metadata.gz: 984bc4b6f1f0a38dc57be7c2a40ba3f144d18adc40179c6eaee1dda7848ffae42582d4c36dbeae81988b9bb6622c115c8cbff654f2e91f3053de20a7b3d038ce
+  data.tar.gz: 892e590017554fad8a5e5bc375d23ecb67220d1b7261fcf37fdf5a3de3793911acc642c74881c5cbc1160663af1e1c7e5115066c92b7de6cbdccbe1da2723753

data/README.md

@@ -51,22 +51,33 @@ serializer.to_json #=> '[{"name":"John Doe",...},{...}]'
 
 ## Rack Helpers
 
-If your application is based on rack, you have a `Rack::Response` called `res`
-in your context, and you have an `env` method that returns the Rack env hash,
-you can simply `include Granola::Rack` and you get access to the following
-interface:
+If your application is based on Rack, you can simply `include Granola::Rack` and
+you get access to the following interface:
 
 ``` ruby
 json(person) #=> This will try to infer PersonSerializer from a Person instance
 json(person, with: AnotherSerializer)
 ```
 
-*NOTE*: This works out of the box in frameworks like [Cuba][] or [Roda][]. You
-might need to provide glue code to make `res` and/or `env` available in other
-frameworks.
+*NOTE* The method relies on being an `env` method that returns the Rack
+environment Hash in the same context where you call the method. See [the
+documentation](./lib/granola/rack.rb) for further details.
 
-[Cuba]: https://github.com/soveran/cuba
-[Roda]: https://github.com/jeremyevans/roda
+This method returns a Rack response tuple that you can use like so (this example
+uses [Cuba][], but similar code will work for other frameworks):
+
+``` ruby
+Cuba.plugin Granola::Rack
+
+Cuba.define do
+  on get, "users/:id" do |id|
+    user = User[id]
+    halt json(user)
+  end
+end
+```
+
+[Cuba]: http://cuba.is
 
 ## Caching
 

data/lib/granola/helper.rb

@@ -10,12 +10,13 @@ module Granola::Helper
   # Keywords
   #   with: A specific serializer class to use. If this is `nil`,
   #         `Helper.serializer_class_for` will be used to infer the serializer
-  #         class.
+  #         class. This is ignored if `object` is already a Granola::Serializer.
   #
   # Raises NameError if no specific serializer is provided and we fail to infer
   #   one for this object.
   # Returns an instance of a Granola::Serializer subclass.
   def serializer_for(object, with: nil)
+    return object if Granola::Serializer === object
     serializer_class = with || Granola::Helper.serializer_class_for(object)
     method = object.respond_to?(:to_ary) ? :list : :new
     serializer_class.send(method, object)

data/lib/granola/rack.rb

@@ -16,9 +16,8 @@ module Granola::Rack
   # `ETag` headers if appropriate, and of controlling whether the object should
   # be rendered at all or not (issuing a 304 response in this case).
   #
-  # This expects the class mixing in this module to implement two methods:
-  # `res`, that should be a Rack::Response, and `env`, that should be a Rack
-  # environment hash.
+  # This expects the class mixing in this module to implement an `env` method,
+  # that should be a Rack environment Hash.
   #
   # object - An object to serialize into JSON.
   #
@@ -31,16 +30,17 @@ module Granola::Rack
   #
   # Raises NameError if no specific serializer is provided and we fail to infer
   #   one for this object.
-  # Returns an instance of a Granola::Serializer subclass.
+  # Returns a Rack response tuple.
   def json(object, with: nil, **json_options)
     serializer = serializer_for(object, with: with)
+    headers = {}
 
     if serializer.last_modified
-      res["Last-Modified".freeze] = serializer.last_modified.httpdate
+      headers["Last-Modified".freeze] = serializer.last_modified.httpdate
     end
 
     if serializer.cache_key
-      res["ETag".freeze] = Digest::MD5.hexdigest(serializer.cache_key)
+      headers["ETag".freeze] = Digest::MD5.hexdigest(serializer.cache_key)
     end
 
     stale_check = StaleCheck.new(
@@ -48,12 +48,12 @@ module Granola::Rack
     )
 
     if stale_check.fresh?
-      res.status = 304
+      [304, headers, []]
     else
       json_string = serializer.to_json(json_options)
-      res["Content-Type".freeze] = serializer.mime_type
-      res["Content-Length".freeze] = json_string.length.to_s
-      res.write(json_string)
+      headers["Content-Type".freeze] = serializer.mime_type
+      headers["Content-Length".freeze] = json_string.length.to_s
+      [200, headers, [json_string]]
     end
   end
 

data/lib/granola/version.rb

@@ -1,3 +1,3 @@
 module Granola
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: granola
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nicolas Sanguinetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json