Merge pull request #67 from gwshaw/66-ignore-vendor-specific-tags

Ignore vendor specific tags in paths

Author: gwshaw

apivore.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'apivore'
-  s.version     = '1.4.0'
+  s.version     = '1.4.1'
   s.date        = '2015-10-27'
   s.summary     = "Tests your API against its Swagger 2.0 spec"
   s.description = "Tests your rails API using its Swagger description of end-points, models, and query parameters."

lib/apivore/swagger.rb

@@ -26,6 +26,7 @@ def base_path
 
     def each_response(&block)
       paths.each do |path, path_data|
+        next if vendor_specific_tag? path
         path_data.each do |verb, method_data|
           next if NONVERB_PATH_ITEMS.include?(verb)
           raise "No responses found in swagger for path '#{path}', method #{verb}: #{method_data.inspect}" if method_data.responses.nil?
@@ -39,5 +40,10 @@ def each_response(&block)
         end
       end
     end
+
+    def vendor_specific_tag? tag
+      tag =~ /\Ax-.*/
+    end
+
   end
 end

spec/apivore_spec.rb

@@ -3,7 +3,7 @@
 describe 'Apivore::Swagger' do
 
   context 'with valid swagger 2.0 input' do
-    let(:doc) { IO.read(File.join(File.dirname(__FILE__), "data", "sample2.0.json")) }
+    let(:doc) { IO.read(File.join(File.dirname(__FILE__), "data", "01_sample2.0.json")) }
     let(:swagger) { Apivore::Swagger.new(JSON.parse(doc)) }
 
     subject { swagger }

spec/data/01_sample2.0.json

@@ -0,0 +1,113 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "testing",
+    "title": "Example Centre Directory Service"
+   },
+  "host": "api.test.example.com",
+  "basePath": "/api",
+  "schemes": [
+    "https"
+  ],
+  "consumes": [
+    "application/json"
+  ],
+  "produces": [
+    "application/json"
+  ],
+  "paths": {
+    "x-something": "Vendor Specific Tag",
+    "/services.json": {
+      "get": {
+        "description": "Services available to shoppers.",
+        "operationId": "Services#index",
+        "responses": {
+          "200": {
+            "description": "service index response",
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/service"
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "description": "Creates a service.",
+        "operationId": "Services#post",
+        "responses": {
+          "204": {
+            "description": "Service created"
+          }
+        }
+      }
+    },
+    "/services/{id}.json": {
+      "parameters": [
+        {
+          "name": "id",
+          "in": "path",
+          "description": "Service identifier.",
+          "required": true,
+          "type": "integer"
+        }
+      ],
+      "get": {
+        "description": "Returns a service.",
+        "operationId": "Services#show",
+        "responses": {
+          "200": {
+            "description": "show service response",
+            "schema": {
+              "$ref": "#/definitions/service"
+            }
+          }
+        }
+      },
+      "put": {
+        "description": "Update a service.",
+        "operationId": "Services#put",
+        "responses": {
+          "204": {
+            "description": "Service updated"
+          }
+        }
+      },
+      "delete": {
+        "description": "Deletes a service.",
+        "operationId": "Services#delete",
+        "responses": {
+          "204": {
+            "description": "Service deleted"
+          }
+        }
+      },
+      "patch": {
+        "description": "Patches a service.",
+        "operationId": "Services#patch",
+        "responses": {
+          "204": {
+            "description": "Service patched"
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "service": {
+      "type": "object",
+      "required": [ "id" ],
+      "properties": {
+        "id": {
+          "type": "integer",
+          "description": "Service id"
+        },
+        "name": {
+          "type": ["string", "null"],
+          "description": "Service name"
+        }
+      }
+    }
+  }
+}

spec/data/sample2.0.json

@@ -31,7 +31,7 @@ def call(env)
       ]
       case "#{method} #{path}"
       when "GET /swagger-doc.json"
-        respond_with 200, File.read(File.expand_path("../../data/sample2.0.json", __FILE__))
+        respond_with 200, File.read(File.expand_path("../../data/01_sample2.0.json", __FILE__))
       when "GET /api/services.json"
         respond_with 200, [{ id: 1, name: "hello world" }].to_json
       when "POST /api/services.json"