lotus-controller 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b692a62b7c7775da832e5f7367ef67c50a279e1f
-  data.tar.gz: f24b0ee003fb32a6f063d2e243c1e6eed2c68e83
+  metadata.gz: 04ae3ccf09d545e91ee49d06a52dd18ea196871f
+  data.tar.gz: 645e47bc4dacb1147cf01007668bd73ece973169
 SHA512:
-  metadata.gz: 381a491ce463d8051437e9f186b0181141a135d2eed5d259b0ba54f7abb1cb9f28672ebe7e71553ba553be5ce40982955a60699c38f4510ae07376a99c189eb9
-  data.tar.gz: 4d23ef2177b9dac081083d51c1bdf2a01b6b6620a752167612e4b7e20bcbb59200592c18d46d981892298d5c7a776590b92d0840b78a8301eb92a56e95d21614
+  metadata.gz: cc76f8ea93416a106fb491bdd3168df82722386b85306eabdf73fca31fa20dff7c38f38ebb317b8393f849a54ec56a3c08e774780691a92289bcf2848af70487
+  data.tar.gz: 923df9fa385da1b3358ebfc46ed386665e6f3f0814f901a39b960603e32dfead3f1f04e90fcf323d56f9401cbbd2e236d52bd5a3ef1a4d1f61f2659322502090

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Lotus::Controller
 Complete, fast and testable actions for Rack
 
+## v0.4.5 - 2015-09-30
+### Added
+- [Theo Felippe] Added configuration entries: `#default_request_format` and `default_response_format`.
+- [Wellington Santos] Error handling to take account of inherited exceptions.
+
+### Changed
+- [Theo Felippe] Deprecated `#default_format` in favor of: `#default_request_format`.
+
 ## v0.4.4 - 2015-06-23
 ### Added
 - [Luca Guidi] Security protection against Cross Site Request Forgery (CSRF).

data/README.md

@@ -432,6 +432,51 @@ action = Articles::Show.new
 action.call({id: 'unknown'}) # => raises RecordNotFound
 ```
 
+#### Inherited Exceptions
+
+```ruby
+class MyCustomException < StandardError
+end
+
+module Articles
+  class Index
+    include Lotus::Action
+
+    handle_exception MyCustomException => :handle_my_exception
+
+    def call(params)
+      raise MyCustomException
+    end
+
+    private
+
+    def handle_my_exception
+      # ...
+    end
+  end
+
+  class Show
+    include Lotus::Action
+
+    handle_exception StandardError => :handle_standard_error
+
+    def call(params)
+      raise MyCustomException
+    end
+
+    private
+
+    def handle_standard_error
+      # ...
+    end
+  end
+end
+
+Articles::Index.new.call({}) # => `handle_my_exception` will be invoked
+Articles::Show.new.call({})  # => `handle_standard_error` will be invoked,
+                             #   because `MyCustomException` inherits from `StandardError`
+```
+
 ### Throwable HTTP statuses
 
 When `#halt` is used with a valid HTTP code, it stops the execution and sets the proper status and body for the response:
@@ -754,7 +799,7 @@ action = Create.new
 action.call({ article: { title: 'Hello' }}) # => [301, {'Location' => '/articles/23'}, '']
 ```
 
-### Mime Types
+### MIME Types
 
 `Lotus::Action` automatically sets the `Content-Type` header, according to the request.
 
@@ -796,7 +841,7 @@ action.call({ 'HTTP_ACCEPT' => 'text/html' }) # Content-Type "application/json"
 action.format                                 # :json
 ```
 
-You can restrict the accepted mime types:
+You can restrict the accepted MIME types:
 
 ```ruby
 class Show
@@ -814,7 +859,7 @@ end
 # When called with "application/xml"  => 406
 ```
 
-You can check if the requested mime type is accepted by the client.
+You can check if the requested MIME type is accepted by the client.
 
 ```ruby
 class Show
@@ -841,7 +886,7 @@ class Show
 end
 ```
 
-Lotus::Controller is shipped with an extensive list of the most common mime types.
+Lotus::Controller is shipped with an extensive list of the most common MIME types.
 Also, you can register your own:
 
 ```ruby
@@ -1002,16 +1047,23 @@ Lotus::Controller.configure do
   #
   handle_exception ArgumentError => 404
 
-  # Register a format to mime type mapping
-  # Argument: hash, key: format symbol, value: mime type string, empty by default
+  # Register a format to MIME type mapping
+  # Argument: hash, key: format symbol, value: MIME type string, empty by default
   #
   format custom: 'application/custom'
 
-  # Define a default format to return in case of HTTP request with `Accept: */*`
+  # Define a fallback format to detect in case of HTTP request with `Accept: */*`
+  # If not defined here, it will return Rack's default: `application/octet-stream`
+  # Argument: symbol, it should be already known. defaults to `nil`
+  #
+  default_request_format :html
+
+  # Define a default format to set as `Content-Type` header for response,
+  # unless otherwise specified.
   # If not defined here, it will return Rack's default: `application/octet-stream`
   # Argument: symbol, it should be already known. defaults to `nil`
   #
-  default_format :html
+  default_response_format :html
 
   # Define a default charset to return in the `Content-Type` response header
   # If not defined here, it returns `utf-8`

data/lib/lotus/action/cookie_jar.rb

@@ -28,6 +28,10 @@ module Lotus
       # @api private
       COOKIE_STRING_KEY = 'rack.request.cookie_string'.freeze
 
+      # @since 0.4.5
+      # @api private
+      COOKIE_SEPARATOR = ';,'.freeze
+
       # Initialize the CookieJar
       #
       # @param env [Hash] a raw Rack env
@@ -128,7 +132,7 @@ module Lotus
         string = env[HTTP_HEADER]
 
         return hash if string == env[COOKIE_STRING_KEY]
-        # TODO Next Rack 1.6.x version will have ::Rack::Utils.parse_cookies
+        # TODO Next Rack 1.7.x ?? version will have ::Rack::Utils.parse_cookies
         # We can then replace the following lines.
         hash.clear
 
@@ -137,7 +141,7 @@ module Lotus
         #   the Cookie header such that those with more specific Path attributes
         #   precede those with less specific.  Ordering with respect to other
         #   attributes (e.g., Domain) is unspecified.
-        cookies = ::Rack::Utils.parse_query(string, ';,') { |s| ::Rack::Utils.unescape(s) rescue s }
+        cookies = ::Rack::Utils.parse_query(string, COOKIE_SEPARATOR) { |s| ::Rack::Utils.unescape(s) rescue s }
         cookies.each { |k,v| hash[k] = Array === v ? v.first : v }
         env[COOKIE_STRING_KEY] = string
         hash

data/lib/lotus/action/mime.rb

@@ -1,6 +1,7 @@
 require 'rack/utils'
 require 'lotus/utils'
 require 'lotus/utils/kernel'
+require 'lotus/utils/deprecation'
 
 module Lotus
   module Action
@@ -169,7 +170,7 @@ module Lotus
       # @since 0.1.0
       #
       # @see Lotus::Action::Mime#format=
-      # @see Lotus::Configuration#default_format
+      # @see Lotus::Configuration#default_request_format
       # @see Lotus::Action::Mime#default_content_type
       # @see Lotus::Action::Mime#DEFAULT_CONTENT_TYPE
       #
@@ -185,7 +186,7 @@ module Lotus
       #     end
       #   end
       def content_type
-        @content_type || accepts || default_content_type || DEFAULT_CONTENT_TYPE
+        @content_type || default_response_type || accepts || default_content_type || DEFAULT_CONTENT_TYPE
       end
 
       # Action charset setter, receives new charset value
@@ -421,12 +422,18 @@ module Lotus
         end
       end
 
+      # @since 0.5.0
+      # @api private
+      def default_response_type
+        self.class.format_to_mime_type(configuration.default_response_format) if configuration.default_response_format
+      end
+
       # @since 0.2.0
       # @api private
       def default_content_type
         self.class.format_to_mime_type(
-          configuration.default_format
-        ) if configuration.default_format
+          configuration.default_request_format
+        ) if configuration.default_request_format
       end
 
       # @since 0.2.0

data/lib/lotus/controller/configuration.rb

@@ -191,7 +191,16 @@ module Lotus
       #
       # @see Lotus::Controller::Configuration#handle_exception
       def exception_handler(exception)
-        @handled_exceptions.fetch(exception.class) { DEFAULT_ERROR_CODE }
+        handler = nil
+
+        @handled_exceptions.each do |exception_class, h|
+          if exception.kind_of?(exception_class)
+            handler = h
+            break
+          end
+        end
+
+        handler || DEFAULT_ERROR_CODE
       end
 
       # Check if the given exception is handled.
@@ -409,35 +418,90 @@ module Lotus
       # an argument, it will set the corresponding instance variable. When
       # called without, it will return the already set value, or the default.
       #
-      # @overload default_format(format)
+      # @overload default_request_format(format)
       #   Sets the given value
       #   @param format [#to_sym] the symbol format
       #   @raise [TypeError] if it cannot be coerced to a symbol
       #
-      # @overload default_format
+      # @overload default_request_format
       #   Gets the value
       #   @return [Symbol,nil]
       #
-      # @since 0.2.0
+      # @since 0.5.0
       #
       # @see Lotus::Action::Mime
       #
       # @example Getting the value
       #   require 'lotus/controller'
       #
-      #   Lotus::Controller.configuration.default_format # => nil
+      #   Lotus::Controller.configuration.default_request_format # => nil
       #
       # @example Setting the value
       #   require 'lotus/controller'
       #
       #   Lotus::Controller.configure do
-      #     default_format :html
+      #     default_request_format :html
       #   end
+      def default_request_format(format = nil)
+        if format
+          @default_request_format = Utils::Kernel.Symbol(format)
+        else
+          @default_request_format
+        end
+      end
+
+      # Set a format as default fallback for all the requests without a strict
+      # requirement for the mime type.
+      #
+      # @since 0.2.0
+      #
+      # @deprecated Use {#default_request_format} instead.
       def default_format(format = nil)
+        Lotus::Utils::Deprecation.new('default_format is deprecated, please use default_request_format')
+        default_request_format(format)
+      end
+
+      # Set a format to be used for all responses regardless of the request type.
+      #
+      # The given format must be coercible to a symbol, and be a valid mime type
+      # alias. If it isn't, at the runtime the framework will raise a
+      # `Lotus::Controller::UnknownFormatError`.
+      #
+      # By default this value is nil.
+      #
+      # This is part of a DSL, for this reason when this method is called with
+      # an argument, it will set the corresponding instance variable. When
+      # called without, it will return the already set value, or the default.
+      #
+      # @overload default_response_format(format)
+      #   Sets the given value
+      #   @param format [#to_sym] the symbol format
+      #   @raise [TypeError] if it cannot be coerced to a symbol
+      #
+      # @overload default_response_format
+      #   Gets the value
+      #   @return [Symbol,nil]
+      #
+      # @since 0.5.0
+      #
+      # @see Lotus::Action::Mime
+      #
+      # @example Getting the value
+      #   require 'lotus/controller'
+      #
+      #   Lotus::Controller.configuration.default_response_format # => nil
+      #
+      # @example Setting the value
+      #   require 'lotus/controller'
+      #
+      #   Lotus::Controller.configure do
+      #     default_response_format :json
+      #   end
+      def default_response_format(format = nil)
         if format
-          @default_format = Utils::Kernel.Symbol(format)
+          @default_response_format = Utils::Kernel.Symbol(format)
         else
-          @default_format
+          @default_response_format
         end
       end
 
@@ -569,7 +633,8 @@ module Lotus
           c.action_module           = action_module
           c.modules                 = modules.dup
           c.formats                 = formats.dup
-          c.default_format          = default_format
+          c.default_request_format  = default_request_format
+          c.default_response_format = default_response_format
           c.default_charset         = default_charset
           c.default_headers         = default_headers.dup
           c.cookies = cookies.dup
@@ -591,15 +656,16 @@ module Lotus
       # @since 0.2.0
       # @api private
       def reset!
-        @handle_exceptions  = true
-        @handled_exceptions = {}
-        @modules            = []
-        @formats            = DEFAULT_FORMATS.dup
-        @default_format     = nil
-        @default_charset    = nil
-        @default_headers    = {}
-        @cookies            = {}
-        @action_module      = ::Lotus::Action
+        @handle_exceptions       = true
+        @handled_exceptions      = {}
+        @modules                 = []
+        @formats                 = DEFAULT_FORMATS.dup
+        @default_request_format  = nil
+        @default_response_format = nil
+        @default_charset         = nil
+        @default_headers         = {}
+        @cookies                 = {}
+        @action_module           = ::Lotus::Action
       end
 
       # Copy the configuration for the given action
@@ -632,7 +698,8 @@ module Lotus
       attr_accessor :formats
       attr_writer :action_module
       attr_writer :modules
-      attr_writer :default_format
+      attr_writer :default_request_format
+      attr_writer :default_response_format
       attr_writer :default_charset
       attr_writer :default_headers
       attr_writer :cookies

data/lib/lotus/controller/version.rb

@@ -3,6 +3,6 @@ module Lotus
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.4.4'.freeze
+    VERSION = '0.4.5'.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', 'Trung Lê']
-  spec.email         = ['me@lucaguidi.com', 'trung.le@ruby-journal.com']
+  spec.authors       = ['Luca Guidi', 'Trung Lê', 'Alfonso Uceda']
+  spec.email         = ['me@lucaguidi.com', 'trung.le@ruby-journal.com', 'uceda73@gmail.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'
@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'rack',              '~> 1.5'
+  spec.add_dependency 'rack',              '~> 1.6', '>= 1.6.2'
   spec.add_dependency 'lotus-utils',       '~> 0.5'
-  spec.add_dependency 'lotus-validations', '~> 0.3'
+  spec.add_dependency 'lotus-validations', '~> 0.3', '>= 0.3.3'
 
   spec.add_development_dependency 'bundler',   '~> 1.6'
   spec.add_development_dependency 'minitest',  '~> 5'

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: lotus-controller
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Luca Guidi
 - Trung Lê
+- Alfonso Uceda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -17,14 +18,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.2
 - !ruby/object:Gem::Dependency
   name: lotus-utils
   requirement: !ruby/object:Gem::Requirement
@@ -46,6 +53,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -53,6 +63,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -113,6 +126,7 @@ description: Complete, fast and testable actions for Rack
 email:
 - me@lucaguidi.com
 - trung.le@ruby-journal.com
+- uceda73@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -171,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Complete, fast and testable actions for Rack and Lotus