jsend_wrapper-rails 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2aec426a71e880af5186aed2415ca18b84577f7
-  data.tar.gz: 5fe8e2310b6ea9d72d6a5f9ab8207a6c26fc5354
+  metadata.gz: 321056c9ec61f7c53a5094e3c95a9871858dbc41
+  data.tar.gz: 36d9de6dd83e21e85ff64fa77496abbcd9496ab3
 SHA512:
-  metadata.gz: 0c91c8f286be617c60ee2ebbbac8f54871fa0242f90cc65a312ee01a040531d1b5de50f175540e20863e6cd085ace5b7c5f8f4e25953d13259a552fc46efd88e
-  data.tar.gz: ad1c3f2f9478f71bfe46e81f350378128ebe759d58216ab1b604e2a683c0afe3fe1371e93dd1683488ff7a1cb2ce39c797ce2246cbda83f301b5a318a71e50e4
+  metadata.gz: f97f06fa6e474260d8189bf7c97ae326dc4614d2e64d5d2d51a3545c57b5d9e6fbd8c35e8969ede4d59d29795eee05018cc720620cc5bfdac9fdd535f7f1caab
+  data.tar.gz: 3d03152cc8c4e418e43cc5d6f0d67659f2ff15f783c163f9fbba4f337ae736568a92b4b367ae6e6cbd34e296473431aee80197decc1ccf9120f7be7fa858575a

data/README.md

@@ -81,7 +81,7 @@ json.year  1999
 
 #### Handling Errors
 
-You can use `rescue_from` to automatically handle errors: 
+You can use `rescue_from` to automatically handle errors:
 
 ```ruby
 rescue_from ActiveRecord::RecordNotFound do
@@ -102,7 +102,10 @@ end
 }
 ```
 
-## JSend Spec
+## JSend Specification
+
+*This section is copied from [omniti.com](http://labs.omniti.com/labs/jsend)
+under via a modified BSD License (see below).*
 
  * **What?** - Put simply, JSend is a specification that lays down some rules
    for how [JSON](http://json.org) responses from web servers should be
@@ -118,7 +121,7 @@ end
    of responses.  Also, this helps promote happiness and unity between backend
    developers and frontend designers, as everyone can come to expect a common
    approach to interacting with one another.
- * **Hold on now, aren't there already specs for this kind of thing?** - 
+ * **Hold on now, aren't there already specs for this kind of thing?** -
    Well... no.  While there are a few handy specifications for dealing with JSON
    data, most notably [Douglas Crockford](http://www.crockford.com/)'s
    [JSONRequest](http://www.json.org/JSONRequest.html) proposal, there's nothing
@@ -171,7 +174,7 @@ required and optional keys for each type:
     <tr>
       <td>fail</td>
       <td>
-        There was a problem with the data submitted, or some pre-condition of 
+        There was a problem with the data submitted, or some pre-condition of
         the API call wasn't satisfied.
       </td>
       <td>status, message</td>
@@ -180,7 +183,7 @@ required and optional keys for each type:
     <tr>
       <td>error</td>
       <td>
-        An error occurred in processing the request, i.e. an exception was 
+        An error occurred in processing the request, i.e. an exception was
         thrown.
       </td>
       <td>status, message</td>
@@ -219,7 +222,7 @@ simple envelope for the results, using the {{{data}}} key, as in the following:
   "status": "success",
   "data": {
     "id": 2,
-    "title": "Another blog post", 
+    "title": "Another blog post",
     "body": "More content"
   }
 }
@@ -263,8 +266,8 @@ Required keys:
 **`GET /posts.json`**:
 ```json
 {
-    "status" : "error",
-    "message" : "A title is required"
+    "status": "error",
+    "message": "A title is required"
 }
 ```
 
@@ -277,7 +280,7 @@ Optional keys:
  * code: A numeric code corresponding to the error, if applicable
  * data: A generic container for any other information about the error, i.e. the
    conditions that caused the error, stack traces, etc.
- 
+
 ### Whither HTTP?
 
 But wait, you ask, doesn't HTTP already provide a way to communicate response

data/lib/jsend_wrapper/rails/railtie.rb

@@ -20,7 +20,7 @@ module JsendWrapper
     class Railtie < ::Rails::Railtie
       initializer 'jsend_wrapper-rails.initialization' do
         if JsendWrapper::Rails.jbuilder_available?
-          JsendWrapper::Rails.install_template
+          JsendWrapper::Rails.install_template_handler
         end
         JsendWrapper::Rails.install_render_option
       end
@@ -32,14 +32,16 @@ module JsendWrapper
       require 'jbuilder'
       true
     rescue LoadError
-      STDERR.puts 'WARN: Please include the "jbuilder" gem for .jsend templates'
+      $stderr.puts 'WARN: Please include the "jbuilder" gem for .jsend templates'
       false
     end
 
     # Install a "template handler" for .jsend view files. These files will be
     # processed with {Jbuilder}, just like .jbuilder view files, but the result
     # will be wrapped in a "success" JSend wrapper.
-    def self.install_template
+    def self.install_template_handler
+      require 'jsend_wrapper/rails/template_handler'
+
       ActionView::Template.register_template_handler \
         :jsend, JsendWrapper::Rails::TemplateHandler
     end
@@ -47,7 +49,7 @@ module JsendWrapper
 
     # Adds the "jsend:" option to {ActiveController::Base#render}
     def self.install_render_option
-      require_relative 'render_option'
+      require 'jsend_wrapper/rails/render_option'
 
       ActionController::Renderers.add :jsend do |value, _|
         self.content_type ||= Mime::JSON

data/lib/jsend_wrapper/rails/render_option.rb

@@ -13,7 +13,8 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-require_relative '../renderers'
+require 'active_support/core_ext/hash/slice'
+require 'jsend_wrapper/renderers'
 
 module JsendWrapper
   # Parses the "render jsend: {...}" command. Valid forms:

data/lib/jsend_wrapper/rails/template_handler.rb

@@ -22,7 +22,7 @@ module JsendWrapper
 
         <<-RUBY
           content = instance_eval #{json.inspect}
-          JsendWrapper::Handlers::Success.new(self).render content
+          JsendWrapper::Rails::TemplateHandler.new(self).render content
         RUBY
       end
 

data/lib/jsend_wrapper/renderers/error_renderer.rb

@@ -13,13 +13,13 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-require_relative 'renderer'
+require 'jsend_wrapper/renderers/renderer'
 
 module JsendWrapper
   # Wraps the given message in a JSend Error. JSend Errors have two required
   # elements (status, message) and two optional elements (code, data).
   class ErrorRenderer < Renderer
-    attr_accessor :message, :has_code, :code, :has_data, :data
+    attr_reader :message, :has_code, :code, :has_data, :data
 
     alias_method :code?, :has_code
     alias_method :data?, :has_data
@@ -30,18 +30,18 @@ module JsendWrapper
     #@option optional [Object] :data a generic container for any other
     #  information about the error
     def initialize(message, optional)
-      self.message  = message.to_s
-      self.has_code = optional.key? :code
-      self.has_data = optional.key? :data
+      @message  = message.to_s
+      @has_code = optional.key? :code
+      @has_data = optional.key? :data
 
-      self.code = parse_code optional[:code] if code?
-      self.data = optional[:data]            if data?
+      @code = parse_code optional[:code] if code?
+      @data = optional[:data]            if data?
     end
 
 
     #@return [String] the rendered JSON
     def call
-      %[{"status":"error","message":#{message.to_json}#{optional}}]
+      %[{"status":"error","message":#{message.inspect}#{optional}}]
     end
 
 
@@ -49,11 +49,8 @@ module JsendWrapper
 
 
     def parse_code(code)
-      if code.respond_to? :to_i
-        code.to_i
-      else
-        raise '"code" must respond to #to_i'
-      end
+      raise '"code" must respond to #to_i' unless code.respond_to? :to_i
+      code.to_i
     end
 
 

data/lib/jsend_wrapper/renderers/fail_renderer.rb

@@ -13,16 +13,16 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-require_relative 'renderer'
+require 'jsend_wrapper/renderers/renderer'
 
 module JsendWrapper
   # Wraps the given message in a JSend Failure. JSend Failures have two required
   # elements (status, data).
   class FailRenderer < Renderer
-    attr_accessor :data
+    attr_reader :data
 
-    def initialize(obj)
-      self.data = obj
+    def initialize(data)
+      @data = data
     end
 
     def call

data/lib/jsend_wrapper/renderers/renderer.rb

@@ -13,6 +13,8 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+require 'json'
+
 module JsendWrapper
   class Renderer
   protected
@@ -23,7 +25,7 @@ module JsendWrapper
       elsif obj.nil?
         'null'
       else
-        obj.to_s.to_json
+        JSON.dump obj
       end
     end
   end

data/lib/jsend_wrapper/renderers/success_renderer.rb

@@ -13,16 +13,16 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-require_relative 'renderer'
+require 'jsend_wrapper/renderers/renderer'
 
 module JsendWrapper
   # Wraps the given message in a JSend Success. JSend Successs have two required
   # elements (status, data).
   class SuccessRenderer < Renderer
-    attr_accessor :data
+    attr_reader :data
 
-    def initialize(obj)
-      self.data = obj
+    def initialize(data)
+      @data = data
     end
 
     def call

data/lib/jsend_wrapper/renderers.rb

@@ -13,6 +13,6 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-require_relative 'renderers/success_renderer'
-require_relative 'renderers/fail_renderer'
-require_relative 'renderers/error_renderer'
+require 'jsend_wrapper/renderers/success_renderer'
+require 'jsend_wrapper/renderers/fail_renderer'
+require 'jsend_wrapper/renderers/error_renderer'

data/lib/jsend_wrapper-rails.rb

@@ -13,8 +13,8 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-JsendWrapper = Module.new
-
 if defined? Rails
-  require_relative 'jsend_wrapper/rails/railtie'
+  require 'jsend_wrapper/rails/railtie'
+else
+  $stderr.puts 'WARN: Rails is not defined! jsend_wrapper-rails cannot load.'
 end

metadata

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