Class: Dropcaster::Channel

Inherits:
Hash
  • Object
show all
Includes:
HashKeys
Defined in:
lib/dropcaster/channel.rb

Overview

Represents a podcast feed in the RSS 2.0 format

Instance Method Summary collapse

Methods included from HashKeys

#method_missing

Constructor Details

#initialize(sources, options) ⇒ Channel

Instantiate a new Channel object. sources must be present and can be a String or Array of Strings, pointing to a one or more directories or MP3 files.

options is a hash with all attributes for the channel. The following attributes are mandatory when a new channel is created:

  • :title - Title (name) of the podcast

  • :url - URL to the podcast

  • :description - Short description of the podcast (a few words)



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/dropcaster/channel.rb', line 21

def initialize(sources, options)
  super(Hash.new)

  # Assert mandatory options
  [:title, :url, :description].each{|attr|
    raise MissingAttributeError.new(attr) if options[attr].blank?
  }

  self.merge!(options)
  self.categories = Array.new
  @source_files = Array.new

  if (sources.respond_to?(:each)) # array
    sources.each{|src|
      add_files(src)
    }
  else
    # single file or directory
    add_files(src)
  end

  # Prepend the image URL with the channel's base to make an absolute URL
  self.image_url = URI.join(self.url, self.image_url).to_s unless self.image_url.blank? || self.image_url =~ /^https?:/

  channel_template = self.channel_template || File.join(File.dirname(__FILE__), '..', '..', 'templates', 'iTunes.rss.erb')

  begin
    @erb_template = ERB.new(File.new(channel_template), 0, "%<>")
  rescue Errno::ENOENT => e
    raise TemplateNotFoundError.new(e.message)
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Dropcaster::HashKeys

Instance Method Details

#items ⇒ Object

Returns all items (episodes) of this channel, ordered by newest-first.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/dropcaster/channel.rb', line 66

def items
  all_items = Array.new
  @source_files.each{|src|
    item = Item.new(src)

    # set author and image_url from channel if empty
    item.tag.artist = self.author if item.artist.blank?
    item.image_url = self.image_url if item.image_url.blank?

    # construct absolute URL, based on the channel's enclosures_url attribute
    # If enclosures_url is not given, take the channel URL as a base.
    self.enclosures_url = self.url if self.enclosures_url.blank?
    self.enclosures_url << '/' unless self.enclosures_url =~ /\/$/
    item.url = URI.join(URI.escape(self.enclosures_url), URI.escape(item.file_name))

    all_items << item
  }

  all_items.sort{|x, y| y.pub_date <=> x.pub_date}
end

#to_rss ⇒ Object

Returns this channel as an RSS representation. The actual rendering is done with the help of an ERB template. By default, it is expected as ../../templates/channel.rss.erb (relative) to channel.rb.



59
60
61
 
# File 'lib/dropcaster/channel.rb', line 59

def to_rss
  @erb_template.result(binding)
end