bcms_bmedia_feeds 2.0.0

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gemspec
+gem 'sqlite3'
+gem "jquery-rails"
+
+group :test do
+	gem 'mocha'
+end
+
+

data/README.markdown

@@ -0,0 +1,27 @@
+Feed Module
+==========
+
+This is a fork of https://github.com/jonleighton/bcms_feeds which updates the module to work with BrowserCMS 3.5.x and later. It will be released as bcms_bmedia_feeds since the original gem is owned by jonleighton.
+
+Overview
+========
+
+This is a BrowserCMS module which fetches, caches and displays RSS/Atom feeds.
+
+Installation
+============
+
+For installation instructions see http://www.browsercms.org/doc/guides/html/installing_modules.html
+
+	$ gem install bcms_bmedia_feeds
+	$ rails g cms:install bcms_bmedia_feeds
+	
+To incorporate a feed in your page, add a Feed Portlet to a page. Specify the URL of the feed. You can use the code section to manipulate this data as necessary, and the template to format it. SimpleRSS [http://simple-rss.rubyforge.org/] is used for parsing, and a parsed version of the feed will be available in the @feed variable.
+
+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.
+
+Issues
+=====
+
+* Escaping html - Feeds will often use HTML in their post bodies. If you decide the 3rd party site is 'trustworthy' enough to just render unescaped HTML from their site on, then you can unescape the XML. By default, its contents are shown as XML encoded bodies. 
+* Cached Pages - If a page with a feed portlet on it has been cached, it will not update with as much frequency as might be expected. You can solve this by turning off page caching for that page.

data/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/bcms_feeds/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/bcms_feeds/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/bcms_feeds/application_controller.rb

@@ -0,0 +1,4 @@
+module BcmsFeeds
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/bcms_feeds/application_helper.rb

@@ -0,0 +1,4 @@
+module BcmsFeeds
+  module ApplicationHelper
+  end
+end

data/app/models/bcms_feeds/feed.rb

@@ -0,0 +1,62 @@
+require 'net/http'
+require 'timeout'
+require 'simple-rss'
+
+module BcmsFeeds
+  class Feed < ActiveRecord::Base
+    TTL = 30.minutes
+    TTL_ON_ERROR = 10.minutes
+    TIMEOUT = 10 # In seconds
+  
+    delegate :entries, :items, :to => :parsed_contents
+    attr_accessible :url, :contents, :expires_at
+  
+    def parsed_contents
+      @parsed_contents ||= SimpleRSS.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
+          SimpleRSS.parse(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
+      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, '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} returned a redirect. Following . . ")
+        raise StandardError 
+      end
+    end
+
+  end
+end

data/app/portlets/feed_portlet.rb

@@ -0,0 +1,17 @@
+class FeedPortlet < Cms::Portlet
+  handler "erb"
+  
+  enable_template_editor true
+  
+  def render
+    raise ArgumentError, "No feed URL specified" if self.url.blank?
+    @feed = BcmsFeeds::Feed.find_or_create_by_url(self.url).parsed_contents
+    if @portlet.limit.to_i != 0
+      @items = @feed.items[0..(@portlet.limit.to_i - 1)]
+    else
+      @items = @feed.items
+    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_template_editor :template %>

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

@@ -0,0 +1,12 @@
+<div class="feed-list feed-number-<%= @portlet.id %>">
+  <h1><%= @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 <%= item.dc_creator %> on <%= item.pubDate %></div>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/config/routes.rb

@@ -0,0 +1,2 @@
+BcmsFeeds::Engine.routes.draw do
+end

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 BcmsFeeds::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 BcmsFeeds::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/db/migrate/20120710201056_bcms_feeds_v2_0_0.rb

@@ -0,0 +1,7 @@
+class BcmsFeedsV200 < ActiveRecord::Migration
+  def change
+    if table_exists?(:feeds) && !table_exists?(:bcms_feeds_feeds)
+      rename_table :feeds, :bcms_feeds_feeds
+    end
+  end
+end

data/lib/bcms_bmedia_feeds.rb

@@ -0,0 +1,5 @@
+require "bcms_feeds/engine"
+
+# This file name (bcms_bmedia_feeds) is different than bcms_feeds since we don't own the gem and need to publish it.
+module BcmsFeeds
+end

data/lib/bcms_feeds/engine.rb

@@ -0,0 +1,7 @@
+require 'browsercms'
+module BcmsFeeds
+  class Engine < ::Rails::Engine
+    isolate_namespace BcmsFeeds
+    include Cms::Module
+  end
+end

data/lib/bcms_feeds/version.rb

@@ -0,0 +1,3 @@
+module BcmsFeeds
+  VERSION = "2.0.0"
+end

data/lib/generators/bcms_bmedia_feeds/install/USAGE

@@ -0,0 +1,3 @@
+Installs bcms_feeds into a project. Typically invoked indirectly via:
+
+   rails generate cms:install bcms_feeds

data/lib/generators/bcms_bmedia_feeds/install/install_generator.rb

@@ -0,0 +1,23 @@
+require 'cms/module_installation'
+
+module BcmsBmediaFeeds
+end
+class BcmsBmediaFeeds::InstallGenerator < Cms::ModuleInstallation
+  add_migrations_directory_to_source_root __FILE__
+  
+  
+  def copy_migrations
+    rake 'bcms_feeds:install:migrations'
+  end
+
+  # Uncomment to add module specific seed data to a project.
+  #def add_seed_data_to_project
+  #  copy_file "../bcms_feeds.seeds.rb", "db/bcms_feeds.seeds.rb"
+  #  append_to_file "db/seeds.rb", "load File.expand_path('../bcms_feeds.seeds.rb', __FILE__)\n"
+  #end
+  
+  def add_routes
+    mount_engine(BcmsFeeds)
+  end
+    
+end

data/lib/tasks/bcms_feeds_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bcms_feeds do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: bcms_bmedia_feeds
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jon Leighton
+- BrowserMedia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: browsercms
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: simple-rss
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+description: A BrowserCMS module which fetches, caches and displays RSS/Atom feeds
+email: github@browsermedia.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- app/assets/javascripts/application.js
+- app/assets/javascripts/bcms_feeds/application.js
+- app/assets/stylesheets/application.css
+- app/assets/stylesheets/bcms_feeds/application.css
+- app/controllers/bcms_feeds/application_controller.rb
+- app/helpers/bcms_feeds/application_helper.rb
+- app/models/bcms_feeds/feed.rb
+- app/portlets/feed_portlet.rb
+- app/views/portlets/feed/_form.html.erb
+- app/views/portlets/feed/render.html.erb
+- config/routes.rb
+- db/migrate/20090813213104_add_feeds.rb
+- db/migrate/20100115202209_modify_feeds_table_to_use_mediumtext.rb
+- db/migrate/20120710201056_bcms_feeds_v2_0_0.rb
+- lib/bcms_bmedia_feeds.rb
+- lib/bcms_feeds/engine.rb
+- lib/bcms_feeds/version.rb
+- lib/generators/bcms_bmedia_feeds/install/install_generator.rb
+- lib/generators/bcms_bmedia_feeds/install/USAGE
+- lib/tasks/bcms_feeds_tasks.rake
+- README.markdown
+- Gemfile
+homepage: http://www.github.com/browsermedia/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
+      version: '0'
+      segments:
+      - 0
+      hash: -4420423868363560329
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4420423868363560329
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Feeds in BrowserCMS
+test_files: []