jsapi 0.8.0 → 0.9.0

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'http/basic'
-require_relative 'http/bearer'
-require_relative 'http/other'
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module SecurityScheme
-        module HTTP
-          class << self
-            # Creates a new \HTTP authentication scheme.
-            def new(keywords = {})
-              scheme = keywords[:scheme] || 'basic'
-
-              case scheme.to_s
-              when 'basic'
-                HTTP::Basic.new(keywords.except(:scheme))
-              when 'bearer'
-                HTTP::Bearer.new(keywords.except(:scheme))
-              else
-                HTTP::Other.new(keywords)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module SecurityScheme
-        # Represents a security scheme based on \OAuth2.
-        class OAuth2 < Base
-          include Extensions
-
-          ##
-          # :attr: oauth_flows
-          # The hash containing the OAuth flows. Possible keys are:
-          #
-          # - <code>"authorization_code"</code>
-          # - <code>"client_credentials"</code>
-          # - <code>"implicit"</code>
-          # - <code>"password"</code>
-          #
-          # Values are OAuthFlow objects.
-          attribute :oauth_flows, { String => OAuthFlow },
-                    keys: %w[authorization_code client_credentials implicit password]
-
-          # Returns a hash representing the \OpenAPI security scheme object.
-          def to_openapi(version)
-            version = Version.from(version)
-
-            with_openapi_extensions(type: 'oauth2', description: description).tap do |h|
-              if oauth_flows&.any?
-                if version.major == 2
-                  key, oauth_flow = oauth_flows.first
-                  h[:flow] = key.to_s
-                  h.merge!(oauth_flow.to_openapi(version))
-                else
-                  h[:flows] = oauth_flows.to_h do |key, value|
-                    [key.to_s.camelize(:lower).to_sym, value.to_openapi(version)]
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module SecurityScheme
-        # Represents a security scheme based on OpenID Connect.
-        #
-        # OpenID Connect was introduced with \OpenAPI 3.0. Thus, a security scheme of
-        # this class is skipped when generating an \OpenAPI 2.0 document.
-        class OpenIDConnect < Base
-          include Extensions
-
-          ##
-          # :attr: open_id_connect_url
-          attribute :open_id_connect_url, String
-
-          # Returns a hash representing the \OpenAPI security scheme object, or +nil+
-          # if <code>version.major</code> is 2.
-          def to_openapi(version)
-            version = Version.from(version)
-            return if version.major == 2
-
-            with_openapi_extensions(
-              type: 'openIdConnect',
-              openIdConnectUrl: open_id_connect_url,
-              description: description
-            )
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'security_scheme/base'
-require_relative 'security_scheme/api_key'
-require_relative 'security_scheme/http'
-require_relative 'security_scheme/oauth2'
-require_relative 'security_scheme/open_id_connect'
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module SecurityScheme
-        class << self
-          # Creates a security scheme. The +:type+ keyword specifies the type
-          # of the security scheme to be created. Possible types are:
-          #
-          # - <code>"api_key"</code>
-          # - <code>"basic"</code>
-          # - <code>"http"</code>
-          # - <code>"oauth2"</code>
-          # - <code>"open_id_connect"</code>
-          #
-          # Raises an InvalidArgumentError if the given type is invalid.
-          def new(keywords = {})
-            type = keywords[:type]
-            keywords = keywords.except(:type)
-
-            case type&.to_s
-            when 'api_key'
-              APIKey.new(keywords)
-            when 'basic' # OpenAPI 2.0
-              HTTP.new(keywords.merge(scheme: 'basic'))
-            when 'http' # OpenAPI 3.0 and higher
-              HTTP.new(keywords)
-            when 'oauth2'
-              OAuth2.new(keywords)
-            when 'open_id_connect' # OpenAPI 3.0 and higher
-              OpenIDConnect.new(keywords)
-            else
-              raise InvalidArgumentError.new(
-                'type',
-                type,
-                valid_values: %w[api_key basic http oauth2 open_id_connect]
-              )
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      # Represents a server object.
-      class Server < Meta::Base::Model
-        include Extensions
-
-        ##
-        # :attr: description
-        # The optional description of the server.
-        attribute :description, String
-
-        ##
-        # :attr: url
-        # The absolute or relative URL of the server.
-        attribute :url, String
-
-        ##
-        # :attr_reader: variables
-        # The optional server variables.
-        attribute :variables, { String => ServerVariable }
-
-        # Returns a hash representing the \OpenAPI server object.
-        def to_openapi(*)
-          with_openapi_extensions(
-            url: url,
-            description: description,
-            variables: variables&.transform_values(&:to_openapi)
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      # Represents a server variable object.
-      class ServerVariable < Meta::Base::Model
-        include Extensions
-
-        ##
-        # :attr: default
-        # The default value of the server variable.
-        attribute :default, String
-
-        ##
-        # :attr: description
-        # The optional description of the server variable.
-        attribute :description, String
-
-        ##
-        # :attr: enum
-        # The values of the server variable.
-        attribute :enum, [String]
-
-        # Returns a hash representing the \OpenAPI server variable object.
-        def to_openapi(*)
-          with_openapi_extensions(
-            default: default,
-            enum: enum.presence, # must not be empty
-            description: description
-          )
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      # Represents a tag object.
-      class Tag < Meta::Base::Model
-        include Extensions
-
-        ##
-        # :attr: description
-        # The description of the tag.
-        attribute :description, String
-
-        ##
-        # :attr: external_docs
-        # The ExternalDocumentation object.
-        attribute :external_docs, ExternalDocumentation
-
-        ##
-        # :attr: name
-        # The name of the tag.
-        attribute :name, String
-
-        # Returns a hash representing the \OpenAPI tag object.
-        def to_openapi(*)
-          with_openapi_extensions(
-            name: name,
-            description: description,
-            externalDocs: external_docs&.to_openapi
-          )
-        end
-      end
-    end
-  end
-end