js_message 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in js_message.gemspec
+gemspec

data/README.md

@@ -0,0 +1,25 @@
+jsMessage
+=========
+
+jsMessage standardizes javascript interaction between the front end (html) and a rails application.
+
+See this blog post: http://paydrotalks.com/posts/45-standard-json-response-for-rails-and-jquery
+
+Installation
+------------
+
+In your Rails 3 <code>Gemfile</code> add:
+
+    gem "js_message"
+
+Then run the following rake task and follow the instructions:
+
+    rake js_message:install
+
+You're all set!
+
+Author
+======
+
+Peter Bui
+peter@paydrotalks.com

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/js/jquery.js_message.js

@@ -0,0 +1,70 @@
+(function($){
+    // Checks that a console arg is available before logging to it
+    $.log = function(msg){
+        if(window.console && DEBUG){
+            console.log(msg);
+        }
+    };
+
+    // Appends the ".jsm" to a URL. It will not append the extension
+    // if the URL already has it.
+    $.appendJSMExt = function(url){
+        if(url.indexOf(".jsm") !== -1){
+            return url;
+        }
+
+        var parts = url.split("?");
+        var request = parts[0];
+        var params = parts[1];
+
+        var jsmUrl = request + ".jsm";
+        if(params){
+            jsmUrl += "?" + params;
+        }
+
+        return jsmUrl;
+    };
+
+    // Send a standard structured JSON message to the server.
+    $.jsMessage = function(options){
+        var validRespFunc = options.success || function(jsonResponse){
+            $.log("Valid response returned");
+            $.log(jsonResponse);
+        };
+
+        var invalidRespFunc = options.error || function(jsonResponse){
+            $.log("Invalid response returned");
+            $.log(jsonResponse);
+        };
+
+        options.success = function(jsonResponse){
+            if(jsonResponse.status == "redirect"){
+                window.location = jsonResponse.to;
+            }
+            else{
+                validRespFunc(jsonResponse);
+            }
+        };
+
+        options.error = function(XMLHttpRequest, textStatus){
+            if(XMLHttpRequest.status == 400){
+                jsonResponse = $.parseJSON(XMLHttpRequest.responseText);
+                invalidRespFunc(jsonResponse);
+            }
+            else{
+                $.log("Request error: " + textStatus);
+                $.log(XMLHttpRequest);
+            }
+        };
+
+        options.dataType = "json";
+        options.type = options.type || "POST";
+        options.url = $.appendJSMExt(options.url);
+
+        $.ajax(options);
+    };
+
+})(jQuery);
+
+
+

data/js_message.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "js_message/version"
+
+Gem::Specification.new do |s|
+  s.name        = "js_message"
+  s.version     = JsMessage::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Peter Bui"]
+  s.email       = ["peter@paydrotalks.com"]
+  s.homepage    = "http://github.com/paydro/js_message"
+  s.summary     = %q{Pass structured json messages between html and a rails application}
+  s.description = %q{Pass structured json messages between html and a rails application}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/js_message/controller_methods.rb

@@ -0,0 +1,47 @@
+module JsMessage
+  module ControllerMethods
+    # Helper to render the js_message response.
+    #
+    # Pass in a type of message (:ok, :error, :redirect) and any other
+    # data you need. Default data attributes in the response are:
+    #
+    #   * html
+    #   * message
+    #   * to (used for redirects)
+    #
+    # Examples:
+    #
+    #   # Send a successful response with some html
+    #   render_js_message :ok, :html => "<p>It worked!</p>"
+    #
+    #   # Send a redirect
+    #   render_js_message :redirect, :to => "http://www.google.com"
+    #
+    #   # Send an error response with a message
+    #   render_js_message :error, :message => "Something broke!"
+    #
+    # Of course, if you don't need other data sent back in the response
+    # this works as well:
+    #
+    #   render_js_message :ok
+    #
+    def render_js_message(type, hash = {})
+      unless [ :ok, :redirect, :error ].include?(type)
+        raise "Invalid js_message response type: #{type}"
+      end
+
+      js_message = {
+        :status => type,
+        :html => nil,
+        :message => nil,
+        :to => nil
+      }.merge(hash)
+
+      render_options = {:json => js_message}
+      render_options[:status] = 400 if type == :error
+
+      render(render_options)
+    end
+
+  end
+end

data/lib/js_message/railtie.rb

@@ -0,0 +1,18 @@
+require 'js_message'
+require 'rails'
+
+module JsMessage
+  class Railtie < Rails::Railtie
+    initializer "js_message.initializer" do |app|
+      ActionController::Base.class_eval do
+        include JsMessage::ControllerMethods
+      end
+
+      Mime::Type.register_alias "application/json", :jsm
+    end
+
+    rake_tasks do
+      load "js_message/tasks.rake"
+    end
+  end
+end

data/lib/js_message/tasks.rake

@@ -0,0 +1,20 @@
+namespace :js_message do
+  desc "Install the jquery.js_message.js into your public/javascripts dir"
+  task :install do
+    gemdir = File.join(File.dirname(__FILE__), "..", "..",)
+    print "\n  Copying 'jquery.js_message.js' to rails' public/javascripts dir ... "
+    FileUtils.cp(
+      File.join(gemdir, "js", "jquery.js_message.js"),
+      Rails.root.join("public", "javascripts")
+    )
+    puts "Done."
+
+    puts %q[
+  Now just add the following lines into your application's layout files:
+
+  <%= javascript_include_tag "jquery.js_message.js" %>
+
+  And you're all set!
+    ]
+  end
+end

data/lib/js_message/version.rb

@@ -0,0 +1,3 @@
+module JsMessage
+  VERSION = "0.0.1"
+end

data/lib/js_message.rb

@@ -0,0 +1,3 @@
+require "js_message/controller_methods"
+require "js_message/railtie"
+

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: js_message
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Bui
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-14 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Pass structured json messages between html and a rails application
+email: 
+- peter@paydrotalks.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- js/jquery.js_message.js
+- js_message.gemspec
+- lib/js_message.rb
+- lib/js_message/controller_methods.rb
+- lib/js_message/railtie.rb
+- lib/js_message/tasks.rake
+- lib/js_message/version.rb
+has_rdoc: true
+homepage: http://github.com/paydro/js_message
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Pass structured json messages between html and a rails application
+test_files: []
+