hanami-router 2.0.0.rc1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc0a68636ae47869944fc0c76f262c420356d3fbf10bd12b270692f48d3ea7bb
-  data.tar.gz: cb653be9037e33f02a05bcbf2048109d64e561afafaa03c8ed353b4b3183d672
+  metadata.gz: d211b5c2f94d5e609ae9de76707c3740d387771f0864fab1d8a04f1f81942663
+  data.tar.gz: 354ce7d52713736379e88271b84e930b6b203299a355e9568c64572380286efe
 SHA512:
-  metadata.gz: 4e50ba3c0279d9c26a1ef882127ef7d02ca39cb5ebab25589799ab7190e4562a40e57d0dcbcfe285b1e9dc7ab312dedc0ebf2553d4da3afc921821a8d23cc233
-  data.tar.gz: b6f390eb1750d6e596bb1064573467fbd8d5ceccb3bbf0e34a8ab021dd1162d4fc88a8edee4d36a221d053a8ee3d656114004ac6ebbb9b87fc43636bd8715004
+  metadata.gz: e8ef3013b9ec171da3eeef8ee92564cc55ad010c62a2133a386325c31ee2501331a92808b37503671d4b75b8d0a8d5eb38ce0bac7b24099bffea689f14cc51e0
+  data.tar.gz: bdf66d398a5e1f32b279ffb22cb4ba6719b2565631880a18e4e2d82469b293930b0f29265d483495d7b7c23dfe4b842aa0cadb34a083d32bad945a2bfc4e8100

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 Rack compatible HTTP router for Ruby
 
+## v2.0.1 - 2022-12-06
+
+### Added
+
+- [Armin, Luca Guidi] Introduce `Hanami::Middleware::BodyParser::FormParser` to parse multipart file upload
+
+### Fixed
+
+- [Luca Guidi] Return HTTP response header `Allow` when returning `405` HTTP status
+
+## v2.0.0 - 2022-11-22
+
+### Fixed
+
+- [Luca Guidi] Don't parse request body when Body Parser already parsed it
+
 ## v2.0.0.rc1 - 2022-11-08
 
 ### Fixed

data/README.md

@@ -331,22 +331,22 @@ curl http://localhost:2300/authors/1 \
 require "hanami/router"
 
 router = Hanami::Router.new do
-  get "/books/:id", to: "books#show", as: :book
+  get "/books/:id", to: "books.show", as: :book
 end
 
 route = router.recognize("/books/23")
 route.verb      # "GET"
-route.action    # => "books#show"
+route.endpoint  # => "books.show"
 route.params    # => {:id=>"23"}
 route.routable? # => true
 
 route = router.recognize(:book, id: 23)
 route.verb      # "GET"
-route.action    # => "books#show"
+route.endpoint  # => "books.show"
 route.params    # => {:id=>"23"}
 route.routable? # => true
 
-route = router.recognize("/books/23", method: :post)
+route = router.recognize("/books/23", {}, method: :post)
 route.verb      # "POST"
 route.routable? # => false
 ```

data/hanami-router.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 3.0"
 
   spec.add_dependency "rack",               "~> 2.0"
-  spec.add_dependency "mustermann",         "~> 1.0"
-  spec.add_dependency "mustermann-contrib", "~> 1.0"
+  spec.add_dependency "mustermann",         "~> 3.0"
+  spec.add_dependency "mustermann-contrib", "~> 3.0"
 
   spec.add_development_dependency "bundler",   ">= 1.6", "< 3"
   spec.add_development_dependency "rake",      "~> 13"

data/lib/hanami/middleware/body_parser/form_parser.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "parser"
+require "rack/multipart"
+
+module Hanami
+  module Middleware
+    class BodyParser
+      # @since 2.0.1
+      # @api private
+      class FormParser < Parser
+        # @since 2.0.1
+        # @api private
+        MIME_TYPES = [
+          "multipart/form-data"
+        ].freeze
+
+        # @since 2.0.1
+        # @api private
+        def self.mime_types
+          MIME_TYPES
+        end
+
+        # Parse a multipart body payload (form file uploading)
+        #
+        # @param body [String] a multipart body
+        #
+        # @return [Hash] the parsed multipart body
+        #
+        # @raise [Hanami::Middleware::BodyParser::BodyParsingError] when the body can't be parsed.
+        #
+        # @since 2.0.1
+        # @api private
+        def parse(*, env)
+          ::Rack::Multipart.parse_multipart(env)
+        rescue StandardError => exception
+          raise BodyParsingError.new(exception.message)
+        end
+      end
+    end
+  end
+end

data/lib/hanami/middleware/body_parser/json_parser.rb

@@ -25,7 +25,7 @@ module Hanami
         #
         # @since 1.3.0
         # @api private
-        def parse(body)
+        def parse(body, *)
           JSON.parse(body)
         rescue StandardError => exception
           raise BodyParsingError.new(exception.message)

data/lib/hanami/middleware/body_parser/parser.rb

@@ -34,6 +34,7 @@ module Hanami
         # Parse raw HTTP request body
         #
         # @param body [String] HTTP request body
+        # @param env [Hash] Rack env
         #
         # @return [Hash] the result of the parsing
         #
@@ -54,7 +55,7 @@ module Hanami
         #       raise Hanami::Middleware::BodyParser::BodyParsingError.new(exception.message)
         #     end
         #   end
-        def parse(body) # rubocop:disable Lint/UnusedMethodArgument
+        def parse(body, env = {}) # rubocop:disable Lint/UnusedMethodArgument
           raise NoMethodError
         end
       end

data/lib/hanami/middleware/body_parser.rb

@@ -2,6 +2,7 @@
 
 require "hanami/router/params"
 require "hanami/middleware/error"
+require_relative "../router/constants"
 
 module Hanami
   module Middleware
@@ -27,9 +28,6 @@ module Hanami
       # @api private
       ROUTER_PARAMS = "router.params"
 
-      # @api private
-      ROUTER_PARSED_BODY = "router.parsed_body"
-
       # @api private
       FALLBACK_KEY = "_"
 
@@ -47,8 +45,8 @@ module Hanami
         env[RACK_INPUT].rewind # somebody might try to read this stream
 
         if (parser = @parsers[media_type(env)])
-          env[ROUTER_PARSED_BODY] = parser.parse(body)
-          env[ROUTER_PARAMS] = _symbolize(env[ROUTER_PARSED_BODY])
+          env[Router::ROUTER_PARSED_BODY] = parser.parse(body, env)
+          env[ROUTER_PARAMS] = _symbolize(env[Router::ROUTER_PARSED_BODY])
         end
 
         @app.call(env)

data/lib/hanami/router/constants.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Hanami
+  class Router
+    # @api private
+    # @since 2.0.0
+    ROUTER_PARSED_BODY = "router.parsed_body"
+  end
+end

data/lib/hanami/router/version.rb

@@ -6,7 +6,8 @@ module Hanami
     #
     # @return [String]
     #
+    # @since 0.1.0
     # @api public
-    VERSION = "2.0.0.rc1"
+    VERSION = "2.0.1"
   end
 end

data/lib/hanami/router.rb

@@ -10,6 +10,7 @@ module Hanami
   # @since 0.1.0
   class Router
     require "hanami/router/version"
+    require "hanami/router/constants"
     require "hanami/router/errors"
     require "hanami/router/segment"
     require "hanami/router/redirect"
@@ -651,10 +652,15 @@ module Hanami
     # @since 2.0.0
     # @api private
     def not_allowed(env)
-      (_not_allowed_fixed(env) ||
-      _not_allowed_variable(env)) and return [HTTP_STATUS_NOT_ALLOWED,
-                                              {::Rack::CONTENT_LENGTH => HTTP_BODY_NOT_ALLOWED_LENGTH},
-                                              [HTTP_BODY_NOT_ALLOWED]]
+      http_methods = _not_allowed_fixed(env) || _not_allowed_variable(env)
+      return if http_methods.nil?
+
+      [HTTP_STATUS_NOT_ALLOWED,
+       {
+         ::Rack::CONTENT_LENGTH => HTTP_BODY_NOT_ALLOWED_LENGTH,
+         "Allow" => http_methods.join(", ")
+       },
+       [HTTP_BODY_NOT_ALLOWED]]
     end
 
     # @since 2.0.0
@@ -919,7 +925,7 @@ module Hanami
       params ||= {}
       env[PARAMS] ||= {}
 
-      if (input = env[::Rack::RACK_INPUT]) and input.rewind
+      if !env.key?(ROUTER_PARSED_BODY) && (input = env[::Rack::RACK_INPUT]) and input.rewind
         env[PARAMS].merge!(::Rack::Utils.parse_nested_query(input.read))
         input.rewind
       end
@@ -933,28 +939,32 @@ module Hanami
     # @since 2.0.0
     # @api private
     def _not_allowed_fixed(env)
-      found = false
+      found = []
 
-      @fixed.each_value do |routes|
-        break if found
+      @fixed.each do |http_method, routes|
+        next if routes.fetch(env[::Rack::PATH_INFO], nil).nil?
 
-        found = routes.key?(env[::Rack::PATH_INFO])
+        found << http_method
       end
 
+      return nil if found.empty?
+
       found
     end
 
     # @since 2.0.0
     # @api private
     def _not_allowed_variable(env)
-      found = false
+      found = []
 
-      @variable.each_value do |routes|
-        break if found
+      @variable.each do |http_method, routes|
+        next if routes.find(env[::Rack::PATH_INFO]).nil?
 
-        found = routes.find(env[::Rack::PATH_INFO])
+        found << http_method
       end
 
+      return nil if found.empty?
+
       found
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-router
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-08 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: mustermann-contrib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +157,7 @@ files:
 - lib/hanami/middleware/body_parser.rb
 - lib/hanami/middleware/body_parser/class_interface.rb
 - lib/hanami/middleware/body_parser/errors.rb
+- lib/hanami/middleware/body_parser/form_parser.rb
 - lib/hanami/middleware/body_parser/json_parser.rb
 - lib/hanami/middleware/body_parser/parser.rb
 - lib/hanami/middleware/error.rb
@@ -164,6 +165,7 @@ files:
 - lib/hanami/middleware/trie.rb
 - lib/hanami/router.rb
 - lib/hanami/router/block.rb
+- lib/hanami/router/constants.rb
 - lib/hanami/router/errors.rb
 - lib/hanami/router/formatter/csv.rb
 - lib/hanami/router/formatter/human_friendly.rb
@@ -194,9 +196,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.3
 signing_key: