lotus-controller 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ca9d4aeba96621f489499f6dc67a58b62b5dd66
-  data.tar.gz: f86c1e2d695ac2fb3bc595a6fb6b587edd4f6bc1
+  metadata.gz: 69d59a1b6b0f96e6af7bf468a3003a45992b17a3
+  data.tar.gz: 93d926cb9fdf962ef3e55d6c5c1efb6de4b546ad
 SHA512:
-  metadata.gz: 5597d8bc2fe5a15577a6698577adb1f9895c5c37353faed252b045974010b351994cfadcadf3d49215a76b5477aab5d95487d84e570b8913a8a0669ae0dee473
-  data.tar.gz: a8e9f5b71b887a6db599e93e7eb555bb1fa556d33ac0ae5f9c095c18f2b55b29bdf53822b9fa459615c03cedf965d564ef4ee52e347d56bc412aaa1e3ff98133
+  metadata.gz: 129a9981a8f46af6d2cd149b9c811a81011cbc3e68b92af5e428e9d9cdc5afc1bb6070b605900acf231a4612d0eaf2c23088c7c17097c1c83aec9c030d5daa27
+  data.tar.gz: 35da235765f394db0fbcbbe3770732ee3e308825981f9634c0f6e6a626e72acbd3188c00939dfcce097a689e706f1de8ea90814cc435bc30be4d74ac7511f765

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Lotus::Controller
 Complete, fast and testable actions for Rack
 
+## v0.4.0 - 2015-03-23
+### Added
+- [Erol Fornoles] `Action.use` now accepts a block
+- [Alfonso Uceda Pompa] Introduced `Lotus::Controller::Configuration#cookies` as default cookie options.
+- [Alfonso Uceda Pompa] Introduced `Lotus::Controller::Configuration#default_headers` as default HTTP headers to return in all the responses.
+- [Luca Guidi] Introduced `Lotus::Action::Params#get` as a safe API to access nested params.
+
+### Changed
+- [Alfonso Uceda Pompa] `redirect_to` now is a flow control method: it terminates the execution of an action, including the callbacks.
+
 ## 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`.

data/lib/lotus/action/callable.rb

@@ -68,7 +68,7 @@ module Lotus
       def call(env)
         _rescue do
           @_env    = env
-          @headers = ::Rack::Utils::HeaderHash.new
+          @headers = ::Rack::Utils::HeaderHash.new(configuration.default_headers)
           @params  = self.class.params_class.new(@_env)
           super @params
         end

data/lib/lotus/action/cookie_jar.rb

@@ -36,9 +36,10 @@ module Lotus
       # @return [CookieJar]
       #
       # @since 0.1.0
-      def initialize(env, headers)
-        @_headers = headers
-        @cookies  = Utils::Hash.new(extract(env)).symbolize!
+      def initialize(env, headers, default_options)
+        @_headers        = headers
+        @cookies         = Utils::Hash.new(extract(env)).symbolize!
+        @default_options = default_options
       end
 
       # Finalize itself, by setting the proper headers to add and remove
@@ -50,7 +51,7 @@ module Lotus
       #
       # @see Lotus::Action::Cookies#finish
       def finish
-        @cookies.each {|k,v| v.nil? ? delete_cookie(k) : set_cookie(k, v) }
+        @cookies.each { |k,v| v.nil? ? delete_cookie(k) : set_cookie(k, _merge_default_values(v)) }
       end
 
       # Returns the object associated with the given key
@@ -77,6 +78,21 @@ module Lotus
       end
 
       private
+
+      # Merge default cookies options with values provided by user
+      #
+      # Cookies values provided by user are respected
+      #
+      # @since 0.4.0
+      # @api private
+      def _merge_default_values(value)
+        cookies_options = if value.is_a? Hash
+          value
+        else
+          { value: value }
+        end
+        @default_options.merge cookies_options
+      end
       # Extract the cookies from the raw Rack env.
       #
       # This implementation is borrowed from Rack::Request#cookies.

data/lib/lotus/action/cookies.rb

@@ -41,7 +41,7 @@ module Lotus
       #     end
       #   end
       def cookies
-        @cookies ||= CookieJar.new(@_env.dup, headers)
+        @cookies ||= CookieJar.new(@_env.dup, headers, configuration.cookies)
       end
 
       private

data/lib/lotus/action/flash.rb

@@ -12,6 +12,12 @@ module Lotus
       # @api private
       SESSION_KEY = :__flash
 
+      # Session key where the last request_id is stored
+      #
+      # @since 0.4.0
+      # @api private
+      LAST_REQUEST_KEY = :__last_request_id
+
       # Initialize a new Flash instance
       #
       # @param session [Rack::Session::Abstract::SessionHash] the session
@@ -22,8 +28,9 @@ module Lotus
       # @see http://www.rubydoc.info/gems/rack/Rack/Session/Abstract/SessionHash
       # @see Lotus::Action::Rack#session_id
       def initialize(session, request_id)
-        @session    = session
-        @request_id = request_id
+        @session         = session
+        @request_id      = request_id
+        @last_request_id = session[LAST_REQUEST_KEY]
 
         session[SESSION_KEY]             ||= {}
         session[SESSION_KEY][request_id] ||= {}
@@ -47,7 +54,7 @@ module Lotus
       # @since 0.3.0
       # @api private
       def [](key)
-        data.fetch(key) do
+        last_request_flash.merge(data).fetch(key) do
           _values.find {|data| !data[key].nil? }
         end
       end
@@ -66,6 +73,7 @@ module Lotus
         # It may happen that `#flash` is nil, and those two methods will fail
         unless flash.nil?
           expire_stale!
+          set_last_request_id!
           remove!
         end
       end
@@ -111,7 +119,7 @@ module Lotus
       # @api private
       def expire_stale!
         flash.each do |request_id, _|
-          flash.delete(request_id) if @request_id != request_id
+          flash.delete(request_id) if delete?(request_id)
         end
       end
 
@@ -136,6 +144,39 @@ module Lotus
       def _values
         flash.values
       end
+
+      # Determine if delete data from flash for the given Request ID
+      #
+      # @return [TrueClass,FalseClass] the result of the check
+      #
+      # @since 0.4.0
+      # @api private
+      #
+      # @see Lotus::Action::Flash#expire_stale!
+      def delete?(request_id)
+        ![@request_id, @session[LAST_REQUEST_KEY]].include?(request_id)
+      end
+
+      # Get the last request session flash
+      #
+      # @return [Hash] the flash of last request
+      #
+      # @since 0.4.0
+      # @api private
+      def last_request_flash
+        flash[@last_request_id] || {}
+      end
+
+      # Store the last request_id to create the next flash with its values
+      # is current flash is not empty.
+      #
+      # @return [void]
+      # @since 0.4.0
+      # @api private
+      def set_last_request_id!
+        @session[LAST_REQUEST_KEY] = @request_id if !empty?
+      end
+
     end
   end
 end

data/lib/lotus/action/head.rb

@@ -14,6 +14,32 @@ module Lotus
       # @api private
       HTTP_STATUSES_WITHOUT_BODY = Set.new((100..199).to_a << 204 << 205 << 304).freeze
 
+
+      # Entity headers allowed in blank body responses, according to
+      # RFC 2616 - Section 10 (HTTP 1.1).
+      #
+      # "The response MAY include new or updated metainformation in the form
+      #   of entity-headers".
+      #
+      # @since 0.4.0
+      # @api private
+      #
+      # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5
+      # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec7.html
+      ENTITY_HEADERS = {
+        'Allow'            => true,
+        'Content-Encoding' => true,
+        'Content-Language' => true,
+        'Content-Length'   => true,
+        'Content-Location' => true,
+        'Content-MD5'      => true,
+        'Content-Range'    => true,
+        'Content-Type'     => true,
+        'Expires'          => true,
+        'Last-Modified'    => true,
+        'extension-header' => true
+      }.freeze
+
       # Ensures to not send body or headers for HEAD requests and/or for status
       # codes that doesn't allow them.
       #
@@ -26,6 +52,7 @@ module Lotus
 
         if _requires_no_body?
           @_body = nil
+          @headers.reject! { |header,_| !ENTITY_HEADERS.include?(header) }
         end
       end
 

data/lib/lotus/action/params.rb

@@ -26,6 +26,14 @@ module Lotus
       # @since 0.1.0
       ROUTER_PARAMS = 'router.params'.freeze
 
+      # Separator for #get
+      #
+      # @since 0.4.0
+      # @api private
+      #
+      # @see Lotus::Action::Params#get
+      GET_SEPARATOR = '.'.freeze
+
       # Whitelist and validate a parameter
       #
       # @param name [#to_sym] The name of the param to whitelist
@@ -137,6 +145,52 @@ module Lotus
         @attributes.get(key)
       end
 
+      # Get an attribute value associated with the given key.
+      # Nested attributes are reached with a dot notation.
+      #
+      # @param key [String] the key
+      #
+      # @return [Object,NilClass] return the associated value, if found
+      #
+      # @since 0.4.0
+      #
+      # @example
+      #   require 'lotus/controller'
+      #
+      #   module Deliveries
+      #     class Create
+      #       include Lotus::Action
+      #
+      #       params do
+      #         param :customer_name
+      #         param :address do
+      #           param :city
+      #         end
+      #       end
+      #
+      #       def call(params)
+      #         params.get('customer_name')   # => "Luca"
+      #         params.get('uknown')          # => nil
+      #
+      #         params.get('address.city')    # => "Rome"
+      #         params.get('address.unknown') # => nil
+      #
+      #         params.get(nil)               # => nil
+      #       end
+      #     end
+      #   end
+      def get(key)
+        key, *keys = key.to_s.split(GET_SEPARATOR)
+        result     = self[key]
+
+        Array(keys).each do |k|
+          break if result.nil?
+          result = result[k]
+        end
+
+        result
+      end
+
       # Returns the Ruby's hash
       #
       # @return [Hash]

data/lib/lotus/action/rack.rb

@@ -94,8 +94,8 @@ module Lotus
         #       end
         #     end
         #   end
-        def use(middleware, *args)
-          rack_builder.use middleware, *args
+        def use(middleware, *args, &block)
+          rack_builder.use middleware, *args, &block
         end
       end
 

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

@@ -9,7 +9,7 @@ module Lotus
         # @param env [Hash] the full Rack env or the params. This value may vary,
         #   see the examples below.
         #
-        # @since x.x.x
+        # @since 0.4.0
         #
         # @see Lotus::Action::Rack::ClassMethods#rack_builder
         # @see Lotus::Action::Rack::ClassMethods#use
@@ -21,7 +21,7 @@ module Lotus
         #      def initialize(app)
         #        @app = app
         #      end
-        #      
+        #
         #      def call(env)
         #        #...
         #      end
@@ -44,4 +44,4 @@ module Lotus
       end
     end
   end
-end
+end

data/lib/lotus/action/redirect.rb

@@ -12,13 +12,15 @@ module Lotus
 
       private
 
-      # Redirect to the given URL
+      # Redirect to the given URL and halt the request
       #
       # @param url [String] the destination URL
       # @param status [Fixnum] the http code
       #
       # @since 0.1.0
       #
+      # @see Lotus::Action::Throwable#halt
+      #
       # @example With default status code (302)
       #   require 'lotus/controller'
       #
@@ -50,7 +52,7 @@ module Lotus
       #   action.call({}) # => [301, {'Location' => '/articles/23'}, '']
       def redirect_to(url, status: 302)
         headers[LOCATION] = url
-        self.status = status
+        halt(status)
       end
     end
   end

data/lib/lotus/action/session.rb

@@ -112,8 +112,8 @@ module Lotus
       #   # The validation errors caused by Comments::Create are available
       #   # **after the redirect** in the context of Comments::Index.
       def redirect_to(*args)
-        super
         flash[ERRORS_KEY] = errors.to_a unless params.valid?
+        super
       end
 
       # Read errors from flash or delegate to the superclass

data/lib/lotus/controller/configuration.rb

@@ -469,6 +469,67 @@ module Lotus
         end
       end
 
+      # Set default headers for all responses
+      #
+      # By default this value is an empty hash.
+      #
+      # @since 0.4.0
+      #
+      # @example Getting the value
+      #   require 'lotus/controller'
+      #
+      #   Lotus::Controller.configuration.default_headers # => {}
+      #
+      # @example Setting the value
+      #   require 'lotus/controller'
+      #
+      #   Lotus::Controller.configure do
+      #     default_headers({
+      #       'X-Frame-Options' => 'DENY'
+      #     })
+      #   end
+      def default_headers(headers = nil)
+        if headers
+          @default_headers.merge!(
+            headers.reject {|_,v| v.nil? }
+          )
+        else
+          @default_headers
+        end
+      end
+
+      # Set default cookies options for all responses
+      #
+      # By default this value is an empty hash.
+      #
+      # @since 0.4.0
+      #
+      # @example Getting the value
+      #   require 'lotus/controller'
+      #
+      #   Lotus::Controller.configuration.cookies # => {}
+      #
+      # @example Setting the value
+      #   require 'lotus/controller'
+      #
+      #   Lotus::Controller.configure do
+      #     cookies({
+      #       domain: 'lotusrb.org',
+      #       path: '/controller',
+      #       secure: true,
+      #       httponly: true
+      #     })
+      #   end
+      def cookies(options = nil)
+        if options
+          @cookies.merge!(
+            options.reject { |_, v| v.nil? }
+          )
+        else
+          @cookies
+        end
+      end
+
       # Returns a format for the given mime type
       #
       # @param mime_type [#to_s,#to_str] A mime type
@@ -503,13 +564,15 @@ module Lotus
       # @api private
       def duplicate
         Configuration.new.tap do |c|
-          c.handle_exceptions  = handle_exceptions
-          c.handled_exceptions = handled_exceptions.dup
-          c.action_module      = action_module
-          c.modules            = modules.dup
-          c.formats            = formats.dup
-          c.default_format     = default_format
-          c.default_charset    = default_charset
+          c.handle_exceptions       = handle_exceptions
+          c.handled_exceptions      = handled_exceptions.dup
+          c.action_module           = action_module
+          c.modules                 = modules.dup
+          c.formats                 = formats.dup
+          c.default_format          = default_format
+          c.default_charset         = default_charset
+          c.default_headers         = default_headers.dup
+          c.cookies = cookies.dup
         end
       end
 
@@ -534,6 +597,8 @@ module Lotus
         @formats            = DEFAULT_FORMATS.dup
         @default_format     = nil
         @default_charset    = nil
+        @default_headers    = {}
+        @cookies            = {}
         @action_module      = ::Lotus::Action
       end
 
@@ -569,6 +634,8 @@ module Lotus
       attr_writer :modules
       attr_writer :default_format
       attr_writer :default_charset
+      attr_writer :default_headers
+      attr_writer :cookies
     end
   end
 end

data/lib/lotus/controller/version.rb

@@ -3,6 +3,6 @@ module Lotus
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.3.2'.freeze
+    VERSION = '0.4.0'.freeze
   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.4'
-  spec.add_dependency 'lotus-validations', '~> 0.2', '>= 0.2.4'
+  spec.add_dependency 'lotus-utils',       '~> 0.4'
+  spec.add_dependency 'lotus-validations', '~> 0.3'
 
   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.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -31,40 +31,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.4
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: lotus-validations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -183,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Complete, fast and testable actions for Rack and Lotus