r2-oas 0.1.0

data/docs/versions/v3.md

@@ -0,0 +1,155 @@
+# v3
+
+## Support Schema
+
+Generate schema yaml like this:
+
+- Schema
+  - openapi
+  - info
+  - tags
+  - paths
+  - externalDocs
+  - servers
+  - security
+  - components
+    - schemas
+    - requestBodies
+    - securitySchemes
+    - parameters
+    - responses (experimental)
+    - examples (experimental)
+    - headers (experimental)
+    - links (experimental)
+    - callbacks (experimental)
+
+## openapi
+
+Support field like this:
+
+|field name|field type|
+|----------|----------|
+|`openapi`|`string`|
+
+[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#openapi-object)
+
+## info
+
+Support field like this:
+
+|field name|field type|
+|----------|----------|
+|`title`|`string`|
+|`description`|`string`|
+|`termsOfService`|`string`|
+|`contact`|`Contact Object`|
+|`license`|`License Object`|
+|`version`|`string`|
+
+[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#info-object)
+
+## tags
+
+Support field like this:
+
+|field name|field type|
+|----------|----------|
+|`name`|`string`|
+|`description`|`string`|
+|`externalDocs`|`External Document Object`|
+
+[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#tagObject)
+
+## paths
+
+Support field like this:
+
+|field name|field type|
+|----------|----------|
+|`/{path}`|`Path Item Object`|
+
+[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#paths-object)
+
+for example:
+```
+paths:
+  "/users":
+    post:
+      tags:
+      - user
+      summary: post summary
+      description: post description
+      responses:
+        default:
+          description: ''
+      deprecated: false
+  "/{model_name}/{id}":
+    get:
+      tags:
+      - rails_admin/main
+      summary: get summary
+      description: get description
+      responses:
+        default:
+          description: ''
+        '200':
+          description: rails_admin/main description
+          content:
+            application/json:
+              schema:
+                "$ref": "#/components/schemas/Main"
+      deprecated: false
+      parameters:
+      - name: model_name
+        in: path
+        description: model_name
+        required: true
+        schema:
+          type: string
+      - name: id
+        in: path
+        description: id
+        required: true
+        schema:
+          type: integer
+```
+
+## externalDocs
+
+Support field like this:
+
+|field name|field type|
+|----------|----------|
+|`description`|`string`|
+|`url`|`string`|
+
+[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#external-documentation-object)
+
+## servers
+
+Support field like this:
+
+|field name|field type|
+|----------|----------|
+|`url`|`string`|
+|`description`|`string`|
+
+[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#server-object)
+
+## components
+
+Support field like this:
+
+|field name|field type|
+|----------|----------|
+|`schemas`| `Schema Object` |
+|`requestBodies`| `Request Body Object`|
+|`securitySchemes`| `Security Schemes Object` |
+|`parameters`| `Parameter Object` |
+|`responses`| `Response Object` |
+|`examples`| `Example Object` |
+|`headers`| `Header Object` |
+|`links`|`Link Object` |
+|`callbacks`| `Callback Object`|
+
+[show more...](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#components-object)

data/lib/r2-oas.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'r2-oas/version'
+require 'r2-oas/configuration'
+require 'r2-oas/errors'
+require 'r2-oas/schema/v3/object/public'
+
+module R2OAS
+  extend ActiveSupport::Autoload
+
+  if !defined?(::Rails)
+    raise NoImplementError, 'Can not load Rails'
+  # support Rails version
+  elsif ::Rails::VERSION::STRING >= '4.2.5.1'
+    extend Configuration
+    require 'r2-oas/task'
+
+    autoload :Base, 'r2-oas/base'
+    autoload :NoImplementError, 'r2-oas/errors'
+    autoload :NoFileExistsError, 'r2-oas/errors'
+    autoload :NoSupportError, 'r2-oas/errors'
+    autoload :Sortable, 'r2-oas/shared/all'
+
+    module Schema
+      extend ActiveSupport::Autoload
+
+      autoload :Base, 'r2-oas/schema/base'
+      autoload :Generator, 'r2-oas/schema/generator'
+      autoload :Analyzer, 'r2-oas/schema/analyzer'
+      autoload :Squeezer, 'r2-oas/schema/squeezer'
+      autoload :Cleaner, 'r2-oas/schema/cleaner'
+    end
+  else
+    raise NoImplementError, "Do not support Rails Version: #{::Rails::VERSION::STRING}"
+  end
+end

data/lib/r2-oas/app_configuration.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative 'app_configuration/server'
+require_relative 'app_configuration/swagger'
+require_relative 'app_configuration/tool'
+
+module R2OAS
+  module AppConfiguration
+    DEFAULT_VERSION = :v3
+    DEFAULT_ROOT_DIR_PATH = './oas_docs'
+    DEFAULT_SCHEMA_SAVE_DIR_NAME = 'src'
+    DEFAULT_DOC_SAVE_FILE_NAME = 'oas_doc.yml'
+    DEFAULT_FORCE_UPDATE_SCHEMA = false
+    DEFAULT_USE_TAG_NAMESPACE = true
+    DEFAULT_USE_SCHEMA_NAMESPACE = true
+    DEFAULT_SERVER = Server.new
+    DEFAULT_INTERVAL_TO_SAVE_EDITED_TMP_SCHEMA = 15
+    DEFAULT_SWAGGER = Swagger.new
+    # rubocop:disable Style/MutableConstant
+    DEFAULT_HTTP_STATUSES_WHEN_HTTP_METHOD = {
+      get: {
+        default: %w[200 422],
+        path_parameter: %w[200 404 422]
+      },
+      post: {
+        default: %w[201 422],
+        path_parameter: %w[201 404 422]
+      },
+      patch: {
+        default: %w[204 422],
+        path_parameter: %w[204 404 422]
+      },
+      put: {
+        default: %w[204 422],
+        path_parameter: %w[204 404 422]
+      },
+      delete: {
+        default: %w[200 422],
+        path_parameter: %w[200 404 422]
+      }
+    }
+    DEFAULT_HTTP_METHODS_WHEN_GENERATE_REQUEST_BODY = %w[post patch put]
+    # rubocop:enable Style/MutableConstant
+    DEFAULT_TOOL = Tool.new
+    # :dot or :underbar
+    DEFAULT_NAMESPACE_TYPE = :underbar
+    DEFAULT_DEPLOY_DIR_PATH = "./deploy_docs"
+
+    PUBLIC_VALID_OPTIONS_KEYS = %i[
+      version
+      root_dir_path
+      schema_save_dir_name
+      doc_save_file_name
+      force_update_schema
+      use_tag_namespace
+      use_schema_namespace
+      server
+      interval_to_save_edited_tmp_schema
+      swagger
+      http_statuses_when_http_method
+      http_methods_when_generate_request_body
+      tool
+      namespace_type
+      deploy_dir_path
+    ].freeze
+
+    UNPUBLIC_VALID_OPTIONS_KEYS = %i[
+      paths_config
+      logger
+    ].freeze
+
+    VALID_OPTIONS_KEYS = PUBLIC_VALID_OPTIONS_KEYS + UNPUBLIC_VALID_OPTIONS_KEYS
+
+    attr_accessor *PUBLIC_VALID_OPTIONS_KEYS
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    private
+
+    module_function def set_default(target)
+      target.version                                 = DEFAULT_VERSION
+      target.root_dir_path                           = DEFAULT_ROOT_DIR_PATH
+      target.schema_save_dir_name                    = DEFAULT_SCHEMA_SAVE_DIR_NAME
+      target.doc_save_file_name                      = DEFAULT_DOC_SAVE_FILE_NAME
+      target.force_update_schema                     = DEFAULT_FORCE_UPDATE_SCHEMA
+      target.use_tag_namespace                       = DEFAULT_USE_TAG_NAMESPACE
+      target.use_schema_namespace                    = DEFAULT_USE_SCHEMA_NAMESPACE
+      target.server                                  = DEFAULT_SERVER
+      target.interval_to_save_edited_tmp_schema      = DEFAULT_INTERVAL_TO_SAVE_EDITED_TMP_SCHEMA
+      target.swagger                                 = DEFAULT_SWAGGER
+      target.http_statuses_when_http_method          = DEFAULT_HTTP_STATUSES_WHEN_HTTP_METHOD
+      target.tool                                    = DEFAULT_TOOL
+      target.http_methods_when_generate_request_body = DEFAULT_HTTP_METHODS_WHEN_GENERATE_REQUEST_BODY
+      target.namespace_type                          = DEFAULT_NAMESPACE_TYPE
+      target.deploy_dir_path                         = DEFAULT_DEPLOY_DIR_PATH
+    end
+  end
+end

data/lib/r2-oas/app_configuration/server.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module AppConfiguration
+    class Server
+      DEFAULT_URL = 'http://localhost:3000'
+      DEFAULT_DESCRIPTION = 'localhost'
+
+      VALID_OPTIONS_KEYS = [
+        :data
+      ].freeze
+
+      attr_accessor *VALID_OPTIONS_KEYS
+
+      def initialize
+        set_default
+      end
+
+      def configure
+        yield self
+      end
+
+      private
+
+      def set_default
+        self.data = [
+          {
+            url: DEFAULT_URL,
+            description: DEFAULT_DESCRIPTION
+          }
+        ]
+      end
+    end
+  end
+end

data/lib/r2-oas/app_configuration/swagger.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'swagger/ui'
+require_relative 'swagger/editor'
+
+module R2OAS
+  module AppConfiguration
+    class Swagger
+      DEFAULT_EDITOR = Editor.new
+      DEFAULT_UI     = UI.new
+
+      VALID_OPTIONS_KEYS = %i[
+        editor
+        ui
+      ].freeze
+
+      attr_accessor *VALID_OPTIONS_KEYS
+
+      def initialize
+        set_default
+      end
+
+      def configure
+        yield self
+      end
+
+      private
+
+      def set_default
+        self.editor = DEFAULT_EDITOR
+        self.ui     = DEFAULT_UI
+      end
+    end
+  end
+end

data/lib/r2-oas/app_configuration/swagger/editor.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module AppConfiguration
+    class Swagger
+      class Editor
+        DEFAULT_IMAGE         = 'swaggerapi/swagger-editor'
+        DEFAULT_PORT          = '81'
+        DEFAULT_EXPOSED_PORT  = '8080/tcp'
+        DEFAULT_STORAGE_KEY   = 'swagger-editor-content' # Fixed
+        DEFAULT_HOST          = 'http://localhost'       # Fixed
+
+        VALID_OPTIONS_KEYS = %i[
+          image
+          port
+          exposed_port
+        ].freeze
+
+        attr_accessor *VALID_OPTIONS_KEYS
+
+        def initialize
+          set_default
+        end
+
+        def configure
+          yield self
+        end
+
+        def url
+          "#{DEFAULT_HOST}:#{port}"
+        end
+
+        def storage_key
+          DEFAULT_STORAGE_KEY
+        end
+
+        private
+
+        def set_default
+          self.image         = DEFAULT_IMAGE
+          self.port          = DEFAULT_PORT
+          self.exposed_port  = DEFAULT_EXPOSED_PORT
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/app_configuration/swagger/ui.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module R2OAS
+  module AppConfiguration
+    class Swagger
+      class UI
+        DEFAULT_IMAGE        = 'swaggerapi/swagger-ui'
+        DEFAULT_PORT         = '8080'
+        DEFAULT_EXPOSED_PORT = '8080/tcp'
+        DEFAULT_VOLUME       = '/app/swagger.json'
+        DEFAULT_HOST         = 'http://localhost' # Fixed
+
+        VALID_OPTIONS_KEYS = %i[
+          image
+          port
+          exposed_port
+          volume
+        ].freeze
+
+        attr_accessor *VALID_OPTIONS_KEYS
+
+        def initialize
+          set_default
+        end
+
+        def configure
+          yield self
+        end
+
+        def url
+          "#{DEFAULT_HOST}:#{port}"
+        end
+
+        private
+
+        def set_default
+          self.image        = DEFAULT_IMAGE
+          self.port         = DEFAULT_PORT
+          self.exposed_port = DEFAULT_EXPOSED_PORT
+          self.volume       = DEFAULT_VOLUME
+        end
+      end
+    end
+  end
+end