feedjira-podcast 0.9.8 → 0.9.9

data/.travis.yml

@@ -1,3 +1,7 @@
+sudo: false
 language: ruby
 rvm:
   - 2.2.1
+  - 2.2.3
+cache: bundler
+script: "bundle exec rake test"

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in feedjira-podcast.gemspec
 gemspec

data/README.md

@@ -42,9 +42,9 @@ In cases where an element can repeat in a given context, the accessor will be pl
 
 #### Typecasting
 
-In nearly all cases the value types of podcast feed data is predictable. As such, the parser will cast values appropriately. In cases where a feed is malformed, the result of the type cast may be somewhat unpredictable, but no more so than the original data was. A bad value should never prevent parsing of the rest of the document, but it bust a specific value (e.g. a date that is human-readable but not parseable will end up as `nil` rather than fallback to an ambiguous `String` value).
+In nearly all cases the value types of podcast feed data is predictable. As such, the parser will cast values appropriately. In cases where a feed is malformed, the result of the type cast may be somewhat unpredictable, but no more so than the original data was. A bad value should never prevent parsing of the rest of the document, but it could bust a specific value (e.g. a date that is human-readable but not parseable will end up as `nil` rather than fallback to an ambiguous `String` value).
 
-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.`
+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.
 
@@ -56,12 +56,16 @@ The parser will try its best to parse whatever data it has available, with a str
 
 Besides standard typecasting, the parser won't try to clean up any data. For example, many elements (such as `<description>`) explicitly allow only plaintext, but it is common for them to include markup in the wild. The parser will assume that markup to be plaintext, according to the spec. If you want to sanitize those parts of feeds, you should handle that on your end.
 
+#### Parsing
+
+During parsing, some aspects of the original feed will not be maintained in such a way that a functionally identical feed could be generated from the result. For example. `CDATA` declarations in XML elements are lost, as the parser converts them (correctly) to strings. If the resulting data is being used to generate feeds, wrapping values in CDATA would be the responsibility of the whatever is constructing the feed, based on the values of the strings. Similarly, Apple expects iTunes category tag values to include encoded ampersands, eg `TV &amp; Film`. Parsing the feed will decode those values (to `TV & Film`), so they would have to be re-encoded before being used somewhere that iTunes would be reading from.
+
 ### More Information
 
 For more detailed information about specific aspects of feeds, how they are spec'd, and how they are handled by the parser, see the [wiki](https://github.com/scour/feedjira-podcast/wiki).
 
 ## In Progress
 
-Coverage of RSS, iTunes, and the other common constituents of podcast feeds is very high, but there are some bits that need to be addressed. Several rarely-used RSS elements (`<cloud>`, `<rating>`, etc) are not supported. Due to how they can be nested `<itunes:category>` is also a work in progress. Currently only top-level categories are available. More esoteric elements, such a host-specific tags, or various parts of Dublin Core, are added based on their prevalence in real world feeds.
+Coverage of RSS, iTunes, and the other common constituents of podcast feeds is very high, but there are some bits that need to be addressed. Several rarely-used RSS elements (`<rating>`, etc) are not supported. More esoteric elements, such a host-specific tags, or various parts of Dublin Core, are added based on their prevalence in real world feeds.
 
 Experimental feed elements may be added over time, but they should be used with caution until they reach a critical mass or become standardized.

data/Rakefile

@@ -1,8 +1,12 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.pattern = 'test/**/test_*.rb'
+  t.pattern = "test/**/test_*.rb"
 end
 
-task default: :test
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:analyze)
+
+task checks: [:test, :analyze]
+task default: :checks

data/feedjira-podcast.gemspec

@@ -1,33 +1,34 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'feedjira/podcast/version'
+require "feedjira/podcast/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'feedjira-podcast'
+  spec.name          = "feedjira-podcast"
   spec.version       = Feedjira::Podcast::VERSION
-  spec.authors       = ['Chris Kalafarski']
-  spec.email         = ['chris@farski.com']
+  spec.authors       = ["Chris Kalafarski"]
+  spec.email         = ["chris@farski.com"]
 
-  spec.summary       = %q{Podcast feed parsing with Feedjira}
-  spec.description   = %q{Podcast feed parsing with Feedjira}
-  spec.homepage      = 'https://github.com/scour/feedjira-podcast'
-  spec.license       = 'MIT'
+  spec.summary       = "Podcast feed parsing with Feedjira"
+  spec.description   = "Podcast feed parsing with Feedjira"
+  spec.homepage      = "https://github.com/scour/feedjira-podcast"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
   end
 
-  spec.add_development_dependency 'bundler', '~> 1.8'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.5'
-  spec.add_development_dependency 'coveralls', '~> 0'
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.5"
+  spec.add_development_dependency "coveralls", "~> 0"
+  spec.add_development_dependency "rubocop", "~> 0"
 
-  spec.add_runtime_dependency 'feedjira', '~> 2.0'
-  spec.add_runtime_dependency 'addressable', '~> 2.3'
+  spec.add_runtime_dependency "feedjira", "~> 2.0"
+  spec.add_runtime_dependency "addressable", "~> 2.3"
 end

data/lib/feedjira/parser/podcast_item.rb

@@ -9,7 +9,6 @@ module Feedjira
       include ::Feedjira::Podcast::Item::Apple
       include ::Feedjira::Podcast::Item::Dublin
       include ::Feedjira::Podcast::Item::Content
-
     end
   end
 end

data/lib/feedjira/podcast.rb

@@ -1,39 +1,34 @@
-require 'feedjira'
-require 'addressable/uri'
-
-require 'feedjira/podcast/version'
-
-require 'feedjira/podcast/channel/image'
-require 'feedjira/podcast/channel/skip_hours'
-require 'feedjira/podcast/channel/skip_days'
-require 'feedjira/podcast/channel/text_input'
-require 'feedjira/podcast/channel/apple_owner'
-require 'feedjira/podcast/channel/apple_subcategory'
-require 'feedjira/podcast/channel/apple_category'
-
-require 'feedjira/podcast/channel/required'
-require 'feedjira/podcast/channel/optional'
-require 'feedjira/podcast/channel/atom'
-require 'feedjira/podcast/channel/feedburner'
-require 'feedjira/podcast/channel/apple'
-require 'feedjira/podcast/channel/syndication'
-
-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/parser/podcast_item'
-require 'feedjira/parser/podcast'
-
-module Feedjira
-  module Podcast
-    # Your code goes here...
-  end
-end
+require "feedjira"
+require "addressable/uri"
+
+require "feedjira/podcast/version"
+
+require "feedjira/podcast/channel/cloud"
+require "feedjira/podcast/channel/image"
+require "feedjira/podcast/channel/skip_hours"
+require "feedjira/podcast/channel/skip_days"
+require "feedjira/podcast/channel/text_input"
+require "feedjira/podcast/channel/apple_owner"
+require "feedjira/podcast/channel/apple_subcategory"
+require "feedjira/podcast/channel/apple_category"
+
+require "feedjira/podcast/channel/required"
+require "feedjira/podcast/channel/optional"
+require "feedjira/podcast/channel/atom"
+require "feedjira/podcast/channel/feedburner"
+require "feedjira/podcast/channel/apple"
+require "feedjira/podcast/channel/syndication"
+
+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/parser/podcast_item"
+require "feedjira/parser/podcast"
 
 Feedjira::Feed.add_feed_class(Feedjira::Parser::Podcast)

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

@@ -2,35 +2,7 @@ module Feedjira
   module Podcast
     module Channel
       module Apple
-        def self.included(base)
-
-          base.element :"itunes:author", as: :itunes_author
-
-          base.element :"itunes:block", as: :_itunes_block
-
-          base.elements :"itunes:category", as: :itunes_categories, class: AppleCategory
-
-          base.element :"itunes:image", as: :itunes_image_href, value: :href do |href|
-            Addressable::URI.parse(href)
-          end
-
-          base.element :"itunes:explicit", as: :_itunes_explicit
-          base.element :"itunes:complete", as: :_itunes_complete
-
-          base.element :"itunes:new_feed_url", as: :itunes_new_feed_url do |url|
-            Addressable::URI.parse(url)
-          end
-
-          base.element :"itunes:owner", as: :_itunes_owner, class: AppleOwner
-          base.element :"itunes:subtitle", as: :itunes_subtitle
-          base.element :"itunes:summary", as: :itunes_summary
-
-          # Legacy support
-
-          base.element :"itunes:keywords", as: :itunes_keywords do |keywords|
-            keywords.split(',').map(&:strip).select { |k| !k.empty? }
-          end
-
+        module InstanceMethods
           def itunes
             @itunes ||= Struct.new(
               :author,
@@ -68,19 +40,23 @@ module Feedjira
           end
 
           def itunes_block
-            @itunes_block ||= (_itunes_block == 'yes')
+            @itunes_block ||= (_itunes_block == "yes")
+          end
+
+          def itunes_categories
+            @itunes_categories ||= _itunes_categories.select(&:valid?)
           end
 
           def itunes_complete
-            @itunes_complete ||= (_itunes_complete == 'yes')
+            @itunes_complete ||= (_itunes_complete == "yes")
           end
 
           def itunes_explicit
-            @itunes_explicit ||= (_itunes_explicit == 'yes')
+            @itunes_explicit ||= (_itunes_explicit == "yes")
           end
 
           def itunes_clean
-            @itunes_clean ||=  (_itunes_explicit == 'clean')
+            @itunes_clean ||= (_itunes_explicit == "clean")
           end
 
           def itunes_owner
@@ -89,7 +65,37 @@ module Feedjira
               _itunes_owner && _itunes_owner.name,
             )
           end
+        end
+
+        def self.included(base)
+          base.include(InstanceMethods)
+
+          base.element :"itunes:author", as: :itunes_author
+
+          base.element :"itunes:block", as: :_itunes_block
+
+          base.elements :"itunes:category", as: :_itunes_categories, class: AppleCategory
+
+          base.element :"itunes:image", as: :itunes_image_href, value: :href do |href|
+            Addressable::URI.parse(href)
+          end
+
+          base.element :"itunes:explicit", as: :_itunes_explicit
+          base.element :"itunes:complete", as: :_itunes_complete
+
+          base.element :"itunes:new_feed_url", as: :itunes_new_feed_url do |url|
+            Addressable::URI.parse(url)
+          end
+
+          base.element :"itunes:owner", as: :_itunes_owner, class: AppleOwner
+          base.element :"itunes:subtitle", as: :itunes_subtitle
+          base.element :"itunes:summary", as: :itunes_summary
 
+          # Legacy support
+
+          base.element :"itunes:keywords", as: :itunes_keywords do |keywords|
+            keywords.split(",").map(&:strip).select { |k| !k.empty? }
+          end
         end
       end
     end

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

@@ -5,10 +5,69 @@ module Feedjira
         include SAXMachine
         include FeedUtilities
 
+        CATEGORIES = {
+          "Arts" => [
+            "Design",
+            "Fashion & Beauty",
+            "Food",
+            "Literature",
+            "Performing Arts",
+            "Visual Arts"
+          ],
+          "Business" => [
+            "Business News",
+            "Careers",
+            "Investing",
+            "Management & Marketing",
+            "Shopping"
+          ],
+          "Comedy" => [],
+          "Education" => [
+
+          ],
+          "Games & Hobbies" => [
+
+          ],
+          "Government & Organizations" => [
+
+          ],
+          "Health" => [
+
+          ],
+          "Kids & Family" => [],
+          "Music" => [],
+          "News & Politics" => [],
+          "Religion & Spirituality" => [
+
+          ],
+          "Science & Medicine" => [
+
+          ],
+          "Society & Culture" => [
+
+          ],
+          "Sports & Recreation" => [
+
+          ],
+          "Technology" => [
+
+          ],
+          "TV & Film" => []
+        }
+
         attribute :text
 
-        element :"itunes:category", as: :subcategory, class: AppleSubcategory
+        elements :"itunes:category", as: :subcategories, class: AppleSubcategory
+
+        def subcategory
+          if subcategories.first && subcategories.first.valid?(self)
+            subcategories.first
+          end
+        end
 
+        def valid?
+          CATEGORIES.include?(text)
+        end
       end
     end
   end

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

@@ -7,6 +7,9 @@ module Feedjira
 
         attribute :text
 
+        def valid?(category)
+          AppleCategory::CATEGORIES[category.text].include?(text)
+        end
       end
     end
   end

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

@@ -2,18 +2,7 @@ module Feedjira
   module Podcast
     module Channel
       module Atom
-        def self.included(base)
-
-          ['self', 'hub'].each do |rel|
-            [:"atom:link", :"atom10:link"].each do |ns|
-              base.element ns, with: { rel: rel }, as: "atom_#{rel}_link_href".to_sym, value: :href do |href|
-                Addressable::URI.parse(href)
-              end
-              base.element ns, with: { rel: rel }, as: "atom_#{rel}_link_rel".to_sym, value: :rel
-              base.element ns, with: { rel: rel }, as: "atom_#{rel}_link_type".to_sym, value: :type
-            end
-          end
-
+        module InstanceMethods
           def atom
             @atom ||= Struct.new(:link).new(atom_link)
           end
@@ -42,7 +31,20 @@ module Feedjira
               atom_hub_link_type,
             )
           end
+        end
+
+        def self.included(base)
+          base.include(InstanceMethods)
 
+          ["self", "hub"].each do |rel|
+            [:"atom:link", :"atom10:link"].each do |ns|
+              base.element ns, with: { rel: rel }, as: "atom_#{rel}_link_href".to_sym, value: :href do |href|
+                Addressable::URI.parse(href)
+              end
+              base.element ns, with: { rel: rel }, as: "atom_#{rel}_link_rel".to_sym, value: :rel
+              base.element ns, with: { rel: rel }, as: "atom_#{rel}_link_type".to_sym, value: :type
+            end
+          end
         end
       end
     end

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

@@ -0,0 +1,16 @@
+module Feedjira
+  module Podcast
+    module Channel
+      class Cloud
+        include SAXMachine
+        include FeedUtilities
+
+        attribute :domain
+        attribute :port
+        attribute :path
+        attribute :registerProcedure
+        attribute :protocol
+      end
+    end
+  end
+end

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

@@ -2,17 +2,19 @@ module Feedjira
   module Podcast
     module Channel
       module Feedburner
-        def self.included(base)
-
-          base.element :"feedburner:info", as: :feedburner_info_uri, value: :uri do |uri|
-            Addressable::URI.parse(uri)
-          end
-
+        module InstanceMethods
           def feedburner
             info = Struct.new(:uri).new(feedburner_info_uri)
             @feedburner ||= Struct.new(:info).new(info)
           end
+        end
+
+        def self.included(base)
+          base.include(InstanceMethods)
 
+          base.element :"feedburner:info", as: :feedburner_info_uri, value: :uri do |uri|
+            Addressable::URI.parse(uri)
+          end
         end
       end
     end