Module: Timelog4r::XML_Parser

Defined in:
lib/timelog4r/xml_parser.rb

Overview

Description

Customized XML Parser for TimelogAPI.

Instance Method Summary collapse

Instance Method Details

#parse_author(element) ⇒ Object

Description

parse XML-Element convert to hash

Params

:element author-element [REXML::Element]

Return

=> {:normal => …, …}



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/timelog4r/xml_parser.rb', line 138

def parse_author(element)
  return nil unless element.elements['id'].has_text?
  result = {
    :images => {
      :normal =>
        URI.parse(
          element.elements['image/normal'].text
        ),
      :thumbnail =>
        URI.parse(
          element.elements['image/thumb'].text
        ),
      :small =>
        URI.parse(
          element.elements['image/small'].text
        )
    }
  }
  if element.elements['statflag'] then
    author_type = element.elements['statflag'].text == '2' ?
    'group' : 'user'
    result[:type] = author_type.to_sym
    result["#{author_type}_id".to_sym] = element.elements['id'].text
    result["#{author_type}_name".to_sym] = element.elements['name'].text
  end
  return result
end

#parse_entry(element) ⇒ Object

Description

parse XML::Element convert to hash.

Params

:element entry-element [REXML::Element]

Return

=> ‘…’, …

RelatedMethods

permission_to_sym parse_author tags_to_a



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/timelog4r/xml_parser.rb', line 74

def parse_entry(element)
  result = {
    :memo_text => element.elements['memo'].text,
    :memo_id => element.elements['id'].text,
    :permission =>
       permission_to_sym(
         element.elements['dispflag'].text
       ),
    :modified =>
       Time.parse(
         element.elements['modified'].text
       ),
    :permalink =>
       URI.parse(
         element.elements['link'].attributes['href']
       ),
    :author =>
       parse_author(
         element.elements['author']
       )
  }
  result[:reply_to] = {
    :memo_id =>
      element.elements['replyid'].text,
    :author => {
      :user_id =>
        element.elements['toid'].text,
      :screen_name =>
        element.elements['toname'].text,
    }
  } if element.elements['toid'].has_text?
  if element.elements['tododate'].has_text? then
    result[:todo] = Time.parse(
      element.elements['tododate'].text
    ) unless element.elements['tododate'].text.eql?(' ')
  end
  if element.elements['tag'].has_text? then
    result[:tag] = tags_to_a(element.elements['tag'].text)
  end
  if element.elements['fromid'] then
    result[:in_group] = {
      :user_id =>
        element.elements['fromid'].text,
      :screen_name =>
        element.elements['fromname'].text
    }
  end
  if element.elements['star'] then
    result[:favorites] = element.elements['star'].text.to_i
  end
  return result
end

#parse_profile(document) ⇒ Object

Description

parse XML-Document convert to hash.

Params

:document profile-document [REXML::Document]

Return

=> ‘Timelog … ’, :link => …

RelatedMethods

parse_user tags_to_a



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/timelog4r/xml_parser.rb', line 333

def parse_profile(document)
  result = {
    :title =>
      document.elements['show/title'].text,
    :link =>
      URI.parse(
        document.elements['show/link'].attributes['href']
      ),
    :modified =>
      Time.parse(
        document.elements['show/modified'].text
      ),
    :user => {
      :parmalink =>
         URI.parse(
           document.elements['show/user/url'].text
         ),
      :use_tags =>
        tags_to_a(
          document.elements['show/user/tags'].text
        )
    }.merge(
      parse_user(document.elements['show/user'])
    )
  }
  if document.elements['show/user/prof_url'].has_text?
    result[:user][:other_site] = URI.parse(
      document.elements['show/user/prof_url'].text
    )
  end
  if document.elements['show/user/prof_url'].has_text?
    result[:user][:profile_message] = document.elements['show/user/prof_msg'].text
  end
  return result
end

#parse_tag(element) ⇒ Object

Description

parse XML-Element convert to hash.

Params

:element tag-element [REXML::Element]

Return

=> ‘tag’, :count => 2



213
214
215
216
217
218
219
220
 
# File 'lib/timelog4r/xml_parser.rb', line 213

def parse_tag(element)
  {
    :tag =>
      element.elements['tag'].text,
    :count =>
      element.elements['cnt'].text
  }
end

#parse_tag_list(document) ⇒ Object

Description

parse XML-Document convert to hash.

Params

:document tags-document [REXML::Document]

Return

=> ‘Timelog … ’, :entries => […]

RelatedMethods

parse_tag



236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/timelog4r/xml_parser.rb', line 236

def parse_tag_list(document)
  result = {
    :title =>
      document.elements['tags/title'].text,
    :link =>
      URI.parse(document.elements['tags/link'].attributes['href']),
    :modified =>
      Time.parse(document.elements['tags/modified'].text)
  }
  result[:tags] = document.elements.collect('tags/tagdata'){|tag|
    parse_tag(tag)
  }
  return result
end

#parse_timeline(document) ⇒ Object

Description

parse XML-Document convert to hash.

Params

:document timeline document [REXML::Document]

Return

=> ‘Timelog …’, :entries => […]

RelatedMethods

parse_author parse_entry



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/timelog4r/xml_parser.rb', line 181

def parse_timeline(document)
  result = {
    :title =>
      document.elements['memos/title'].text,
    :link =>
      URI.parse(
        document.elements['memos/link'].attributes['href']
      ),
    :modified =>
      Time.parse(
        document.elements['memos/modified'].text
      )
  }
  author = parse_author(document.elements['memos/author'])
  result[:author] = author if author
  result[:entries] = document.elements.collect('memos/entry'){|entry|
    parse_entry(entry)
  }
  return result
end

#parse_user(element) ⇒ Object

Description

parse XML-Element convert to hash.

Params

:element user-element [REXML::Element]

Return

=> ‘user_id’, :user_name => ‘name’, …



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/timelog4r/xml_parser.rb', line 262

def parse_user(element)
  {
    :user_id =>
      element.elements['id'].text,
    :user_name =>
      element.elements['name'].text,
    :images => {
      :normal =>
        URI.parse(
          element.elements['image/normal'].text
        ),
      :thumbnail =>
        URI.parse(
          element.elements['image/thumb'].text
        ),
      :small =>
        URI.parse(
          element.elements['image/small'].text
        )
    }
  }
end

#parse_user_list(document) ⇒ Object

Description

parse XML-Document convert to hash.

Params

:document users-document [REXML::Document]

Return

=> ‘Timelog … ’, :entries => […]

RelatedMethods

parse_user



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/timelog4r/xml_parser.rb', line 299

def parse_user_list(document)
  result = {
    :title =>
      document.elements['friends/title'].text,
    :link =>
      URI.parse(
        document.elements['friends/link'].attributes['href']
      ),
    :modified =>
      Time.parse(
        document.elements['friends/modified'].text
      )
  }
  result[:entries] = document.elements.collect('friends/entry'){|friend|
    parse_user(friend)
  }
  return result
end

#permission_to_sym(string) ⇒ Object

Description

memo’s entry permission to symbol.

Params

:string memo’s permission [String]

Return

:public (case of ‘public permission’) :friends_only (case of ‘friends-only permission’) :private (case of ‘private permission’) :unknown (other case)



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/timelog4r/xml_parser.rb', line 30

def permission_to_sym(string)
  case string
    when '0'
      return :public
    when '1'
      return :friends_only
    when '2'
      return :private
    else
      return :unknown
  end
end

#tags_to_a(tag_string) ⇒ Object

Description

tag-strings convert to Array in tag.

Params

:tag_string tags [String]

Return
‘TagA’, ‘TagB’, … 


54
55
56
 
# File 'lib/timelog4r/xml_parser.rb', line 54

def tags_to_a(tag_string)
  return tag_string.chop.split(',')
end