convenient-actionpack 0.0.1

data/README.md

@@ -0,0 +1,49 @@
+convenient-actionpack
+=====
+
+*Under construction... Watch your head.*
+
+Making common things easier for ActionController, etc.
+
+### Setup
+
+In your Rails 3.1+ project, add this to your Gemfile:
+
+    gem 'convenient-actionpack', :git => 'git://github.com/garysweaver/convenient-actionpack.git'
+
+Then run:
+
+    bundle install
+
+### Usage
+
+Provides a wrap method to rescue StandardError to return an informative JSON error from JSON services instead of HTML when there is an error:
+    
+    def create
+      wrap do
+        @my_model.save
+        respond_with @my_model
+      end
+    end
+
+If you don't like the standard functionality, you can implement a single error handling method in your ApplicationController to handle errors from all wrapped action methods:
+
+    def on_action_error(error)
+      case params[:format].to_sym
+      when :json
+        respond_with({errors: [error.message]}, location: nil, status: :internal_server_error)
+      else
+        raise error # should include prior backtrace
+      end
+    end
+
+### Future
+
+Originally was meant to provide a respond method that would skirt some of the unintuitive behavior of respond_with like [#2798][rails2798], and provide additional functionality, but that is commented for now. Maybe will get to it later. Feel free to fork/submit pull requests.
+
+### License
+
+Copyright (c) 2012 Gary S. Weaver, released under the [MIT license][lic].
+
+[rails2798]: https://github.com/rails/rails/issues/2798
+[lic]: http://github.com/garysweaver/convenient-actionpack/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/convenient-actionpack.rb

@@ -0,0 +1,3 @@
+require 'convenient-actionpack/version'
+require 'convenient-actionpack/controller'
+require 'convenient-actionpack/railtie' if defined?(Rails)

data/lib/convenient-actionpack/controller.rb

@@ -0,0 +1,62 @@
+module Convenient
+  module Controller
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+    end
+
+    def wrap
+      begin
+        yield
+      rescue
+        on_action_error($!)
+      end
+    end
+
+    # This is problematic and respond_with seems to function mostly normally.
+    # TODO: how to get around needing to specify location, as mentioned here, without interfering with existing functionality for html format, etc.: https://github.com/rails/rails/issues/2798
+    #def respond(*args)
+    #  #puts "respond args=#{args.inspect}"
+    #  options = args.extract_options!
+    #  raise ArgumentError.new 'respond takes one resource and an optional array of options' if args.size != 1
+    #  data = args[0]
+    #  if data.respond_to?(:errors) && data.try(:errors) && !(data.errors.respond_to?(:size) && data.errors.size == 0)
+    #    # was setting status: :unprocessable_entity but that is done by respond_with already
+    #    respond_with({errors: data.errors}, {location: nil}.merge!(options)) do
+    #      yield if block_given?
+    #    end
+    #  else
+    #    # respond_with requires location to be nil if not required, or it can be specified in options, in which case, we'll take it.
+    #    case params[:format].to_sym
+    #    when :json
+    #      options[:location] = (options[:status] == :accepted || params[:action] == :create) && !options[:location] ? show_uri(data) : options[:location]
+    #    end
+    #    
+    #    # respond_with should do this already
+    #    #options[:status] = :created if params[:action] == :create && !options[:status]
+    #
+    #    #puts "GOING TO respond_with #{data.inspect}, #{options.inspect}"
+    #
+    #    respond_with data, options do
+    #      # respond_with should do this already
+    #      #head :no_content if params[:action] == :destroy && !block_given?
+    #
+    #      yield if block_given?
+    #    end
+    #  end
+    #end
+    #
+    #def show_uri(data)
+    #  send("show_#{data.class.name.underscore}_path", data)
+    #end
+
+    def on_action_error(error)
+      case params[:format].to_sym
+      when :json
+        respond_with({errors: [error.message]}, {location: nil, status: :internal_server_error})
+      else
+        raise error # should include prior backtrace
+      end
+    end
+  end
+end

data/lib/convenient-actionpack/railtie.rb

@@ -0,0 +1,11 @@
+require 'convenient-actionpack'
+
+module Convenient
+  class Railtie < Rails::Railtie
+    initializer "convenient-actionpack.action_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        include Convenient::Controller
+      end
+    end
+  end
+end

data/lib/convenient-actionpack/version.rb

@@ -0,0 +1,3 @@
+module Convenient
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: convenient-actionpack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gary S. Weaver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Convenient functionality for actionpack.
+email:
+- garysweaver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/convenient-actionpack/controller.rb
+- lib/convenient-actionpack/railtie.rb
+- lib/convenient-actionpack/version.rb
+- lib/convenient-actionpack.rb
+- Rakefile
+- README.md
+homepage: https://github.com/garysweaver/convenient-actionpack
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Convenient functionality for actionpack.
+test_files: []