lotus-controller 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04ae3ccf09d545e91ee49d06a52dd18ea196871f
-  data.tar.gz: 645e47bc4dacb1147cf01007668bd73ece973169
+  metadata.gz: cac7b8bf14852940993b526910f912f4c8a84398
+  data.tar.gz: 0d1987258f25f24b2e3b797441e557d76e704184
 SHA512:
-  metadata.gz: cc76f8ea93416a106fb491bdd3168df82722386b85306eabdf73fca31fa20dff7c38f38ebb317b8393f849a54ec56a3c08e774780691a92289bcf2848af70487
-  data.tar.gz: 923df9fa385da1b3358ebfc46ed386665e6f3f0814f901a39b960603e32dfead3f1f04e90fcf323d56f9401cbbd2e236d52bd5a3ef1a4d1f61f2659322502090
+  metadata.gz: 17ef726ad1e57674ef8215aa9cb1aa4277f8ef29518d89e893f66dc8a631e7f9387f118f77d6dcacfdbc8ff8595e46798455ef6d2175ca12a6a365b33396b2e5
+  data.tar.gz: 4acdfbe61468ee74824894b1c060b8068a612c619acfab62c283284214e17c694a43c3c940ae46d3c17548ffbc2c98d48740a04b6396f1407467afc37ff7c2c7

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Lotus::Controller
 Complete, fast and testable actions for Rack
 
+## v0.4.6 - 2015-12-04
+### Added
+- [Luca Guidi] Allow to force custom headers for responses that shouldn't include them (eg 204). Override `#keep_response_header?(header)` in action
+
 ## v0.4.5 - 2015-09-30
 ### Added
 - [Theo Felippe] Added configuration entries: `#default_request_format` and `default_response_format`.

data/lib/lotus/action/head.rb

@@ -50,7 +50,7 @@ module Lotus
 
         if _requires_no_body?
           @_body = nil
-          @headers.reject! { |header,_| !ENTITY_HEADERS.include?(header) }
+          @headers.reject! {|header,_| !keep_response_header?(header) }
         end
       end
 
@@ -60,6 +60,63 @@ module Lotus
       def _requires_no_body?
         HTTP_STATUSES_WITHOUT_BODY.include?(@_status) || head?
       end
+
+      private
+      # According to RFC 2616, when a response MUST have an empty body, it only
+      # allows Entity Headers.
+      #
+      # For instance, a <tt>204</tt> doesn't allow <tt>Content-Type</tt> or any
+      # other custom header.
+      #
+      # This restriction is enforced by <tt>Lotus::Action::Head#finish</tt>.
+      #
+      # However, there are cases that demand to bypass this rule to set meta
+      # informations via headers.
+      #
+      # An example is a <tt>DELETE</tt> request for a JSON API application.
+      # It returns a <tt>204</tt> but still wants to specify the rate limit
+      # quota via <tt>X-Rate-Limit</tt>.
+      #
+      # @since x.x.x
+      # @api public
+      #
+      # @see Lotus::Action::HEAD#finish
+      #
+      # @example
+      #   require 'lotus/controller'
+      #
+      #   module Books
+      #     class Destroy
+      #       include Lotus::Action
+      #
+      #       def call(params)
+      #         # ...
+      #         self.headers.merge!(
+      #           'Last-Modified' => 'Fri, 27 Nov 2015 13:32:36 GMT',
+      #           'X-Rate-Limit'  => '4000',
+      #           'Content-Type'  => 'application/json',
+      #           'X-No-Pass'     => 'true'
+      #         )
+      #
+      #         self.status = 204
+      #       end
+      #
+      #       private
+      #
+      #       def keep_response_header?(header)
+      #         super || header == 'X-Rate-Limit'
+      #       end
+      #     end
+      #   end
+      #
+      #   # Only the following headers will be sent:
+      #   #  * Last-Modified - because we used `super' in the method that respects the HTTP RFC
+      #   #  * X-Rate-Limit  - because we explicitely allow it
+      #
+      #   # Both Content-Type and X-No-Pass are removed because they're not allowed
+      def keep_response_header?(header)
+        ENTITY_HEADERS.include?(header)
+      end
     end
   end
 end

data/lib/lotus/controller/version.rb

@@ -3,6 +3,6 @@ module Lotus
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.4.5'.freeze
+    VERSION = '0.4.6'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lotus-controller
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2015-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack