responders 2.1.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06ba4b048f7ab149753ce1222674abcde97594ce
-  data.tar.gz: d10721b4e6683ecc3095d709134d9e8785909c7f
+  metadata.gz: 8dce735a1e17c51056e99b880daafe35f666771f
+  data.tar.gz: 61548c0e60e01fa193a5b01ce93f21b1e9c5181f
 SHA512:
-  metadata.gz: 89dbb2374f73e0090d5ef320ae5d52235a075de8f344475717c1dc45474d86a0a2fd8de8dd8d7a7661f166f014658841106635c57cf1dc9db36b1acea5ad37d5
-  data.tar.gz: 973bbda1f6a6b6b4f056a8a5615b170d22f0e954fb2b77625279347e23f85378100fbf1d3079897c69174b304132099ed77c29963741439466bc0fdaff3b7120
+  metadata.gz: 1c5e9f72023667804fbb1589dc4512db20e10a4cca06c643fdc85475c713fd16b6cef65936c3bbc1bbe7beba1460277f32b2f82973ab5f2080acce9ae9772260
+  data.tar.gz: 8bc67ddcb91fb1834483cd99e53f3cfd397b3639b9c0b022996ad2e77d06dcb501cab89a8f586c0f0fc224530ed952fecce88bf9680a9c62d7808e0492420a9a

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 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

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,8 +1,8 @@
 # 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 4.2+ app.
 
@@ -17,6 +17,10 @@ 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
 
 ### FlashResponder
@@ -101,6 +105,22 @@ class ThingsController < ApplicationController
 end
 ```
 
+**Dealing with namespaced routes**
+
+In order for the LocationResponder to find the correct route helper for namespaced routes you need to pass the namespaces to `respond_with`:
+
+```ruby
+class Api::V1::ThingsController < ApplicationController
+  respond_to :json
+
+  # POST /api/v1/things
+  def create
+    @thing = Thing.create(thing_params)
+    respond_with :api, :v1, @thing
+  end
+end
+```
+
 ## Configuring your own responder
 
 Responders only provides a set of modules and to use them you have to create your own
@@ -109,7 +129,7 @@ generated in your application:
 
 ```ruby
 # lib/application_responder.rb
-class AppResponder < ActionController::Responder
+class ApplicationResponder < ActionController::Responder
   include Responders::FlashResponder
   include Responders::HttpCacheResponder
 end
@@ -122,7 +142,7 @@ Your application also needs to be configured to use it:
 require "application_responder"
 
 class ApplicationController < ActionController::Base
-  self.responder = AppResponder
+  self.responder = ApplicationResponder
   respond_to :html
 end
 ```
@@ -168,13 +188,41 @@ to use `respond_with` instead of default `respond_to` blocks. From 2.1, you need
 
     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
+```
+
 ## Examples
 
 Want more examples ? Check out this blog posts:
 
 * [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
 
@@ -182,4 +230,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

@@ -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.

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/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/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/version.rb

@@ -1,3 +1,3 @@
 module Responders
-  VERSION = "2.1.0".freeze
+  VERSION = "2.1.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: responders
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.2
 platform: ruby
 authors:
 - José Valim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-27 00:00:00.000000000 Z
+date: 2016-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -19,7 +19,7 @@ dependencies:
         version: 4.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         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