lotus-controller 0.0.0 → 0.1.0

data/lib/lotus/action/session.rb

@@ -0,0 +1,48 @@
+module Lotus
+  module Action
+    # Session API
+    #
+    # This module isn't included by default.
+    #
+    # @since 0.1.0
+    module Session
+      # The key that returns raw session from the Rack env
+      #
+      # @since 0.1.0
+      SESSION_KEY = 'rack.session'.freeze
+
+      protected
+
+      # Gets the session from the request and expose it as an Hash.
+      #
+      # @return [Hash] the HTTP session from the request
+      #
+      # @since 0.1.0
+      #
+      # @example
+      #   require 'lotus/controller'
+      #   require 'lotus/action/session'
+      #
+      #   class Show
+      #     include Lotus::Action
+      #     include Lotus::Action::Session
+      #
+      #     def call(params)
+      #       # ...
+      #
+      #       # get a value
+      #       session[:user_id] # => '23'
+      #
+      #       # set a value
+      #       session[:foo] = 'bar'
+      #
+      #       # remove a value
+      #       session[:bax] = nil
+      #     end
+      #   end
+      def session
+        @_env[SESSION_KEY] ||= {}
+      end
+    end
+  end
+end

data/lib/lotus/action/throwable.rb

@@ -0,0 +1,130 @@
+require 'lotus/utils/class_attribute'
+require 'lotus/http/status'
+
+module Lotus
+  module Action
+    # Throw API
+    #
+    # @since 0.1.0
+    #
+    # @see Lotus::Action::Throwable::ClassMethods#handle_exception
+    # @see Lotus::Action::Throwable#throw
+    # @see Lotus::Action::Throwable#status
+    module Throwable
+      def self.included(base)
+        base.class_eval do
+          extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+        def self.extended(base)
+          base.class_eval do
+            include Utils::ClassAttribute
+
+            # Action handled exceptions.
+            #
+            # When an handled exception is raised during #call execution, it will be
+            # translated into the associated HTTP status.
+            #
+            # By default there aren't handled exceptions, all the errors are threaded
+            # as a Server Side Error (500).
+            #
+            # @api private
+            # @since 0.1.0
+            #
+            # @see Lotus::Controller.handled_exceptions
+            # @see Lotus::Action::Throwable.handle_exception
+            class_attribute :handled_exceptions
+            self.handled_exceptions = Controller.handled_exceptions.dup
+          end
+        end
+
+        protected
+
+        # Handle the given exception with an HTTP status code.
+        #
+        # When the exception is raise during #call execution, it will be
+        # translated into the associated HTTP status.
+        #
+        # This is a fine grained control, for a global configuration see
+        # Lotus::Action.handled_exceptions
+        #
+        # @param exception [Class] the exception class
+        # @param status [Fixmun] a valid HTTP status
+        #
+        # @since 0.1.0
+        #
+        # @see Lotus::Action.handled_exceptions
+        #
+        # @example
+        #   require 'lotus/controller'
+        #
+        #   class Show
+        #     include Lotus::Action
+        #     handle_exception RecordNotFound, 404
+        #
+        #     def call(params)
+        #       # ...
+        #       raise RecordNotFound.new
+        #     end
+        #   end
+        #
+        #   Show.new.call({id: 1}) # => [404, {}, ['Not Found']]
+        def handle_exception(exception, status)
+          self.handled_exceptions[exception] = status
+        end
+      end
+
+      protected
+
+      # Throw the given HTTP status code.
+      #
+      # When used, the execution of a callback or of an action is interrupted
+      # and the control returns to the framework, that decides how to handle
+      # the event.
+      #
+      # It also sets the response body with the message associated to the code
+      # (eg 404 will set `"Not Found"`).
+      #
+      # @param code [Fixnum] a valid HTTP status code
+      #
+      # @since 0.1.0
+      #
+      # @see Lotus::Controller#handled_exceptions
+      # @see Lotus::Action::Throwable#handle_exception
+      # @see Lotus::Http::Status:ALL
+      def throw(code)
+        status(*Http::Status.for_code(code))
+        super :halt
+      end
+
+      # Sets the given code and message for the response
+      #
+      # @param code [Fixnum] a valid HTTP status code
+      # @param message [String] the response body
+      #
+      # @since 0.1.0
+      # @see Lotus::Http::Status:ALL
+      def status(code, message)
+        self.status = code
+        self.body   = message
+      end
+
+      private
+      def _rescue
+        catch :halt do
+          begin
+            yield
+          rescue => exception
+            _handle_exception(exception)
+          end
+        end
+      end
+
+      def _handle_exception(exception)
+        throw self.class.handled_exceptions.fetch(exception.class, 500)
+      end
+    end
+  end
+end

data/lib/lotus/controller.rb

@@ -1,7 +1,70 @@
-require "lotus/controller/version"
+require 'lotus/utils/class_attribute'
+require 'lotus/action'
+require 'lotus/controller/dsl'
+require 'lotus/controller/version'
+require 'rack-patch'
 
 module Lotus
+  # A set of logically grouped actions
+  #
+  # @since 0.1.0
+  #
+  # @see Lotus::Action
+  #
+  # @example
+  #   require 'lotus/controller'
+  #
+  #   class ArticlesController
+  #     include Lotus::Controller
+  #
+  #     action 'Index' do
+  #       # ...
+  #     end
+  #
+  #     action 'Show' do
+  #       # ...
+  #     end
+  #   end
   module Controller
-    # Your code goes here...
+    include Utils::ClassAttribute
+
+    # Global handled exceptions.
+    # When an handled exception is raised during #call execution, it will be
+    # translated into the associated HTTP status.
+    #
+    # By default there aren't handled exceptions, all the errors are threaded
+    # as a Server Side Error (500).
+    #
+    # **Important:** Be sure to set this configuration, **before** the actions
+    # and controllers of your application are loaded.
+    #
+    # @since 0.1.0
+    #
+    # @see Lotus::Action::Throwable
+    #
+    # @example
+    #   require 'lotus/controller'
+    #
+    #   Lotus::Controller.handled_exceptions = { RecordNotFound => 404 }
+    #
+    #   class Show
+    #     include Lotus::Action
+    #
+    #     def call(params)
+    #       # ...
+    #       raise RecordNotFound.new
+    #     end
+    #   end
+    #
+    #   Show.new.call({id: 1}) # => [404, {}, ['Not Found']]
+    class_attribute :handled_exceptions
+    self.handled_exceptions = {}
+
+    def self.included(base)
+      base.class_eval do
+        include Dsl
+      end
+    end
   end
 end
+

data/lib/lotus/controller/dsl.rb

@@ -0,0 +1,54 @@
+module Lotus
+  module Controller
+    # Public DSL
+    #
+    # @since 0.1.0
+    module Dsl
+      def self.included(base)
+        base.class_eval do
+          extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+        # Define an action for the given name.
+        # It generates a concrete class for the action, for this reason the name
+        # MUST be a valid name for Ruby.
+        #
+        # @param name [String] the name of the action
+        # @param blk [Proc] the code of the action
+        #
+        # @raise TypeError when the name isn't a valid Ruby name
+        #
+        # @since 0.1.0
+        #
+        # @example
+        #   require 'lotus/controller'
+        #
+        #   class ArticlesController
+        #     include Lotus::Controller
+        #
+        #     action 'Index' do
+        #       def call(params)
+        #         # ...
+        #       end
+        #     end
+        #
+        #     action 'Show' do
+        #       def call(params)
+        #         # ...
+        #       end
+        #     end
+        #   end
+        def action(name, &blk)
+          const_set(name, Class.new)
+
+          const_get(name).tap do |klass|
+            klass.class_eval { include ::Lotus::Action }
+            klass.class_eval(&blk)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lotus/controller/version.rb

@@ -1,5 +1,8 @@
 module Lotus
   module Controller
-    VERSION = "0.0.0"
+    # Defines the version
+    #
+    # @since 0.1.0
+    VERSION = '0.1.0'
   end
 end

data/lib/lotus/http/status.rb

@@ -0,0 +1,103 @@
+module Lotus
+  module Http
+    # An HTTP status
+    #
+    # @since 0.1.0
+    # @api private
+    class Status
+      # A set of standard codes and messages for HTTP statuses
+      #
+      # @since 0.1.0
+      # @api private
+      ALL = {
+        100 => 'Continue',
+        101 => 'Switching Protocols',
+        102 => 'Processing (WebDAV) (RFC 2518)',
+        103 => 'Checkpoint',
+        122 => 'Request-URI too long',
+        200 => 'OK',
+        201 => 'Created',
+        202 => 'Accepted',
+        203 => 'Non-Authoritative Information',
+        204 => 'No Content',
+        205 => 'Reset Content',
+        206 => 'Partial Content',
+        207 => 'Multi-Status (WebDAV) (RFC 4918)',
+        208 => 'Already Reported (WebDAV) (RFC 5842)',
+        226 => 'IM Used (RFC 3229)',
+        300 => 'Multiple Choices',
+        301 => 'Moved Permanently',
+        302 => 'Found',
+        303 => 'See Other',
+        304 => 'Not Modified',
+        305 => 'Use Proxy',
+        306 => 'Switch Proxy',
+        307 => 'Temporary Redirect',
+        308 => 'Resume Incomplete',
+        400 => 'Bad Request',
+        401 => 'Unauthorized',
+        402 => 'Payment Required',
+        403 => 'Forbidden',
+        404 => 'Not Found',
+        405 => 'Method Not Allowed',
+        406 => 'Not Acceptable',
+        407 => 'Proxy Authentication Required',
+        408 => 'Request Timeout',
+        409 => 'Conflict',
+        410 => 'Gone',
+        411 => 'Length Required',
+        412 => 'Precondition Failed',
+        413 => 'Request Entity Too Large',
+        414 => 'Request-URI Too Long',
+        415 => 'Unsupported Media Type',
+        416 => 'Requested Range Not Satisfiable',
+        417 => 'Expectation Failed',
+        418 => 'I\'m a teapot (RFC 2324)',
+        420 => 'Enhance Your Calm',
+        422 => 'Unprocessable Entity (WebDAV) (RFC 4918)',
+        423 => 'Locked (WebDAV) (RFC 4918)',
+        424 => 'Failed Dependency (WebDAV) (RFC 4918)',
+        426 => 'Upgrade Required (RFC 2817)',
+        428 => 'Precondition Required',
+        429 => 'Too Many Requests',
+        431 => 'Request Header Fields Too Large',
+        444 => 'No Response',
+        449 => 'Retry With',
+        450 => 'Blocked by Windows Parental Controls',
+        451 => 'Wrong Exchange server',
+        499 => 'Client Closed Request',
+        500 => 'Internal Server Error',
+        501 => 'Not Implemented',
+        502 => 'Bad Gateway',
+        503 => 'Service Unavailable',
+        504 => 'Gateway Timeout',
+        505 => 'HTTP Version Not Supported',
+        506 => 'Variant Also Negotiates (RFC 2295)',
+        507 => 'Insufficient Storage (WebDAV) (RFC 4918)',
+        508 => 'Loop Detected (WebDAV) (RFC 5842)',
+        509 => 'Bandwidth Limit Exceeded (Apache bw\/limited extension)',
+        510 => 'Not Extended (RFC 2774)',
+        511 => 'Network Authentication Required',
+        598 => 'Network read timeout error',
+        599 => 'Network connect timeout error'
+      }.freeze
+
+      # Return a status for the given code
+      #
+      # @param code [Fixnum] a valid HTTP code
+      #
+      # @return [Array] a pair of code and message for an HTTP status
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @example
+      #   require 'lotus/http/status'
+      #
+      #   Lotus::Http::Status.for_code(418) # => [418, "I'm a teapot (RFC 2324)"]
+      def self.for_code(code)
+        ALL.assoc(code)
+      end
+    end
+  end
+end

data/lib/rack-patch.rb

@@ -0,0 +1,20 @@
+# see https://github.com/rack/rack/pull/659
+require 'rack'
+
+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.map do |req_mime, quality|
+        match = available_mimes.find { |am| Rack::Mime.match?(am, req_mime) }
+        next unless match
+        [match, quality]
+      end.compact.sort_by do |match, quality|
+        (match.split('/', 2).count('*') * -10) + quality
+      end.last.first
+    end
+  end
+end

data/lotus-controller.gemspec

@@ -4,20 +4,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lotus/controller/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "lotus-controller"
+  spec.name          = 'lotus-controller'
   spec.version       = Lotus::Controller::VERSION
-  spec.authors       = ["Luca Guidi"]
-  spec.email         = ["me@lucaguidi.com"]
-  spec.summary       = %q{Controller layer for Lotus}
+  spec.authors       = ['Luca Guidi']
+  spec.email         = ['me@lucaguidi.com']
   spec.description   = %q{Controller layer for Lotus}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.summary       = %q{Controller layer for Lotus, compatible with Rack}
+  spec.homepage      = 'http://lotusrb.org'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_dependency 'rack',        '~> 1.5'
+  spec.add_dependency 'lotus-utils', '~> 0.1'
+
+  spec.add_development_dependency 'bundler',   '~> 1.5'
+  spec.add_development_dependency 'minitest',  '~> 5'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+  spec.add_development_dependency 'rake',      '~> 10'
 end