feedparser 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41e434db09f31136e1a0e9aad46893b738ab50e2
-  data.tar.gz: 8f7030711c61cdde977a13f68d5cc5e321ec81b4
+  metadata.gz: a1bacd6aeb6281e16cbcd51fd6732f999d9788cd
+  data.tar.gz: c48df4d0c5cf710d63ec4ebabfc2e28a11b06d27
 SHA512:
-  metadata.gz: 674d3d2c3f606036f394cfd9c4ce17787941fc743b75c485373987ceb27326b526f9057253306e2c9dfd19591773cae9ef1c1b953a68530e43db4bec0ee5b16f
-  data.tar.gz: f94e683d0dbc429cafed117213dae71797e7a2d6030c3425761fc959e1d42e36410c8d33b8e91d9d611cab64a1ac26687fce43ebcf0f15f101e94f06bff397e0
+  metadata.gz: 37d3ede519e5f9e3ef3d6a5c768181408ce049e19629af277440888fd96a35890a87c7ddffe11376de4b0acb4818820f7486f8ed7411ce91a24a11229af1acb9
+  data.tar.gz: 6f448cc771f30d523b23337225b8bf26b0cf613be26236e7c68093e0ca8e5538f8e053ba0c84b8c58a2fbe95d3c9287fe3e90341f8ec4c4bedd8de203cb56a6a

data/Manifest.txt

@@ -3,6 +3,7 @@ Manifest.txt
 README.md
 Rakefile
 lib/feedparser.rb
+lib/feedparser/attachment.rb
 lib/feedparser/author.rb
 lib/feedparser/builder/atom.rb
 lib/feedparser/builder/json.rb
@@ -16,6 +17,7 @@ lib/feedparser/tag.rb
 lib/feedparser/version.rb
 test/helper.rb
 test/test_atom_live.rb
+test/test_attachments_live.rb
 test/test_dates.rb
 test/test_microformats.rb
 test/test_rss_live.rb

data/README.md

@@ -11,6 +11,8 @@ feedparser gem - web feed parser and normalizer (Atom, RSS, JSON Feed, HTML h-en
 
 ## What's News?
 
+**October/2017**: Added support for attachments / media enclosures in RSS and Atom.
+
 **June/2017**:  Added support for reading feeds in HTML with Microformats incl.
 [`h-entry`](http://microformats.org/wiki/h-entry),
 [`h-feed`](http://microformats.org/wiki/h-feed) and others.
@@ -32,7 +34,7 @@ See the [Awesome Feeds](https://github.com/feedparser/awesome-feeds) page ».
 
 ### Structs
 
-Feed • Item • Author • Tag • Generator
+Feed • Item • Author • Tag • Attachment • Generator
 
 
 ![](feed-models.png)
@@ -158,12 +160,20 @@ end
 
 (Source: [`lib/feedparser/tag.rb`](https://github.com/feedparser/feedparser/blob/master/lib/feedparser/tag.rb))
 
+### `Attachment`  Struct
+
+_Also known as Media Enclosure_
+
+(Source: [`lib/feedparser/attachment.rb`](https://github.com/feedparser/feedparser/blob/master/lib/feedparser/attachment.rb))
+
+
 ### `Generator` Struct
 
 (Source: [`lib/feedparser/generator.rb`](https://github.com/feedparser/feedparser/blob/master/lib/feedparser/generator.rb))
 
 
 
+
 ### Read Feed Example
 
 ``` ruby

data/lib/feedparser.rb

@@ -30,6 +30,7 @@ require 'feedparser/feed'
 require 'feedparser/item'
 require 'feedparser/author'
 require 'feedparser/tag'
+require 'feedparser/attachment'
 require 'feedparser/generator'
 require 'feedparser/parser'
 

data/lib/feedparser/attachment.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module FeedParser
+
+class Attachment   ## also known as Enclosure
+
+  attr_accessor :url
+  ## note: uri is an alias for url
+  alias :uri  :url       ## add atom alias for uri - why? why not?
+  alias :uri= :url=
+
+  attr_accessor :length
+  attr_accessor :type
+
+end  # class Attachment
+
+end # module FeedParser

data/lib/feedparser/builder/atom.rb

@@ -176,7 +176,7 @@ class AtomFeedBuilder
       item.updated        = item.updated_local.utc
     end
 
-    if atom_item.published && atom_item.published.content 
+    if atom_item.published && atom_item.published.content
       item.published_local  = handle_date( atom_item.published, 'item.published' )
       item.published        = item.published_local.utc
     end
@@ -203,6 +203,20 @@ class AtomFeedBuilder
       item.tags << build_tag( atom_cat )
     end
 
+
+    ## check for attachments / media enclosures
+    ###  todo/fix: allow more than one attachment/enclosure
+    if atom_item.links
+      enclosure = atom_item.links.detect{ |x| x.rel == 'enclosure' }
+      if enclosure
+        attachment = Attachment.new
+        attachment.url    = enclosure.href
+        attachment.length = enclosure.length
+        attachment.type   = enclosure.type
+        item.attachments << attachment
+      end
+    end
+
     item
   end # method build_item
 

data/lib/feedparser/builder/rss.rb

@@ -182,6 +182,17 @@ class RssFeedBuilder
     end
 
 
+    ## check for enclosure
+    ##   todo/check: rss can only include at most one enclosure?
+
+    if rss_item.enclosure
+      attachment = Attachment.new
+      attachment.url    = rss_item.enclosure.url
+      attachment.length = rss_item.enclosure.length
+      attachment.type   = rss_item.enclosure.type
+      item.attachments << attachment
+    end
+
     item
   end # method build_feed_item_from_rss
 

data/lib/feedparser/item.rb

@@ -81,10 +81,26 @@ class Item
 
   alias :categories :tags    # for now allow categories alias for tags - remove (why? why not?)
 
+
+  # add attachments/media enclosures (url, length and type)
+  #  note: lets support more than one (it's an array)
+  attr_accessor :attachments
+
+  def attachment()    @attachments[0]; end
+  def attachments?()  @attachments && @attachments.size > 0;  end
+  alias :attachment? :attachments?
+
+  alias :enclosures  :attachments
+  alias :enclosure   :attachment
+  alias :enclosures? :attachments?
+  alias :enclosure?  :attachments?
+
+
   def initialize
     ## note: make authors, tags empty arrays on startup (e.g. not nil)
-    @authors = []
-    @tags    = []
+    @authors     = []
+    @tags        = []
+    @attachments = []
   end
 
 end  # class Item

data/lib/feedparser/version.rb

@@ -3,8 +3,8 @@
 module FeedParser
 
   MAJOR = 2
-  MINOR = 0
-  PATCH = 1
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/test/test_atom_live.rb

@@ -25,12 +25,16 @@ class TestAtomLive < MiniTest::Test
   end
 
 
+=begin
+  ### returns ssl error e.g.
+  ## OpenSSL::SSL::SSLError: SSL_connect SYSCALL returned=5 errno=0 state=SSLv2/v3 read server
   def test_googlegroup
     feed = fetch_and_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
+=end
 
 
   def test_headius

data/test/test_attachments_live.rb

@@ -0,0 +1,32 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_attachments_live.rb
+#  or better
+#     rake test
+
+require 'helper'
+
+class TestAttachmentsLive < MiniTest::Test
+
+  def test_atom
+    feed = fetch_and_parse_feed( 'http://www.lse.ac.uk/assets/richmedia/webFeeds/publicLecturesAndEvents_AtomAllMediaTypesLatest100.xml' )
+
+    assert_equal 'audio/mpeg', feed.items.first.attachment.type
+    assert_equal 'audio/mpeg', feed.items.first.enclosure.type
+
+    assert_equal true, feed.items.first.attachment?
+    assert_equal true, feed.items.first.enclosure?
+  end
+
+
+  def test_rss
+    feed = fetch_and_parse_feed( 'http://www.radiofreesatan.com/category/featured/feed/' )
+
+    assert_equal 'audio/mpeg', feed.items.first.attachment.type
+    assert_equal 'audio/mpeg', feed.items.first.enclosure.type
+
+    assert_equal true, feed.items.first.attachment?
+    assert_equal true, feed.items.first.enclosure?
+  end
+
+end

data/test/test_rss_live.rb

@@ -31,7 +31,7 @@ class TestRssLive < MiniTest::Test
   def test_rubymine
     # includes item/content:encoded
     feed = fetch_and_parse_feed( 'http://feeds.feedburner.com/jetbrains_rubymine?format=xml' )
-    
+
     assert_equal 'rss 2.0', feed.format
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feedparser
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-15 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -81,6 +81,7 @@ files:
 - README.md
 - Rakefile
 - lib/feedparser.rb
+- lib/feedparser/attachment.rb
 - lib/feedparser/author.rb
 - lib/feedparser/builder/atom.rb
 - lib/feedparser/builder/json.rb
@@ -94,6 +95,7 @@ files:
 - lib/feedparser/version.rb
 - test/helper.rb
 - test/test_atom_live.rb
+- test/test_attachments_live.rb
 - test/test_dates.rb
 - test/test_microformats.rb
 - test/test_rss_live.rb
@@ -119,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: feedparser - web feed parser and normalizer (RSS, Atom, JSON Feed, HTML h-entry,