responders 2.0.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1048b35bc57148e916fc54ea72aa8a0e3f9f7498
-  data.tar.gz: 8d4c1c0825d565528c29371185d374e8266336ff
+  metadata.gz: 7ba43cee72d6a197eff78818683a01dfe43814d3
+  data.tar.gz: 37ceb10a23ee46f1ec142176eee690c33a98b73d
 SHA512:
-  metadata.gz: 2cd86b1e17658300952e4fea7326eafc6474d9b47ee7520322521a103300fa3ad803ed41c5c7849febdf0769bb7f43085d2898fe589d0b85cc835a9017f7e07c
-  data.tar.gz: f390f3b7d962ede7cda0b454d45b7864d2606472c33029a24981d84374be0ba8d8f98536aa5af2ef9aa4c0f915e4d2750a2f06278cf4113f82f35e30ceb5dc6a
+  metadata.gz: e198e8715fefd1e87c21d7a52ed255ad51445bdfe2eb83e0e8a5eb8845eae8d3b1e665217ce1ac6f836156abd1d56cff5a2082f48cfb6f44e3cabe875117125f
+  data.tar.gz: c59cbdaf34207e264e7551bdd700f2d9afe200fa29c2a31672d79debce0979853c76ee8ce0500347f5ee8fb19ebf8b86fc270a45add262d06b4d9c43c7c7ae17

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 2.2.0
+
+* Added the `verify_request_format!` method, that can be used as a `before_action`
+  callback to prevent your actions from being invoked when the controller does
+  not respond to the request mime type, preventing the execution of complex
+  queries or creating/deleting records from your app.
+
+## 2.1.2
+
+* Fix rendering when using `ActionController::API`. (by @eLod)
+* Added API controller template for the controller generator. (by @vestimir)
+
+## 2.1.1
+
+* Added support for Rails 5.
+
+## 2.1.0
+
+* No longer automatically set the responders generator as many projects may use this gem as a dependency. When upgrading, users will need to add `config.app_generators.scaffold_controller :responders_controller` to their application. The `responders:install` generator has been updated to automatically insert it in new applications
+
 ## 2.0.1
 
 * Require `rails/railtie` explicitly before using it
@@ -8,7 +28,7 @@
 
 * Import `respond_with` and class-level `respond_to` from Rails
 * Support only Rails ~> 4.2
-* `Responders::LocationResponder` is now included by in the default responder (and therefore deprecated)
+* `Responders::LocationResponder` is now included by the default responder (and therefore deprecated)
 
 ## 1.1.0
 

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2009-2014 Plataforma Tecnologia. http://blog.plataformatec.com.br
+Copyright 2009-2016 Plataformatec. http://plataformatec.com.br
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,10 +1,25 @@
 # Responders
 
-[![Gem Version](https://fury-badge.herokuapp.com/rb/responders.png)](http://badge.fury.io/rb/responders)
-[![Build Status](https://api.travis-ci.org/plataformatec/responders.png?branch=master)](http://travis-ci.org/plataformatec/responders)
-[![Code Climate](https://codeclimate.com/github/plataformatec/responders.png)](https://codeclimate.com/github/plataformatec/responders)
+[![Gem Version](https://fury-badge.herokuapp.com/rb/responders.svg)](http://badge.fury.io/rb/responders)
+[![Build Status](https://api.travis-ci.org/plataformatec/responders.svg?branch=master)](http://travis-ci.org/plataformatec/responders)
+[![Code Climate](https://codeclimate.com/github/plataformatec/responders.svg)](https://codeclimate.com/github/plataformatec/responders)
 
-A set of responders modules to dry up your Rails 3.2+ app.
+A set of responders modules to dry up your Rails 4.2+ app.
+
+## Installation
+
+Add the responders gem to your Gemfile:
+
+    gem "responders"
+
+Update your bundle and run the install generator:
+
+    $ bundle install
+    $ rails g responders:install
+
+If you are including this gem to support backwards compatibilty for responders in previous releases of Rails, you only need to include the gem and bundle.
+
+    $ bundle install
 
 ## Responders Types
 
@@ -60,15 +75,27 @@ You can also have embedded HTML. Just create a `_html` scope.
 
 See also the `namespace_lookup` option to search the full hierarchy of possible keys.
 
+### HttpCacheResponder
+
+Automatically adds Last-Modified headers to API requests. This
+allows clients to easily query the server if a resource changed and if the client tries
+to retrieve a resource that has not been modified, it returns not_modified status.
+
+### CollectionResponder
+
+Makes your create and update action redirect to the collection on success.
+
 ### LocationResponder
 
 This responder allows you to use callable objects as the redirect location.
 Useful when you want to use the `respond_with` method with
 a custom route that requires persisted objects, but the validation may fail.
 
+Note: this responder is included by default, and doesn't need to be included
+on the top of your controller (including it will issue a deprecation warning).
+
 ```ruby
 class ThingsController < ApplicationController
-  responders :location, :flash
   respond_to :html
 
   def create
@@ -78,59 +105,48 @@ class ThingsController < ApplicationController
 end
 ```
 
-### HttpCacheResponder
-
-Automatically adds Last-Modified headers to API requests. This
-allows clients to easily query the server if a resource changed and if the client tries
-to retrieve a resource that has not been modified, it returns not_modified status.
+**Dealing with namespaced routes**
 
-### CollectionResponder
+In order for the LocationResponder to find the correct route helper for namespaced routes you need to pass the namespaces to `respond_with`:
 
-Makes your create and update action redirect to the collection on success.
-
-## Configuring your own responder
-
-The first step is to install the responders gem and configure it in your application:
+```ruby
+class Api::V1::ThingsController < ApplicationController
+  respond_to :json
 
-```console
-gem install responders
+  # POST /api/v1/things
+  def create
+    @thing = Thing.create(thing_params)
+    respond_with :api, :v1, @thing
+  end
+end
 ```
 
-In your Gemfile, add this line:
-
-```ruby
-gem 'responders'
-```
+## Configuring your own responder
 
-Responders only provides a set of modules, to use them, you have to create your own
-responder. This can be done inside the lib folder for example:
+Responders only provides a set of modules and to use them you have to create your own
+responder. After you run the install command, the following responder will be
+generated in your application:
 
 ```ruby
-# lib/app_responder.rb
-class AppResponder < ActionController::Responder
+# lib/application_responder.rb
+class ApplicationResponder < ActionController::Responder
   include Responders::FlashResponder
   include Responders::HttpCacheResponder
 end
 ```
 
-And then you need to configure your application to use it:
+Your application also needs to be configured to use it:
 
 ```ruby
 # app/controllers/application_controller.rb
-require "app_responder"
+require "application_responder"
 
 class ApplicationController < ActionController::Base
-  self.responder = AppResponder
+  self.responder = ApplicationResponder
   respond_to :html
 end
 ```
 
-Or, for your convenience, just do:
-
-```console
-rails generate responders:install
-```
-
 ## Controller method
 
 This gem also includes the controller method `responders`, which allows you to cherry-pick which
@@ -168,17 +184,68 @@ Now you would see the message "bob@bob.com was successfully created" instead of
 ## Generator
 
 This gem also includes a responders controller generator, so your scaffold can be customized
-to use `respond_with` instead of default `respond_to` blocks. Installing this gem automatically
-sets the generator.
+to use `respond_with` instead of default `respond_to` blocks. From 2.1, you need to explicitly opt-in to use this generator by adding the following to your `config/application.rb`:
+
+    config.app_generators.scaffold_controller :responders_controller
+
+## Failure handling
+
+Responders don't use `valid?` to check for errors in models to figure out if
+the request was successfull or not, and relies on your controllers to call
+`save` or `create` to trigger the validations.
+
+```ruby
+def create
+  @widget = Widget.new(widget_params)
+  # @widget will be a valid record for responders, as we haven't called `save`
+  # on it, and will always redirect to the `widgets_path`.
+  respond_with @widget, location: -> { widgets_path }
+end
+```
+
+Responders will check if the `errors` object in your model is empty or not. Take
+this in consideration when implementing different actions or writing test
+assertions on this behavior for your controllers.
+
+```ruby
+def create
+  @widget = Widget.new(widget_params)
+  @widget.errors.add(:base, :invalid)
+  # `respond_with` will render the `new` template again.
+  respond_with @widget
+end
+```
+
+## Verifying request formats
+
+`respond_with` will raise an `ActionController::UnknownFormat` if the request
+mime type was not configured through the class level `respond_to`, but the
+action will still be executed and any side effects (like creating a new record)
+will still occur. To raise the `UnknownFormat` exception before your action
+is invoked you can set the `verify_request_format!` method as a `before_action`
+on your controller.
+
+```ruby
+class WidgetsController < ApplicationController
+  respond_to :json
+  before_action :verify_request_format!
+
+  # POST /widgets.html won't reach the `create` action.
+  def create
+    widget = Widget.create(widget_params)
+    respond_with widget
+  end
+end
+
+```
 
 ## Examples
 
 Want more examples ? Check out this blog posts:
 
-* [One in Three: Inherited Resources, Has Scope and Responders](http://blog.plataformatec.com.br/2009/12/one-in-three-inherited-resources-has-scope-and-responders/)
 * [Embracing REST with mind, body and soul](http://blog.plataformatec.com.br/2009/08/embracing-rest-with-mind-body-and-soul/)
 * [Three reasons to love ActionController::Responder](http://weblog.rubyonrails.org/2009/8/31/three-reasons-love-responder/)
-* [My five favorite things about Rails 3](http://www.engineyard.com/blog/2009/my-five-favorite-things-about-rails-3/)
+* [My five favorite things about Rails 3](http://www.engineyard.com/blog/2009/my-five-favorite-things-about-rails-3)
 
 ## Bugs and Feedback
 
@@ -186,4 +253,4 @@ If you discover any bugs or want to drop a line, feel free to create an issue on
 
 http://github.com/plataformatec/responders/issues
 
-MIT License. Copyright 2009-2014 Plataforma Tecnologia. http://blog.plataformatec.com.br
+MIT License. Copyright 2009-2016 Plataformatec. http://plataformatec.com.br

data/lib/action_controller/respond_with.rb

@@ -40,14 +40,14 @@ module ActionController #:nodoc:
         only_actions   = Array(options.delete(:only)).map(&:to_s)
         except_actions = Array(options.delete(:except)).map(&:to_s)
 
-        new = mimes_for_respond_to.dup
+        hash = mimes_for_respond_to.dup
         mimes.each do |mime|
           mime = mime.to_sym
-          new[mime]          = {}
-          new[mime][:only]   = only_actions   unless only_actions.empty?
-          new[mime][:except] = except_actions unless except_actions.empty?
+          hash[mime]          = {}
+          hash[mime][:only]   = only_actions   unless only_actions.empty?
+          hash[mime][:except] = except_actions unless except_actions.empty?
         end
-        self.mimes_for_respond_to = new.freeze
+        self.mimes_for_respond_to = hash.freeze
       end
 
       # Clear all mime types in <tt>respond_to</tt>.
@@ -175,7 +175,9 @@ module ActionController #:nodoc:
     # Also, a hash passed to +respond_with+ immediately after the specified
     # resource(s) is interpreted as a set of options relevant to all
     # formats. Any option accepted by +render+ can be used, e.g.
+    #
     #   respond_with @people, status: 200
+    #
     # However, note that these options are ignored after an unsuccessful attempt
     # to save a resource, e.g. when automatically rendering <tt>:new</tt>
     # after a post request.
@@ -191,10 +193,10 @@ module ActionController #:nodoc:
           "formats your controller responds to in the class level."
       end
 
-      mimes = collect_mimes_from_class_level()
+      mimes = collect_mimes_from_class_level
       collector = ActionController::MimeResponds::Collector.new(mimes, request.variant)
       block.call(collector) if block_given?
-      
+
       if format = collector.negotiate_format(request)
         _process_format(format)
         options = resources.size == 1 ? {} : resources.extract_options!
@@ -206,7 +208,24 @@ module ActionController #:nodoc:
       end
     end
 
-  protected
+    protected
+
+    # Before action callback that can be used to prevent requests that do not
+    # match the mime types defined through <tt>respond_to</tt> from being executed.
+    #
+    #   class PeopleController < ApplicationController
+    #     respond_to :html, :xml, :json
+    #
+    #     before_action :verify_request_format!
+    #   end
+    def verify_request_format!
+      mimes = collect_mimes_from_class_level
+      collector = ActionController::MimeResponds::Collector.new(mimes, request.variant)
+
+      unless collector.negotiate_format(request)
+        raise ActionController::UnknownFormat
+      end
+    end
 
     # Collect mimes declared in the class method respond_to valid for the
     # current action.
@@ -226,4 +245,4 @@ module ActionController #:nodoc:
       end
     end
   end
-end
+end

data/lib/action_controller/responder.rb

@@ -182,10 +182,12 @@ module ActionController #:nodoc:
     # responds to :to_format and display it.
     #
     def to_format
-      if get? || !has_errors? || response_overridden?
+      if !get? && has_errors? && !response_overridden?
+        display_errors
+      elsif has_view_rendering? || response_overridden?
         default_render
       else
-        display_errors
+        api_behavior
       end
     rescue ActionView::MissingTemplate
       api_behavior
@@ -233,7 +235,7 @@ module ActionController #:nodoc:
       if @default_response
         @default_response.call(options)
       else
-        controller.default_render(options)
+        controller.render(options)
       end
     end
 
@@ -273,6 +275,10 @@ module ActionController #:nodoc:
       Renderers::RENDERERS.include?(format)
     end
 
+    def has_view_rendering?
+      controller.class.include? ActionView::Rendering
+    end
+
     # By default, render the <code>:edit</code> action for HTML requests with errors, unless
     # the verb was POST.
     #

data/lib/generators/rails/responders_controller_generator.rb

@@ -15,32 +15,8 @@ module Rails
         end
       end
 
-      def orm_instance_update(params)
-        if orm_instance.respond_to?(:update)
-          orm_instance.update params
-        else
-          orm_instance.update_attributes params
-        end
-      end
-
-      def controller_before_filter
-        if ActionController::Base.respond_to?(:before_action)
-          "before_action"
-        else
-          "before_filter"
-        end
-      end
-
       def attributes_params
-        if strong_parameters_defined?
-          "#{file_name}_params"
-        else
-          "params[:#{file_name}]"
-        end
-      end
-
-      def strong_parameters_defined?
-        defined?(ActionController::StrongParameters)
+        "#{singular_table_name}_params"
       end
     end
   end

data/lib/generators/rails/templates/api_controller.rb

@@ -0,0 +1,51 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  before_action :set_<%= singular_table_name %>, only: [:show, :update, :destroy]
+
+  respond_to :json
+
+<% unless options[:singleton] -%>
+  def index
+    @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
+    respond_with(@<%= plural_table_name %>)
+  end
+<% end -%>
+
+  def show
+    respond_with(@<%= singular_table_name %>)
+  end
+
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, attributes_params) %>
+    <%= "flash[:notice] = '#{class_name} was successfully created.' if " if flash? %>@<%= orm_instance.save %>
+    respond_with(@<%= singular_table_name %>)
+  end
+
+  def update
+    <%= "flash[:notice] = '#{class_name} was successfully updated.' if " if flash? %>@<%= orm_instance.update(attributes_params) %>
+    respond_with(@<%= singular_table_name %>)
+  end
+
+  def destroy
+    @<%= orm_instance.destroy %>
+    respond_with(@<%= singular_table_name %>)
+  end
+
+  private
+    def set_<%= singular_table_name %>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    end
+
+    def <%= "#{singular_table_name}_params" %>
+      <%- if attributes_names.empty? -%>
+      params[:<%= singular_table_name %>]
+      <%- else -%>
+      params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      <%- end -%>
+    end
+end
+<% end -%>

data/lib/generators/rails/templates/controller.rb

@@ -1,6 +1,10 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApplicationController
-  <%= controller_before_filter %> :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
+  before_action :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
 
   respond_to :html
 
@@ -30,7 +34,7 @@ class <%= controller_class_name %>Controller < ApplicationController
   end
 
   def update
-    <%= "flash[:notice] = '#{class_name} was successfully updated.' if " if flash? %>@<%= orm_instance_update(attributes_params) %>
+    <%= "flash[:notice] = '#{class_name} was successfully updated.' if " if flash? %>@<%= orm_instance.update(attributes_params) %>
     respond_with(@<%= singular_table_name %>)
   end
 
@@ -43,7 +47,6 @@ class <%= controller_class_name %>Controller < ApplicationController
     def set_<%= singular_table_name %>
       @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
     end
-    <%- if strong_parameters_defined? -%>
 
     def <%= "#{singular_table_name}_params" %>
       <%- if attributes_names.empty? -%>
@@ -52,6 +55,5 @@ class <%= controller_class_name %>Controller < ApplicationController
       params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
       <%- end -%>
     end
-    <%- end -%>
 end
 <% end -%>

data/lib/generators/responders/install_generator.rb

@@ -18,6 +18,14 @@ end
         RUBY
       end
 
+      def update_application
+        inject_into_class "config/application.rb", "Application", <<-RUBY
+    # Use the responders controller from the responders gem
+    config.app_generators.scaffold_controller :responders_controller
+
+        RUBY
+      end
+
       def update_application_controller
         prepend_file "app/controllers/application_controller.rb", %{require "application_responder"\n\n}
         inject_into_class "app/controllers/application_controller.rb", "ApplicationController", <<-RUBY

data/lib/responders.rb

@@ -19,12 +19,6 @@ module Responders
     config.responders.flash_keys = [:notice, :alert]
     config.responders.namespace_lookup = false
 
-    if config.respond_to?(:app_generators)
-      config.app_generators.scaffold_controller = :responders_controller
-    else
-      config.generators.scaffold_controller = :responders_controller
-    end
-
     # Add load paths straight to I18n, so engines and application can overwrite it.
     require 'active_support/i18n'
     I18n.load_path << File.expand_path('../responders/locales/en.yml', __FILE__)

data/lib/responders/controller_method.rb

@@ -34,4 +34,6 @@ module Responders
   end
 end
 
-ActionController::Base.extend Responders::ControllerMethod
+ActiveSupport.on_load(:action_controller) do
+  ActionController::Base.extend Responders::ControllerMethod
+end

data/lib/responders/location_responder.rb

@@ -1,7 +1,7 @@
 module Responders
   module LocationResponder
     def self.included(_base)
-      ActiveSupport::Deprecation.warn "Responders::LocationResponder is enabled by default, "
+      ActiveSupport::Deprecation.warn "Responders::LocationResponder is enabled by default, " \
                                       "no need to include it", caller
     end
   end

data/lib/responders/version.rb

@@ -1,3 +1,3 @@
 module Responders
-  VERSION = "2.0.2".freeze
+  VERSION = "2.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: responders
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.0
 platform: ruby
 authors:
 - José Valim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0.alpha
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0.alpha
+        version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.1'
 description: A set of Rails responders to dry up your application
 email: contact@plataformatec.com.br
 executables: []
@@ -43,6 +43,7 @@ files:
 - lib/action_controller/responder.rb
 - lib/generators/rails/USAGE
 - lib/generators/rails/responders_controller_generator.rb
+- lib/generators/rails/templates/api_controller.rb
 - lib/generators/rails/templates/controller.rb
 - lib/generators/responders/install_generator.rb
 - lib/responders.rb
@@ -73,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: responders
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A set of Rails responders to dry up your application