jsonapi-swagger-blocks-generator 0.1.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Gleydson Tavares
+
+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,65 @@
+# JSONAPI Swagger Blocks Generator
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/2de3e3c4e8fb1543a687/maintainability)](https://codeclimate.com/github/g13ydson/jsonapi-swagger-blocks-generator/maintainability) <a href="https://codeclimate.com/github/g13ydson/jsonapi-swagger-blocks-generator/test_coverage"><img src="https://api.codeclimate.com/v1/badges/2de3e3c4e8fb1543a687/test_coverage" /></a> [![Build Status](https://travis-ci.org/g13ydson/jsonapi-swagger-blocks-generator.svg?branch=master)](https://travis-ci.org/g13ydson/jsonapi-swagger-blocks-generator)
+
+   creates swagger blocks files based on the JSONAPI::Resource file http://jsonapi-resources.com/ 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi-swagger-blocks-generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonapi-swagger-blocks-generator
+
+## Usage
+
+    $ rails g jsonapi:swagger_blocks User
+
+or specifying the namespace of the resources folder
+
+    $ rails g jsonapi:swagger_blocks User Api::V1 
+
+
+## Contributing
+
+# Contributing to JSONAPI Swagger blocks generator
+
+We are following the Gitflow workflow. The active development branch is [dev](https://github.com/g13ydson/jsonapi-swagger-blocks-generator/tree/dev), the stable branch is [master](https://github.com/g13ydson/jsonapi-swagger-blocks-generator/tree/master).
+
+Contributions will be accepted to the [dev](https://github.com/g13ydson/jsonapi-swagger-blocks-generator/tree/dev) only.
+
+## How to provide a patch for a new feature
+
+1. If it is a major feature, please create an [Issue]( https://github.com/g13ydson/jsonapi-swagger-blocks-generator/issues ) and discuss with the project leaders.
+
+2. If in step 1 you get an acknowledge from the project leaders, use the
+   following procedure to submit a patch:
+
+    a. Fork Fast JSONAPI Swagger blocks generator on github ( http://help.github.com/fork-a-repo/ )
+
+    b. Create a topic branch (git checkout -b my_branch)
+
+    c. Push to your branch (git push origin my_branch)
+
+    d. Initiate a pull request on github ( http://help.github.com/send-pull-requests/ )
+
+    e. Done :)
+
+3. Run the tests. We only take pull requests with passing tests.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SwaggerBlocksGenerator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/g13ydson/jsonapi-swagger-blocks-generator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "jsonapi/swagger/blocks/generator"
+
+# 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/jsonapi-swagger-blocks-generator.gemspec

@@ -0,0 +1,29 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jsonapi/swagger/blocks/generator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi-swagger-blocks-generator"
+  spec.version       = Jsonapi::Swagger::Blocks::Generator::VERSION
+  spec.authors       = ["Gleydson Tavares"]
+  spec.email         = ["tavares.gleydson@gmail.com"]
+
+  spec.summary       = "creates swagger blocks files based on the JSONAPI::Resource"
+  spec.description   = "The swagger-bloks files are created based on the JSONAPI::Resources files. To use this gem, you need to have jsonapi-resources gem installed."
+  spec.homepage      = "https://github.com/g13ydson/jsonapi-swagger-blocks-generator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/generators/jsonapi/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Creates swagger blocks files from resources
+Example:
+    rails generate jsonapi:swagger_bloks User
+    rails generate jsonapi:swagger_bloks User Api::V1
+
+    This will create:
+        controllers/docs/user.rb
+        controllers/docs/users_controller.rb

data/lib/generators/jsonapi/swagger_blocks_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Jsonapi
+  module Generators
+    class SwaggerBlocksGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      argument :model, type: :string, banner: "resource", desc: "Resource file generated by JSONAPI::Resources gem"
+      argument :namespace, type: :string, default: "", desc: "namespace where the Resource files are located"
+
+      def generate_documentation
+        model_name = model.to_s.split("::").last || model
+        Object.const_get("#{namespace}::#{model_name.camelcase}Resource").is_a?(Class)
+        generate_model_template
+        generate_controller_template
+      rescue Exception => e
+        p e.message
+      end
+
+      private
+
+        def generate_model_template
+          template "model_template.template", "app/docs/#{model.underscore}.rb"
+        end
+
+        def generate_controller_template
+          template "controller_template.template", "app/docs/#{model.underscore.pluralize}_controller.rb"
+        end
+    end
+  end
+end

data/lib/generators/jsonapi/templates/controller_template.template

@@ -0,0 +1,671 @@
+class <%= model.pluralize.camelcase %>Controller
+  include Swagger::Blocks
+  <%- model_name = "#{model}".split("::").last || model -%>
+
+  swagger_path "/<%= model_name.pluralize.underscore %>" do
+    operation :get do
+      key :summary, "Index <%= model_name.pluralize.underscore %>"
+      key :produces, [
+        "application/json"
+      ]
+      key :tags, [
+        "<%= model_name.singularize.underscore %>"
+      ]
+      response 200 do
+        key :description, "List of all <%= model_name.pluralize.underscore %>"
+        schema do
+          key :"$ref", :<%= model_name.singularize.underscore %>_index_response
+        end
+      end
+      response 401 do
+        key :description, "Unauthorized"
+      end
+      response 404 do
+        key :description, "Not Found"
+      end
+      response :default do
+        key :description, "Unexpected error"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+    end
+  end
+
+  swagger_path "/<%= model_name.pluralize.underscore %>/{id}" do
+    operation :get do
+      key :summary, "Show <%= model_name.singularize.underscore %>"
+      key :produces, [
+        "application/json"
+      ]
+      key :tags, [
+        "<%= model_name.singularize.underscore %>"
+      ]
+      parameter do
+        key :name, :id
+        key :in, :path
+        key :description, "id of <%= model_name.singularize.underscore %>"
+        key :required, true
+        key :type, :integer
+      end
+      response 200 do
+        key :description, "Show <%= model_name.singularize.underscore %>"
+        schema do
+          key :"$ref", :<%= model_name.singularize.underscore %>_show_response
+        end
+      end
+      response 401 do
+        key :description, "Unauthorized"
+      end
+      response 404 do
+        key :description, "Not Found"
+      end
+      response :default do
+        key :description, "Unexpected error"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+    end
+  end
+
+  swagger_path "/<%= model_name.pluralize.underscore %>" do
+    operation :post do
+      key :summary, "Create <%= model_name.singularize.underscore %>"
+      key :produces, [
+        "application/json"
+      ]
+      key :tags, [
+        "<%= model_name.singularize.underscore %>"
+      ]
+      parameter do
+        key :name, :<%= model_name.singularize.underscore %>_params
+        key :in, :body
+        key :required, true
+        schema do
+          key :"$ref", :create_<%= model_name.singularize.underscore %>
+        end
+      end
+      response 201 do
+        key :description, "<%= model_name.singularize.underscore %>"
+        schema do
+          key :"$ref", :<%= model_name.singularize.underscore %>_create_response
+        end
+      end
+      response 401 do
+        key :description, "Unauthorized"
+      end
+      response 403 do
+        key :description, "Forbidden"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+      response :default do
+        key :description, "Unexpected error"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+    end
+  end
+
+  swagger_path "/<%= model_name.pluralize.underscore %>/{id}" do
+    operation :put do
+      key :summary, "Update <%= model_name.singularize.underscore %>"
+      key :produces, [
+        "application/json"
+      ]
+      key :tags, [
+        "<%= model_name.singularize.underscore %>"
+      ]
+      parameter do
+        key :name, :id
+        key :in, :path
+        key :description, "id of <%= model_name.singularize.underscore %>"
+        key :required, true
+        key :type, :integer
+      end
+      parameter do
+        key :name, :<%= model_name.singularize.underscore %>_params
+        key :in, :body
+        key :required, true
+        schema do
+          key :"$ref", :update_<%= model_name.singularize.underscore %>
+        end
+      end
+      response 200 do
+        key :description, "<%= model_name.singularize.underscore %>"
+        schema do
+          key :"$ref", :<%= model_name.singularize.underscore %>_create_response
+        end
+      end
+      response 401 do
+        key :description, "Unauthorized"
+      end
+      response 202 do
+        key :description, "Accepted"
+      end
+      response 204 do
+        key :description, "No Content"
+      end
+      response 403 do
+        key :description, "Forbidden"
+      end
+      response 404 do
+        key :description, "Not Found"
+      end
+      response 409 do
+        key :description, "Conflict"
+      end
+      response :default do
+        key :description, "Unexpected error"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+    end
+  end
+
+  swagger_path "/<%= model_name.pluralize.underscore %>/{id}" do
+    operation :patch do
+      key :summary, "Update <%= model_name.singularize.underscore %>"
+      key :produces, [
+        "application/json"
+      ]
+      key :tags, [
+        "<%= model_name.singularize.underscore %>"
+      ]
+      parameter do
+        key :name, :id
+        key :in, :path
+        key :description, "id of <%= model_name.singularize.underscore %>"
+        key :required, true
+        key :type, :integer
+      end
+      parameter do
+        key :name, :<%= model_name.singularize.underscore %>_params
+        key :in, :body
+        key :required, true
+        schema do
+          key :"$ref", :update_<%= model_name.singularize.underscore %>
+        end
+      end
+      response 200 do
+        key :description, "<%= model_name.singularize.underscore %>"
+        schema do
+          key :"$ref", :<%= model_name.singularize.underscore %>_create_response
+        end
+      end
+      response 401 do
+        key :description, "Unauthorized"
+      end
+      response 202 do
+        key :description, "Accepted"
+      end
+      response 204 do
+        key :description, "No Content"
+      end
+      response 403 do
+        key :description, "Forbidden"
+      end
+      response 404 do
+        key :description, "Not Found"
+      end
+      response 409 do
+        key :description, "Conflict"
+      end
+      response :default do
+        key :description, "Unexpected error"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+    end
+  end
+  
+  swagger_path "/<%= model_name.pluralize.underscore %>/{id}" do
+    operation :delete do
+      key :summary, "Delete <%= model_name.singularize.underscore %>"
+      key :produces, [
+        "application/json"
+      ]
+      key :tags, [
+        "<%= model_name.singularize.underscore %>"
+      ]
+      parameter do
+        key :name, :id
+        key :in, :path
+        key :description, "id of <%= model_name.singularize.underscore %>"
+        key :required, true
+        key :type, :integer
+      end
+      response 200 do
+        key :description, "Ok"
+      end
+      response 202 do
+        key :description, "Accepted"
+      end
+      response 204 do
+        key :description, "No Content"
+      end
+      response 404 do
+        key :description, "Not Found"
+      end
+      response 401 do
+        key :description, "Unauthorized"
+      end
+      response :default do
+        key :description, "Unexpected error"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+    end
+  end
+<%- relationships = "#{namespace}::#{model_name.camelcase}Resource".constantize._relationships -%>
+<%- if relationships -%>
+<%- relationships.keys.each do |relationship| -%>
+
+  swagger_path "/<%= model_name.pluralize.underscore %>/{<%= model_name.singularize.underscore %>_id}/<%= relationship %>" do
+    operation :get do
+      key :summary, "Show <%= relationship %> from <%= model_name.singularize.underscore %>"
+      key :produces, [
+        "application/json"
+      ]
+      key :tags, [
+        "<%= model_name.singularize.underscore %>"
+      ]
+      response 200 do
+        key :description, "Show <%= relationship %> from <%= model_name.singularize.underscore %>"
+        schema do
+          key :"$ref", :show_<%= relationship %>_from_<%= model_name.singularize.underscore %>_response
+        end
+      end
+      response 401 do
+        key :description, "Unauthorized"
+      end
+      response 403 do
+        key :description, "Forbidden"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+      response 404 do
+        key :description, "Not Found"
+      end
+      response :default do
+        key :description, "Unexpected error"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+    end
+  end
+
+  swagger_path "/<%= model_name.pluralize.underscore %>/{id}/relationships/<%= relationship %>" do
+    operation :get do
+      key :summary, "Show <%= relationship %> from <%= model_name.singularize.underscore %>"
+      key :produces, [
+        "application/json"
+      ]
+      key :tags, [
+        "<%= model_name.singularize.underscore %>"
+      ]
+      parameter do
+        key :name, :id
+        key :in, :path
+        key :description, "id of <%= model_name.singularize.underscore %>"
+        key :required, true
+        key :type, :integer
+      end
+      response 200 do
+        key :description, "Show <%= relationship %> from <%= model_name.singularize.underscore %>"
+        schema do
+          key :"$ref", :show_<%= relationship %>_from_<%= model_name.singularize.underscore %>_relation_response
+        end
+      end
+      response 401 do
+        key :description, "Unauthorized"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+      response 403 do
+        key :description, "Forbidden"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+      response :default do
+        key :description, "Unexpected error"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+    end
+  end
+
+  swagger_path "/<%= model_name.pluralize.underscore %>/{id}/relationships/<%= relationship %>" do
+    operation :put do
+      key :summary, "Update <%= relationship %> from <%= model_name.singularize.underscore %>"
+      key :produces, [
+        "application/json"
+      ]
+      key :tags, [
+        "<%= model_name.singularize.underscore %>"
+      ]
+      parameter do
+        key :name, :id
+        key :in, :path
+        key :description, "id of <%= model_name.singularize.underscore %>"
+        key :required, true
+        key :type, :integer
+      end
+      response 200 do
+        key :description, "Update <%= relationship %> from <%= model_name.singularize.underscore %>"
+        schema do
+          key :"$ref", :update_<%= relationship %>_from_<%= model_name.singularize.underscore %>_relation_response
+        end
+      end
+      response 202 do
+        key :description, "Accepted"
+      end
+      response 204 do
+        key :description, "No Content"
+      end
+      response 401 do
+        key :description, "Unauthorized"
+      end
+      response 403 do
+        key :description, "Forbidden"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+      response :default do
+        key :description, "Unexpected error"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+    end
+  end
+
+  swagger_path "/<%= model_name.pluralize.underscore %>/{id}/relationships/<%= relationship %>" do
+    operation :post do
+      key :summary, "Update <%= relationship %> from <%= model_name.singularize.underscore %>"
+      key :produces, [
+        "application/json"
+      ]
+      key :tags, [
+        "<%= model_name.singularize.underscore %>"
+      ]
+      parameter do
+        key :name, :id
+        key :in, :path
+        key :description, "id of <%= model_name.singularize.underscore %>"
+        key :required, true
+        key :type, :integer
+      end
+      response 200 do
+        key :description, "Update <%= relationship %> from <%= model_name.singularize.underscore %>"
+        schema do
+          key :"$ref", :update_<%= relationship %>_from_<%= model_name.singularize.underscore %>_relation_response
+        end
+      end
+      response 202 do
+        key :description, "Accepted"
+      end
+      response 204 do
+        key :description, "No Content"
+      end
+      response 401 do
+        key :description, "Unauthorized"
+      end
+      response 403 do
+        key :description, "Forbidden"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+      response :default do
+        key :description, "Unexpected error"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+    end
+  end
+
+   swagger_path "/<%= model_name.pluralize.underscore %>/{id}/relationships/<%= relationship %>" do
+    operation :delete do
+      key :summary, "Delete <%= relationship %> from <%= model_name.singularize.underscore %>"
+      key :produces, [
+        "application/json"
+      ]
+      key :tags, [
+        "<%= model_name.singularize.underscore %>"
+      ]
+      parameter do
+        key :name, :id
+        key :in, :path
+        key :description, "id of <%= model_name.singularize.underscore %>"
+        key :required, true
+        key :type, :integer
+      end
+      response 200 do
+        key :description, "Delete <%= relationship %> from <%= model_name.singularize.underscore %>"
+        schema do
+          key :"$ref", :delete_<%= relationship %>_from_<%= model_name.singularize.underscore %>_relation_response
+        end
+      end
+      response 202 do
+        key :description, "Accepted"
+      end
+      response 204 do
+        key :description, "No Content"
+      end
+      response 401 do
+        key :description, "Unauthorized"
+      end
+      response 404 do
+        key :description, "Not Found"
+      end
+      response 403 do
+        key :description, "Forbidden"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+      response :default do
+        key :description, "Unexpected error"
+        schema do 
+          property :errors do
+            property :status do
+              key :type, :integer
+            end
+            property :source do
+              key :type, :string
+            end
+            property :detail do
+              key :type, :string
+            end
+          end
+        end
+      end
+    end
+  end
+<%- end -%>
+<%- end -%>
+end