feedutils 0.4.0 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc27ca90a5876fa6ae3ca6abaad1dba94d95a19b
+  data.tar.gz: 704c4187ca9e9b903fe99ecee3f45c7e5d0150cc
+SHA512:
+  metadata.gz: 19f0245d4dd3e01403ef6d822ddca5022178b6718201af402fcdd9f7963252acea856cdc45b3e28103f1e5efc92f9be5c2ee4abd78d2896d85af2f7929c96584
+  data.tar.gz: 8b684e82f2ba8473dc80ec5f4a02a0c10df15e0342aa4b182aaba6a55746dc8fd343d620e864a718056e1c6df4253c1e7d10e8e3d169d3551711e9c7a31c706f

data/Manifest.txt

@@ -1,4 +1,4 @@
-History.md
+HISTORY.md
 Manifest.txt
 README.md
 Rakefile
@@ -9,6 +9,9 @@ lib/feedutils/feed.rb
 lib/feedutils/item.rb
 lib/feedutils/parser.rb
 lib/feedutils/version.rb
+test/feeds/googlegroups.atom
+test/feeds/googlegroups2.atom
 test/helper.rb
 test/test_atom.rb
+test/test_atom_from_file.rb
 test/test_rss.rb

data/README.md

@@ -26,3 +26,4 @@ TBD
 
 The `feedutils` scripts are dedicated to the public domain.
 Use it as you please with no restrictions whatsoever.
+

data/Rakefile

@@ -15,19 +15,18 @@ Hoe.spec 'feedutils' do
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'
-  self.history_file = 'History.md'
+  self.history_file = 'HISTORY.md'
 
   self.extra_deps = [
-    ['logutils', '>= 0.5']
+    ['logutils', '>= 0.6.1']
   ]
-  
+
   ###  todo: add fetcher dep for testing (e.g. development only)
 
   self.licenses = ['Public Domain']
 
   self.spec_extras = {
-   :required_ruby_version => '>= 1.9.2'
+   required_ruby_version: '>= 1.9.2'
   }
 
-
-end
+end

data/lib/feedutils.rb

@@ -20,20 +20,6 @@ require 'feedutils/item'
 require 'feedutils/parser'
 
 
-module FeedUtils
-
-  def self.banner
-    "feedutils/#{VERSION} (with stdlib rss/#{RSS::VERSION}) on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
-  end
-
-=begin
-  def self.root
-    "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
-  end
-=end
-
-end  # module FeedUtils
-
-
-puts FeedUtils.banner    # say hello
 
+# say hello
+puts FeedUtils.banner     if $DEBUG || (defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG)

data/lib/feedutils/builder/atom.rb

@@ -27,6 +27,34 @@ class AtomFeedBuilder
     feed.title  = atom_feed.title.content
     logger.debug "  atom | title.content  >#{atom_feed.title.content}< : #{atom_feed.title.content.class.name}"
 
+
+    ## note: for now assume id is feed (html)url
+    ## use url only if starts_with http
+    ##  might not be link e.g blogger uses for ids =>
+    ##    <id>tag:blogger.com,1999:blog-4704664917418794835</id>
+    ##
+    ## Note: remove (strip) leading and trailing spaces and newlines
+
+    if atom_feed.id.content.strip.start_with?( 'http' )
+      feed.url = atom_feed.id.content.strip
+    else
+      feed.url = nil
+    end
+
+    logger.debug "  atom | id.content  >#{atom_feed.id.content}< : #{atom_feed.id.content.class.name}"
+
+    ## note: use links (plural to allow multiple links e.g. self,alternate,etc.)
+    atom_feed.links.each_with_index do |link,i|
+      logger.debug "  atom | link[#{i+1}] link rel=>#{link.rel}< : #{link.rel.class.name} type=#{link.type} href=#{link.href}"
+
+      ## for now assume alternate is link or no rel specified (assumes alterante)
+      ##   note: only set if feed.url is NOT already set (via <id> for example)
+      if feed.url.nil? && (link.rel == 'alternate' || link.rel.nil?)
+        feed.url = link.href
+      end
+    end
+
+
     if atom_feed.updated
       # NOTE: empty updated.content e.g.  used by google groups feed
       #   will return nil : NilClass
@@ -38,7 +66,8 @@ class AtomFeedBuilder
     end
 
     if atom_feed.generator
-      feed.generator =  atom_feed.generator.content
+      ## Note: remove (strip) leading and trailing spaces and newlines
+      feed.generator =  atom_feed.generator.content.strip
       logger.debug "  atom | generator.content  >#{atom_feed.generator.content}< : #{atom_feed.generator.content.class.name}"
 
       # pp atom_feed.generator

data/lib/feedutils/version.rb

@@ -1,4 +1,24 @@
+# encoding: utf-8
 
 module FeedUtils
-  VERSION = '0.4.0'
-end
+
+  MAJOR = 0
+  MINOR = 5
+  PATCH = 0
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+
+  def self.banner
+    "feedutils/#{VERSION} (with stdlib rss/#{RSS::VERSION}) on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+  end  
+
+end # module FeedUtils
+

data/test/feeds/googlegroups.atom

@@ -0,0 +1,18 @@
+<feed xmlns="http://www.w3.org/2005/Atom">
+  <id>https://groups.google.com/d/forum/beerdb</id>
+  <title type="text">Open Beer &amp; Brewery Database (beer.db)</title>
+  <subtitle>Free open public domain beer database &amp;amp; schema (beer.db) for use in any (programming) language (e.g. uses plain text fixtures/data sets). Questions? Comments?</subtitle>
+  <link rel="self" href="https://groups.google.com/forum/feed/beerdb/topics/atom_v1_0.xml" title="beerdb feed"></link>
+  <updated></updated>
+  <generator>Google Groups</generator>
+  <entry>
+    <author>
+      <name>Joe Sixpack</name>
+    </author>
+    <updated>2014-12-17T11:54:43Z</updated>
+    <id>https://groups.google.com/d/topic/beerdb/KpQOUDYJ3J8</id>
+    <link href="https://groups.google.com/d/topic/beerdb/KpQOUDYJ3J8"></link>
+    <title type="text">Planet Beer (Austria, Belgium) - Feeds Incl. Craft Fest Wien, Beer-A-Day, proBier n Friends</title>
+    <summary type="html">Hello, I&apos;ve started putting together a planet site for beer, that is, Planet Beer [1]. The first feed lists include: - Austria [2] - Belgium [3] You&apos;re welcome and invited to suggest new countries and feeds. Cheers. Prost. [1] http://planetbeer.herokuapp.com [2] http://github.com/openbeer/planet/blob/master/</summary>
+  </entry>
+</feed>

data/test/feeds/googlegroups2.atom

@@ -0,0 +1,20 @@
+<feed xmlns="http://www.w3.org/2005/Atom">
+  <id>https://groups.google.com/d/forum/beerdb</id>
+  <title type="text">Open Beer &amp; Brewery Database (beer.db)</title>
+  <subtitle>Free open public domain beer database &amp;amp; schema (beer.db) for use in any (programming) language (e.g. uses plain text fixtures/data sets). Questions? Comments?</subtitle>
+  <link rel="self" href="https://groups.google.com/forum/feed/beerdb/topics/atom_v1_0.xml" title="beerdb feed"></link>
+  <updated></updated>
+  <generator>
+     Google Groups (w/ leading n trailing newlines stripped)
+  </generator>
+  <entry>
+    <author>
+      <name>Joe Sixpack</name>
+    </author>
+    <updated>2014-12-17T11:54:43Z</updated>
+    <id>https://groups.google.com/d/topic/beerdb/KpQOUDYJ3J8</id>
+    <link href="https://groups.google.com/d/topic/beerdb/KpQOUDYJ3J8"></link>
+    <title type="text">Planet Beer (Austria, Belgium) - Feeds Incl. Craft Fest Wien, Beer-A-Day, proBier n Friends</title>
+    <summary type="html">Hello, I&apos;ve started putting together a planet site for beer, that is, Planet Beer [1]. The first feed lists include: - Austria [2] - Belgium [3] You&apos;re welcome and invited to suggest new countries and feeds. Cheers. Prost. [1] http://planetbeer.herokuapp.com [2] http://github.com/openbeer/planet/blob/master/</summary>
+  </entry>
+</feed>

data/test/helper.rb

@@ -3,11 +3,8 @@
 
 ## minitest setup
 
-# require 'minitest/unit'
 require 'minitest/autorun'
 
-# include MiniTest::Unit  # lets us use TestCase instead of MiniTest::Unit::TestCase
-
 require 'logutils'
 require 'fetcher'
 
@@ -18,8 +15,16 @@ require 'feedutils'
 
 LogUtils::Logger.root.level = :debug
 
-def parse_feed( feed_url )
-  xml = Fetcher.read( feed_url )
+def parse_feed( url )
+  xml = Fetcher.read( url )
 
   FeedUtils::Parser.parse( xml )
 end
+
+
+def parse_feed_from_file( name )
+  xml = File.read( "#{FeedUtils.root}/test/feeds/#{name}")
+
+  FeedUtils::Parser.parse( xml )  
+end
+

data/test/test_atom.rb

@@ -1,29 +1,34 @@
 ###
 #  to run use
-#     ruby -I ./lib -I ./test test/test_rss.rb
+#     ruby -I ./lib -I ./test test/test_atom.rb
 #  or better
 #     rake test
 
 require 'helper'
 
-class TestAtom < MiniTest::Unit::TestCase
+class TestAtom < MiniTest::Test
 
   def test_rubyonrails
     feed = parse_feed( 'http://weblog.rubyonrails.org/feed/atom.xml' )
     
-    assert_equal 'atom', feed.format
+    assert_equal 'atom',                           feed.format
+    assert_equal 'http://weblog.rubyonrails.org/', feed.url
   end
 
+
   def test_railstutorial
     feed = parse_feed( 'http://feeds.feedburner.com/railstutorial?format=xml' )
     
-    assert_equal 'atom', feed.format
+    assert_equal 'atom',                           feed.format
+    assert_equal 'http://news.railstutorial.org/', feed.url
   end
 
+
   def test_googlegroup
     feed = parse_feed( 'https://groups.google.com/forum/feed/beerdb/topics/atom.xml?num=15' )
 
     assert_equal 'atom', feed.format
+    assert_equal 'https://groups.google.com/d/forum/beerdb', feed.url
   end
 
 
@@ -34,6 +39,7 @@ class TestAtom < MiniTest::Unit::TestCase
     assert_equal 'Blogger', feed.generator
     assert_equal 'Headius', feed.title
     assert_equal 'Helping the JVM Into the 21st Century', feed.title2  # aka subtitle in atom
+    assert_equal 'http://blog.headius.com/', feed.url
   end
 
 end

data/test/test_atom_from_file.rb

@@ -0,0 +1,28 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_atom_from_file.rb
+#  or better
+#     rake test
+
+require 'helper'
+
+
+class TestAtomFromFile < MiniTest::Test
+
+  def test_googlegroup
+    feed = parse_feed_from_file( 'googlegroups.atom' )
+
+    assert_equal 'atom', feed.format
+    assert_equal 'Google Groups', feed.generator
+    assert_equal 'https://groups.google.com/d/forum/beerdb', feed.url
+  end
+
+  def test_googlegroup2
+    feed = parse_feed_from_file( 'googlegroups2.atom' )
+
+    assert_equal 'atom', feed.format
+    assert_equal 'Google Groups (w/ leading n trailing newlines stripped)', feed.generator
+    assert_equal 'https://groups.google.com/d/forum/beerdb', feed.url
+  end
+
+end # class TestAtomFromFile

data/test/test_rss.rb

@@ -6,7 +6,7 @@
 
 require 'helper'
 
-class TestRss < MiniTest::Unit::TestCase
+class TestRss < MiniTest::Test
 
 
   def test_rubyflow

metadata

@@ -1,57 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: feedutils
 version: !ruby/object:Gem::Version
-  version: 0.4.0
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-09 00:00:00.000000000 Z
+date: 2014-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
-  requirement: &74494180 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *74494180
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &74493890 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '4.0'
   type: :development
   prerelease: false
-  version_requirements: *74493890
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &74493660 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.13'
   type: :development
   prerelease: false
-  version_requirements: *74493660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
 description: feedutils - web feed parser and normalizer (RSS 2.0, Atom, etc.)
 email: feedreader@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- HISTORY.md
 - Manifest.txt
+- README.md
 files:
-- History.md
+- ".gemtest"
+- HISTORY.md
 - Manifest.txt
 - README.md
 - Rakefile
@@ -62,37 +73,39 @@ files:
 - lib/feedutils/item.rb
 - lib/feedutils/parser.rb
 - lib/feedutils/version.rb
+- test/feeds/googlegroups.atom
+- test/feeds/googlegroups2.atom
 - test/helper.rb
 - test/test_atom.rb
+- test/test_atom_from_file.rb
 - test/test_rss.rb
-- .gemtest
 homepage: https://github.com/rubylibs/feedutils
 licenses:
 - Public Domain
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --main
+- "--main"
 - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: feedutils
-rubygems_version: 1.8.17
+rubyforge_project: 
+rubygems_version: 2.4.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: feedutils - web feed parser and normalizer (RSS 2.0, Atom, etc.)
 test_files:
 - test/test_atom.rb
+- test/test_atom_from_file.rb
 - test/test_rss.rb