Class: HaveAPI::ModelAdapter::Output

Inherits:

Object

• Object
• HaveAPI::ModelAdapter::Output

Defined in:

lib/haveapi/model_adapter.rb

Overview

Subclass this class in your adapter and reimplement necessary methods.

Direct Known Subclasses

HaveAPI::ModelAdapters::ActiveRecord::Output, HaveAPI::ModelAdapters::Hash::Output

Class Method Summary

• .used_by(action) ⇒ Object

Instance Method Summary

• #[](name) ⇒ Object

  Return a parameter in an appropriate format to be sent to a client.

• #has_param?(name) ⇒ Boolean

  Return true if input parameters contain parameter with ‘name`.

• #initialize(context, obj) ⇒ Output constructor

  A new instance of Output.

• #meta ⇒ Object

Constructor Details

#initialize(context, obj) ⇒ Output

Returns a new instance of Output.

# File 'lib/haveapi/model_adapter.rb', line 91

def initialize(context, obj)
  @context = context
  @object = obj
end

Class Method Details

.used_by(action) ⇒ Object

# File 'lib/haveapi/model_adapter.rb', line 89

def self.used_by(action); end

Instance Method Details

#[](name) ⇒ Object

Return a parameter in an appropriate format to be sent to a client.

# File 'lib/haveapi/model_adapter.rb', line 101

def [](name); end

#has_param?(name) ⇒ Boolean

Return true if input parameters contain parameter with ‘name`.

Returns:

• (Boolean)

# File 'lib/haveapi/model_adapter.rb', line 98

def has_param?(name); end

#meta ⇒ Object

# File 'lib/haveapi/model_adapter.rb', line 103

def meta
  {}
end