open_api-rspec 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0eaa152838fc212c77475757db2bc43f6578981f2c3d5f798921aec151eff980
-  data.tar.gz: f497e89a621ddbc452caf3fd14724cc0531a16ec2ee7ed91503b1fe45af0c49b
+  metadata.gz: 3741968c9b4462297e6b5133bbfeb867925a9a66ffeb6df80071a0d59092eac2
+  data.tar.gz: 7d1a054818ed563c3dfc0e12c59ff928429e28149090cf63bb4f96d83b75a614
 SHA512:
-  metadata.gz: 5341b04617825182b2a652108a6c182ea52ef0dbe55db9c2e2bb444a3c064cd2331d25693b641ac56406d2ce2a52efe979f8407dc56d78f2b621d881421967c5
-  data.tar.gz: d0fcf7ef8a0f618a0d67524a8ed058e95d74f2069dbe0546512fa6a4964d3312e06a91b65cf9d49da065e87de44bbe32aefe762eed29f3bca0d065a532b5b713
+  metadata.gz: 36034881ca126efae00820d2820e173c2e2eef1416213e43c3b0e5a2994d698d0eef712c3a222966c76e558a4fcf0e6cafbd3dc9e60687786dbb475c1b3b0af6
+  data.tar.gz: 9f1bff37f4299fb0672b5bc1dae5d0df04024e5313dd77752d26f9d620b449b2391c2b73a79e2823d321b456eb1bc932c817ab80866753d012359400e5db8f16

data/.reek.yml

@@ -0,0 +1,64 @@
+---
+detectors:
+  DuplicateMethodCall:
+    exclude:
+    - OpenApi::RSpec::SchemaParser#deep_body_keys
+    - OpenApi::RSpec::SchemaParser#get_deep_keys
+    - OpenApi::RSpec::SchemaParser#initialize
+    - OpenApi::RSpec::SchemaParser#openapi_body_params
+    - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_and_response_status
+    - OpenApi::RSpec::SchemaParser#openapi_form_data_params
+  FeatureEnvy:
+    exclude:
+    - OpenApi::RSpec::SchemaParser#deep_body_keys
+    - OpenApi::RSpec::SchemaParser#get_deep_keys
+    - OpenApi::RSpec::SchemaParser#openapi_required_form_data_params
+    - OpenApi::RSpec::SchemaParser#openapi_required_path_params
+    - OpenApi::RSpec::SchemaParser#openapi_required_query_string_params
+    - OpenApi::RSpec::SchemaParser#openapi_form_data_params
+  NestedIterators:
+    exclude:
+    - OpenApi::RSpec::SchemaParser#deep_body_keys
+    - OpenApi::RSpec::SchemaParser#get_deep_keys
+    - OpenApi::RSpec::SchemaParser#initialize
+    - OpenApi::RSpec::SchemaParser#openapi_body_params
+    - OpenApi::RSpec::SchemaParser#openapi_form_data_params
+  TooManyInstanceVariables:
+    exclude:
+    - OpenApi::RSpec::SchemaParser
+  TooManyMethods:
+    exclude:
+    - OpenApi::RSpec::SchemaParser
+  TooManyStatements:
+    exclude:
+    - initialize
+    - OpenApi::RSpec::SchemaParser#deep_body_keys
+    - OpenApi::RSpec::SchemaParser#get_deep_keys
+    - OpenApi::RSpec::SchemaParser#openapi_body_params
+    - OpenApi::RSpec::SchemaParser#openapi_form_data_params
+  UncommunicativeVariableName:
+    exclude:
+    - OpenApi::RSpec::SchemaParser#get_deep_keys
+    - OpenApi::RSpec::SchemaParser#initialize
+    - OpenApi::RSpec::SchemaParser#openapi_body_params
+    - OpenApi::RSpec::SchemaParser#openapi_form_data_params
+    - OpenApi::RSpec::SchemaParser#openapi_path_params
+    - OpenApi::RSpec::SchemaParser#openapi_query_string_params
+    - OpenApi::RSpec::SchemaParser#openapi_required_form_data_params
+    - OpenApi::RSpec::SchemaParser#openapi_required_path_params
+    - OpenApi::RSpec::SchemaParser#openapi_required_query_string_params
+    - OpenApi::RSpec::SchemaParser#request_path_params
+    - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_body_parameters
+    - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_form_data_parameters
+    - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_path_parameters
+    - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_query_string_parameters
+  UtilityFunction:
+    exclude:
+    - OpenApi::RSpec::SchemaParser#has_documented_param_in_openapi_url_fragments
+    - OpenApi::RSpec::SchemaParser#openapi_url_fragment_name
+
+  IrresponsibleModule:
+    enabled: false
+
+exclude_paths:
+  - vendor/bundle

data/.rubocop_todo.yml

@@ -18,7 +18,7 @@ Metrics/AbcSize:
 # Offense count: 6
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 56
+  Max: 73
 
 # Offense count: 1
 # Configuration parameters: CountBlocks.
@@ -28,7 +28,7 @@ Metrics/BlockNesting:
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 183
+  Max: 192
 
 # Offense count: 1
 Metrics/CyclomaticComplexity:
@@ -67,3 +67,6 @@ Style/NumericPredicate:
   Exclude:
     - 'spec/**/*'
     - 'lib/open_api/rspec/schema_parser.rb'
+
+RSpec/SharedExamples:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    open_api-rspec (0.1.5)
+    open_api-rspec (0.1.6)
       activesupport
       open_api-schema_validator
       rspec
@@ -9,22 +9,22 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.1.5)
-      actionview (= 5.1.5)
-      activesupport (= 5.1.5)
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
       rack (~> 2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.5)
-      activesupport (= 5.1.5)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.1.5)
+    activesupport (5.2.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.5.2)
@@ -34,33 +34,35 @@ GEM
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
-    brakeman (4.2.0)
+    brakeman (4.3.1)
     builder (3.2.3)
     bundler-audit (0.6.0)
       bundler (~> 1.2)
       thor (~> 0.18)
-    byebug (10.0.0)
+    byebug (10.0.2)
     codeclimate-engine-rb (0.4.1)
       virtus (~> 1.0)
     coderay (1.1.2)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     concurrent-ruby (1.0.5)
-    crass (1.0.3)
+    crass (1.0.4)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
-    docile (1.1.5)
+    docile (1.3.1)
     equalizer (0.0.11)
-    erubi (1.7.0)
-    httparty (0.16.0)
+    erubi (1.7.1)
+    httparty (0.16.2)
       multi_xml (>= 0.5.2)
-    i18n (0.9.5)
+    i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
+    jaro_winkler (1.5.1)
     json (2.1.0)
     json-schema (2.8.0)
       addressable (>= 2.4)
+    kwalify (0.7.2)
     lois (0.1.6)
       activesupport
       brakeman
@@ -70,21 +72,21 @@ GEM
       rubocop
       simplecov
       thor
-    loofah (2.2.0)
+    loofah (2.2.2)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (0.9.0)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
     multi_xml (0.6.0)
-    nokogiri (1.8.2)
+    nokogiri (1.8.4)
       mini_portile2 (~> 2.3.0)
     open_api-schema_validator (0.1.0)
       json-schema
     parallel (1.12.1)
-    parser (2.4.0.2)
-      ast (~> 2.3)
-    powerpack (0.1.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -92,21 +94,21 @@ GEM
       byebug (~> 10.0)
       pry (~> 0.10)
     public_suffix (3.0.2)
-    rack (2.0.4)
-    rack-test (0.8.2)
+    rack (2.0.5)
+    rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.3)
-      loofah (~> 2.0)
-    rainbow (2.2.2)
-      rake
-    rake (12.3.0)
-    reek (4.7.3)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rainbow (3.0.0)
+    rake (12.3.1)
+    reek (5.0.2)
       codeclimate-engine-rb (~> 0.4.0)
-      parser (>= 2.4.0.0, < 2.5)
-      rainbow (~> 2.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.6, != 2.5.1.1)
+      rainbow (>= 2.0, < 4.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -120,18 +122,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    rubocop (0.52.1)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.4.0.2, < 3.0)
+      parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (1.23.0)
-      rubocop (>= 0.52.1)
+    rubocop-rspec (1.27.0)
+      rubocop (>= 0.56.0)
     ruby-progressbar (1.9.0)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
@@ -139,7 +142,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.3.0)
+    unicode-display_width (1.4.0)
     virtus (1.0.5)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
@@ -162,4 +165,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/lib/open_api/rspec/schema_parser.rb

@@ -138,7 +138,16 @@ module OpenApi
       end
 
       def openapi_form_data_params
-        schema_for_url_and_request_method_form_data_parameters.map { |p| p['name'].to_s }
+        schema_for_url_and_request_method_form_data_parameters.flat_map do |p|
+          if p['schema'].present?
+            keys = p['schema']['properties'].flat_map do |k, v|
+              deep_body_keys(k, v)
+            end
+            keys.map { |key| "#{p['name']}##{key}" }
+          else
+            p['name'].to_s
+          end
+        end
       end
 
       def openapi_body_params

data/lib/open_api/rspec/shared_examples.rb

@@ -8,45 +8,69 @@ module OpenApi
         let(:schema_parser) { OpenApi::RSpec::SchemaParser.new(schema_hash, request, response) }
 
         it 'has openapi documentation for url' do
-          expect(schema_parser.schema_for_url).not_to be_nil
+          expect(schema_parser.schema_for_url).not_to(
+            be_nil,
+            'url not documented'
+          )
         end
 
         it 'matches an allowed http request method' do
-          expect(schema_parser.schema_for_url_and_request_method).not_to be_nil
+          expect(schema_parser.schema_for_url_and_request_method).not_to(
+            be_nil,
+            'http method for url not documented'
+          )
         end
 
         it 'has all required request query parameters' do
           schema_parser.openapi_required_query_string_params.each do |openapi_param|
-            expect(schema_parser.request_params).to include(openapi_param)
+            expect(schema_parser.request_params).to(
+              include(openapi_param),
+              'missing required request query parameters'
+            )
           end
         end
 
         it 'has all required request path parameters' do
           schema_parser.openapi_required_path_params.each do |openapi_param|
-            expect(schema_parser.request_path_params).to include(openapi_param)
+            expect(schema_parser.request_path_params).to(
+              include(openapi_param),
+              'missing required request path parameters'
+            )
           end
         end
 
         it 'has all required request form data parameters' do
           schema_parser.openapi_required_form_data_params.each do |openapi_param|
-            expect(schema_parser.request_params).to include(openapi_param)
+            expect(schema_parser.request_params).to(
+              include(openapi_param),
+              'missing required request form data parameters'
+            )
           end
         end
 
         it 'does not allow undocumented request path parameters' do
           schema_parser.request_path_params.each do |request_param|
-            expect(schema_parser.openapi_path_params).to include(request_param)
+            expect(schema_parser.openapi_path_params).to(
+              include(request_param),
+              "#{request_param} is an undocumented request path parameter"
+            )
           end
         end
 
         it 'does not allow undocumented request parameters' do
           schema_parser.request_params.each do |request_param|
-            expect(schema_parser.openapi_request_params).to include(request_param)
+            expect(schema_parser.openapi_request_params).to(
+              include(request_param),
+              "#{request_param} is an undocumented request parameter"
+            )
           end
         end
 
         it 'matches an allowed http response status' do
-          expect(schema_parser.schema_for_url_and_request_method_and_response_status).not_to be_nil
+          expect(schema_parser.schema_for_url_and_request_method_and_response_status).not_to(
+            be_nil,
+            'http response status not documented'
+          )
         end
         it 'matches the response schema' do
           response_schema = schema_parser.schema_for_url_and_request_method_and_response_status
@@ -60,7 +84,7 @@ module OpenApi
                       response_schema
                     end
 
-          expect(results).to be_truthy
+          expect(results).to be_truthy, 'response does not match documented schema'
         end
       end
     end

data/lib/open_api/rspec/version.rb

@@ -2,6 +2,6 @@
 
 module OpenApi
   module RSpec
-    VERSION = '0.1.5'
+    VERSION = '0.1.6'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_api-rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Ryan Hansen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2018-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -186,7 +186,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".reek"
+- ".reek.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -228,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: RSpec matchers and shared examples for OpenApi

data/.reek

@@ -1,59 +0,0 @@
----
-DuplicateMethodCall:
-  exclude:
-  - OpenApi::RSpec::SchemaParser#deep_body_keys
-  - OpenApi::RSpec::SchemaParser#get_deep_keys
-  - OpenApi::RSpec::SchemaParser#initialize
-  - OpenApi::RSpec::SchemaParser#openapi_body_params
-  - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_and_response_status
-FeatureEnvy:
-  exclude:
-  - OpenApi::RSpec::SchemaParser#deep_body_keys
-  - OpenApi::RSpec::SchemaParser#get_deep_keys
-  - OpenApi::RSpec::SchemaParser#openapi_required_form_data_params
-  - OpenApi::RSpec::SchemaParser#openapi_required_path_params
-  - OpenApi::RSpec::SchemaParser#openapi_required_query_string_params
-NestedIterators:
-  exclude:
-  - OpenApi::RSpec::SchemaParser#deep_body_keys
-  - OpenApi::RSpec::SchemaParser#get_deep_keys
-  - OpenApi::RSpec::SchemaParser#initialize
-  - OpenApi::RSpec::SchemaParser#openapi_body_params
-TooManyInstanceVariables:
-  exclude:
-  - OpenApi::RSpec::SchemaParser
-TooManyMethods:
-  exclude:
-  - OpenApi::RSpec::SchemaParser
-TooManyStatements:
-  exclude:
-  - initialize
-  - OpenApi::RSpec::SchemaParser#deep_body_keys
-  - OpenApi::RSpec::SchemaParser#get_deep_keys
-  - OpenApi::RSpec::SchemaParser#openapi_body_params
-UncommunicativeVariableName:
-  exclude:
-  - OpenApi::RSpec::SchemaParser#get_deep_keys
-  - OpenApi::RSpec::SchemaParser#initialize
-  - OpenApi::RSpec::SchemaParser#openapi_body_params
-  - OpenApi::RSpec::SchemaParser#openapi_form_data_params
-  - OpenApi::RSpec::SchemaParser#openapi_path_params
-  - OpenApi::RSpec::SchemaParser#openapi_query_string_params
-  - OpenApi::RSpec::SchemaParser#openapi_required_form_data_params
-  - OpenApi::RSpec::SchemaParser#openapi_required_path_params
-  - OpenApi::RSpec::SchemaParser#openapi_required_query_string_params
-  - OpenApi::RSpec::SchemaParser#request_path_params
-  - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_body_parameters
-  - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_form_data_parameters
-  - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_path_parameters
-  - OpenApi::RSpec::SchemaParser#schema_for_url_and_request_method_query_string_parameters
-UtilityFunction:
-  exclude:
-  - OpenApi::RSpec::SchemaParser#has_documented_param_in_openapi_url_fragments
-  - OpenApi::RSpec::SchemaParser#openapi_url_fragment_name
-
-IrresponsibleModule:
-  enabled: false
-
-exclude_paths:
-  - vendor/bundle