lotus-controller 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 394aa431f6edb629284fc999c3a317ce46a34b91
-  data.tar.gz: 97020ea1106fa6b4abe1a878143c9a2494603933
+  metadata.gz: 6ca9d4aeba96621f489499f6dc67a58b62b5dd66
+  data.tar.gz: f86c1e2d695ac2fb3bc595a6fb6b587edd4f6bc1
 SHA512:
-  metadata.gz: 02f845f2f20d2f91c4a5cf3247a70e231f9f776bea1b550b85e971d4abdb06027951c75096b7b9dd246421a00fd14bd6b8063cca5fd097ba51ce6fbfef38ae98
-  data.tar.gz: df96a33e1899c417311907ea6313c190000355076dcac07502096768369ef1ddc824dfd9e5214551b0e07ba89c0312c6dc21b635b66a797d4f9fb3c63ed184d9
+  metadata.gz: 5597d8bc2fe5a15577a6698577adb1f9895c5c37353faed252b045974010b351994cfadcadf3d49215a76b5477aab5d95487d84e570b8913a8a0669ae0dee473
+  data.tar.gz: a8e9f5b71b887a6db599e93e7eb555bb1fa556d33ac0ae5f9c095c18f2b55b29bdf53822b9fa459615c03cedf965d564ef4ee52e347d56bc412aaa1e3ff98133

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Lotus::Controller
 Complete, fast and testable actions for Rack
 
+## v0.3.2 - 2015-01-30
+### Added
+- [Alfonso Uceda Pompa] Callbacks: introduced `append_before` (alias of `before`), `append_after` (alias of `after`), `prepend_before` and `prepend_after`.
+- [Alfonso Uceda Pompa] Introduced `Lotus::Action::Params#raw` which returns unfiltered data as it comes from an HTTP request.
+- [Alfonso Uceda Pompa] `Lotus::Action::Rack.use` now fully supports Rack middleware, by mounting an internal `Rack::Builder` instance.
+- [Simone Carletti] `Lotus::Action::Throwable#halt` now accepts an optional message. If missing it falls back to the corresponding HTTP status message.
+- [Steve Hodgkiss] Nested params validation
+
+### Fixed
+- [Luca Guidi] Ensure HEAD requests will return empty body
+- [Stefano Verna] Ensure HTTP status codes with empty body won't send body and non-entity headers.
+- [Luca Guidi] Only dump exceptions in `rack.errors` if handling is turned off, or the raised exception is not managed.
+- [Luca Guidi] Ensure params will return coerced values
+
 ## v0.3.1 - 2015-01-08
 ### Added
 - [Lasse Skindstad Ebert] Introduced `Action#request` which returns an instance a `Rack::Request` compliant object: `Lotus::Action::Request`.

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Luca Guidi
+Copyright © 2014-2015 Luca Guidi
 
 MIT License
 

data/README.md

@@ -446,6 +446,26 @@ action = Show.new
 action.call({}) # => [401, {}, ["Unauthorized"]]
 ```
 
+Alternatively, you can specify a custom message.
+
+```ruby
+class Show
+  include Lotus::Action
+
+  def call(params)
+    DroidRepository.find(params[:id]) or not_found
+  end
+
+  private
+  def not_found
+    halt 404, "This is not the droid you're looking for"
+  end
+end
+
+action = Show.new
+action.call({}) # => [404, {}, ["This is not the droid you're looking for"]]
+```
+
 ### Cookies
 
 Lotus::Controller offers convenient access to cookies.
@@ -1064,4 +1084,4 @@ __Lotus::Controller__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright 2014 Luca Guidi – Released under MIT License
+Copyright © 2014-2015 Luca Guidi – Released under MIT License

data/lib/lotus/action.rb

@@ -6,6 +6,7 @@ require 'lotus/action/exposable'
 require 'lotus/action/throwable'
 require 'lotus/action/callbacks'
 require 'lotus/action/validatable'
+require 'lotus/action/head'
 require 'lotus/action/callable'
 
 module Lotus
@@ -36,6 +37,7 @@ module Lotus
     #
     # @see Lotus::Action::Rack
     # @see Lotus::Action::Mime
+    # @see Lotus::Action::Http
     # @see Lotus::Action::Redirect
     # @see Lotus::Action::Exposable
     # @see Lotus::Action::Throwable
@@ -53,6 +55,7 @@ module Lotus
         include Callbacks
         include Validatable
         include Configurable
+        include Head
         prepend Callable
       end
     end
@@ -75,6 +78,7 @@ module Lotus
     # @see Lotus::Action::Session#finish
     # @see Lotus::Action::Cookies#finish
     # @see Lotus::Action::Cache#finish
+    # @see Lotus::Action::Head#finish
     def finish
     end
   end

data/lib/lotus/action/callbacks.rb

@@ -17,7 +17,7 @@ module Lotus
       # @since 0.1.0
       # @api private
       #
-      # @see http://www.ruby-doc.org/core-2.1.2/Module.html#method-i-included
+      # @see http://www.ruby-doc.org/core/Module.html#method-i-included
       def self.included(base)
         base.class_eval do
           extend  ClassMethods
@@ -38,7 +38,7 @@ module Lotus
         # @since 0.1.0
         # @api private
         #
-        # @see http://www.ruby-doc.org/core-2.1.2/Module.html#method-i-extended
+        # @see http://www.ruby-doc.org/core/Module.html#method-i-extended
         def self.extended(base)
           base.class_eval do
             include Utils::ClassAttribute
@@ -63,7 +63,9 @@ module Lotus
         #
         # @return [void]
         #
-        # @since 0.1.0
+        # @since 0.3.2
+        #
+        # @see Lotus::Action::Callbacks::ClassMethods#append_after
         #
         # @example Method names (symbols)
         #   require 'lotus/controller'
@@ -111,10 +113,13 @@ module Lotus
         #   # 1. authentication
         #   # 2. set the article
         #   # 3. #call
-        def before(*callbacks, &blk)
-          before_callbacks.add(*callbacks, &blk)
+        def append_before(*callbacks, &blk)
+          before_callbacks.append(*callbacks, &blk)
         end
 
+        # @since 0.1.0
+        alias_method :before, :append_before
+
         # Define a callback for an Action.
         # The callback will be executed **after** the action is called, in the
         # order they are added.
@@ -127,11 +132,52 @@ module Lotus
         #
         # @return [void]
         #
+        # @since 0.3.2
+        #
+        # @see Lotus::Action::Callbacks::ClassMethods#append_before
+        def append_after(*callbacks, &blk)
+          after_callbacks.append(*callbacks, &blk)
+        end
+
         # @since 0.1.0
+        alias_method :after, :append_after
+
+        # Define a callback for an Action.
+        # The callback will be executed **before** the action is called.
+        # It will add the callback at the beginning of the callbacks' chain.
+        #
+        # @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
+        #   each of them is representing a name of a method available in the
+        #   context of the Action.
+        #
+        # @param blk [Proc] an anonymous function to be executed
+        #
+        # @return [void]
+        #
+        # @since 0.3.2
+        #
+        # @see Lotus::Action::Callbacks::ClassMethods#prepend_after
+        def prepend_before(*callbacks, &blk)
+          before_callbacks.prepend(*callbacks, &blk)
+        end
+
+        # Define a callback for an Action.
+        # The callback will be executed **after** the action is called.
+        # It will add the callback at the beginning of the callbacks' chain.
+        #
+        # @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
+        #   each of them is representing a name of a method available in the
+        #   context of the Action.
+        #
+        # @param blk [Proc] an anonymous function to be executed
+        #
+        # @return [void]
+        #
+        # @since 0.3.2
         #
-        # @see Lotus::Action::Callbacks::ClassMethods#before
-        def after(*callbacks, &blk)
-          after_callbacks.add(*callbacks, &blk)
+        # @see Lotus::Action::Callbacks::ClassMethods#prepend_before
+        def prepend_after(*callbacks, &blk)
+          after_callbacks.prepend(*callbacks, &blk)
         end
       end
 

data/lib/lotus/action/glue.rb

@@ -2,6 +2,9 @@ module Lotus
   module Action
     # Glue code for full stack Lotus applications
     #
+    # This includes missing rendering logic that it makes sense to include
+    # only for web applications.
+    #
     # @api private
     # @since 0.3.0
     module Glue
@@ -11,12 +14,30 @@ module Lotus
       # @since 0.3.0
       ENV_KEY = 'lotus.action'.freeze
 
+      # @api private
+      # @since 0.3.2
+      ADDITIONAL_HTTP_STATUSES_WITHOUT_BODY = Set.new([301, 302]).freeze
+
       # Override Ruby's Module#included
       #
       # @api private
       # @since 0.3.0
       def self.included(base)
-        base.class_eval { expose :format }
+        base.class_eval { expose(:format) if respond_to?(:expose) }
+      end
+
+      # Check if the current HTTP request is renderable.
+      #
+      # It verifies if the verb isn't HEAD and if the status demands to omit
+      # the body.
+      #
+      # @return [TrueClass,FalseClass] the result of the check
+      #
+      # @api private
+      # @since 0.3.2
+      def renderable?
+        !_requires_no_body? &&
+          !ADDITIONAL_HTTP_STATUSES_WITHOUT_BODY.include?(@_status)
       end
 
       protected

data/lib/lotus/action/head.rb

@@ -0,0 +1,40 @@
+module Lotus
+  module Action
+    # Ensures to not send body or headers for HEAD requests and/or for status
+    # codes that doesn't allow them.
+    #
+    # @since 0.3.2
+    #
+    # @see http://www.ietf.org/rfc/rfc2616.txt
+    module Head
+
+      # Status codes that by RFC must not include a message body
+      #
+      # @since 0.3.2
+      # @api private
+      HTTP_STATUSES_WITHOUT_BODY = Set.new((100..199).to_a << 204 << 205 << 304).freeze
+
+      # Ensures to not send body or headers for HEAD requests and/or for status
+      # codes that doesn't allow them.
+      #
+      # @since 0.3.2
+      # @api private
+      #
+      # @see Lotus::Action#finish
+      def finish
+        super
+
+        if _requires_no_body?
+          @_body = nil
+        end
+      end
+
+      protected
+      # @since 0.3.2
+      # @api private
+      def _requires_no_body?
+        HTTP_STATUSES_WITHOUT_BODY.include?(@_status) || head?
+      end
+    end
+  end
+end

data/lib/lotus/action/params.rb

@@ -80,8 +80,8 @@ module Lotus
       #
       #   params = SignupParams.new({})
       #   params.valid? # => raise ArgumentError
-      def self.param(name, options = {})
-        attribute name, options
+      def self.param(name, options = {}, &block)
+        attribute name, options, &block
         nil
       end
 
@@ -91,12 +91,28 @@ module Lotus
         defined_attributes.any?
       end
 
+      # Overrides the method in Lotus::Validation to build a class that
+      # inherits from Params rather than only Lotus::Validations.
+      #
+      # @since 0.3.2
+      # @api private
+      def self.build_validation_class(&block)
+        kls = Class.new(Params)
+        kls.class_eval(&block)
+        kls
+      end
+
       # @attr_reader env [Hash] the Rack env
       #
       # @since 0.2.0
       # @api private
       attr_reader :env
 
+      # @attr_reader raw [Lotus::Utils::Attributes] all request's attributes
+      #
+      # @since 0.3.2
+      attr_reader :raw
+
       # Initialize the params and freeze them.
       #
       # @param env [Hash] a Rack env or an hash of params.
@@ -138,10 +154,16 @@ module Lotus
         if self.class.whitelisting?
           _whitelisted_params
         else
-          @attributes = Utils::Attributes.new(_params)
+          @attributes = _raw
         end
       end
 
+      # @since 0.3.2
+      # @api private
+      def _raw
+        @raw ||= Utils::Attributes.new(_params)
+      end
+
       # @since 0.3.1
       # @api private
       def _params
@@ -159,7 +181,7 @@ module Lotus
       # @api private
       def _whitelisted_params
         {}.tap do |result|
-          _params.each do |k, v|
+          _raw.to_h.each do |k, v|
             next unless self.class.defined_attributes.include?(k.to_s)
 
             result[k] = v

data/lib/lotus/action/rack.rb

@@ -1,5 +1,6 @@
 require 'securerandom'
 require 'lotus/action/request'
+require 'lotus/action/rack/callable'
 
 module Lotus
   module Action
@@ -27,6 +28,18 @@ module Lotus
       # @see Lotus::Action::Rack#request_id
       DEFAULT_REQUEST_ID_LENGTH = 16
 
+      # The request method
+      #
+      # @since 0.3.2
+      # @api private
+      REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+
+      # HEAD request
+      #
+      # @since 0.3.2
+      # @api private
+      HEAD = 'HEAD'.freeze
+
       # Override Ruby's hook for modules.
       # It includes basic Lotus::Action modules to the given class.
       #
@@ -41,11 +54,20 @@ module Lotus
       end
 
       module ClassMethods
-        # Use a Rack middleware as a before callback.
+        # Build rack builder
         #
-        # The middleware will be used as it is, no matter if it's a class or an
-        # instance. If it needs to be initialized, please do it before to pass
-        # it as the argument of this method.
+        # @return [Rack::Builder]
+        def rack_builder
+          @rack_builder ||= begin
+            extend Lotus::Action::Rack::Callable
+            rack_builder = ::Rack::Builder.new
+            rack_builder.run ->(env) { self.new.call(env) }
+            rack_builder
+          end
+        end
+        # Use a Rack middleware
+        #
+        # The middleware will be used as it is.
         #
         # At the runtime, the middleware be invoked with the raw Rack env.
         #
@@ -53,12 +75,13 @@ module Lotus
         # this method.
         #
         # @param middleware [#call] A Rack middleware
+        # @param args [Array] Array arguments for middleware
         #
         # @since 0.2.0
         #
         # @see Lotus::Action::Callbacks::ClassMethods#before
         #
-        # @example Class Middleware
+        # @example Middleware
         #   require 'lotus/controller'
         #
         #   module Sessions
@@ -71,29 +94,12 @@ module Lotus
         #       end
         #     end
         #   end
-        #
-        # @example Instance Middleware
-        #   require 'lotus/controller'
-        #
-        #   module Sessions
-        #     class Create
-        #       include Lotus::Controller
-        #       use XMiddleware.new('x', 123)
-        #
-        #       def call(params)
-        #         # ...
-        #       end
-        #     end
-        #   end
-        def use(middleware)
-          before do |params|
-            middleware.call(params.env)
-          end
+        def use(middleware, *args)
+          rack_builder.use middleware, *args
         end
       end
 
       protected
-
       # Gets the headers from the response
       #
       # @return [Hash] the HTTP headers from the response
@@ -210,6 +216,15 @@ module Lotus
         body   = Array(body) unless body.respond_to?(:each)
         @_body = body
       end
+
+      # Check if the current request is a HEAD
+      #
+      # @return [TrueClass,FalseClass] the result of the check
+      #
+      # @since 0.3.2
+      def head?
+        @_env[REQUEST_METHOD] == HEAD
+      end
     end
   end
 end

data/lib/lotus/action/rack/callable.rb

@@ -0,0 +1,47 @@
+
+module Lotus
+  module Action
+    module Rack
+      module Callable
+        # Callable module for actions. With this module, actions with middlewares
+        # will be able to work with rack builder.
+        #
+        # @param env [Hash] the full Rack env or the params. This value may vary,
+        #   see the examples below.
+        #
+        # @since x.x.x
+        #
+        # @see Lotus::Action::Rack::ClassMethods#rack_builder
+        # @see Lotus::Action::Rack::ClassMethods#use
+        #
+        # @example
+        #   require 'lotus/controller'
+        #
+        #    class MyMiddleware
+        #      def initialize(app)
+        #        @app = app
+        #      end
+        #      
+        #      def call(env)
+        #        #...
+        #      end
+        #    end
+        #
+        #    class Show
+        #      include Lotus::Action
+        #      use MyMiddleware
+        #
+        #      def call(params)
+        #        # ...
+        #        puts params # => { id: 23 } extracted from Rack env
+        #      end
+        #    end
+        #
+        #    Show.respond_to?(:call) # => true
+        def call(env)
+          rack_builder.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/lotus/action/throwable.rb

@@ -62,24 +62,50 @@ module Lotus
 
       protected
 
-      # Halt the action execution with the given HTTP status code.
+      # Halt the action execution with the given HTTP status code and message.
       #
       # When used, the execution of a callback or of an action is interrupted
       # and the control returns to the framework, that decides how to handle
       # the event.
       #
-      # It also sets the response body with the message associated to the code
-      # (eg 404 will set `"Not Found"`).
+      # If a message is provided, it sets the response body with the message.
+      # Otherwise, it sets the response body with the default message associated
+      # to the code (eg 404 will set `"Not Found"`).
       #
       # @param code [Fixnum] a valid HTTP status code
+      # @param message [String] the response body
       #
       # @since 0.2.0
       #
       # @see Lotus::Controller#handled_exceptions
       # @see Lotus::Action::Throwable#handle_exception
       # @see Lotus::Http::Status:ALL
-      def halt(code = nil)
-        status(*Http::Status.for_code(code)) if code
+      #
+      # @example Basic usage
+      #   require 'lotus/controller'
+      #
+      #   class Show
+      #     def call(params)
+      #       halt 404
+      #     end
+      #   end
+      #
+      #   # => [404, {}, ["Not Found"]]
+      #
+      # @example Custom message
+      #   require 'lotus/controller'
+      #
+      #   class Show
+      #     def call(params)
+      #       halt 404, "This is not the droid you're looking for."
+      #     end
+      #   end
+      #
+      #   # => [404, {}, ["This is not the droid you're looking for."]]
+      def halt(code, message = nil)
+        message ||= Http::Status.message_for(code)
+        status(code, message)
+
         throw :halt
       end
 
@@ -112,6 +138,8 @@ module Lotus
       # @since 0.2.0
       # @api private
       def _reference_in_rack_errors(exception)
+        return if configuration.handled_exception?(exception)
+
         if errors = @_env[RACK_ERRORS]
           errors.write(_dump_exception(exception))
           errors.flush

data/lib/lotus/controller/configuration.rb

@@ -194,6 +194,19 @@ module Lotus
         @handled_exceptions.fetch(exception.class) { DEFAULT_ERROR_CODE }
       end
 
+      # Check if the given exception is handled.
+      #
+      # @param exception [Exception] an exception
+      #
+      # @since 0.3.2
+      # @api private
+      #
+      # @see Lotus::Controller::Configuration#handle_exception
+      def handled_exception?(exception)
+        handled_exceptions &&
+          !!@handled_exceptions.fetch(exception.class) { false }
+      end
+
       # Specify which is the default action module to be included when we use
       # the `Lotus::Controller.action` method.
       #

data/lib/lotus/controller/version.rb

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

data/lib/lotus/http/status.rb

@@ -45,6 +45,18 @@ module Lotus
       def self.for_code(code)
         ALL.assoc(code)
       end
+
+      # Return a message for the given status code
+      #
+      # @param code [Fixnum] a valid HTTP code
+      #
+      # @return [String] a message for the given status code
+      #
+      # @since 0.3.2
+      # @api private
+      def self.message_for(code)
+        for_code(code)[1]
+      end
     end
   end
 end

data/lotus-controller.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency 'rack',              '~> 1.5'
-  spec.add_dependency 'lotus-utils',       '~> 0.3', '>= 0.3.2'
-  spec.add_dependency 'lotus-validations', '~> 0.2', '>= 0.2.2'
+  spec.add_dependency 'lotus-utils',       '~> 0.3', '>= 0.3.4'
+  spec.add_dependency 'lotus-validations', '~> 0.2', '>= 0.2.4'
 
   spec.add_development_dependency 'bundler',   '~> 1.6'
   spec.add_development_dependency 'minitest',  '~> 5'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lotus-controller
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Luca Guidi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-08 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -34,7 +34,7 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: lotus-validations
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +54,7 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -64,7 +64,7 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -147,9 +147,11 @@ files:
 - lib/lotus/action/exposable.rb
 - lib/lotus/action/flash.rb
 - lib/lotus/action/glue.rb
+- lib/lotus/action/head.rb
 - lib/lotus/action/mime.rb
 - lib/lotus/action/params.rb
 - lib/lotus/action/rack.rb
+- lib/lotus/action/rack/callable.rb
 - lib/lotus/action/redirect.rb
 - lib/lotus/action/request.rb
 - lib/lotus/action/session.rb
@@ -181,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Complete, fast and testable actions for Rack and Lotus