jsapi 0.8.0 → 0.9.0

data/lib/jsapi/model/base.rb

@@ -50,11 +50,6 @@ module Jsapi
         "#{attributes.map { |k, v| "#{k}: #{v.inspect}" }.join(', ')}>"
       end
 
-      def method_missing(*args) # :nodoc:
-        name = args.first.to_s
-        _attr_readers.key?(name) ? _attr_readers[name] : super
-      end
-
       def respond_to_missing?(param1, _param2) # :nodoc:
         _attr_readers.key?(param1.to_s) ? true : super
       end
@@ -68,6 +63,11 @@ module Jsapi
       def _nested_validity
         @nested.validate(errors)
       end
+
+      def method_missing(*args) # :nodoc:
+        name = args.first.to_s
+        _attr_readers.key?(name) ? _attr_readers[name] : super
+      end
     end
   end
 end

data/lib/jsapi/version.rb

@@ -5,6 +5,6 @@ module Jsapi
     # NOTE: See https://bundler.io/guides/creating_gem.html
 
     # The current GEM version.
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
   end
 end

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: jsapi
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-29 00:00:00.000000000 Z
+date: 2024-10-12 00:00:00.000000000 Z
 dependencies: []
-description: Jsapi can be used to read requests, produce responses and create OpenAPI
-  documents
+description:
 email: denis@dmgoeller.de
 executables: []
 extensions: []
@@ -26,15 +25,12 @@ files:
 - lib/jsapi/controller/parameters_invalid.rb
 - lib/jsapi/controller/response.rb
 - lib/jsapi/dsl.rb
+- lib/jsapi/dsl/base.rb
+- lib/jsapi/dsl/callback.rb
 - lib/jsapi/dsl/class_methods.rb
 - lib/jsapi/dsl/definitions.rb
 - lib/jsapi/dsl/error.rb
-- lib/jsapi/dsl/node.rb
-- lib/jsapi/dsl/openapi.rb
-- lib/jsapi/dsl/openapi/callback.rb
-- lib/jsapi/dsl/openapi/callbacks.rb
-- lib/jsapi/dsl/openapi/examples.rb
-- lib/jsapi/dsl/openapi/root.rb
+- lib/jsapi/dsl/examples.rb
 - lib/jsapi/dsl/operation.rb
 - lib/jsapi/dsl/parameter.rb
 - lib/jsapi/dsl/request_body.rb
@@ -61,47 +57,34 @@ files:
 - lib/jsapi/meta/callable.rb
 - lib/jsapi/meta/callable/symbol_evaluator.rb
 - lib/jsapi/meta/callable/symbol_sequence_evaluator.rb
+- lib/jsapi/meta/callback.rb
+- lib/jsapi/meta/callback/model.rb
+- lib/jsapi/meta/callback/reference.rb
+- lib/jsapi/meta/contact.rb
 - lib/jsapi/meta/defaults.rb
 - lib/jsapi/meta/definitions.rb
+- lib/jsapi/meta/example.rb
+- lib/jsapi/meta/example/model.rb
+- lib/jsapi/meta/example/reference.rb
 - lib/jsapi/meta/existence.rb
+- lib/jsapi/meta/external_documentation.rb
+- lib/jsapi/meta/header.rb
+- lib/jsapi/meta/header/model.rb
+- lib/jsapi/meta/header/reference.rb
+- lib/jsapi/meta/info.rb
+- lib/jsapi/meta/license.rb
+- lib/jsapi/meta/link.rb
+- lib/jsapi/meta/link/model.rb
+- lib/jsapi/meta/link/reference.rb
+- lib/jsapi/meta/oauth_flow.rb
 - lib/jsapi/meta/openapi.rb
-- lib/jsapi/meta/openapi/callback.rb
-- lib/jsapi/meta/openapi/callback/model.rb
-- lib/jsapi/meta/openapi/callback/reference.rb
-- lib/jsapi/meta/openapi/contact.rb
-- lib/jsapi/meta/openapi/example.rb
-- lib/jsapi/meta/openapi/example/model.rb
-- lib/jsapi/meta/openapi/example/reference.rb
 - lib/jsapi/meta/openapi/extensions.rb
-- lib/jsapi/meta/openapi/external_documentation.rb
-- lib/jsapi/meta/openapi/header.rb
-- lib/jsapi/meta/openapi/header/model.rb
-- lib/jsapi/meta/openapi/header/reference.rb
-- lib/jsapi/meta/openapi/info.rb
-- lib/jsapi/meta/openapi/license.rb
-- lib/jsapi/meta/openapi/link.rb
-- lib/jsapi/meta/openapi/link/model.rb
-- lib/jsapi/meta/openapi/link/reference.rb
-- lib/jsapi/meta/openapi/oauth_flow.rb
-- lib/jsapi/meta/openapi/root.rb
-- lib/jsapi/meta/openapi/security_requirement.rb
-- lib/jsapi/meta/openapi/security_scheme.rb
-- lib/jsapi/meta/openapi/security_scheme/api_key.rb
-- lib/jsapi/meta/openapi/security_scheme/base.rb
-- lib/jsapi/meta/openapi/security_scheme/http.rb
-- lib/jsapi/meta/openapi/security_scheme/http/basic.rb
-- lib/jsapi/meta/openapi/security_scheme/http/bearer.rb
-- lib/jsapi/meta/openapi/security_scheme/http/other.rb
-- lib/jsapi/meta/openapi/security_scheme/oauth2.rb
-- lib/jsapi/meta/openapi/security_scheme/open_id_connect.rb
-- lib/jsapi/meta/openapi/server.rb
-- lib/jsapi/meta/openapi/server_variable.rb
-- lib/jsapi/meta/openapi/tag.rb
 - lib/jsapi/meta/openapi/version.rb
 - lib/jsapi/meta/operation.rb
 - lib/jsapi/meta/parameter.rb
 - lib/jsapi/meta/parameter/model.rb
 - lib/jsapi/meta/parameter/reference.rb
+- lib/jsapi/meta/parameter/to_openapi.rb
 - lib/jsapi/meta/property.rb
 - lib/jsapi/meta/reference_error.rb
 - lib/jsapi/meta/request_body.rb
@@ -137,6 +120,19 @@ files:
 - lib/jsapi/meta/schema/validation/minimum.rb
 - lib/jsapi/meta/schema/validation/multiple_of.rb
 - lib/jsapi/meta/schema/validation/pattern.rb
+- lib/jsapi/meta/security_requirement.rb
+- lib/jsapi/meta/security_scheme.rb
+- lib/jsapi/meta/security_scheme/api_key.rb
+- lib/jsapi/meta/security_scheme/base.rb
+- lib/jsapi/meta/security_scheme/http.rb
+- lib/jsapi/meta/security_scheme/http/basic.rb
+- lib/jsapi/meta/security_scheme/http/bearer.rb
+- lib/jsapi/meta/security_scheme/http/other.rb
+- lib/jsapi/meta/security_scheme/oauth2.rb
+- lib/jsapi/meta/security_scheme/open_id_connect.rb
+- lib/jsapi/meta/server.rb
+- lib/jsapi/meta/server_variable.rb
+- lib/jsapi/meta/tag.rb
 - lib/jsapi/model.rb
 - lib/jsapi/model/base.rb
 - lib/jsapi/model/error.rb
@@ -167,5 +163,5 @@ requirements: []
 rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
-summary: Build JSON APIs with Rails
+summary: Easily build OpenAPI compliant APIs with Rails.
 test_files: []

data/lib/jsapi/dsl/node.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module DSL
-    class Node
-      def initialize(meta_model, &block)
-        @_meta_model = meta_model
-        instance_eval(&block) if block
-      end
-
-      def method_missing(*args, &block) # :nodoc:
-        _keyword(*args, &block)
-      end
-
-      def respond_to_missing?(*args) # :nodoc:
-        _keyword?(args.first)
-      end
-
-      private
-
-      attr_reader :_meta_model
-
-      def _define(*args, &block)
-        block.call
-      rescue Error => e
-        raise e.prepend_origin(args.compact.join(' '))
-      rescue StandardError => e
-        raise Error.new(e, args.compact.join(' ').presence)
-      end
-
-      def _eval(model, klass = Node, &block)
-        return unless block
-
-        if model.reference?
-          raise Error, 'reference cannot be specified together with a block'
-        end
-
-        klass.new(model, &block)
-      end
-
-      def _find_method(name)
-        ["#{name}=", "add_#{name}"].find do |method|
-          _meta_model.respond_to?(method)
-        end
-      end
-
-      def _keyword(name, *params, &block)
-        method = _find_method(name)
-        raise "unsupported method: #{name}" unless method
-
-        _define(name) do
-          value = _meta_model.public_send(method, *params)
-          _eval(value, &block)
-        end
-      end
-
-      def _keyword?(name)
-        _find_method(name).present?
-      end
-    end
-  end
-end

data/lib/jsapi/dsl/openapi/callback.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module DSL
-    module OpenAPI
-      # Used to specify details of a callback.
-      class Callback < Node
-
-        # Adds a callback operation.
-        #
-        #   operation '{$request.query.foo}' do
-        #     parameter 'bar', type: 'string'
-        #   end
-        def operation(expression, **keywords, &block)
-          _define('operation', expression.inspect) do
-            operation_model = _meta_model.add_operation(expression, keywords)
-            Operation.new(operation_model, &block) if block
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/dsl/openapi/callbacks.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module DSL
-    module OpenAPI
-      module Callbacks
-        # Defines an \OpenAPI callback or refers a reusable callback.
-        #
-        #   # define a callback
-        #   callback 'foo' do
-        #     operation '{$request.query.foo}'
-        #   end
-        #
-        #   # refer a reusable callback
-        #   callback ref: 'foo'
-        #
-        # Refers the reusable callback with the same name if neither any
-        # keywords nor a block is specified.
-        #
-        #   callback 'foo'
-        #
-        def callback(name = nil, **keywords, &block)
-          _define('callback', name&.inspect) do
-            name = keywords[:ref] if name.nil?
-            keywords = { ref: name } unless keywords.any? || block
-
-            callback_model = _meta_model.add_callback(name, keywords)
-            _eval(callback_model, OpenAPI::Callback, &block)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/dsl/openapi/examples.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module DSL
-    module OpenAPI
-      module Examples
-        # Adds an example.
-        #
-        #   example 'foo', value: 'bar'
-        #
-        #   example 'foo'
-        #
-        # The default name is <code>'default'</code>.
-        def example(name_or_value = nil, **keywords, &block)
-          _define('example', name_or_value&.inspect) do
-            if keywords.any? || block
-              # example 'foo', value: 'bar', ...
-              name = name_or_value
-            else
-              # example 'foo'
-              name = nil
-              keywords = { value: name_or_value }
-            end
-
-            example = _meta_model.add_example(name, keywords)
-            Node.new(example, &block) if block
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,126 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module DSL
-    module OpenAPI
-      # Used to specify details of an \OpenAPI object.
-      class Root < Node
-        include Callbacks
-
-        ##
-        # :method: base_path
-        # :args: arg
-        # Specifies the base path of the API.
-        #
-        #   base_path '/foo'
-        #
-        # See Meta::OpenAPI::Root#base_path for further information.
-
-        ##
-        # :method: consumes
-        # :args: mime_types
-        # Specifies one or more MIME types the API can consume.
-        #
-        #   consumes 'application/json'
-        #
-        #   consumes %w[application/json application/pdf]
-        #
-        # See Meta::OpenAPI::Root#consumes for further information.
-
-        ##
-        # :method: external_docs
-        # :args: **keywords, &block
-        # Specifies the external documentation.
-        #
-        #   external_docs url: 'https://foo.bar'
-        #
-        # See Meta::OpenAPI::Root#external_docs for further information.
-
-        ##
-        # :method: host
-        # :args: arg
-        # Specifies the host serving the API.
-        #
-        #   host 'foo.bar'
-        #
-        # See Meta::OpenAPI::Root#host for further information.
-
-        ##
-        # :method: info
-        # :args: **keywords, &block
-        # Specifies general information about the API.
-        #
-        #   info title: 'foo', version: 1
-        #
-        # See Meta::OpenAPI::Root#info for further information.
-
-        ##
-        # :method: link
-        # :args: name, **keywords, &block
-        # Adds a link.
-        #
-        #   link 'foo', operation_id: 'bar'
-        #
-        # See Meta::OpenAPI::Root#links for further information.
-
-        ##
-        # :method: produces
-        # :args: mime_types
-        # Specifies one or more MIME types the API can produce.
-        #
-        #   produces 'application/json'
-        #
-        #   produces %w[application/json application/pdf]'
-        #
-        # See Meta::OpenAPI::Root#produces for further information.
-
-        ##
-        # :method: scheme
-        # :args: arg
-        # Adds a URI scheme supported by the API.
-        #
-        #   scheme 'https'
-        #
-        # See Meta::OpenAPI::Root#scheme for further information.
-
-        ##
-        # :method: security_requirement
-        # :args: **keywords, &block
-        # Adds a security requirement.
-        #
-        #   security_requirement do
-        #     scheme 'basic_auth'
-        #   end
-        #
-        # See Meta::OpenAPI::Root#security_requirements for further information.
-
-        ##
-        # :method: security_scheme
-        # :args: name, **keywords, &block
-        # Adds a security scheme.
-        #
-        #   security_scheme 'basic_auth', type: 'http', scheme: 'basic'
-        #
-        # See Meta::OpenAPI::Root#security_schemes for further information.
-
-        ##
-        # :method: server
-        # :args: arg
-        # Adds a server providing the API.
-        #
-        #   server url: 'https://foo.bar'
-        #
-        # See Meta::OpenAPI::Root#servers for further information.
-
-        ##
-        # :method: tag
-        # :args: **keywords, &block
-        # Adds a tag.
-        #
-        #   tag name: 'foo', description: 'description of foo'
-        #
-        # See Meta::OpenAPI::Root#tags for further information.
-      end
-    end
-  end
-end

data/lib/jsapi/dsl/openapi.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'openapi/callbacks'
-require_relative 'openapi/examples'
-require_relative 'openapi/callback'
-require_relative 'openapi/root'

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

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module Callback
-        # Represents a callback object. Applies to \OpenAPI 3.0 and higher.
-        class Model < Meta::Base::Model
-          ##
-          # :attr: operations
-          attribute :operations, { String => Object }, default: {}
-
-          undef add_operation
-
-          # Adds a callback operation.
-          #
-          # Raises an +ArgumentError+ if +expression+ is blank.
-          def add_operation(expression, keywords = {})
-            raise ArgumentError, "expression can't be blank" if expression.blank?
-
-            (@operations ||= {})[expression.to_s] = Operation.new(nil, keywords)
-          end
-
-          # Returns a hash representing the \OpenAPI callback object.
-          def to_openapi(version, definitions)
-            operations.transform_values do |operation|
-              { operation.method => operation.to_openapi(version, definitions) }
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'callback/model'
-require_relative 'callback/reference'
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module Callback
-        class << self
-          # Creates a callback 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/contact.rb

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

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

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module Example
-        class Model < Meta::Base::Model
-          include Extensions
-
-          ##
-          # :attr: description
-          # The optional description of the example.
-          attribute :description, String
-
-          ##
-          # :attr: external
-          # If true, +value+ is interpreted as a URI pointing to an external sample value.
-          attribute :external, values: [true, false]
-
-          ##
-          # :attr: summary
-          # The optional summary of the example.
-          attribute :summary, String
-
-          ##
-          # :attr: value
-          # The sample value.
-          attribute :value
-
-          # Returns a hash representing the \OpenAPI example object.
-          def to_openapi(*)
-            with_openapi_extensions(summary: summary, description: description).tap do |hash|
-              if external?
-                hash[:external_value] = value
-              else
-                hash[:value] = value
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'example/model'
-require_relative 'example/reference'
-
-module Jsapi
-  module Meta
-    module OpenAPI
-      module Example
-        class << self
-          # Creates a new example 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/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