Class: ActionWebService::Struct

Inherits:
Object
  • Object
show all
Defined in:
lib/action_web_service/struct.rb

Overview

To send structured types across the wire, derive from ActionWebService::Struct, and use member to declare structure members.

ActionWebService::Struct should be used in method signatures when you want to accept or return structured types that have no Active Record model class representations, or you don’t want to expose your entire Active Record model to remote callers.

Example

class Person < ActionWebService::Struct
  member :id,         :int
  member :firstnames, [:string]
  member :lastname,   :string
  member :email,      :string,	:nillable => true
end
person = Person.new(:id => 5, :firstname => 'john', :lastname => 'doe')

Active Record model classes are already implicitly supported in method signatures.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(values = {}) ⇒ Struct

If a Hash is given as argument to an ActionWebService::Struct constructor, it can contain initial values for the structure member.

[View source]

24
25
26
27
28
 
# File 'lib/action_web_service/struct.rb', line 24

def initialize(values={})
  if values.is_a?(Hash)
    values.map{|k,v| __send__('%s=' % k.to_s, v)}
  end
end

Class Method Details

.member(name, type, options = {}) ⇒ Object

accessor methods for reading and writing the member value.

[View source]

46
47
48
49
50
51
52
53
54
 
# File 'lib/action_web_service/struct.rb', line 46

def member(name, type, options={})
  name = name.to_sym
  type = ActionWebService::SignatureTypes.canonical_signature_entry({ name => type }, 0)
  write_inheritable_hash("struct_members", name => [type, options])
  class_eval <<-END
    def #{name}; @#{name}; end
    def #{name}=(value); @#{name} = value; end
  END
end

.member_type(name) ⇒ Object

:nodoc:

[View source]

60
61
62
63
 
# File 'lib/action_web_service/struct.rb', line 60

def member_type(name) # :nodoc:
				type, options = members[name.to_sym]
				type
end

.members ⇒ Object

:nodoc:

[View source]

56
57
58
 
# File 'lib/action_web_service/struct.rb', line 56

def members # :nodoc:
  read_inheritable_attribute("struct_members") || {}
end

Instance Method Details

#[](name) ⇒ Object

The member with the given name

[View source]

31
32
33
 
# File 'lib/action_web_service/struct.rb', line 31

def [](name)
  send(name.to_s)
end

#each_pair(&block) ⇒ Object

Iterates through each member

[View source]

36
37
38
39
40
 
# File 'lib/action_web_service/struct.rb', line 36

def each_pair(&block)
  self.class.members.each do |name, type|
    yield name, self.__send__(name)
  end
end