dry_crud_jsonapi_swagger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ca6f8559b627d78879620ecdc23cf364c2c66a9bdc250413583822a207c2bdb
+  data.tar.gz: acd211a583d25f1b71793298e05fde5cf4eee4fb3f09eba1c673256abed65a30
+SHA512:
+  metadata.gz: 42337d4de64d59e9c28e6cc456e5f5dd7c7b919618de928a0a9fbc8a1fa9564b114044e55e958deae231d8258c71de26979cff06c357871a90a5f372c918bb44
+  data.tar.gz: 64089c5fdf47d6797861726b496811b4f7a05978ce29f33f76eb7c0af6095583da13acbfcb8a6e68fc4499f6160f92a6385a5f37cbbcd0dd3ab9b81d206e1697

data/README.md

@@ -0,0 +1,28 @@
+# DryCrudJsonapiSwagger
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry_crud_jsonapi_swagger'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install dry_crud_jsonapi_swagger
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require "bundler/gem_tasks"

data/app/controllers/apidocs_controller.rb

@@ -0,0 +1,31 @@
+class ApidocsController < ApplicationController
+  skip_before_action :authenticate, only: [:show]
+  skip_authorization_check
+
+  layout false
+
+  def show
+    respond_to do |format|
+      format.html
+      format.json { render json: generate_doc }
+    end
+  end
+
+  private
+
+  def generate_doc
+    Swagger::Setup.new(request.url, controller_classes).run
+  end
+
+  def controller_classes
+    Rails.application.eager_load! if Rails.env.development?
+    json_api_controllers
+  end
+
+  def json_api_controllers
+    ListController.descendants.select { |model| model.include?(DryCrudJsonapi) }.select do |controller|
+      controller.model_class rescue false
+    end
+  end
+
+end

data/app/domain/swagger/controller_setup.rb

@@ -0,0 +1,37 @@
+module Swagger
+  class ControllerSetup
+    include Rails.application.routes.url_helpers
+    include Swagger::Helper
+    attr_reader :controller_class
+
+    def initialize(controller_class)
+      @controller_class = controller_class
+    end
+
+    def run
+      setup_index_path
+      setup_show_path
+    end
+
+    def setup_index_path
+      setup_swagger_path(index_path) do |helper|
+        helper.path_spec(self, helper, :index)
+      end
+    end
+
+    def setup_show_path
+      setup_swagger_path(show_path) do |helper|
+        helper.path_spec(self, helper, :show)
+      end
+    end
+
+    def show_path
+      polymorphic_path(model_name.singular_route_key, id: 1) rescue nil
+    end
+
+    def index_path
+      polymorphic_path(model_name.route_key) rescue nil
+    end
+
+  end
+end

data/app/domain/swagger/helper.rb

@@ -0,0 +1,130 @@
+module Swagger
+  module Helper
+
+    def setup_swagger_path(path, helper = self, &block)
+      return unless path
+      @path = path.gsub('1', '{id}')
+      controller_class.send(:swagger_path, @path) do
+        instance_exec(helper, &block)
+      end
+    end
+
+    def model_name
+      controller_class.model_class.model_name
+    end
+
+    def human_name
+      model_name.human
+    end
+
+    def nested_human_name
+      nested_model_name.human
+    end
+
+    def controller_route
+      controller_class.model_class.new(id: 1)
+    end
+
+    def nested_root_path
+      nested_model_name.route_key
+    end
+
+    def nested_controller_id
+      controller_class.model_class.model_name.route_key.singularize + '_id'
+    end
+
+    def nested_model_name
+      nested_class.model_class.model_name
+    end
+
+    def description(controller = controller_class)
+      # relationships = controller.model_class
+      #   .reflect_on_all_associations(:belongs_to)
+      #   .map(&:name).sort
+      #
+      # relationships += controller.model_class
+      # .reflect_on_all_associations(:has_many)
+      # .map(&:name).sort
+
+      relationships = controller.model_class
+        .reflect_on_all_associations
+        .map(&:name).sort
+
+      'The following relationships are available: ' \
+        "#{relationships.join(', ')} (separate values with a comma)"
+    end
+
+    def path_spec(swagger_doc, helper, type) # rubocop:disable Metrics/MethodLength
+      summary =
+        case type.to_sym
+        when :index  then "All #{human_name.pluralize}"
+        when :show   then "Single #{human_name}"
+        when :nested then "All #{nested_human_name.pluralize} belonging to #{human_name}"
+        end
+
+      swagger_doc.operation :get do
+        key :summary, summary
+        helper.setup_tags(self)
+        helper.parameters(self, helper, type)
+        response 200 do
+          key :description, summary + ' Response'
+          helper.response_schema(self, helper, type)
+        end
+      end
+    end
+
+    def setup_tags(swagger_doc)
+      swagger_doc.key :tags, [
+        'All',
+        Swagger::TagsSetup.path_tag(@path)
+      ]
+    end
+
+    def parameters(swagger_doc, helper, type)
+      case type.to_sym
+      when :show, :nested then parameter_id swagger_doc, helper
+      end
+
+      parameter_include swagger_doc, helper, type
+    end
+
+    def parameter_id(swagger_doc, helper)
+      swagger_doc.parameter do
+        key :name, :id
+        key :in, :path
+        key :description, "ID of #{helper.human_name} to fetch"
+        key :required, true
+        key :type, :integer
+      end
+    end
+
+    def parameter_include(swagger_doc, helper, type) # rubocop:disable Metrics/MethodLength
+      desc = case type.to_sym
+             when :index, :show then description
+             when :nested       then description helper.nested_class
+             end
+      swagger_doc.parameter do
+        key :name,        :include
+        key :in,          :query
+        key :description, desc
+        key :required,    false
+        key :type,        :string
+      end
+    end
+
+    def response_schema(swagger_doc, helper, type)
+      ref = case type.to_sym
+            when :index, :show then helper.model_name
+            when :nested       then helper.nested_model_name
+            end
+
+      swagger_doc.schema do
+        key :type, :array
+        items do
+          key :'$ref', ref
+        end
+      end
+    end
+
+  end
+end

data/app/domain/swagger/nested_controller_setup.rb

@@ -0,0 +1,53 @@
+module Swagger
+  class NestedControllerSetup
+    include Rails.application.routes.url_helpers
+    include Swagger::Helper
+
+    attr_reader :controller_class, :controller_classes, :nested_class
+
+    def initialize(controller_classes, controller_class)
+      @controller_classes = controller_classes
+      @controller_class = controller_class
+    end
+
+    def run
+      setup_nestings
+    end
+
+    private
+
+    def setup_nestings
+      collect_nestings.each do |nested|
+        @nested_class = nested
+        setup_nesting
+      end
+    end
+
+    def setup_nesting
+      setup_swagger_path(nested_path) do |helper|
+        helper.path_spec(self, helper, :nested)
+      end
+    end
+
+    def nested_path
+      polymorphic_path([controller_route, nested_root_path]) rescue nil
+    end
+
+    def collect_nestings
+      controller_classes.collect do |controller|
+        controller if nested? controller
+      end.flatten.compact
+    end
+
+    def nested?(controller)
+      return false if controller == controller_class
+
+      nested = []
+      #nested << controller.optional_nesting || []
+      nested << controller.nesting          || []
+
+      nested.flatten.include? controller_class.model_class
+    end
+
+  end
+end

data/app/domain/swagger/setup.rb

@@ -0,0 +1,102 @@
+module Swagger
+  class Setup
+    attr_reader :request_uri, :controller_classes
+
+    def initialize(request_url, controller_classes)
+      @request_uri = URI.parse(request_url)
+      @controller_classes = controller_classes
+    end
+
+    def run
+      swaggered_classes = [setup_metadata, setup_controllers, setup_models].flatten
+      Swagger::Blocks.build_root_json(swaggered_classes)
+    end
+
+    def host
+      "#{request_uri.host}:#{request_uri.port}"
+    end
+
+    def json_api_mimetype
+      JSONAPI::Rails::Railtie::MEDIA_TYPE
+    end
+
+    def setup_tags(swagger_doc)
+      Swagger::TagsSetup.new(swagger_doc).run
+    end
+
+    private
+
+    def setup_metadata # rubocop:disable Metrics/MethodLength
+      ApidocsController.instance_exec(self) do |helper|
+        include Swagger::Blocks
+        swagger_root do
+          key :swagger, '2.0'
+          info do
+            key :version, Puzzletime.version
+            key :title, 'Puzzletime'
+            contact do
+              key :name, 'Puzzletime Team'
+            end
+          end
+          helper.setup_tags(self)
+          key :host, helper.host
+          key :schemes, [helper.request_uri.scheme]
+          key :basePath, '/'
+          key :produces, [helper.json_api_mimetype]
+          key :consumes, [helper.json_api_mimetype]
+          security_definition 'BasicAuth' do
+            key :type, 'basic'
+          end
+        end
+      end
+      ApidocsController
+    end
+
+    def setup_controllers
+      controller_classes.each(&method(:setup_controller))
+      controller_classes
+    end
+
+    def setup_models
+      exposed_models.each(&method(:setup_model))
+      exposed_models
+    end
+
+    def exposed_models
+      root_models = controller_classes.map(&:model_class)
+      (root_models + root_models.map(&:reflect_on_all_associations).flatten.map(&:klass)).uniq
+    end
+
+    def setup_model(model_class)
+      model_class.instance_exec(self) do |_helper|
+        include Swagger::Blocks
+        swagger_schema model_class.name.to_sym do
+          model_class.columns.each do |column|
+            property column.name do
+              case column.type
+              when :float
+                key :type, 'number'
+              when :date
+                key :type, 'string'
+                key :format, 'date'
+              when :time
+                key :type, 'string'
+                key :format, 'date-time'
+              else
+                key :type, column.type
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def setup_controller(controller_class)
+      controller_class.send :include, Swagger::Blocks
+      Swagger::ControllerSetup.new(controller_class).run
+      Swagger::NestedControllerSetup.new(controller_classes, controller_class).run
+    end
+
+  end
+
+end

data/app/domain/swagger/tags_setup.rb

@@ -0,0 +1,46 @@
+module Swagger
+  class TagsSetup
+
+    def initialize(swagger_doc = nil)
+      @swagger_doc = swagger_doc
+    end
+
+    def run
+      setup_tags
+    end
+
+    def self.path_tag(path)
+      new.get_tag_by_path(path)
+    end
+
+    def get_tag_by_path(path)
+      tags.each do |tag|
+        next if tag['include'].blank?
+
+        tag['include'].each do |inc|
+          return tag['name'] if path =~ /#{inc}/i
+        end
+
+      end
+    end
+
+    private
+
+
+    def setup_tags
+      tags.each do |tag|
+        @swagger_doc.tags tag.slice('name', 'description', 'externalDocs')
+      end
+    end
+
+    def tags
+      @tags ||= load_tags['tags']
+    end
+
+    def load_tags
+      require 'yaml'
+      YAML.load_file(Rails.root.join('config', 'swagger-tags.yml')) # TODO: what is this for? fill yml with sensible values
+    end
+
+  end
+end

data/config/initializers/rswag-ui.rb

@@ -0,0 +1,10 @@
+Rswag::Ui.configure do |c|
+
+  # List the Swagger endpoints that you want to be documented through the swagger-ui
+  # The first parameter is the path (absolute or relative to the UI host) to the corresponding
+  # JSON endpoint and the second is a title that will be displayed in the document selector
+  # NOTE: If you're using rspec-api to expose Swagger files (under swagger_root) as JSON endpoints,
+  # then the list below should correspond to the relative paths for those endpoints
+
+  c.swagger_endpoint '/apidocs.json', 'API Docs'
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  mount Rswag::Ui::Engine => '/apidocs'
+  get 'apidocs', to: 'apidocs#show', constraints: { format: 'json' }
+end

data/lib/dry_crud_jsonapi_swagger/engine.rb

@@ -0,0 +1,7 @@
+require "rswag/ui"
+require "swagger/blocks"
+
+module DryCrudJsonapiSwagger
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/dry_crud_jsonapi_swagger/version.rb

@@ -0,0 +1,3 @@
+module DryCrudJsonapiSwagger
+  VERSION = '0.1.0'
+end

data/lib/dry_crud_jsonapi_swagger.rb

@@ -0,0 +1,5 @@
+require "dry_crud_jsonapi_swagger/engine"
+
+module DryCrudJsonapiSwagger
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: dry_crud_jsonapi_swagger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Illi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: dry_crud_jsonapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rswag-ui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: swagger-blocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: 
+email:
+- illi@puzzle.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/apidocs_controller.rb
+- app/domain/swagger/controller_setup.rb
+- app/domain/swagger/helper.rb
+- app/domain/swagger/nested_controller_setup.rb
+- app/domain/swagger/setup.rb
+- app/domain/swagger/tags_setup.rb
+- config/initializers/rswag-ui.rb
+- config/routes.rb
+- lib/dry_crud_jsonapi_swagger.rb
+- lib/dry_crud_jsonapi_swagger/engine.rb
+- lib/dry_crud_jsonapi_swagger/version.rb
+homepage: https://rubygems.org/gems/dry_crud_jsonapi_swagger
+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.6
+signing_key: 
+specification_version: 4
+summary: Automatic swagger documentation for dry_crud_jsonapi
+test_files: []