jsend-rails 0.9.1 → 0.9.2

data/README.md

@@ -0,0 +1,49 @@
+# jsend-rails
+
+extensions to Rails for rendering JSON responses in the [JSend](http://labs.omniti.com/labs/jsend) format
+
+## Usage
+
+In a controller:
+
+    def create
+      thing = Thing.new_from_json(request.body)
+      if thing.save
+        render_jsend(:success => thing)
+      else
+        render_jsend(:fail => thing.errors)
+      end
+    rescue Exception => e
+      render_jsend(:error => e.message, :code => 12345, :data => ['other', 'stuff])
+    end
+
+Valid statuses are `:success`, `:fail` and `:error`. You can pass either the status itself (which implies an empty data
+object) or a hash of options; in the case of options, one of the keys must be the status, and its value is used for the
+data object.
+
+## Tests
+
+Some handy matchers are provided for RSpec users, and `ActionController::TestResponse` is extended with a few methods:
+
+    require 'jsend-rails/test/matchers'
+    require 'jsend-rails/test/response'
+
+    describe Thing do
+      let(:thing) { Thing.create(...) }
+
+      before(:each) do
+        xhr :get, :show, :id => thing.id
+      end
+
+      it "succeeds" do
+        response.should be_jsend_success
+      end
+
+      it "returns thing id" do
+        response.jsend_data['id'].should == thing.id
+      end
+    end
+
+## Copyright
+
+Copyright (c) 2011 Utah Street Labs. See LICENSE for details.

data/lib/jsend-rails.rb

@@ -0,0 +1,3 @@
+require 'jsend-rails/envelope'
+require 'jsend-rails/controller'
+require 'jsend-rails/railtie'

data/lib/jsend-rails/controller.rb

@@ -0,0 +1,9 @@
+module JSend
+  module Rails
+    module Controller
+      def render_jsend(options_or_status)
+        render(:json => Envelope.compute(options_or_status))
+      end
+    end
+  end
+end

data/lib/jsend-rails/envelope.rb

@@ -0,0 +1,27 @@
+module JSend
+  module Rails
+    class Envelope
+      STATUS = [:error, :fail, :success]
+
+      def self.compute(options_or_status)
+        if options_or_status.is_a?(Hash)
+          if options_or_status.include?(:error)
+            p = {:status => :error, :message => options_or_status[:error]}
+            p[:code] = options_or_status[:code] if options_or_status.include?(:code)
+            p[:data] = options_or_status[:data] if options_or_status.include?(:data)
+            p
+          elsif options_or_status.include?(:fail)
+            {:status => :fail, :data => options_or_status[:fail]}
+          elsif options_or_status.include?(:success)
+            {:status => :success, :data => options_or_status[:success]}
+          else
+            raise ArgumentError.new("one of #{STATUS.join(', ')} required")
+          end
+        else
+          raise ArgumentError.new("one of #{STATUS.join(', ')} required") unless STATUS.include?(options_or_status)
+          {:status => options_or_status, :data => {}}
+        end
+      end
+    end
+  end
+end

data/lib/jsend-rails/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module JSend
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer "jsend.configure_rails_initialization" do
+        ActionController::Base.send :include, JSend::Rails::Controller
+      end
+    end
+  end
+end

data/lib/jsend-rails/test/matchers.rb

@@ -0,0 +1,58 @@
+require 'rspec/core'
+require 'rspec/matchers'
+
+module JSend
+  module Rails
+    module Test
+      module Matchers
+        RSpec::Matchers.define :be_json do
+          match do |response|
+            response.content_type =~ /^application\/json/
+          end
+          failure_message_for_should do |response|
+            "Response should have application/json content type"
+          end
+          failure_message_for_should_not do |response|
+            "Response should not have application/json content type"
+          end
+        end
+
+        RSpec::Matchers.define :be_jsend_success do
+          match do |response|
+            response.json['status'].should == 'success'
+          end
+          failure_message_for_should do |response|
+            "Response should be JSend success"
+          end
+          failure_message_for_should_not do |response|
+            "Response should not be JSend success"
+          end
+        end
+
+        RSpec::Matchers.define :be_jsend_failure do
+          match do |response|
+            response.json['status'].should == 'fail'
+          end
+          failure_message_for_should do |response|
+            "Response should be JSend failure"
+          end
+          failure_message_for_should_not do |response|
+            "Response should not be JSend failure"
+          end
+        end
+
+        RSpec::Matchers.define :be_jsend_error do
+          match do |response|
+            response.json['status'].should == 'error'
+          end
+          failure_message_for_should do |response|
+            "Response should be JSend error"
+          end
+          failure_message_for_should_not do |response|
+            "Response should not be JSend error"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jsend-rails/test/response.rb

@@ -0,0 +1,24 @@
+require 'active_support/json'
+require 'action_controller/test_case'
+
+module JSend
+  module Rails
+    module Test
+      module Response
+        def json
+          ActiveSupport::JSON.decode(body)
+        end
+
+        def jsend_status
+          json['status']
+        end
+
+        def jsend_data
+          json['data']
+        end
+      end
+    end
+  end
+end
+
+ActionController::TestResponse.send :include, JSend::Rails::Test::Response

data/lib/jsend-rails/version.rb

@@ -0,0 +1,5 @@
+module JSend
+  module Rails
+    VERSION = "0.9.2"
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: jsend-rails
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - Brian Moseley
@@ -44,8 +44,15 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- lib/jsend-rails/controller.rb
+- lib/jsend-rails/envelope.rb
+- lib/jsend-rails/railtie.rb
+- lib/jsend-rails/test/matchers.rb
+- lib/jsend-rails/test/response.rb
+- lib/jsend-rails/version.rb
+- lib/jsend-rails.rb
+- README.md
 has_rdoc: true
 homepage: http://github.com/utahstreetlabs/jsend-rails
 licenses: []