lotus-controller 0.4.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cac7b8bf14852940993b526910f912f4c8a84398
-  data.tar.gz: 0d1987258f25f24b2e3b797441e557d76e704184
+  metadata.gz: b2ff1fea9be3ce5d7e3cb2fd0555efbf3928d0f7
+  data.tar.gz: a7eac7e0477f45078bf77172a9c179aa712be57a
 SHA512:
-  metadata.gz: 17ef726ad1e57674ef8215aa9cb1aa4277f8ef29518d89e893f66dc8a631e7f9387f118f77d6dcacfdbc8ff8595e46798455ef6d2175ca12a6a365b33396b2e5
-  data.tar.gz: 4acdfbe61468ee74824894b1c060b8068a612c619acfab62c283284214e17c694a43c3c940ae46d3c17548ffbc2c98d48740a04b6396f1407467afc37ff7c2c7
+  metadata.gz: eaab2895b510bedd269fc9bb9147c50af9e742b7a99041a22bb35a767e9bd195955f377ecd8ba2e0c7452ae4776e7aba213d8f3bbfa230f8af21361658869632
+  data.tar.gz: b25f2829ca7b31440d2e768231d9ba2c5a88a85aa09c71ffe44cadcff7c396d35cab2a7387b0a04db4aacf62bcb6a9be9a4f36759f3ca47f577c3447df695a9a

data/CHANGELOG.md

@@ -1,9 +1,22 @@
 # Lotus::Controller
 Complete, fast and testable actions for Rack
 
+## v0.5.0 - 2016-01-12
+### Added
+- [Luca Guidi] Reference a raised exception in Rack env's `rack.exception`. Compatibility with exception reporting SaaS.
+
+### Fixed
+- [Cainã Costa] Ensure Rack environment to be always available for sessions unit tests
+- [Luca Guidi] Ensure superclass exceptions to not shadow subclasses during exception handling (eg. `CustomError` handler will take precedence over `StandardError`)
+
+### Changed
+- [Luca Guidi] Removed `Lotus::Controller::Configuration#default_format`
+- [Cainã Costa] Made `Lotus::Action#session` a public method for improved unit testing
+- [Karim Tarek] Introduced `Lotus::Controller::Error` and let all the framework exceptions to inherit from it.
+
 ## v0.4.6 - 2015-12-04
 ### Added
-- [Luca Guidi] Allow to force custom headers for responses that shouldn't include them (eg 204). Override `#keep_response_header?(header)` in action
+- [Luca Guidi] Allow to force custom headers for responses that according to RFC shouldn't include them (eg 204). Override `#keep_response_header?(header)` in action
 
 ## v0.4.5 - 2015-09-30
 ### Added

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014-2015 Luca Guidi
+Copyright © 2014-2016 Luca Guidi
 
 MIT License
 

data/README.md

@@ -921,6 +921,37 @@ action.call({ 'HTTP_ACCEPT' => '*/*' }) # => Content-Type 'application/custom'
 action.format                           # => :custom
 ```
 
+### Streamed Responses
+
+When the work to be done by the server takes time, it may be a good idea to stream your response. Here's an example of a streamed CSV.
+
+```ruby
+Lotus::Controller.configure do
+  format csv: 'text/csv'
+  middleware.use ::Rack::Chunked
+end
+
+class Csv
+  include Lotus::Action
+
+  def call(params)
+    self.format = :csv
+    self.body = Enumerator.new do |yielder|
+      yielder << csv_header
+      
+      # Expensive operation is streamed as each line becomes available
+      csv_body.each_line do |line|
+        yielder << line
+      end
+    end
+  end
+end
+```
+
+Note: 
+* In development, Lotus' code reloading needs to be disabled for streaming to work. This is because `Shotgun` interferes with the streaming action. You can disable it like this `lotus server --code-reloading=false`
+* Streaming does not work with WEBrick as it buffers its response. We recommend using `puma`, though you may find success with other servers
+
 ### No rendering, please
 
 Lotus::Controller is designed to be a pure HTTP endpoint, rendering belongs to other layers of MVC.
@@ -1131,7 +1162,9 @@ Articles::Create.new.call({})
 ### Thread safety
 
 An Action is **mutable**. When used without Lotus::Router, be sure to instantiate an
-action for each request.
+action for each request. The same advice applies when using
+Lotus::Router but NOT routing to `mycontroller#myaction` but instead
+routing direct to a class.
 
 ```ruby
 # config.ru
@@ -1169,4 +1202,4 @@ __Lotus::Controller__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2015 Luca Guidi – Released under MIT License
+Copyright © 2014-2016 Luca Guidi – Released under MIT License

data/lib/lotus/action/head.rb

@@ -77,7 +77,7 @@ module Lotus
       # It returns a <tt>204</tt> but still wants to specify the rate limit
       # quota via <tt>X-Rate-Limit</tt>.
       #
-      # @since x.x.x
+      # @since 0.5.0
       # @api public
       #
       # @see Lotus::Action::HEAD#finish

data/lib/lotus/action/mime.rb

@@ -473,12 +473,17 @@ module Lotus
           [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?
+        if Lotus::Utils.jruby?
+          # See https://github.com/lotus/controller/issues/59
+          # See https://github.com/lotus/controller/issues/104
+          values.reverse!
+        else
+          # See https://github.com/jruby/jruby/issues/3004
+          values.sort!
+        end
 
-        value  = values.sort_by do |match, quality|
-          (match.split('/', 2).count('*') * -10) + quality
+        value = values.sort_by do |match, quality|
+          (match.split('/'.freeze, 2).count('*'.freeze) * -10) + quality
         end.last
 
         value.first if value

data/lib/lotus/action/session.rb

@@ -30,8 +30,6 @@ module Lotus
         end
       end
 
-      protected
-
       # Gets the session from the request and expose it as an Hash.
       #
       # @return [Hash] the HTTP session from the request

data/lib/lotus/action/throwable.rb

@@ -15,6 +15,19 @@ module Lotus
       # @api private
       RACK_ERRORS = 'rack.errors'.freeze
 
+      # This isn't part of Rack SPEC
+      #
+      # Exception notifiers use <tt>rack.exception</tt> instead of
+      # <tt>rack.errors</tt>, so we need to support it.
+      #
+      # @since 0.5.0
+      # @api private
+      #
+      # @see Lotus::Action::Throwable::RACK_ERRORS
+      # @see http://www.rubydoc.info/github/rack/rack/file/SPEC#The_Error_Stream
+      # @see https://github.com/lotus/controller/issues/133
+      RACK_EXCEPTION = 'rack.exception'.freeze
+
       def self.included(base)
         base.extend ClassMethods
       end
@@ -140,6 +153,8 @@ module Lotus
       def _reference_in_rack_errors(exception)
         return if configuration.handled_exception?(exception)
 
+        @_env[RACK_EXCEPTION] = exception
+
         if errors = @_env[RACK_ERRORS]
           errors.write(_dump_exception(exception))
           errors.flush

data/lib/lotus/controller.rb

@@ -2,6 +2,7 @@ require 'lotus/utils/class_attribute'
 require 'lotus/action'
 require 'lotus/controller/configuration'
 require 'lotus/controller/version'
+require 'lotus/controller/error'
 
 module Lotus
   # A set of logically grouped actions
@@ -35,7 +36,7 @@ module Lotus
     # @since 0.2.0
     #
     # @see Lotus::Action::Mime#format=
-    class UnknownFormatError < ::StandardError
+    class UnknownFormatError < Lotus::Controller::Error
       def initialize(format)
         super("Cannot find a corresponding Mime type for '#{ format }'. Please configure it with Lotus::Controller::Configuration#format.")
       end

data/lib/lotus/controller/configuration.rb

@@ -180,6 +180,7 @@ module Lotus
       #   end
       def handle_exception(exception)
         @handled_exceptions.merge!(exception)
+        _sort_handled_exceptions!
       end
 
       # Return a callable handler for the given exception
@@ -450,17 +451,6 @@ module Lotus
         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
@@ -693,6 +683,13 @@ module Lotus
       end
 
       protected
+      # @since 0.5.0
+      # @api private
+      def _sort_handled_exceptions!
+        @handled_exceptions = Hash[
+          @handled_exceptions.sort{|(ex1,_),(ex2,_)| ex1.ancestors.include?(ex2) ? -1 : 1 }
+        ]
+      end
 
       attr_accessor :handled_exceptions
       attr_accessor :formats

data/lib/lotus/controller/error.rb

@@ -0,0 +1,7 @@
+module Lotus
+  module Controller
+    # @since 0.5.0
+    class Error < ::StandardError
+    end
+  end
+end

data/lib/lotus/controller/version.rb

@@ -3,6 +3,6 @@ module Lotus
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.4.6'.freeze
+    VERSION = '0.5.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.6', '>= 1.6.2'
-  spec.add_dependency 'lotus-utils',       '~> 0.5'
-  spec.add_dependency 'lotus-validations', '~> 0.3', '>= 0.3.3'
+  spec.add_dependency 'lotus-utils',       '~> 0.6'
+  spec.add_dependency 'lotus-validations', '~> 0.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.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-04 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -38,34 +38,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: lotus-validations
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.3
+        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.3
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +156,7 @@ files:
 - lib/lotus/action/validatable.rb
 - lib/lotus/controller.rb
 - lib/lotus/controller/configuration.rb
+- lib/lotus/controller/error.rb
 - lib/lotus/controller/version.rb
 - lib/lotus/http/status.rb
 - lotus-controller.gemspec
@@ -185,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Complete, fast and testable actions for Rack and Lotus