feedutils 0.3.1 → 0.3.2

data/Manifest.txt

@@ -5,7 +5,9 @@ Rakefile
 lib/feedutils.rb
 lib/feedutils/builder/atom.rb
 lib/feedutils/builder/rss.rb
-lib/feedutils/utils.rb
+lib/feedutils/feed.rb
+lib/feedutils/item.rb
+lib/feedutils/parser.rb
 lib/feedutils/version.rb
 test/helper.rb
 test/test_atom.rb

data/lib/feedutils.rb

@@ -15,7 +15,9 @@ require 'feedutils/version'  # let it always go first
 require 'feedutils/builder/atom'
 require 'feedutils/builder/rss'
 
-require 'feedutils/utils'
+require 'feedutils/feed'
+require 'feedutils/item'
+require 'feedutils/parser'
 
 
 module FeedUtils

data/lib/feedutils/feed.rb

@@ -0,0 +1,52 @@
+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|html-escaped  (optional) -use - why?? why not??
+  attr_accessor :url
+
+  attr_accessor :items
+
+  def summary?()  @summary.nil? == false;  end
+  # no summary? try/return title2
+  def summary()  summary?  ?  @summary : @title2;  end
+  attr_writer :summary        # e.g. description (rss)
+
+  attr_accessor :summary_type   # e.g. text|html|html-escaped
+
+  def title2?()  @title2.nil? == false;  end
+  attr_accessor :title2         # e.g. subtitle (atom)
+
+  attr_accessor :title2_type    # e.g. text|html|html-escaped
+
+  def published?()  @published.nil? == false;  end
+  # no published date? try/return updated or built
+  def published
+    if published?
+      @published
+    elsif updated?
+      @updated
+    else
+      @built
+    end
+  end
+  attr_writer :published
+
+  def updated?()  @updated.nil? == false;  end
+  attr_accessor :updated
+
+  def built?()  @built.nil? == false;  end
+  attr_accessor :built
+
+  attr_accessor :generator
+
+
+  ## fix:
+  #  add pretty printer/inspect (exclude object)
+
+end  # class Feed
+
+end # module FeedUtils

data/lib/feedutils/item.rb

@@ -0,0 +1,42 @@
+module FeedUtils
+
+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|html-escaped) - not yet set
+  attr_accessor :url      # todo: rename to link (use alias) ??
+
+
+  # no content? try/return summary
+  def content()  content? ? @content : @summary;  end
+  def content?()  @content.nil? == false;  end
+  attr_writer   :content
+
+  attr_accessor :content_type  # optional for now (text|html|html-escaped|binary-base64) - not yet set
+
+  # no summary? try/return content
+  def summary()  summary? ? @summary : @content;  end
+  def summary?()  @summary.nil? == false;  end
+  attr_writer   :summary
+
+  attr_accessor :summary_type  # optional for now (text|html|html-escaped) - not yet set
+
+## todo: add summary (alias description)  ???
+## todo: add author/authors
+## todo: add category/categories
+
+  # no published date? try/return updated
+  def published()  published? ? @published : @updated;  end
+  def published?()  @published.nil? == false;  end
+  attr_writer :published
+
+  def updated?()  @updated.nil? == false;  end
+  attr_accessor :updated
+
+  attr_accessor :guid     # todo: rename to id (use alias) ??
+
+
+end  # class Item
+
+end # module FeedUtils

data/lib/feedutils/parser.rb

@@ -0,0 +1,42 @@
+
+module FeedUtils
+
+
+class Parser
+
+  include LogUtils::Logging
+
+  ### convenience class/factory method
+  def self.parse( xml, opts={} )
+    self.new( xml ).parse
+  end
+
+  ### 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
+
+    logger.debug "  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.3.1'
+   VERSION = '0.3.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feedutils
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2013-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
-  requirement: &74300430 !ruby/object:Gem::Requirement
+  requirement: &82615740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *74300430
+  version_requirements: *82615740
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &74300030 !ruby/object:Gem::Requirement
+  requirement: &82615490 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *74300030
+  version_requirements: *82615490
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &74299400 !ruby/object:Gem::Requirement
+  requirement: &82615190 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *74299400
+  version_requirements: *82615190
 description: feedutils - web feed parser and normalizer (RSS 2.0, Atom, etc.)
 email: webslideshow@googlegroups.com
 executables: []
@@ -58,7 +58,9 @@ files:
 - lib/feedutils.rb
 - lib/feedutils/builder/atom.rb
 - lib/feedutils/builder/rss.rb
-- lib/feedutils/utils.rb
+- lib/feedutils/feed.rb
+- lib/feedutils/item.rb
+- lib/feedutils/parser.rb
 - lib/feedutils/version.rb
 - test/helper.rb
 - test/test_atom.rb

data/lib/feedutils/utils.rb

@@ -1,170 +0,0 @@
-
-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|html-escaped  (optional) -use - why?? why not??
-    attr_accessor :url
-
-    attr_accessor :items
-
-    attr_accessor :summary        # e.g. description (rss)
-    attr_accessor :summary_type   # e.g. text|html|html-escaped
-    attr_accessor :title2         # e.g. subtitle (atom)
-    attr_accessor :title2_type    # e.g. text|html|html-escaped
-
-    attr_accessor :published
-    attr_accessor :updated
-    attr_accessor :built
-    
-    attr_accessor :generator
-
-
-    def title2?
-      @title2.nil? == false
-    end
-
-    def summary?
-      @summary.nil? == false
-    end
-
-    def built?
-      @built.nil? == false
-    end
-    
-    def updated?
-      @updated.nil? == false
-    end
-    
-    def published?
-      @published.nil? == false
-    end
-
-
-    def summary
-      # no summary? try/return title2
-      if summary?
-        @summary
-      else
-        @title2
-      end
-    end
-
-    def published
-      # no published date? try/return updated or built
-      if published?
-        @published
-      elsif updated?
-        @updated
-      else
-        @built
-      end
-    end
-
-    ## fix:
-    #  add pretty printer/inspect (exclude object)
-
-  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|html-escaped) - not yet set
-    attr_accessor :url      # todo: rename to link (use alias) ??
-    attr_accessor :content
-    attr_accessor :content_type  # optional for now (text|html|html-escaped|binary-base64) - not yet set
-    attr_accessor :summary
-    attr_accessor :summary_type  # optional for now (text|html|html-escaped) - not yet set
-
-## todo: add summary (alias description)  ???
-## todo: add author/authors
-## todo: add category/categories
-
-    attr_accessor :published
-    attr_accessor :updated
-
-    attr_accessor :guid     # todo: rename to id (use alias) ??
-
-
-    def summary?
-      @summary.nil? == false
-    end
-
-    def content?
-      @content.nil? == false
-    end
-    
-    def published?
-      @published.nil? == false
-    end
-
-    def updated?
-      @updated.nil? == false
-    end
-    
-    def content
-      # no content? try/return summary
-      if content?
-        @content
-      else
-        @summary
-      end
-    end
-
-    def published
-      # no published date? try/return updated
-      if published?
-        @published
-      else
-        @updated
-      end
-    end
-
-
-  end  # class Item
-
-
-  class Parser
-
-    include LogUtils::Logging
-
-    ### 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
-
-      logger.debug "  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
-    
-    ### convenience class/factory method
-    def self.parse( xml, opts={} )
-      self.new( xml ).parse
-    end
-
-  end  # class Parser
-
-
-end # module FeedUtils