js-client-bridge 0.1.4 → 0.1.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    js-client-bridge (0.1.4)
+    js-client-bridge (0.1.5)
       json_pure (~> 1.4.6)
 
 GEM
@@ -83,7 +83,6 @@ DEPENDENCIES
   dm-types (~> 1.0.2)
   dm-validations (~> 1.0.2)
   js-client-bridge!
-  json_pure (~> 1.4.6)
   mocha (~> 0.9.8)
   rcov (~> 0.9.8)
   rspec (~> 2.0.0)

data/lib/js-client-bridge/responses.rb

@@ -15,7 +15,7 @@ module JsClientBridge #:nodoc:
       def respond_with(type, args)
         unless args.blank?
           options = args.last.is_a?(Hash) ? args.pop.dup : {}
-          options[:_message] = args.shift.dup if args.first.is_a?(String)
+          options['_message'] = args.shift.dup if args.first.is_a?(String)
         else
           options = {}
         end
@@ -26,7 +26,7 @@ module JsClientBridge #:nodoc:
           formatting[para] = options.delete(para) if options.include?(para)
         end
         
-        [options.merge({ :_status => type.to_s }), formatting]
+        [options.merge({ '_status' => type.to_s }), formatting]
       end
       
       def format_response(response, formatting_options = {})

data/lib/js-client-bridge/responses/error.rb

@@ -7,16 +7,31 @@ module JsClientBridge #:nodoc:
       # used as the _status options. It will also honour custom optionss as long
       # they don't clash with the standard ones.
       #
-      # ==== Parameters
-      # message<String>:: An optional message.
-      # options<Hash>:: Custom optionss.
+      # @param <String> message
+      #   An optional message.
+      # @param <Hash> options
+      #   Custom optionss.
       #
-      # ==== Returns
-      # JSON String:: 
+      # @return <Hash>
+      #   The response as a Hash
       def respond_with_error(*args)
-        format_response(*respond_with('error', args))
+        respond_with('error', args).first
       end
 
+      # Generates a error response. If the first parameter is a string is will be
+      # used as the _status options. It will also honour custom optionss as long
+      # they don't clash with the standard ones.
+      #
+      # @param <String> message
+      #   An optional message.
+      # @param <Hash> options
+      #   Custom optionss.
+      #
+      # @return <Hash>
+      #   The response as a String encoded JSON object.
+      def render_error(*args)
+        format_response(*respond_with('error', args))
+      end
     end # module Error
   end # module Responses
 end # module JsClientBridge

data/lib/js-client-bridge/responses/exception.rb

@@ -25,6 +25,30 @@ module JsClientBridge #:nodoc:
           :backtrace  => exception.backtrace
         }]
 
+        response
+      end
+
+      def render_exception(*args)
+        raise ArgumentError.new("respond_with_exception requires an exception as it's first parameter") if args.blank? || !args.first.is_a?(StandardError)
+        
+        exception = args.shift
+        options = args.last.is_a?(Hash) ? args.pop : {}
+
+        # Ensure we have our required fields
+        raise ArgumentError.new("respond_with_exception requires the request_uri option") unless options.include?(:request_uri)
+
+        # Set some defaults
+        options[:parameters] ||= {}
+
+        # Generate our response hash and add the exceptions parameter
+        response, formatting = respond_with('exception', [options])
+        response[:exceptions] = [{
+          :name       => exception.class,
+          :short_name => exception.class.to_s.split('::').last,
+          :message    => CGI.escape(exception.message),
+          :backtrace  => exception.backtrace
+        }]
+
         format_response(response, formatting)
       end
 
@@ -52,6 +76,33 @@ module JsClientBridge #:nodoc:
           }
         end
         
+        response
+      end
+
+      def render_exceptions(*args)
+        raise ArgumentError.new("respond_with_exception requires an array of exceptions as it's first parameter") if args.blank? || !args.first.is_a?(Array)
+        
+        exceptions = args.shift
+        options = args.last.is_a?(Hash) ? args.pop : {}
+
+        # Ensure we have our required fields
+        raise ArgumentError.new("respond_with_exception requires the request_uri option") unless options.include?(:request_uri)
+
+        # Set some defaults
+        options[:parameters] ||= {}
+
+        # Generate our response hash and add the exceptions parameter
+        response, formatting = respond_with('exception', [options])
+        
+        response[:exceptions] = exceptions.map do |exception|
+          {
+            :name       => exception.class,
+            :short_name => exception.class.to_s.split('::').last,
+            :message    => CGI.escape(exception.message),
+            :backtrace  => exception.backtrace
+          }
+        end
+        
         format_response(response, formatting)
       end
 

data/lib/js-client-bridge/responses/ok.rb

@@ -3,17 +3,33 @@ require 'cgi'
 module JsClientBridge #:nodoc:
   module Responses #:nodoc:
     module Ok
-      # Generates a 'ok' status response. If the first parameter is a string is will be
+      # Generates a 'ok' status response as a Hash. If the first parameter is a string is will be
       # used as the _status options. It will also honour custom optionss as long
       # they don't clash with the standard ones.
       #
-      # ==== Parameters
-      # message<String>:: An optional message.
-      # options<Hash>:: Custom optionss.
+      # @param <String> message
+      #   An optional message.
+      # @param <Hash> options
+      #   Custom optionss.
       #
-      # ==== Returns
-      # JSON String::
+      # @return <Hash>
+      #   The response as a Hash
       def respond_with_ok(*args)
+        respond_with('ok', args).first
+      end
+
+      # Generates a 'ok' status response. If the first parameter is a string is will be
+      # used as the _status options. It will also honour custom optionss as long
+      # they don't clash with the standard ones.
+      #
+      # @param <String> message
+      #   An optional message.
+      # @param <Hash> options
+      #   Custom optionss.
+      #
+      # @return <String>
+      #   A JSON object encoded as a String.
+      def render_ok(*args)
         format_response(*respond_with('ok', args))
       end
     end # module Ok

data/lib/js-client-bridge/responses/validation.rb

@@ -7,16 +7,42 @@ module JsClientBridge #:nodoc:
       # used as the _status options. It will also honour custom optionss as long
       # they don't clash with the standard ones.
       #
-      # ==== Parameters
-      # message<String>:: An optional message.
-      # options<Hash>:: Custom optionss.
+      # @param <String> message
+      #   An optional message.
+      # @param <Hash> options
+      #   Custom optionss.
       #
-      # ==== Returns
-      # JSON String::
+      # @return <Hash>
+      #   The response as a Hash
       def respond_with_validation_error(*args)
         obj = args.shift
         options = args.last.is_a?(Hash) ? args.pop : {}
 
+        # Generate our response hash and add the exceptions parameter
+        response =  if options.include?(:message)
+                      options.merge( validation_errors_to_hash(obj, options.delete(:message)) )
+                    else
+                      options.merge( validation_errors_to_hash(obj) )
+                    end
+
+        response
+      end
+
+      # Generates a validation error status response. If the first parameter is a string is will be
+      # used as the _status options. It will also honour custom optionss as long
+      # they don't clash with the standard ones.
+      #
+      # @param <String> message
+      #   An optional message.
+      # @param <Hash> options
+      #   Custom optionss.
+      #
+      # @return <String>
+      #   The response as a String encoded JSON object
+      def render_validation(*args)
+        obj = args.shift
+        options = args.last.is_a?(Hash) ? args.pop : {}
+
         # Generate our response hash and add the exceptions parameter
         response =  if options.include?(:message)
                       options.merge( validation_errors_to_hash(obj, options.delete(:message)) )
@@ -33,14 +59,14 @@ module JsClientBridge #:nodoc:
         short_type = data_object.class.to_s.split('::').last
     
         validation = {
-          :_status       => 'validation',
-          :_type        => data_object.class.to_s,
-          :_short_type  => short_type,
-          :_message      => message,
-          :validation   => data_object.errors.to_hash,
+          '_status'       => 'validation',
+          '_type'        => data_object.class.to_s,
+          '_short_type'  => short_type,
+          '_message'      => message,
+          'validation'   => data_object.errors.to_hash,
         }
     
-        validation[:id] = data_object.id.to_s unless data_object.new?
+        validation['id'] = data_object.id.to_s unless data_object.new?
     
         validation
       end

data/lib/js-client-bridge/version.rb

@@ -1,3 +1,3 @@
 module JsClientBridge
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/spec/error_responses_spec.rb

@@ -1,26 +1,46 @@
 require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 
 describe "Error Responses" do
-  it "should generate a basic error response" do
-    JSON.parse(JsClientBridge::Responses.respond_with_error).should == {'_status' => 'error'}
-  end
+  describe "#render_error" do
+    it "should generate a basic error response" do
+      JSON.parse(JsClientBridge::Responses.render_error).should == {'_status' => 'error'}
+    end
 
-  it "should generate a error response with a status message" do
-    JSON.parse(JsClientBridge::Responses.respond_with_error('a message')).should == {'_status' => 'error', '_message' => "a message"}
-  end
+    it "should generate a error response with a status message" do
+      JSON.parse(JsClientBridge::Responses.render_error('a message')).should == {'_status' => 'error', '_message' => "a message"}
+    end
 
-  it "should generate a error response with a status message and additional custom properties" do
-    JSON.parse(JsClientBridge::Responses.respond_with_error('a message', 'blame' => 'the user')).should == {'_status' => 'error', '_message' => "a message", 'blame' => 'the user'}
-  end
-  
-  it "should generate a error response with custom properties but not message" do
-    JSON.parse(JsClientBridge::Responses.respond_with_error('blame' => 'the user')).should == {'_status' => 'error', 'blame' => 'the user'}
+    it "should generate a error response with a status message and additional custom properties" do
+      JSON.parse(JsClientBridge::Responses.render_error('a message', 'blame' => 'the user')).should == {'_status' => 'error', '_message' => "a message", 'blame' => 'the user'}
+    end
+
+    it "should generate a error response with custom properties but not message" do
+      JSON.parse(JsClientBridge::Responses.render_error('blame' => 'the user')).should == {'_status' => 'error', 'blame' => 'the user'}
+    end
+
+    it "should generate a basic error response using JSONP" do
+      jsonp = JsClientBridge::Responses.render_error('a message', :jsonp => 'jsonp1')
+      jsonp[0..6].should == 'jsonp1('
+      jsonp[-1..-1].should == ')'
+      JSON.parse(jsonp[7..-2]).should == {'_message' => "a message", '_status' => 'error'}
+    end
   end
-  
-  it "should generate a basic error response using JSONP" do
-    jsonp = JsClientBridge::Responses.respond_with_error('a message', :jsonp => 'jsonp1')
-    jsonp[0..6].should == 'jsonp1('
-    jsonp[-1..-1].should == ')'
-    JSON.parse(jsonp[7..-2]).should == {'_message' => "a message", '_status' => 'error'}
+
+  describe "#respond_with_error" do
+    it "should generate a basic error response" do
+      JsClientBridge::Responses.respond_with_error.should == {'_status' => 'error'}
+    end
+
+    it "should generate a error response with a status message" do
+      JsClientBridge::Responses.respond_with_error('a message').should == {'_status' => 'error', '_message' => "a message"}
+    end
+
+    it "should generate a error response with a status message and additional custom properties" do
+      JsClientBridge::Responses.respond_with_error('a message', 'blame' => 'the user').should == {'_status' => 'error', '_message' => "a message", 'blame' => 'the user'}
+    end
+
+    it "should generate a error response with custom properties but not message" do
+      JsClientBridge::Responses.respond_with_error('blame' => 'the user').should == {'_status' => 'error', 'blame' => 'the user'}
+    end
   end
 end

data/spec/exception_responses_spec.rb

@@ -5,52 +5,99 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 class TestException < StandardError; end
 
 describe "Exception Responses" do
+  describe "#respond_with_exception" do
+    it "should generate an exception response" do
+      exception = TestException.new('An exception')
 
-  it "should generate an exception response" do
-    exception = TestException.new('An exception')
+      ex = JsClientBridge::Responses.respond_with_exception(exception, :request_uri => '/', :parameters => {:param1 => 'value1'})
 
-    ex = JSON.parse(JsClientBridge::Responses.respond_with_exception(exception, :request_uri => '/', :parameters => {:param1 => 'value1'}))
+      ex['_status'].should == 'exception'
+      ex['request_uri'].should == '/'
+      ex['parameters'].should == {'param1' => 'value1'}
+      ex['exceptions'].length.should == 1
 
-    ex['_status'].should == 'exception'
-    ex['request_uri'].should == '/'
-    ex['parameters'].should == {'param1' => 'value1'}
-    ex['exceptions'].length.should == 1
+      e = ex['exceptions'].first
+      e['name'].should == exception.class.to_s
+      e['message'].should == CGI.escape(exception.message)
+      e['backtrace'].should == exception.backtrace
+      e['short_name'].should == exception.class.to_s.split('::').last
+    end
 
-    e = ex['exceptions'].first
-    e['name'].should == exception.class.to_s
-    e['message'].should == CGI.escape(exception.message)
-    e['backtrace'].should == exception.backtrace
-    e['short_name'].should == exception.class.to_s.split('::').last
+    it "should require the request_uri option" do
+      lambda {
+        JsClientBridge::Responses.respond_with_exception(TestException.new('An exception'), :parameters => {:param1 => 'value1'})
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should require the exception option" do
+      lambda {
+        JsClientBridge::Responses.respond_with_exception(:request_uri => '/', :parameters => {:param1 => 'value1'})
+      }.should raise_error(ArgumentError)
+    end
   end
 
-  it "should generate an exceptions response" do
-    exceptions = [TestException.new('An exception'), TestException.new('Another exception')]
+  describe "#respond_with_exceptions" do
+    it "should generate an exceptions response" do
+      exceptions = [TestException.new('An exception'), TestException.new('Another exception')]
 
-    ex = JSON.parse(JsClientBridge::Responses.respond_with_exceptions(exceptions, :request_uri => '/', :parameters => {:param1 => 'value1'}))
+      ex = JsClientBridge::Responses.respond_with_exceptions(exceptions, :request_uri => '/', :parameters => {:param1 => 'value1'})
 
-    ex['_status'].should == 'exception'
-    ex['request_uri'].should == '/'
-    ex['parameters'].should == {'param1' => 'value1'}
-    ex['exceptions'].length.should == 2
+      ex['_status'].should == 'exception'
+      ex['request_uri'].should == '/'
+      ex['parameters'].should == {'param1' => 'value1'}
+      ex['exceptions'].length.should == 2
+    end
   end
+  
+  describe "#render_exception" do
+    it "should generate an exception response" do
+      exception = TestException.new('An exception')
 
-  it "should require the request_uri option" do
-    lambda {
-      JsClientBridge::Responses.respond_with_exception(TestException.new('An exception'), :parameters => {:param1 => 'value1'})
-    }.should raise_error(ArgumentError)
-  end
+      ex = JSON.parse(JsClientBridge::Responses.render_exception(exception, :request_uri => '/', :parameters => {:param1 => 'value1'}))
+
+      ex['_status'].should == 'exception'
+      ex['request_uri'].should == '/'
+      ex['parameters'].should == {'param1' => 'value1'}
+      ex['exceptions'].length.should == 1
+
+      e = ex['exceptions'].first
+      e['name'].should == exception.class.to_s
+      e['message'].should == CGI.escape(exception.message)
+      e['backtrace'].should == exception.backtrace
+      e['short_name'].should == exception.class.to_s.split('::').last
+    end
 
-  it "should require the exception option" do
-    lambda {
-      JsClientBridge::Responses.respond_with_exception(:request_uri => '/', :parameters => {:param1 => 'value1'})
-    }.should raise_error(ArgumentError)
+    it "should require the request_uri option" do
+      lambda {
+        JsClientBridge::Responses.render_exception(TestException.new('An exception'), :parameters => {:param1 => 'value1'})
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should require the exception option" do
+      lambda {
+        JsClientBridge::Responses.render_exception(:request_uri => '/', :parameters => {:param1 => 'value1'})
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should generate an exception response using JSONP" do
+      exception = TestException.new('An exception')
+
+      ex = JsClientBridge::Responses.render_exception(exception, :request_uri => '/', :parameters => {:param1 => 'value1'}, :jsonp => 'jsonp1')
+      ex[0..6].should == 'jsonp1('
+      ex[-1..-1].should == ')'
+    end
   end
   
-  it "should generate an exception response using JSONP" do
-    exception = TestException.new('An exception')
+  describe "#render_exceptions" do
+    it "should generate an exceptions response" do
+      exceptions = [TestException.new('An exception'), TestException.new('Another exception')]
+
+      ex = JSON.parse(JsClientBridge::Responses.render_exceptions(exceptions, :request_uri => '/', :parameters => {:param1 => 'value1'}))
 
-    ex = JsClientBridge::Responses.respond_with_exception(exception, :request_uri => '/', :parameters => {:param1 => 'value1'}, :jsonp => 'jsonp1')
-    ex[0..6].should == 'jsonp1('
-    ex[-1..-1].should == ')'
+      ex['_status'].should == 'exception'
+      ex['request_uri'].should == '/'
+      ex['parameters'].should == {'param1' => 'value1'}
+      ex['exceptions'].length.should == 2
+    end
   end
 end

data/spec/ok_responses_spec.rb

@@ -4,29 +4,49 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 
 
 describe "Ok Responses" do
-  it "should generate a basic ok response" do
-    JSON.parse(JsClientBridge::Responses.respond_with_ok).should == {'_status' => 'ok'}
-  end
+  describe "#respond_with_ok" do
+    it "should generate a basic ok response" do
+      JsClientBridge::Responses.respond_with_ok.should == {'_status' => 'ok'}
+    end
 
-  it "should generate a ok response with a status message" do
-    JSON.parse(JsClientBridge::Responses.respond_with_ok('a message')).should == {'_status' => 'ok', '_message' => "a message"}
-  end
+    it "should generate a ok response with a status message" do
+      JsClientBridge::Responses.respond_with_ok('a message').should == {'_status' => 'ok', '_message' => "a message"}
+    end
 
-  it "should generate a ok response with a status message and additional custom parameters" do
-    JSON.parse(JsClientBridge::Responses.respond_with_ok('a message', 'awesomeness' => 'has happened')).should == {'_status' => 'ok', '_message' => "a message", 'awesomeness' => 'has happened'}
-  end
-  
-  it "should generate a ok response with a status message and a complex parameters" do
-    JSON.parse(JsClientBridge::Responses.respond_with_ok('a message', 'stuff' => complext_test_data)).should == {'_message' => "a message", 'stuff' => complext_test_data, '_status' => 'ok'}
+    it "should generate a ok response with a status message and additional custom parameters" do
+      JsClientBridge::Responses.respond_with_ok('a message', 'awesomeness' => 'has happened').should == {'_status' => 'ok', '_message' => "a message", 'awesomeness' => 'has happened'}
+    end
+
+    it "should generate a ok response with a status message and a complex parameters" do
+      JsClientBridge::Responses.respond_with_ok('a message', 'stuff' => complext_test_data).should == {'_message' => "a message", 'stuff' => complext_test_data, '_status' => 'ok'}
+    end
   end
-  
-  it "should generate a basic ok response using JSONP" do
-    jsonp = JsClientBridge::Responses.respond_with_ok('a message', :jsonp => 'jsonp1')
-    jsonp[0..6].should == 'jsonp1('
-    jsonp[-1..-1].should == ')'
-    JSON.parse(jsonp[7..-2]).should == {'_status' => 'ok', '_message' => "a message"}
+
+  describe "#render_ok" do
+    it "should generate a basic ok response" do
+      JSON.parse(JsClientBridge::Responses.render_ok).should == {'_status' => 'ok'}
+    end
+
+    it "should generate a ok response with a status message" do
+      JSON.parse(JsClientBridge::Responses.render_ok('a message')).should == {'_status' => 'ok', '_message' => "a message"}
+    end
+
+    it "should generate a ok response with a status message and additional custom parameters" do
+      JSON.parse(JsClientBridge::Responses.render_ok('a message', 'awesomeness' => 'has happened')).should == {'_status' => 'ok', '_message' => "a message", 'awesomeness' => 'has happened'}
+    end
+
+    it "should generate a ok response with a status message and a complex parameters" do
+      JSON.parse(JsClientBridge::Responses.render_ok('a message', 'stuff' => complext_test_data)).should == {'_message' => "a message", 'stuff' => complext_test_data, '_status' => 'ok'}
+    end
+
+    it "should generate a basic ok response using JSONP" do
+      jsonp = JsClientBridge::Responses.render_ok('a message', :jsonp => 'jsonp1')
+      jsonp[0..6].should == 'jsonp1('
+      jsonp[-1..-1].should == ')'
+      JSON.parse(jsonp[7..-2]).should == {'_status' => 'ok', '_message' => "a message"}
+    end
   end
-  
+
   def complext_test_data
     [
       {'name'=>"Whangarei",

data/spec/validation_responses_spec.rb

@@ -26,24 +26,39 @@ describe "Validation Responses" do
     DataMapper.auto_migrate!
   end
   
-  it "should generate a basic validation response" do
-    test_do = Luma::Test::TestDO.new(:id => 'bob')
-    test_do.save.should be_false
+  describe "#respond_with_validation" do
+    it "should generate a basic validation response" do
+      test_do = Luma::Test::TestDO.new(:id => 'bob')
+      test_do.save.should be_false
 
-    ex = JSON.parse(JsClientBridge::Responses.respond_with_validation_error(test_do))
-    pp ex
-    ex['validation'].length.should == 2
-    ex['_short_type'].should == "TestDO"
-    ex['_type'].should == "Luma::Test::TestDO"
+      ex = JsClientBridge::Responses.respond_with_validation_error(test_do)
+      pp ex
+      ex['validation'].length.should == 2
+      ex['_short_type'].should == "TestDO"
+      ex['_type'].should == "Luma::Test::TestDO"
+    end
   end
-  
-  it "should generate a basic validation response using JSONP" do
-    test_do = Luma::Test::TestDO.new(:id => 'bob')
-    test_do.save.should be_false
 
-    ex = JsClientBridge::Responses.respond_with_validation_error(test_do, :jsonp => 'jsonp1')
-    ex[0..6].should == 'jsonp1('
-    ex[-1..-1].should == ')'
+  describe "#render_validation" do
+    it "should generate a basic validation response" do
+      test_do = Luma::Test::TestDO.new(:id => 'bob')
+      test_do.save.should be_false
+
+      ex = JSON.parse(JsClientBridge::Responses.render_validation(test_do))
+      pp ex
+      ex['validation'].length.should == 2
+      ex['_short_type'].should == "TestDO"
+      ex['_type'].should == "Luma::Test::TestDO"
+    end
+
+    it "should generate a basic validation response using JSONP" do
+      test_do = Luma::Test::TestDO.new(:id => 'bob')
+      test_do.save.should be_false
+
+      ex = JsClientBridge::Responses.render_validation(test_do, :jsonp => 'jsonp1')
+      ex[0..6].should == 'jsonp1('
+      ex[-1..-1].should == ')'
+    end
   end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Rolly Fordham
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-21 00:00:00 +13:00
+date: 2011-02-13 00:00:00 +13:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency