lotus-controller 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69d59a1b6b0f96e6af7bf468a3003a45992b17a3
-  data.tar.gz: 93d926cb9fdf962ef3e55d6c5c1efb6de4b546ad
+  metadata.gz: 40bc827a76215d889abc5fd33c3b102cb626732e
+  data.tar.gz: 3ea7a9a16a40c1e00e2861684076f1a7c543efa8
 SHA512:
-  metadata.gz: 129a9981a8f46af6d2cd149b9c811a81011cbc3e68b92af5e428e9d9cdc5afc1bb6070b605900acf231a4612d0eaf2c23088c7c17097c1c83aec9c030d5daa27
-  data.tar.gz: 35da235765f394db0fbcbbe3770732ee3e308825981f9634c0f6e6a626e72acbd3188c00939dfcce097a689e706f1de8ea90814cc435bc30be4d74ac7511f765
+  metadata.gz: 2ff6ac5d43e155662c2318ba55184260d4ffdebbb6d0b6eec607d3563439bd809bf8dee089fdb342779eaa23c10d1d7bb5074ae11ead2c5c832bd64ee9506272
+  data.tar.gz: 8e6e4c60d239bd321aa0a1aec3aad3120fbef86dc86f33e8c50603f18013650b63ff184572379068fb2f734b7faf593586fcf0c97b9d3f5feb6d6e0167151df2

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Lotus::Controller
 Complete, fast and testable actions for Rack
 
+## v0.4.1 - 2015-05-15
+### Fixed
+- [Luca Guidi] Ensure proper automatic `Content-Type` working well with Internet Explorer.
+- [Luca Guidi] Ensure `Lotus::Action#redirect_to` to return `::String` for Rack servers compatibility.
+
+### Changed
+- [Alfonso Uceda Pompa] Prevent `Content-Type` and `Content-Lenght` to be sent when status code requires no body (eg. `204`).
+    This is for compatibility with `Rack::Lint`, not with RFC 2016.
+- [Luca Guidi] Ensure `Lotus::Action::Params#to_h` to return `::Hash`
+
 ## v0.4.0 - 2015-03-23
 ### Added
 - [Erol Fornoles] `Action.use` now accepts a block

data/README.md

@@ -75,7 +75,7 @@ __An action is an object__. That's important because __you have the full control
 In other words, you have the freedom to instantiate, inject dependencies and test it, both at the unit and integration level.
 
 In the example below, the default repository is `Article`. During a unit test we can inject a stubbed version, and invoke `#call` with the params.
-__We're avoiding HTTP calls__, we're eventually avoiding to hit the database (it depends on the stubbed repository), __we're just dealing with message passing__.
+__We're avoiding HTTP calls__, we're also going to avoid hitting the database (it depends on the stubbed repository), __we're just dealing with message passing__.
 Imagine how **fast** the unit test could be.
 
 ```ruby
@@ -99,7 +99,7 @@ action.call({ id: 23 })
 
 The request params are passed as an argument to the `#call` method.
 If routed with *Lotus::Router*, it extracts the relevant bits from the Rack `env` (eg the requested `:id`).
-Otherwise everything passed as is: the full Rack `env` in production, and the given `Hash` for unit tests.
+Otherwise everything is passed as is: the full Rack `env` in production, and the given `Hash` for unit tests.
 
 With Lotus::Router:
 
@@ -158,6 +158,12 @@ class Signup
     param :first_name
     param :last_name
     param :email
+    
+    param :address do
+      param :line_one
+      param :state
+      param :country
+    end
   end
 
   def call(params)
@@ -168,6 +174,10 @@ class Signup
     # Whitelist :first_name, but not :admin
     puts params[:first_name]     # => "Luca"
     puts params[:admin]          # => nil
+    
+    # Whitelist nested params [:address][:line_one], not [:address][:line_two]
+    puts params[:address][:line_one] # => '69 Tender St'
+    puts params[:address][:line_two] # => nil
   end
 end
 ```
@@ -232,7 +242,7 @@ action = Show.new
 action.call({}) # => [200, {}, [""]]
 ```
 
-It has private accessors to explicitly set status, headers and body:
+It has private accessors to explicitly set status, headers, and body:
 
 ```ruby
 class Show
@@ -251,17 +261,17 @@ action.call({}) # => [201, { "X-Custom" => "OK" }, ["Hi!"]]
 
 ### Exposures
 
-We know that actions are objects and Lotus::Action respects one of the pillars of OOP: __encapsulation__.
+We know that actions are objects and `Lotus::Action` respects one of the pillars of OOP: __encapsulation__.
 Other frameworks extract instance variables (`@ivar`) and make them available to the view context.
 
-Lotus::Action's solution is the simple and powerful DSL: `expose`.
+`Lotus::Action`'s solution is the simple and powerful DSL: `expose`.
 It's a thin layer on top of `attr_reader`.
 
 Using `expose` creates a getter for the given attribute, and adds it to the _exposures_.
 Exposures (`#exposures`) are a set of attributes exposed to the view.
 That is to say the variables necessary for rendering a view.
 
-By default, all Lotus::Actions expose `#params` and `#errors`.
+By default, all `Lotus::Action` objects expose `#params` and `#errors`.
 
 ```ruby
 class Show
@@ -526,10 +536,34 @@ class RemoveCookies
   end
 end
 
-action = SetCookies.new
+action = RemoveCookies.new
 action.call({}) # => [200, {'Set-Cookie' => "foo=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000"}, '...']
 ```
 
+Default values can be set in configuration, but overriden case by case.
+
+```ruby
+require 'lotus/controller'
+require 'lotus/action/cookies'
+
+Lotus::Controller.configure do
+  cookies max_age: 300 # 5 minutes
+end
+
+class SetCookies
+  include Lotus::Action
+  include Lotus::Action::Cookies
+
+  def call(params)
+    # ...
+    cookies[:foo] = { value: 'bar', max_age: 100 }
+  end
+end
+
+action = SetCookies.new
+action.call({}) # => [200, {'Set-Cookie' => "foo=bar; max-age=100;"}, '...']
+```
+
 ### Sessions
 
 It has builtin support for Rack sessions:
@@ -722,7 +756,7 @@ action.call({ article: { title: 'Hello' }}) # => [301, {'Location' => '/articles
 
 ### Mime Types
 
-Lotus::Action automatically sets the `Content-Type` header, according to the request.
+`Lotus::Action` automatically sets the `Content-Type` header, according to the request.
 
 ```ruby
 class Show
@@ -872,7 +906,7 @@ Articles::Index.new.call({})
 ### Lotus::Router integration
 
 While Lotus::Router works great with this framework, Lotus::Controller doesn't depend on it.
-You, as developer, are free to choose your own routing system.
+You, the developer, are free to choose your own routing system.
 
 But, if you use them together, the **only constraint is that an action must support _arity 0_ in its constructor**.
 The following examples are valid constructors:
@@ -908,9 +942,8 @@ While a Lotus application's architecture is more web oriented, this framework is
 
 ### Rack middleware
 
-Rack middleware can be configured globally in `config.ru`, but often they add an
-unnecessary overhead for all those endpoints that aren't direct users of a
-certain middleware.
+Rack middleware can be configured globally in `config.ru`. However, consider that they often add
+unnecessary overhead for *all* endpoints that aren't direct users of all the configured middleware.
 
 Think about a middleware to create sessions, where only `SessionsController::Create` needs that middleware, but every other action pays the performance price for that middleware.
 
@@ -1067,8 +1100,8 @@ end
 run Action
 ```
 
-Lotus::Controller heavely depends on class configuration, to ensure immutability
-in deployment environments, please consider of invoke `Lotus::Controller.load!`.
+Lotus::Controller heavely depends on class configuration. To ensure immutability
+in deployment environments, use `Lotus::Controller.load!`.
 
 ## Versioning
 

data/lib/lotus/action/cookie_jar.rb

@@ -68,11 +68,22 @@ module Lotus
       # Associate the given value with the given key and store them
       #
       # @param key [Symbol] the key
-      # @param value [Object] the value
+      # @param value [#to_s,Hash] value that can be serialized as a string or
+      #   expressed as a Hash
+      # @option value [String] :domain - The domain
+      # @option value [String] :path - The path
+      # @option value [Integer] :max_age - Duration expressed in seconds
+      # @option value [Time] :expires - Expiration time
+      # @option value [TrueClass,FalseClass] :secure - Restrict cookie to secure
+      #   connections
+      # @option value [TrueClass,FalseClass] :httponly - Restrict JavaScript
+      #   access
       #
       # @return [void]
       #
       # @since 0.2.0
+      #
+      # @see http://en.wikipedia.org/wiki/HTTP_cookie
       def []=(key, value)
         @cookies[key] = value
       end
@@ -93,6 +104,7 @@ module Lotus
         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

@@ -14,12 +14,21 @@ module Lotus
 
       # Gets the cookies from the request and expose them as an Hash
       #
-      # @return [Lotus::Action::CookieJar] the cookies
+      # It automatically sets options from global configuration, but it allows to
+      # override values case by case.
+      #
+      # For a list of options please have a look at <tt>Lotus::Controller::Configuration</tt>,
+      # and <tt>Lotus::Action::CookieJar</tt>.
+      #
+      # @return [Lotus::Action::CookieJar] cookies
       #
       # @since 0.1.0
       # @api public
       #
-      # @example
+      # @see Lotus::Controller::Configuration#cookies
+      # @see Lotus::Action::CookieJar#[]=
+      #
+      # @example Basic Usage
       #   require 'lotus/controller'
       #   require 'lotus/action/cookies'
       #
@@ -40,6 +49,21 @@ module Lotus
       #       cookies[:bax] = nil
       #     end
       #   end
+      #
+      # @example Cookies Options
+      #   require 'lotus/controller'
+      #   require 'lotus/action/cookies'
+      #
+      #   class Show
+      #     include Lotus::Action
+      #     include Lotus::Action::Cookies
+      #
+      #     def call(params)
+      #       # ...
+      #       # set a value
+      #       cookies[:foo] = { value: 'bar', max_age: 300, path: '/dashboard' }
+      #     end
+      #   end
       def cookies
         @cookies ||= CookieJar.new(@_env.dup, headers, configuration.cookies)
       end

data/lib/lotus/action/head.rb

@@ -30,11 +30,9 @@ module Lotus
         '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

data/lib/lotus/action/mime.rb

@@ -1,3 +1,5 @@
+require 'rack/utils'
+require 'lotus/utils'
 require 'lotus/utils/kernel'
 
 module Lotus
@@ -415,7 +417,7 @@ module Lotus
       # @api private
       def accepts
         unless accept == DEFAULT_ACCEPT
-          ::Rack::Utils.best_q_match(accept, ::Rack::Mime::MIME_TYPES.values)
+          best_q_match(accept, ::Rack::Mime::MIME_TYPES.values)
         end
       end
 
@@ -446,6 +448,34 @@ module Lotus
         "#{content_type}; charset=#{charset}"
       end
 
+      # Patched version of <tt>Rack::Utils.best_q_match</tt>.
+      #
+      # @since x.x.x
+      # @api private
+      #
+      # @see http://www.rubydoc.info/gems/rack/Rack/Utils#best_q_match-class_method
+      # @see https://github.com/rack/rack/pull/659
+      # @see https://github.com/lotus/controller/issues/59
+      # @see https://github.com/lotus/controller/issues/104
+      def best_q_match(q_value_header, available_mimes)
+        values = ::Rack::Utils.q_values(q_value_header)
+
+        values = values.map do |req_mime, quality|
+          match = available_mimes.find { |am| ::Rack::Mime.match?(am, req_mime) }
+          next unless match
+          [match, quality]
+        end.compact
+
+        # See https://github.com/lotus/controller/issues/59
+        # See https://github.com/lotus/controller/issues/104
+        values = values.reverse unless Lotus::Utils.jruby?
+
+        value  = values.sort_by do |match, quality|
+          (match.split('/', 2).count('*') * -10) + quality
+        end.last
+
+        value.first if value
+      end
     end
   end
 end

data/lib/lotus/action/redirect.rb

@@ -51,7 +51,7 @@ module Lotus
       #   action = Create.new
       #   action.call({}) # => [301, {'Location' => '/articles/23'}, '']
       def redirect_to(url, status: 302)
-        headers[LOCATION] = url
+        headers[LOCATION] = ::String.new(url)
         halt(status)
       end
     end

data/lib/lotus/controller.rb

@@ -2,7 +2,6 @@ require 'lotus/utils/class_attribute'
 require 'lotus/action'
 require 'lotus/controller/configuration'
 require 'lotus/controller/version'
-require 'rack-patch'
 
 module Lotus
   # A set of logically grouped actions

data/lib/lotus/controller/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lotus-controller
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Luca Guidi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -149,7 +149,6 @@ files:
 - lib/lotus/controller/configuration.rb
 - lib/lotus/controller/version.rb
 - lib/lotus/http/status.rb
-- lib/rack-patch.rb
 - lotus-controller.gemspec
 homepage: http://lotusrb.org
 licenses:

data/lib/rack-patch.rb

@@ -1,28 +0,0 @@
-# see https://github.com/rack/rack/pull/659
-require 'rack'
-require 'lotus/utils'
-
-if Rack.release <= '1.5'
-  require 'rack/utils'
-
-  Rack::Utils.class_eval do
-    def self.best_q_match(q_value_header, available_mimes)
-      values = q_values(q_value_header)
-
-      values = values.map do |req_mime, quality|
-        match = available_mimes.find { |am| Rack::Mime.match?(am, req_mime) }
-        next unless match
-        [match, quality]
-      end.compact
-
-      # See https://github.com/lotus/controller/issues/59
-      values = values.reverse if RUBY_VERSION >= '2.2.0' || Lotus::Utils.rubinius?
-
-      value  = values.sort_by do |match, quality|
-        (match.split('/', 2).count('*') * -10) + quality
-      end.last
-
-      value.first if value
-    end
-  end
-end