jsapi 0.7.3 → 0.9.0

data/lib/jsapi/meta/openapi/external_documentation.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      # Represents an external documentation object.
-      class ExternalDocumentation < Meta::Base::Model
-        include Extensions
-
-        ##
-        # :attr: description
-        # The optional description of the external documentation.
-        attribute :description, String
-
-        ##
-        # :attr: url
-        # The URL of the external documentation.
-        attribute :url, String
-
-        # Returns a hash representing the \OpenAPI external documentation object.
-        def to_openapi(*)
-          with_openapi_extensions(url: url, description: description)
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/header/model.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module Header
-        class Model < Meta::Base::Model
-          include Extensions
-
-          delegate_missing_to :schema
-
-          ##
-          # :attr: collection_format
-          # The collection format of a header whose values are arrays. Possible values are:
-          #
-          # - <code>"csv"</code> -  comma separated values
-          # - <code>"pipes"</code> - pipe separated values
-          # - <code>"ssv"</code> - space separated values
-          # - <code>"tsv"</code> - tab separated values
-          #
-          # Applies to \OpenAPI 2.0.
-          attribute :collection_format, values: %w[csv pipes ssv tsv]
-
-          ##
-          # :attr: deprecated
-          # Specifies whether or not the header is deprecated.
-          attribute :deprecated, values: [true, false]
-
-          ##
-          # :attr: description
-          # The description of the header.
-          attribute :description, String
-
-          ##
-          # :attr_reader: examples
-          # One or more example values.
-          attribute :examples, { String => Example }, default_key: 'default'
-
-          ##
-          # :attr_reader: schema
-          # The Schema of the header.
-          attribute :schema, read_only: true
-
-          def initialize(keywords = {})
-            raise ArgumentError, "type can't be object" if keywords[:type] == 'object'
-
-            keywords = keywords.dup
-            super(
-              keywords.extract!(
-                :collection_format, :deprecated, :description, :examples, :openapi_extensions
-              )
-            )
-            add_example(value: keywords.delete(:example)) if keywords.key?(:example)
-
-            @schema = Schema.new(keywords)
-          end
-
-          # Returns a hash representing the \OpenAPI header object.
-          def to_openapi(version)
-            version = OpenAPI::Version.from(version)
-
-            with_openapi_extensions(
-              if version.major == 2
-                schema.to_openapi(version).merge(
-                  collection_format: (collection_format if array?),
-                  description: description
-                )
-              else
-                {
-                  description: description,
-                  deprecated: deprecated?.presence,
-                  schema: schema.to_openapi(version),
-                  examples: examples&.transform_values(&:to_openapi)
-                }
-              end
-            )
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/header/reference.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module Header
-        class Reference < Meta::Base::Reference
-          # Returns a hash representing the \OpenAPI reference object.
-          def to_openapi(*)
-            { '$ref': "#/components/headers/#{ref}" }
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/header.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'header/model'
-require_relative 'header/reference'
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module Header
-        class << self
-          # Creates a header model or reference.
-          def new(keywords = {})
-            return Reference.new(keywords) if keywords.key?(:ref)
-
-            Model.new(keywords)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/info.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      # Represents an info object.
-      class Info < Meta::Base::Model
-        include Extensions
-
-        ##
-        # :attr: contact
-        # The optional Contact object.
-        attribute :contact, Contact
-
-        ##
-        # :attr: description
-        # The optional description of the API.
-        attribute :description, String
-
-        ##
-        # :attr: license
-        # The optional License object.
-        attribute :license, License
-
-        ##
-        # :attr: terms_of_service
-        # The optional URL pointing to the terms of service.
-        attribute :terms_of_service, String
-
-        ##
-        # :attr: title
-        # The title of the API.
-        attribute :title, String
-
-        ##
-        # :attr: version
-        # The version of the API.
-        attribute :version, String
-
-        # Returns a hash representing the \OpenAPI info object.
-        def to_openapi(*)
-          with_openapi_extensions(
-            title: title,
-            version: version,
-            description: description,
-            termsOfService: terms_of_service,
-            contact: contact&.to_openapi,
-            license: license&.to_openapi
-          )
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/license.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      # Represents a license object.
-      class License < Meta::Base::Model
-        include Extensions
-
-        ##
-        # :attr: name
-        # The name of the license.
-        attribute :name, String
-
-        ##
-        # :attr: url
-        # The optional URL of the license.
-        attribute :url, String
-
-        # Returns a hash representing the \OpenAPI license object.
-        def to_openapi(*)
-          with_openapi_extensions(name: name, url: url)
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/link/model.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module Link
-        # Represents a link object.
-        class Model < Meta::Base::Model
-          include Extensions
-
-          ##
-          # :attr: description
-          # The optional description of the link.
-          attribute :description, String
-
-          ##
-          # :attr: operation_id
-          # The operation ID.
-          attribute :operation_id, String
-
-          ##
-          # :attr: parameters
-          # The optional parameters to be passed.
-          attribute :parameters, { String => Object }
-
-          ##
-          # :attr: request_body
-          # The optional request body to be passed.
-          attribute :request_body
-
-          ##
-          # :attr: server
-          # The optional Server object.
-          attribute :server, Server
-
-          # Returns a hash representing the \OpenAPI link object.
-          def to_openapi(*)
-            with_openapi_extensions(
-              operationId: operation_id,
-              parameters: parameters,
-              requestBody: request_body,
-              description: description,
-              server: server&.to_openapi
-            )
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/link/reference.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module Link
-        class Reference < Meta::Base::Reference
-          # Returns a hash representing the \OpenAPI reference object.
-          def to_openapi(*)
-            { '$ref': "#/components/links/#{ref}" }
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/link.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'link/model'
-require_relative 'link/reference'
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module Link
-        class << self
-          # Creates a link model or reference.
-          def new(keywords = {})
-            return Reference.new(keywords) if keywords.key?(:ref)
-
-            Model.new(keywords)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/oauth_flow.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      # Represents an OAuth flow object.
-      class OAuthFlow < Base::Model
-        include Extensions
-
-        class Scope < Meta::Base::Model
-          ##
-          # :attr: description
-          # The optional description of the scope.
-          attribute :description, String, default: ''
-        end
-
-        ##
-        # :attr: authorization_url
-        # The authorization URL to be used for the flow.
-        attribute :authorization_url, String
-
-        ##
-        # :attr: refresh_url
-        # The refresh URL to be used for the flow.
-        #
-        # Note that the refresh URL was introduced with \OpenAPI 3.0. It is
-        # skipped when generating an \OpenAPI 2.0 document.
-        attribute :refresh_url, String
-
-        ##
-        # :attr: scopes
-        # The hash containing the scopes.
-        attribute :scopes, { String => Scope }, default: {}
-
-        ##
-        # :attr: token_url
-        # The token URL to be used for the flow.
-        attribute :token_url, String
-
-        # Returns a hash representing the \OpenAPI OAuth flow object.
-        def to_openapi(version)
-          with_openapi_extensions(
-            authorizationUrl: authorization_url,
-            tokenUrl: token_url,
-            refreshUrl: (refresh_url if version.major > 2),
-            scopes: scopes.transform_values(&:description)
-          )
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/root.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      # Represents an \OpenAPI object.
-      class Root < Meta::Base::Model
-        include Extensions
-
-        ##
-        # :attr: callbacks
-        # The reusable Callback objects. Applies to \OpenAPI 3.0 and higher.
-        attribute :callbacks, { String => Callback }
-
-        ##
-        # :attr: base_path
-        # The base path of the API. Applies to \OpenAPI 2.0.
-        attribute :base_path, String
-
-        ##
-        # :attr: examples
-        # The reusable Example objects. Applies to \OpenAPI 3.0 and higher.
-        attribute :examples, { String => Example }
-
-        ##
-        # :attr: external_docs
-        # The ExternalDocumentation object.
-        attribute :external_docs, ExternalDocumentation
-
-        ##
-        # :attr: headers
-        # The reusable Header objects. Applies to \OpenAPI 3.0 and higher.
-        attribute :headers, { String => Header }
-
-        ##
-        # :attr: host
-        # The host serving the API. Applies to \OpenAPI 2.0.
-        attribute :host, String
-
-        ##
-        # :attr: info
-        # The Info object.
-        attribute :info, Info
-
-        ##
-        # :attr: links
-        # The reusable Link objects. Applies to \OpenAPI 3.0 and higher.
-        attribute :links, { String => Link }
-
-        ##
-        # :attr: schemes
-        # The array of transfer protocols supported by the API. Possible values are:
-        #
-        # - <code>"http"</code>
-        # - <code>"https"</code>
-        # - <code>"ws"</code>
-        # - <code>"wss"</code>
-        #
-        # Applies to \OpenAPI 2.0.
-        attribute :schemes, [String], values: %w[http https ws wss]
-
-        ##
-        # :attr: security_requirements
-        # The array of SecurityRequirement objects.
-        attribute :security_requirements, [SecurityRequirement]
-
-        alias add_security add_security_requirement
-
-        ##
-        # :attr_reader: security_schemes
-        # The security schemes.
-        attribute :security_schemes, { String => SecurityScheme }
-
-        ##
-        # :attr: servers
-        # The array of Server objects. Applies to \OpenAPI 3.0 and higher.
-        attribute :servers, [Server]
-
-        ##
-        # :attr: tags
-        # The array of Tag objects.
-        attribute :tags, [Tag]
-
-        # Returns a hash representing the \OpenAPI object.
-        def to_openapi(version, definitions)
-          version = Version.from(version)
-          security_schemes =
-            self.security_schemes&.transform_values do |value|
-              value.to_openapi(version)
-            end
-
-          with_openapi_extensions(
-            if version.major == 2
-              uri = servers&.first&.then { |server| URI(server.url) }
-              {
-                swagger: '2.0',
-                info: info&.to_openapi,
-                host: host || uri&.hostname,
-                basePath: base_path || uri&.path,
-                schemes: schemes || uri&.scheme&.then { |scheme| [scheme] },
-                securityDefinitions: security_schemes,
-                security: security_requirements&.map(&:to_openapi),
-                tags: tags&.map(&:to_openapi),
-                externalDocs: external_docs&.to_openapi
-              }
-            else
-              {
-                openapi: version.minor.zero? ? '3.0.3' : '3.1.0',
-                info: info&.to_openapi,
-                servers: servers&.map(&:to_openapi),
-                components: {
-                  callbacks: callbacks&.transform_values do |callback|
-                    callback.to_openapi(version, definitions)
-                  end,
-                  examples: examples&.transform_values(&:to_openapi),
-                  headers: headers&.transform_values do |header|
-                    header.to_openapi(version)
-                  end,
-                  links: links&.transform_values(&:to_openapi),
-                  securitySchemes: security_schemes
-                }.compact.presence,
-                security: security_requirements&.map(&:to_openapi),
-                tags: tags&.map(&:to_openapi),
-                externalDocs: external_docs&.to_openapi
-              }
-            end
-          )
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/security_requirement.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      # Represents a security requirement object.
-      class SecurityRequirement < Meta::Base::Model
-        class Scheme < Meta::Base::Model
-          ##
-          # :attr: scopes
-          # The array of scopes.
-          attribute :scopes, [String], default: []
-        end
-
-        ##
-        # :attr_reader: schemes
-        # The schemes.
-        attribute :schemes, { String => Scheme }
-
-        # Returns a hash representing the \OpenAPI security requirement object.
-        def to_openapi(*)
-          schemes&.transform_values(&:scopes) || {}
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/security_scheme/api_key.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module SecurityScheme
-        # Represents a security scheme based on an API key.
-        class APIKey < Base
-          include Extensions
-
-          ##
-          # :attr: in
-          # The location of the API key. Possible values are:
-          #
-          # - <code>"cookie"</code>
-          # - <code>"header"</code>
-          # - <code>"query"</code>
-          #
-          attribute :in, String, values: %w[cookie header query]
-
-          ##
-          # :attr: name
-          # The name of the header, query parameter or cookie the
-          # API key is sent by.
-          attribute :name, String
-
-          # Returns a hash representing the \OpenAPI security scheme object.
-          def to_openapi(*)
-            with_openapi_extensions(
-              type: 'apiKey',
-              name: name,
-              in: self.in,
-              description: description
-            )
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/security_scheme/base.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module SecurityScheme
-        class Base < Meta::Base::Model
-          ##
-          # :attr: description
-          # The optional description of the security scheme.
-          attribute :description, String
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/security_scheme/http/basic.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module SecurityScheme
-        module HTTP
-          # Represents a security scheme based on \HTTP basic authentication.
-          class Basic < Base
-            include Extensions
-
-            # Returns a hash representing the \OpenAPI security scheme object.
-            def to_openapi(version)
-              version = OpenAPI::Version.from(version)
-
-              with_openapi_extensions(
-                if version.major == 2
-                  {
-                    type: 'basic',
-                    description: description
-                  }
-                else
-                  {
-                    type: 'http',
-                    scheme: 'basic',
-                    description: description
-                  }
-                end
-              )
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/openapi/security_scheme/http/bearer.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module SecurityScheme
-        module HTTP
-          # Represents a security scheme based on bearer authentication.
-          #
-          # Note that Bearer authentication was introduced with \OpenAPI 3.0.
-          # Thus, a security scheme of this class is skipped when generating
-          # an \OpenAPI 2.0 document.
-          class Bearer < Base
-            include Extensions
-
-            ##
-            # :attr: bearer_format
-            # The optional format of the bearer token.
-            attribute :bearer_format, String
-
-            # Returns a hash representing the \OpenAPI security scheme object, or
-            # +nil+ if <code>version.major</code> is 2.
-            def to_openapi(version)
-              version = OpenAPI::Version.from(version)
-              return if version.major == 2
-
-              with_openapi_extensions(
-                type: 'http',
-                scheme: 'bearer',
-                bearerFormat: bearer_format,
-                description: description
-              )
-            end
-          end
-        end
-      end
-    end
-  end
-end