Class: FeedTools::OpensearchFeed

Inherits:
Feed
  • Object
show all
Defined in:
lib/opensearch_feed.rb

Overview

The FeedTools::OpensearchFeed class represents a web feed’s structure for an Opensearch query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attrs = {}) ⇒ OpensearchFeed

Returns a new instance of OpensearchFeed.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/opensearch_feed.rb', line 31

def initialize(attrs={})
  #super
  @search_terms = attrs[:search_terms]
  @total_results = attrs[:total_results]
  @start_index = attrs[:start_index]
  @items_per_page = attrs[:count]
  @search_page = nil
  @first_page = nil
  @last_page = nil
  @previous_page = nil
  @next_page = nil
  @queries = {}
  @queries[:request] = FeedTools::OpensearchQuery.new("request", attrs) if @search_terms
end

Instance Attribute Details

#queries ⇒ Object

Returns the value of attribute queries.



30
31
32
 
# File 'lib/opensearch_feed.rb', line 30

def queries
  @queries
end

Instance Method Details

#add_opensearch_tags(xml) ⇒ Object 



389
390
391
392
393
394
395
396
 
# File 'lib/opensearch_feed.rb', line 389

def add_opensearch_tags(xml)
  xml.opensearch(:totalResults){|tr|tr<<@total_results} if @total_results
  xml.opensearch(:startIndex){|si|si << @start_index} if @start_index         
  xml.opensearch(:itemsPerPage){|ipp|ipp<<@items_per_page} if @items_per_page
  @queries.each { | key, obj |
    obj.build_xml(xml)
  }        
end

#build_xml(feed_type = (self.feed_type or "atom"), feed_version = nil, xml_builder = Builder::XmlMarkup.new( :indent => 2, :escape_attrs => false)) ⇒ Object

Generates xml based on the content of the feed



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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
126
127
128
129
130
131
132
133
134
135
136
137
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
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
 
# File 'lib/opensearch_feed.rb', line 46

def build_xml(feed_type=(self.feed_type or "atom"), feed_version=nil,
    xml_builder=Builder::XmlMarkup.new(
      :indent => 2, :escape_attrs => false))
  xml_builder.instruct! :xml, :version => "1.0",
    :encoding => (self.configurations[:output_encoding] or "utf-8")
  if feed_type.nil?
    feed_type = self.feed_type
  end
  if feed_version.nil?
    feed_version = self.feed_version
  end
  if feed_type == "rss" &&
      (feed_version == nil || feed_version <= 0.0)
    feed_version = 1.0
  elsif feed_type == "atom" &&
      (feed_version == nil || feed_version <= 0.0)
    feed_version = 1.0
  end
  if feed_type == "rss" &&
      (feed_version == 0.9 || feed_version == 1.0 || feed_version == 1.1)
    # RDF-based rss format
    return xml_builder.tag!("rdf:RDF",
        "xmlns" => FEED_TOOLS_NAMESPACES['rss10'],
        "xmlns:content" => FEED_TOOLS_NAMESPACES['content'],
        "xmlns:rdf" => FEED_TOOLS_NAMESPACES['rdf'],
        "xmlns:dc" => FEED_TOOLS_NAMESPACES['dc'],
        "xmlns:syn" => FEED_TOOLS_NAMESPACES['syn'],
        "xmlns:admin" => FEED_TOOLS_NAMESPACES['admin'],
        "xmlns:taxo" => FEED_TOOLS_NAMESPACES['taxo'],
        "xmlns:itunes" => FEED_TOOLS_NAMESPACES['itunes'],
        "xmlns:media" => FEED_TOOLS_NAMESPACES['media'],
        "xmlns:atom" => FEED_TOOLS_NAMESPACES['atom10'],
        "xmlns:opensearch"=>"http://a9.com/-/spec/opensearch/1.1/") do
      channel_attributes = {}
      unless self.link.nil?
        channel_attributes["rdf:about"] =
          FeedTools::HtmlHelper.escape_entities(self.link)
      end
      xml_builder.channel(channel_attributes) do
        unless self.title.blank?
          xml_builder.title(
            FeedTools::HtmlHelper.strip_html_tags(self.title))
        else
          xml_builder.title
        end
        unless self.link.blank?
          xml_builder.link(self.link)
        else
          xml_builder.link
        end
        unless self.search_page.blank?
          xml_builder.tag!("atom:link", 
            {:href=>
               FeedTools::HtmlHelper.escape_entities(self.search_page),
             :rel=>"search",
             :type=>"application/opensearchdescription+xml"                
            }
          )
        end
        self.add_opensearch_tags(xml_builder)
        unless images.blank?
          xml_builder.image("rdf:resource" =>
            FeedTools::HtmlHelper.escape_entities(
              images.first.url))
        end
        unless description.nil? || description == ""
          xml_builder.description(description)
        else
          xml_builder.description
        end
        unless self.language.blank?
          xml_builder.tag!("dc:language", self.language)
        end
        unless self.rights.blank?
          xml_builder.tag!("dc:rights", self.rights)
        end
        xml_builder.tag!("syn:updatePeriod", "hourly")
        xml_builder.tag!("syn:updateFrequency",
          (self.time_to_live / 1.hour).to_s)
        xml_builder.tag!("syn:updateBase", Time.mktime(1970).iso8601)
        xml_builder.items do
          xml_builder.tag!("rdf:Seq") do
            unless items.nil?
              for item in items
                if item.link.nil?
                  raise "Cannot generate an rdf-based feed with a nil " +
                    "item link field."
                end
                xml_builder.tag!("rdf:li", "rdf:resource" =>
                  FeedTools::HtmlHelper.escape_entities(item.link))
              end
            end
          end
        end
        xml_builder.tag!(
          "admin:generatorAgent",
          "rdf:resource" => self.configurations[:generator_href])
        build_xml_hook(feed_type, feed_version, xml_builder)
      end
      unless self.images.blank?
        best_image = nil
        for image in self.images
          if image.link != nil
            best_image = image
            break
          end
        end
        best_image = self.images.first if best_image.nil?
        xml_builder.image("rdf:about" =>
            FeedTools::HtmlHelper.escape_entities(best_image.url)) do
          if !best_image.title.blank?
            xml_builder.title(best_image.title)
          elsif !self.title.blank?
            xml_builder.title(self.title)
          else
            xml_builder.title
          end
          unless best_image.url.blank?
            xml_builder.url(best_image.url)
          end
          if !best_image.link.blank?
            xml_builder.link(best_image.link)
          elsif !self.link.blank?
            xml_builder.link(self.link)
          else
            xml_builder.link
          end
        end
      end
      unless items.nil?
        for item in items
          item.build_xml(feed_type, feed_version, xml_builder)
        end
      end
    end
  elsif feed_type == "rss"
    # normal rss format
    return xml_builder.rss("version" => "2.0",
        "xmlns:content" => FEED_TOOLS_NAMESPACES['content'],
        "xmlns:rdf" => FEED_TOOLS_NAMESPACES['rdf'],
        "xmlns:dc" => FEED_TOOLS_NAMESPACES['dc'],
        "xmlns:taxo" => FEED_TOOLS_NAMESPACES['taxo'],
        "xmlns:trackback" => FEED_TOOLS_NAMESPACES['trackback'],
        "xmlns:itunes" => FEED_TOOLS_NAMESPACES['itunes'],
        "xmlns:media" => FEED_TOOLS_NAMESPACES['media'],
        "xmlns:atom" => FEED_TOOLS_NAMESPACES['atom10'],
        "xmlns:opensearch"=>"http://a9.com/-/spec/opensearch/1.1/") do
      xml_builder.channel do
        unless self.title.blank?
          xml_builder.title(
            FeedTools::HtmlHelper.strip_html_tags(self.title))
        end
        unless self.link.blank?
          xml_builder.link(link)
        end
        unless self.description.blank?
          xml_builder.description(description)
        else
          xml_builder.description
        end
        unless self.author.email.blank?
          xml_builder.managingEditor(self.author.email)
        end
        unless self.publisher.email.blank?
          xml_builder.webMaster(self.publisher.email)
        end
        unless self.published.blank?
          xml_builder.pubDate(self.published.rfc822)
        end
        unless self.updated.blank?
          xml_builder.lastBuildDate(self.updated.rfc822)
        end
        unless self.copyright.blank?
          xml_builder.copyright(self.copyright)
        end
        unless self.search_page.blank?
          xml_builder.tag!("atom:link", 
            {:href=>
               FeedTools::HtmlHelper.escape_entities(self.search_page),
             :rel=>"search",
             :type=>"application/opensearchdescription+xml"                
            }
          )
        end
        self.add_opensearch_tags(xml_builder)            
        xml_builder.ttl((time_to_live / 1.minute).to_s)
        xml_builder.generator(
          self.configurations[:generator_href])
        build_xml_hook(feed_type, feed_version, xml_builder)
        unless items.nil?
          for item in items
            item.build_xml(feed_type, feed_version, xml_builder)
          end
        end
      end
    end
  elsif feed_type == "atom" && feed_version == 0.3
    raise "Atom 0.3 is obsolete."
  elsif feed_type == "atom" && feed_version == 1.0
    namespaces = {}
    # normal atom format
    return xml_builder.feed("xmlns" => FEED_TOOLS_NAMESPACES['atom10'],
        "xmlns:opensearch"=>"http://a9.com/-/spec/opensearch/1.1/",
        "xml:lang" => language) do
      unless title.blank?
        xml_builder.title(title,
            "type" => "html")
      end
      xml_builder.author do
        unless self.author.nil? || self.author.name.nil?
          xml_builder.name(self.author.name)
        else
          xml_builder.name("n/a")
        end
        unless self.author.nil? || self.author.email.nil?
          xml_builder.email(self.author.email)
        end
        unless self.author.nil? || self.author.url.nil?
          xml_builder.uri(self.author.url)
        end
      end
      unless self.href.blank?
        xml_builder.link("href" => self.href,
            "rel" => "self",
            "type" => "application/atom+xml")
      end
      unless self.link.blank?
        xml_builder.link(
          "href" =>
            FeedTools::HtmlHelper.escape_entities(self.link),
          "rel" => "alternate")
      end
      unless self.subtitle.blank?
        xml_builder.subtitle(self.subtitle,
            "type" => "html")
      end
      unless self.next_page.blank?
        xml_builder.link(
          "href" =>
            FeedTools::HtmlHelper.escape_entities(self.next_page),
          "type"=>"application/opensearchdescription+xml",                
          "rel" => "next")          
      end
      unless self.previous_page.blank?
        xml_builder.link(
          "href" =>
            FeedTools::HtmlHelper.escape_entities(self.previous_page),
          "type"=>"application/opensearchdescription+xml",                
          "rel" => "previous")          
      end           
      unless self.first_page.blank?
        xml_builder.link(
          "href" =>
            FeedTools::HtmlHelper.escape_entities(self.first_page),
          "type"=>"application/opensearchdescription+xml",                
          "rel" => "first")          
      end           
      unless self.last_page.blank?
        xml_builder.link(
          "href" =>
            FeedTools::HtmlHelper.escape_entities(self.last_page),
          "type"=>"application/opensearchdescription+xml",                
          "rel" => "last")          
      end       
      unless self.search_page.blank?
        xml_builder.link(
          "href" =>
            FeedTools::HtmlHelper.escape_entities(self.search_page),
          "type"=>"application/opensearchdescription+xml",
          "rel" => "last")          
      end         
      self.add_opensearch_tags(xml_builder)               
      if self.updated != nil
        xml_builder.updated(self.updated.iso8601)
      elsif self.time != nil
        # Not technically correct, but a heck of a lot better
        # than the Time.now fall-back.
        xml_builder.updated(self.time.iso8601)
      else
        xml_builder.updated(Time.now.gmtime.iso8601)
      end
      unless self.rights.blank?
        xml_builder.rights(self.rights)
      end
      xml_builder.generator(self.configurations[:generator_name] +
        " - " + self.configurations[:generator_href])
      if self.id != nil
        unless FeedTools::UriHelper.is_uri? self.id
          if self.link != nil
            xml_builder.id(FeedTools::UriHelper.build_urn_uri(self.link))
          else
            raise "The unique id must be a valid URI."
          end
        else
          xml_builder.id(self.id)
        end
      elsif self.link != nil
        xml_builder.id(FeedTools::UriHelper.build_urn_uri(self.link))
      else
        raise "Cannot build feed, missing feed unique id."
      end
      build_xml_hook(feed_type, feed_version, xml_builder)
      unless items.nil?
        for item in items
          item.build_xml(feed_type, feed_version, xml_builder)
        end
      end
    end
  else
    raise "Unsupported feed format/version."
  end
end

#first_page ⇒ Object 



364
365
366
 
# File 'lib/opensearch_feed.rb', line 364

def first_page
  return @first_page
end

#first_page=(first_page) ⇒ Object 



367
368
369
 
# File 'lib/opensearch_feed.rb', line 367

def first_page=(first_page)
  @first_page=first_page
end

#last_page ⇒ Object 



370
371
372
 
# File 'lib/opensearch_feed.rb', line 370

def last_page
  return @last_page
end

#last_page=(last_page) ⇒ Object 



373
374
375
 
# File 'lib/opensearch_feed.rb', line 373

def last_page=(last_page)    
  @last_page=last_page
end

#next_page ⇒ Object 



382
383
384
 
# File 'lib/opensearch_feed.rb', line 382

def next_page
  return @next_page
end

#next_page=(next_page) ⇒ Object 



385
386
387
 
# File 'lib/opensearch_feed.rb', line 385

def next_page=(next_page)
  @next_page = next_page
end

#previous_page ⇒ Object 



376
377
378
 
# File 'lib/opensearch_feed.rb', line 376

def previous_page
  return @previous_page
end

#previous_page=(previous_page) ⇒ Object 



379
380
381
 
# File 'lib/opensearch_feed.rb', line 379

def previous_page=(previous_page)
  @previous_page = previous_page
end

#search_page ⇒ Object 



358
359
360
 
# File 'lib/opensearch_feed.rb', line 358

def search_page
  return @search_page
end

#search_page=(search_page) ⇒ Object 



361
362
363
 
# File 'lib/opensearch_feed.rb', line 361

def search_page=(search_page)
  @search_page=search_page
end