feedutils 0.0.1 → 0.1.0

data/Manifest.txt

@@ -3,4 +3,7 @@ Manifest.txt
 README.md
 Rakefile
 lib/feedutils.rb
+lib/feedutils/builder/atom.rb
+lib/feedutils/builder/rss.rb
+lib/feedutils/utils.rb
 lib/feedutils/version.rb

data/lib/feedutils/builder/atom.rb

@@ -0,0 +1,81 @@
+
+module FeedUtils
+
+class AtomFeedBuilder
+
+  def initialize( atom_feed )
+    @feed = build_feed( atom_feed )
+  end
+
+  def to_feed
+    @feed
+  end
+
+  def self.build( atom_feed )
+    feed = self.new( atom_feed )
+    feed.to_feed
+  end
+
+
+  def build_feed( atom_feed )
+    feed = Feed.new
+    feed.object = atom_feed
+    feed.title  = atom_feed.title.content
+    feed.format = 'atom'
+
+    items = []
+    atom_feed.items.each do |atom_item|
+      items << build_feed_item( atom_item )
+    end
+    feed.items = items
+
+    feed # return new feed
+  end # method build_feed_from_atom
+
+  def build_feed_item( atom_item )
+    item = Item.new   # Item.new
+    item.object = atom_item
+
+    item.title     = atom_item.title.content
+    item.url       = atom_item.link.href
+
+    ## todo: check if updated or published present
+    #    set 
+    item.updated    =  atom_item.updated.content.utc.strftime( "%Y-%m-%d %H:%M" )
+    item.published  =  item.updated  # fix: check if publshed set
+
+    item.guid       =  atom_item.id.content
+
+
+    # todo: move logic to updater or something
+    #  - not part of normalize
+
+    if atom_item.summary
+      item.content = atom_item.summary.content
+    else
+      if atom_item.content
+        text  = atom_item.content.content.dup
+        ## strip all html tags
+        text = text.gsub( /<[^>]+>/, '' )
+        text = text[ 0..400 ] # get first 400 chars
+        ## todo: check for length if > 400 add ... at the end???
+        item.content = text
+      end
+    end
+
+    puts "- #{atom_item.title.content}"
+    puts "  link >#{atom_item.link.href}<"
+    puts "  id (~guid) >#{atom_item.id.content}<"
+
+    ### todo: use/try published first? why? why not?
+    puts "  updated (~pubDate) >#{atom_item.updated.content}< >#{atom_item.updated.content.utc.strftime( "%Y-%m-%d %H:%M" )}< : #{atom_item.updated.content.class.name}"
+    puts
+
+    # puts "*** dump item:"
+    # pp item
+
+    item
+  end # method build_feed_item
+
+end # AtomFeedBuilder
+end # FeedUtils

data/lib/feedutils/builder/rss.rb

@@ -0,0 +1,71 @@
+
+module FeedUtils
+
+class RssFeedBuilder
+
+  def initialize( rss_feed )
+    @feed = build_feed( rss_feed )
+  end
+
+  def to_feed
+    @feed
+  end
+
+  def self.build( rss_feed )
+    feed = self.new( rss_feed )
+    feed.to_feed
+  end
+
+
+  def build_feed( rss_feed )
+    feed = Feed.new
+    feed.object = rss_feed
+    feed.title  = rss_feed.channel.title
+    feed.format = "rss #{rss_feed.rss_version}"
+
+    items = []
+    rss_feed.items.each do |rss_item|
+      items << build_feed_item( rss_item )
+    end
+    feed.items = items
+
+    feed # return new feed
+  end
+
+  def build_feed_item( rss_item )
+
+    item = Item.new
+    item.object = rss_item
+
+    item.title     = rss_item.title
+    item.url       = rss_item.link
+      
+    ## todo: check if updated or published present
+    #    set 
+    item.published = rss_item.pubDate.utc.strftime( "%Y-%m-%d %H:%M" )
+    item.updated   = item.published
+      
+    # content:  item.content_encoded,
+  
+    # if item.content_encoded.nil?
+    # puts " using description for content"
+       
+    item.content  = rss_item.description
+    # end
+        
+    item.guid     = rss_item.guid.content
+        
+    puts "- #{rss_item.title}"
+    puts "  link (#{rss_item.link})"
+    puts "  guid (#{rss_item.guid.content})"
+    puts "  pubDate >#{rss_item.pubDate}< >#{rss_item.pubDate.utc.strftime( "%Y-%m-%d %H:%M" )}< : #{rss_item.pubDate.class.name}"
+    puts
+
+    # puts "*** dump item:"
+    # pp item
+
+    item
+  end # method build_feed_item_from_rss
+
+end # class RssFeedBuilder
+end # module FeedUtils

data/lib/feedutils/utils.rb

@@ -0,0 +1,67 @@
+
+module FeedUtils
+
+
+  class Feed
+    attr_accessor :object
+
+    attr_accessor :format   # e.g. atom|rss 2.0|etc.
+    attr_accessor :title
+    attr_accessor :title_type  # e.g. text|html  (optional) -use - why?? why not??
+
+    attr_accessor :items
+
+  end  # class Feed
+
+
+  class Item
+    attr_accessor :object   # orginal object (e.g RSS item or ATOM entry etc.)
+
+    attr_accessor :title
+    attr_accessor :title_type    # optional for now (text|html) - not yet set
+    attr_accessor :url      # todo: rename to link (use alias) ??
+    attr_accessor :content
+    attr_accessor :content_type  # optional for now (text|html) - not yet set
+
+## todo: add summary (alias description)  ???
+## todo: add author/authors
+## todo: add category/categories
+
+    attr_accessor :updated
+    attr_accessor :published
+
+    attr_accessor :guid     # todo: rename to id (use alias) ??
+  end  # class Item
+
+
+  class Parser
+
+    ### Note: lets keep/use same API as RSS::Parser for now
+    def initialize( xml )
+      @xml = xml
+    end
+    
+    def parse
+      parser = RSS::Parser.new( @xml )
+      parser.do_validate            = false
+      parser.ignore_unknown_element = true
+
+      puts "Parsing feed..."
+      feed_wild = parser.parse  # not yet normalized
+
+      puts "  feed.class=#{feed_wild.class.name}"
+
+      if feed_wild.is_a?( RSS::Atom::Feed )
+        feed = AtomFeedBuilder.build( feed_wild )
+      else  # -- assume RSS::Rss::Feed
+        feed = RssFeedBuilder.build( feed_wild )
+      end
+
+      puts "== #{feed.format} / #{feed.title} =="
+      feed # return new (normalized) feed
+    end
+ 
+  end  # class Parser
+
+
+end # module FeedUtils

data/lib/feedutils/version.rb

@@ -1,4 +1,4 @@
 
 module FeedUtils
-   VERSION = '0.0.1'
+   VERSION = '0.1.0'
 end

data/lib/feedutils.rb

@@ -1,7 +1,21 @@
+# core and stdlibs
 
+require 'rss'
+require 'pp'
+
+# 3rd party gems/libs
+
+require 'logutils'
+
+# our own code
 
 require 'feedutils/version'  # let it always go first
 
+require 'feedutils/builder/atom'
+require 'feedutils/builder/rss'
+
+require 'feedutils/utils'
+
 
 module FeedUtils
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feedutils
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
-  requirement: &74685600 !ruby/object:Gem::Requirement
+  requirement: &73814860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *74685600
+  version_requirements: *73814860
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &74684390 !ruby/object:Gem::Requirement
+  requirement: &73813400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *74684390
+  version_requirements: *73813400
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &74683880 !ruby/object:Gem::Requirement
+  requirement: &73812180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *74683880
+  version_requirements: *73812180
 description: feedutils - web feed parser and normalizer (RSS 2.0, Atom, etc.)
 email: webslideshow@googlegroups.com
 executables: []
@@ -56,6 +56,9 @@ files:
 - README.md
 - Rakefile
 - lib/feedutils.rb
+- lib/feedutils/builder/atom.rb
+- lib/feedutils/builder/rss.rb
+- lib/feedutils/utils.rb
 - lib/feedutils/version.rb
 homepage: https://github.com/rubylibs/feedutils
 licenses: