simple_rest 0.0.1

data/README.rdoc

@@ -0,0 +1,141 @@
+= Simple Rest
+
+ * http://github.com/niquola/simple_rest
+
+== DESCRIPTION
+
+ActionControllers helper methods for restful response handling
+Just DRY respond_to do |format|; ...;  end;
+Support for jsonp and pdf
+  
+
+== INSTALL:
+
+in config/environment.rb 
+
+  config.gem 'simple_rest'
+
+then
+
+  sudo rake gems:install
+
+To handle uncatched exceptios restfully  add this to ApplicationController
+
+ class ApplicationController < ApplicationController::Base
+    rescue_exceptions_restfully
+ end
+
+== USAGE  
+
+Example:
+   
+    def action 
+      #fetch result
+      options = {:status=>:ok,:serialize_opts=>some options will be passed to to_json or to_xml}
+      simple_rest result,options
+    end
+
+See more in tests  
+
+== TEST EXAMPLES:
+
+
+  ActionController::Routing::Routes.draw do |map|
+    map.connect ':controller/:action/:id.:format'
+    map.connect ':controller/:action.:format'
+    map.connect ':controller/:action/:id'
+  end
+
+  class MyController < ActionController::Base
+    rescue_exceptions_restfully
+
+    class MyException< Exception
+    end
+
+    rescue_from MyException do |exception|
+      simple_rest({:message=>exception.to_s},{:status=>500})
+    end
+
+    def index
+      result = {:field=>'value'}
+      simple_rest result
+    end
+
+    def action_with_error
+      raise MyException.new("Some error")
+    end
+
+    def action_with_uncatched_error
+      raise Exception.new("Some error")
+    end
+  end
+
+  class MyControllerTest < ActionController::TestCase
+    def test_methods_mixed
+      assert(MyController.new.respond_to?(:simple_rest))
+    end
+
+    def test_js_format
+      get :index, :format => 'js'
+      resp = @response.body
+      assert(resp)
+      resp_obj = nil
+      assert_nothing_raised(Exception) {
+        resp_obj = ActiveSupport::JSON.decode(resp)
+      }
+      assert_not_nil(resp_obj)
+      assert_equal('value', resp_obj['field'])
+    end
+
+    def test_jsonp_format
+      get :index, :format => 'jsonp'
+      resp = @response.body
+      assert(resp)
+      resp_obj = nil
+      assert_nothing_raised(Exception) {
+        resp_obj = ActiveSupport::JSON.decode(resp)
+      }
+      assert_not_nil(resp_obj)
+      assert_not_nil(resp_obj['status'])
+      assert_equal(200,resp_obj['status'])
+      assert_equal('value',resp_obj['data']['field'])
+    end
+
+    def test_xml_format
+      get :index, :format => 'xml'
+      resp_obj = nil
+      assert_nothing_raised(Exception) {
+        resp_obj = html_document
+      }
+      assert_not_nil(resp_obj)
+      #FIXME: add more asserts
+    end
+
+    def test_jsonp_exception
+      get :action_with_error, :format => 'jsonp'
+      resp = @response.body
+      resp_obj = nil
+      assert_nothing_raised(Exception) {
+        resp_obj = ActiveSupport::JSON.decode(resp)
+      }
+      assert_not_nil(resp_obj)
+      assert_not_nil(resp_obj['data']['message'])
+      assert_equal(500,resp_obj['status'])
+    end
+
+    def test_rescue_exceptions_restfully
+      get :action_with_uncatched_error, :format => 'jsonp'
+      resp = @response.body
+      resp_obj = nil
+      assert_nothing_raised(Exception) {
+        resp_obj = ActiveSupport::JSON.decode(resp)
+      }
+      assert_not_nil(resp_obj)
+      assert_not_nil(resp_obj['data']['message'])
+      assert_equal(500,resp_obj['status'])
+      assert_response(:ok)
+
+      get :action_with_uncatched_error, :format => 'js'
+      assert_response(500)
+    end
+  end

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the dojo_on_rails plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+desc 'Generate rdoc'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Simple Rest'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+PKG_FILES = FileList[ '[a-zA-Z]*', 'lib/**/*', 'test/**/*' ]
+
+spec = Gem::Specification.new do |s|
+  s.name = "simple_rest"
+  s.version = "0.0.1"
+  s.author = "niquola,smecsia"
+  s.email = "niquola@gmail.com,smecsia@gmail"
+  #s.homepage = ""
+  s.platform = Gem::Platform::RUBY
+  s.summary = "ActionControllers helpers for restful rails"
+  s.add_dependency('rails', '>= 2.3.5')
+  s.files = PKG_FILES.to_a 
+  s.require_path = "lib"
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.rdoc"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/lib/simple_rest.rb

@@ -0,0 +1,25 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+module SimpleRest
+  VERSION = '0.0.1'
+  autoload :ActionControllerMethods, 'simple_rest/action_controller_methods'
+  class << self
+    def enable
+      ActionController::Base.send :include, ActionControllerMethods
+      enable_mime_types
+    end
+
+    def enable_mime_types
+      unless defined? Mime::PDF
+        Mime::Type.register("application/pdf", :pdf)
+      end
+      unless defined? Mime::JSONP
+        Mime::Type.register("text/javascript", :jsonp)
+      end
+    end
+  end
+end
+
+if defined? ActionController
+  SimpleRest.enable if defined? ActionController
+end

data/lib/simple_rest/action_controller_methods.rb

@@ -0,0 +1,61 @@
+module SimpleRest
+  module ActionControllerMethods
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def rescue_exceptions_restfully
+        rescue_from Exception do |exception|
+          simple_rest({:message=>exception.to_s},{:status=>500})
+        end
+      end
+    end
+
+    def simple_rest(data, opts={})
+      status= opts[:status] || :ok
+      serial_opts= opts[:serialize_opts] || {}
+      respond_to do |format|
+        format.js { render :json => data.to_json(serial_opts),:status=>status}
+        format.html { render}
+        format.yaml { render :partial=> 'shared/inspect',:content_type =>'text/html',:locals => { :data => data } ,:status=>status }
+        format.xml  { render :xml => data.to_xml(serial_opts),:status=>status}
+        format.pdf  { render (opts[:pdf_opts] || {}).merge(:layout=>false) }
+        format.jsonp { render_jsonp(data,opts) }
+      end
+    end
+
+    def render_jsonp(data, options={})
+      text = build_jsonp_message(data,options)
+      render({:content_type => :js, :text => text}.merge(options.merge(:status=>:ok)))
+    end
+
+    def build_jsonp_message(data,options)
+      message = {:status=>options[:status] || 200, :data=>data}
+      json=message.to_json(options)
+      callback, variable = params[:callback], params[:variable]
+      response =
+      begin
+        if callback && variable
+          "var #{variable} = #{json};\n#{callback}(#{variable});"
+        elsif variable
+          "var #{variable} = #{json};"
+        elsif callback
+          "#{callback}(#{json});"
+        else
+          json
+        end
+      end
+    end
+
+    def store_location
+      session[:return_to] = request.request_uri
+    end
+
+    def redirect_back_or_default(default)
+      redirect_to(session[:return_to] || default)
+      session[:return_to] = nil
+    end
+
+  end
+end

data/test/simple_rest_test.rb

@@ -0,0 +1,102 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action/:id.:format'
+  map.connect ':controller/:action.:format'
+  map.connect ':controller/:action/:id'
+end
+
+class MyController < ActionController::Base
+  rescue_exceptions_restfully
+
+  class MyException< Exception
+  end
+
+  rescue_from MyException do |exception|
+    simple_rest({:message=>exception.to_s},{:status=>500})
+  end
+
+  def index
+    result = {:field=>'value'}
+    simple_rest result
+  end
+
+  def action_with_error
+    raise MyException.new("Some error")
+  end
+
+  def action_with_uncatched_error
+    raise Exception.new("Some error")
+  end
+end
+
+class MyControllerTest < ActionController::TestCase
+  def test_methods_mixed
+    assert(MyController.new.respond_to?(:simple_rest))
+  end
+
+  def test_js_format
+    get :index, :format => 'js'
+    resp = @response.body
+    assert(resp)
+    resp_obj = nil
+    assert_nothing_raised(Exception) {
+      resp_obj = ActiveSupport::JSON.decode(resp)
+    }
+    assert_not_nil(resp_obj)
+    assert_equal('value', resp_obj['field'])
+  end
+
+  def test_jsonp_format
+    get :index, :format => 'jsonp'
+    resp = @response.body
+    assert(resp)
+    resp_obj = nil
+    assert_nothing_raised(Exception) {
+      resp_obj = ActiveSupport::JSON.decode(resp)
+    }
+    assert_not_nil(resp_obj)
+    assert_not_nil(resp_obj['status'])
+    assert_equal(200,resp_obj['status'])
+    assert_equal('value',resp_obj['data']['field'])
+  end
+
+  def test_xml_format
+    get :index, :format => 'xml'
+    resp_obj = nil
+    assert_nothing_raised(Exception) {
+      resp_obj = html_document
+    }
+    assert_not_nil(resp_obj)
+    #FIXME: add more asserts
+  end
+
+  def test_jsonp_exception
+    get :action_with_error, :format => 'jsonp'
+    resp = @response.body
+    resp_obj = nil
+    assert_nothing_raised(Exception) {
+      resp_obj = ActiveSupport::JSON.decode(resp)
+    }
+    assert_not_nil(resp_obj)
+    assert_not_nil(resp_obj['data']['message'])
+    assert_equal(500,resp_obj['status'])
+  end
+
+  def test_rescue_exceptions_restfully
+    get :action_with_uncatched_error, :format => 'jsonp'
+    resp = @response.body
+    resp_obj = nil
+    assert_nothing_raised(Exception) {
+      resp_obj = ActiveSupport::JSON.decode(resp)
+    }
+    assert_not_nil(resp_obj)
+    assert_not_nil(resp_obj['data']['message'])
+    assert_equal(500,resp_obj['status'])
+    assert_response(:ok)
+
+    get :action_with_uncatched_error, :format => 'js'
+    assert_response(500)
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+def path(path)
+  File.join(File.dirname(__FILE__),path)
+end
+
+$:.unshift(path('../lib'))
+require 'rubygems'
+require "test/unit"
+require 'active_support'
+require 'active_support/test_case'
+require 'action_controller'
+require 'simple_rest'
+

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: simple_rest
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- niquola,smecsia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-04 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
+description: 
+email: niquola@gmail.com,smecsia@gmail
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- README.rdoc
+- lib/simple_rest/action_controller_methods.rb
+- lib/simple_rest.rb
+- test/simple_rest_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ActionControllers helpers for restful rails
+test_files: []
+