pivotalrpx-bcms_feeds 1.0.12

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/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/app/models/feed.rb

@@ -0,0 +1,66 @@
+require 'net/http'
+require 'timeout'
+require 'feedzirra'
+
+class Feed < ActiveRecord::Base
+  TTL = 30.minutes
+  TTL_ON_ERROR = 10.minutes
+  TIMEOUT = 10 # In seconds
+  
+  delegate :entries, :items, :to => :parsed_contents
+
+  def parsed_contents
+    @parsed_contents ||= Feedzirra::Feed.parse(contents)
+  end
+  
+  def contents
+    if expires_at.nil? || expires_at < Time.now.utc
+      begin
+        self.expires_at = Time.now.utc + TTL
+        new_contents = remote_contents
+        Feedzirra::Feed.parse(new_contents) # Check that we can actually parse it
+        write_attribute(:contents, new_contents)
+        save
+      rescue StandardError, Timeout::Error, Feedzirra::NoParserAvailable => 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
+    Timeout.timeout(TIMEOUT) {
+      simple_get(url)
+    }
+  end
+
+  private
+
+  def simple_get(url)
+    logger.info("Loading feed from remote: #{url}")
+    parsed_url = URI.parse(url)
+    http = Net::HTTP.start(parsed_url.host, parsed_url.port)
+    response = http.request_get(url_path(parsed_url), 'User-Agent' => "BrowserCMS bcms_feed extension")
+    if response.is_a?(Net::HTTPSuccess)
+      return response.body
+    elsif response.is_a?(Net::HTTPRedirection)
+      logger.info("#{url} returned a redirect. Following . . ")
+      simple_get(response.header['Location'])
+    else
+      logger.info("#{url} unexpected results ")
+      raise StandardError 
+    end
+  end
+
+  def url_path(parsed_url)
+    path = parsed_url.path
+    # use the path + query for the request_get() call, not the full url
+    # using the full url can lead to incorrect 'location' headers in the case of a redirect
+    path << "?#{parsed_url.query}" if parsed_url.query
+    path
+  end
+end

data/app/portlets/feed_portlet.rb

@@ -0,0 +1,15 @@
+class FeedPortlet < Portlet
+  handler "erb"
+  
+  def render
+    raise ArgumentError, "No feed URL specified" if self.url.blank?
+    @feed = Feed.find_or_create_by_url(self.url).parsed_contents
+    if @portlet.limit.to_i != 0
+      @items = @feed.entries[0..(@portlet.limit.to_i - 1)]
+    else
+      @items = @feed.entries
+    end
+    instance_eval(self.code) unless self.code.blank?
+  end
+
+end

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

@@ -0,0 +1,11 @@
+<%= f.cms_text_field :name %>
+<%= f.cms_text_field :url %>
+<%= f.cms_text_area :code %>
+<%= f.cms_drop_down :limit, 
+  [
+    ['Unlimited','0'],['1','1'],['2','2'],['3','3'],['4','4'],['5','5'],['6','6'],['7','7'],['8','8'],['9','9'],
+    ['10','10'],['11','11'],['12','12'],['13','13'],['14','14'],['15','15'],['16','16'],['17','17'],['18','18'],['19','19'],
+    ['20','20']
+], :instructions => 'Items are available in the @items array and will be limited to the number you select above. You can still access the items via @feed.items, but they will not have a limit applied to them for backwards compatibility.'
+%>
+<%= f.cms_text_area :template, :default_value => @block.class.default_template %>

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

@@ -0,0 +1,12 @@
+<div class="feed-list feed-number-<%= @portlet.id %>">
+  <h1><%= h @feed.title %></h1>
+  <ul>
+    <% @items.each do |item| %>
+      <li>
+        <div class="title"><%= link_to item.title, item.link %></div>
+        <div class="description"><%= item.description %></div>
+        <div class="item-meta">by <%= h item.dc_creator %> on <%= h item.pubDate %></div>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/db/migrate/20090813213104_add_feeds.rb

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

data/db/migrate/20100115202209_modify_feeds_table_to_use_mediumtext.rb

@@ -0,0 +1,15 @@
+class ModifyFeedsTableToUseMediumtext < ActiveRecord::Migration
+  def self.up
+    if Feed.connection.adapter_name == 'MySQL'
+      #The postgres text column suffices, and this syntax and column type don't work in pg.
+      execute "ALTER TABLE feeds MODIFY COLUMN contents MEDIUMTEXT"
+    end
+  end
+
+  def self.down
+    if Feed.connection.adapter_name == 'MySQL'
+      #The postgres text column suffices, and this syntax and column type don't work in pg.
+      execute "ALTER TABLE feeds MODIFY COLUMN contents TEXT"
+    end
+  end
+end

data/lib/bcms_feeds.rb

@@ -0,0 +1 @@
+require 'bcms_feeds/routes'

data/lib/bcms_feeds/routes.rb

@@ -0,0 +1,5 @@
+module Cms::Routes
+  def routes_for_bcms_feeds
+    #nothing, just here to make the default install process happy.
+  end
+end

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/feed_test.rb

@@ -0,0 +1,95 @@
+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 via simple_get" do
+    @feed.expects(:simple_get).returns( @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.simple_get(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
+  
+  test "Contents can be larger than 64Kb of text in a feed" do
+    feed = Feed.new(:url => 'http://www.foo.com', :contents => '<feed>' + 'w' * 300000 + '</feed>', :expires_at => Time.now + 15.minutes)
+    feed.save
+    
+    assert_equal 'http://www.foo.com', feed.url
+    assert_equal '<feed>' + 'w' * 300000 + '</feed>', feed.contents
+  end
+
+  test "url_path should return the path from the requested url" do
+    parsed_url = URI.parse("http://example.com/blog.rss")
+    assert_equal("/blog.rss", @feed.send(:url_path, parsed_url))
+  end
+
+  test "url_path should include the provided query string" do
+    parsed_url = URI.parse("http://example.com/blog.rss?feed=atom")
+    assert_equal("/blog.rss?feed=atom", @feed.send(:url_path, parsed_url))
+  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,98 @@
+--- !ruby/object:Gem::Specification 
+name: pivotalrpx-bcms_feeds
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 12
+  version: 1.0.12
+platform: ruby
+authors: 
+- Jon Leighton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-14 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pauldix-feedzirra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A BrowserCMS module which fetches, caches and displays RSS/Atom feeds
+email: j@jonathanleighton.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- app/controllers/application_controller.rb
+- app/helpers/application_helper.rb
+- 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
+- db/migrate/20100115202209_modify_feeds_table_to_use_mediumtext.rb
+- lib/bcms_feeds.rb
+- lib/bcms_feeds/routes.rb
+- rails/init.rb
+- README
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/feed_test.rb
+- test/unit/portlets/feed_portlet_test.rb
+has_rdoc: true
+homepage: http://github.com/pivotalrpx/bcms_feeds
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Feeds in BrowserCMS
+test_files: 
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/feed_test.rb
+- test/unit/portlets/feed_portlet_test.rb