openapi_first 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50a431b59d4568cede6b8a110ada173691c698517231299795ee22fc8f54115a
-  data.tar.gz: be49aa45dd7b95ee0ec2149b4ec6476c78a42a0e46204c321e5350368bee2d54
+  metadata.gz: e7c0190540a81a93de98accc25eac31681aa77997282744083639e75e032a65b
+  data.tar.gz: '08c6b1f8bee0682a75672e77e8831d30fe15a466ad72cdd6ea901c93b4c0361d'
 SHA512:
-  metadata.gz: b6b29dab24a951716e9fb73a7f852a4acd3de577cce82008cd329906ef77d73c4cff182face7adb1d36e9ecb9ea170d1655accb9cdc3bba682a818c3c81000b0
-  data.tar.gz: d0ad9c915cb4e637dce9ff4f0e6a8bc35cf705c684f69f38d9abbc8edada4b8aef0d2ba226cfae187f9d80da3a229e0f9493ac78bddb0045206ed816cbfe022e
+  metadata.gz: cb1e60e214237e73304f5e4abc7611b6516072b7610e2bacfe9040d9fc91299e786fbfc64c695702aca891981a3eb993d0f8a2f75007fa2637f659e5ab4a635c
+  data.tar.gz: ab281285bda7e922497885c3751eaa9e34419ba2a8f9a20b2b9dc9bf693d9f2248ed998347527430485edf123d715dbb7932d516f5f2af22aae95910f05e7d58

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.10.0
+- Add support for query parameters named `"some[thing]"` ([issue](https://github.com/ahx/openapi_first/issues/40))
+
 ## 0.9.0
 - Make request validation usable standalone
 

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.9.0)
+    openapi_first (0.10.0)
+      deep_merge (>= 1.2.1)
       hanami-router (~> 2.0.alpha2)
       hanami-utils (~> 2.0.alpha1)
       json_schemer (~> 0.2)
@@ -12,12 +13,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.2)
+    activesupport (6.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
@@ -28,7 +29,7 @@ GEM
     diff-lcs (1.3)
     ecma-re-validator (0.2.1)
       regexp_parser (~> 1.2)
-    hana (1.3.5)
+    hana (1.3.6)
     hanami-router (2.0.0.alpha2)
       mustermann (~> 1.0)
       mustermann-contrib (~> 1.0)
@@ -66,7 +67,7 @@ GEM
       mustermann-contrib (~> 1.1.1)
       nokogiri
     parallel (1.19.1)
-    parser (2.7.1.1)
+    parser (2.7.1.2)
       ast (~> 2.4.0)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -83,15 +84,15 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
     rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+    rspec-support (3.9.3)
     rubocop (0.82.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)

data/README.md

@@ -1,13 +1,32 @@
 # OpenapiFirst
 
-OpenapiFirst helps to implement HTTP APIs based on an [OpenApi](https://www.openapis.org/) API description. The idea is that you create an API description first, then add a method that returns data and implements your business logic and be done.
-
-## TL;DR
+OpenapiFirst helps to implement HTTP APIs based on an [OpenApi](https://www.openapis.org/) API description. The idea is that you create an API description first, then add code that returns data and implements your business logic and be done.
 
 Start with writing an OpenAPI file that describes the API, which you are about to write. Use a [validator](https://github.com/stoplightio/spectral/) to make sure the file is valid.
-In the following examples, the OpenAPI file is named `openapi/openapi.yaml`.
 
-Now implement your API:
+## Rack middlewares
+OpenapiFirst consists of these Rack middlewares:
+
+- `OpenapiFirst::Router` finds the operation for the current request or returns 404 if no operation was found.
+- `OpenapiFirst::RequestValidation` validates the request against the found operation and returns 400 if the request is invalid.
+- `OpenapiFirst::OperationResolver` calls the [handler](#handlers) found for the operation.
+
+## Usage within your Rack webframework
+If you just want to use the request validation part without any handlers you can use the rack middlewares standalone:
+
+```ruby
+use OpenapiFirst::Router, spec: OpenapiFirst.load('./openapi/openapi.yaml')
+use OpenapiFirst::RequestValidation
+```
+
+### Rack env variables
+These variables will available in your rack env:
+
+- `env[OpenapiFirst::OPERATION]` - Holds an Operation object that responsed about `operation_id` and `path`. This is useful for introspection.
+- `env[OpenapiFirst::INBOX]`. Holds the (filtered) path and query parameters and the parsed request body.
+
+## Standalone usage
+You can implement your API in conveniently with just OpenapiFirst.
 
 ```ruby
 module Pets
@@ -24,7 +43,7 @@ require 'openapi_first'
 run OpenapiFirst.app('./openapi/openapi.yaml', namespace: Pets)
 ```
 
-The above will:
+The above will use the mentioned Rack middlewares to:
 
 - Validate the request and respond with 400 if the request does not match with your API description
 - Map the request to a method call `Pets.find_pet` based on the `operationId` in the API description
@@ -35,48 +54,10 @@ Handler functions (`find_pet`) are called with two arguments:
 - `params` - Holds the parsed request body, filtered query params and path parameters
 - `res` - Holds a Rack::Response that you can modify if needed
   If you want to access to plain Rack env you can call `params.env`.
-  
-## Rack middlewares 
-OpenapiFirst consists of these Rack middlewares:
 
-- `OpenapiFirst::Router` finds the operation for the current request and finds a handler (if namespace option is given)
-- `OpenapiFirst::RequestValidation` validates the request and returns 400 if it's invalid
-- `OpenapiFirst::OperationResolver` calls the handler
+### Handlers
 
-Instead of using `OpenapiFirst.app` you can use these middlwares by itself.
-
-## Usage within your Rack webframework
-If you just want to use the request validation part without any handlers you can use the rack middlewares standalone and don't need to pass a `namespace` option:
-
-```ruby
-use OpenapiFirst::Router, spec: OpenapiFirst.load('./openapi/openapi.yaml')
-use OpenapiFirst::RequestValidation
-```
-
-### Rack env variables
-These variables will available in your rack env:
-
-- `env[OpenapiFirst::OPERATION]` - Holds an Operation object that responsed about `operation_id` and `path`. This is useful for introspection.
-- `env[OpenapiFirst::INBOX]`. Holds the (filtered) path and query parameters and the response body.
-
-## Try it out
-
-See [examples](examples).
-
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'openapi_first'
-```
-
-OpenapiFirst uses [`multi_json`](https://rubygems.org/gems/multi_json).
-
-## Handlers
-
-OpenapiFirst maps the HTTP request to a method call based on the [operationId](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operation-object) in your API description.
+OpenapiFirst maps the HTTP request to a method call based on the [operationId](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operation-object) in your API description and calls it via the `OperationResolver` middleware.
 
 It works like this:
 
@@ -96,6 +77,28 @@ There are two ways to set the response body:
 - Calling `res.write "things"` (see [Rack::Response](https://www.rubydoc.info/github/rack/rack/Rack/Response))
 - Returning a value from the function (see example above) (this will always converted to JSON)
 
+### If your API description does not contain all endpoints
+
+```ruby
+run OpenapiFirst.middleware('./openapi/openapi.yaml', namespace: Pets)
+```
+
+Here all requests that are not part of the API description will be passed to the next app.
+
+### Try it out
+
+See [examples](examples).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openapi_first'
+```
+
+OpenapiFirst uses [`multi_json`](https://rubygems.org/gems/multi_json).
+
 ## Request validation
 
 If the request is not valid, these middlewares return a 400 status code with a body that describes the error.
@@ -151,14 +154,6 @@ validator = OpenapiFirst::ResponseValidator.new(spec)
 expect(validator.validate(last_request, last_response).errors).to be_empty
 ```
 
-## If your API description does not contain all endpoints
-
-```ruby
-run OpenapiFirst.middleware('./openapi/openapi.yaml', namespace: Pets)
-```
-
-Here all requests that are not part of the API description will be passed to the next app.
-
 ## Handling only certain paths
 
 You can filter the URIs that should be handled by passing `only` to `OpenapiFirst.load`:
@@ -168,7 +163,6 @@ spec = OpenapiFirst.load './openapi/openapi.yaml', only: '/pets'.method(:==)
 run OpenapiFirst.app(spec, namespace: Pets)
 ```
 
-
 ## Coverage
 
 (This is a bit experimental. Please try it out and give feedback.)

data/benchmarks/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.9.0)
+    openapi_first (0.10.0)
+      deep_merge (>= 1.2.1)
       hanami-router (~> 2.0.alpha2)
       hanami-utils (~> 2.0.alpha1)
       json_schemer (~> 0.2)
@@ -12,15 +13,15 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.2)
+    activesupport (6.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    benchmark-ips (2.7.2)
+    benchmark-ips (2.8.2)
     benchmark-memory (0.1.2)
       memory_profiler (~> 0.9)
     builder (3.2.4)
@@ -61,7 +62,7 @@ GEM
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    hana (1.3.5)
+    hana (1.3.6)
     hanami-router (2.0.0.alpha2)
       mustermann (~> 1.0)
       mustermann-contrib (~> 1.0)

data/lib/openapi_first/operation.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require_relative 'utils'
 
 module OpenapiFirst
   class Operation
@@ -39,14 +40,31 @@ module OpenapiFirst
     def build_parameters_json_schema
       return unless @operation.parameters&.any?
 
-      @operation.parameters.each_with_object(
+      @operation.parameters.each_with_object(new_node) do |parameter, schema|
+        params = Rack::Utils.parse_nested_query(parameter.name)
+        generate_schema(schema, params, parameter)
+      end
+    end
+
+    def generate_schema(schema, params, parameter)
+      params.each do |key, value|
+        schema['required'] << key if parameter.required
+        if value.is_a? Hash
+          property_schema = new_node
+          generate_schema(property_schema, value, parameter)
+          Utils.deep_merge!(schema['properties'], { key => property_schema })
+        else
+          schema['properties'][key] = parameter.schema
+        end
+      end
+    end
+
+    def new_node
+      {
         'type' => 'object',
         'required' => [],
         'properties' => {}
-      ) do |parameter, schema|
-        schema['required'] << parameter.name if parameter.required
-        schema['properties'][parameter.name] = parameter.schema
-      end
+      }
     end
   end
 end

data/lib/openapi_first/utils.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
 require 'hanami/utils/string'
+require 'deep_merge/core'
 
 module OpenapiFirst
   module Utils
+    def self.deep_merge!(dest, source)
+      DeepMerge.deep_merge!(source, dest)
+    end
+
     def self.underscore(string)
       Hanami::Utils::String.underscore(string)
     end

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/openapi_first.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'deep_merge', '>= 1.2.1'
   spec.add_dependency 'hanami-router', '~> 2.0.alpha2'
   spec.add_dependency 'hanami-utils', '~> 2.0.alpha1'
   spec.add_dependency 'json_schemer', '~> 0.2'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Andreas Haller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: hanami-router
   requirement: !ruby/object:Gem::Requirement