apiwork 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02f6a539dd3708f867af6e298daec039dd03bc4ea38f22e21172940332ee800f
-  data.tar.gz: a5603ca5b09b0a8baa3195629b848ceb186e3b1e1d40b987539f02195a76d76f
+  metadata.gz: e7d4674d14687a7f9eb3547135c22df22c1cada2dc55b7f2b0f011462d20bf1a
+  data.tar.gz: f580dcdf234e49b933b1636f2a2c14d2ca11caf4d5364a70ec574763978c834c
 SHA512:
-  metadata.gz: 187ae2ea46e4df89ccca25bc2b88fd5a81b31f1887def0f7acfdb3dbc1fad3284f4b6f91c13956631aa20d6dd6793ac4ff1015ce36c6150c0b29dc669ca2aa18
-  data.tar.gz: 844cb5df21fe9803dabd1e450ce6a9c2f1d7f745fcb40d1d92dbfc2d95660d9ee1be719856d1b922ca5a0eeb11f8e711ce8be1eb423f20d90d348f7c55335a32
+  metadata.gz: 33a16b4c739c5c13ba2374882d0997bea4cda29b00eef1c1afe7c810fe0247fab1ca6568bb225ac8e32617742b0ff9df85920518db7a4c062a223cdc688cee6b
+  data.tar.gz: d707cbf17e3df65f57a523e7695b5ce2c7d009b3aa28599b071fb0ec1ba910281af9224493708214654a979ffe6362d661d6d5410bcec93ffadc08e37c9f6f96

data/lib/apiwork/adapter/serializer/error/default/api_builder.rb

@@ -7,9 +7,9 @@ module Apiwork
         class Default < Base
           class APIBuilder < Adapter::Builder::API::Base
             def build
-              enum(:layer, values: %w[http contract domain])
+              enum(:error_layer, values: %w[http contract domain])
 
-              object(:issue) do |object|
+              object(:error_issue) do |object|
                 object.string(:code)
                 object.string(:detail)
                 object.array(:path, &:string)
@@ -18,9 +18,9 @@ module Apiwork
               end
 
               object(data_type) do |object|
-                object.reference(:layer)
+                object.reference(:layer, to: :error_layer)
                 object.array(:issues) do |element|
-                  element.reference(:issue)
+                  element.reference(:error_issue)
                 end
               end
             end

data/lib/apiwork/adapter/serializer/resource/default/contract_builder.rb

@@ -59,6 +59,8 @@ module Apiwork
                 end
 
                 representation_class.attributes.each do |name, attribute|
+                  next if attribute.write_only?
+
                   param_options = {
                     deprecated: attribute.deprecated?,
                     description: attribute.description,

data/lib/apiwork/contract/object/validator.rb

@@ -163,7 +163,7 @@ module Apiwork
         def validate_enum_value(name, value, enum, field_path)
           enum_values = resolve_enum(enum)
           return nil unless enum_values
-          return nil if enum_values.include?(value.to_s) || enum_values.include?(value)
+          return nil if enum_values.any? { |enum_value| enum_value.to_s == value.to_s }
 
           Issue.new(
             :value_invalid,

data/lib/apiwork/contract/object.rb

@@ -189,6 +189,10 @@ module Apiwork
       #   Whether deprecated. Metadata included in exports.
       # @param description [String, nil] (nil)
       #   The description. Metadata included in exports.
+      # @param max [Integer, nil] (nil)
+      #   The maximum number of elements.
+      # @param min [Integer, nil] (nil)
+      #   The minimum number of elements.
       # @param nullable [Boolean] (false)
       #   Whether the value can be `null`.
       # @param optional [Boolean] (false)
@@ -214,6 +218,8 @@ module Apiwork
         default: nil,
         deprecated: false,
         description: nil,
+        max: nil,
+        min: nil,
         nullable: false,
         optional: false,
         required: false,
@@ -231,6 +237,8 @@ module Apiwork
           default:,
           deprecated:,
           description:,
+          max:,
+          min:,
           nullable:,
           optional:,
           required:,

data/lib/apiwork/controller.rb

@@ -138,10 +138,10 @@ module Apiwork
                end
              else
                data[:meta] = meta if meta.present?
-               data
+               data.deep_symbolize_keys
              end
 
-      response = Response.new(body:)
+      response = Response.new(body: deep_as_json(body))
 
       if Rails.env.development?
         result = contract_class.parse_response(response, action_name)
@@ -223,6 +223,19 @@ module Apiwork
 
     private
 
+    def deep_as_json(value)
+      case value
+      when Hash
+        value.transform_values { |nested_value| deep_as_json(nested_value) }
+      when Array
+        value.map { |element| deep_as_json(element) }
+      when String, Integer, Float, TrueClass, FalseClass, NilClass, Symbol, Time, Date, BigDecimal
+        value
+      else
+        value.as_json
+      end
+    end
+
     def validate_contract
       return unless resource
       return if contract.valid?

data/lib/apiwork/object.rb

@@ -1341,6 +1341,10 @@ module Apiwork
     #   Whether deprecated. Metadata included in exports.
     # @param description [String, nil] (nil)
     #   The description. Metadata included in exports.
+    # @param max [Integer, nil] (nil)
+    #   The maximum number of elements.
+    # @param min [Integer, nil] (nil)
+    #   The minimum number of elements.
     # @param nullable [Boolean] (false)
     #   Whether the value can be `null`.
     # @param of [Symbol, Hash, nil] (nil)
@@ -1386,6 +1390,8 @@ module Apiwork
       default: nil,
       deprecated: false,
       description: nil,
+      max: nil,
+      min: nil,
       nullable: false,
       of: nil,
       optional: false,
@@ -1398,6 +1404,8 @@ module Apiwork
         default:,
         deprecated:,
         description:,
+        max:,
+        min:,
         nullable:,
         of:,
         optional:,

data/lib/apiwork/representation/attribute.rb

@@ -83,7 +83,8 @@ module Apiwork
                   :of,
                   :optional,
                   :preload,
-                  :type
+                  :type,
+                  :write_only
 
       def initialize(
         name,
@@ -105,6 +106,7 @@ module Apiwork
         sortable: false,
         type: nil,
         writable: false,
+        write_only: false,
         &block
       )
         @name = name
@@ -157,6 +159,7 @@ module Apiwork
         @example = example
         @format = format
         @deprecated = deprecated
+        @write_only = write_only
 
         validate_min_max_range!
         validate_format!
@@ -225,6 +228,14 @@ module Apiwork
         [true, action].include?(@writable)
       end
 
+      # @api public
+      # Whether this attribute is write-only.
+      #
+      # @return [Boolean]
+      def write_only?
+        @write_only
+      end
+
       def encode(value)
         result = @empty && value.nil? ? '' : value
         @encode ? @encode.call(result) : result

data/lib/apiwork/representation/base.rb

@@ -222,6 +222,9 @@ module Apiwork
         #   Use an explicit type or block in those cases.
         # @param writable [Boolean, Symbol] (false) [:create, :update]
         #   The write access. `true` for both create and update, `:create` for create only, `:update` for update only.
+        # @param write_only [Boolean] (false)
+        #   Whether the attribute is write-only. Write-only attributes are excluded from response
+        #   serialization and response types but remain in writable payloads.
         # @yieldparam element [Representation::Element]
         # @return [void]
         #
@@ -286,6 +289,7 @@ module Apiwork
           sortable: false,
           type: nil,
           writable: false,
+          write_only: false,
           &block
         )
           self.attributes = attributes.merge(
@@ -309,6 +313,7 @@ module Apiwork
               sortable:,
               type:,
               writable:,
+              write_only:,
               &block
             ),
           )

data/lib/apiwork/representation/serializer.rb

@@ -21,6 +21,8 @@ module Apiwork
         add_discriminator_field(fields) if @representation_class.subclass?
 
         @representation_class.attributes.each do |name, attribute|
+          next if attribute.write_only?
+
           value = @representation.respond_to?(name) ? @representation.public_send(name) : @representation.record.public_send(name)
           value = map_type_column_output(name, value)
           value = attribute.encode(value)

data/lib/apiwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Apiwork
-  VERSION = '0.5.0'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apiwork
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - skiftle
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-23 00:00:00.000000000 Z
+date: 2026-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails