apiwork 0.3.1 → 0.5.0

data/lib/apiwork/introspection/param/boolean.rb

@@ -20,6 +20,30 @@ module Apiwork
       #     param.enum_reference? # => false
       #   end
       class Boolean < Base
+        # @api public
+        # The default for this param.
+        #
+        # @return [Object, nil]
+        def default
+          @dump[:default]
+        end
+
+        # @api public
+        # The example for this param.
+        #
+        # @return [Object, nil]
+        def example
+          @dump[:example]
+        end
+
+        # @api public
+        # Whether this param is concrete.
+        #
+        # @return [Boolean]
+        def concrete?
+          true
+        end
+
         # @api public
         # Whether this param is scalar.
         #
@@ -67,6 +91,18 @@ module Apiwork
         def formattable?
           false
         end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:default] = default
+          result[:enum] = enum if enum?
+          result[:example] = example
+          result
+        end
       end
     end
   end

data/lib/apiwork/introspection/param/date.rb

@@ -20,6 +20,30 @@ module Apiwork
       #     param.enum_reference? # => false
       #   end
       class Date < Base
+        # @api public
+        # The default for this param.
+        #
+        # @return [Object, nil]
+        def default
+          @dump[:default]
+        end
+
+        # @api public
+        # The example for this param.
+        #
+        # @return [Object, nil]
+        def example
+          @dump[:example]
+        end
+
+        # @api public
+        # Whether this param is concrete.
+        #
+        # @return [Boolean]
+        def concrete?
+          true
+        end
+
         # @api public
         # Whether this param is scalar.
         #
@@ -67,6 +91,18 @@ module Apiwork
         def formattable?
           false
         end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:default] = default
+          result[:enum] = enum if enum?
+          result[:example] = example
+          result
+        end
       end
     end
   end

data/lib/apiwork/introspection/param/date_time.rb

@@ -20,6 +20,30 @@ module Apiwork
       #     param.enum_reference? # => false
       #   end
       class DateTime < Base
+        # @api public
+        # The default for this param.
+        #
+        # @return [Object, nil]
+        def default
+          @dump[:default]
+        end
+
+        # @api public
+        # The example for this param.
+        #
+        # @return [Object, nil]
+        def example
+          @dump[:example]
+        end
+
+        # @api public
+        # Whether this param is concrete.
+        #
+        # @return [Boolean]
+        def concrete?
+          true
+        end
+
         # @api public
         # Whether this param is scalar.
         #
@@ -67,6 +91,18 @@ module Apiwork
         def formattable?
           false
         end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:default] = default
+          result[:enum] = enum if enum?
+          result[:example] = example
+          result
+        end
       end
     end
   end

data/lib/apiwork/introspection/param/decimal.rb

@@ -24,6 +24,22 @@ module Apiwork
       #     param.enum_reference? # => false
       #   end
       class Decimal < Base
+        # @api public
+        # The default for this param.
+        #
+        # @return [Object, nil]
+        def default
+          @dump[:default]
+        end
+
+        # @api public
+        # The example for this param.
+        #
+        # @return [Object, nil]
+        def example
+          @dump[:example]
+        end
+
         # @api public
         # The minimum for this param.
         #
@@ -40,6 +56,14 @@ module Apiwork
           @dump[:max]
         end
 
+        # @api public
+        # Whether this param is concrete.
+        #
+        # @return [Boolean]
+        def concrete?
+          true
+        end
+
         # @api public
         # Whether this param is scalar.
         #
@@ -110,7 +134,9 @@ module Apiwork
         # @return [Hash]
         def to_h
           result = super
+          result[:default] = default
           result[:enum] = enum if enum?
+          result[:example] = example
           result[:max] = max
           result[:min] = min
           result

data/lib/apiwork/introspection/param/integer.rb

@@ -25,6 +25,22 @@ module Apiwork
       #     param.enum_reference? # => false
       #   end
       class Integer < Base
+        # @api public
+        # The default for this param.
+        #
+        # @return [Object, nil]
+        def default
+          @dump[:default]
+        end
+
+        # @api public
+        # The example for this param.
+        #
+        # @return [Object, nil]
+        def example
+          @dump[:example]
+        end
+
         # @api public
         # The minimum for this param.
         #
@@ -49,6 +65,14 @@ module Apiwork
           @dump[:format]
         end
 
+        # @api public
+        # Whether this param is concrete.
+        #
+        # @return [Boolean]
+        def concrete?
+          true
+        end
+
         # @api public
         # Whether this param is scalar.
         #
@@ -119,7 +143,9 @@ module Apiwork
         # @return [Hash]
         def to_h
           result = super
+          result[:default] = default
           result[:enum] = enum if enum?
+          result[:example] = example
           result[:format] = format
           result[:max] = max
           result[:min] = min

data/lib/apiwork/introspection/param/number.rb

@@ -24,6 +24,22 @@ module Apiwork
       #     param.enum_reference? # => false
       #   end
       class Number < Base
+        # @api public
+        # The default for this param.
+        #
+        # @return [Object, nil]
+        def default
+          @dump[:default]
+        end
+
+        # @api public
+        # The example for this param.
+        #
+        # @return [Object, nil]
+        def example
+          @dump[:example]
+        end
+
         # @api public
         # The minimum for this param.
         #
@@ -40,6 +56,14 @@ module Apiwork
           @dump[:max]
         end
 
+        # @api public
+        # Whether this param is concrete.
+        #
+        # @return [Boolean]
+        def concrete?
+          true
+        end
+
         # @api public
         # Whether this param is scalar.
         #
@@ -110,7 +134,9 @@ module Apiwork
         # @return [Hash]
         def to_h
           result = super
+          result[:default] = default
           result[:enum] = enum if enum?
+          result[:example] = example
           result[:max] = max
           result[:min] = min
           result

data/lib/apiwork/introspection/param/record.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Apiwork
+  module Introspection
+    module Param
+      # @api public
+      # Record param representing key-value maps with typed values.
+      #
+      # @example Basic usage
+      #   param.type # => :record
+      #   param.record? # => true
+      #   param.scalar? # => false
+      #
+      # @example Value type
+      #   param.of # => Param (value type) or nil
+      class Record < Base
+        # @api public
+        # The default for this param.
+        #
+        # @return [Object, nil]
+        def default
+          @dump[:default]
+        end
+
+        # @api public
+        # The example for this param.
+        #
+        # @return [Object, nil]
+        def example
+          @dump[:example]
+        end
+
+        # @api public
+        # The value type for this record.
+        #
+        # @return [Param::Base, nil]
+        def of
+          @of ||= @dump[:of] ? Param.build(@dump[:of]) : nil
+        end
+
+        # @api public
+        # Whether this param is a record.
+        #
+        # @return [Boolean]
+        def record?
+          true
+        end
+
+        # @api public
+        # Whether this param is concrete.
+        #
+        # @return [Boolean]
+        def concrete?
+          true
+        end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:default] = default
+          result[:example] = example
+          result[:of] = of&.to_h
+          result
+        end
+      end
+    end
+  end
+end

data/lib/apiwork/introspection/param/string.rb

@@ -24,6 +24,22 @@ module Apiwork
       #     param.enum_reference? # => false
       #   end
       class String < Base
+        # @api public
+        # The default for this param.
+        #
+        # @return [Object, nil]
+        def default
+          @dump[:default]
+        end
+
+        # @api public
+        # The example for this param.
+        #
+        # @return [Object, nil]
+        def example
+          @dump[:example]
+        end
+
         # @api public
         # The format for this param.
         #
@@ -48,6 +64,14 @@ module Apiwork
           @dump[:max]
         end
 
+        # @api public
+        # Whether this param is concrete.
+        #
+        # @return [Boolean]
+        def concrete?
+          true
+        end
+
         # @api public
         # Whether this param is scalar.
         #
@@ -110,7 +134,9 @@ module Apiwork
         # @return [Hash]
         def to_h
           result = super
+          result[:default] = default
           result[:enum] = enum if enum?
+          result[:example] = example
           result[:format] = format
           result[:max] = max
           result[:min] = min

data/lib/apiwork/introspection/param/time.rb

@@ -20,6 +20,30 @@ module Apiwork
       #     param.enum_reference? # => false
       #   end
       class Time < Base
+        # @api public
+        # The default for this param.
+        #
+        # @return [Object, nil]
+        def default
+          @dump[:default]
+        end
+
+        # @api public
+        # The example for this param.
+        #
+        # @return [Object, nil]
+        def example
+          @dump[:example]
+        end
+
+        # @api public
+        # Whether this param is concrete.
+        #
+        # @return [Boolean]
+        def concrete?
+          true
+        end
+
         # @api public
         # Whether this param is scalar.
         #
@@ -67,6 +91,18 @@ module Apiwork
         def formattable?
           false
         end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:default] = default
+          result[:enum] = enum if enum?
+          result[:example] = example
+          result
+        end
       end
     end
   end

data/lib/apiwork/introspection/param/uuid.rb

@@ -20,6 +20,30 @@ module Apiwork
       #     param.enum_reference? # => false
       #   end
       class UUID < Base
+        # @api public
+        # The default for this param.
+        #
+        # @return [Object, nil]
+        def default
+          @dump[:default]
+        end
+
+        # @api public
+        # The example for this param.
+        #
+        # @return [Object, nil]
+        def example
+          @dump[:example]
+        end
+
+        # @api public
+        # Whether this param is concrete.
+        #
+        # @return [Boolean]
+        def concrete?
+          true
+        end
+
         # @api public
         # Whether this param is scalar.
         #
@@ -67,6 +91,18 @@ module Apiwork
         def formattable?
           false
         end
+
+        # @api public
+        # Converts this param to a hash.
+        #
+        # @return [Hash]
+        def to_h
+          result = super
+          result[:default] = default
+          result[:enum] = enum if enum?
+          result[:example] = example
+          result
+        end
       end
     end
   end

data/lib/apiwork/introspection/param.rb

@@ -18,6 +18,7 @@ module Apiwork
           when :binary then Binary.new(dump)
           when :unknown then Unknown.new(dump)
           when :array then Array.new(dump)
+          when :record then Record.new(dump)
           when :object then Object.new(dump)
           when :union then Union.new(dump)
           when :literal then Literal.new(dump)

data/lib/apiwork/introspection.rb

@@ -4,23 +4,36 @@ module Apiwork
   module Introspection
     class << self
       def api(api_class, locale: nil)
+        validate_locale(api_class, locale)
         with_locale(locale) { API.new(Dump.api(api_class)) }
       end
 
       def contract(contract_class, expand: false, locale: nil)
+        validate_locale(contract_class.api_class, locale)
         with_locale(locale) { Contract.new(Dump.contract(contract_class, expand:)) }
       end
 
       private
 
-      def with_locale(locale, &block)
-        return yield unless locale
+      def validate_locale(api_class, locale)
+        return unless locale
+        return unless api_class
 
-        unless I18n.available_locales.include?(locale)
+        if api_class.locales.empty?
           raise ConfigurationError,
-                "locale must be one of #{I18n.available_locales.inspect}, got #{locale.inspect}"
+                "locale :#{locale} was requested but no locales are defined. " \
+                "Add `locales #{locale.inspect}` to your API definition."
         end
 
+        return if api_class.locales.include?(locale)
+
+        raise ConfigurationError,
+              "locale must be one of #{api_class.locales.inspect}, got #{locale.inspect}"
+      end
+
+      def with_locale(locale, &block)
+        return yield unless locale
+
         I18n.with_locale(locale, &block)
       end
     end