lotus-controller 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f0f02211060856c6f853b05907e1993a23684a2
-  data.tar.gz: 98db51b586aa274b812def351f2960219d26a254
+  metadata.gz: 394aa431f6edb629284fc999c3a317ce46a34b91
+  data.tar.gz: 97020ea1106fa6b4abe1a878143c9a2494603933
 SHA512:
-  metadata.gz: 8a9988d2c322dba57028f60615652aa4307ef2808a1a742e7a12c15c70609defb83abec4cd8d0c31eddaf5de49e618f74a4010c97c2c03d95a4544fe459b388a
-  data.tar.gz: 688a5dba74eecf6c8d6a14891c9b4d0d2c8b853864e66fa0beb6f09c0abd3918b18ab2daf957e64ece73a1e72ea86f803b67ffbf6bd3a8bc1e0e433a66767f05
+  metadata.gz: 02f845f2f20d2f91c4a5cf3247a70e231f9f776bea1b550b85e971d4abdb06027951c75096b7b9dd246421a00fd14bd6b8063cca5fd097ba51ce6fbfef38ae98
+  data.tar.gz: df96a33e1899c417311907ea6313c190000355076dcac07502096768369ef1ddc824dfd9e5214551b0e07ba89c0312c6dc21b635b66a797d4f9fb3c63ed184d9

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Lotus::Controller
 Complete, fast and testable actions for Rack
 
+## 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`.
+
+### Fixed
+- [Steve Hodgkiss] Ensure params to return coerced values
+
 ## v0.3.0 - 2014-12-23
 ### Added
 - [Luca Guidi] Introduced `Action#request_id` as unique identifier for an incoming HTTP request

data/README.md

@@ -1023,33 +1023,6 @@ Articles::Create.new.call({})
   # => raises ArgumentError because we set handle_exceptions to false
 ```
 
-### Reusability
-
-Lotus::Controller can be used as a singleton framework as seen in this README.
-The application code includes `Lotus::Controller` or `Lotus::Action` directly
-and the configuration is unique per Ruby process.
-
-While this is convenient for tiny applications, it doesn't fit well for more
-complex scenarios, where we want micro applications to coexist together.
-
-```ruby
-require 'lotus/controller'
-
-module WebApp
-  Controller = Lotus::Controller.duplicate
-end
-
-module ApiApp
-  Controller = Lotus::Controller.duplicate(self) do
-    handle_exception ArgumentError => 400
-  end
-end
-```
-
-The code above defines `WebApp::Controller` and `WebApp::Action`, to be used for
-the `WebApp` endpoints, while `ApiApp::Controller` and `ApiApp::Action` have
-a different configuration.
-
 ### Thread safety
 
 An Action is **mutable**. When used without Lotus::Router, be sure to instantiate an

data/lib/lotus/action/flash.rb

@@ -90,7 +90,7 @@ module Lotus
       # @since 0.3.0
       # @api private
       def flash
-        @session[SESSION_KEY]
+        @session[SESSION_KEY] || {}
       end
 
       # The flash registry that holds the data **only for** the current request
@@ -100,7 +100,7 @@ module Lotus
       # @since 0.3.0
       # @api private
       def data
-        flash[@request_id]
+        flash[@request_id] || {}
       end
 
       # Expire the stale data from the previous request.

data/lib/lotus/action/params.rb

@@ -1,5 +1,5 @@
-require 'lotus/utils/hash'
 require 'lotus/validations'
+require 'lotus/utils/attributes'
 require 'set'
 
 module Lotus
@@ -87,6 +87,10 @@ module Lotus
 
       include Lotus::Validations
 
+      def self.whitelisting?
+        defined_attributes.any?
+      end
+
       # @attr_reader env [Hash] the Rack env
       #
       # @since 0.2.0
@@ -103,12 +107,7 @@ module Lotus
       def initialize(env)
         @env = env
         super(_compute_params)
-        freeze
-      end
-
-      def self.defined_attributes
-        result = super
-        return result if result.to_ary.any?
+        # freeze
       end
 
       # Returns the object associated with the given key
@@ -133,13 +132,19 @@ module Lotus
       alias_method :to_hash, :to_h
 
       private
+      # @since 0.3.1
+      # @api private
       def _compute_params
-        Utils::Hash.new(
-          _extract
-        ).symbolize!
+        if self.class.whitelisting?
+          _whitelisted_params
+        else
+          @attributes = Utils::Attributes.new(_params)
+        end
       end
 
-      def _extract
+      # @since 0.3.1
+      # @api private
+      def _params
         {}.tap do |result|
           if env.has_key?(RACK_INPUT)
             result.merge! ::Rack::Request.new(env).params
@@ -149,6 +154,18 @@ module Lotus
           end
         end
       end
+
+      # @since 0.3.1
+      # @api private
+      def _whitelisted_params
+        {}.tap do |result|
+          _params.each do |k, v|
+            next unless self.class.defined_attributes.include?(k.to_s)
+
+            result[k] = v
+          end
+        end
+      end
     end
   end
 end

data/lib/lotus/action/rack.rb

@@ -1,4 +1,5 @@
 require 'securerandom'
+require 'lotus/action/request'
 
 module Lotus
   module Action
@@ -142,6 +143,27 @@ module Lotus
         @request_id ||= SecureRandom.hex(DEFAULT_REQUEST_ID_LENGTH)
       end
 
+      # Returns a Lotus specialized rack request
+      #
+      # @return [Lotus::Action::Request] The request
+      #
+      # @since 0.3.1
+      #
+      # @example
+      #   require 'lotus/controller'
+      #
+      #   class Create
+      #     include Lotus::Action
+      #
+      #     def call(params)
+      #       ip     = request.ip
+      #       secure = request.ssl?
+      #     end
+      #   end
+      def request
+        @request ||= ::Lotus::Action::Request.new(@_env)
+      end
+
       private
 
       # Sets the HTTP status code for the response

data/lib/lotus/action/request.rb

@@ -0,0 +1,86 @@
+require 'rack/request'
+
+module Lotus
+  module Action
+    # An HTTP request based on top of Rack::Request.
+    # This guarantees backwards compatibility with with Rack.
+    #
+    # @since 0.3.1
+    #
+    # @see http://www.rubydoc.info/gems/rack/Rack/Request
+    class Request < ::Rack::Request
+
+      # @raise [NotImplementedError]
+      #
+      # @since 0.3.1
+      # @api private
+      def content_type
+        raise NotImplementedError, 'Please use Action#content_type'
+      end
+
+      # @raise [NotImplementedError]
+      #
+      # @since 0.3.1
+      # @api private
+      def session
+        raise NotImplementedError, 'Please include Action::Session and use Action#session'
+      end
+
+      # @raise [NotImplementedError]
+      #
+      # @since 0.3.1
+      # @api private
+      def cookies
+        raise NotImplementedError, 'Please include Action::Cookies and use Action#cookies'
+      end
+
+      # @raise [NotImplementedError]
+      #
+      # @since 0.3.1
+      # @api private
+      def params
+        raise NotImplementedError, 'Please use params passed to Action#call'
+      end
+
+      # @raise [NotImplementedError]
+      #
+      # @since 0.3.1
+      # @api private
+      def update_param(*)
+        raise NotImplementedError, 'Please use params passed to Action#call'
+      end
+
+      # @raise [NotImplementedError]
+      #
+      # @since 0.3.1
+      # @api private
+      def delete_param(*)
+        raise NotImplementedError, 'Please use params passed to Action#call'
+      end
+
+      # @raise [NotImplementedError]
+      #
+      # @since 0.3.1
+      # @api private
+      def [](*)
+        raise NotImplementedError, 'Please use params passed to Action#call'
+      end
+
+      # @raise [NotImplementedError]
+      #
+      # @since 0.3.1
+      # @api private
+      def []=(*)
+        raise NotImplementedError, 'Please use params passed to Action#call'
+      end
+
+      # @raise [NotImplementedError]
+      #
+      # @since 0.3.1
+      # @api private
+      def values_at(*)
+        raise NotImplementedError, 'Please use params passed to Action#call'
+      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.3.0'.freeze
+    VERSION = '0.3.1'.freeze
   end
 end

data/lotus-controller.gemspec

@@ -6,8 +6,8 @@ require 'lotus/controller/version'
 Gem::Specification.new do |spec|
   spec.name          = 'lotus-controller'
   spec.version       = Lotus::Controller::VERSION
-  spec.authors       = ['Luca Guidi']
-  spec.email         = ['me@lucaguidi.com']
+  spec.authors       = ['Luca Guidi', 'Trung Lê']
+  spec.email         = ['me@lucaguidi.com', 'trung.le@ruby-journal.com']
   spec.description   = %q{Complete, fast and testable actions for Rack}
   spec.summary       = %q{Complete, fast and testable actions for Rack and Lotus}
   spec.homepage      = 'http://lotusrb.org'
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   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.1'
+  spec.add_dependency 'lotus-validations', '~> 0.2', '>= 0.2.2'
 
   spec.add_development_dependency 'bundler',   '~> 1.6'
   spec.add_development_dependency 'minitest',  '~> 5'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lotus-controller
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Luca Guidi
+- Trung Lê
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-23 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -53,7 +54,7 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +64,7 @@ dependencies:
         version: '0.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +124,7 @@ dependencies:
 description: Complete, fast and testable actions for Rack
 email:
 - me@lucaguidi.com
+- trung.le@ruby-journal.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -149,6 +151,7 @@ files:
 - lib/lotus/action/params.rb
 - lib/lotus/action/rack.rb
 - lib/lotus/action/redirect.rb
+- lib/lotus/action/request.rb
 - lib/lotus/action/session.rb
 - lib/lotus/action/throwable.rb
 - lib/lotus/action/validatable.rb
@@ -178,7 +181,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