jsend_wrapper-rails 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 595e037630a2625db30b88eef87c2527cc2c568b
-  data.tar.gz: 24c5581c69fa89beef3934d8e9ccf6db67da1d80
+  metadata.gz: eee04f91289f43f6ebf82e8b1ee53ec90e82ebec
+  data.tar.gz: 93be3df4245222a92426c33d595aa5f371b83ea6
 SHA512:
-  metadata.gz: e3cd16e861c3d4b986542ae5d9298f78305e043da48134e98ce1a4e926ee9dfa1ad8cf557b71872a4eadcdab34b190e74f09b42e1b56b0a218481480ffb37b57
-  data.tar.gz: ff339af35ec687208ccda0e01be7c1657ffccd23eded174eb2624e3a129037d1ef9e8d310fa62504270b9172e1a6784a1e7b4b9cd44cdc02f4daabb0c1ca4765
+  metadata.gz: be9ce6da5c187e1c7ad1b87cd2c869acf5eaeaf33e8f54d9305bd111df4bec7b4b2b5e09e51de4049736c57a08f348006cc0ec7f093ccd16a6edb82b19723817
+  data.tar.gz: 9f4ad8062573d02f7e28eabbc8963cd0167e71ee02e776f486325252f8cbf309795401dd0c6aee4db1834a90a7bff411d25100aeca0dfa6d217867b806add048

data/README.md

@@ -32,7 +32,9 @@ The elements `code` and `data` are optional for JSend Error containers. If you
 leave them out, they will be absent from the rendered JSON. Note the differences
 in these two examples:
 
-`render jsend: {error: 'too bad'}`
+```ruby
+render jsend: {error: 'too bad'}`
+```
 
 **Result**:
 ```json
@@ -42,7 +44,9 @@ in these two examples:
 }
 ```
 
-`render jsend: {error: 'too bad', data: nil}`
+```ruby
+render jsend: {error: 'too bad', data: nil}`
+```
 
 **Result**:
 ```json
@@ -104,6 +108,33 @@ end
 }
 ```
 
+#### Use Renderers directly
+
+If you have some other purpose in mind, you can access the renderers directly:
+
+```ruby
+require 'jsend_wrapper/renderers/success_renderer'
+require 'jsend_wrapper/renderers/fail_renderer'
+require 'jsend_wrapper/renderers/error_renderer'
+
+# or, for all three:
+require 'jsend_wrapper/renderers'
+```
+
+##### Usages
+
+To use these renderers, construct them with the same arguments as you pass to
+the `render` statements listed above.
+
+```ruby
+renderer = JsendWrapper::SuccessRenderer @data
+renderer = JsendWrapper::FailRenderer 'a message'
+renderer = JsendWrapper::ErrorRenderer 'a message', code: 123, data: @data
+
+json = renderer.to_s
+hash = renderer.to_h
+```
+
 ## JSend Specification
 
 *This section is copied from [omniti.com](http://labs.omniti.com/labs/jsend)

data/lib/jsend_wrapper/rails/render_option.rb

@@ -38,7 +38,7 @@ module JsendWrapper
 
     #@return [String] A string containing the rendered JSON
     def render
-      renderer.call
+      renderer.to_s
     end
 
 

data/lib/jsend_wrapper/renderers/error_renderer.rb

@@ -29,7 +29,7 @@ module JsendWrapper
     #@option optional [#to_i] :code a numeric code representing the error
     #@option optional [Object] :data a generic container for any other
     #  information about the error
-    def initialize(message, optional)
+    def initialize(message, optional={})
       @message  = message.to_s
       @has_code = optional.key? :code
       @has_data = optional.key? :data
@@ -40,10 +40,16 @@ module JsendWrapper
 
 
     #@return [String] the rendered JSON
-    def call
+    def to_s
       %[{"status":"error","message":#{message.inspect}#{optional}}]
     end
 
+    def to_h
+      {status: 'error', message: message}.tap do |hash|
+        hash[:code] = code if code?
+        hash[:data] = data if data?
+      end
+    end
 
   private
 

data/lib/jsend_wrapper/renderers/fail_renderer.rb

@@ -25,8 +25,12 @@ module JsendWrapper
       @data = data
     end
 
-    def call
+    def to_s
       %[{"status":"fail","data":#{json_string data}}]
     end
+
+    def to_h
+      { status: 'fail', data: data }
+    end
   end
 end

data/lib/jsend_wrapper/renderers/success_renderer.rb

@@ -16,8 +16,8 @@
 require 'jsend_wrapper/renderers/renderer'
 
 module JsendWrapper
-  # Wraps the given message in a JSend Success. JSend Successs have two required
-  # elements (status, data).
+  # Wraps the given message in a JSend Success. JSend Successes have two
+  # required elements (status, data).
   class SuccessRenderer < Renderer
     attr_reader :data
 
@@ -25,8 +25,12 @@ module JsendWrapper
       @data = data
     end
 
-    def call
+    def to_s
       %[{"status":"success","data":#{json_string data}}]
     end
+
+    def to_h
+      { status: 'success', data: data }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsend_wrapper-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jon Sangster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry