apivore 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: e65e5c0dae07a51ff67726b32b3e6a244d3f4a88
-  data.tar.gz: bd8bf1e39471e1671044321177cb12230a0a04e1
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWNjOGI2MTJjZjgyM2M5MjRiYjA1ODg4YTA1MmRkOWY0YTlkYzlmNw==
+  data.tar.gz: !binary |-
+    N2JjZWIzYTlhN2UyNTNhNjJkMDZiYjIxNTA4NWYzY2FiNGYxM2RjYw==
 SHA512:
-  metadata.gz: 9b72501bc2be6fb51da035c5527ed4d9c0b2518820e4801ad8b53e9c111aa0aee5ef8d3a3ecd456a7a5db88968536385bdbeba19c88174886f138e143a9a4a5e
-  data.tar.gz: f6b065b7d68128e4d36206555c5b5d96864ea85adf9163775bb00c1d40f7fcf1bc8362908c1e72dfe3ad3996a170e408e0d503b6079ceef1d16138f431574b97
+  metadata.gz: !binary |-
+    Y2NhZDZiYTdmNWNlYzYwMWRkZTVlMDkyZmQwMWI4OTdkNGE1NTU0YjY5Mzgy
+    ZGU4NWI3MjA4YjBjMWYwZWM3MDc0Mjk2ODc5YjRhODhhMmQxYzg0ODJjMWFl
+    Zjk4YzdhMTljMzI2YTRjNWMwMGNlY2RhNmM5NTZhNDlhNWI2YzA=
+  data.tar.gz: !binary |-
+    NDI1NjQyODRlYzZhZjFjN2UxODZmZGMzN2Y4MjBmMDc3NjI0Yzc2OTNhNTBm
+    M2Y1YjUxZGY0OWRmZGFiZTc0ZTcwZjVkZTFjOTI0MzU2YTgyMDEwYzA5YTY4
+    YzNkZmY1NDQ2MDE5Y2UxNDM2NGY3MzAyMzI4NWRiZDRkNDM2Yjc=

data/lib/apivore.rb

@@ -1,48 +1,10 @@
-require 'apivore/rspec_builder'
 require 'apivore/rspec_matchers'
-
-module Apivore
-  class Swagger < Hashie::Mash
-
-    def validate
-      case version
-      when '2.0'
-        schema = File.read(File.expand_path("../../data/swagger_2.0_schema.json", __FILE__))
-      else
-        raise "Unknown/unsupported Swagger version to validate against: #{version}"
-      end
-      JSON::Validator.fully_validate(schema, self)
-    end
-
-    def version
-      swagger
-    end
-
-    def base_path
-      self['basePath'] || ''
-    end
-
-    def each_response(&block)
-      paths.each do |path, path_data|
-        path_data.each do |verb, method_data|
-          raise "No responses found in swagger for path '#{path}', method #{verb}: #{method_data.inspect}" if method_data.responses.nil?
-          method_data.responses.each do |response_code, response_data|
-            schema_location = nil
-            if response_data.schema
-              schema_location = Fragment.new ['#', 'paths', path, verb, 'responses', response_code, 'schema']
-            end
-            block.call(path, verb, response_code, schema_location)
-          end
-        end
-      end
-    end
-  end
-
-  # This is a workaround for json-schema's fragment validation which does not allow paths to contain forward slashes
-  #  current json-schema attempts to split('/') on a string path to produce an array.
-  class Fragment < Array
-    def split(options = nil)
-      self
-    end
-  end
+require 'apivore/rspec_helpers'
+require 'apivore/swagger_checker'
+require 'apivore/swagger'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.include Apivore::RspecMatchers, type: :apivore
+  config.include Apivore::RspecHelpers, type: :apivore
 end

data/lib/apivore/all_routes_tested_validator.rb

@@ -0,0 +1,25 @@
+module Apivore
+  class AllRoutesTestedValidator
+
+    def matches?(swagger_checker)
+      @errors = []
+      swagger_checker.mappings.each do |path, methods|
+        methods.each do |method, codes|
+          codes.each do |code, _|
+            @errors << "#{method} #{path} is untested for response code #{code}"
+          end
+        end
+      end
+
+      @errors.empty?
+    end
+
+    def description
+      "have tested all documented routes"
+    end
+
+    def failure_message
+      @errors.join("\n")
+    end
+  end
+end

data/lib/apivore/fragment.rb

@@ -0,0 +1,9 @@
+module Apivore
+  # This is a workaround for json-schema's fragment validation which does not allow paths to contain forward slashes
+  #  current json-schema attempts to split('/') on a string path to produce an array.
+  class Fragment < Array
+    def split(options = nil)
+      self
+    end
+  end
+end

data/lib/apivore/rspec_helpers.rb

@@ -0,0 +1,14 @@
+require 'apivore/validator'
+require 'apivore/all_routes_tested_validator'
+
+module Apivore
+  module RspecHelpers
+    def validate(method, path, response_code, params = {})
+      Validator.new(method, path, response_code, params)
+    end
+
+    def validate_all_paths
+      AllRoutesTestedValidator.new
+    end
+  end
+end

data/lib/apivore/rspec_matchers.rb

@@ -5,41 +5,11 @@ require 'net/http'
 module Apivore
   module RspecMatchers
     extend RSpec::Matchers::DSL
-    matcher :be_valid_swagger do |version|
-      match do |body|
-        @api_description = Swagger.new(JSON.parse(body))
-        @errors = @api_description.validate
-        @errors.empty?
-      end
-
-      failure_message do |body|
-        msg = "The document fails to validate as Swagger #{@api_description.version}:\n"
-        msg += @errors.join("\n")
-      end
-    end
-
-    matcher :have_models_for_all_get_endpoints do
-      match do |body|
-        @errors = []
-        swagger = Swagger.new(JSON.parse(body))
-        swagger.each_response do |path, method, response_code, schema|
-          if method == 'get' && !schema
-            @errors << "Unable to find a valid model for #{path} get #{response_code} response."
-          end
-        end
-        @errors.empty?
-      end
-
-      failure_message do
-        @errors.join("\n")
-      end
-    end
-
-    matcher :be_consistent_with_swagger_definitions do |master_swagger, current_service|
+    matcher :be_consistent_with_swagger_definitions do |master_swagger_host, current_service|
 
       attr_reader :actual, :expected
 
-      def cleaned_definitions(definitions, current_service)
+      define_method :cleaned_definitions do |definitions, current_service|
         definitions.each do |key, definition_fields|
           # We ignore definitions that are owned exclusively by the current_service
           if [current_service] == definition_fields['x-services']
@@ -52,8 +22,17 @@ module Apivore
         end.select{ |_, value| !value.nil? }
       end
 
-      match do |body|
-        our_swagger = JSON.parse(body)
+      define_method :fetch_master_swagger do
+        req = Net::HTTP.get(master_swagger_host, "/swagger.json")
+        JSON.parse(req)
+      end
+
+      define_method :master_swagger do
+        @master_swagger ||= fetch_master_swagger
+      end
+
+      match do |swagger_checker|
+        our_swagger = swagger_checker.swagger
         master_definitions = cleaned_definitions(master_swagger["definitions"], current_service)
         our_definitions = our_swagger["definitions"]
         @actual = our_definitions.slice(*master_definitions.keys)
@@ -63,17 +42,5 @@ module Apivore
 
       diffable
     end
-
-    matcher :conform_to_the_documented_model_for do |swagger, fragment|
-      match do |body|
-        body = JSON.parse(body)
-        @errors = JSON::Validator.fully_validate(swagger, body, fragment: fragment)
-        @errors.empty?
-      end
-
-      failure_message do |body|
-        @errors.map { |e| e.sub("'#", "'#{path}#").gsub(/^The property|in schema.*$/,'') }.join("\n")
-      end
-    end
   end
 end

data/lib/apivore/swagger.rb

@@ -0,0 +1,41 @@
+require 'hashie'
+
+require 'apivore/fragment'
+
+module Apivore
+  class Swagger < Hashie::Mash
+
+    def validate
+      case version
+      when '2.0'
+        schema = File.read(File.expand_path("../../../data/swagger_2.0_schema.json", __FILE__))
+      else
+        raise "Unknown/unsupported Swagger version to validate against: #{version}"
+      end
+      JSON::Validator.fully_validate(schema, self)
+    end
+
+    def version
+      swagger
+    end
+
+    def base_path
+      self['basePath'] || ''
+    end
+
+    def each_response(&block)
+      paths.each do |path, path_data|
+        path_data.each do |verb, method_data|
+          raise "No responses found in swagger for path '#{path}', method #{verb}: #{method_data.inspect}" if method_data.responses.nil?
+          method_data.responses.each do |response_code, response_data|
+            schema_location = nil
+            if response_data.schema
+              schema_location = Fragment.new ['#', 'paths', path, verb, 'responses', response_code, 'schema']
+            end
+            block.call(path, verb, response_code, schema_location)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apivore/swagger_checker.rb

@@ -0,0 +1,89 @@
+module Apivore
+  class SwaggerChecker
+    PATH_TO_CHECKER_MAP = {}
+
+    def self.instance_for(path)
+      PATH_TO_CHECKER_MAP[path] ||= new(path)
+    end
+
+    def has_path?(path)
+      mappings.has_key?(path)
+    end
+
+    def has_method_at_path?(path, method)
+      mappings[path].has_key?(method)
+    end
+
+    def has_response_code_for_path?(path, method, code)
+      mappings[path][method].has_key?(code.to_s)
+    end
+
+    def has_matching_document_for(path, method, code, body)
+      JSON::Validator.fully_validate(
+        swagger, body, fragment: fragment(path, method, code)
+      )
+    end
+
+    def fragment(path, method, code)
+      mappings[path][method.to_s][code.to_s]
+    end
+
+    def remove_tested_end_point_response(path, method, code)
+      mappings[path][method].delete(code.to_s)
+      if mappings[path][method].size == 0
+        mappings[path].delete(method)
+        if mappings[path].size == 0
+          mappings.delete(path)
+        end
+      end
+    end
+
+    def base_path
+      @swagger.base_path
+    end
+
+    attr_reader :swagger_path, :mappings, :swagger
+
+    private
+
+    def initialize(swagger_path)
+      @swagger_path = swagger_path
+      load_swagger_doc!
+      validate_swagger!
+      setup_mappings!
+    end
+
+    def load_swagger_doc!
+      @swagger = Apivore::Swagger.new(fetch_swagger!)
+    end
+
+    def fetch_swagger!
+      session = ActionDispatch::Integration::Session.new(Rails.application)
+      begin
+        session.get(swagger_path)
+      rescue
+        fail "Unable to perform GET request for swagger json: #{swagger_path} - #{$!}."
+      end
+       JSON.parse(session.response.body)
+    end
+
+    def validate_swagger!
+      errors = swagger.validate
+      unless errors.empty?
+        msg = "The document fails to validate as Swagger #{swagger.version}:\n"
+        msg += errors.join("\n")
+        fail msg
+      end
+    end
+
+    def setup_mappings!
+      @mappings = {}
+      @swagger.each_response do |path, method, response_code, fragment|
+        @mappings[path] ||= {}
+        @mappings[path][method] ||= {}
+        raise "duplicate" unless @mappings[path][method][response_code].nil?
+        @mappings[path][method][response_code] = fragment
+      end
+    end
+  end
+end

data/lib/apivore/validator.rb

@@ -0,0 +1,132 @@
+require 'action_controller'
+require 'action_dispatch'
+
+module Apivore
+  class Validator
+    include ::ActionDispatch::Integration::Runner
+
+    attr_reader :method, :path, :expected_response_code, :params
+
+    def initialize(method, path, expected_response_code, params = {})
+      @method = method.to_s
+      @path = path.to_s
+      @params = params
+      @expected_response_code = expected_response_code.to_i
+    end
+
+    def matches?(swagger_checker)
+      pre_checks(swagger_checker)
+
+      unless has_errors?
+        send(
+          method,
+          full_path(swagger_checker),
+          params['_data'] || {},
+          params['_headers'] || {}
+        )
+        post_checks(swagger_checker)
+        swagger_checker.remove_tested_end_point_response(
+          path, method, expected_response_code
+        )
+      end
+
+      !has_errors?
+    end
+
+    def full_path(swagger_checker)
+      apivore_build_path(swagger_checker.base_path + path, params)
+    end
+
+    def apivore_build_path(path, data)
+      path.scan(/\{([^\}]*)\}/).each do |param|
+        key = param.first
+        if data && data[key]
+          path = path.gsub "{#{key}}", data[key].to_s
+        else
+          raise URI::InvalidURIError, "No substitution data found for {#{key}}"\
+            " to test the path #{path}.", caller
+        end
+      end
+      path + (data['_query_string'] ? "?#{data['_query_string']}" : '')
+    end
+
+
+    def pre_checks(swagger_checker)
+      check_request_path(swagger_checker)
+    end
+
+    def post_checks(swagger_checker)
+      check_status_code
+      check_response_is_valid(swagger_checker) unless has_errors?
+    end
+
+    def check_request_path(swagger_checker)
+      if !swagger_checker.has_path?(path)
+        errors << "Swagger doc: #{swagger_checker.swagger_path} does not have"\
+          " a documented path for #{path}"
+      elsif !swagger_checker.has_method_at_path?(path, method)
+        errors << "Swagger doc: #{swagger_checker.swagger_path} does not have"\
+          " a documented path for #{method} #{path}"
+      elsif !swagger_checker.has_response_code_for_path?(path, method, expected_response_code)
+        errors << "Swagger doc: #{swagger_checker.swagger_path} does not have"\
+          " a documented response code of #{expected_response_code} at path"\
+          " #{method} #{path}"
+      elsif method == "get" && swagger_checker.fragment(path, method, expected_response_code).nil?
+        errors << "Swagger doc: #{swagger_checker.swagger_path} missing"\
+          " response model for get request with #{path} for code"/
+          " #{expected_response_code}"
+      end
+    end
+
+    def check_status_code
+      if response.status != expected_response_code
+        errors << "Path #{path} did not respond with expected status code."\
+          " Expected #{expected_response_code} got #{response.status}"
+      end
+    end
+
+    def check_response_is_valid(swagger_checker)
+      swagger_errors = swagger_checker.has_matching_document_for(
+        path, method, response.status, response_body
+      )
+      unless swagger_errors.empty?
+        errors.concat(
+          swagger_errors.map do |e|
+            e.sub("'#", "'#{full_path(swagger_checker)}#").gsub(
+              /^The property|in schema.*$/,''
+            )
+          end
+        )
+      end
+    end
+
+    def response_body
+      JSON.parse(response.body) unless response.body.blank?
+    end
+
+    def has_errors?
+      !errors.empty?
+    end
+
+    def failure_message
+      errors.join(" ")
+    end
+
+    def errors
+      @errors ||= []
+    end
+
+    def description
+      "validate that #{method} #{path} returns #{expected_response_code}"
+    end
+
+    # Required by ActionDispatch::Integration::Runner
+    def app
+      ::Rails.application
+    end
+
+    # Required by rails
+    def reset_template_assertion
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apivore
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Charles Horn
@@ -14,158 +14,144 @@ dependencies:
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.1
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.5.1
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.1
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: pry
   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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
   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
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: activesupport
   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: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-description: Automatically tests your API using its Swagger description of end-points,
-  models, and query parameters.
+        version: '4'
+description: Tests your rails API using its Swagger description of end-points, models,
+  and query parameters.
 email: charles.horn@gmail.com
 executables: []
 extensions: []
@@ -173,10 +159,17 @@ extra_rdoc_files: []
 files:
 - data/swagger_2.0_schema.json
 - lib/apivore.rb
-- lib/apivore/rspec_builder.rb
+- lib/apivore/all_routes_tested_validator.rb
+- lib/apivore/fragment.rb
+- lib/apivore/rspec_helpers.rb
 - lib/apivore/rspec_matchers.rb
+- lib/apivore/swagger.rb
+- lib/apivore/swagger_checker.rb
+- lib/apivore/validator.rb
 homepage: http://github.com/westfieldlabs/apivore
-licenses: []
+licenses:
+- Apache 2.0
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -184,20 +177,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Automatically tests your API using its Swagger description of end-points,
-  models, and query parameters.
+summary: Tests your API against its Swagger 2.0 spec
 test_files: []
-has_rdoc: 

data/lib/apivore/rspec_builder.rb

@@ -1,114 +0,0 @@
-require 'apivore/rspec_matchers'
-require 'action_controller'
-require 'action_dispatch'
-require 'rspec/mocks'
-require 'hashie'
-
-module Apivore
-  module RspecBuilder
-    include Apivore::RspecMatchers
-    include ActionDispatch::Integration
-    include RSpec::Mocks::ExampleMethods
-
-    @@setups ||= {}
-
-    @@master_swagger_uri = nil
-
-    # Setup tests against a combination of path, method, and response.
-    # - *keys -> A combination of path, method, and/or response. Blank '' for base setup.
-    # - &block -> Code block to execute to setup the test. A hash of path subsitution parameters can be returned if required.
-    # All matching code blocks are executed, and substitution parameters are merged in order of specificity.
-    def apivore_setup(*keys, &block)
-      @@setups[keys.join] = block
-    end
-
-    def get_apivore_setup(path, method, response)
-      keys_to_search = [
-        '', # base setup key
-        response,
-        method,
-        path,
-        method + response,
-        path + response,
-        path + method,
-        path + method + response
-      ]
-      final_result = {}
-      keys_to_search.each do |k|
-        setup = @@setups[k]
-        if setup
-          result = instance_eval &setup
-          final_result.merge!(result) if result.is_a?(Hash)
-        end
-      end
-      final_result
-    end
-
-    def apivore_build_path(path, data)
-      path.scan(/\{([^\}]*)\}/).each do |param|
-        key = param.first
-        if data && data[key]
-          path = path.gsub "{#{key}}", data[key].to_s
-        else
-          raise URI::InvalidURIError, "No substitution data found for {#{key}} to test the path #{path}.\nAdd it via an:\n  apivore_setup '<path>', '<method>', '<response>' do\n    { '#{key}' => <value> }\n  end\nblock in your specs.", caller
-        end
-      end
-      path + (data['_query_string'] ? "?#{data['_query_string']}" : '')
-    end
-
-    def apivore_check_consistency_with_swagger_at(uri, current_service = nil)
-      @@current_service = current_service
-      @@master_swagger_uri = uri
-    end
-
-    def apivore_swagger(swagger_path)
-      session = ActionDispatch::Integration::Session.new(Rails.application)
-      begin
-        session.get swagger_path
-      rescue
-        # TODO: make this fail inside rspec test execution rather than immediately raise an exception.
-        # ALSO, handle other scenarios where we can't get a response to generate tests, e.g 500s, invalid formats etc
-        raise "Unable to perform GET request for swagger json: #{swagger_path} - #{$!}."
-      end
-      Apivore::Swagger.new JSON.parse(session.response.body)
-    end
-
-    def validate(swagger_path)
-
-      describe "swagger documentation" do
-        before { get swagger_path }
-        subject { body }
-        it { should be_valid_swagger }
-        it { should have_models_for_all_get_endpoints }
-        if @@master_swagger_uri
-          req = Net::HTTP.get(@@master_swagger_uri, "/swagger.json")
-          master_swagger = JSON.parse(req)
-          it { should be_consistent_with_swagger_definitions master_swagger, @@current_service }
-        end
-      end
-
-      swagger = apivore_swagger(swagger_path)
-      swagger.each_response do |path, method, response_code, fragment|
-        describe "path #{path} method #{method} response #{response_code}" do
-          it "responds with the specified models" do
-            setup_data = get_apivore_setup(path, method, response_code)
-            full_path = apivore_build_path(swagger.base_path + path, setup_data)
-            # e.g., get(full_path)
-            begin
-              send(method, full_path, setup_data['_data'] || {}, setup_data['_headers'] || {})
-            rescue
-              raise "Unable to #{method} #{full_path} -- invalid response from server: #{$!}."
-            end
-            expect(response).to have_http_status(response_code), "expected #{response_code} array, got #{response.status}: #{response.body}"
-
-            if fragment
-              expect(response.body).to conform_to_the_documented_model_for(swagger, fragment)
-            end
-
-          end
-        end
-      end
-
-    end
-  end
-end