feedzirra-podcast 0.0.11 → 0.0.12

data/README.md

@@ -18,12 +18,14 @@ If you want to avoid potential conflicts, you can directly pass feeds to the pod
 
 ## Usage
 
-The parser attempts to match the structure and naming conventions of the actual feed XML elements as closely as possible. `<link>` tags are accessed through `item.link`, etc.
+The parser attempts to match the structure and naming conventions of the actual feed XML elements as closely as possible. `<link>` tags are accessed through `item.link`, etc. Some elements, such as `pubDate`, can be accessed with methods that match the element, or aliases that better adhere to ruby naming conventions (e.g. `pub_date`).
 
 The goal is to support all elements common to podcast feeds. Currently not all elements are supported; as they are added, they will be listed below.
 
 When it makes sense for an element's value to be parsed or tranformed into a non-string object, that will be done. The string value is always preserved, though.
 
+When an element has children, such as `itunes:owner`, you can safely call the children directly (`feed.itunes_owner.email`) even when the feed doesn't include the parent element. You will get `nil` back for both calls to the parent or child
+
 ### Channel
 
 	<link>				feed.link
@@ -62,6 +64,7 @@ When it makes sense for an element's value to be parsed or tranformed into a non
 						feed.itunes_explicit_string
 	<itunes:subtitle> 	feed.itunes_subtitle
 	<itunes:summary> 	feed.itunes_summary
+	<itunes:image href>	feed.itunes_image.href
 	<itunes:keywords> 	feed.itunes_keywords (Array of Strings)
 						feed.itunes_keywords_string
 
@@ -70,8 +73,13 @@ When it makes sense for an element's value to be parsed or tranformed into a non
 	<itunes:complete> 	feed.itunes_complete (true, false)
 						feed.itunes_complete_string
 	<itunes:new-feed-url>	feed.itunes_new_feed_url
+	
+	<sy:updatePeriod>	 feed.sy_updatePeriod (:hourly, :daily, etc)
+	<sy:updateFrequency>	feed.sy_updateFrequency (Integer)
+	<sy:updateBase>		feed.sy_updateBase (Time)
 
 	<issn>				feed.issn
+	<network>			feed.network
 
 ### Items
 
@@ -92,6 +100,31 @@ When it makes sense for an element's value to be parsed or tranformed into a non
 						item.enclosure.length
 
 	<comments>			item.comments
+	
+	<dc:creator>		item.dc_creator
+	<dc:created>		item.dc_created (Time)
+	<dc:modified>		item.dc_modified (Time)
+	<dc:replaces>		item.dc_replaces
+	<dc:isReplacedBy>	item.dc_isReplacedBy
+	
+	<itunes:author>		feed.itunes_author
+	<itunes:subtitle> 	feed.itunes_subtitle
+	<itunes:summary> 	feed.itunes_summary
+	<itunes:explicit> 	feed.itunes_explicit (true, false, :clean)
+						feed.itunes_explicit_string
+	<itunes:duration>	feed.itunes_duration (Number)
+						feed.itunes_duration_string (String)
+	<itunes:keywords> 	feed.itunes_keywords (Array of Strings)
+						feed.itunes_keywords_string
+	<itunes:image href>	feed.itunes_image.href
+	<itunes:block>	 	feed.itunes_block (true, false)
+						feed.itunes_block_string
+	<itunes:isClosedCaptioned>	feed.itunes_is_closed_captioned (Boolean)
+						feed.itunes_is_closed_captioned_string
+	<itunes:order>		feed.itunes_order (Float)
+						feed.itunes_order_string (String)
+	
+	<content:encoded>	item.content_encoded	
 
 ### Helpers
 

data/etc/feeds/99percentinvisible.xml

@@ -10,6 +10,7 @@
     <language>en-US</language>
     <sy:updatePeriod>hourly</sy:updatePeriod>
     <sy:updateFrequency>1</sy:updateFrequency>
+    <sy:updateBase>2012-01-01T02:00:00+00:00</sy:updateBase>
     <!-- podcast_generator="Blubrry PowerPress/4.0.9" -->
     <itunes:summary>Design is everywhere in our lives, perhaps most importantly in the places where we've just stopped noticing. 99% Invisible (99 Percent Invisible) is a weekly exploration of the process and power of design and architecture. From award winning producer Roman Mars and KALW in San Francisco. Learn more: http://99percentinvisible.org
 
@@ -36,7 +37,11 @@ Awesome people saying nice things:
       <link>http://99percentinvisible.org</link>
     </image>
     <itunes:category text="Arts">
-      <itunes:category text="Design" />
+      <itunes:category text="Painting" />
+    </itunes:category>
+    <itunes:category text="Design" />
+    <itunes:category text="Music">
+      <itunes:category text="Technology" />
     </itunes:category>
     <atom10:link xmlns:atom10="http://www.w3.org/2005/Atom" rel="self" type="application/rss+xml" href="http://feeds.99percentinvisible.org/99percentinvisible" />
     <feedburner:info xmlns:feedburner="http://rssnamespace.org/feedburner/ext/1.0" uri="99percentinvisible" />

data/lib/feedzirra-podcast/parser/podcast.rb

@@ -9,12 +9,12 @@ module FeedzirraPodcast
       # iTunes
 
       element :"itunes:author", as: :itunes_author
-      element :"itunes:owner", as: :itunes_owner, class: ItunesOwner
+      element :"itunes:owner", as: :itunes_owner_object, class: ItunesOwner
       element :"itunes:explicit", as: :itunes_explicit_string
       element :"itunes:subtitle", as: :itunes_subtitle
       element :"itunes:summary", as: :itunes_summary
-      elements :"itunes:category", as: :itunes_categories, value: :text
-      element :"itunes:image", as: :itunes_image, value: :href
+      # elements :"itunes:category", as: :itunes_categories, value: :text
+      element :"itunes:image", as: :itunes_image_href, value: :href
       element :"itunes:keywords", as: :itunes_keywords_string
 
       element :"itunes:block", as: :itunes_block_string
@@ -23,13 +23,24 @@ module FeedzirraPodcast
 
       # Syndication RSS
 
-      # element :"sy:updatePeriod"
-      # element :"sy:updateFrequency"
-      # element :"sy:updateBase"
+      element :"sy:updatePeriod", as: :sy_update_period_string
+      element :"sy:updateFrequency", as: :sy_update_frequency_string
+      element :"sy:updateBase", as: :sy_update_base_string
 
       # Misc
 
       element :issn
+      element :network
+
+      def itunes_owner
+        _email = itunes_owner_object ? itunes_owner_object.email : nil
+        _name = itunes_owner_object ? itunes_owner_object.name : nil
+        Struct.new(:email, :name).new(_email, _name)
+      end
+
+      def itunes_image
+        Struct.new(:href).new(itunes_image_href)
+      end
 
       def itunes_explicit
         case itunes_explicit_string
@@ -63,6 +74,28 @@ module FeedzirraPodcast
           false
         end
       end
+
+      def sy_update_period
+        case sy_update_period_string
+          when "hourly" then :hourly
+          when "daily" then :daily
+          when "weekly" then :weekly
+          when "monthly" then :monthly
+          when "yearly" then :yearly
+          else nil
+        end
+      end
+      alias_method :sy_updatePeriod, :sy_update_period
+
+      def sy_update_frequency
+        sy_update_frequency_string.to_i if sy_update_frequency_string
+      end
+      alias_method :sy_updateFrequency, :sy_update_frequency
+
+      def sy_update_base
+        Time.parse(sy_update_base_string)
+      end
+      alias_method :sy_updateBase, :sy_update_base
     end
   end
 end

data/lib/feedzirra-podcast/parser/podcast_item.rb

@@ -12,7 +12,7 @@ module FeedzirraPodcast
       element :"itunes:explicit", as: :itunes_explicit_string
       element :"itunes:duration", as: :itunes_duration_string
       element :"itunes:keywords", as: :itunes_keywords_string
-      element :"itunes:image", as: :itunes_image, value: :href
+      element :"itunes:image", as: :itunes_image_href, value: :href
 
       element :"itunes:block", as: :itunes_block_string
       element :"itunes:isClosedCaptioned", as: :itunes_is_closed_captioned_string
@@ -22,6 +22,9 @@ module FeedzirraPodcast
 
       element :"dc:creator", as: :dc_creator
       element :"dc:created", as: :dc_created_string
+      element :"dc:modified", as: :dc_modified_string
+      element :"dc:replaces", as: :dc_replaces
+      element :"dc:isReplacedBy", as: :dc_is_replaced_by
 
       # Content
 
@@ -38,6 +41,10 @@ module FeedzirraPodcast
         end
       end
 
+      def itunes_image
+        Struct.new(:href).new(itunes_image_href)
+      end
+
       def itunes_duration
         Periodic.parse(itunes_duration_string) if itunes_duration_string.present?
       # rescue
@@ -65,6 +72,7 @@ module FeedzirraPodcast
           false
         end
       end
+      alias_method :itunes_isClosedCaptioned, :itunes_is_closed_captioned
 
       def itunes_order
         itunes_order_string.to_f if itunes_order_string.present?
@@ -75,6 +83,16 @@ module FeedzirraPodcast
       rescue ArgumentError
         nil
       end
+
+      def dc_modified
+        Time.parse(dc_modified_string).utc if dc_modified_string.present?
+      rescue ArgumentError
+        nil
+      end
+
+      def dc_isReplacedBy
+        dc_is_replaced_by
+      end
     end
   end
 end

data/lib/feedzirra-podcast/parser/rss2.rb

@@ -21,7 +21,7 @@ module FeedzirraPodcast
       element :pubDate, as: :pub_date_string
       element :lastBuildDate, as: :last_build_date_string
       elements :category, as: :categories
-      element :image, class: FeedzirraPodcast::Parser::RSS2ChannelImage
+      element :image, as: :image_object, class: FeedzirraPodcast::Parser::RSS2ChannelImage
       element :docs
 
       element :generator
@@ -44,21 +44,45 @@ module FeedzirraPodcast
         (/\<rss|\<rdf/ =~ xml)
       end
 
+      def image
+        _url = image_object ? image_object.url : nil
+        _title = image_object ? image_object.title : nil
+        _link = image_object ? image_object.link : nil
+        _width = image_object ? image_object.width : nil
+        _height = image_object ? image_object.height : nil
+        _description = image_object ? image_object.description : nil
+
+        Struct.new(:url, :title, :link, :width, :height, :description).new(_url, _title, _link, _width, _height, _description)
+      end
+
       def pubDate
         Time.parse(pub_date_string).utc if pub_date_string.present?
       rescue ArgumentError
         nil
       end
+      alias_method :pub_date, :pubDate
+      alias_method :pubdate, :pubDate
 
       def lastBuildDate
         Time.parse(last_build_date_string).utc if last_build_date_string.present?
       rescue ArgumentError
         nil
       end
+      alias_method :last_build_date, :lastBuildDate
 
       def feedburner?
         !!feedburner_info_xmlns || !!feedburner_info_uri
       end
+
+      def managing_editor
+        managingEditor
+      end
+      alias_method :managingeditor, :managing_editor
+
+      def web_master
+        webMaster
+      end
+      alias_method :webmaster, :web_master
     end
   end
 end

data/lib/feedzirra-podcast/parser/rss2_item.rb

@@ -29,6 +29,8 @@ module FeedzirraPodcast
       rescue ArgumentError
         nil
       end
+      alias_method :pub_date, :pubDate
+      alias_method :pubdate, :pubDate
 
       def source
         Struct.new(:title, :url).new(source_title, source_url)

data/lib/feedzirra-podcast/version.rb

@@ -1,3 +1,3 @@
 module FeedzirraPodcast
-  VERSION = '0.0.11'
+  VERSION = '0.0.12'
 end

data/test/podcast_channel_test.rb

@@ -11,4 +11,37 @@ class PodcastChannelTest < MiniTest::Unit::TestCase
   def test_itunes_author
     assert_equal 'Roman Mars', @feed.itunes_author
   end
+
+  def test_itunes_owner
+    assert_equal 'roman_mars@yahoo.com', @feed.itunes_owner.email
+  end
+
+  def test_excluded_tag
+    assert_equal nil, @feed.itunes_new_feed_url
+  end
+
+  def test_sy_update_frequency
+    assert_equal "1", @feed.sy_update_frequency_string
+    assert_equal 1, @feed.sy_update_frequency
+  end
+
+  def test_sy_update_period
+    assert_equal "hourly", @feed.sy_update_period_string
+    assert_equal :hourly, @feed.sy_update_period
+  end
+
+  def test_sy_update_base
+    assert_equal "2012-01-01T02:00:00+00:00", @feed.sy_update_base_string
+    assert_equal Time.parse('2012-01-01T02:00:00+00:00'), @feed.sy_update_base
+    assert_equal Time.parse('2012-01-01T02:00:00+00:00'), @feed.sy_updateBase
+  end
+
+  def test_itunes_image
+    url = 'http://cdn.99percentinvisible.org/wp-content/uploads/powerpress/99invisible-logo-1400.jpg'
+    assert_equal url, @feed.itunes_image.href
+  end
+
+  def test_itunes_categories
+    # assert_equal 1, @feed.itunes_categories
+  end
 end

data/test/podcast_item_test.rb

@@ -22,4 +22,8 @@ class PodcastItemTest < MiniTest::Unit::TestCase
     assert_equal 'no', @item.itunes_explicit_string
     assert_equal false, @item.itunes_explicit
   end
+
+  def test_closed_captioned
+    assert_equal false, @item.itunes_is_closed_captioned
+  end
 end

data/test/rss_channel_test.rb

@@ -15,4 +15,9 @@ class RSSChannelTest < MiniTest::Unit::TestCase
   def test_feedburner
     assert_equal true, @feed.feedburner?
   end
+
+  def test_image
+    assert_equal '99% Invisible', @feed.image.title
+    assert_equal nil, @feed.image.width
+  end
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: feedzirra-podcast
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
+  prerelease: 
 platform: ruby
 authors:
 - Chris Kalafarski
@@ -13,57 +14,65 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: feedzirra
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: periodic
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.2
 description: Strict RSS 2 podcast parsing with Feedzirra
@@ -73,7 +82,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -95,26 +104,27 @@ files:
 homepage: https://github.com/PRX/feedzirra-podcast
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Feedzirra parser classes strictly for handling podcasts strictly
 test_files:
 - test/podcast_channel_test.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: c0a142950ca5ee21a1953aba7134cfa474138ef4
-  data.tar.gz: 607e579dd5e7474a44347c427dffb0594662939c
-SHA512:
-  metadata.gz: d4b2bc5e4e2328edebe7ce1bd13bdf983feb61e411c153c05cdbebe72ab29efedd98987060f8b1321067ddd042edaa6be53453dbbaa7a5c7cb9c5977b6913ab1
-  data.tar.gz: 5a57bf6d891e67922fe5f3d65574b1bd1a8063b84de5ad3cbf354d992269df83ae90308aee6f346d4325c3b92040a6c6986d57a6263e5cff40cf0ab5c50d86a7