js-client-bridge 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0 2009-03-28
+
+* Repackaged an earlier version of this gem in a more modern way.

data/Manifest.txt

@@ -0,0 +1,21 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/js-client-bridge.rb
+lib/js-client-bridge/responses.rb
+lib/js-client-bridge/responses/ok.rb
+lib/js-client-bridge/responses/validation.rb
+lib/js-client-bridge/responses/error.rb
+lib/js-client-bridge/responses/exception.rb
+lib/js-client-bridge/extensions/datamapper_errors.rb
+script/console
+script/destroy
+script/generate
+spec/ok_responses_spec.rb
+spec/error_responses_spec.rb
+spec/exception_responses_spec.rb
+spec/validation_responses_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.txt

@@ -0,0 +1,186 @@
+= js-client-bridge
+
+* https://github.com/luma/js-client-bridge/tree/master
+
+== DESCRIPTION:
+
+Little library that encapsulates a (particular) standardised way of talking between a service and javascript. Probably not the best way of doing things, but it's been handy in a pinch.
+
+== FEATURES/PROBLEMS:
+
+* TODO
+
+== SYNOPSIS:
+
+=== Standard and Custom Fields
+Any fields that begin with a '_' are standard fields that will be used among all the different response types. These fields are quite often required or will have specific set behavior that the client side is expected to follow. Any fields that don't begin with '_' are custom fields and the client side can use them (or not) however they want.
+
+=== Use of JSON With Padding (JSONP)
+We support JSONP (see [http://bob.pythonmac.org/archives/2005/12/05/remote-json-jsonp/ Here] for an introduction to JSONP). Meaning that, rather than the standard JSON responses below:
+
+	{
+		_status  : 'ok',
+		_message : 'a status message'
+	} 
+
+
+A service may be required to return a response of the form:
+
+	jsonp_identifier_12321({
+		_status  : 'ok',
+		_message : 'a status message'
+	} )
+
+
+Whether JSONP is used for a response or not is decided by the calling client and services should support either response format.
+
+
+=== Everything's Cool Response
+This is returned when a remote call succeeds, it must include the status of 'ok'. It can optionally include a message, if a message is included it should be displayed to the user.
+
+
+==== Required Fields
+[_status]		String - This will always be 'ok'.
+
+
+==== Optional Fields
+[_message]		String - If sent from server-side client side should display it.
+
+==== Example
+	{
+		_status  : 'ok',
+		_message : 'a status message'
+	} 
+
+
+=== A General Error Occurred
+This is returned when a remote call fails with a general error, where in this case general error means we want to display feedback to the user but we want to leave any further action up to the client side. It can optionally include a message, if a message is included it should be displayed to the user.
+
+
+==== Required Fields
+[_status]		String - This will always be 'error'.
+
+==== Optional Fields
+[_message]		String - If sent from server-side client side should display it.
+
+==== Example
+	{
+		_status	: 'error',
+		_message	: 'asdfasfasd'
+	}
+
+=== An Unexpected Exception Occurred
+This is returned when something explodes on the server side. These errors are assumed to be unhandlable on the client side (due to the absurdly large number of possible errors). The client side should take the error info and display it to the user in a standard format. During development or testing this should include displaying all the information on the screen. What happens in production is an open question.
+
+
+==== Required Fields
+[_status]			String - This will always be 'error'.
+[_type]				String - This will be the fully namespaced name of the exception.
+[_short_type]	String - This will be the short, easily readable version of _type.
+[request_uri]	String - The uri of the original request that triggered this exception.
+[parameters]	Hash   - A hash of key/value pairs representing the query string or POSTed data. If there are none, an empty hash ({}) should be used.
+
+==== Optional Fields
+[_message]		String - If sent from server-side client side should display it.
+
+==== Example
+	{
+	  _status            : "exception",
+	  _type             : "Merb::Controller::Exceptions::InternalServerError",
+	  _short_type  : "InternalServerError",
+	  request_uri   : '/asdf,
+	  parameters    : {name : value, name : value, name : value},
+	  exceptions    : [
+	    {
+	      name     : 'Twimmy::Exceptions::ServerError',
+	      message  : 'A awful error occured',
+	      backtrace : [
+	        "file:line",
+	        "file:line",
+	        "file:line",
+	        "file:line"
+	      ]
+	  ]
+	}
+
+=== Validation for the Request Failed
+This response is returned when server side validation of an object failed, it should include enough information to display dynamic validation messages and highlight/animate input fields. It is suggested that to make this work seamlessly there must be some way to map html field ids to attribute names in a way that won't clash. One way that is quite efficient is to use form element ids of the form:
+  '''short_object_type-object_id-attribute_name'''
+
+Or if the object is not yet created and doesn't have an id:
+  '''short_object_type-attribute_name'''
+
+For example, if we were calling a remote service to update an Offer with the id of 1, and validation failed on the bid_amount field then the attribute mapping would be:
+  '''offer-1-bid_amount'''
+
+
+==== Example
+The advantage of this scheme is that dynamic validation UI bits can be applied to a client side form using something like the following (this is pseudo code, it's untested):
+
+	var response = get_response_from_server_side();
+
+	jQuery.each(response.validation, function(field_name, errors) {
+	  var field_id = [response._short_type, response.id, field_name].join('-');
+	  $('#' + field_id).highlight().shake().addClass('error').after("<strong class='form-error'>" + errors.join(', ') + "</strong>");
+	});
+
+==== Required Fields
+[_status]			String - This will always be 'exception'.
+[_type]				String - This will be the fully namespaced name of the exception.
+[_short_type]	String - This will be the short, easily readable version of _type.
+[validation]	Has - The keys of the hash are the field name on which the error occured. these should has no spaces. The values are arrays of strings, where each string is an error message.
+
+
+=== Optional Fields
+[_message]		String - If sent from server-side client side should display it.
+[id]					String - The server side id of the object.
+
+=== Example
+	{
+	 "_status"          => "validation",
+	 "_type"             => "Twimmy::Test::TestDO",
+	 "_short_type"  => "TestDO",
+	 "_message"     => "Sorry, we couldn't save your TestDO",
+	 "action"            => "create",
+	  "validation"  : {
+	                    "body"     :  ["Body must not be blank"],
+	                    "subject" :  ["Subject must not be blank", "Subject must be between 30 and 155 characters long"],
+	                    "id"          :  ["Id must not be blank"]
+	   },
+	} 
+
+== REQUIREMENTS:
+
+* json gem
+* extlib gem
+
+== INSTALL:
+The first line add's github as a source for your local rubygems.
+
+	sudo gem sources -a http://gems.github.com
+	sudo gem install luma-js-client-bridge
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Rolly
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,74 @@
+=begin
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/js-client-bridge'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('js-client-bridge', JsClientBridge::VERSION) do |p|
+  p.developer('Rolly', 'rolly@luma.co.nz')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+    ['json', '>= 0'],
+    ['extlib', '>= 0']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]
+
+desc "Run all examples (or a specific spec with TASK=xxxx)"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts  = ["-cfs"]
+  t.spec_files = begin
+    if ENV["TASK"] 
+      ENV["TASK"].split(',').map { |task| "spec/**/#{task}_spec.rb" }
+    else
+      FileList['spec/**/*_spec.rb']
+    end
+  end
+end
+
+#desc 'Default: run spec examples'
+#task :default => 'spec'
+=end
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'fileutils'
+require 'newgem'
+require 'rubigen'
+
+#require File.dirname(__FILE__) + '/lib/js-client-bridge'
+
+Hoe.spec 'js-client-bridge' do
+  developer 'Rolly', 'rolly@luma.co.nz'
+
+  extra_deps << ['json', '>= 0']
+  extra_deps << ['extlib', '>= 0']
+
+#  extra_dev_deps << ['newgem', ">= #{::Newgem::VERSION}"]
+=begin  
+  clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  rsync_args = '-av --delete --ignore-errors'
+=end
+end
+
+# vim: syntax=ruby
+

data/lib/js-client-bridge.rb

@@ -0,0 +1,14 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module JsClientBridge
+  VERSION = '0.1.0'
+end
+
+require 'rubygems'
+require 'json'
+require "extlib"
+require 'hoe'
+
+require 'js-client-bridge/responses'
+require 'js-client-bridge/extensions/datamapper_errors'

data/lib/js-client-bridge/extensions/datamapper_errors.rb

@@ -0,0 +1,43 @@
+
+module DataMapper
+  module Validate
+
+    ##
+    #
+    # Monkey patch of Datamapper to add a nice to_json method that uses our error format
+    class ValidationErrors
+
+      def to_hash
+        js = {}
+      
+        errors.each do |list, pair|
+          js[list] = pair
+        end
+      
+        js
+      end
+
+    end # class ValidationErrors
+  end # module Validate
+end # module DataMapper
+
+module DataMapper
+  module Resource
+    def errors_to_hash(message = "Sorry, we couldn't save your #{self.class.to_s.split('::').last}")
+    
+      short_type = self.class.to_s.split('::').last
+    
+      validation = {
+        :_status       => 'validation',
+        :_type        => self.class,
+        :_short_type  => short_type,
+        :_message      => message,
+        :validation   => self.errors.to_hash,
+      }
+    
+      validation[:id] = self.id.to_s unless new_record?
+    
+      validation
+    end
+  end # module Resource
+end # module DataMapper

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

@@ -0,0 +1,47 @@
+require 'cgi'
+
+base = File.dirname(__FILE__) / 'responses'
+%w(ok error exception validation).each {|f| require base / f }
+
+module JSClientBridge #:nodoc:
+  module Responses      
+    class << self
+      include Responses::Ok
+      include Responses::Error
+      include Responses::Exception
+      include Responses::Validation
+
+      protected
+      
+      def formatting_parameters
+        [:jsonp]
+      end
+      
+      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)
+        else
+          options = {}
+        end
+        
+        # separate out formatting parameters
+        formatting = {}
+        for para in formatting_parameters
+          formatting[para] = options.delete(para) if options.include?(para)
+        end
+        
+        [options.merge({ :_status => type.to_s }), formatting]
+      end
+      
+      def format_response(response, formatting_options = {})
+        # Handle JSONP responses
+        if formatting_options[:jsonp].blank?
+          response.to_json
+        else
+          "#{formatting_options[:jsonp]}(#{response.to_json})"
+        end
+      end
+    end
+  end # module Responses
+end # module JSClientBridge

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

@@ -0,0 +1,22 @@
+require 'cgi'
+
+module JSClientBridge #:nodoc:
+  module Responses #:nodoc:
+    module Error
+      # 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.
+      #
+      # ==== Parameters
+      # message<String>:: An optional message.
+      # options<Hash>:: Custom optionss.
+      #
+      # ==== Returns
+      # JSON String:: 
+      def respond_with_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

@@ -0,0 +1,60 @@
+require 'cgi'
+
+module JSClientBridge #:nodoc:
+  module Responses #:nodoc:
+    module Exception
+      
+      def respond_with_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
+
+      def respond_with_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
+
+    end # module Exception
+  end # module Responses
+end # module JSClientBridge

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

@@ -0,0 +1,21 @@
+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
+      # 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.
+      #
+      # ==== Returns
+      # JSON String::
+      def respond_with_ok(*args)
+        format_response(*respond_with('ok', args))
+      end
+    end # module Ok
+  end # module Responses
+end # module JSClientBridge

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

@@ -0,0 +1,47 @@
+require 'cgi'
+
+module JSClientBridge #:nodoc:
+  module Responses #:nodoc:
+    module Validation
+      # 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.
+      #
+      # ==== Parameters
+      # message<String>:: An optional message.
+      # options<Hash>:: Custom optionss.
+      #
+      # ==== Returns
+      # JSON String::
+      def respond_with_validation_error(*args)
+        if args.blank? || !args.first.respond_to?(:errors_to_hash)
+          raise ArgumentError.new("respond_with_validation_error requires an object that responds to errors_to_hash as it's first parameter")
+        end
+        
+        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(obj.errors_to_hash(options.delete(:message)))
+                      
+                    else
+                      options.merge(obj.errors_to_hash)
+                    end
+
+        format_response(response, options)
+      end
+
+    end # module Validation
+  end # module Responses
+end # module JSClientBridge
+
+=begin
+{
+  :_status       => 'validation',
+  :_type        => self.class,
+  :_short_type  => self.class.to_s.split('::').first,
+  :_message      => message,
+  :validation   => self.errors.to_json
+}
+=end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/js-client-bridge.rb'}"
+puts "Loading js-client-bridge gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/error_responses_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Error Responses" do
+  it "should generate a basic error response" do
+    JSClientBridge::Responses.respond_with_error.should == {:_status => 'error'}.to_json
+  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"}.to_json
+  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'}.to_json
+  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'}.to_json
+  end
+  
+  it "should generate a basic error response using JSONP" do
+    JSClientBridge::Responses.respond_with_error('a message', :jsonp => 'jsonp1').should == "jsonp1(#{{:_status => 'error', :_message => "a message"}.to_json})"
+  end
+end

data/spec/exception_responses_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+
+class TestException < StandardError; end
+
+describe "Exception Responses" do
+
+  it "should generate an exception response" do
+    exception = TestException.new('An exception')
+
+    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
+
+    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 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['_status'].should == 'exception'
+    ex['request_uri'].should == '/'
+    ex['parameters'].should == {'param1' => 'value1'}
+    ex['exceptions'].length.should == 2
+  end
+
+  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
+  
+  it "should generate an exception response using JSONP" do
+    exception = TestException.new('An exception')
+
+    ex = JSClientBridge::Responses.respond_with_exception(exception, :request_uri => '/', :parameters => {:param1 => 'value1'}, :jsonp => 'jsonp1')
+    ex[0..6].should == 'jsonp1('
+    ex[-1..-1].should == ')'
+  end
+end

data/spec/ok_responses_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+
+
+
+describe "Ok Responses" do
+  it "should generate a basic ok response" do
+    JSClientBridge::Responses.respond_with_ok.should == {:_status => 'ok'}.to_json
+  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"}.to_json
+  end
+
+  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'}.to_json
+  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'}.to_json
+  end
+  
+  it "should generate a basic ok response using JSONP" do
+    JSClientBridge::Responses.respond_with_ok('a message', :jsonp => 'jsonp1').should == "jsonp1(#{{:_status => 'ok', :_message => "a message"}.to_json})"
+  end
+  
+  def complext_test_data
+    [
+      {:name=>"Whangarei",
+      :description=>"Northland Coach & Travel Centre, 3C Bank St.",
+      :id=>:WRE},
+      {:name=>"Westwood Lodge", :description=>"Westwood Lodge", :id=>:WWL},
+      {:name=>"Queenstown YHA Lake Esplanade",
+      :description=>"Queenstown YHA, 80 Lake Esplanade",
+      :id=>:YHQ},
+      {:name=>"Queenstown Airport", :description=>"Queenstown Airport", :id=>:ZQA},
+      {:name=>"Queenstown",
+      :description=>"Athol Street in the middle of the car park",
+      :id=>:ZQN},
+      {:name=>"Queenstown The Station",
+      :description=>"The Station, corner of Camp and Shotover Streets",
+      :id=>:ZQT}
+    ]
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'js-client-bridge'
+
+require 'pp'

data/spec/validation_responses_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+require 'dm-core'
+require 'dm-aggregates'
+require 'dm-migrations'
+require 'dm-timestamps'
+require 'dm-types'
+require 'dm-validations'
+
+module Luma
+  module Test
+    class TestDO
+      include DataMapper::Resource
+
+      property :id,                     String, :key => true, :length => 36
+
+      property :subject,                String, :length => 30..155, :nullable => false
+      property :body,                   Text, :nullable => false
+    end # class Message
+  end
+end
+  
+describe "Validation Responses" do
+  before(:all) do
+    DataMapper.setup(:default, 'sqlite3::memory:')
+    DataMapper.auto_migrate!
+  end
+  
+  it "should generate a basic validation response" do
+    test_do = Luma::Test::TestDO.new
+    test_do.save.should be_false
+
+    ex = JSON.parse(JSClientBridge::Responses.respond_with_validation_error(test_do))
+    pp ex
+    ex['validation'].length.should == 3
+    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
+    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 == ')'
+  end
+end
+
+
+=begin
+{
+  :_status       => 'validation',
+  :_type        => self.class,
+  :_short_type  => self.class.to_s.split('::').first,
+  :_message      => message,
+  :validation   => self.errors.to_json
+}
+
+{
+  "validation"=> {
+                    "body"    =>  ["Body must not be blank"],
+                    "subject" =>  ["Subject must not be blank", "Subject must be between 30 and 155 characters long"],
+                    "id"      =>  ["Id must not be blank"]
+                  },
+ "_short_type"  => "TestDO",
+ "_status"      => "validation",
+ "_type"        => "Luma::Test::TestDO",
+ "_message"     => "Sorry, we couldn't save your TestDO"
+}
+
+=end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification 
+name: js-client-bridge
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rolly
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-02 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 1
+        version: 0.4.1
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id005
+description: Little library that encapsulates a (particular) standardised way of talking between a service and javascript. Probably not the best way of doing things, but it's been handy in a pinch.
+email: 
+- rolly@luma.co.nz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/js-client-bridge.rb
+- lib/js-client-bridge/responses.rb
+- lib/js-client-bridge/responses/ok.rb
+- lib/js-client-bridge/responses/validation.rb
+- lib/js-client-bridge/responses/error.rb
+- lib/js-client-bridge/responses/exception.rb
+- lib/js-client-bridge/extensions/datamapper_errors.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/ok_responses_spec.rb
+- spec/error_responses_spec.rb
+- spec/exception_responses_spec.rb
+- spec/validation_responses_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: https://github.com/luma/js-client-bridge/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: js-client-bridge
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Little library that encapsulates a (particular) standardised way of talking between a service and javascript
+test_files: []
+