swagger_coverage 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41af26bf939196920c683199bca51301caac5305
+  data.tar.gz: 3ea266df6d6af53d250ae54d2031ef3a5501b1da
+SHA512:
+  metadata.gz: a781c9d0196ca1a0654f574859650acf424f8e11d284945757e27a007abfdb7685d253594ccbadcc21b15ee27c6224612f9dfad29118004d46376871fc6f82e6
+  data.tar.gz: 0291a28bdaec7448c818bc4a74f2ea4a8fe7aae19e6c11273099653e112850d43c1a107ef7989424c91934ce7758a3941ca0c6de8070b19e2dafea547b66f312

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.gitlab-ci.yml

@@ -0,0 +1,35 @@
+before_script:
+  ["bundle install --jobs $(nproc) --path=/cache/bundler"]
+
+stages:
+  - test
+  - build_gem
+  - deploy
+
+unit_tests:
+  stage: test
+  tags:
+    - docker
+  script:
+    - bundle exec rspec spec/unit_tests
+
+functional_tests:
+  stage: test
+  tags:
+    - docker
+  script:
+    - bundle exec rspec spec/functional_tests
+
+build_gem:
+  stage: build_gem
+  only:
+    - master
+  script:
+    - gem build swagger_coverage.gemspec
+
+deploy:
+  stage: deploy
+  only:
+    - master
+  script:
+    - ruby -v #will be changed to push gem to rubygems.org

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.12.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at andrewh@spiceworks.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :test do
+	gem "rspec", "~> 3.0"
+	gem "rake"
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andrew Harthcock
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# SwaggerCoverage
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/swagger_coverage`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swagger_coverage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swagger_coverage
+
+## Usage
+
+An instance of SwaggerCoverage must first be created. The "routes" parameter accepts a string of all of the source code routes. Path_to_file is the path where your swagger doc is located. The swagger doc should be either yaml or json.
+
+```ruby
+routes = "users          GET     /users(.:format)          users#index
+                        POST     /users(.:format)          users#create
+          new_user       GET     /users/new(.:format)      users#new
+          edit_user      GET     /users/:id/edit(.:format) users#edit
+          api            GET     /api(.:format) redirect(301, /swagger/dist/index.html?url=/apidocs/api-docs.json)"
+path_to_file = File.join(File.dirname(__FILE__), '../heroku-pets.json')
+swaggercov = SwaggerCoverage::Parser.new(routes, path_to_file)
+
+```
+To compare route coverage, call the "check_coverage" method. This method will return a string array of the routes that do not match. If the routes from the docs match the source code, an empty array will be returned. The check_coverage method also accepts a boolean parameter for testing api coverage. If passed as true, check_coverage will only compare routes that include '/api'
+
+```
+comparison_results = swaggercov.check_coverage # => ["/users(.:format)", "users#create", "/api(.:format)"]
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swagger_coverage. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "swagger_coverage"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/code_parser.rb

@@ -0,0 +1,48 @@
+class CodeParser
+
+	def initialize(output)
+		@raw_routes_output = output
+	end
+
+	def api_endpoints(output = @raw_routes_output, api = false)
+		endpoints = []
+		parsed_routes(output).each do |route|
+			if api
+				endpoints << route[:route] if route[:route].include?('/api')
+			else
+				endpoints << route[:route]
+			end
+		end
+		endpoints
+	end
+
+	#returns all route http request type
+	def http_requests(output = @raw_routes_output)
+		request_type = []
+		parsed_routes(output).each do |route|
+			if route[:request_type] =~ /[\/]/
+				request_type << route[:type]
+			else
+				request_type << route[:request_type]
+			end
+		end
+		request_type
+	end
+
+	def parsed_routes(output = raw_routes_output)
+		#add 'none specified'
+		routes = []
+		output.strip.each_line do |line|
+			split = line.split(' ')
+			route = {}
+			route[:type]         = split[0]
+			route[:request_type] = split[1]
+			route[:route]        = split[2]
+			route[:controller]   = split[3]
+			route[:action]       = split[4]
+			routes << route
+		end
+		routes
+	end
+
+end

data/lib/swagger_cov.rb

@@ -0,0 +1,44 @@
+require "swagger_coverage/version"
+require "swagger_parser"
+require "code_parser"
+
+module SwaggerCoverage
+	class Parser
+
+		def initialize(output, swagger_docs)
+			@output = output
+			@swagger_docs = swagger_docs
+			@swagger_parser = SwaggerParser.new(@swagger_docs)
+			@code_parser = CodeParser.new(output)
+		end
+
+		def check_request_types
+			code_request_types = @code_parser.http_requests
+			swagger_request_types = @swagger_parser.http_requests
+			request_types_diff = compare_routes(code_request_types, swagger_request_types)
+		end
+
+		def check_routes(api = false)
+			code_endpoints = @code_parser.api_endpoints(@output, api)
+			swagger_endpoints = @swagger_parser.api_endpoints
+			routes_diff = compare_routes(code_endpoints, swagger_endpoints)
+		end
+
+		def compare_routes(code_routes, swagger_routes)
+			endpoints_match = code_routes.eql?(swagger_routes)
+			endpoint_diff = []
+			if !endpoints_match
+				if code_routes.size() > swagger_routes.size()
+					endpoint_diff = code_routes - swagger_routes
+					#raise "DOCUMENTATION DOES NOT CONTAIN THE FOLLOWING ROUTES FROM SOURCE: #{endpoint_diff}"
+				else
+					endpoint_diff = swagger_routes - code_routes
+					#raise "SOURCE CODE CONTAINS THE FOLLOWING ROUTES NOT FOUND IN DOCUMENTATION: #{endpoint_diff}"
+				end
+			end
+			endpoint_diff
+		end
+
+	end
+
+end

data/lib/swagger_coverage/version.rb

@@ -0,0 +1,3 @@
+module SwaggerCoverage
+  VERSION = "0.0.1.pre"
+end

data/lib/swagger_parser.rb

@@ -0,0 +1,39 @@
+require 'yaml'
+require 'json'
+
+class SwaggerParser
+
+	def initialize(path)
+		@path = path
+		@yaml_file = @path.include?('yaml')
+		@yaml_file ? @docs = YAML.load_file(path) : @docs = File.read(path)
+		@yaml_file ? @parse = @docs : @parse = JSON.parse(@docs)
+	end
+
+	def api_endpoints
+		endpoints = []
+			base_path = @parse['basePath']
+			@parse['paths'].each do |path|
+				endpoints << base_path + path.first.gsub('{', ':').gsub('}', '')
+			end
+		endpoints
+	end
+
+	def http_requests
+		request_types_arr = []
+		paths_arr = []
+		@parse['paths'].each do |path|
+			paths_arr << path.first
+		end
+		paths_arr.each do |path|
+			@yaml_file ? req = @parse['paths'] : req = @parse['paths'][path]
+			@yaml_file ? req = req[path] : req
+			req.each do |type|
+				result = (type.first).upcase
+				request_types_arr << result
+			end
+		end
+		request_types_arr
+	end
+
+end

data/swagger_coverage.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swagger_coverage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swagger_coverage"
+  spec.version       = SwaggerCoverage::VERSION
+  spec.authors       = ["Andrew Harthcock"]
+  spec.email         = ["andrewh@spiceworks.com"]
+
+  spec.summary       = "A tool designed to report on swagger documentation coverage for phoenix and rails APIs."
+  spec.description   = "swagger_coverage programmatically compares Swagger API routes to existing routes from the source code and reports the difference(s)"
+  spec.homepage      = "https://gitlab.spice.spiceworks.com/spiceworks/swagger-cov.git"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: swagger_coverage
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Andrew Harthcock
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: swagger_coverage programmatically compares Swagger API routes to existing
+  routes from the source code and reports the difference(s)
+email:
+- andrewh@spiceworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/code_parser.rb
+- lib/swagger_cov.rb
+- lib/swagger_coverage/version.rb
+- lib/swagger_parser.rb
+- swagger_coverage.gemspec
+homepage: https://gitlab.spice.spiceworks.com/spiceworks/swagger-cov.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A tool designed to report on swagger documentation coverage for phoenix and
+  rails APIs.
+test_files: []