rspec-autoswagger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9ca20badc411c1e7708446e3b85298a19c03af38afaf5f7d304df647a1a38f3
+  data.tar.gz: f94c3bdb32d80bf3bb6a6675312d03a0c04e0483eac887573bc670d1b47fb8ba
+SHA512:
+  metadata.gz: f8d0cd561f05b89ccedfc16a1f63e968ef08335695bfadc2a185268c591595a227f9e564070653d91575b4fed8de8cf2780e66c3ecb2f717819ac3e61d410c42
+  data.tar.gz: 1f17084e9e12108d00f2f018f9f0a4525ee5de1561c2990d6375cec0bb983ff248f474ffff4909269d4d2b3c11811b1f05fd1bf6a293fe3a5adb86487a98539d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.sw*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rspec-autoswagger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 sayakahojo
+
+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,39 @@
+# Rspec::Autoswagger
+
+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/rspec/autoswagger`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-autoswagger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-autoswagger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/rspec-autoswagger.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "rspec/autoswagger"
+
+# 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(__FILE__)

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/rspec/autoswagger/doc_part.rb

@@ -0,0 +1,31 @@
+require 'rspec/autoswagger/parts/path'
+require 'rspec/autoswagger/parts/info'
+require 'rspec/autoswagger/parts/definition'
+
+module Rspec
+  module Autoswagger
+    class DocPart
+
+      attr_reader :rspec_core_obj, :example
+
+      def initialize(rspec_core_obj, example)
+        @rspec_core_obj = rspec_core_obj
+        @example = example
+      end
+
+      def response_name
+        example.full_description[%r<(GET|POST|PATCH|PUT|DELETE) ([^ ]+)>, 2].gsub(/\/|:/, '').camelize
+      end
+
+      def create_path
+        path = Parts::Path.new(rspec_core_obj, example, response_name)
+        path.generate_hash
+      end
+
+      def create_definition
+        definition = Parts::Definition.new(rspec_core_obj.response.body, response_name)
+        definition.generate_definitions
+      end
+    end
+  end
+end

data/lib/rspec/autoswagger/doc_parts.rb

@@ -0,0 +1,41 @@
+require 'rspec/autoswagger/doc_part'
+module Rspec module Autoswagger
+    class DocParts
+
+      attr_reader :specification, :info, :paths, :definitions
+      def initialize
+        @info = Parts::Info.generate_hash
+        @paths = {}
+        @definitions = {}
+        @specification = {}
+      end
+
+      def add(rspec_core_obj, example)
+        doc_part = DocPart.new(rspec_core_obj, example)
+        path, param_definitions = doc_part.create_path
+        if paths.keys.include?(path.keys.first)
+          paths[path.keys.first].merge!(path.values.first)
+        else
+          paths.merge!(path)
+        end
+        definitions.merge!(doc_part.create_definition)
+        definitions.merge!(param_definitions) unless param_definitions.empty?
+      end
+
+      def aggregate
+        specification.merge!(info)
+        specification.merge!({ 'paths' => paths })
+        specification.merge!({ 'definitions' => definitions })
+
+        specification
+      end
+
+      def to_yaml
+        aggregate if specification.empty?
+
+        FileUtils::mkdir_p(Rails.root.to_s + '/tmp/')
+        YAML.dump(specification, File.open(Rails.root.to_s + '/tmp/swagger.yml', 'w'))
+      end
+    end
+  end
+end

data/lib/rspec/autoswagger/parts/config/default_info.yml

@@ -0,0 +1,16 @@
+swagger: '2.0'
+info:
+  description: Doc Application For Project Api
+  version: 1.0.0
+  title: Project Api Doc
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0.html
+host: contents.kurashiru.com
+basePath: /api/v1
+schemes:
+  - https
+consumes:
+  - application/json
+produces:
+  - application/json

data/lib/rspec/autoswagger/parts/definition.rb

@@ -0,0 +1,49 @@
+require 'swagger_model'
+
+module Rspec
+  module Autoswagger
+    module Parts
+      class Definition
+        attr_reader :json, :response_name
+
+        DEFAULT_PATH = './tmp/specifications'
+
+        def initialize(json, response_name)
+          @json = json
+          @response_name = response_name
+        end
+
+        def tmp_file_path
+          DEFAULT_PATH
+        end
+
+        def generate_model_definitions
+          model_definition_hash = {}
+          generate_hash_and_file['models'].each do |key, value|
+            model_definition_hash.merge!(value)
+          end
+          model_definition_hash
+        end
+
+        def generate_response_definitions
+          generate_hash_and_file['responses']
+        end
+
+        def generate_definitions
+          model_hash = generate_model_definitions
+          response_hash = generate_response_definitions
+          response_hash.merge!(model_hash)
+          response_hash
+        end
+
+        def generate_hash_and_file
+          @definition_hash ||= SwaggerModel::SwaggerV2.create_from_json(
+            json_string: json,
+            tmp_file_path: tmp_file_path,
+            response_name: response_name
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rspec/autoswagger/parts/info.rb

@@ -0,0 +1,14 @@
+module Rspec
+  module Autoswagger
+    module Parts
+      class Info
+
+        DEFAULT_INFO = YAML.load_file(File.expand_path("../config/default_info.yml", __FILE__))
+
+        def self.generate_hash
+          DEFAULT_INFO
+        end
+      end
+    end
+  end
+end

data/lib/rspec/autoswagger/parts/path.rb

@@ -0,0 +1,155 @@
+module Rspec
+  module Autoswagger
+    module Parts
+      class Path
+        attr_reader :response, :request, :description, :example, :path, :response_name
+
+        def initialize(rspec_core_obj, example, response_name)
+          @response = rspec_core_obj.response
+          @request = rspec_core_obj.request
+          @description = rspec_core_obj.description
+          @example = example
+          @response_name = response_name
+        end
+
+        def path
+          path = example.full_description[%r<(GET|POST|PATCH|PUT|DELETE) ([^ ]+)>, 2]
+          path.split("/").map { |name| name.include?(":") ? "{" + name.gsub(":", "") + "}" : name }.join("/")
+        end
+
+        def tags
+          tag = request.parameters['controller']
+          base_path = Info.generate_hash['basePath']
+          tag = ('/' + tag).gsub(base_path.to_s, '')
+          [tag]
+        end
+
+        def status
+          response.status
+        end
+
+        def method
+          request.method.downcase
+        end
+
+        def operation_id
+          (method + path.gsub('/', '_').gsub(/{|}/, '')).camelize
+        end
+
+        def param_model_name
+          (response_name + '_' + method + '_request_parameter').camelize
+        end
+
+        def params
+          return @params if @params.present?
+          @params = request.parameters.dup
+          @params.delete('controller')
+          @params.delete('action')
+          @params
+        end
+
+        def generate_parameters
+          schema = {}
+          params_arr = []
+          params.each do |name, value|
+            type = convert_value_to_type(value)
+            param_type = predict_param_type(name)
+            if param_type == 'body'
+              if type == 'array'
+                type_hash = SwaggerModel::SwaggerV2.parse_array(value, "dummy", "dummy")
+                type_hash.delete('example')
+                schema.merge!({ name => { 'type' => type, 'items' => type_hash } })
+              else
+                schema.merge!({ name => { 'type' => type } })
+              end
+            else
+              if type == 'array'
+                type_hash = SwaggerModel::SwaggerV2.parse_array(value, "dummy", "dummy")
+                type_hash.delete('example')
+                param_hash = {
+                  'name' => name,
+                  'in' => param_type,
+                  'type' => type,
+                  'items' => type_hash
+                }
+              else
+                param_hash = {
+                  'name' => name,
+                  'in' => param_type,
+                  'type' => type
+                }
+              end
+              param_hash['required'] = true if param_type == 'path'
+              params_arr << param_hash
+            end
+          end
+          param_definitions = {}
+          unless schema.empty?
+            params_arr << {
+                             'name' => 'body',
+                             'in' => 'body',
+                             'schema' => { "$ref" => "#/definitions/#{param_model_name}" }
+                           }
+            param_definitions = { param_model_name => { 'type' => 'object', 'properties' => schema } }
+          end
+
+          [params_arr, param_definitions]
+        end
+
+        def generate_hash
+          hash = {}
+          path_sym = path
+          hash[path] = {}
+          hash[path][method] = {}
+
+          hash[path][method] = {}
+          hash[path][method]["tags"] = tags
+          hash[path][method]["summary"] = ''
+          hash[path][method]["description"] = description
+          hash[path][method]["operationId"] = operation_id
+
+          params, param_definitions = generate_parameters
+          hash[path][method]["parameters"] = params
+
+          hash[path][method]["produces"] = ['application/json']
+          hash[path][method]["responses"] = {}
+          hash[path][method]["responses"][status] = {}
+          hash[path][method]["responses"][status]["description"] = response_description
+          hash[path][method]["responses"][status]["schema"] = { "$ref" => "#/definitions/#{response_name}" }
+          [hash, param_definitions]
+        end
+
+        private
+
+        def response_description
+          case status.to_i
+          when 200
+            'successful operation'
+          else
+            'error operation'
+          end
+        end
+
+        def predict_param_type(param_name)
+          candidates = path.split("/").map { |name| name.gsub(/{|}/, "") }
+          return 'path' if candidates.include?(param_name.to_s)
+          method == 'get' ? 'query' : 'body'
+        end
+
+        def convert_value_to_type(value)
+          if value.to_s == 'true' || value.to_s == 'false'
+            'boolean'
+          elsif value.is_a?(String)
+            'string'
+          elsif value.is_a?(Integer)
+            'integer'
+          elsif value.is_a?(Array)
+            'array'
+          else
+            'string'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/autoswagger/rspec.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'rspec/autoswagger/doc_parts'
+
+RSpec.configuration.after(:each, autoswagger: true) do |example|
+  Rspec::Autoswagger.doc_parts.add(self, example)
+end
+
+RSpec.configuration.after(:suite) do
+  Rspec::Autoswagger.doc_parts.aggregate
+  Rspec::Autoswagger.doc_parts.to_yaml
+end

data/lib/rspec/autoswagger/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Autoswagger
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec/autoswagger.rb

@@ -0,0 +1,12 @@
+require "rspec/autoswagger/version"
+require "rspec/autoswagger/rspec" if ENV["AUTOSWAGGER"]
+require "rspec/autoswagger/doc_parts"
+
+module Rspec
+  module Autoswagger
+
+    def self.doc_parts
+      @doc_parts ||= DocParts.new
+    end
+  end
+end

data/rspec-autoswagger.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rspec/autoswagger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-autoswagger"
+  spec.version       = Rspec::Autoswagger::VERSION
+  spec.authors       = ["joooee0000"]
+  spec.email         = ["joooee0000@gmail.com"]
+
+  spec.summary       = "Rspec extension to auto generate swagger/openapi specification"
+  spec.homepage      = "https://github.com/joooee0000/rspec-autoswagger"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "swagger_model"
+  spec.add_dependency "rspec"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: rspec-autoswagger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joooee0000
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: swagger_model
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- joooee0000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/autoswagger.rb
+- lib/rspec/autoswagger/doc_part.rb
+- lib/rspec/autoswagger/doc_parts.rb
+- lib/rspec/autoswagger/parts/config/default_info.yml
+- lib/rspec/autoswagger/parts/definition.rb
+- lib/rspec/autoswagger/parts/info.rb
+- lib/rspec/autoswagger/parts/path.rb
+- lib/rspec/autoswagger/rspec.rb
+- lib/rspec/autoswagger/version.rb
+- rspec-autoswagger.gemspec
+homepage: https://github.com/joooee0000/rspec-autoswagger
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Rspec extension to auto generate swagger/openapi specification
+test_files: []