swagger_coverage 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8aeb44f6290fe04d25d56b89862264368fd69417
-  data.tar.gz: 8fb14feaad8ce9dd638237e99ac7dc1f311c3c50
+  metadata.gz: f613780fa11b8056da41a388bf857bd52d2e038c
+  data.tar.gz: 3adf5b54efdfbe3a7c9468f377dabafe38846630
 SHA512:
-  metadata.gz: 87cf78283587434a7fbd9966b6a96b497f4f1d5e95d1de853ca6b54af27b2aa062fbb9e32f7d5feadbb9a44b206b0a856141286f7fcdf35236bbe0c4e159730e
-  data.tar.gz: b172e45c17e67c0e4f469752d73eac4ab1628dea90b9bf1aff25f40184b444db2f4834bb1b014dc56e05b0b867658ab178fe2354f2449ce4a42e521d007e2e26
+  metadata.gz: ee1228d7de4d959277dd517c627b2619205238c38ed65140e9e0ec4d819028bc6b446d49aa798a436972d4e4c780ee8926d63db63fcfb8c5efa967e6a404572d
+  data.tar.gz: 2566daa222437eb37aed1455e71c21fe12d5ebac01050b1e0709c572af44e763ccf17daec5a71cfedddfcedf25eee3431ac1961c6218a87a4a855c37726c0b42

data/lib/code_parser.rb

@@ -5,19 +5,21 @@ class CodeParser
 	end
 
 	#returns an empty array if no api_endpoints in code
-	def api_endpoints(output = @raw_routes_output, api = false)
+	def api_endpoints(output = @raw_routes_output)
 		endpoints = []
 		parsed_routes(output).each do |route|
 			if route[:route] != nil
-				if api
-					endpoints << route[:route] if route[:route].include?('/api')
-				else
-					endpoints << route[:route]
-				end
+				endpoints << route[:route] if route[:route].include?('/api')
 			end
 		end
-		contains_api = endpoints.any? { |route| route.include?('/api')  }
-		endpoints = [] if !contains_api
+		endpoints
+	end
+
+	def all_endpoints(output = @raw_routes_output)
+	endpoints = []
+		parsed_routes(output).each do |route|
+			endpoints << route[:route] if route[:route] != nil
+		end
 		endpoints
 	end
 

data/lib/swagger_cov.rb

@@ -19,7 +19,7 @@ module SwaggerCoverage
 		end
 
 		def check_routes(api = false)
-			code_endpoints = @code_parser.api_endpoints(@output, api)
+			code_endpoints = @code_parser.api_endpoints(@output)
 			swagger_endpoints = @swagger_parser.api_endpoints
 			routes_diff = compare_routes(code_endpoints, swagger_endpoints)
 		end
@@ -39,6 +39,30 @@ module SwaggerCoverage
 			endpoint_diff
 		end
 
-	end
+		def source_api_routes
+			output = @output
+			endpoints = []
+			@code_parser.parsed_routes(output).each do |route|
+				if route[:route] != nil
+					endpoints << route[:route] if route[:route].include?('/api')
+				end
+			end
+			endpoints.sort
+		end
+
+		def source_routes
+			output = @output
+			endpoints = []
+			@code_parser.parsed_routes(ouput) do |route|
+				endpoints << route[:route] if route[:route] != nil
+			end
+		endpoints.sort
+		end
 
+		def swagger_api_routes
+			swagger_routes = @swagger_parser.api_endpoints
+			swagger_routes.sort
+		end
+
+	end
 end

data/lib/swagger_coverage/version.rb

@@ -1,3 +1,3 @@
 module SwaggerCoverage
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/swagger_parser.rb

@@ -13,8 +13,10 @@ class SwaggerParser
 	def api_endpoints
 		endpoints = []
 			base_path = @parse['basePath']
+			swag_path = ''
 			@parse['paths'].each do |path|
-				endpoints << base_path + path.first.gsub('{', ':').gsub('}', '')
+				swag_path = base_path + path.first.gsub('{', ':').gsub('}', '')
+				endpoints << swag_path if swag_path.include?('api')
 			end
 		endpoints
 	end
@@ -23,7 +25,7 @@ class SwaggerParser
 		request_types_arr = []
 		paths_arr = []
 		@parse['paths'].each do |path|
-			paths_arr << path.first
+			paths_arr << path.first if path.first.include?('api')
 		end
 		paths_arr.each do |path|
 			@yaml_file ? req = @parse['paths'] : req = @parse['paths'][path]

data/non_api_routes_test_info/routes.txt

@@ -0,0 +1,25 @@
+health_path  GET     /health                                      Grid.HealthController :index
+  page_path  GET     /                                            Grid.PageController :index
+ visit_path  GET     /api/public/visit/show_by_nexus_id/:id       Grid.VisitController :show_by_nexus_id
+ visit_path  GET     /api/public/visit/show_by_user_id/:id        Grid.VisitController :show_by_user_id
+app_stat_path  GET     /api/public/app_stats                        Grid.AppStatController :index
+app_stat_path  GET     /api/public/app_stats/:id/edit               Grid.AppStatController :edit
+app_stat_path  GET     /api/public/app_stats/new                    Grid.AppStatController :new
+app_stat_path  GET     /api/public/app_stats/:id                    Grid.AppStatController :show
+app_stat_path  POST    /api/public/app_stats                        Grid.AppStatController :create
+app_stat_path  PATCH   /api/public/app_stats/:id                    Grid.AppStatController :update
+             PUT     /api/public/app_stats/:id                    Grid.AppStatController :update
+app_stat_path  DELETE  /api/public/app_stats/:id                    Grid.AppStatController :delete
+  user_path  GET     /api/public/users                            Grid.UserController :index
+  user_path  GET     /api/public/users/:id                        Grid.UserController :show
+  user_path  POST    /api/public/users                            Grid.UserController :create
+  user_path  PATCH   /api/public/users/:id                        Grid.UserController :update
+             PUT     /api/public/users/:id                        Grid.UserController :update
+  user_path  DELETE  /api/public/users/:id                        Grid.UserController :delete
+user_nexus_identity_path  GET     /api/public/users/:user_id/nexus_identities  Grid.NexusIdentityController :index
+nexus_identity_path  GET     /api/public/nexus_identities                 Grid.NexusIdentityController :index
+nexus_identity_path  GET     /api/public/nexus_identities/:id             Grid.NexusIdentityController :show
+nexus_identity_path  POST    /api/public/nexus_identities                 Grid.NexusIdentityController :create
+nexus_identity_path  PATCH   /api/public/nexus_identities/:id             Grid.NexusIdentityController :update
+             PUT     /api/public/nexus_identities/:id             Grid.NexusIdentityController :update
+nexus_identity_path  DELETE  /api/public/nexus_identities/:id             Grid.NexusIdentityController :delete

data/non_api_routes_test_info/swagger.json

@@ -0,0 +1 @@
+{"swagger":"2.0","schemes":["http"],"produces":["application/json"],"paths":{"/health":{"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[],"operationId":"index","description":""}},"/api/public/visit/show_by_user_id/{id}":{"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"schema":{"type":"object","title":"ShowByUserId","required":["last_cloud_visit","last_networking_visit"],"properties":{"last_networking_visit":{"type":"string","format":"date-time"},"last_cloud_visit":{"type":"string","format":"date-time"}}},"description":"Resource Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":"Spiceworks Id"}],"operationId":"show_by_user_id","description":"Retrieve last cloud and networking visit by user id"}},"/api/public/visit/show_by_nexus_id/{id}":{"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"schema":{"type":"object","title":"ShowByNexusId","required":["last_cloud_visit","last_networking_visit"],"properties":{"last_networking_visit":{"type":"string","format":"date-time"},"last_cloud_visit":{"type":"string","format":"date-time"}}},"description":"Resource Content"}},"produces":["application/json"],"parameters":[{"type":"string","required":true,"name":"id","in":"path","description":"Nexus Id"}],"operationId":"show_by_nexus_id","description":"Retrieve last cloud and networking visit by user id"}},"/api/public/users/{user_id}/nexus_identities":{"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[{"type":"string","required":true,"name":"user_id","in":"path","description":""}],"operationId":"index","description":""}},"/api/public/users/{id}":{"put":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"400":{"description":"Request contains bad values"},"204":{"description":"No Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"update","description":""},"patch":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"update","description":""},"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"schema":{"$ref":"#/definitions/Grid.User"},"description":"Resource Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":"Spiceworks Id"}],"operationId":"show","description":"Retrieve user"},"delete":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"204":{"description":"No Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"delete","description":""}},"/api/public/users":{"post":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"400":{"description":"Request contains bad values"},"201":{"description":"Resource created"}},"produces":["application/json"],"parameters":[{"required":true,"name":"type","in":"body","description":"The new User","schema":{"$ref":"#/definitions/Grid.User"}}],"operationId":"create","description":"Create a User"},"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"schema":{"title":"Users","type":"array","items":{"$ref":"#/definitions/Grid.User"}},"description":"Resource Content"}},"produces":["application/json"],"parameters":[],"operationId":"index","description":"Retrieve all Users"}},"/api/public/nexus_identities/{id}":{"put":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"400":{"description":"Request contains bad values"},"204":{"description":"No Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"update","description":""},"patch":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"update","description":""},"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"show","description":""},"delete":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"204":{"description":"No Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"delete","description":""}},"/api/public/nexus_identities":{"post":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"400":{"description":"Request contains bad values"},"201":{"description":"Resource created"}},"produces":["application/json"],"parameters":[],"operationId":"create","description":""},"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[],"operationId":"index","description":""}},"/api/public/app_stats/{id}/edit":{"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"edit","description":""}},"/api/public/app_stats/{id}":{"put":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"400":{"description":"Request contains bad values"},"204":{"description":"No Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"update","description":""},"patch":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"update","description":""},"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"show","description":""},"delete":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"204":{"description":"No Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"delete","description":""}},"/api/public/app_stats/new":{"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[],"operationId":"new","description":""}},"/api/public/app_stats":{"post":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"400":{"description":"Request contains bad values"},"201":{"description":"Resource created"}},"produces":["application/json"],"parameters":[],"operationId":"create","description":""},"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[],"operationId":"index","description":""}},"nil":{"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[],"operationId":"index","description":""}}},"info":{"version":"","title":"GRID","termsOfService":"","license":{"url":"","name":""},"description":"","contact":{"url":"","name":"Fraser Mince","email":"fraserm@spiceworks.com"}},"host":"api.spiceworks.com","definitions":{"Grid.User":{"required":["spiceworks_id","last_cloud_visit","last_networking_visit"],"properties":{"updated_at":{"type":"string","format":"date-time"},"spiceworks_id":{"type":"integer","format":"int64"},"last_networking_visit":{"type":"string","format":"date-time"},"last_cloud_visit":{"type":"string","format":"date-time"},"inserted_at":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"}}},"Grid.NexusIdentity":{"required":["nexus_id"],"properties":{"user_id":{"type":"integer","format":"int64"},"updated_at":{"type":"string","format":"date-time"},"nexus_id":{"type":"string"},"inserted_at":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"}}},"Grid.AppStat":{"required":["key","value"],"properties":{"value":{"type":"integer","format":"int64"},"updated_at":{"type":"string","format":"date-time"},"key":{"type":"string"},"inserted_at":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"}}}},"consumes":["application/json"],"basePath":""}

data/routes.txt

@@ -0,0 +1,5 @@
+page_path GET /lookup/:id IpCheck.PageController :show
+health_path GET /health IpCheck.HealthController :index
+api_path GET /api IpCheck.ApiController :index
+v1_api_path GET /api/v1 IpCheck.V1.ApiController :index
+v1_page_path GET /api/v1/lookup/:id IpCheck.V1.PageController :show

data/swagger.json

@@ -1,177 +1 @@
-{
-    "swagger": "2.0",
-    "info": {
-        "title": "Stratocumulus API",
-        "description": "Finally you can use the cloud with Stratocumulus",
-        "version": "1.0.0"
-    },
-    "schemes": [
-        "https"
-    ],
-    "basePath": "/api",
-    "produces": [
-        "application/json"
-    ],
-    "paths": {
-        "/status": {
-            "get": {
-                "summary": "Statuses",
-                "description": "The Status endpoint returns the currently stored statuses.\n",
-                "tags": [
-                    "Statuses"
-                ],
-                "responses": {
-                    "200": {
-                        "description": "An array of Statuses",
-                        "schema": {
-                            "type": "array",
-                            "items": {
-                                "$ref": "#/definitions/Status"
-                            }
-                        }
-                    }
-                }
-            },
-            "post": {
-                "summary": "Create new Statuses",
-                "description": "This endpoint allows the user to create a new status.\n",
-                "tags": [
-                    "Statuses"
-                ],
-                "responses": {
-                    "200": {
-                        "description": "Returns the ID and name of the new status",
-                        "schema": {
-                            "$ref": "#/definitions/Status"
-                        }
-                    }
-                }
-            }
-        },
-        "/status/{id}": {
-            "get": {
-                "summary": "Get specific Status",
-                "description": "This endpoint returns a specific status.\n",
-                "tags": [
-                    "Statuses"
-                ],
-                "parameters": [
-                    {
-                        "name": "id",
-                        "in": "path",
-                        "description": "ID of status to fetch",
-                        "required": true,
-                        "type": "integer",
-                        "format": "int64"
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "Returns the ID and name of the requested status",
-                        "schema": {
-                            "$ref": "#/definitions/Status"
-                        }
-                    }
-                }
-            },
-            "patch": {
-                "summary": "Update specific Status",
-                "description": "This endpoint allws the user to update a specific status.\n",
-                "tags": [
-                    "Statuses"
-                ],
-                "parameters": [
-                    {
-                        "name": "id",
-                        "in": "path",
-                        "description": "ID of status to update",
-                        "required": true,
-                        "type": "integer"
-                    },
-                    {
-                        "name": "status",
-                        "in": "formData",
-                        "description": "Updated status",
-                        "required": false,
-                        "type": "string"
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "Returns the ID and name of the updated status",
-                        "schema": {
-                            "$ref": "#/definitions/Status"
-                        }
-                    }
-                }
-            },
-            "put": {
-                "summary": "Replace existing Status",
-                "description": "This endpoint allws the user to replace an existing status.\n",
-                "tags": [
-                    "Statuses"
-                ],
-                "parameters": [
-                    {
-                        "name": "id",
-                        "in": "path",
-                        "description": "ID of status to update",
-                        "required": true,
-                        "type": "integer"
-                    },
-                    {
-                        "name": "status",
-                        "in": "formData",
-                        "description": "New status",
-                        "required": true,
-                        "type": "string"
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "Returns the ID and name of the patched status",
-                        "schema": {
-                            "$ref": "#/definitions/Status"
-                        }
-                    }
-                }
-            },
-            "delete": {
-                "summary": "Delete existing Status",
-                "description": "This endpoint allws the user to delete an existing status.\n",
-                "tags": [
-                    "Statuses"
-                ],
-                "parameters": [
-                    {
-                        "name": "id",
-                        "in": "path",
-                        "description": "ID of status to delete",
-                        "required": true,
-                        "type": "integer"
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "Not sure what this returns currently"
-                    }
-                }
-            }
-        }
-    },
-    "definitions": {
-        "Status": {
-            "type": "object",
-            "properties": {
-                "id": {
-                    "type": "string",
-                    "description": "Unique identifier representing a status."
-                },
-                "status": {
-                    "type": "string",
-                    "description": "The name of the status."
-                }
-            }
-        }
-    }
-}
+{"swagger":"2.0","schemes":["http"],"produces":["application/json"],"paths":{"/api/v1/lookup/{id}":{"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[{"type":"integer","required":true,"name":"id","in":"path","description":""}],"operationId":"show","description":""}},"/api/v1":{"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[],"operationId":"index","description":""}},"/api":{"get":{"responses":{"500":{"description":"Internal Server Error"},"404":{"description":"Resource not found"},"401":{"description":"Request is not authorized"},"200":{"description":"Resource Content"}},"produces":["application/json"],"parameters":[],"operationId":"index","description":""}}},"info":{"version":"","title":"ip-check-backend","termsOfService":"","license":{"url":"","name":""},"description":"","contact":{"url":"","name":"Jason Hatchett","email":"jasonh@spiceworks.com"}},"host":"api.spiceworks.com","definitions":{"Ecto.Migration.SchemaMigration":{"properties":{"version":{"type":"integer","format":"int64"},"inserted_at":{"type":"string","format":"date-time"}}}},"consumes":["application/json"],"basePath":""}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_coverage
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Andrew Harthcock
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,6 +49,9 @@ files:
 - lib/swagger_cov.rb
 - lib/swagger_coverage/version.rb
 - lib/swagger_parser.rb
+- non_api_routes_test_info/routes.txt
+- non_api_routes_test_info/swagger.json
+- routes.txt
 - swagger.json
 - swagger_coverage.gemspec
 homepage: https://gitlab.spice.spiceworks.com/spiceworks/swagger-cov.git