nachokb-bcms_feeds 1.0.6

data/README

@@ -0,0 +1,10 @@
+bcms_feeds
+==========
+
+This is a BrowserCMS module which fetches, caches and displays RSS/Atom feeds.
+
+For installation instructions see http://www.browsercms.org/doc/guides/html/installing_modules.html
+
+To incorporate a feed in your page, use a Feed Portlet. Specify the URL of the feed. SimpleRSS [http://simple-rss.rubyforge.org/] is used for parsing, and a parsed version of the feed will be available in the @feed variable. You can use the code section to manipulate this data as necessary, and the template to format it.
+
+Feeds are cached in the database for 30 minutes. If there is a failure fetching a remote feed, the expiry time of the cached feed will be extended by 10 minutes. When fetching remote feeds, the timeout length is 10 seconds.

data/app/models/feed.rb

@@ -0,0 +1,70 @@
+require "open-uri"
+require "timeout"
+require "simple-rss"
+require "ri_cal"
+
+class Feed < ActiveRecord::Base
+  TTL = 30.minutes
+  TTL_ON_ERROR = 10.minutes
+  TIMEOUT = 10 # In seconds
+  CONTENT_TYPES = {
+    "application/rss+xml" => lambda { |content| SimpleRSS.parse(content) },
+    "text/calendar" => lambda { |content| RiCal.parse_string(content) }
+  }.with_indifferent_access
+  DEFAULT_CONTENT_TYPE = "application/rss+xml"
+  
+  delegate :entries, :items, :to => :parsed_contents
+  
+  def self.content_types
+    self::CONTENT_TYPES
+  end
+  
+  def self.supported_content_types
+    self.content_types.keys
+  end
+  
+  def self.default_content_type
+    self::DEFAULT_CONTENT_TYPE
+  end
+  
+  def content_type
+    read_attribute(:content_type) || self.class::DEFAULT_CONTENT_TYPE
+  end
+  
+  def parsed_contents
+    @parsed_contents ||= parse_content
+  end
+  
+  def contents(force_reload = false)
+    if force_reload || expires_at.nil? || expires_at < Time.now.utc
+      begin
+        self.expires_at = Time.now.utc + TTL
+        new_contents = remote_contents
+        parse_content(new_contents) # Check that we can actually parse it
+        write_attribute(:contents, new_contents)
+        save
+      rescue StandardError, Timeout::Error, SimpleRSSError => exception
+        logger.error("Loading feed #{url} failed with #{exception.inspect}")
+        self.expires_at = Time.now.utc + TTL_ON_ERROR
+        save
+      end
+    else
+      logger.info("Loading feed from cache: #{url}")
+    end
+    
+    read_attribute(:contents)
+  end
+  
+  def remote_contents
+    logger.info("Loading feed from remote: #{url}")
+    Timeout.timeout(TIMEOUT) { open(url).read }
+  end
+
+  private
+    def parse_content(content = nil)
+      parser = self.class.content_types[self.content_type]
+      raise ArgumentError.new("Invalid ContentType for #{self.class.name}##{self.id}") unless parser
+      content ||= self.contents
+      parser.call(content)
+    end
+end

data/app/portlets/feed_portlet.rb

@@ -0,0 +1,9 @@
+class FeedPortlet < Portlet
+  # handler "erb"
+  
+  def render
+    raise ArgumentError, "No feed URL specified" if self.url.blank?
+    @feed = Feed.find_or_create_by_url_and_content_type(self.url, self.content_type).parsed_contents
+    instance_eval(self.code) unless self.code.blank?
+  end
+end

data/app/views/portlets/feed/_form.html.erb

@@ -0,0 +1,6 @@
+<%= f.cms_text_field :name %>
+<%= f.cms_drop_down :content_type, Feed.supported_content_types, :default => Feed.default_content_type %>
+<%= f.cms_text_field :url %>
+<%= f.cms_text_area :code %>
+<%= f.cms_drop_down :handler, ActionView::Template.template_handler_extensions, :default => "erb" %>
+<%= f.cms_text_area :template, :default_value => @block.class.default_template %>

data/app/views/portlets/feed/render.html.erb

@@ -0,0 +1 @@
+<%=h @portlet.name %>

data/db/migrate/20090813213104_add_feeds.rb

@@ -0,0 +1,14 @@
+class AddFeeds < ActiveRecord::Migration
+  def self.up
+    create_table :feeds do |f|
+      f.string :url
+      f.string :content_type
+      f.text :contents
+      f.datetime :expires_at
+    end
+  end
+
+  def self.down
+    drop_table :feeds
+  end
+end

data/lib/bcms_feeds.rb

@@ -0,0 +1 @@
+

data/rails/init.rb

@@ -0,0 +1,3 @@
+gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Cms.add_to_rails_paths gem_root
+Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"

data/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+require 'mocha'
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/test/unit/calendar_feed_test.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + "/../test_helper"
+
+class CalendarFeedTest < ActiveSupport::TestCase
+  def setup
+    @feed = Feed.create!(:url => "http://example.com/events.ics", :content_type => "text/calendar")
+    @contents = "BEGIN:VEVENT\nDTSTART;VALUE=DATE:20090903\nDTEND;VALUE=DATE:20090904\nDTSTAMP:20090831T192355Z\nDESCRIPTION:\nLOCATION:\nSEQUENCE:0\nSUMMARY:Example\nEND:VEVENT"
+  end
+  
+  test "parsed_contents should return the contents parsed by RiCal" do
+    @feed.stubs(:contents).returns(@contents)
+    RiCal.stubs(:parse_string).with(@contents).returns(parsed_contents = stub)
+    
+    assert_equal parsed_contents, @feed.parsed_contents
+  end
+  
+  test "default content_type should be used when no other is specified" do
+    assert_equal Feed.default_content_type, Feed.new.content_type
+  end
+  
+  test "parse_content should raise an error when content_type is not valid" do
+    assert_raise(ArgumentError) { Feed.new(:content_type => "invalid").parsed_contents }
+  end
+end

data/test/unit/feed_test.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + "/../test_helper"
+
+class FeedTest < ActiveSupport::TestCase
+  def setup
+    @feed = Feed.create!(:url => "http://example.com/blog.rss")
+    @contents = "<feed>Some feed</feed>"
+    
+    now = Time.now
+    Time.stubs(:now).returns(now) # Freeze time
+    
+    # small timeout for testing purposes
+    Feed.send(:remove_const, :TIMEOUT)
+    Feed.const_set(:TIMEOUT, 1)
+  end
+  
+  test "remote_contents should fetch the feed" do
+    @feed.expects(:open).with("http://example.com/blog.rss").returns(stub(:read => @contents))
+    assert_equal @contents, @feed.remote_contents
+  end
+  
+  test "remote_contents should raise a Timeout::Error if fetching the feed takes longer then Feed::TIMEOUT" do
+    def @feed.open(url)
+      sleep(2)
+      stubs(:read => "bla")
+    end
+    
+    assert_raise(Timeout::Error) { @feed.remote_contents }
+  end
+  
+  test "contents with no expiry should return the remote contents and save it" do
+    @feed.expires_at = nil
+    should_get_remote_contents_and_parse
+  end
+  
+  test "contents with an expiry in the past return the remote contents and save it" do
+    @feed.expires_at = Time.now - 1.hour
+    should_get_remote_contents_and_parse
+  end
+  
+  def should_get_remote_contents_and_parse
+    @feed.stubs(:remote_contents).returns(@contents)
+    SimpleRSS.expects(:parse).with(@contents)
+    
+    assert_equal @contents, @feed.contents
+    @feed.reload
+    assert_equal @contents, @feed.read_attribute(:contents)
+    
+    # I think the to_i is necessary because of a lack of precision provided by sqlite3. I think.
+    # Anyway, without it the comparison fails.
+    assert_equal (Time.now.utc + Feed::TTL).to_i, @feed.expires_at.to_i
+  end
+  
+  test "contents with the expiry in the future should return the cached contents" do
+    @feed.expires_at = Time.now + 1.hour
+    @feed.write_attribute(:contents, @contents)
+    
+    assert_equal @contents, @feed.contents
+  end
+  
+  test "TTL of cached contents should be extended if there is an error fetching the remote contents, or parsing the feed" do
+    [StandardError, Timeout::Error, SimpleRSSError].each do |exception|
+      @feed.expires_at = Time.now - 1.hour
+      @feed.stubs(:remote_contents).raises(exception)
+      @feed.write_attribute(:contents, @contents)
+      
+      assert_equal @contents, @feed.contents
+      assert_equal Time.now.utc + Feed::TTL_ON_ERROR, @feed.expires_at
+    end
+  end
+  
+  test "parsed_contents should return the contents parsed by SimpleRSS" do
+    @feed.stubs(:contents).returns(@contents)
+    SimpleRSS.stubs(:parse).with(@contents).returns(parsed_contents = stub)
+    
+    assert_equal parsed_contents, @feed.parsed_contents
+  end
+end

data/test/unit/portlets/feed_portlet_test.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '/../../test_helper')
+
+class FeedTest < ActiveSupport::TestCase
+
+  test "Should be able to create new instance of a portlet" do
+    assert FeedPortlet.create!(:name => "New Portlet")
+  end
+  
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: nachokb-bcms_feeds
+version: !ruby/object:Gem::Version 
+  version: 1.0.6
+platform: ruby
+authors: 
+- Jon Leighton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-01 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: simple-rss
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ri_cal
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A BrowserCMS module which fetches, caches and displays RSS/Atom feeds -- now with iCalendar support!
+email: j@jonathanleighton.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- app/models/feed.rb
+- app/portlets/feed_portlet.rb
+- app/views/portlets/feed/_form.html.erb
+- app/views/portlets/feed/render.html.erb
+- db/migrate/20090813213104_add_feeds.rb
+- lib/bcms_feeds.rb
+- rails/init.rb
+- README
+has_rdoc: true
+homepage: http://github.com/jonleighton/bcms_feeds
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Feeds in BrowserCMS
+test_files: 
+- test/unit/feed_test.rb
+- test/unit/calendar_feed_test.rb
+- test/unit/portlets/feed_portlet_test.rb
+- test/test_helper.rb
+- test/performance/browsing_test.rb