openapi_first 0.7.0.alpha1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4885473ec6373b0fcfd9baace6175296f362099ba8ee73de0b8c1538b3420504
-  data.tar.gz: 5a72ae579e67bcb17c33debb3adbcae1cdaae09ad98ccc0e1158a59719d00115
+  metadata.gz: 3628fb4b2c3839480899102cfa770b7dc5fbed43503689a475e3e969dc1f8c13
+  data.tar.gz: 27fd6a6c02cd48a56e99e9e6bb7c8edc9ccbc5a0423d59c9186ec1ea3e2daecd
 SHA512:
-  metadata.gz: d2783c23798622b8bcc6c6f9520272d0477760d405f9879d4dc39e94b1d361b3873a87147ccef81e0ba3ec5c59e67941f645e41caf52dd221ddb915167140c6d
-  data.tar.gz: d540387f504454feca50ea746ef87745aed68e841bc5eb734c8d2e3419676e221a8dd93404601f010e3725152cd0e0e9a2775a1646690b8f4e5b62fbd8d7ca93
+  metadata.gz: e7577b4277603b753ad5b30970c1f479e9c16843400636b6718730459a8f5b1847a12d78b4582ed72d4431e9a45d9d7f1b850e39575cf08da927470a839eb371
+  data.tar.gz: 8afb057b842fe5759878f8f6b1a4ea16bbf223bdcfcd0823dd99715b3ba3ff492be7dbf2257868fb252a14c90f820942576b3e975e394287a349c3e493277358

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2 
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.rubocop.yml

@@ -1,11 +1,19 @@
 AllCops:
   TargetRubyVersion: 2.6
-Documentation:
+Style/Documentation:
   Enabled: false
-BlockLength:
+Style/ExponentialNotation:
+  Enabled: true
+Metrics/BlockLength:
   Exclude:
   - 'spec/**/*.rb'
   - '*.gemspec'
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
 Style/HashEachMethods:
   Enabled: false
 Style/HashTransformKeys:

data/CHANGELOG.md

@@ -1,12 +1,19 @@
 # Changelog
 
-## Unreleased
+## 0.7.1
+- Add missing `require` to work with new version of `oas_parser`
 
+## 0.7.0
 - Make use of hanami-router, because it's fast
-- Remove OpenapiFirst::Coverage
 - Remove option `allow_unknown_query_paramerters`
 - Move the namespace option to Router
-- Convert numeric parameters to `Integer` or `Float`
+- Convert numeric path and query parameters  to `Integer` or `Float`
+- Pass the Rack env if your action class' initializers accepts an argument
+- Respec rack's `env['SCRIPT_NAME']` in router
+- Add MIT license
+
+## 0.6.10
+- Bugfix: params.env['unknown'] now returns `nil` as expected. Thanks @tristandruyen.
 
 ## 0.6.9
 - Removed radix tree, because of a bug (https://github.com/namusyaka/r2ree-ruby/issues/2)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapi_first (0.7.0.alpha1)
+    openapi_first (0.7.1)
       hanami-router (~> 2.0.alpha2)
       hanami-utils (~> 2.0.alpha1)
       json_schemer (~> 0.2)
@@ -26,7 +26,7 @@ GEM
     concurrent-ruby (1.1.6)
     deep_merge (1.2.1)
     diff-lcs (1.3)
-    ecma-re-validator (0.2.0)
+    ecma-re-validator (0.2.1)
       regexp_parser (~> 1.2)
     hana (1.3.5)
     hanami-router (2.0.0.alpha2)
@@ -57,7 +57,7 @@ GEM
       mustermann (= 1.1.1)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    oas_parser (0.24.0)
+    oas_parser (0.25.0)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)
@@ -66,12 +66,12 @@ GEM
       mustermann-contrib (~> 1.1.1)
       nokogiri
     parallel (1.19.1)
-    parser (2.7.0.5)
+    parser (2.7.1.1)
       ast (~> 2.4.0)
-    pry (0.13.0)
+    pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.3)
+    public_suffix (4.0.4)
     rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -92,21 +92,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.2)
-    rubocop (0.80.1)
+    rubocop (0.82.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       rexml
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
     ruby-progressbar (1.10.1)
     ruby2_keywords (0.0.2)
     thread_safe (0.3.6)
     transproc (1.1.1)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
+    unicode-display_width (1.7.0)
     uri_template (0.7.0)
     zeitwerk (2.3.0)
 

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andreas Haller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -78,7 +78,7 @@ It works like this:
 
 - "create_pet" or "createPet" or "create pet" calls `MyApi.create_pet(params, response)`
 - "some_things.create" calls: `MyApi::SomeThings.create(params, response)`
-- "pets#create" calls: `MyApi::Pets::Create.new.call(params, response)`
+- "pets#create" calls: `MyApi::Pets::Create.new.call(params, response)` If `MyApi::Pets::Create.new` accepts an argument, it will pass the rack `env`.
 
 These handler methods are called with two arguments:
 

data/benchmarks/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    openapi_first (0.7.0.alpha1)
+    openapi_first (0.7.1)
       hanami-router (~> 2.0.alpha2)
       hanami-utils (~> 2.0.alpha1)
       json_schemer (~> 0.2)
@@ -12,7 +12,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.1)
+    activesupport (6.0.2.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -30,7 +30,7 @@ GEM
       rack (>= 1.5)
     concurrent-ruby (1.1.6)
     deep_merge (1.2.1)
-    dry-configurable (0.11.3)
+    dry-configurable (0.11.5)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
       dry-equalizer (~> 0.2)
@@ -52,9 +52,9 @@ GEM
       dry-equalizer (~> 0.3)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    ecma-re-validator (0.2.0)
+    ecma-re-validator (0.2.1)
       regexp_parser (~> 1.2)
-    grape (1.3.0)
+    grape (1.3.2)
       activesupport
       builder
       dry-types (>= 1.1)
@@ -92,7 +92,7 @@ GEM
       mustermann (>= 1.0.0)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    oas_parser (0.24.0)
+    oas_parser (0.25.0)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)
@@ -100,8 +100,8 @@ GEM
       hash-deep-merge
       mustermann-contrib (~> 1.1.1)
       nokogiri
-    openapi_parser (0.8.0)
-    public_suffix (4.0.3)
+    openapi_parser (0.10.0)
+    public_suffix (4.0.4)
     rack (2.2.2)
     rack-accept (0.4.5)
       rack (>= 0.4)
@@ -121,7 +121,7 @@ GEM
     thread_safe (0.3.6)
     tilt (2.0.10)
     transproc (1.1.1)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     uri_template (0.7.0)
     zeitwerk (2.3.0)

data/lib/openapi_first.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'oas_parser/path' # TODO: Remove when Nexmo/oas_parser/pull/49 is merged
 require 'oas_parser'
 require 'openapi_first/definition'
 require 'openapi_first/version'
@@ -46,5 +47,5 @@ module OpenapiFirst
   end
 
   class Error < StandardError; end
-  # Your code goes here...
+  class ResponseCodeNotFoundError < Error; end
 end

data/lib/openapi_first/operation.rb

@@ -28,6 +28,10 @@ module OpenapiFirst
                 .response_by_code(status.to_s, use_default: true)
                 .content
       content.keys[0] if content
+    rescue OasParser::ResponseCodeNotFound
+      operation_name = "#{method.upcase} #{path}"
+      message = "Response status code or default not found: #{status} for '#{operation_name}'" # rubocop:disable Layout/LineLength
+      raise OpenapiFirst::ResponseCodeNotFoundError, message
     end
 
     private

data/lib/openapi_first/operation_resolver.rb

@@ -37,7 +37,7 @@ module OpenapiFirst
 
     def initialize(env)
       @env = env
-      super
+      super()
     end
   end
 end

data/lib/openapi_first/router.rb

@@ -16,9 +16,8 @@ module OpenapiFirst
     end
 
     def call(env)
-      route = @router.recognize(env)
-      return route.endpoint.call(env) if route.routable?
-
+      endpoint = find_endpoint(env)
+      return endpoint.call(env) if endpoint
       return @parent_app.call(env) if @parent_app
 
       NOT_FOUND
@@ -37,7 +36,11 @@ module OpenapiFirst
         module_name, klass_name = name.split('#')
         const = find_const(@namespace, module_name)
         klass = find_const(const, klass_name)
-        return ->(params, res) { klass.new.call(params, res) }
+        if klass.instance_method(:initialize).arity.zero?
+          return ->(params, res) { klass.new.call(params, res) }
+        end
+
+        return ->(params, res) { klass.new(params.env).call(params, res) }
       end
       method_name = Utils.underscore(name)
       return unless @namespace.respond_to?(method_name)
@@ -47,6 +50,15 @@ module OpenapiFirst
 
     private
 
+    def find_endpoint(env)
+      original_path_info = env[Rack::PATH_INFO]
+      # Overwrite PATH_INFO temporarily, because hanami-router does not respect SCRIPT_NAME # rubocop:disable Layout/LineLength
+      env[Rack::PATH_INFO] = Rack::Request.new(env).path
+      @router.recognize(env).endpoint
+    ensure
+      env[Rack::PATH_INFO] = original_path_info
+    end
+
     def find_const(parent, name)
       name = Utils.classify(name)
       return unless parent.const_defined?(name, false)
@@ -64,7 +76,7 @@ module OpenapiFirst
         end
         handler = find_handler(operation.operation_id)
         if handler.nil?
-          warn "could not find handler for '#{operation.operation_id}' (#{operation.method} #{operation.path}). I am ignoring this operation." # rubocop:disable Layout/LineLength
+          warn "#{self.class.name} cannot not find handler for '#{operation.operation_id}' (#{operation.method} #{operation.path}). This operation will be ignored." # rubocop:disable Layout/LineLength
           next
         end
         router.public_send(

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '0.7.0.alpha1'
+  VERSION = '0.7.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 0.7.0.alpha1
+  version: 0.7.1
 platform: ruby
 authors:
 - Andreas Haller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2020-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-router
@@ -158,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -165,6 +166,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
 - benchmarks/Gemfile
@@ -216,9 +218,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: