hanami-router 1.2.0 → 1.3.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d3df0ce6e2386faecda80095ebba0e81e5fd30737999c2e0446ae922f1c3df1
-  data.tar.gz: d66331f4966e8deaae7adbccd8efe93295e3a11355cd86464bc542d0495b5a25
+  metadata.gz: 55265d04629210abb763c78a81bd4507cbe271cb0a5da1662bb938a3fca9d409
+  data.tar.gz: c11974f4d0f047d1ae21342d936faba59125080e1ce093ef9d63ce7a0cf672a9
 SHA512:
-  metadata.gz: 57e694cbe56d1cbe8eafa82228000258fa04d9c597643e3b04c619308921c8df3841915348b6206f8e463b68e45760f308e3efc54fb6e6cc019f09da76b94489
-  data.tar.gz: 157f72c97b99dfed376107a6d7e2e4d4d51f21654e58bf2ac9c3b316708666f41032b3f904d37ffe28b2405580e4863abe449f2ea0d29ecf221a908b6c574370
+  metadata.gz: 75ca87dadac5a3eb8c099aa4a1977c271f1b24dcdd55cfd16a8fdf77c4e990ac074a84e651ad347bad9d202b2bed5e53f7dc43a64feaea96a8cb09adefd9428c
+  data.tar.gz: 685771d96a9c584a6bfee63ee90916648bf851c94b2dd1c1be69513b2f9b8b2ab6975b321fe4454047216e05a99c6431dc0c354309812ad260f2c8af058c86f9

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Hanami::Router
 Rack compatible HTTP router for Ruby
 
+## v1.3.0.beta1 - 2018-08-08
+### Added
+- [Luca Guidi] Official support for JRuby 9.2.0.0
+- [Gustavo Caso] Introduce `Hanami::Middleware::BodyParser` Rack middleware to parse payload of non-GET HTTP requests.
+
+### Deprecated
+- [Alfonso Uceda] Deprecate `Hanami::Router.new(force_ssl: true)`. Use webserver (eg. Nginx), Rack middleware (eg. `rack-ssl`), or another strategy to force HTTPS connection.
+- [Gustavo Caso] Deprecate `Hanami::Router.new(body_parsers: [:json])`. Use `Hanami::Middleware::BodyParser` instead.
+
 ## v1.2.0 - 2018-04-11
 
 ## v1.2.0.rc2 - 2018-04-06

data/README.md

@@ -4,12 +4,12 @@ Rack compatible, lightweight and fast HTTP Router for Ruby and [Hanami](http://h
 
 ## Status
 
-[![Gem Version](http://img.shields.io/gem/v/hanami-router.svg)](https://badge.fury.io/rb/hanami-router)
-[![Build Status](http://img.shields.io/travis/hanami/router/master.svg)](https://travis-ci.org/hanami/router?branch=master)
-[![Coverage](http://img.shields.io/coveralls/hanami/router/master.svg)](https://coveralls.io/r/hanami/router)
-[![Code Climate](http://img.shields.io/codeclimate/github/hanami/router.svg)](https://codeclimate.com/github/hanami/router)
-[![Dependencies](http://img.shields.io/gemnasium/hanami/router.svg)](https://gemnasium.com/hanami/router)
-[![Inline docs](http://inch-ci.org/github/hanami/router.png)](http://inch-ci.org/github/hanami/router)
+[![Gem Version](https://badge.fury.io/rb/hanami-router.svg)](https://badge.fury.io/rb/hanami-router)
+[![TravisCI](https://travis-ci.org/hanami/router.svg?branch=master)](https://travis-ci.org/hanami/router)
+[![CircleCI](https://circleci.com/gh/hanami/router/tree/master.svg?style=svg)](https://circleci.com/gh/hanami/router/tree/master)
+[![Test Coverage](https://codecov.io/gh/hanami/router/branch/master/graph/badge.svg)](https://codecov.io/gh/hanami/router)
+[![Depfu](https://badges.depfu.com/badges/5f6b8e8fa3b0d082539f0b0f84d55960/overview.svg)](https://depfu.com/github/hanami/router?project=Bundler)
+[![Inline Docs](http://inch-ci.org/github/hanami/router.svg)](http://inch-ci.org/github/hanami/router)
 
 ## Contact
 
@@ -594,12 +594,14 @@ It comes with a built-in JSON parser and allows to pass custom parsers.
 
 ```ruby
 require 'hanami/router'
+require 'hanami/middleware/body_parser'
 
-endpoint = ->(env) { [200, {},[env['router.params'].inspect]] }
-
-router = Hanami::Router.new(parsers: [:json]) do
-  patch '/books/:id', to: endpoint
+app = Hanami::Router.new do
+  patch '/books/:id', to: ->(env) { [200, {},[env['router.params'].inspect]] }
 end
+
+use Hanami::Middleware::BodyParser, :json
+run app
 ```
 
 ```shell
@@ -615,7 +617,7 @@ curl http://localhost:2300/books/1    \
 If the json can't be parsed an exception is raised:
 
 ```ruby
-Hanami::Routing::Parsing::BodyParsingError
+Hanami::Middleware::BodyParser::BodyParsingError
 ```
 
 ##### `multi_json`
@@ -626,9 +628,10 @@ If you want to use a different JSON backend, include `multi_json` in your `Gemfi
 
 ```ruby
 require 'hanami/router'
+require 'hanami/middleware/body_parser'
 
 # See Hanami::Routing::Parsing::Parser
-class XmlParser
+class XmlParser < Hanami::Middleware::BodyParser::Parser
   def mime_types
     ['application/xml', 'text/xml']
   end
@@ -637,15 +640,16 @@ class XmlParser
   def parse(body)
     # parse xml
   rescue SomeXmlParsingError => e
-    raise Hanami::Routing::Parsing::BodyParsingError.new(e)
+    raise Hanami::Middleware::BodyParser::BodyParsingError.new(e)
   end
 end
 
-endpoint = ->(env) { [200, {},[env['router.params'].inspect]] }
-
-router = Hanami::Router.new(parsers: [XmlParser.new]) do
-  patch '/authors/:id', to: endpoint
+app = Hanami::Router.new do
+  patch '/authors/:id', to: ->(env) { [200, {},[env['router.params'].inspect]] }
 end
+
+use Hanami::Middleware::BodyParser, XmlParser
+run app
 ```
 
 ```shell

data/hanami-router.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rack',         '~> 2.0'
   spec.add_dependency 'http_router',  '0.11.2'
-  spec.add_dependency 'hanami-utils', '~> 1.2'
+  spec.add_dependency 'hanami-utils', '~> 1.3.beta'
 
   spec.add_development_dependency 'bundler',   '~> 1.5'
-  spec.add_development_dependency 'rake',      '~> 11'
-  spec.add_development_dependency 'rack-test', '~> 0.6'
+  spec.add_development_dependency 'rake',      '~> 12'
+  spec.add_development_dependency 'rack-test', '~> 1.0'
   spec.add_development_dependency 'rspec',     '~> 3.7'
 end

data/lib/hanami/middleware/body_parser.rb

@@ -0,0 +1,98 @@
+require 'hanami/middleware/body_parser/parser'
+require 'hanami/utils/hash'
+
+module Hanami
+  module Middleware
+    # @since 1.3.0
+    # @api private
+    class BodyParser
+      # @since 1.3.0
+      # @api private
+      CONTENT_TYPE       = 'CONTENT_TYPE'.freeze
+
+      # @since 1.3.0
+      # @api private
+      MEDIA_TYPE_MATCHER = /\s*[;,]\s*/.freeze
+
+      # @since 1.3.0
+      # @api private
+      RACK_INPUT    = 'rack.input'.freeze
+
+      # @since 1.3.0
+      # @api private
+      ROUTER_PARAMS = 'router.params'.freeze
+
+      # @api private
+      ROUTER_PARSED_BODY = 'router.parsed_body'.freeze
+
+      # @api private
+      FALLBACK_KEY  = '_'.freeze
+
+      def initialize(app, parsers)
+        @app = app
+        @parsers = build_parsers(parsers)
+      end
+
+      def call(env)
+        body = env[RACK_INPUT].read
+        return @app.call(env) if body.empty?
+
+        env[RACK_INPUT].rewind    # somebody might try to read this stream
+
+        env[ROUTER_PARAMS] ||= {} # prepare params
+        env[ROUTER_PARSED_BODY] = _parse(env, body)
+        env[ROUTER_PARAMS]      = _symbolize(env[ROUTER_PARSED_BODY]).merge(env[ROUTER_PARAMS])
+
+        @app.call(env)
+      end
+
+      private
+
+      def build_parsers(parsers)
+        result  = Hash.new
+        args    = Array(parsers)
+        return result if args.empty?
+
+        args.each do |arg|
+          parser = Parser.for(arg)
+
+          parser.mime_types.each do |mime|
+            result[mime] = parser
+          end
+        end
+
+        result.default = Parser.new
+        result
+      end
+
+      # @api private
+      def _symbolize(body)
+        if body.is_a?(Hash)
+          Utils::Hash.deep_symbolize(body)
+        else
+          { FALLBACK_KEY => body }
+        end
+      end
+
+      # @api private
+      def _parse(env, body)
+        @parsers[
+          media_type(env)
+        ].parse(body)
+      end
+
+      # @api private
+      def media_type(env)
+        if ct = content_type(env)
+          ct.split(MEDIA_TYPE_MATCHER, 2).first.downcase
+        end
+      end
+
+      # @api private
+      def content_type(env)
+        content_type = env[CONTENT_TYPE]
+        content_type.nil? || content_type.empty? ? nil : content_type
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require 'hanami/utils/json'
+
+module Hanami
+  module Middleware
+    class BodyParser
+      # @since 1.3.0
+      # @api private
+      class JsonParser < Parser
+        # @since 1.3.0
+        # @api private
+        def mime_types
+          ['application/json', 'application/vnd.api+json']
+        end
+
+        # Parse a json string
+        #
+        # @param body [String] a json string
+        #
+        # @return [Hash] the parsed json
+        #
+        # @raise [Hanami::Middleware::BodyParser::BodyParsingError] when the body can't be parsed.
+        #
+        # @since 1.3.0
+        # @api private
+        def parse(body)
+          Hanami::Utils::Json.parse(body)
+        rescue Hanami::Utils::Json::ParserError => e
+          raise BodyParsingError.new(e.message)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+require 'hanami/utils/class'
+require 'hanami/utils/string'
+require 'hanami/routing/parsing/parser'
+
+module Hanami
+  module Middleware
+    class BodyParser
+      # Body parsing error
+      # This is raised when parser fails to parse the body
+      #
+      # @since 1.3.0
+      class BodyParsingError < Hanami::Routing::Parsing::BodyParsingError
+      end
+
+      # @since 1.3.0
+      class UnknownParserError < Hanami::Routing::Parsing::UnknownParserError
+      end
+
+      # @since 1.3.0
+      class Parser
+        # @since 1.3.0
+        # @api private
+        def self.for(parser)
+          case parser
+          when String, Symbol
+            require_parser(parser)
+          else
+            raise UnknownParserError.new(parser) unless parser?(parser)
+            parser.new
+          end
+        end
+
+        # @since 1.3.0
+        def mime_types
+          raise NotImplementedError
+        end
+
+        # @since 1.3.0
+        def parse(body)
+          body
+        end
+
+        private
+        # @since 1.3.0
+        # @api private
+        def self.require_parser(parser)
+          require "hanami/middleware/body_parser/#{ parser }_parser"
+
+          parser = Utils::String.classify(parser)
+          Utils::Class.load!("Hanami::Middleware::BodyParser::#{ parser }Parser").new
+        rescue LoadError, NameError
+          raise UnknownParserError.new(parser)
+        end
+
+        def self.parser?(parser)
+          parser.is_a?(Class) && parser < Parser
+        end
+      end
+    end
+  end
+end

data/lib/hanami/router/version.rb

@@ -1,6 +1,6 @@
 module Hanami
   class Router
     # @since 0.1.0
-    VERSION = '1.2.0'.freeze
+    VERSION = '1.3.0.beta1'.freeze
   end
 end

data/lib/hanami/routing/force_ssl.rb

@@ -1,4 +1,5 @@
 require 'rack/request'
+require 'hanami/utils/deprecation'
 
 module Hanami
   module Routing
@@ -176,6 +177,8 @@ module Hanami
       def _redefine_call
         return unless @active
 
+        Hanami::Utils::Deprecation.new('force_ssl option is deprecated, please delegate this behaviour to Nginx/Apache or use a Rack middleware like `rack-ssl`')
+
         define_singleton_method :call do |env|
           [redirect_code(env), { LOCATION_HEADER => full_url(env) }, EMPTY_BODY] if force?(env)
         end

data/lib/hanami/routing/http_router.rb

@@ -67,6 +67,10 @@ module Hanami
       # @since 0.1.0
       # @api private
       def initialize(options = {}, &blk)
+        if options[:parsers]
+          depecration_message = 'Hanami::Router options[:parsers] is deprecated and it will be removed in future versions'
+          Hanami::Utils::Deprecation.new(depecration_message)
+        end
         @compiled         = false
         @uri_parser       = URI::Parser.new
         super(options, &nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-router
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0.beta1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2018-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.3.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.3.beta
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,9 @@ files:
 - README.md
 - hanami-router.gemspec
 - lib/hanami-router.rb
+- lib/hanami/middleware/body_parser.rb
+- lib/hanami/middleware/body_parser/json_parser.rb
+- lib/hanami/middleware/body_parser/parser.rb
 - lib/hanami/router.rb
 - lib/hanami/router/version.rb
 - lib/hanami/routing/endpoint.rb
@@ -156,12 +159,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Rack compatible HTTP router for Ruby and Hanami