Class: Gnip::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/gnip_api/gnip/message.rb

Direct Known Subclasses

Activity, Actor, GnipData, SystemMessage, Url

Constant Summary collapse

SYSTEM_MESSAGE_TYPES = 
['error', 'warn', 'info']

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.build(params) ⇒ Object

Raises:


5
6
7
8
9
 
# File 'lib/gnip_api/gnip/message.rb', line 5

def self.build params
  return build_system_message(params) if (SYSTEM_MESSAGE_TYPES & params.keys).any?
  return build_activity(params) if params['objectType'] && params['objectType'] == 'activity'
  raise Gnip::UndefinedMessage
end

Instance Method Details

#activity? ⇒ Boolean

Returns:

  • (Boolean) 

27
28
29
 
# File 'lib/gnip_api/gnip/message.rb', line 27

def activity?
  @object_type == 'activity'
end

#error? ⇒ Boolean

Returns:

  • (Boolean) 

15
16
17
 
# File 'lib/gnip_api/gnip/message.rb', line 15

def error?
  @message_type == 'error'
end

#generate_json(data) ⇒ Object 


31
32
33
 
# File 'lib/gnip_api/gnip/message.rb', line 31

def generate_json data
  GnipApi::JsonParser.encode(data)
end

#info? ⇒ Boolean

Returns:

  • (Boolean) 

23
24
25
 
# File 'lib/gnip_api/gnip/message.rb', line 23

def info?
  @message_type == 'info'
end

#system_message? ⇒ Boolean

Returns:

  • (Boolean) 

11
12
13
 
# File 'lib/gnip_api/gnip/message.rb', line 11

def system_message?
  @message_type ? true : false
end

#warn? ⇒ Boolean

Returns:

  • (Boolean) 

19
20
21
 
# File 'lib/gnip_api/gnip/message.rb', line 19

def warn?
  @message_type == 'warn'
end