feedjira-podcast 0.9.14 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb6cd379a0d36a4311fc8d511d49562e4575cee0
-  data.tar.gz: db188b0638b4b4b015cd45657d11677df58d8695
+  metadata.gz: ac3a1196fabb335ea51d62168ec80797768ded8e
+  data.tar.gz: cd06b8dc8e1b5a06752980de182a65affb400c31
 SHA512:
-  metadata.gz: 0afae3d893d59de6f375fe63d31479ee47f65c062ef464a122b28ab0e345c65252e3bf9364ed1eb996c970b732219bdae540f86a886e7a200be9a64d02cf3215
-  data.tar.gz: 3e5803e5f0e887840d484879406856c524ae89ba4603c82fda873112571cb79f0cc612d5512302dcd043bbeb7414a849554b42365ff9c5f1f9862e4672e98480
+  metadata.gz: ab3d078680dad24ebb13cf6922d99ad5fd2a1d9bde94edda4bd49afb9809a774665ee2459e2cc8903731eccc80e674364380f7234b0652cef09220e79a08cdc1
+  data.tar.gz: 3acc7dbabdfff90416ca56aa1ec7e880541598f77223fc543e31972230a0c89a94eb48c53b4bb70cf308b83a83a7e3f57159a7ca813b4025833709ee06230900

data/README.md

@@ -46,7 +46,7 @@ In nearly all cases the value types of podcast feed data is predictable. As such
 
 Date values are parsed as `Time` objects, number values become `Float` objects, hrefs, URIs and URLs are parsed using [Addressable](https://github.com/sporkmonger/addressable), and boolean values will return `true` or `false`.
 
-In the case of the `<itunes:explicit>` tag, there are three mutually exclusive options, `"yes"`, `"clean"`, and any other value (representing `"no"`). This element gets expanded to two properties through parsing, `explicit?` and `clean?`, allowing both to be simple boolean values.
+In 2016 the definition of the `<itunes:explicit>` tag changed, but it still gets expanded into two properties when parsed: `explicit?` and `clean?`. Unlike previously, where both being false would indicate `"no"` (rather than `"yes"` or `"clean"`), now both properties being false means the tag is not included (or it is being use incorrectly). When present, and given a proper value, `explicit?` and `clean?` will be accurate according to the Podcasts Connect guidelines. If you choose to, you can refer only to `explicit?` to test the value, but when it is false there is no guarantee `<itunes:explicit>` was actually set to `clean`, `no`, or `false`; you would have to also check `clean?` to be sure.
 
 The spec for the item `<guid>` indicates that the default value if no value is given for the `isPermaLink` attribute is `true`. It also states that when `isPermaLink` is true, the value of `<guid>` represents a URI (and that the client can choose to treat it that way or not). As such, whenever a `<guid>` is acting as a `permaLink`, whether implicitly or explicitly, the `guid` value will return an `Addressable::URI`. Only if `isPermaLink` has a value of `"false"` with `guid` return a string.
 

data/lib/feedjira/parser/podcast.rb

@@ -4,19 +4,39 @@ module Feedjira
       include SAXMachine
       include FeedUtilities
 
-      include ::Feedjira::Podcast::Channel::Required
-      include ::Feedjira::Podcast::Channel::Optional
-      include ::Feedjira::Podcast::Channel::Atom
-      include ::Feedjira::Podcast::Channel::Feedburner
-      include ::Feedjira::Podcast::Channel::Apple
+      include ::Feedjira::Podcast::XML::Required
 
-      elements :item, as: :items, class: PodcastItem
+      # def parse(xml_input, on_error = nil, on_warning = nil)
+      #   # TODO This is fragile
+      #   @namespaces = {}
+      #   Nokogiri::XML(xml_input).xpath("//namespace::*").each do |ns|
+      #     @namespaces[ns.href] = ns.prefix
+      #   end
+      #
+      #   super xml_input
+      # end
 
       def self.able_to_parse?(xml)
-        # TODO Look several something podcast-specific matches, especially
+        # TODO Look for any of several podcast-specific matches, especially
         # to cover feeds that may not have any items yet
         (/\<rss|\<rdf/ =~ xml) && (/enclosure/ =~ xml)
       end
+
+      def method_missing(method_sym, *arguments, &block)
+        if rss && rss.channel && rss.channel.respond_to?(method_sym)
+          rss.channel.send(method_sym, *arguments, &block)
+        else
+          super
+        end
+      end
+
+      def self.respond_to_missing?(method_sym, include_private = false)
+        if rss && rss.channel && rss.channel.respond_to?(method_sym)
+          true
+        else
+          super
+        end
+      end
     end
   end
 end

data/lib/feedjira/podcast.rb

@@ -3,6 +3,15 @@ require "addressable/uri"
 
 require "feedjira/podcast/version"
 
+require "feedjira/podcast/item/guid"
+require "feedjira/podcast/item/source"
+
+require "feedjira/podcast/item/required"
+require "feedjira/podcast/item/optional"
+require "feedjira/podcast/item/apple"
+require "feedjira/podcast/item/dublin"
+require "feedjira/podcast/item/content"
+
 require "feedjira/podcast/channel/cloud"
 require "feedjira/podcast/channel/image"
 require "feedjira/podcast/channel/skip_hours"
@@ -18,17 +27,14 @@ require "feedjira/podcast/channel/atom"
 require "feedjira/podcast/channel/feedburner"
 require "feedjira/podcast/channel/apple"
 require "feedjira/podcast/channel/syndication"
+require "feedjira/podcast/channel/item"
 
-require "feedjira/podcast/item/guid"
-require "feedjira/podcast/item/source"
+require "feedjira/podcast/rss/channel"
+require "feedjira/podcast/rss/required"
 
-require "feedjira/podcast/item/required"
-require "feedjira/podcast/item/optional"
-require "feedjira/podcast/item/apple"
-require "feedjira/podcast/item/dublin"
-require "feedjira/podcast/item/content"
+require "feedjira/podcast/xml/rss"
+require "feedjira/podcast/xml/required"
 
-require "feedjira/parser/podcast_item"
 require "feedjira/parser/podcast"
 
 Feedjira::Feed.add_feed_class(Feedjira::Parser::Podcast)

data/lib/feedjira/podcast/channel/apple.rb

@@ -52,11 +52,11 @@ module Feedjira
           end
 
           def itunes_explicit
-            @itunes_explicit ||= (_itunes_explicit == "yes")
+            @itunes_explicit ||= ["yes", "explicit", "true"].include?(_itunes_explicit)
           end
 
           def itunes_clean
-            @itunes_clean ||= (_itunes_explicit == "clean")
+            @itunes_clean ||= ["no", "clean", "false"].include?(_itunes_explicit)
           end
 
           def itunes_owner
@@ -70,30 +70,32 @@ module Feedjira
         def self.included(base)
           base.include(InstanceMethods)
 
-          base.element :"itunes:author", as: :itunes_author
+          itunes_xml_ns = "itunes"
 
-          base.element :"itunes:block", as: :_itunes_block
+          base.element :"#{itunes_xml_ns}:author", as: :itunes_author
 
-          base.elements :"itunes:category", as: :_itunes_categories, class: AppleCategory
+          base.element :"#{itunes_xml_ns}:block", as: :_itunes_block
 
-          base.element :"itunes:image", as: :itunes_image_href, value: :href do |href|
+          base.elements :"#{itunes_xml_ns}:category", as: :_itunes_categories, class: AppleCategory
+
+          base.element :"#{itunes_xml_ns}:image", as: :itunes_image_href, value: :href do |href|
             Addressable::URI.parse(href.strip)
           end
 
-          base.element :"itunes:explicit", as: :_itunes_explicit
-          base.element :"itunes:complete", as: :_itunes_complete
+          base.element :"#{itunes_xml_ns}:explicit", as: :_itunes_explicit
+          base.element :"#{itunes_xml_ns}:complete", as: :_itunes_complete
 
-          base.element :"itunes:new_feed_url", as: :itunes_new_feed_url do |url|
+          base.element :"#{itunes_xml_ns}:new_feed_url", as: :itunes_new_feed_url do |url|
             Addressable::URI.parse(url.strip)
           end
 
-          base.element :"itunes:owner", as: :_itunes_owner, class: AppleOwner
-          base.element :"itunes:subtitle", as: :itunes_subtitle
-          base.element :"itunes:summary", as: :itunes_summary
+          base.element :"#{itunes_xml_ns}:owner", as: :_itunes_owner, class: AppleOwner
+          base.element :"#{itunes_xml_ns}:subtitle", as: :itunes_subtitle
+          base.element :"#{itunes_xml_ns}:summary", as: :itunes_summary
 
           # Legacy support
 
-          base.element :"itunes:keywords", as: :itunes_keywords, default: "" do |keywords|
+          base.element :"#{itunes_xml_ns}:keywords", as: :itunes_keywords, default: "" do |keywords|
             keywords.split(",").map(&:strip).select { |k| !k.empty? }
           end
         end

data/lib/feedjira/podcast/channel/feedburner.rb

@@ -12,7 +12,9 @@ module Feedjira
         def self.included(base)
           base.include(InstanceMethods)
 
-          base.element :"feedburner:info", as: :feedburner_info_uri, value: :uri do |uri|
+          feedburner_xml_ns = "feedburner"
+
+          base.element :"#{feedburner_xml_ns}:info", as: :feedburner_info_uri, value: :uri do |uri|
             Addressable::URI.parse(uri.strip)
           end
         end

data/lib/feedjira/podcast/channel/item.rb

@@ -0,0 +1,16 @@
+module Feedjira
+  module Podcast
+    module Channel
+      class Item
+        include SAXMachine
+        include FeedUtilities
+
+        include ::Feedjira::Podcast::Item::Required
+        include ::Feedjira::Podcast::Item::Optional
+        include ::Feedjira::Podcast::Item::Apple
+        include ::Feedjira::Podcast::Item::Dublin
+        include ::Feedjira::Podcast::Item::Content
+      end
+    end
+  end
+end

data/lib/feedjira/podcast/item/apple.rb

@@ -46,42 +46,44 @@ module Feedjira
           end
 
           def itunes_explicit
-            @itunes_explicit ||= (_itunes_explicit == "yes")
+            @itunes_explicit ||= ["yes", "explicit", "true"].include?(_itunes_explicit)
           end
 
           def itunes_clean
-            @itunes_clean ||= (_itunes_explicit == "clean")
+            @itunes_clean ||= ["no", "clean", "false"].include?(_itunes_explicit)
           end
         end
 
         def self.included(base)
           base.include(InstanceMethods)
 
-          base.element :"itunes:author", as: :itunes_author
-          base.element :"itunes:block", as: :_itunes_block
+          itunes_xml_ns = "itunes"
 
-          base.element :"itunes:image", as: :itunes_image_href, value: :href do |href|
+          base.element :"#{itunes_xml_ns}:author", as: :itunes_author
+          base.element :"#{itunes_xml_ns}:block", as: :_itunes_block
+
+          base.element :"#{itunes_xml_ns}:image", as: :itunes_image_href, value: :href do |href|
             Addressable::URI.parse(href.strip)
           end
 
-          base.element :"itunes:duration", as: :itunes_duration do |d|
+          base.element :"#{itunes_xml_ns}:duration", as: :itunes_duration do |d|
             ["0:0:0:#{d}".split(":")[-3, 3].map(&:to_i)].inject(0) do |_m, i|
               (i[0] * 3600) + (i[1] * 60) + i[2]
             end
           end
 
-          base.element :"itunes:explicit", as: :_itunes_explicit
+          base.element :"#{itunes_xml_ns}:explicit", as: :_itunes_explicit
 
-          base.element :"itunes:isClosedCaptioned", as: :_itunes_is_closed_captioned
+          base.element :"#{itunes_xml_ns}:isClosedCaptioned", as: :_itunes_is_closed_captioned
 
-          base.element :"itunes:order", as: :itunes_order, &:to_f
+          base.element :"#{itunes_xml_ns}:order", as: :itunes_order, &:to_f
 
-          base.element :"itunes:subtitle", as: :itunes_subtitle
-          base.element :"itunes:summary", as: :itunes_summary
+          base.element :"#{itunes_xml_ns}:subtitle", as: :itunes_subtitle
+          base.element :"#{itunes_xml_ns}:summary", as: :itunes_summary
 
           # Legacy support
 
-          base.element :"itunes:keywords", as: :itunes_keywords do |keywords|
+          base.element :"#{itunes_xml_ns}:keywords", as: :itunes_keywords do |keywords|
             keywords.split(",").map(&:strip).select { |k| !k.empty? }
           end
         end

data/lib/feedjira/podcast/item/content.rb

@@ -11,7 +11,9 @@ module Feedjira
         def self.included(base)
           base.include(InstanceMethods)
 
-          base.element :"content:encoded", as: :content_encoded
+          content_xml_ns = "content"
+
+          base.element :"#{content_xml_ns}:encoded", as: :content_encoded
         end
       end
     end

data/lib/feedjira/podcast/item/dublin.rb

@@ -13,7 +13,9 @@ module Feedjira
         def self.included(base)
           base.include(InstanceMethods)
 
-          base.element :"dc:creator", as: :dc_creator
+          dc_xml_ns = "dc"
+
+          base.element :"#{dc_xml_ns}:creator", as: :dc_creator
         end
       end
     end

data/lib/feedjira/podcast/rss/channel.rb

@@ -0,0 +1,20 @@
+module Feedjira
+  module Podcast
+    module RSS
+      class Channel
+        include SAXMachine
+        include FeedUtilities
+
+        include ::Feedjira::Podcast::Channel::Required
+        include ::Feedjira::Podcast::Channel::Optional
+        include ::Feedjira::Podcast::Channel::Atom
+        include ::Feedjira::Podcast::Channel::Feedburner
+        include ::Feedjira::Podcast::Channel::Apple
+
+        elements :item, as: :items, class: ::Feedjira::Podcast::Channel::Item
+
+        ancestor :rss
+      end
+    end
+  end
+end

data/lib/feedjira/podcast/rss/required.rb

@@ -0,0 +1,14 @@
+module Feedjira
+  module Podcast
+    module RSS
+      module Required
+        def self.included(base)
+          base.element :channel, class: Channel
+          base.attribute :version
+
+          base.ancestor :xml
+        end
+      end
+    end
+  end
+end

data/lib/feedjira/podcast/version.rb

@@ -1,5 +1,5 @@
 module Feedjira
   module Podcast
-    VERSION = "0.9.14"
+    VERSION = "0.10.0"
   end
 end

data/lib/feedjira/podcast/xml/required.rb

@@ -0,0 +1,11 @@
+module Feedjira
+  module Podcast
+    module XML
+      module Required
+        def self.included(base)
+          base.element :rss, class: RSS
+        end
+      end
+    end
+  end
+end

data/lib/feedjira/podcast/xml/rss.rb

@@ -0,0 +1,12 @@
+module Feedjira
+  module Podcast
+    module XML
+      class RSS
+        include SAXMachine
+        include FeedUtilities
+
+        include ::Feedjira::Podcast::RSS::Required
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feedjira-podcast
 version: !ruby/object:Gem::Version
-  version: 0.9.14
+  version: 0.10.0
 platform: ruby
 authors:
 - Chris Kalafarski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-14 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,7 +128,6 @@ files:
 - bin/setup
 - feedjira-podcast.gemspec
 - lib/feedjira/parser/podcast.rb
-- lib/feedjira/parser/podcast_item.rb
 - lib/feedjira/podcast.rb
 - lib/feedjira/podcast/channel/apple.rb
 - lib/feedjira/podcast/channel/apple_category.rb
@@ -138,6 +137,7 @@ files:
 - lib/feedjira/podcast/channel/cloud.rb
 - lib/feedjira/podcast/channel/feedburner.rb
 - lib/feedjira/podcast/channel/image.rb
+- lib/feedjira/podcast/channel/item.rb
 - lib/feedjira/podcast/channel/optional.rb
 - lib/feedjira/podcast/channel/required.rb
 - lib/feedjira/podcast/channel/skip_days.rb
@@ -152,8 +152,12 @@ files:
 - lib/feedjira/podcast/item/optional.rb
 - lib/feedjira/podcast/item/required.rb
 - lib/feedjira/podcast/item/source.rb
+- lib/feedjira/podcast/rss/channel.rb
+- lib/feedjira/podcast/rss/required.rb
 - lib/feedjira/podcast/version.rb
 - lib/feedjira/podcast/warning.rb
+- lib/feedjira/podcast/xml/required.rb
+- lib/feedjira/podcast/xml/rss.rb
 homepage: https://github.com/scour/feedjira-podcast
 licenses:
 - MIT
@@ -175,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
 summary: Podcast feed parsing with Feedjira

data/lib/feedjira/parser/podcast_item.rb

@@ -1,14 +0,0 @@
-module Feedjira
-  module Parser
-    class PodcastItem
-      include SAXMachine
-      include FeedUtilities
-
-      include ::Feedjira::Podcast::Item::Required
-      include ::Feedjira::Podcast::Item::Optional
-      include ::Feedjira::Podcast::Item::Apple
-      include ::Feedjira::Podcast::Item::Dublin
-      include ::Feedjira::Podcast::Item::Content
-    end
-  end
-end