Module: Apiwork::Adapter

Defined in:

lib/apiwork/adapter.rb,
lib/apiwork/adapter/base.rb,
lib/apiwork/adapter/registry.rb,
lib/apiwork/adapter/standard.rb,
lib/apiwork/adapter/wrapper/base.rb,
lib/apiwork/adapter/wrapper/shape.rb,
lib/apiwork/adapter/capability/base.rb,
lib/apiwork/adapter/builder/api/base.rb,
lib/apiwork/adapter/capability/result.rb,
lib/apiwork/adapter/capability/runner.rb,
lib/apiwork/adapter/wrapper/error/base.rb,
lib/apiwork/adapter/capability/api/base.rb,
lib/apiwork/adapter/wrapper/member/base.rb,
lib/apiwork/adapter/capability/api/scope.rb,
lib/apiwork/adapter/builder/contract/base.rb,
lib/apiwork/adapter/serializer/error/base.rb,
lib/apiwork/adapter/wrapper/error/default.rb,
lib/apiwork/adapter/wrapper/member/default.rb,
lib/apiwork/adapter/wrapper/collection/base.rb,
lib/apiwork/adapter/capability/contract/base.rb,
lib/apiwork/adapter/serializer/error/default.rb,
lib/apiwork/adapter/serializer/resource/base.rb,
lib/apiwork/adapter/capability/contract/scope.rb,
lib/apiwork/adapter/capability/operation/base.rb,
lib/apiwork/adapter/standard/includes_resolver.rb,
lib/apiwork/adapter/wrapper/collection/default.rb,
lib/apiwork/adapter/serializer/resource/default.rb,
lib/apiwork/adapter/standard/capability/sorting.rb,
lib/apiwork/adapter/standard/capability/writing.rb,
lib/apiwork/adapter/standard/capability/filtering.rb,
lib/apiwork/adapter/standard/capability/including.rb,
lib/apiwork/adapter/standard/capability/pagination.rb,
lib/apiwork/adapter/capability/operation/metadata_shape.rb,
lib/apiwork/adapter/capability/transformer/request/base.rb,
lib/apiwork/adapter/capability/transformer/response/base.rb,
lib/apiwork/adapter/serializer/error/default/api_builder.rb,
lib/apiwork/adapter/standard/capability/sorting/operation.rb,
lib/apiwork/adapter/standard/capability/writing/constants.rb,
lib/apiwork/adapter/standard/capability/writing/operation.rb,
lib/apiwork/adapter/standard/capability/filtering/constants.rb,
lib/apiwork/adapter/standard/capability/filtering/operation.rb,
lib/apiwork/adapter/standard/capability/including/operation.rb,
lib/apiwork/adapter/standard/capability/sorting/api_builder.rb,
lib/apiwork/adapter/standard/capability/pagination/operation.rb,
lib/apiwork/adapter/standard/capability/filtering/api_builder.rb,
lib/apiwork/adapter/standard/capability/pagination/api_builder.rb,
lib/apiwork/adapter/standard/capability/sorting/operation/sort.rb,
lib/apiwork/adapter/serializer/resource/default/contract_builder.rb,
lib/apiwork/adapter/standard/capability/sorting/contract_builder.rb,
lib/apiwork/adapter/standard/capability/writing/contract_builder.rb,
lib/apiwork/adapter/standard/capability/filtering/contract_builder.rb,
lib/apiwork/adapter/standard/capability/filtering/operation/filter.rb,
lib/apiwork/adapter/standard/capability/including/contract_builder.rb,
lib/apiwork/adapter/standard/capability/pagination/contract_builder.rb,
lib/apiwork/adapter/standard/capability/writing/request_transformer.rb,
lib/apiwork/adapter/standard/capability/filtering/request_transformer.rb,
lib/apiwork/adapter/standard/capability/pagination/operation/paginate.rb,
lib/apiwork/adapter/standard/capability/writing/operation/issue_mapper.rb,
lib/apiwork/adapter/standard/capability/filtering/operation/filter/builder.rb,
lib/apiwork/adapter/standard/capability/pagination/operation/paginate/cursor.rb,
lib/apiwork/adapter/standard/capability/pagination/operation/paginate/offset.rb,
lib/apiwork/adapter/standard/capability/filtering/operation/filter/operator_builder.rb

Defined Under Namespace

Modules: Builder, Capability, Serializer, Wrapper Classes: Base, Registry, Standard

Class Method Summary

• .find(name) ⇒ Class<Adapter::Base>^?

  Finds an adapter by name.

• .find!(name) ⇒ Class<Adapter::Base>

  Finds an adapter by name.

• .register(klass) ⇒ Object

  Registers an adapter.

• .register_defaults! ⇒ Object

Class Method Details

.find(name) ⇒ Class<Adapter::Base>^?

Finds an adapter by name.

Examples:

Apiwork::Adapter.find(:standard)

Parameters:

• name (Symbol) —

  The adapter name.

Returns:

• (Class<Adapter::Base>, nil)

See Also:

• find!

# File 'lib/apiwork/adapter.rb', line 36

delegate :clear!,
:exists?,
:find,
:find!,
:keys,
:register,
:values,
to: Registry

.find!(name) ⇒ Class<Adapter::Base>

Finds an adapter by name.

Examples:

Apiwork::Adapter.find!(:standard)

Parameters:

• name (Symbol) —

  The adapter name.

Returns:

• (Class<Adapter::Base>)

Raises:

• (KeyError) —

  if the adapter is not found

See Also:

• find

# File 'lib/apiwork/adapter.rb', line 36

delegate :clear!,
:exists?,
:find,
:find!,
:keys,
:register,
:values,
to: Registry

.register(klass) ⇒ Object

Registers an adapter.

Examples:

Apiwork::Adapter.register(JSONAPIAdapter)

Parameters:

• klass (Class<Adapter::Base>) —

  The adapter class with adapter_name set.

See Also:

• Base

# File 'lib/apiwork/adapter.rb', line 36

delegate :clear!,
:exists?,
:find,
:find!,
:keys,
:register,
:values,
to: Registry

.register_defaults! ⇒ Object

# File 'lib/apiwork/adapter.rb', line 45

def register_defaults!
  register(Standard)
end