open_api-rspec 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39fda32f5c1341425ca23a185ad1a9cf8d62e591567adfef9e7a5621c9d9f7e2
-  data.tar.gz: c93b366624b64e013706b4c2a61a55c987ca470b489ba1f43ad091d5e7a12f15
+  metadata.gz: d794023cd314671660f9a383a6a5eaca9b594a670c1faf32057769c6dc4ac155
+  data.tar.gz: 85876684fd5f99d9d8fec1b8cebc56308a5075af61e8ff9d156805fc92971c43
 SHA512:
-  metadata.gz: ca13abf00e42c2ca012d8aecf028292a6783fa80f2685e560b47fdc1cc4da8adfdba506112ea338107d345c8acb020c7961ca023ac02d36ab4326f03a3346362
-  data.tar.gz: 12d8f912c228f0b24cf6f949e1ad05da5e307ca490f91b50de1007c9590ccd5479c3e70c571095bcae1f3b98bacc02db97374b23cb2f5ef82a7f33c222d80ac0
+  metadata.gz: 4cccf63d318af2996d9969537ecab716f4db2f9220fbf8d152f612b0443b34ffade3a0113cf961ceb05550dcf5cea32e68612775e8ff1ff80ae91e3e7371dee2
+  data.tar.gz: 912f041ca7834b155572c472dbbef6c755df25aba4189c686d9619205a5df9f80ca2958906d8db103d7693da75f166b11299e3f244004390acbc39f102ac3603

data/Gemfile.lock

@@ -1,13 +1,27 @@
 PATH
   remote: .
   specs:
-    open_api-rspec (0.1.1)
+    open_api-rspec (0.1.4)
+      activesupport
       open_api-schema_validator
       rspec
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (5.1.5)
+      actionview (= 5.1.5)
+      activesupport (= 5.1.5)
+      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)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
     activesupport (5.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
@@ -21,6 +35,7 @@ GEM
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
     brakeman (4.2.0)
+    builder (3.2.3)
     bundler-audit (0.6.0)
       bundler (~> 1.2)
       thor (~> 0.18)
@@ -31,11 +46,13 @@ GEM
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     concurrent-ruby (1.0.5)
+    crass (1.0.3)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
     docile (1.1.5)
     equalizer (0.0.11)
+    erubi (1.7.0)
     httparty (0.16.0)
       multi_xml (>= 0.5.2)
     i18n (0.9.5)
@@ -53,9 +70,15 @@ GEM
       rubocop
       simplecov
       thor
+    loofah (2.2.0)
+      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)
+      mini_portile2 (~> 2.3.0)
     open_api-schema_validator (0.1.0)
       json-schema
     parallel (1.12.1)
@@ -69,6 +92,14 @@ GEM
       byebug (~> 10.0)
       pry (~> 0.10)
     public_suffix (3.0.2)
+    rack (2.0.4)
+    rack-test (0.8.2)
+      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)
@@ -119,6 +150,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  actionpack
   bundler
   lois
   open_api-rspec!

data/README.md

@@ -1,4 +1,4 @@
-# OpenApi::Rspec [![Build Status](https://travis-ci.org/ketiko/open_api-rspec.svg?branch=master)](https://travis-ci.org/ketiko/open_api-rspec)
+# OpenApi::RSpec [![Build Status](https://travis-ci.org/ketiko/open_api-rspec.svg?branch=master)](https://travis-ci.org/ketiko/open_api-rspec)
 
 RSpec matchers and shared examples for OpenApi
 
@@ -20,6 +20,21 @@ Or install it yourself as:
 
 ## Usage
 
+Add a file with the following:
+
+```ruby
+#file: spec/support/openapi_schema.rb
+
+RSpec.shared_context "Shared OpenAPI JSON" do
+  let(:open_api_json) { '{my open api json schema'} }
+end
+
+RSpec.configure do |rspec|
+  rspec.include_context "Shared OpenAPI JSON", type: :request
+  rspec.include_context "Shared OpenAPI JSON", type: :controller
+end
+```
+
 Test if your swagger.json endpoint is a valid schema.
 
 ```ruby
@@ -72,20 +87,6 @@ RSpec.describe UsersController, type: :request do
 end
 ```
 
-Note for the endpoint matcher to work you must declare something like the following:
-
-```ruby
-#file: spec/support/openapi_schema.rb
-
-RSpec.shared_context "Shared OpenAPI JSON" do
-  let(:open_api_json) { '{my open api json schema'} }
-end
-
-RSpec.configure do |rspec|
-  rspec.include_context "Shared OpenAPI JSON", type: :request
-end
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/open_api/rspec.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 require 'rspec'
+require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/hash/indifferent_access'
 require 'open_api/schema_validator'
 require 'open_api/rspec/version'
 require 'open_api/rspec/schema_parser'
-require 'open_api/rspec/matchers/open_api'
-require 'open_api/rspec/shared_examples/open_api'
+require 'open_api/rspec/matchers'
+require 'open_api/rspec/shared_examples'
 
 module OpenApi
-  module Rspec
+  module RSpec
   end
 end

data/lib/open_api/rspec/matchers.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OpenApi
+  module RSpec
+    module Matchers
+      ::RSpec::Matchers.define :match_openapi_response_schema do |schema|
+        match do |response|
+          ::OpenApi::SchemaValidator.validate_schema!(
+            open_api_json,
+            response.is_a?(Hash) ? response : ::JSON.parse(response.body),
+            fragment: "#/definitions/#{schema}"
+          )
+        end
+      end
+
+      ::RSpec::Matchers.define :be_valid_openapi_schema do
+        match do |string|
+          json = ::JSON.parse(string)
+          ::OpenApi::SchemaValidator.validate!(json)
+        end
+      end
+    end
+  end
+end

data/lib/open_api/rspec/{shared_examples/open_api.rb → shared_examples.rb}

@@ -5,7 +5,7 @@ module OpenApi
     module SharedExamples
       ::RSpec.shared_examples_for :an_openapi_endpoint do
         let(:schema_hash) { ::JSON.parse(open_api_json) }
-        let(:schema_parser) { SchemaParser.new(schema_hash, request, response) }
+        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
@@ -50,11 +50,11 @@ module OpenApi
         end
         it 'matches the response schema' do
           response_schema = schema_parser.schema_for_url_and_request_method_and_response_status
-          results = if response_schema[:schema]
+          results = if response_schema['schema']
                       ::OpenApi::SchemaValidator.validate_schema!(
                         schema_hash,
                         ::JSON.parse(response.body),
-                        fragment: response_schema[:schema][:$ref]
+                        fragment: response_schema['schema']['$ref']
                       )
                     else
                       response_schema

data/lib/open_api/rspec/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module OpenApi
-  module Rspec
-    VERSION = '0.1.1'
+  module RSpec
+    VERSION = '0.1.4'
   end
 end

data/open_api-rspec.gemspec

@@ -5,7 +5,7 @@ require "open_api/rspec/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "open_api-rspec"
-  spec.version       = OpenApi::Rspec::VERSION
+  spec.version       = OpenApi::RSpec::VERSION
   spec.authors       = ["Ryan Hansen"]
   spec.email         = ["ketiko@gmail.com"]
 
@@ -28,7 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'actionpack'
 
   spec.add_dependency 'rspec'
   spec.add_dependency 'open_api-schema_validator'
+  spec.add_dependency 'activesupport'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_api-rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Ryan Hansen
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: RSpec matchers and shared examples for OpenApi
 email:
 - ketiko@gmail.com
@@ -176,9 +204,9 @@ files:
 - bin/rubocop
 - bin/setup
 - lib/open_api/rspec.rb
-- lib/open_api/rspec/matchers/open_api.rb
+- lib/open_api/rspec/matchers.rb
 - lib/open_api/rspec/schema_parser.rb
-- lib/open_api/rspec/shared_examples/open_api.rb
+- lib/open_api/rspec/shared_examples.rb
 - lib/open_api/rspec/version.rb
 - open_api-rspec.gemspec
 homepage: https://github.com/ketiko/open_api-rspec

data/lib/open_api/rspec/matchers/open_api.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module OpenApi
-  module RSpec
-    module Matchers
-      module OpenApi
-        ::RSpec::Matchers.define :match_openapi_response_schema do |schema|
-          match do |response|
-            ::OpenApi::SchemaValidator.validate_schema!(
-              SwaggerSchema.to_h,
-              response.is_a?(Hash) ? response : ::JSON.parse(response.body),
-              fragment: "#/definitions/#{schema}"
-            )
-          end
-        end
-
-        ::RSpec::Matchers.define :be_valid_openapi_schema do
-          match do |string|
-            json = ::JSON.parse(string)
-            ::OpenApi::SchemaValidator.validate!(json)
-          end
-        end
-      end
-    end
-  end
-end