hanami-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b78d8afabe0c9e3a00e3d809866366d1961786fab864788d37bb0b4edc0b67c8
-  data.tar.gz: 7df6b562a2721f299b9c2a307f546c4e79d72f500b67032ed434907bc880dc09
+  metadata.gz: 33a0b691f992906407c5d0c6bdf4c844d6b7ff4deb420b88f1e73c45768f210f
+  data.tar.gz: 01a7c8f0972e5ea9a1eff88c81d5966a9c22192c99ca9e3416cfdba9c9fdbc38
 SHA512:
-  metadata.gz: bb8c28fded8d1518c02d286d57d56afff643caab1da5c11e0f357b6dea72e79a4788be00b11169599b692d74fc867244516220785932e3b30895b72077375a77
-  data.tar.gz: 82db2bdc48a9416f884d22fb7d3fe9d3bb7f6dab1632416ca0939e6ed66c87f4a4fc81e2a7a0d86da18a9e8a3e418d189a375a78ca8e63b2a7177e7e9a5bb91b
+  metadata.gz: a40490671a64ebdf57939a470de03045f29224859453465aa5ed60d39c19d2d8f2d342f8cd7116a90ae6e754b761b609f0cabc6d1ed7daac3df991ac0c25b2ce
+  data.tar.gz: f8791ad3eaa0be2b0e114f124d5e193b5a112ea3a4282c01ebc21a5c860c37e367484ade01f44392962853c6126511f30f9fc32829ebb078e2a86b1a47583358

data/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: ci
+
+"on":
+  push:
+    paths:
+      - ".github/workflows/ci.yml"
+      - "lib/**"
+      - "*.gemspec"
+      - "spec/**"
+      - "Rakefile"
+      - "Gemfile"
+      - ".rubocop.yml"
+  pull_request:
+    branches:
+      - master
+  create:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "2.7"
+    env:
+      CODACY_RUN_LOCAL: true
+      CODACY_PROJECT_TOKEN: ${{secrets.CODACY_PROJECT_TOKEN}}
+    steps:
+      - uses: actions/checkout@v1
+      - name: Install package dependencies
+        run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+      - name: Install latest bundler
+        run: |
+          gem install bundler --no-document
+      - name: Bundle install
+        run: bundle install --jobs 4 --retry 3
+      - name: Run all tests
+        run: bundle exec rake

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Hanami::API
 Minimal, extremely fast, lightweight Ruby framework for HTTP APIs.
 
+## v0.1.1 - 2020-05-20
+### Fixed
+- [Luca Guidi] Ensure Rack middleware to be mounted in scopes without a leading slash
+- [Luca Guidi] Ensure nested scopes to use the given middleware stack
+- [Luca Guidi] Ensure nested scopes to inherit middleware from outer scopes
+
 ## v0.1.0 - 2020-02-19
 ### Added
+- [Luca Guidi] Allow to use Rack middleware with scope visibility
+- [Luca Guidi] Block syntax: introduced `json` to render JSON response body
+- [Luca Guidi] Block syntax: introduced `redirect` to perform HTTP redirect
+- [Luca Guidi] Block syntax: introduced `halt` to interrupt the execution flow and return a HTTP status and body
+- [Luca Guidi] Block syntax: introduced `status`, `headers`, `body` that act both as getters and setters for the response values
+- [Luca Guidi] Block syntax: introduced `params` getter
 - [Luca Guidi] Introduced `Hanami::API` superclass

data/Gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 gemspec
 
 gem "byebug", require: false
-gem "hanami-router", git: "https://github.com/hanami/router.git", branch: "feature/tree-rewrite"
+gem "hanami-router", git: "https://github.com/hanami/router.git", branch: "unstable"

data/README.md

@@ -1,6 +1,35 @@
 # Hanami::API
 
 Minimal, extremely fast, lightweight Ruby framework for HTTP APIs.
+* [Installation](#installation)
+* [Performance](#performance)
+  + [Runtime](#runtime)
+  + [Memory](#memory)
+  + [Requests per second](#requests-per-second)
+* [Usage](#usage)
+  + [Routes](#routes)
+  + [HTTP methods](#http-methods)
+  + [Endpoints](#endpoints)
+    - [Rack endpoint](#rack-endpoint)
+    - [Block endpoint](#block-endpoint)
+      * [String (body)](#string-body)
+      * [Integer (status code)](#integer-status-code)
+      * [Integer, String (status code, body)](#integer-string-status-code-body)
+      * [Integer, Hash, String (status code, headers, body)](#integer-hash-string-status-code-headers-body)
+  + [Block context](#block-context)
+    - [env](#env)
+    - [status](#status)
+    - [headers](#headers)
+    - [body](#body)
+    - [params](#params)
+    - [halt](#halt)
+    - [redirect](#redirect)
+    - [back](#back)
+    - [json](#json)
+  + [Scope](#scope)
+  + [Rack Middleware](#rack-middleware)
+* [Development](#development)
+* [Contributing](#contributing)
 
 ## Installation
 
@@ -33,15 +62,14 @@ Runtime to complete 20,000 requests (lower is better).
 
 | Framework  | Seconds to complete |
 |------------|---------------------|
-| hanami-api | 0.11628299998119473 |
-| watts      | 0.23525599995628    |
-| roda       | 0.348202999914065   |
-| syro       | 0.355627000099048   |
-| rack-app   | 0.6226229998283088  |
-| cuba       | 1.2913489998318255  |
-| rails      | 17.04722599987872   |
-| synfeld    | 171.83788800006732  |
-| sinatra    | 197.47695700009353  |
+| hanami-api | 0.116               |
+| watts      | 0.235               |
+| roda       | 0.348               |
+| syro       | 0.356               |
+| rack-app   | 0.623               |
+| cuba       | 1.291               |
+| rails      | 17.047              |
+| sinatra    | 197.477             |
 
 ### Memory
 
@@ -57,7 +85,22 @@ Memory footprint for 10,000 routes app (lower is better).
 | watts      | 84956  |
 | sinatra    | 124980 |
 | rails      | 143048 |
-| synfeld    | 172680 |
+
+### Requests per second
+
+For this benchmark there are two apps for each framework: one with the root route, and one with 10,000 routes.
+Requests per second hitting the 1st (and only route) and the 10,000th route to measure the best and worst case scenario (higher is better).
+
+| Framework  | 1st route | 10,000th route |
+|------------|-----------|----------------|
+| hanami-api | 14719.95  | 14290.20       |
+| watts      | 13912.31  | 12609.68       |
+| roda       | 13965.20  | 11051.27       |
+| syro       | 13079.12  | 10689.51       |
+| rack-app   | 10274.01  | 10306.46       |
+| cuba       | 13061.82  | 7084.33        |
+| rails      | 1345.27   | 303.06         |
+| sinatra    | 5038.74   | 28.14          |
 
 ## Usage
 
@@ -123,7 +166,7 @@ get "/", to: MyRackEndpoint.new
 A block passed to the route definition is named a block endpoint.
 The returning value will compose the Rack response. It can be:
 
-##### String
+##### String (body)
 
 ```ruby
 get "/" do
@@ -133,7 +176,7 @@ end
 
 It will return `[200, {}, ["Hello, world"]]`
 
-##### Integer
+##### Integer (status code)
 
 ```ruby
 get "/" do
@@ -143,7 +186,7 @@ end
 
 It will return `[418, {}, ["I'm a teapot"]]`
 
-##### Integer, String
+##### Integer, String (status code, body)
 
 ```ruby
 get "/" do
@@ -153,7 +196,7 @@ end
 
 It will return `[401, {}, ["You shall not pass"]]`
 
-##### Integer, Hash, String
+##### Integer, Hash, String (status code, headers, body)
 
 ```ruby
 get "/" do
@@ -220,7 +263,7 @@ get "/" do
 end
 ```
 
-Get HTTP response body
+Set HTTP response body
 
 ```ruby
 get "/" do

data/lib/hanami/api.rb

@@ -16,19 +16,14 @@ module Hanami
       super
 
       app.class_eval do
-        @routes = []
-        @stack = Middleware::Stack.new
+        @router = Router.new
       end
     end
 
     class << self
-      # @since 0.1.0
+      # @since 0.1.1
       # @api private
-      attr_reader :routes
-
-      # @since 0.1.0
-      # @api private
-      attr_reader :stack
+      attr_reader :router
     end
 
     # Defines a named root route (a GET route for "/")
@@ -56,7 +51,7 @@ module Hanami
     #     end
     #   end
     def self.root(*args, **kwargs, &blk)
-      @routes << [:root, args, kwargs, blk]
+      @router.root(*args, **kwargs, &blk)
     end
 
     # Defines a route that accepts GET requests for the given path.
@@ -93,7 +88,7 @@ module Hanami
     #     get "/users/:id", to: ->(*) { [200, {}, ["OK"]] }, id: /\d+/
     #   end
     def self.get(*args, **kwargs, &blk)
-      @routes << [:get, args, kwargs, blk]
+      @router.get(*args, **kwargs, &blk)
     end
 
     # Defines a route that accepts POST requests for the given path.
@@ -108,7 +103,7 @@ module Hanami
     #
     # @see .get
     def self.post(*args, **kwargs, &blk)
-      @routes << [:post, args, kwargs, blk]
+      @router.post(*args, **kwargs, &blk)
     end
 
     # Defines a route that accepts PATCH requests for the given path.
@@ -123,7 +118,7 @@ module Hanami
     #
     # @see .get
     def self.patch(*args, **kwargs, &blk)
-      @routes << [:patch, args, kwargs, blk]
+      @router.patch(*args, **kwargs, &blk)
     end
 
     # Defines a route that accepts PUT requests for the given path.
@@ -138,7 +133,7 @@ module Hanami
     #
     # @see .get
     def self.put(*args, **kwargs, &blk)
-      @routes << [:put, args, kwargs, blk]
+      @router.put(*args, **kwargs, &blk)
     end
 
     # Defines a route that accepts DELETE requests for the given path.
@@ -153,7 +148,7 @@ module Hanami
     #
     # @see .get
     def self.delete(*args, **kwargs, &blk)
-      @routes << [:delete, args, kwargs, blk]
+      @router.delete(*args, **kwargs, &blk)
     end
 
     # Defines a route that accepts TRACE requests for the given path.
@@ -168,7 +163,7 @@ module Hanami
     #
     # @see .get
     def self.trace(*args, **kwargs, &blk)
-      @routes << [:trace, args, kwargs, blk]
+      @router.trace(*args, **kwargs, &blk)
     end
 
     # Defines a route that accepts OPTIONS requests for the given path.
@@ -183,7 +178,7 @@ module Hanami
     #
     # @see .get
     def self.options(*args, **kwargs, &blk)
-      @routes << [:options, args, kwargs, blk]
+      @router.options(*args, **kwargs, &blk)
     end
 
     # Defines a route that accepts LINK requests for the given path.
@@ -198,7 +193,7 @@ module Hanami
     #
     # @see .get
     def self.link(*args, **kwargs, &blk)
-      @routes << [:link, args, kwargs, blk]
+      @router.link(*args, **kwargs, &blk)
     end
 
     # Defines a route that accepts UNLINK requests for the given path.
@@ -213,7 +208,7 @@ module Hanami
     #
     # @see .get
     def self.unlink(*args, **kwargs, &blk)
-      @routes << [:unlink, args, kwargs, blk]
+      @router.unlink(*args, **kwargs, &blk)
     end
 
     # Defines a route that redirects the incoming request to another path.
@@ -227,7 +222,7 @@ module Hanami
     #
     # @see .get
     def self.redirect(*args, **kwargs, &blk)
-      @routes << [:redirect, args, kwargs, blk]
+      @router.redirect(*args, **kwargs, &blk)
     end
 
     # Defines a routing scope. Routes defined in the context of a scope,
@@ -251,7 +246,7 @@ module Hanami
     #
     #   # It generates a route with a path `/v1/users`
     def self.scope(*args, **kwargs, &blk)
-      @routes << [:scope, args, kwargs, blk]
+      @router.scope(*args, **kwargs, &blk)
     end
 
     # Mount a Rack application at the specified path.
@@ -276,7 +271,7 @@ module Hanami
     #     mount MyRackApp.new, at: "/foo"
     #   end
     def self.mount(*args, **kwargs, &blk)
-      @routes << [:mount, args, kwargs, blk]
+      @router.mount(*args, **kwargs, &blk)
     end
 
     # Use a Rack middleware
@@ -294,27 +289,21 @@ module Hanami
     #     use MyRackMiddleware
     #   end
     def self.use(middleware, *args, &blk)
-      @stack.use(middleware, args, &blk)
+      @router.use(middleware, *args, &blk)
     end
 
     # @since 0.1.0
-    def initialize(routes: self.class.routes, stack: self.class.stack)
-      @stack = stack
-      @router = Router.new(stack: @stack) do
-        routes.each do |method_name, args, kwargs, blk|
-          send(method_name, *args, **kwargs, &blk)
-        end
-      end
+    def initialize(router: self.class.router)
+      @router = router
 
       freeze
     end
 
     # @since 0.1.0
     def freeze
-      @app = @stack.finalize(@router)
+      @app = @router.to_rack_app
       @url_helpers = @router.url_helpers
       @router.remove_instance_variable(:@url_helpers)
-      remove_instance_variable(:@stack)
       remove_instance_variable(:@router)
       @url_helpers.freeze
       @app.freeze

data/lib/hanami/api/block/context.rb

@@ -7,6 +7,9 @@ require "json"
 module Hanami
   class API
     module Block
+      # Execution context for Block syntax
+      #
+      # @since 0.1.0
       class Context < Hanami::Router::Block::Context
         # @overload body
         #   Gets the current HTTP response body
@@ -126,12 +129,24 @@ module Hanami
 
         # @since 0.1.0
         # @api private
+        #
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
         def call
           case caught
             in String => body
             [status, headers, [body]]
             in Integer => status
+            # rubocop:disable Style/RedundantSelf
+            #
+            # NOTE: It must use `self.body` so it will pick the method defined above.
+            #
+            #       If `self` isn't enforced, Ruby will try to bind `body` to
+            #       the current pattern matching context.
+            #       When that happens, the body that was manually set is ignored,
+            #       which results in a bug.
             [status, headers, [self.body || http_status(status)]]
+            # rubocop:enable Style/RedundantSelf
             in [Integer, String] => response
             [response[0], headers, [response[1]]]
             in [Integer, Hash, String] => response
@@ -139,6 +154,8 @@ module Hanami
             [response[0], headers, [response[2]]]
           end
         end
+        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/AbcSize
 
         private
 

data/lib/hanami/api/middleware.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "rack/builder"
-
 module Hanami
   class API
     # Hanami::API middleware stack
@@ -9,6 +7,9 @@ module Hanami
     # @since 0.1.0
     # @api private
     module Middleware
+      require "hanami/api/middleware/app"
+      require "hanami/api/middleware/trie"
+
       # Middleware stack
       #
       # @since 0.1.0
@@ -16,76 +17,46 @@ module Hanami
       class Stack
         # @since 0.1.0
         # @api private
-        ROOT_PREFIX = "/"
-        private_constant :ROOT_PREFIX
-
-        # @since 0.1.0
-        # @api private
-        def initialize
-          @prefix = ROOT_PREFIX
-          @stack = Hash.new { |hash, key| hash[key] = [] }
-        end
-
-        # @since 0.1.0
-        # @api private
-        def use(middleware, args, &blk)
-          @stack[@prefix].push([middleware, args, blk])
+        def initialize(prefix)
+          @prefix = prefix
+          @stack = {}
         end
 
         # @since 0.1.0
         # @api private
-        def with(path)
-          prefix = @prefix
-          @prefix = path
-          yield
-        ensure
-          @prefix = prefix
+        def use(path, middleware, *args, &blk)
+          # FIXME: test with prefix when Hanami::API.settings and prefix will be supported
+          @stack[path] ||= []
+          @stack[path].push([middleware, args, blk])
         end
 
-        # @since 0.1.0
+        # @since 0.1.1
         # @api private
-        def finalize(app) # rubocop:disable Metrics/MethodLength
-          uniq!
-          return app if @stack.empty?
-
-          s = self
-
-          Rack::Builder.new do
-            s.each do |prefix, stack|
-              s.mapped(self, prefix) do
-                stack.each do |middleware, args, blk|
-                  use(middleware, *args, &blk)
-                end
-              end
-
-              run app
-            end
+        def to_hash
+          @stack.each_with_object({}) do |(path, _), result|
+            result[path] = stack_for(path)
           end
         end
 
-        # @since 0.1.0
+        # @since 0.1.1
         # @api private
-        def each(&blk)
-          uniq!
-          @stack.each(&blk)
-        end
+        def finalize(app)
+          mapping = to_hash
+          return app if mapping.empty?
 
-        # @since 0.1.0
-        # @api private
-        def mapped(builder, prefix, &blk)
-          if prefix == ROOT_PREFIX
-            builder.instance_eval(&blk)
-          else
-            builder.map(prefix, &blk)
-          end
+          App.new(app, mapping)
         end
 
         private
 
-        # @since 0.1.0
+        # @since 0.1.1
         # @api private
-        def uniq!
-          @stack.each_value(&:uniq!)
+        def stack_for(current_path)
+          @stack.each_with_object([]) do |(path, stack), result|
+            next unless current_path.start_with?(path)
+
+            result.push(stack)
+          end.flatten(1)
         end
       end
     end

data/lib/hanami/api/middleware/app.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "rack/builder"
+
+module Hanami
+  class API
+    module Middleware
+      # Hanami::API middleware stack
+      #
+      # @since 0.1.1
+      # @api private
+      class App
+        # @since 0.1.1
+        # @api private
+        def initialize(app, mapping)
+          @trie = Hanami::API::Middleware::Trie.new(app)
+
+          mapping.each do |path, stack|
+            builder = Rack::Builder.new
+
+            stack.each do |middleware, args, blk|
+              builder.use(middleware, *args, &blk)
+            end
+
+            builder.run(app)
+
+            @trie.add(path, builder.to_app.freeze)
+          end
+
+          @trie.freeze
+        end
+
+        # @since 0.1.1
+        # @api private
+        def call(env)
+          @trie.find(env["PATH_INFO"]).call(env)
+        end
+      end
+    end
+  end
+end

data/lib/hanami/api/middleware/node.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Hanami
+  class API
+    module Middleware
+      # Trie node to register scopes with custom Rack middleware
+      #
+      # @api private
+      # @since 0.1.1
+      class Node
+        # @api private
+        # @since 0.1.1
+        attr_reader :app
+
+        # @api private
+        # @since 0.1.1
+        def initialize
+          @app = nil
+          @children = {}
+        end
+
+        # @api private
+        # @since 0.1.1
+        def freeze
+          @children.each(&:freeze)
+          super
+        end
+
+        # @api private
+        # @since 0.1.1
+        def put(segment)
+          @children[segment] ||= self.class.new
+        end
+
+        # @api private
+        # @since 0.1.1
+        def get(segment)
+          @children.fetch(segment) { self if leaf? }
+        end
+
+        # @api private
+        # @since 0.1.1
+        def app!(app)
+          @app = app
+        end
+
+        # @api private
+        # @since 0.1.1
+        def app?
+          @app
+        end
+
+        # @api private
+        # @since 0.1.1
+        def leaf?
+          @children.empty?
+        end
+      end
+    end
+  end
+end

data/lib/hanami/api/middleware/trie.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "hanami/api/middleware/node"
+
+module Hanami
+  class API
+    module Middleware
+      # Trie to register scopes with custom Rack middleware
+      #
+      # @api private
+      # @since 0.1.1
+      class Trie
+        # @api private
+        # @since 0.1.1
+        def initialize(app)
+          @app = app
+          @root = Node.new
+        end
+
+        # @api private
+        # @since 0.1.1
+        def freeze
+          @root.freeze
+          super
+        end
+
+        # @api private
+        # @since 0.1.1
+        def add(path, app)
+          node = @root
+          for_each_segment(path) do |segment|
+            node = node.put(segment)
+          end
+
+          node.app!(app)
+        end
+
+        # @api private
+        # @since 0.1.1
+        def find(path)
+          node = @root
+
+          for_each_segment(path) do |segment|
+            break unless node
+
+            node = node.get(segment)
+          end
+
+          return node.app if node&.app?
+
+          @root.app || @app
+        end
+
+        # @api private
+        # @since 0.1.1
+        def empty?
+          @root.leaf?
+        end
+
+        private
+
+        # @api private
+        # @since 0.1.1
+        def for_each_segment(path, &blk)
+          _, *segments = path.split(/\//)
+          segments.each(&blk)
+        end
+      end
+    end
+  end
+end

data/lib/hanami/api/router.rb

@@ -9,9 +9,9 @@ module Hanami
     class Router < ::Hanami::Router
       # @since 0.1.0
       # @api private
-      def initialize(stack:, **kwargs, &blk)
-        @stack = stack
-        super(block_context: Block::Context, **kwargs, &blk)
+      def initialize(block_context: Block::Context, **kwargs)
+        super(block_context: block_context, **kwargs)
+        @stack = Middleware::Stack.new(@path_prefix.to_s)
       end
 
       # @since 0.1.0
@@ -26,15 +26,13 @@ module Hanami
       # @since 0.1.0
       # @api private
       def use(middleware, *args, &blk)
-        @stack.use(middleware, args, &blk)
+        @stack.use(@path_prefix.to_s, middleware, *args, &blk)
       end
 
-      # @since 0.1.0
+      # @since 0.1.1
       # @api private
-      def scope(*args, **kwargs, &blk)
-        @stack.with(args.first) do
-          super
-        end
+      def to_rack_app
+        @stack.finalize(self)
       end
     end
   end

data/lib/hanami/api/version.rb

@@ -3,6 +3,6 @@
 module Hanami
   class API
     # @since 0.1.0
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2020-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-router
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -87,6 +88,9 @@ files:
 - lib/hanami/api/block/context.rb
 - lib/hanami/api/error.rb
 - lib/hanami/api/middleware.rb
+- lib/hanami/api/middleware/app.rb
+- lib/hanami/api/middleware/node.rb
+- lib/hanami/api/middleware/trie.rb
 - lib/hanami/api/router.rb
 - lib/hanami/api/version.rb
 homepage: http://rubygems.org
@@ -111,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Hanami API