jsapi 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbf64d8068afe39168667e9f907654d308ab933d7688c1a10a7c6341f66a13d5
-  data.tar.gz: 006af1f3b5fec80a643c7dab1bdc82917428c355930c434302df465177235359
+  metadata.gz: 78a92c9f73f4a39ede65ad5b0b5646db67dc8b9e2b3ca444b6de32fdb75e349a
+  data.tar.gz: e235535541854c172f578cce7cf112ceebe880971643cb33125a76cc61bbd88a
 SHA512:
-  metadata.gz: 04a02c4e688e8c02cf7cbb4ee66356bdcb570fa9ff89a8ba3303d52f4713d7bc5c8bbbddafd22b3871d3de960e7606f25dd9496d39731f0fa0e095ffa53688a0
-  data.tar.gz: 5099312a76a600aed362733b23bf4e358ba18b3f5a9f060258cb5aabed3caecab8d28afd9034844ce8619adf5a811f418c7fc19b28f67738392d0ec8becc659e
+  metadata.gz: 7c139744bacb90f772bb40779a8d149daf025dd838ffc3268c35640dfe18da1934e62ffd2e319658478ef5c4d54a4f630ed76eabf60a22df641f1ce7da218150
+  data.tar.gz: b9e72517dea9061eaa23b5ff5631745a18769614c04d2a91ae97db2e715c30504bc5b849fdcaa89384f7fb2618e5ea639601f637b9583b5fec219bd053006f08

data/lib/jsapi/controller/methods.rb

@@ -13,9 +13,9 @@ module Jsapi
       end
 
       # Performs an API operation by calling the given block. The request parameters are
-      # passed as an instance of the operation's model class to the block. The object
-      # returned by the block is implicitly rendered according to the appropriate
-      # +response+ specification.
+      # passed as an instance of the operation's model class to the block. Parameter names
+      # are converted to snake case. The object returned by the block is implicitly rendered
+      # according to the appropriate +response+ specification.
       #
       #   api_operation('foo') do |api_params|
       #     # ...
@@ -53,6 +53,7 @@ module Jsapi
       end
 
       # Returns the request parameters as an instance of the operation's model class.
+      # Parameter names are converted to snake case.
       #
       #   params = api_params('foo')
       #

data/lib/jsapi/controller/parameters.rb

@@ -25,15 +25,12 @@ module Jsapi
         end
         request_body = operation.request_body&.resolve(definitions)
         if request_body && request_body.schema.respond_to?(:properties)
-          meta_models.merge!(
-            request_body.schema.resolve_properties(:write, definitions)
-          )
+          meta_models.merge!(request_body.schema.resolve_properties(:write, definitions))
         end
 
         # Wrap params
         meta_models.each do |name, meta_model|
-          @raw_attributes[name] =
-            JSON.wrap(params[name], meta_model.schema, definitions)
+          @raw_attributes[name.underscore] = JSON.wrap(params[name], meta_model.schema, definitions)
         end
       end
 

data/lib/jsapi/controller/response.rb

@@ -5,8 +5,8 @@ module Jsapi
     # Used to serialize a response.
     class Response
 
-      # Creates a new instance to serialize +object+ according to +response+. References are
-      # resolved to API components in +definitions+.
+      # Creates a new instance to serialize +object+ according to +response+. References
+      # are resolved to API components in +definitions+.
       def initialize(object, response, definitions)
         @object = object
         @response = response
@@ -37,33 +37,13 @@ module Jsapi
 
         case schema.type
         when 'array'
-          item_schema = schema.items.resolve(@definitions)
-          Array(object).map { |item| serialize(item, item_schema, path) }
+          serialize_array(object, schema, path)
         when 'integer'
           schema.convert(object.to_i)
         when 'number'
           schema.convert(object.to_f)
         when 'object'
-          return if object.blank? # {}
-
-          # Select inherriting schema on polymorphism
-          if (discriminator = schema.discriminator)
-            discriminator_property = schema.properties[discriminator.property_name]
-            schema = discriminator.resolve(
-              object.public_send(
-                discriminator_property.source || discriminator_property.name
-              ),
-              @definitions
-            )
-          end
-          # Serialize properties
-          schema.resolve_properties(:read, @definitions).transform_values do |property|
-            serialize(
-              object.public_send(property.source || property.name),
-              property.schema.resolve(@definitions),
-              path.nil? ? property.name : "#{path}.#{property.name}"
-            )
-          end
+          serialize_object(object, schema, path)
         when 'string'
           schema.convert(
             case schema.format
@@ -71,6 +51,8 @@ module Jsapi
               object.to_date
             when 'date-time'
               object.to_datetime
+            when 'duration'
+              object.iso8601
             else
               object.to_s
             end
@@ -79,6 +61,48 @@ module Jsapi
           object
         end
       end
+
+      def serialize_array(array, schema, path)
+        item_schema = schema.items.resolve(@definitions)
+        Array(array).map { |item| serialize(item, item_schema, path) }
+      end
+
+      def serialize_object(object, schema, path)
+        return if object.blank? # {}
+
+        # Select inherriting schema on polymorphism
+        if (discriminator = schema.discriminator)
+          discriminator_property = schema.properties[discriminator.property_name]
+          schema = discriminator.resolve(
+            object.public_send(discriminator_property.source || discriminator_property.name.underscore),
+            @definitions
+          )
+        end
+        # Serialize properties
+        properties = schema.resolve_properties(:read, @definitions).transform_values do |property|
+          serialize(
+            object.public_send(property.source || property.name.underscore),
+            property.schema.resolve(@definitions),
+            path.nil? ? property.name : "#{path}.#{property.name}"
+          )
+        end
+        if (additional_properties = schema.additional_properties&.resolve(@definitions))
+          additional_properties_schema = additional_properties.schema.resolve(@definitions)
+
+          object.public_send(additional_properties.source)&.each do |key, value|
+            # Don't replace the property with the same key
+            next if properties.key?(key = key.to_s)
+
+            # Serialize the additional property
+            properties[key] = serialize(
+              value,
+              additional_properties_schema,
+              path.nil? ? key : "#{path}.#{key}"
+            )
+          end
+        end
+        properties
+      end
     end
   end
 end

data/lib/jsapi/dsl/parameter.rb

@@ -24,16 +24,6 @@ module Jsapi
       # Specifies the location of the parameter.
       #
       # See Meta::Parameter::Model#in for further information.
-
-      ##
-      # :method: ref
-      # :args: name
-      # Specifies the name of the reusable parameter to be referred.
-
-      ##
-      # :method: schema
-      # :args: name
-      # Specifies the name of the reusable schema to be referred.
     end
   end
 end

data/lib/jsapi/dsl/request_body.rb

@@ -17,16 +17,6 @@ module Jsapi
       # :method: description
       # :args: arg
       # Specifies the description of the request body.
-
-      ##
-      # :method: ref
-      # :args: name
-      # Specifies the name of the reusable request body to be referred.
-
-      ##
-      # :method: schema
-      # :args: name
-      # Specifies the name of the reusable schema to be referred.
     end
   end
 end

data/lib/jsapi/dsl/response.rb

@@ -47,16 +47,6 @@ module Jsapi
       # Specifies the locale to be used when rendering a response.
       #
       #   locale :en
-
-      ##
-      # :method: ref
-      # :args: name
-      # Specifies the name of the reusable response to be referred.
-
-      ##
-      # :method: schema
-      # :args: name
-      # Specifies the name of the reusable schema to be referred.
     end
   end
 end

data/lib/jsapi/dsl/schema.rb

@@ -8,7 +8,7 @@ module Jsapi
       # Includes all of the properties from +schemas+. Each argument must be the name of
       # a schema defined by ClassMethods#api_schema or Definitions#schema.
       def all_of(*schemas)
-        schemas.each { |schema| _meta_model.add_all_of({ schema: schema }) }
+        schemas.each { |schema| _meta_model.add_all_of({ ref: schema }) }
       end
 
       ##

data/lib/jsapi/json/array.rb

@@ -11,7 +11,7 @@ module Jsapi
         end
       end
 
-      # Returns +true+ if it contains no elements, +false+ otherwise.
+      # Returns true if it contains no elements, false otherwise.
       def empty?
         @elements.empty?
       end
@@ -20,8 +20,7 @@ module Jsapi
         "#<#{self.class.name} [#{@elements.map(&:inspect).join(', ')}]>"
       end
 
-      # See Value#validate.
-      def validate(errors)
+      def validate(errors) # :nodoc:
         return false unless super
 
         @elements.map { |element| element.validate(errors) }.all?

data/lib/jsapi/json/null.rb

@@ -5,7 +5,7 @@ module Jsapi
     # Represents +null+.
     class Null < Value
 
-      # Returns allways +true+.
+      # Returns true.
       def empty?
         true
       end
@@ -14,7 +14,7 @@ module Jsapi
         "#<#{self.class}>"
       end
 
-      # Returns allways +true+.
+      # Returns true.
       def null?
         true
       end

data/lib/jsapi/json/object.rb

@@ -11,21 +11,18 @@ module Jsapi
       def initialize(attributes, schema, definitions)
         # Select inherriting schema on polymorphism
         if (discriminator = schema.discriminator)
-          schema = discriminator.resolve(
-            attributes[discriminator.property_name],
-            definitions
-          )
+          schema = discriminator.resolve(attributes[discriminator.property_name], definitions)
         end
         # Wrap attribute values
-        @raw_attributes = schema.resolve_properties(:write, definitions)
-                                .transform_values do |property|
-          JSON.wrap(attributes[property.name], property.schema, definitions)
-        end
+        @raw_attributes =
+          schema.resolve_properties(:write, definitions).transform_values do |property|
+            JSON.wrap(attributes[property.name], property.schema, definitions)
+          end
 
         super(schema)
       end
 
-      # Returns +true+ if all attributes are empty, +false+ otherwise.
+      # Returns true if all attributes are empty, false otherwise.
       def empty?
         @raw_attributes.values.all?(&:empty?)
       end

data/lib/jsapi/json/string.rb

@@ -8,22 +8,36 @@ module Jsapi
 
       def initialize(value, schema)
         super(schema)
-        @value = schema.convert(
-          case schema.format
-          when 'date'
-            value.to_date
-          when 'date-time'
-            value.to_datetime
-          else
-            value.to_s
+
+        @value =
+          begin
+            case schema.format
+            when 'date'
+              value.to_date
+            when 'date-time'
+              value.to_datetime
+            when 'duration'
+              ActiveSupport::Duration.parse(value)
+            else
+              value.to_s
+            end
+          rescue StandardError => e
+            @error = e
+            value
           end
-        )
+        @value = schema.convert(@value) unless defined? @error
       end
 
-      # See Value#empty?.
-      def empty?
+      def empty? # :nodoc:
         value.blank?
       end
+
+      def validate(errors) # :nodoc:
+        return super unless defined? @error
+
+        errors.add(:base, :invalid)
+        false
+      end
     end
   end
 end

data/lib/jsapi/json/value.rb

@@ -14,7 +14,7 @@ module Jsapi
       end
 
       # Used by #validate to test whether or not it is empty.
-      # Returns +false+ by default.
+      # Returns false by default.
       def empty?
         false
       end
@@ -23,13 +23,13 @@ module Jsapi
         "#<#{self.class} #{value.inspect}>"
       end
 
-      # Used by #validate to test whether or not it is +null+.
-      # Returns +false+ by default.
+      # Used by #validate to test whether or not it is null.
+      # Returns false by default.
       def null?
         false
       end
 
-      # Validates it against #schema. Returns +true+ if it is valid, +false+ otherwise.
+      # Validates it against #schema. Returns true if it is valid, false otherwise.
       # Detected errors are added to +errors+.
       def validate(errors)
         unless schema.existence.reach?(self)

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

@@ -4,6 +4,8 @@ module Jsapi
   module Meta
     module Example
       class Model < Base
+        include OpenAPI::Extensions
+
         ##
         # :attr: description
         # The optional description of the example.
@@ -26,10 +28,7 @@ module Jsapi
 
         # Returns a hash representing the \OpenAPI example object.
         def to_openapi(*)
-          {}.tap do |hash|
-            hash[:summary] = summary if summary.present?
-            hash[:description] = description if description.present?
-
+          with_openapi_extensions(summary: summary, description: description).tap do |hash|
             if external?
               hash[:external_value] = value
             else

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents a contact object.
       class Contact < Base
+        include Extensions
+
         ##
         # :attr: email
         # The email address of the contact.
@@ -22,11 +24,7 @@ module Jsapi
 
         # Returns a hash representing the contact object.
         def to_openapi(*)
-          {
-            name: name,
-            url: url,
-            email: email
-          }.compact
+          with_openapi_extensions(name: name, url: url, email: email)
         end
       end
     end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Meta
+    module OpenAPI
+      module Extensions
+        # Adds an \OpenAPI extension.
+        #
+        # Raises an +ArgumentError+ if +name+ is blank.
+        def add_openapi_extension(name, value = nil)
+          raise ArgumentError, "name can't be blank" if name.blank?
+
+          openapi_extensions["x-#{name}".to_sym] = value
+        end
+
+        # Returns a hash containing the \OpenAPI extensions.
+        def openapi_extensions
+          @openapi_extensions ||= {}
+        end
+
+        private
+
+        def with_openapi_extensions(keywords = {}) # :nodoc:
+          keywords.merge!(openapi_extensions)
+          keywords.compact!
+          keywords
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents an external documentation object.
       class ExternalDocumentation < Base
+        include Extensions
+
         ##
         # :attr: description
         # The optional description of the external documentation.
@@ -17,10 +19,7 @@ module Jsapi
 
         # Returns a hash representing the external documentation object.
         def to_openapi(*)
-          {
-            url: url,
-            description: description
-          }.compact
+          with_openapi_extensions(url: url, description: description)
         end
       end
     end

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents an info object.
       class Info < Base
+        include Extensions
+
         ##
         # :attr: contact
         # The optional Contact object.
@@ -37,14 +39,14 @@ module Jsapi
 
         # Returns a hash representing the 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
-          }.compact
+          )
         end
       end
     end

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents a license object.
       class License < Base
+        include Extensions
+
         ##
         # :attr: name
         # The name of the license.
@@ -17,10 +19,7 @@ module Jsapi
 
         # Returns a hash representing the license object.
         def to_openapi(*)
-          {
-            name: name,
-            url: url
-          }.compact
+          with_openapi_extensions(name: name, url: url)
         end
       end
     end

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

@@ -6,6 +6,8 @@ module Jsapi
       module Link
         # Represents a link object.
         class Model < Base
+          include Extensions
+
           ##
           # :attr: description
           # The optional description of the link.
@@ -33,13 +35,13 @@ module Jsapi
 
           # Returns a hash representing the link object.
           def to_openapi(*)
-            {
+            with_openapi_extensions(
               operationId: operation_id,
               parameters: parameters,
               requestBody: request_body,
               description: description,
               server: server&.to_openapi
-            }.compact
+            )
           end
         end
       end

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents an OAuth flow object.
       class OAuthFlow < Base
+        include Extensions
+
         class Scope < Base
           ##
           # :attr: description
@@ -37,12 +39,12 @@ module Jsapi
 
         # Returns a hash representing the 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)
-          }.compact
+          )
         end
       end
     end

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents an \OpenAPI object.
       class Root < Base
+        include Extensions
+
         ##
         # :attr: callbacks
         # The reusable Callback objects. Applies to \OpenAPI 3.0 and higher.
@@ -95,37 +97,40 @@ module Jsapi
               value.to_openapi(version)
             end
 
-          if version.major == 2
-            {
-              swagger: '2.0',
-              info: info&.to_openapi,
-              host: host,
-              basePath: base_path,
-              schemes: schemes,
-              consumes: consumed_mime_types,
-              produces: produced_mime_types,
-              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,
-                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.compact
+          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] },
+                consumes: consumed_mime_types,
+                produces: produced_mime_types,
+                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,
+                  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

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

@@ -6,6 +6,8 @@ module Jsapi
       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:
@@ -24,12 +26,12 @@ module Jsapi
 
           # Returns a hash representing the security scheme object.
           def to_openapi(*)
-            {
+            with_openapi_extensions(
               type: 'apiKey',
               name: name,
               in: self.in,
               description: description
-            }.compact
+            )
           end
         end
       end