restful_json 3.3.0 → 3.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODY3NTY5N2RkMDE2ZDI2M2JhMjQ2ZTEwY2RiMjYyMDJiODlmOGU3OA==
+    YjYwZWQ2YjYyMTlmYTU5ZDJjNDg3NzBhNWUzMzFiYjA3MTEwYjdkYQ==
   data.tar.gz: !binary |-
-    NmJiNTYyMTM0NDRjMWI0NTIzYTIzNmRmY2YyNGYzOGYyZDlhNjUxMw==
+    NTQ2MWYxMzMxZDc2Y2E3ZTVjOWU1YzcxNWI1MTk3ZTlkZjI5YjdjNw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YzFiZjlhMzA1YWYwM2UxNGExYjZhZDg0MGFmZWM0NjhjNjRhMTBmNmQwYWM5
-    MTUzMmYwOGJlZDQ0ZDA4MjFiZjRiZjlkMmEzZDY5MjY4MzJmZGFhZGY5NGJh
-    MTM3Yjc0OTA1YWQ0MGFhYjQwNTgxYzM2M2Y2ZmMzODE5YmQ3ZjM=
+    NzRhYjAxZjkwOTRiZDdiNmYyZjRiNGEzZWM2OTQwMTA4NzVhM2UwZjY1ZDg4
+    YzYzNjU4MmU4NjJiYjE1ODBhOWRiYzQ3Y2Y4M2Q2M2RjYjhmYzZmOTBmMTU3
+    ZDZkYWQyOWIyYmExZmI5NjA0ODQzY2I1NGQxOGFmNTAzZjU5NWU=
   data.tar.gz: !binary |-
-    Mjg2ZGU1ZmI5NWY5MjFjOTM4ZmYwZGI0ZjdmMmMxOGIxNmU1NWYxMTA3YTJj
-    YTk0NjRkMDE2MTVmNjdmMTRiOTBhNzdmZmYzMWZjOTBjYzJjNGNkNTcyYzc5
-    YTVlYzI5ZTkxMWMzOWMyZDc2ZDFlNDgzZTRlNzAzYWU1NmE2MDI=
+    ODhlY2RiMTk3YTFlOGJiMGZiMjBlY2YxMDliMjczMzNiNDJmN2VmYmU2NTY1
+    OTUxNzhiNDJhZjMzZjI2ZjdlNWQzMzlhOWE2YThlNjQ3YWJlMmViOGJjOGMw
+    YWMwN2NiODVmM2IyNGE3YzMzZDllNTYzNWJjNDU3NTliOTlkNGI=

data/README.md

@@ -6,22 +6,22 @@ What does that mean? It means you typically won't have to write index, create, u
 
 Why do you need this if Rails controllers already make it easy to provide RESTful JSON services via generated controllers? Because this is just as flexible, almost as declarative, and takes less code. That means your controllers will be easier to read and there will be less code to maintain, but when you need an action method more customized than we can provide, that's all you'll have to write.
 
-restful_json is tested by travis-ci with with Rails 3.1, 3.2, and Rails 4. Feel free to submit issues and/or do a pull requests if you run into anything.
+The goal of the project is to reduce service controller code in an intuitive way, not to be a be-everything DSL or limit what you can do in a controller. Choose what features to expose, and you can still define/redefine actions etc. at will.
 
-Your options for JSON response (the view):
+We test with travis-ci with with Rails 3.1, 3.2, and Rails 4. Feel free to submit issues and/or do a pull requests if you run into anything.
+
+You can use any of these for the JSON response (the view):
 * [active_model_serializers][active_model_serializers] - also provides the serialize_action class method in the controller to specify custom serializers (assuming you are using a later version of active_model_serializers that works with respond_with). 
 * JBuilder - to use, set render_enabled in the restful_json config to false.
 * Just about anything else that works with render/respond_with, or that just adjust the view like JBuilder, and don't require extra work in the controller.
 
-Your options for authorizing parameters in incoming JSON (for POSTing create/update):
+And can use any of the following for authorizing parameters in the incoming JSON (for create/update):
 * Adam Hawkins' [permitters][permitter] which use [Strong Parameters][strong_parameters] and [Cancan][cancan]. Permitters are an object-oriented way of defining what is permitted in the incoming JSON, and are a great compliment in the same way that ActiveModel::Serializers are. Cancan supports [Authlogic][authlogic], [Devise][devise], etc.
 * [Strong Parameters][strong_parameters] - lets you only have to define `(single model name)_params` and/or `create_(single model name)_params` and/or `update_(single model name)_params` which can call require, permit, etc. on params.
 * Mass assignment security in Rails 3.x (attr_accessible, etc.).
 
 An example app using an older version of restful_json with AngularJS is [employee-training-tracker][employee-training-tracker], featured in [Built with AngularJS][built_with_angularjs].
 
-The goal of restful_json is to reduce service controller code in an intuitive way, not to be a be-everything DSL. You can choose whether or not to use it and what features to expose at the controller-level, and you can customize controllers and re-define actions/define custom actions.
-
 ### Installation
 
 In your Rails app's `Gemfile`:
@@ -41,51 +41,19 @@ Then:
 
     bundle install
 
-#### Service Controller Additions
-
-To clean up your controllers and to make restful_json more flexible and less complex, we suggest use of a module to hold the includes that you'll need depending on what you decide to use. We'll call it ServiceControllerAdditions:
-
-Create a file called `app/controllers/service_controller_additions.rb` and put this in it:
-
-    module ServiceControllerAdditions
-      extend ActiveSupport::Concern
-      
-      included do
-        # comment this out if you don't want to use ActiveModel::Seriaizers
-        include ::ActionController::Serialization
-        # comment this out if you don't want to use Strong Parameters or Permitters
-        include ::ActionController::StrongParameters
-        # comment this out if you don't want to use Permitters
-        include ::TwinTurbo::Controller
-        # comment this out if you don't want to use restful_json
-        include ::RestfulJson::Controller
-      end
-      
-    end
-
-That way you can just put this at the top of your controller, and will be able to easily extend the functionality of multiple controllers at once, e.g.:
-
-    class FoobarsController < ApplicationController
-      include ServiceControllerAdditions
-    end
-
-However, if you plan to use Permitters and ActiveModel::Serializers, use the "default". It is called the default, because v3 started off with Permitters and ActiveModel::Serializers controller, etc. includes being done by the restful_json gem, which no longer happens:
-
-    class FoobarsController < ApplicationController
-      include RestfulJson::DefaultController
-    end
+#### Strong Parameters
 
-`acts_as_restful_json` was deprecated in restful_json 3.3.0. It just calls `include RestfulJson::DefaultController`.
+Strong Parameters is not required, but can be used on its own or as a dependency of Permitters.
 
-#### Strong Parameters
+If you are using Rails 4.x, you might be able to skip this section, as [Strong Parameters][strong_parameters] is included.
 
-If you plan to use Permitters or if you want to use Strong Parameters by itself, you will need to tweak things for [Strong Parameters][strong_parameters] if using Rails 3.x.
+If you are using Rails 3.x, then if you plan to use Permitters or want to use Strong Parameters by itself, you may need to tweak a few things for [Strong Parameters][strong_parameters]
 
 To disable the default whitelisting that occurs in later versions of Rails 3.x, set the `config.active_record.whitelist_attributes` property in your `config/application.rb` to false:
 
     config.active_record.whitelist_attributes = false
 
-No more attr_accessible needed in your models (so take them out and convert them). Instead you will put this information into your permitters or into `create_(single model name)_params`, `update_(single model name)_params`, and/or `(single model name)_params` methods. Encapsulating what params are permissible in such a method is encouraged and described in the [Strong Parameters][strong_parameters] documentation, used by Rails 4.
+No more attr_accessible needed in your models (so take them out and convert them). Instead you will either put this information into your Permitters, or if you are using Strong Parameters without Permitters, you'll create `create_(single model name)_params`, `update_(single model name)_params`, and/or `(single model name)_params` methods in your controller(s). Encapsulating what params are permissible in such a method is encouraged and described in the [Strong Parameters][strong_parameters] documentation.
 
 Strong Parameters (and Permitters) require a model include.
 
@@ -99,7 +67,11 @@ If you'd rather use Strong Parameters with all models, just put this in your `co
 
 #### Cancan
 
-If you are using Permitters, they use [Cancan][cancan], which requires a `current_user` method in your `app/controllers/application_controller.rb` or in your service controllers:
+Though optional, if you decide to use Permitters, the Permitters framework relies on [Cancan][cancan].
+
+Permitters are an object-oriented representation of Strong Parameters, but they also integrate with Cancan. Cancan can restrict what resources a given user is allowed to access. In Cancan, all permissions are defined in a single location (the Ability class) and not duplicated across controllers, views, and database queries.
+
+To setup Cancan, you need a `current_user` method in your `app/controllers/application_controller.rb` or in your service controllers. For the sake of example, we'll just have it return a new User:
 
     class ApplicationController < ActionController::Base
       protect_from_forgery
@@ -109,9 +81,9 @@ If you are using Permitters, they use [Cancan][cancan], which requires a `curren
       end
     end
 
-You could do that better by setting up some real authentication with [Authlogic][authlogic], [Devise][devise], or whatever Cancan will support.
+Cancan integrates [Authlogic][authlogic], [Devise][devise], etc. to return a proper logged-in user or you can return it however you wish.
 
-You also need a `app/models/ability.rb`, setup a basic cancan ability. Just for testing we'll allow everything:
+Cancan also needs an Ability defined in `app/models/ability.rb`. Just for testing we'll ignore the user object and allow everything:
 
     class Ability
       include CanCan::Ability
@@ -129,13 +101,17 @@ Or, if you'd rather use Cancan with all models, just put this in your `config/en
 
     ActiveRecord::Base.send(:include, CanCan::ModelAdditions)
 
-If you follow the code above, you'll need a User model, too. Instead of providing a sample one here, we'll leave that open for you to decide on an appropriate implementation after you read through [Authlogic][authlogic], [Devise][devise], etc.
+Once you get everything setup, go through the [Cancan][cancan] documentation, and then [Authlogic][authlogic], [Devise][devise], etc. to setup/integrate with proper authentication and authorization.
 
 #### JSON Response Generators
 
 ##### ActiveModel Serializers
 
-If you chose to use, [ActiveModel::Serializers][active_model_serializers], you'll eventually want to create one or more serializers for each model that you will be returning via the service(s), e.g.:
+Use of [ActiveModel::Serializers][active_model_serializers] is optional, but a great way to have object-oriented model-like representation of JSON views.
+
+The purpose of ActiveModel::Serializers is to provide an object to encapsulate serialization of ActiveModel objects, including ActiveRecord objects. Serializers know about both a model and the current_user, so you can customize serialization based upon whether a user is authorized to see the content. In short, serializers replace hash-driven development with object-oriented development.
+
+If you chose to use ActiveModel::Serializers, you'll eventually want to create one or more serializers for each model that you will be returning via the service(s), e.g.:
 
     /app/serializers/singular_model_name_serializer.rb
 
@@ -182,9 +158,9 @@ Then make sure you add a JBuilder view for each action you require. Although all
 
 See [Railscast #320][railscast320] for more examples on setting up and using JBuilder.
 
-###### Other
+##### Other Options
 
-You should be able to use anything that works with normal render/responds_with in Rails controllers that don't require any additional code in the action methods of the controller are ok, e.g. as_json defined in model, etc.
+You should be able to use anything that works with normal render/responds_with in Rails controllers without additional code in the controller. If you'd like to use something that requires additional code in the action methods of the controller, and you think it would be a good fit, feel free to do a pull request.
 
 #### Create/Update JSON Request/Params Acceptance
 
@@ -246,9 +222,9 @@ Only the main controller is needed:
 
 Then, make sure that attr_accessible and/or attr_protected, etc. are used properly. 
 
-### App-level Configuration
+### Application Configuration
 
-At the bottom of `config/environment.rb`, you can set config items one at a time like:
+At the bottom of `config/environment.rb`, you can set restful_json can be configured one line at a time.
 
     RestfulJson.debug = true
 
@@ -285,7 +261,7 @@ or in bulk, like:
       
     end
 
-### Controller-specific Configuration
+### Controller Configuration
 
 In the controller, you can set a variety of class attributes with `self.something = ...` in the body of your controller.
 
@@ -318,23 +294,22 @@ Other class attributes are available for setting/overriding, but they are all se
 
 ### Usage
 
-You have a configurable generic Rails 3.1+/4+ controller that does the index, show, create, and update and other custom actions easily for you.
+You have a configurable generic Rails 3.1.x/3.2.x/4.0.x controller that does the index, show, create, and update and other custom actions easily for you.
 
 Everything is well-declared and fairly concise.
 
 You can have something as simple as:
 
     class FoobarsController < ApplicationController
-      include ServiceControllerAdditions
+      include RestfulJson::DefaultController
     end
 
-which would use the restful_json configuration and the controller's classname for the service definition and provide a simple no-frills JSON CRUD controller that behaves mostly like a typical Rails controller created via scaffold.
+which would use the restful_json configuration and the controller's classname for the service definition and provide a simple no-frills JSON CRUD controller that behaves somewhat similarly to a Rails controller created via `rails g scaffold ...`.
 
-Or, you could define more bells and whistles (read on to see what these do...):
+Or, you can define many more bells and whistles:
 
     class FoobarsController < ApplicationController
-
-      include ServiceControllerAdditions
+      include RestfulJson::DefaultController
       
       query_for :index, is: ->(t,q) {q.joins(:apples, :pears).where(apples: {color: 'green'}).where(pears: {color: 'green'})}
       
@@ -365,6 +340,30 @@ Or, you could define more bells and whistles (read on to see what these do...):
       
     end
 
+#### Routing
+
+You can just add normal Rails RESTful routes in `config/routes.rb`, e.g. for the Foobar model:
+
+    MyAppName::Application.routes.draw do
+      resources :foobars
+    end
+
+Supports static, nested, etc. routes also, e.g.:
+
+    MyAppName::Application.routes.draw do
+      namespace :my_service_controller_module do
+        resources :foobars
+      end
+    end
+
+Can pass in params from the path for use in filters, etc. as if they were request parameters:
+
+    MyAppName::Application.routes.draw do
+      namespace :my_service_controller_module do
+        match 'bar/:bar_id/foobars(.:format)' => 'foobars#index'
+      end
+    end    
+
 #### Default Filtering by Attribute(s)
 
 First, declare in the controller:
@@ -433,7 +432,7 @@ First, declare in the controller:
 
     supports_functions :uniq
 
-To return a simple unique view of a model, combine use of an [ActiveModel Serializer][active_model_serializers] that returns just the attribute you want along with the uniq param, e.g. to return unique/distinct colors of foobars you'd have a serializer to just return the color and then use:
+Now this works:
 
     http://localhost:3000/foobars?uniq=
 
@@ -443,27 +442,25 @@ First, declare in the controller:
 
     supports_functions :count
 
-This is another filter that can be used with the others, but instead of returning the json objects, it returns their count, which is useful for paging to determine how many results you can page through:
+Now this works:
 
     http://localhost:3000/foobars?count=
 
 ##### Paging
 
-In controller make sure these are included:
+First, declare in the controller:
 
     supports_functions :page, :page_count
 
-To get the first page of results:
+Now you can get the page count:
 
-    http://localhost:3000/foobars?page=1
+    http://localhost:3000/foobars?page_count=
 
-To get the second page of results:
+And access each page of results:
 
+    http://localhost:3000/foobars?page=1
     http://localhost:3000/foobars?page=2
-
-To get the total number of pages of results:
-
-    http://localhost:3000/foobars?page_count=
+    ...
 
 To set page size at application level:
 
@@ -473,11 +470,9 @@ To set page size at controller level:
 
     self.number_of_records_in_a_page = 15
 
-For a better idea of how this works on the backend, look at [ARel][arel]'s skip and take, or see Variable Paging.
+##### Skip and Take (OFFSET and LIMIT)
 
-###### Skip and Take (OFFSET and LIMIT)
-
-In controller make sure these are included:
+First, declare in the controller:
 
     supports_functions :skip, :take
 
@@ -489,47 +484,25 @@ To limit the number of rows returned, use 'take'. It is called take, because tak
 
     http://localhost:3000/foobars.json?take=5
 
-Combine skip and take for manual completely customized paging.
-
-Get the first page of 15 results:
+Combine skip and take for manual completely customized paging, e.g.
 
     http://localhost:3000/foobars?take=15
-
-Second page of 15 results:
-
     http://localhost:3000/foobars?skip=15&take=15
-
-Third page of 15 results:
-
     http://localhost:3000/foobars?skip=30&take=15
 
-First page of 30 results:
-
-    http://localhost:3000/foobars?take=30
-
-Second page of 30 results:
-
-    http://localhost:3000/foobars?skip=30&take=30
-
-Third page of 30 results:
-
-    http://localhost:3000/foobars?skip=60&take=30
-
 ##### Custom Serializers
 
-If using ActiveModel::Serializers, you can use something other than the (singular model name)Serializer via serialize_action:
+If using ActiveModel::Serializers, you can use something other than the `(singular model name)Serializer` via `serialize_action`:
 
     serialize_action :index, with: ListFoobarSerializer
 
 The built-in actions that support custom serializers (you can add more) are: index, show, new, create, update, destroy, and any action you automatically have created via using the restful_json `query_for` method.
 
-It will use `serialize` for single result actions like show, new, create, update, destroy, and `serialize_each` with index and custom actions.
-
-To override, specify `for:` with `:array` or `:each`, e.g.:
+It will use the `serializer` option for single result actions like show, new, create, update, destroy, and the `each_serializer` option with index and custom actions. Or, you can specify `for:` with `:array` or `:each`, e.g.:
 
     serialize_action :index, :some_custom_action, with: FoosSerializer, for: :array
 
-And, you can just use the default serialization provided by AMS if you want. No class needed.
+Or, you could just use the default serialization, if you want.
 
 ##### Custom Queries
 
@@ -538,7 +511,12 @@ To filter the list where the status_code attribute is 'green':
     # t is self.model_class.arel_table and q is self.model_class.scoped
     query_for :index, is: lambda {|t,q| q.where(:status_code => 'green')}
 
-or use the `->` Ruby 1.9 lambda stab operator. You can also filter out items that have associations that don't have a certain attribute value (or anything else you can think up with [ARel][arel]/[ActiveRecord relations][ar]). To filter the list where the object's apples and pears associations are green:
+or use the `->` Ruby 1.9 lambda stab operator (note lack of whitespace between stab and parenthesis):
+
+    # t is self.model_class.arel_table and q is self.model_class.scoped
+    query_for :index, is: is: ->(t,q) {q.where(:status_code => 'green')}
+
+You can also filter out items that have associations that don't have a certain attribute value (or anything else you can think up with [ARel][arel]/[ActiveRecord relations][ar]), e.g. to filter the list where the object's apples and pears associations are green:
 
     # t is self.model_class.arel_table and q is self.model_class.scoped
     # note: must be no space between -> and parenthesis
@@ -550,7 +528,9 @@ or use the `->` Ruby 1.9 lambda stab operator. You can also filter out items tha
 
 ##### Define Custom Actions with Custom Queries
 
-`query_for` also will `alias_method (some action), :index` anything other than `:index`, so you can easily create custom non-RESTful action methods:
+You are still working with regular controllers here, so add or override methods if you want more!
+
+However `query_for` will create new action methods, so you can easily create custom non-RESTful action methods:
 
     # t is self.model_class.arel_table and q is self.model_class.scoped
     # note: must be no space between -> and parenthesis in lambda syntax!
@@ -558,31 +538,35 @@ or use the `->` Ruby 1.9 lambda stab operator. You can also filter out items tha
 
 Note that it is a proc so you can really do whatever you want with it and will have access to other things in the environment or can call another method, etc.
 
-You are still working with regular controllers here, so add or override methods if you want more!
-
-### Routing
+    query_for :some_action, is: ->(t,q) do
+        if @current_user.admin?
+          Rails.logger.debug("Notice: unfiltered results provided to admin #{@current_user.name}")
+          # just make sure the relation is returned!
+          q
+        else
+          q.where(:access => 'public')
+        end        
+    end
 
-Respects regular and nested Rails resourceful routing and controller namespacing, e.g. in `config/routes.rb`:
+Be sure to add a route for that action, e.g. in `config/routes.rb`, e.g. for the Barfoo model:
 
-    MyAwesomeApp::Application.routes.draw do
-      namespace :my_service_controller_module do
-        resources :foobars
-        # why use nested if you only want to provide ways of querying via path
-        match 'bars/:bar_id/foobars(.:format)' => 'foobars#index'
+    MyAppName::Application.routes.draw do
+      resources :barfoos do
+        get 'some_action', :on => :collection
       end
     end
 
 ### With Rails-api
 
-If you want to try out [rails-api][rails-api], maybe use:
+If you want to try out [rails-api][rails-api]:
 
     gem 'rails-api', '~> 0.0.3'
 
-In `apps/controllers/restful_json_api.rb`:
+In `app/controllers/my_service_controller.rb`:
 
-    module RestfulJsonApi
+    module MyServiceController
       extend ActiveSupport::Concern
-
+      
       included do
         # Rails-api lets you choose features. You might not need all of these, or may need others.
         include AbstractController::Translation
@@ -591,25 +575,25 @@ In `apps/controllers/restful_json_api.rb`:
         include ActionController::MimeResponds
         include ActionController::Cookies
         include ActionController::ParamsWrapper
+
+        # use Permitters and AMS
         include RestfulJson::DefaultController
+        # or comment that last line and uncomment whatever you want to use
+        #include ::ActionController::Serialization # AMS
+        #include ::ActionController::StrongParameters
+        #include ::TwinTurbo::Controller # Permitters which uses Cancan and Strong Parameters
+        #include ::RestfulJson::Controller
 
         # If you want any additional inline class stuff, it goes here...
-      end
-      
-      module ClassMethods
-        # Any additional class methods...
-      end
-      
-      # Instance methods...
-      
+      end      
     end
 
     class FoobarsController < ActionController::API
-      include RestfulJsonApi  
+      include MyServiceController  
     end
 
     class BarfoosController < ActionController::API
-      include RestfulJsonApi  
+      include MyServiceController  
     end
 
 Note that in `/config/initializers/wrap_parameters.rb` you might need to add `include ActionController::ParamsWrapper` prior to the `wrap_parameters` call. For example, for unwrapped JSON, it would look like:
@@ -630,6 +614,8 @@ Note that in `/config/initializers/wrap_parameters.rb` you might need to add `in
 
 ##### Parent/Ancestor Class Definition Not Supported
 
+Don't subclass and include in the parent, that puts the class attributes into the parent which means they would be shared by the children and bad things can happen.
+
 Don't do this:
 
     class ServiceController < ApplicationController
@@ -639,72 +625,81 @@ Don't do this:
       include ::RestfulJson::Controller
     end
     
-    # nor should you do this
-    #class FoobarsController < ApplicationController
-    #  include RestfulJson::DefaultController
-    #end
-    
     class FoobarsController < ServiceController
     end
     
     class BarfoosController < ServiceController
     end
 
-It may appear to work when using the same controller or even on each new controller load, but when you make requests to BarfoosController, make a request to FoobarsController, and then make a request back to the BarfoosController, it may fail in very strange ways, such as missing column(s) from SQL results (because it isn't using the correct model).
-
-Do as a module instead!
-
-##### Customizing Behavior via Module
-
-Remember how we created a `apps/controllers/service_controller_additions.rb`?
-
-You can add behavior to it!
+And don't do this:
 
-Let's add a method so that `hello :world` in the controller will make it return `{"hello": "world"}`:
+    class FoobarsController < ApplicationController
+      include RestfulJson::DefaultController
+    end
+    
+    class FoobarsController < ServiceController
+    end
+    
+    class BarfoosController < ServiceController
+    end
 
-    module HelloWorld
-      extend ActiveSupport::Concern      
-      included do
-        # see notes in Service Controller Additions section of restful_json doc for what is needed
-        include ::ActionController::Serialization
-        include ::ActionController::StrongParameters
-        include ::TwinTurbo::Controller
-        include ::RestfulJson::Controller
-
-        # let's add a name that can be set with a class method
-        class_attribute :name, instance_writer: true
-      end
+It may appear to work when using the same controller or even on each new controller load, but when you make requests to BarfoosController, make a request to FoobarsController, and then make a request back to the BarfoosController, it may fail in very strange ways, such as missing column(s) from SQL results (because it isn't using the correct model).
 
-      module ClassMethods
-        def hello(value)
-          self.name = value.to_sym
+##### Customizing Behavior via Patch
+
+In `config/initializers/restful_json.rb` you can monkey patch the RestfulJson::Controller module. The DefaultController includes that, so it will get your changes also:
+
+    # a horrible Hello World example
+    module RestfulJson
+      module Controller
+        
+        # class methods that should be implemented or overriden
+        module ClassMethods
+          def hello(name)
+            #TODO: find way to call hook into the block call in RJ controller's included block
+            # without having do funny things to ActiveSupport::Concern, because append_features(base)            
+            # defined in the monkey patch is never called, and module_eval is a royal pain.
+            # Or, stop using ActiveSupport::Concern. For now, we'll defined class_attribute in the
+            # class method that uses it and use respond_to? in a nasty hack. I'm sorry.
+            class_attribute :name, instance_writer: true
+            self.name = name        
+          end
         end
-      end
 
-      def index
-        respond_to do |format|
-          format.json do
-            render :json => {"hello" => self.name}.to_json
-          end
+        # instance methods that should be implemented or overriden.
+        #
+        # note: you don't have to do this to override service methods at the controller-level.
+        # Instead, just define them in the controller. this is just an example of monkey-patching.        
+        def index
+          name = self.respond_to?(:name) && self.name ? self.name : 'nobody'
+          render :json => {:hello => self.name}
+        rescue => e
+          # rescue to identify errors that otherwise can be swallowed
+          puts "index failed: #{self} #{e}"
+          raise e
         end
+
       end
     end
 
-Then:
+Now in your controller, if you:
 
     class FoobarsController < ApplicationController
-      include HelloWorld
-      hello :world
+      include RestfulJson::DefaultController
+      hello 'world'
     end
 
-    class BarfoosController < ApplicationController
-      include HelloWorld
-      hello :world
-    end
+(Note again: RestfulJson::DefaultController includes RestfulJson::Controller.)
 
-For more realistic use that takes advantage of existing configuration in the controller, take a look at the controller in `lib/restful_json/controller.rb` to see how the actions are defined, and just copy/paste into your controller or module, etc.
+Now when you call:
+
+    http://localhost:3000/foobars
 
-Make sure that the inclusion of your module is defined after `include RestfulJson::Controller`, `include RestfulJson::DefaultController`, or `acts_as_restful_json` is called.
+You would get the response:
+
+    {'hello': 'world'}
+
+For more realistic use that takes advantage of existing configuration in the controller, take a look at the controller in `lib/restful_json/controller.rb` to see how the actions are defined, and just copy/paste into your controller or module, etc.
 
 ### Release Notes
 
@@ -734,9 +729,9 @@ Include this in `config/environment.rb`
 
 ### Rails Version-specific Eccentricities
 
-Strong Parameters is included in Rails 4. Rails 4.1 and up will need `gem 'activerecord-deprecated_finders' gem, at least for now. (At time of writing Rails 4.1 is not out yet, so not a problem.)
+Strong Parameters is included in Rails 4.
 
-If you are using Rails 3.1, note that respond_with returns HTTP 200 instead of 204 for update and destroy, unless return_resource is true.
+If you are using Rails 3.1.x, note that respond_with returns HTTP 200 instead of 204 for update and destroy, unless return_resource is true.
 
 ### Thanks!
 

data/lib/restful_json/controller.rb

@@ -200,14 +200,19 @@ module RestfulJson
 
     def render_or_respond(read_only_action, success_code = :ok)
       if self.render_enabled
-        if !@value.nil? && ((read_only_action && RestfulJson.return_resource) || RestfulJson.avoid_respond_with)
+        # 404/not found is just for update (not destroy, because idempotent destroy = no 404)
+        if success_code == :not_found
+          respond_to do |format|
+            format.html { render :file => "#{Rails.root}/public/404.html", :status => :not_found }
+            format.any  { head :not_found }
+          end
+        elsif !@value.nil? && ((read_only_action && RestfulJson.return_resource) || RestfulJson.avoid_respond_with)
           respond_with(@value) do |format|
             format.json do
               # define local variables in blocks, not outside of them, to be safe, even though would work in this case              
               custom_action_serializer = self.action_to_serializer[params[:action].to_s]
               custom_action_serializer_for = self.action_to_serializer_for[params[:action].to_s]
               serialization_key = single_value_response? ? (custom_action_serializer_for == :each ? :each_serializer : :serializer) : (custom_action_serializer_for == :array ? :serializer : :each_serializer)
-              puts "serialization key = #{serialization_key}, custom_action_serializer = #{custom_action_serializer}"
               if !@value.respond_to?(:errors) || @value.errors.empty?
                 render custom_action_serializer ? {json: @value, status: success_code, serialization_key => custom_action_serializer} : {json: @value, status: success_code}
               else
@@ -390,17 +395,22 @@ module RestfulJson
         allowed_params = params
       end
       # to_s as safety measure for vulnerabilities similar to CVE-2013-1854
-      @value = @model_class.find(params[:id].to_s)
-      @value.update_attributes(allowed_params)
+      @value = @model_class.where(id: params[:id].to_s).to_a[0]
+      status = :ok
+      if @value.nil?
+        status = :not_found
+      else
+        @value.update_attributes(allowed_params)
+      end
       instance_variable_set(@model_at_singular_name_sym, @value)
-      render_or_respond(false)
+      render_or_respond(false, status)
     end
 
     # The controller's destroy (delete) method to destroy a resource.
     def destroy
       # to_s as safety measure for vulnerabilities similar to CVE-2013-1854
-      @value = @model_class.find(params[:id].to_s)
-      @value.destroy
+      @value = @model_class.where(id: params[:id].to_s).to_a[0]
+      @value.destroy if @value
       instance_variable_set(@model_at_singular_name_sym, @value)
       render_or_respond(false)
     end

data/lib/restful_json/version.rb

@@ -1,3 +1,3 @@
 module RestfulJson
-  VERSION = '3.3.0'
+  VERSION = '3.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_json
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Gary S. Weaver
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,6 +39,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Develop declarative, featureful JSON RESTful-ish service controllers
   to use with modern Javascript MVC frameworks like AngularJS, Ember, etc. with much
   less code.