hanami-controller 1.3.3 → 2.0.0.alpha1

data/lib/hanami/action/exposable.rb

@@ -1,126 +0,0 @@
-require 'hanami/action/exposable/guard'
-
-module Hanami
-  module Action
-    # Exposures API
-    #
-    # @since 0.1.0
-    #
-    # @see Hanami::Action::Exposable::ClassMethods#expose
-    module Exposable
-      # Override Ruby's hook for modules.
-      # It includes exposures logic
-      #
-      # @param base [Class] the target action
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see http://www.ruby-doc.org/core-2.1.2/Module.html#method-i-included
-      def self.included(base)
-        base.class_eval do
-          extend ClassMethods
-          include Guard
-
-          _expose :params
-        end
-      end
-
-      # Exposures API class methods
-      #
-      # @since 0.1.0
-      # @api private
-      module ClassMethods
-        # Expose the given attributes on the outside of the object with
-        # a getter and a special method called #exposures.
-        #
-        # @param names [Array<Symbol>] the name(s) of the attribute(s) to be
-        #   exposed
-        #
-        # @return [void]
-        #
-        # @since 0.1.0
-        #
-        # @example
-        #   require 'hanami/controller'
-        #
-        #   class Show
-        #     include Hanami::Action
-        #
-        #     expose :article, :tags
-        #
-        #     def call(params)
-        #       @article = Article.find params[:id]
-        #       @tags    = Tag.for(article)
-        #     end
-        #   end
-        #
-        #   action = Show.new
-        #   action.call({id: 23})
-        #
-        #   action.article # => #<Article ...>
-        #   action.tags    # => [#<Tag ...>, #<Tag ...>]
-        #
-        #   action.exposures # => { :article => #<Article ...>, :tags => [ ... ] }
-        def expose(*names)
-          class_eval do
-            names.each do |name|
-              attr_reader(name) unless attr_reader?(name)
-            end
-
-            exposures.push(*names)
-          end
-        end
-
-        # Alias of #expose to be used in internal modules.
-        # #_expose is not watched by the Guard
-        alias _expose expose
-
-        # Set of exposures attribute names
-        #
-        # @return [Array] the exposures attribute names
-        #
-        # @since 0.1.0
-        # @api private
-        def exposures
-          @exposures ||= []
-        end
-
-        private
-        # Check if the attr_reader is already defined
-        #
-        # @since 0.3.0
-        # @api private
-        def attr_reader?(name)
-          (instance_methods | private_instance_methods).include?(name)
-        end
-      end
-
-      # Set of exposures
-      #
-      # @return [Hash] the exposures
-      #
-      # @since 0.1.0
-      #
-      # @see Hanami::Action::Exposable::ClassMethods.expose
-      def exposures
-        @exposures ||= {}.tap do |result|
-          self.class.exposures.each do |name|
-            result[name] = send(name)
-          end
-        end
-      end
-
-      # Finalize the response
-      #
-      # @since 0.3.0
-      # @api private
-      #
-      # @see Hanami::Action#finish
-      def finish
-        super
-        exposures
-      end
-    end
-  end
-end

data/lib/hanami/action/exposable/guard.rb

@@ -1,104 +0,0 @@
-require 'hanami/controller/error'
-
-module Hanami
-  module Controller
-    # Exposure of reserved words
-    #
-    # @since 0.7.1
-    class IllegalExposureError < Error
-    end
-  end
-
-  module Action
-    module Exposable
-      # Guard for Exposures API.
-      # Prevents exposure of reserved words
-      #
-      # @since 0.7.1
-      # @api private
-      #
-      # @see Hanami::Action::Exposable::Guard::ClassMethods#expose
-      # @see Hanami::Action::Exposable::Guard::ClassMethods#reserved_word?
-      module Guard
-        # Override Ruby's hook for modules.
-        # It prepends a guard for the exposures logic
-        #
-        # @param base [Class] the target action
-        #
-        # @since 0.7.1
-        # @api private
-        #
-        # @see http://www.ruby-doc.org/core-2.1.2/Module.html#method-i-included
-        def self.included(base)
-          class << base
-            prepend ClassMethods
-          end
-        end
-
-        # Exposures API Guard class methods
-        #
-        # @since 0.7.1
-        # @api private
-        module ClassMethods
-          # Prevents exposure if names contain a reserved word.
-          #
-          # @param names [Array<Symbol>] the name(s) of the attribute(s) to be
-          #   exposed
-          #
-          # @return [void]
-          #
-          # @since 0.7.1
-          # @api private
-          def expose(*names)
-            detect_reserved_words!(names)
-
-            super
-          end
-
-          private
-
-          # Raises error if given names  contain a reserved word.
-          #
-          # @param names [Array<Symbol>] a list of names to be checked.
-          #
-          # @return [void]
-          #
-          # @raise [IllegalExposeError] if names contain one or more of reserved
-          #   words
-          #
-          # @since 0.7.1
-          # @api private
-          def detect_reserved_words!(names)
-            names.each do |name|
-              if reserved_word?(name)
-                raise Hanami::Controller::IllegalExposureError.new("#{name} is a reserved word. It cannot be exposed")
-              end
-            end
-          end
-
-          # Checks if a string is a reserved word
-          #
-          # Reserved word is a name of the method defined in one of the modules
-          # of a given namespace.
-          #
-          # @param name [Symbol] the word to be checked
-          # @param namespace [String] the namespace containing internal modules
-          #
-          # @return [true, false]
-          #
-          # @since 0.7.1
-          # @api private
-          def reserved_word?(name, namespace = 'Hanami')
-            if method_defined?(name) || private_method_defined?(name)
-              method_owner = instance_method(name).owner
-
-              Utils::String.namespace(method_owner) == namespace
-            else
-              false
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hanami/action/head.rb

@@ -1,121 +0,0 @@
-module Hanami
-  module Action
-    # Ensures to not send body or headers for HEAD requests and/or for status
-    # codes that doesn't allow them.
-    #
-    # @since 0.3.2
-    #
-    # @see http://www.ietf.org/rfc/rfc2616.txt
-    module Head
-
-      # Status codes that by RFC must not include a message body
-      #
-      # @since 0.3.2
-      # @api private
-      HTTP_STATUSES_WITHOUT_BODY = Set.new((100..199).to_a << 204 << 205 << 304).freeze
-
-
-      # Entity headers allowed in blank body responses, according to
-      # RFC 2616 - Section 10 (HTTP 1.1).
-      #
-      # "The response MAY include new or updated metainformation in the form
-      #   of entity-headers".
-      #
-      # @since 0.4.0
-      # @api private
-      #
-      # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5
-      # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec7.html
-      ENTITY_HEADERS = {
-        'Allow'            => true,
-        'Content-Encoding' => true,
-        'Content-Language' => true,
-        'Content-Location' => true,
-        'Content-MD5'      => true,
-        'Content-Range'    => true,
-        'Expires'          => true,
-        'Last-Modified'    => true,
-        'extension-header' => true
-      }.freeze
-
-      # Ensures to not send body or headers for HEAD requests and/or for status
-      # codes that doesn't allow them.
-      #
-      # @since 0.3.2
-      # @api private
-      #
-      # @see Hanami::Action#finish
-      def finish
-        super
-
-        if _requires_no_body?
-          @_body = nil
-          @headers.reject! {|header,_| !keep_response_header?(header) }
-        end
-      end
-
-      protected
-      # @since 0.3.2
-      # @api private
-      def _requires_no_body?
-        HTTP_STATUSES_WITHOUT_BODY.include?(@_status) || head?
-      end
-
-      private
-      # According to RFC 2616, when a response MUST have an empty body, it only
-      # allows Entity Headers.
-      #
-      # For instance, a <tt>204</tt> doesn't allow <tt>Content-Type</tt> or any
-      # other custom header.
-      #
-      # This restriction is enforced by <tt>Hanami::Action::Head#finish</tt>.
-      #
-      # However, there are cases that demand to bypass this rule to set meta
-      # informations via headers.
-      #
-      # An example is a <tt>DELETE</tt> request for a JSON API application.
-      # It returns a <tt>204</tt> but still wants to specify the rate limit
-      # quota via <tt>X-Rate-Limit</tt>.
-      #
-      # @since 0.5.0
-      #
-      # @see Hanami::Action::HEAD#finish
-      #
-      # @example
-      #   require 'hanami/controller'
-      #
-      #   module Books
-      #     class Destroy
-      #       include Hanami::Action
-      #
-      #       def call(params)
-      #         # ...
-      #         self.headers.merge!(
-      #           'Last-Modified' => 'Fri, 27 Nov 2015 13:32:36 GMT',
-      #           'X-Rate-Limit'  => '4000',
-      #           'Content-Type'  => 'application/json',
-      #           'X-No-Pass'     => 'true'
-      #         )
-      #
-      #         self.status = 204
-      #       end
-      #
-      #       private
-      #
-      #       def keep_response_header?(header)
-      #         super || header == 'X-Rate-Limit'
-      #       end
-      #     end
-      #   end
-      #
-      #   # Only the following headers will be sent:
-      #   #  * Last-Modified - because we used `super' in the method that respects the HTTP RFC
-      #   #  * X-Rate-Limit  - because we explicitely allow it
-      #
-      #   # Both Content-Type and X-No-Pass are removed because they're not allowed
-      def keep_response_header?(header)
-        ENTITY_HEADERS.include?(header)
-      end
-    end
-  end
-end

data/lib/hanami/action/rack.rb

@@ -1,411 +0,0 @@
-require 'securerandom'
-require 'hanami/action/request'
-require 'hanami/action/base_params'
-require 'hanami/action/rack/callable'
-require 'hanami/action/rack/file'
-require 'hanami/utils/deprecation'
-
-module Hanami
-  module Action
-    # Rack integration API
-    #
-    # @since 0.1.0
-    module Rack
-      # Rack SPEC response code
-      #
-      # @since 1.0.0
-      # @api private
-      RESPONSE_CODE = 0
-
-      # Rack SPEC response headers
-      #
-      # @since 1.0.0
-      # @api private
-      RESPONSE_HEADERS = 1
-
-      # Rack SPEC response body
-      #
-      # @since 1.0.0
-      # @api private
-      RESPONSE_BODY = 2
-
-      # The default HTTP response code
-      #
-      # @since 0.1.0
-      # @api private
-      DEFAULT_RESPONSE_CODE = 200
-
-      # Not Found
-      #
-      # @since 1.0.0
-      # @api private
-      NOT_FOUND = 404
-
-      # The default Rack response body
-      #
-      # @since 0.1.0
-      # @api private
-      DEFAULT_RESPONSE_BODY = []
-
-      # The default HTTP Request ID length
-      #
-      # @since 0.3.0
-      # @api private
-      #
-      # @see Hanami::Action::Rack#request_id
-      DEFAULT_REQUEST_ID_LENGTH = 16
-
-      # The request method
-      #
-      # @since 0.3.2
-      # @api private
-      REQUEST_METHOD = 'REQUEST_METHOD'.freeze
-
-      # The Content-Length HTTP header
-      #
-      # @since 1.0.0
-      # @api private
-      CONTENT_LENGTH = 'Content-Length'.freeze
-
-      # The non-standard HTTP header to pass the control over when a resource
-      # cannot be found by the current endpoint
-      #
-      # @since 1.0.0
-      # @api private
-      X_CASCADE = 'X-Cascade'.freeze
-
-      # HEAD request
-      #
-      # @since 0.3.2
-      # @api private
-      HEAD = 'HEAD'.freeze
-
-      # The key that returns router parsed body from the Rack env
-      ROUTER_PARSED_BODY = 'router.parsed_body'.freeze
-
-      # This is the root directory for `#unsafe_send_file`
-      #
-      # @since 1.3.3
-      # @api private
-      #
-      # @see #unsafe_send_file
-      FILE_SYSTEM_ROOT = Pathname.new("/").freeze
-
-      # Override Ruby's hook for modules.
-      # It includes basic Hanami::Action modules to the given class.
-      #
-      # @param base [Class] the target action
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see http://www.ruby-doc.org/core-2.1.2/Module.html#method-i-included
-      def self.included(base)
-        base.class_eval do
-          extend ClassMethods
-          prepend InstanceMethods
-        end
-      end
-
-      # @api private
-      module ClassMethods
-        # Build rack builder
-        #
-        # @return [Rack::Builder]
-        # @api private
-        def rack_builder
-          @rack_builder ||= begin
-            extend Hanami::Action::Rack::Callable
-            rack_builder = ::Rack::Builder.new
-            rack_builder.run ->(env) { self.new.call(env) }
-            rack_builder
-          end
-        end
-
-        # Use a Rack middleware
-        #
-        # The middleware will be used as it is.
-        #
-        # At the runtime, the middleware be invoked with the raw Rack env.
-        #
-        # Multiple middlewares can be employed, just by using multiple times
-        # this method.
-        #
-        # @param middleware [#call] A Rack middleware
-        # @param args [Array] Array arguments for middleware
-        #
-        # @since 0.2.0
-        #
-        # @see Hanami::Action::Callbacks::ClassMethods#before
-        #
-        # @example Middleware
-        #   require 'hanami/controller'
-        #
-        #   module Sessions
-        #     class Create
-        #       include Hanami::Action
-        #       use OmniAuth
-        #
-        #       def call(params)
-        #         # ...
-        #       end
-        #     end
-        #   end
-        def use(middleware, *args, &block)
-          rack_builder.use middleware, *args, &block
-        end
-
-        # Returns the class which defines the params
-        #
-        # Returns the class which has been provided to define the
-        # params. By default this will be Hanami::Action::Params.
-        #
-        # @return [Class] A params class (when whitelisted) or
-        #   Hanami::Action::Params
-        #
-        # @api private
-        # @since 0.7.0
-        def params_class
-          @params_class ||= BaseParams
-        end
-      end
-
-      # @since 0.7.0
-      # @api private
-      module InstanceMethods
-        # @since 0.7.0
-        # @api private
-        def initialize(*)
-          super
-          @_status = nil
-          @_body   = nil
-        end
-      end
-
-      protected
-      # Gets the headers from the response
-      #
-      # @return [Hash] the HTTP headers from the response
-      #
-      # @since 0.1.0
-      #
-      # @example
-      #   require 'hanami/controller'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #
-      #     def call(params)
-      #       # ...
-      #       self.headers            # => { ... }
-      #       self.headers.merge!({'X-Custom' => 'OK'})
-      #     end
-      #   end
-      def headers
-        @headers
-      end
-
-      # Returns a serialized Rack response (Array), according to the current
-      #   status code, headers, and body.
-      #
-      # @return [Array] the serialized response
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see Hanami::Action::Rack::DEFAULT_RESPONSE_CODE
-      # @see Hanami::Action::Rack::DEFAULT_RESPONSE_BODY
-      # @see Hanami::Action::Rack#status=
-      # @see Hanami::Action::Rack#headers
-      # @see Hanami::Action::Rack#body=
-      def response
-        [ @_status || DEFAULT_RESPONSE_CODE, headers, @_body || DEFAULT_RESPONSE_BODY.dup ]
-      end
-
-      # Calculates an unique ID for the current request
-      #
-      # @return [String] The unique ID
-      #
-      # @since 0.3.0
-      def request_id
-        # FIXME make this number configurable and document the probabilities of clashes
-        @request_id ||= SecureRandom.hex(DEFAULT_REQUEST_ID_LENGTH)
-      end
-
-      # Returns a Hanami specialized rack request
-      #
-      # @return [Hanami::Action::Request] The request
-      #
-      # @since 0.3.1
-      #
-      # @example
-      #   require 'hanami/controller'
-      #
-      #   class Create
-      #     include Hanami::Action
-      #
-      #     def call(params)
-      #       ip     = request.ip
-      #       secure = request.ssl?
-      #     end
-      #   end
-      def request
-        @request ||= ::Hanami::Action::Request.new(@_env)
-      end
-
-      # Return parsed request body
-      #
-      # @deprecated
-      def parsed_request_body
-        Hanami::Utils::Deprecation.new('#parsed_request_body is deprecated and it will be removed in future versions')
-        @_env.fetch(ROUTER_PARSED_BODY, nil)
-      end
-
-      private
-
-      # Sets the HTTP status code for the response
-      #
-      # @param status [Fixnum] an HTTP status code
-      # @return [void]
-      #
-      # @since 0.1.0
-      #
-      # @example
-      #   require 'hanami/controller'
-      #
-      #   class Create
-      #     include Hanami::Action
-      #
-      #     def call(params)
-      #       # ...
-      #       self.status = 201
-      #     end
-      #   end
-      def status=(status)
-        @_status = status
-      end
-
-      # Sets the body of the response
-      #
-      # @param body [String] the body of the response
-      # @return [void]
-      #
-      # @since 0.1.0
-      #
-      # @example
-      #   require 'hanami/controller'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #
-      #     def call(params)
-      #       # ...
-      #       self.body = 'Hi!'
-      #     end
-      #   end
-      def body=(body)
-        body   = Array(body) unless body.respond_to?(:each)
-        @_body = body
-      end
-
-      # Send a file as response.
-      #  <tt>This method only sends files from the public directory</tt>
-      #
-      # It automatically handle the following cases:
-      #
-      #   * <tt>Content-Type</tt> and <tt>Content-Length</tt>
-      #   * File Not found (returns a 404)
-      #   * Conditional GET (via <tt>If-Modified-Since</tt> header)
-      #   * Range requests (via <tt>Range</tt> header)
-      #
-      # @param path [String, Pathname] the body of the response
-      # @return [void]
-      #
-      # @since 0.4.3
-      #
-      # @example
-      #   require 'hanami/controller'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #
-      #     def call(params)
-      #       # ...
-      #       send_file Pathname.new('path/to/file')
-      #     end
-      #   end
-      def send_file(path)
-        _send_file(
-          File.new(path, self.class.configuration.public_directory).call(@_env)
-        )
-      end
-
-      # Send a file as response from anywhere in the file system.
-      #
-      # @see Hanami::Action::Rack#send_file
-      #
-      # @param path [String, Pathname] path to the file to be sent
-      # @return [void]
-      #
-      # @since 1.0.0
-      #
-      # @example
-      #   require 'hanami/controller'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #
-      #     def call(params)
-      #       # ...
-      #       unsafe_send_file Pathname.new('/tmp/path/to/file')
-      #     end
-      #   end
-      def unsafe_send_file(path)
-        directory = if Pathname.new(path).relative?
-                      self.class.configuration.root_directory
-                    else
-                      FILE_SYSTEM_ROOT
-                    end
-
-        _send_file(
-          File.new(path, directory).call(@_env)
-        )
-      end
-
-      # Check if the current request is a HEAD
-      #
-      # @return [TrueClass,FalseClass] the result of the check
-      #
-      # @since 0.3.2
-      def head?
-        request_method == HEAD
-      end
-
-      # NOTE: <tt>Hanami::Action::CSRFProtection</tt> (<tt>hanamirb</tt> gem) depends on this.
-      #
-      # @api private
-      # @since 0.4.4
-      def request_method
-        @_env[REQUEST_METHOD]
-      end
-
-      # @since 1.0.0
-      # @api private
-      def _send_file(response)
-        headers.merge!(response[RESPONSE_HEADERS])
-
-        if response[RESPONSE_CODE] == NOT_FOUND
-          headers.delete(X_CASCADE)
-          headers.delete(CONTENT_LENGTH)
-          halt NOT_FOUND
-        else
-          # FIXME: this is a fix for https://github.com/hanami/controller/issues/240
-          # It's here to maintain the backward compat with 1.1, as we can't remove `#halt`
-          # We should review the workflow for 2.0, because I don't like callbacks to be referenced from here.
-          _run_after_callbacks(params)
-          halt response[RESPONSE_CODE], response[RESPONSE_BODY]
-        end
-      end
-    end
-  end
-end