jsapi 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbf64d8068afe39168667e9f907654d308ab933d7688c1a10a7c6341f66a13d5
-  data.tar.gz: 006af1f3b5fec80a643c7dab1bdc82917428c355930c434302df465177235359
+  metadata.gz: 72aa6ad77a99ade6acb3d5c70b6521b640e012cccc7e9ab00b9d55db3062d4d6
+  data.tar.gz: 96ec077740dde1963ca6b448662e1f4370f3bc0b54778db2d03d9447ba69aa3b
 SHA512:
-  metadata.gz: 04a02c4e688e8c02cf7cbb4ee66356bdcb570fa9ff89a8ba3303d52f4713d7bc5c8bbbddafd22b3871d3de960e7606f25dd9496d39731f0fa0e095ffa53688a0
-  data.tar.gz: 5099312a76a600aed362733b23bf4e358ba18b3f5a9f060258cb5aabed3caecab8d28afd9034844ce8619adf5a811f418c7fc19b28f67738392d0ec8becc659e
+  metadata.gz: ec7997fbedc7c9035f9e36d5426b23502b87f4c4c654b1e02f93db711f514a8a434d371dc4761156165c439256ad3f339c7a151b1b35c8dcbf3d1e14f1fd4628
+  data.tar.gz: 1f2952e80bf883302fd835f9425bae0bd2e7629b2746d3abec4b19a259c5abbd9869534b18eb6c69afd94a9397e13c7d86d78720f3573d92ef355b1e66b99fb0

data/lib/jsapi/controller/response.rb

@@ -71,6 +71,8 @@ module Jsapi
               object.to_date
             when 'date-time'
               object.to_datetime
+            when 'duration'
+              object.iso8601
             else
               object.to_s
             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

@@ -25,7 +25,7 @@ module Jsapi
         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/openapi/root.rb

@@ -96,12 +96,13 @@ module Jsapi
             end
 
           if version.major == 2
+            uri = servers&.first&.then { |server| URI(server.url) }
             {
               swagger: '2.0',
               info: info&.to_openapi,
-              host: host,
-              basePath: base_path,
-              schemes: schemes,
+              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,

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

@@ -47,12 +47,14 @@ module Jsapi
         def initialize(name, keywords = {})
           raise ArgumentError, "parameter name can't be blank" if name.blank?
 
+          @name = name.to_s
+
           keywords = keywords.dup
           super(keywords.extract!(:deprecated, :description, :examples, :in))
 
           add_example(value: keywords.delete(:example)) if keywords.key?(:example)
+          keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
 
-          @name = name.to_s
           @schema = Schema.new(keywords)
         end
 

data/lib/jsapi/meta/property.rb

@@ -34,10 +34,12 @@ module Jsapi
       def initialize(name, keywords = {})
         raise ArgumentError, "property name can't be blank" if name.blank?
 
+        @name = name.to_s
+
         keywords = keywords.dup
         super(keywords.extract!(:read_only, :source, :write_only))
+        keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
 
-        @name = name.to_s
         @schema = Schema.new(keywords)
       end
 

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

@@ -26,6 +26,7 @@ module Jsapi
           super(keywords.extract!(:description, :examples))
 
           add_example(value: keywords.delete(:example)) if keywords.key?(:example)
+          keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
 
           @schema = Schema.new(keywords)
         end

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

@@ -36,6 +36,7 @@ module Jsapi
           super(keywords.extract!(:description, :examples, :locale))
 
           add_example(value: keywords.delete(:example)) if keywords.key?(:example)
+          keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
 
           @schema = Schema.new(**keywords)
         end

data/lib/jsapi/meta/schema/array.rb

@@ -7,7 +7,7 @@ module Jsapi
         ##
         # :attr: items
         # The Schema defining the kind of items.
-        attribute :items, Schema
+        attribute :items, Schema, writer: false
 
         ##
         # :attr: max_items
@@ -19,6 +19,14 @@ module Jsapi
         # The minimum length of an array.
         attribute :min_items, writer: false
 
+        def items=(keywords = {}) # :nodoc:
+          if keywords.key?(:schema)
+            keywords = keywords.dup
+            keywords[:ref] = keywords.delete(:schema)
+          end
+          @items = Schema.new(keywords)
+        end
+
         def max_items=(value) # :nodoc:
           add_validation('max_items', Validation::MaxItems.new(value))
           @max_items = value

data/lib/jsapi/meta/schema/object.rb

@@ -72,7 +72,7 @@ module Jsapi
           {}.tap do |properties|
             all_of_references.each do |reference|
               schema = reference.resolve(definitions)
-              raise "circular reference: #{reference.schema}" if schema.in?(path)
+              raise "circular reference: #{reference.ref}" if schema.in?(path)
 
               properties.merge!(schema.merge_properties(definitions, path + [self]))
             end

data/lib/jsapi/meta/schema/reference.rb

@@ -4,9 +4,6 @@ module Jsapi
   module Meta
     module Schema
       class Reference < BaseReference
-        alias :schema :ref
-        alias :schema= :ref=
-
         ##
         # :attr: existence
         # The level of Existence. The default level of existence is +ALLOW_OMITTED+.

data/lib/jsapi/meta/schema/string.rb

@@ -8,12 +8,8 @@ module Jsapi
 
         ##
         # :attr: format
-        # The format of a string. Possible values are:
-        #
-        # - <code>"date"</code>
-        # - <code>"date-time"</code>
-        #
-        attribute :format, ::String, values: %w[date date-time]
+        # The format of a string.
+        attribute :format, ::String
 
         ##
         # :attr: max_length

data/lib/jsapi/meta/schema.rb

@@ -33,9 +33,7 @@ module Jsapi
         #
         # Raises an InvalidArgumentError if the given type is invalid.
         def new(keywords = {})
-          if keywords.key?(:ref) || keywords.key?(:schema)
-            return Reference.new(keywords)
-          end
+          return Reference.new(keywords) if keywords.key?(:ref)
 
           type = keywords[:type]
           case type&.to_s

data/lib/jsapi/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module Jsapi
-  # Holds the current GEM version
   module Version
-    VERSION = '0.1.2'
-
     # NOTE: See https://bundler.io/guides/creating_gem.html
+
+    # The current GEM version.
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsapi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies: []
 description: Jsapi can be used to read requests, produce responses and create OpenAPI
   documents