Base

GitHub

Base class for collection response wrappers.

Collection wrappers structure responses for index actions that return multiple records. Extend this class to customize how collections are wrapped in your API responses.

Example: Custom collection wrapper

class MyCollectionWrapper < Wrapper::Collection::Base
  shape do
    array(root_key.plural.to_sym) do |array|
      array.reference(data_type)
    end
    object?(:meta)
    metadata_type_names.each { |type_name| merge(type_name) }
  end

  def wrap
    { root_key.plural.to_sym => data, meta: meta.presence, **metadata }.compact
  end
end

Class Methods

.shape

.shape(klass_or_callable = nil, &block)

GitHub

Defines the response shape for contract generation.

Parameters

Name	Type	Default	Description
klass_or_callable	Class<Shape>, Proc, nil	nil	A Shape subclass or callable.

Returns

Class<Shape>, nil

---

Instance Methods

#data

#data

GitHub

The data for this wrapper.

Returns

Hash

---

#meta

#meta

GitHub

The meta for this wrapper.

Returns

Hash

---

#metadata

#metadata

GitHub

The metadata for this wrapper.

Returns

Hash

---

#wrap

#wrap

GitHub

Transforms the data into the final response format.

Returns

Hash

---