hanami-controller 0.0.0 → 0.6.0

data/hanami-controller.gemspec

@@ -4,20 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hanami/controller/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "hanami-controller"
+  spec.name          = 'hanami-controller'
   spec.version       = Hanami::Controller::VERSION
-  spec.authors       = ["Luca Guidi"]
-  spec.email         = ["me@lucaguidi.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 Hanami}
+  spec.homepage      = 'http://hanamirb.org'
+  spec.license       = 'MIT'
 
-  spec.summary       = %q{The web, with simplicity}
-  spec.description   = %q{Hanami is a web framework for Ruby}
-  spec.homepage      = "http://hanamirb.org"
+  spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md hanami-controller.gemspec`.split($/)
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.add_dependency 'rack',               '~> 1.6', '>= 1.6.2'
+  spec.add_dependency 'hanami-utils',       '~> 0.7'
+  spec.add_dependency 'hanami-validations', '~> 0.5'
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler',   '~> 1.6'
+  spec.add_development_dependency 'minitest',  '~> 5'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+  spec.add_development_dependency 'rake',      '~> 10'
 end

data/lib/hanami-controller.rb

@@ -0,0 +1 @@
+require 'hanami/controller'

data/lib/hanami/action.rb

@@ -0,0 +1,85 @@
+require 'hanami/action/configurable'
+require 'hanami/action/rack'
+require 'hanami/action/mime'
+require 'hanami/action/redirect'
+require 'hanami/action/exposable'
+require 'hanami/action/throwable'
+require 'hanami/action/callbacks'
+require 'hanami/action/validatable'
+require 'hanami/action/head'
+require 'hanami/action/callable'
+
+module Hanami
+  # An HTTP endpoint
+  #
+  # @since 0.1.0
+  #
+  # @example
+  #   require 'hanami/controller'
+  #
+  #   class Show
+  #     include Hanami::Action
+  #
+  #     def call(params)
+  #       # ...
+  #     end
+  #   end
+  module Action
+    # 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
+    #
+    # @see Hanami::Action::Rack
+    # @see Hanami::Action::Mime
+    # @see Hanami::Action::Http
+    # @see Hanami::Action::Redirect
+    # @see Hanami::Action::Exposable
+    # @see Hanami::Action::Throwable
+    # @see Hanami::Action::Callbacks
+    # @see Hanami::Action::Validatable
+    # @see Hanami::Action::Configurable
+    # @see Hanami::Action::Callable
+    def self.included(base)
+      base.class_eval do
+        include Rack
+        include Mime
+        include Redirect
+        include Exposable
+        include Throwable
+        include Callbacks
+        include Validatable
+        include Configurable
+        include Head
+        prepend Callable
+      end
+    end
+
+    private
+
+    # Finalize the response
+    #
+    # This method is abstract and COULD be implemented by included modules in
+    # order to prepare their data before the reponse will be returned to the
+    # webserver.
+    #
+    # @since 0.1.0
+    # @api private
+    # @abstract
+    #
+    # @see Hanami::Action::Mime#finish
+    # @see Hanami::Action::Exposable#finish
+    # @see Hanami::Action::Callable#finish
+    # @see Hanami::Action::Session#finish
+    # @see Hanami::Action::Cookies#finish
+    # @see Hanami::Action::Cache#finish
+    # @see Hanami::Action::Head#finish
+    def finish
+    end
+  end
+end

data/lib/hanami/action/cache.rb

@@ -0,0 +1,174 @@
+require 'hanami/action/cache/cache_control'
+require 'hanami/action/cache/expires'
+require 'hanami/action/cache/conditional_get'
+
+module Hanami
+  module Action
+    # Cache type API
+    #
+    # @since 0.3.0
+    #
+    # @see Hanami::Action::Cache::ClassMethods#cache_control
+    # @see Hanami::Action::Cache::ClassMethods#expires
+    # @see Hanami::Action::Cache::ClassMethods#fresh
+    module Cache
+      # Override Ruby's hook for modules.
+      # It includes exposures logic
+      #
+      # @param base [Class] the target action
+      #
+      # @since 0.3.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
+          include CacheControl, Expires
+        end
+      end
+
+      protected
+
+      # Specify response freshness policy for HTTP caches (Cache-Control header).
+      # Any number of non-value directives (:public, :private, :no_cache,
+      # :no_store, :must_revalidate, :proxy_revalidate) may be passed along with
+      # a Hash of value directives (:max_age, :min_stale, :s_max_age).
+      #
+      # See RFC 2616 / 14.9 for more on standard cache control directives:
+      # http://tools.ietf.org/html/rfc2616#section-14.9.1
+      #
+      # @param values [Array<Symbols, Hash>] mapped to cache_control directives
+      # @option values [Symbol] :public
+      # @option values [Symbol] :private
+      # @option values [Symbol] :no_cache
+      # @option values [Symbol] :no_store
+      # @option values [Symbol] :must_validate
+      # @option values [Symbol] :proxy_revalidate
+      # @option values [Hash] :max_age
+      # @option values [Hash] :min_stale
+      # @option values [Hash] :s_max_age
+      #
+      # @return void
+      #
+      # @since 0.3.0
+      # @api public
+      #
+      # @example
+      #   require 'hanami/controller'
+      #   require 'hanami/action/cache'
+      #
+      #   class Show
+      #     include Hanami::Action
+      #     include Hanami::Action::Cache
+      #
+      #     def call(params)
+      #       # ...
+      #
+      #       # set Cache-Control directives
+      #       cache_control :public, max_age: 900, s_maxage: 86400
+      #
+      #       # overwrite previous Cache-Control directives
+      #       cache_control :private, :no_cache, :no_store
+      #
+      #       => Cache-Control: private, no-store, max-age=900
+      #
+      #     end
+      #   end
+      #
+      def cache_control(*values)
+        cache_control = CacheControl::Directives.new(*values)
+        headers.merge!(cache_control.headers)
+      end
+
+      # Set the Expires header and Cache-Control/max-age directive. Amount
+      # can be an integer number of seconds in the future or a Time object
+      # indicating when the response should be considered "stale". The remaining
+      # "values" arguments are passed to the #cache_control helper:
+      #
+      # @param amount [Integer,Time] number of seconds or point in time
+      # @param values [Array<Symbols>] mapped to cache_control directives
+      #
+      # @return void
+      #
+      # @since 0.3.0
+      # @api public
+      #
+      # @example
+      #   require 'hanami/controller'
+      #   require 'hanami/action/cache'
+      #
+      #   class Show
+      #     include Hanami::Action
+      #     include Hanami::Action::Cache
+      #
+      #     def call(params)
+      #       # ...
+      #
+      #       # set Cache-Control directives and Expires
+      #       expires 900, :public
+      #
+      #       # overwrite Cache-Control directives and Expires
+      #       expires 300, :private, :no_cache, :no_store
+      #
+      #       => Expires: Thu, 26 Jun 2014 12:00:00 GMT
+      #       => Cache-Control: private, no-cache, no-store max-age=300
+      #
+      #     end
+      #   end
+      #
+      def expires(amount, *values)
+        expires = Expires::Directives.new(amount, *values)
+        headers.merge!(expires.headers)
+      end
+
+      # Set the etag, last_modified, or both headers on the response
+      # and halts a 304 Not Modified if the request is still fresh
+      # respecting IfNoneMatch and IfModifiedSince request headers
+      #
+      # @param options [Hash]
+      # @option options [Integer] :etag for testing IfNoneMatch conditions
+      # @option options [Date] :last_modified for testing IfModifiedSince conditions
+      #
+      # @return void
+      #
+      # @since 0.3.0
+      # @api public
+      #
+      # @example
+      #   require 'hanami/controller'
+      #   require 'hanami/action/cache'
+      #
+      #   class Show
+      #     include Hanami::Action
+      #     include Hanami::Action::Cache
+      #
+      #     def call(params)
+      #       # ...
+      #
+      #       # set etag response header and halt 304
+      #       # if request matches IF_NONE_MATCH header
+      #       fresh etag: @resource.updated_at.to_i
+      #
+      #       # set last_modified response header and halt 304
+      #       # if request matches IF_MODIFIED_SINCE
+      #       fresh last_modified: @resource.updated_at
+      #
+      #       # set etag and last_modified response header,
+      #       # halt 304 if request matches IF_MODIFIED_SINCE
+      #       # and IF_NONE_MATCH
+      #       fresh last_modified: @resource.updated_at
+      #
+      #     end
+      #   end
+      def fresh(options)
+        conditional_get = ConditionalGet.new(@_env, options)
+
+        headers.merge!(conditional_get.headers)
+
+        conditional_get.fresh? do
+          halt 304
+        end
+      end
+    end
+  end
+end

data/lib/hanami/action/cache/cache_control.rb

@@ -0,0 +1,70 @@
+require 'hanami/action/cache/directives'
+
+module Hanami
+  module Action
+    module Cache
+
+      # Module with Cache-Control logic
+      #
+      # @since 0.3.0
+      # @api private
+      module CacheControl
+
+        # The HTTP header for Cache-Control
+        #
+        # @since 0.3.0
+        # @api private
+        HEADER = 'Cache-Control'.freeze
+
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          def cache_control(*values)
+            @cache_control_directives ||= Directives.new(*values)
+          end
+
+          def cache_control_directives
+            @cache_control_directives || Object.new.tap do |null_object|
+              def null_object.headers
+                Hash.new
+              end
+            end
+          end
+        end
+
+        # Finalize the response including default cache headers into the response
+        #
+        # @since 0.3.0
+        # @api private
+        #
+        # @see Hanami::Action#finish
+        def finish
+          super
+          headers.merge!(self.class.cache_control_directives.headers) unless headers.include? HEADER
+        end
+
+        # Class which stores CacheControl values
+        #
+        # @since 0.3.0
+        #
+        # @api private
+        #
+        class Directives
+          def initialize(*values)
+            @directives = Hanami::Action::Cache::Directives.new(*values)
+          end
+
+          def headers
+            if @directives.any?
+              { HEADER => @directives.join(', ') }
+            else
+              {}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/action/cache/conditional_get.rb

@@ -0,0 +1,93 @@
+module Hanami
+  module Action
+    module Cache
+      # @since 0.3.0
+      # @api private
+      IF_NONE_MATCH = 'HTTP_IF_NONE_MATCH'.freeze
+
+      # The HTTP header for ETag
+      #
+      # @since 0.3.0
+      # @api private
+      ETAG          = 'ETag'.freeze
+
+      # @since 0.3.0
+      # @api private
+      IF_MODIFIED_SINCE = 'HTTP_IF_MODIFIED_SINCE'.freeze
+
+      # The HTTP header for Last-Modified
+      #
+      # @since 0.3.0
+      # @api private
+      LAST_MODIFIED = 'Last-Modified'.freeze
+
+      # ETag value object
+      #
+      # @since 0.3.0
+      # @api private
+      #
+      class ETag
+        def initialize(env, value)
+          @env, @value = env, value
+        end
+
+        def fresh?
+          none_match && @value == none_match
+        end
+
+        def header
+          { ETAG => @value } if none_match
+        end
+
+        private
+
+        def none_match
+          @env[IF_NONE_MATCH]
+        end
+      end
+
+      # LastModified value object
+      #
+      # @since 0.3.0
+      # @api private
+      class LastModified
+        def initialize(env, value)
+          @env, @value = env, value
+        end
+
+        def fresh?
+          modified_since && Time.httpdate(modified_since).to_i >= @value.to_i
+        end
+
+        def header
+          { LAST_MODIFIED => @value.httpdate } if modified_since
+        end
+
+        private
+
+        def modified_since
+          @env[IF_MODIFIED_SINCE]
+        end
+      end
+
+      # Class responsible to determine if a given request is fresh
+      # based on IF_NONE_MATCH and IF_MODIFIED_SINCE headers
+      #
+      # @since 0.3.0
+      # @api private
+      class ConditionalGet
+        def initialize(env, options)
+          @validations = [ ETag.new(env, options[:etag]), LastModified.new(env, options[:last_modified]) ]
+        end
+
+        def fresh?
+          yield if @validations.any?(&:fresh?)
+        end
+
+        def headers
+          @validations.map(&:header).compact.reduce Hash.new, :merge
+        end
+      end
+    end
+  end
+end