concerto_simple_rss 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0eceaf899ce25371ae25b97401b6f5f148abcd9c
-  data.tar.gz: 40395c9ad8b3b698176adaaad36505a9fc5ffa77
+  metadata.gz: 27bcb6e184059a5cbae750cb4851cf0161e966e0
+  data.tar.gz: ff9e1a3d2da810814ae11b4d1bbd8f9e89433ac2
 SHA512:
-  metadata.gz: aaf5f4ccd942a437b4699c6d62ee8a2e00c20c4402f0547a1400c3e77073b2eabb8a857bd05c2442a46c8c3ab58960b08ff725d2fe19c3989ae8c7c6edade4ba
-  data.tar.gz: 2c0ac3d2abadc5461adbd249d5700fb3079d03459dc1f99c47bcb937c76e09ad8c7894f6dfff2e92386caef2addac3ee4f8155a2170e872325d5dc41036ac1aa
+  metadata.gz: 506c01f6444c666f2a5756f81c5a2c205382216a09ad5a7a9a57c3f28d326d32d06c76973e04cb0d14032a07952dc00a00cfb21eb5170daaa17aec17be2d8130
+  data.tar.gz: 94afe471154677c38a7ef8af2205f91e2d62cb3ae1e8a5f4f6aa52f5fb23fcc05ef571d7497081067de1217a701e79a10c9fd985b7b0a3b7d67c4effb93c30d4

data/app/assets/javascripts/concerto_simple_rss/simple_rss.js

@@ -1,41 +1,51 @@
-function initializeSimpleRSSPreview() {
-  // When changes are made to url input, get rss data and build preview
-  $('#simple_rss_config_url').keyup(function (e) {
-    rss_url = $('#simple_rss_config_url').val();
-    getRSSData(rss_url);
-  });
+function toggleSimpleRssConditionalInputs() {
+  if ($('select#simple_rss_config_output_format').val() == 'xslt') {
+    $('div#simple_rss_maxitems').hide();
+    $('div#simple_rss_xslmarkup').show();
+  } else {
+    $('div#simple_rss_maxitems').show();
+    $('div#simple_rss_xslmarkup').hide();
+  }
 }
 
-function getRSSData(rss_url) {
-  // Get the rss data based in input url
-  $.ajax({
-    type: "GET",
-    dataType: 'jsonp',
-    url: document.location.protocol + '//ajax.googleapis.com/ajax/services/feed/load?v=1.0&num=1000&callback=?&q=' + encodeURIComponent(rss_url),
-    success: function (rss_data) {
-      simpleRSSPreview(rss_data);
-    },
-    error: function () {
-      $('#preview_div').html("Could not load preview")
+function previewSimpleRss() {
+  var url = $('input#simple_rss_config_url').data('url');
+  if (url) {
+    rss_url = $('input#simple_rss_config_url').val();
+    output_format = $('select#simple_rss_config_output_format').val();
+    max_items = $('input#simple_rss_config_max_items').val();
+    reverse_order = $('select#simple_rss_config_reverse_order').val();
+    xsl = $('textarea#simple_rss_config_xsl').val();
+    if (max_items == '') {
+      max_items = '0';
     }
-  });
+    $("#preview_div").load(url, { data: { 
+      url: rss_url, 
+      output_format: output_format, 
+      max_items: max_items,
+      reverse_order: reverse_order,
+      xsl: xsl
+    }, type: 'SimpleRss' });
+  }
 }
 
-function simpleRSSPreview(rss_data) {
+var initializedSimpleRssHandlers = false;
+function initializeSimpleRssHandlers() {
+  if (!initializedSimpleRssHandlers) {
+    $('select#simple_rss_config_output_format').on('change', toggleSimpleRssConditionalInputs);
+    toggleSimpleRssConditionalInputs();
 
-  // Store all article entries and clear preview 
-  articles = rss_data['responseData']['feed']['entries'];
-  $('#preview_div').html();
+    // on blur and change of url, display format, reverse_order, max items, and xsl
+    // not on keyup (poor man's debouncing technique?)
+    $('input#simple_rss_config_url').on('blur', previewSimpleRss);
+    $('select#simple_rss_config_output_format').on('change', previewSimpleRss);
+    $('input#simple_rss_config_max_items').on('blur', previewSimpleRss);
+    $('select#simple_rss_config_reverse_order').on('change', previewSimpleRss);
+    $('textarea#simple_rss_config_xsl').on('blur', previewSimpleRss);
 
-  // Build rss preview for only a sample of article titles
-  rss_preview = "<div><p style='font-weight: bold'>Found " + articles.length + " articles total</p></div>";
-  for (var i = 0; i < Math.min(4, articles.length); i++) {
-    rss_preview += "<div>" +
-      "<p style='font-size: 14px; text-decoration: underline'>" + articles[i]['title'] + "</p>" +
-      "<p>" + articles[i]['contentSnippet'] + "</p>" + "</div>";
+    initializedSimpleRssHandlers = true;
   }
-  $('#preview_div').html(rss_preview);
 }
 
-$(document).ready(initializeSimpleRSSPreview);
-$(document).on('page:change', initializeSimpleRSSPreview);
+$(document).ready(initializeSimpleRssHandlers);
+$(document).on('page:change', initializeSimpleRssHandlers);

data/app/models/simple_rss.rb

@@ -8,28 +8,44 @@ class SimpleRss < DynamicContent
     contents = []
 
     url = self.config['url']
-    type, feed_title, rss = fetch_feed(url)
+    type, feed_title, rss, raw = fetch_feed(url)
     
     if (["RSS", "ATOM"].include? type) && !feed_title.blank?
       # it is a valid feed
       if !self.config['reverse_order'].blank? && self.config['reverse_order'] == '1'
         rss.items.reverse!
       end
+      feed_items = rss.items
+      if !self.config['max_items'].blank? && self.config['max_items'].to_i > 0
+        feed_items = feed_items.first(self.config['max_items'].to_i)
+      end
       case self.config['output_format']
       when 'headlines'
-        rss.items.each_slice(5).with_index do |items, index|
+        feed_items.each_slice(5).with_index do |items, index|
           htmltext = HtmlText.new()
           htmltext.name = "#{feed_title} (#{index+1})"
           htmltext.data = "<h1>#{feed_title}</h1> #{items_to_html(items, type)}"
           contents << htmltext
         end
       when 'detailed'
-        rss.items.each_with_index do |item, index|
+        feed_items.each_with_index do |item, index|
           htmltext = HtmlText.new()
           htmltext.name = "#{feed_title} (#{index+1})"
           htmltext.data = item_to_html(item, type)
           contents << htmltext
         end
+      when 'xslt'
+        require 'rexml/document'
+        require 'xml/xslt'
+
+        XML::XSLT.registerErrorHandler { |string| puts string }
+        xslt = XML::XSLT.new()
+        xslt.xml = REXML::Document.new(raw)
+        xslt.xsl = REXML::Document.new(self.config['xsl'])
+        htmltext = HtmlText.new()
+        htmltext.name = "#{feed_title}"
+        htmltext.data = xslt.serve()
+        contents << htmltext
       else
         raise ArgumentError, 'Unexpected output format for RSS feed.'
       end
@@ -41,7 +57,7 @@ class SimpleRss < DynamicContent
     return contents
   end
 
-  # fetch the feed, return the type, title, and contents
+  # fetch the feed, return the type, title, and contents (parsed) and raw feed (unparsed)
   def fetch_feed(url)
     require 'rss'
     require 'net/http'
@@ -49,13 +65,18 @@ class SimpleRss < DynamicContent
     type = 'UNKNOWN'
     title = ''
     rss = nil
+    feed = nil
 
     begin
-      uri = URI.parse(url)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = uri.scheme == 'https'
-      request = Net::HTTP::Get.new(uri.request_uri)
-      feed = http.request(request).body
+      # cache same url for 1 minute to alleviate redundant calls when previewing
+      feed = Rails.cache.fetch(url, :expires_in => 1.minute) do
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == 'https'
+        request = Net::HTTP::Get.new(uri.request_uri)
+        http.request(request).body
+      end
+
       rss = RSS::Parser.parse(feed, false, true)
       raise "feed could not be parsed" if rss.nil?
     rescue => e
@@ -75,7 +96,7 @@ class SimpleRss < DynamicContent
       end
     end
 
-    return type, title, rss
+    return type, title, rss, feed
   end
 
   def item_to_html(item, type)
@@ -114,7 +135,7 @@ class SimpleRss < DynamicContent
   # Simple RSS processing needs a feed URL and the format of the output content.
   def self.form_attributes
     attributes = super()
-    attributes.concat([:config => [:url, :output_format, :reverse_order]])
+    attributes.concat([:config => [:url, :output_format, :reverse_order, :max_items, :xsl]])
   end
 
   # if the feed is valid we store the title in config
@@ -127,17 +148,60 @@ class SimpleRss < DynamicContent
       if (["RSS", "ATOM"].include? type) && !title.blank?
         self.config['title'] = title
       else
-        errors.add(:config_url, "does not appear to be an RSS feed")
+        errors.add(:base, "URL does not appear to be an RSS feed")
       end
     end
   end
 
   def validate_config
     if self.config['url'].blank?
-      errors.add(:config_url, "can't be blank")
+      errors.add(:base, "URL can't be blank")
+    end
+
+    if !['headlines', 'detailed', 'xslt'].include?(self.config['output_format'])
+      errors.add(:base, "Display Format must be Headlines or Articles or XSLT")
+    end
+
+    if self.config['output_format'] == 'xslt'
+      if self.config['xsl'].blank?
+        errors.add(:base, "XSL Markup can't be blank when using the XSLT Display Format")
+      else
+        url = self.config['url']
+        unless url.blank? 
+          require 'rexml/document'
+          require 'xml/xslt'
+
+          type, title, rss, raw = fetch_feed(url)
+          if ["RSS", "ATOM"].include? type
+            begin
+              xslt = XML::XSLT.new()
+              xslt.xml = REXML::Document.new(raw)
+              xslt.xsl = REXML::Document.new(self.config['xsl'])
+            rescue XML::XSLT::ParsingError
+              errors.add(:base, "XSL Markup could not be parsed")
+            end
+          end
+        end
+      end
     end
-    if !['headlines', 'detailed'].include?(self.config['output_format'])
-      errors.add(:config_output_format, "must be Headlines or Articles")
+  end
+
+  # return the first item for use as a preview
+  # data is a hash of the config
+  def self.preview(data)
+    begin
+      o = SimpleRss.create()
+      o.config['url'] = data[:url]
+      o.config['output_format'] = data[:output_format]
+      o.config['max_items'] = data[:max_items]
+      o.config['reverse_order'] = data[:reverse_order]
+      o.config['xsl'] = data[:xsl]
+      results = o.build_content.first.data
+    rescue => e
+      results = "Unable to preview #{e.message}"
     end
+
+    return results
   end
+
 end

data/app/views/contents/simple_rss/_form_top.html.erb

@@ -5,14 +5,14 @@
     <div class="clearfix">
       <%= config.label :url %>
       <div class="input">
-        <%= config.url_field :url, :placeholder => 'http://feeds.bbci.co.uk/news/rss.xml', :class => "input-xxlarge", :value => @content.config['url'] %>
+        <%= config.url_field :url, :placeholder => 'http://feeds.bbci.co.uk/news/rss.xml', :class => "input-xxlarge", :value => @content.config['url'], "data-url" => preview_contents_path %>
         <div><small>You can verify an RSS feed at <a href="http://validator.w3.org/feed/" target="_blank">http://validator.w3.org/feed/</a></small></div>
       </div>
     </div>
     <div class="clearfix">
       <%= config.label :output_format, 'Display Format' %>
       <div class="input">
-        <%= config.select :output_format, [["Headlines", "headlines"], ["Articles", "detailed"]], :selected => @content.config['output_format'] %>
+        <%= config.select :output_format, [["Headlines", "headlines"], ["Articles", "detailed"], ["XSLT", "xslt"]], :selected => @content.config['output_format'] %>
       </div>
     </div>
     <div class="clearfix">
@@ -21,5 +21,17 @@
         <%= config.select :reverse_order, [["No", 0], ["Yes", 1]] %>
       </div>
     </div>
+    <div class="clearfix" id="simple_rss_maxitems">
+      <%= config.label :max_items, 'Maximum items from feed' %>
+      <div class="input">
+        <%= config.number_field :max_items, :min => 0, :step => 1, :value => @content.config['max_items'] %>
+      </div>
+    </div>
+    <div class="clearfix" id="simple_rss_xslmarkup">
+      <%= label_tooltip "simple_rss", :config_xsl, "XSL Markup", :tip => "The XSL Markup field is only used when the Display Format is set to XSLT." %>
+      <div class="input">
+        <%= config.text_area :xsl, :class => "span12", :rows =>4, :value => @content.config['xsl'] %>
+      </div>
+    </div>
   <% end %>
 </fieldset>

data/lib/concerto_simple_rss/version.rb

@@ -1,3 +1,3 @@
 module ConcertoSimpleRss
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concerto_simple_rss
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Brian Michalski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.11
+- !ruby/object:Gem::Dependency
+  name: ruby-xslt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement