feedjira 2.2.0 → 3.1.2

data/lib/feedjira/parser/atom_youtube.rb

@@ -1,4 +1,5 @@
-# rubocop:disable Style/DocumentationMethod
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     # Parser for dealing with RSS feeds.
@@ -6,8 +7,8 @@ module Feedjira
       include SAXMachine
       include FeedUtilities
       element :title
-      element :link, as: :url, value: :href, with: { rel: 'alternate' }
-      element :link, as: :feed_url, value: :href, with: { rel: 'self' }
+      element :link, as: :url, value: :href, with: { rel: "alternate" }
+      element :link, as: :feed_url, value: :href, with: { rel: "self" }
       element :name, as: :author
       element :"yt:channelId", as: :youtube_channel_id
 

data/lib/feedjira/parser/atom_youtube_entry.rb

@@ -1,19 +1,20 @@
-# rubocop:disable Style/Documentation
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     class AtomYoutubeEntry
       include SAXMachine
       include FeedEntryUtilities
+      include AtomEntryUtilities
+
+      sax_config.top_level_elements["link"].clear
+      sax_config.collection_elements["link"].clear
+
+      element :link, as: :url, value: :href, with: { rel: "alternate" }
 
-      element :title
-      element :link, as: :url, value: :href, with: { rel: 'alternate' }
-      element :name, as: :author
       element :"media:description", as: :content
-      element :summary
-      element :published
-      element :id, as: :entry_id
-      element :updated
       element :"yt:videoId", as: :youtube_video_id
+      element :"yt:channelId", as: :youtube_channel_id
       element :"media:title", as: :media_title
       element :"media:content", as: :media_url, value: :url
       element :"media:content", as: :media_type, value: :type

data/lib/feedjira/parser/globally_unique_identifier.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Feedjira
+  module Parser
+    class GloballyUniqueIdentifier
+      include SAXMachine
+
+      attribute :isPermaLink, as: :is_perma_link
+
+      value :guid
+
+      def perma_link?
+        is_perma_link != "false"
+      end
+
+      def url
+        perma_link? ? guid : nil
+      end
+    end
+  end
+end

data/lib/feedjira/parser/google_docs_atom.rb

@@ -1,6 +1,6 @@
-require File.expand_path('./atom', File.dirname(__FILE__))
-# rubocop:disable Style/Documentation
-# rubocop:disable Style/DocumentationMethod
+# frozen_string_literal: true
+
+require File.expand_path("./atom", File.dirname(__FILE__))
 module Feedjira
   module Parser
     class GoogleDocsAtom
@@ -8,8 +8,8 @@ module Feedjira
       include FeedUtilities
       element :title
       element :subtitle, as: :description
-      element :link, as: :url, value: :href, with: { type: 'text/html' }
-      element :link, as: :feed_url, value: :href, with: { type: 'application/atom+xml' } # rubocop:disable Metrics/LineLength
+      element :link, as: :url, value: :href, with: { type: "text/html" }
+      element :link, as: :feed_url, value: :href, with: { type: "application/atom+xml" }
       elements :link, as: :links, value: :href
       elements :entry, as: :entries, class: GoogleDocsAtomEntry
 
@@ -18,7 +18,7 @@ module Feedjira
       end
 
       def self.able_to_parse?(xml) #:nodoc:
-        %r{<id>https?://docs\.google\.com/.*\</id\>} =~ xml
+        %r{<id>https?://docs\.google\.com/.*</id>} =~ xml
       end
 
       def feed_url

data/lib/feedjira/parser/google_docs_atom_entry.rb

@@ -1,31 +1,15 @@
-# rubocop:disable Style/Documentation
-# rubocop:disable Style/DocumentationMethod
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     class GoogleDocsAtomEntry
       include SAXMachine
       include FeedEntryUtilities
+      include AtomEntryUtilities
 
-      element :title
-      element :link, as: :url, value: :href, with: { type: 'text/html', rel: 'alternate' } # rubocop:disable Metrics/LineLength
-      element :name, as: :author
-      element :content
-      element :summary
-      element :published
-      element :id, as: :entry_id
-      element :created, as: :published
-      element :issued, as: :published
-      element :updated
-      element :modified, as: :updated
-      elements :category, as: :categories, value: :term
-      elements :link, as: :links, value: :href
       element :"docs:md5Checksum", as: :checksum
       element :"docs:filename", as: :original_filename
       element :"docs:suggestedFilename", as: :suggested_filename
-
-      def url
-        @url ||= links.first
-      end
     end
   end
 end

data/lib/feedjira/parser/itunes_rss.rb

@@ -1,4 +1,5 @@
-# rubocop:disable Style/DocumentationMethod
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     # iTunes is RSS 2.0 + some apple extensions
@@ -19,7 +20,7 @@ module Feedjira
       element :language
       element :lastBuildDate, as: :last_built
       element :link, as: :url
-      element :managingEditor
+      element :managingEditor, as: :managing_editor
       element :rss, as: :version, value: :version
       element :title
       element :ttl
@@ -62,7 +63,7 @@ module Feedjira
       elements :item, as: :entries, class: ITunesRSSItem
 
       def self.able_to_parse?(xml)
-        %r{xmlns:itunes\s?=\s?[\"\']http://www\.itunes\.com/dtds/podcast-1\.0\.dtd[\"\']}i =~ xml # rubocop:disable Metrics/LineLength
+        %r{xmlns:itunes\s?=\s?["']http://www\.itunes\.com/dtds/podcast-1\.0\.dtd["']}i =~ xml
       end
     end
   end

data/lib/feedjira/parser/itunes_rss_category.rb

@@ -1,4 +1,5 @@
-# rubocop:disable Style/DocumentationMethod
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     # iTunes extensions to the standard RSS2.0 item
@@ -11,17 +12,17 @@ module Feedjira
       elements :"itunes:category", as: :itunes_categories,
                                    class: ITunesRSSCategory
 
-      def each_subcategory
+      def each_subcategory(&block)
         return to_enum(__method__) unless block_given?
 
         yield text
 
         itunes_categories.each do |itunes_category|
-          itunes_category.each_subcategory(&proc)
+          itunes_category.each_subcategory(&block)
         end
       end
 
-      def each_path(ancestors = [])
+      def each_path(ancestors = [], &block)
         return to_enum(__method__, ancestors) unless block_given?
 
         category_hierarchy = ancestors + [text]
@@ -30,7 +31,7 @@ module Feedjira
           yield category_hierarchy
         else
           itunes_categories.each do |itunes_category|
-            itunes_category.each_path(category_hierarchy, &proc)
+            itunes_category.each_path(category_hierarchy, &block)
           end
         end
       end

data/lib/feedjira/parser/itunes_rss_item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     # iTunes extensions to the standard RSS2.0 item
@@ -5,14 +7,9 @@ module Feedjira
     class ITunesRSSItem
       include SAXMachine
       include FeedEntryUtilities
+      include RSSEntryUtilities
 
-      element :author
-      element :guid, as: :entry_id
-      element :title
-      element :link, as: :url
-      element :description, as: :summary
-      element :"content:encoded", as: :content
-      element :pubDate, as: :published
+      sax_config.top_level_elements["enclosure"].clear
 
       # If author is not present use author tag on the item
       element :"itunes:author", as: :itunes_author
@@ -34,7 +31,7 @@ module Feedjira
       element :enclosure, value: :length, as: :enclosure_length
       element :enclosure, value: :type, as: :enclosure_type
       element :enclosure, value: :url, as: :enclosure_url
-      elements 'psc:chapter', as: :raw_chapters, class: Feedjira::Parser::PodloveChapter # rubocop:disable Metrics/LineLength
+      elements "psc:chapter", as: :raw_chapters, class: Feedjira::Parser::PodloveChapter
 
       # Podlove requires clients to re-order by start time in the
       # event the publisher doesn't provide them in that

data/lib/feedjira/parser/itunes_rss_owner.rb

@@ -1,4 +1,5 @@
-# rubocop:disable Style/Documentation
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     class ITunesRSSOwner

data/lib/feedjira/parser/json_feed.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Feedjira
+  module Parser
+    # Parser for dealing with JSON Feeds.
+    class JSONFeed
+      include SAXMachine
+      include FeedUtilities
+
+      def self.able_to_parse?(json)
+        %r{https://jsonfeed.org/version/} =~ json
+      end
+
+      def self.parse(json)
+        new(JSON.parse(json))
+      end
+
+      attr_reader :json, :version, :title, :url, :feed_url, :description,
+                  :expired, :entries
+
+      def initialize(json)
+        @json = json
+        @version = json.fetch("version")
+        @title = json.fetch("title")
+        @url = json.fetch("home_page_url", nil)
+        @feed_url = json.fetch("feed_url", nil)
+        @description = json.fetch("description", nil)
+        @expired = json.fetch("expired", nil)
+        @entries = parse_items(json["items"])
+      end
+
+      private
+
+      def parse_items(items)
+        items.map do |item|
+          Feedjira::Parser::JSONFeedItem.new(item)
+        end
+      end
+    end
+  end
+end

data/lib/feedjira/parser/json_feed_item.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Feedjira
+  module Parser
+    # Parser for dealing with JSON Feed items.
+    class JSONFeedItem
+      include FeedEntryUtilities
+
+      attr_reader :json, :entry_id, :url, :external_url, :title, :content, :summary,
+                  :published, :updated, :image, :banner_image, :author, :categories
+
+      def initialize(json)
+        @json = json
+        @entry_id = json.fetch("id")
+        @url = json.fetch("url")
+        @external_url = json.fetch("external_url", nil)
+        @title = json.fetch("title", nil)
+        @content = parse_content(json.fetch("content_html", nil), json.fetch("content_text", nil))
+        @summary = json.fetch("summary", nil)
+        @image = json.fetch("image", nil)
+        @banner_image = json.fetch("banner_image", nil)
+        @published = parse_published(json.fetch("date_published", nil))
+        @updated = parse_updated(json.fetch("date_modified", nil))
+        @author = author_name(json.fetch("author", nil))
+        @categories = json.fetch("tags", [])
+      end
+
+      private
+
+      def parse_published(date_published)
+        return nil unless date_published
+
+        Time.parse_safely(date_published)
+      end
+
+      def parse_updated(date_modified)
+        return nil unless date_modified
+
+        Time.parse_safely(date_modified)
+      end
+
+      # Convenience method to return the included content type.
+      # Prefer content_html unless it isn't included.
+      def parse_content(content_html, content_text)
+        return content_html unless content_html.nil?
+
+        content_text
+      end
+
+      def author_name(author_obj)
+        return nil if author_obj.nil?
+
+        author_obj["name"]
+      end
+    end
+  end
+end

data/lib/feedjira/parser/podlove_chapter.rb

@@ -1,5 +1,5 @@
-# rubocop:disable Style/Documentation
-# rubocop:disable Style/DocumentationMethod
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     class PodloveChapter
@@ -12,7 +12,8 @@ module Feedjira
 
       def start
         return unless start_ntp
-        parts = start_ntp.split(':')
+
+        parts = start_ntp.split(":")
         parts.reverse.to_enum.with_index.map do |part, index|
           part.to_f * (60**index)
         end.reduce(:+)

data/lib/feedjira/parser/rss.rb

@@ -1,4 +1,5 @@
-# rubocop:disable Style/DocumentationMethod
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     # Parser for dealing with RSS feeds.
@@ -11,16 +12,17 @@ module Feedjira
       element :language
       element :lastBuildDate, as: :last_built
       element :link, as: :url
+      element :"a10:link", as: :url, value: :href
       element :rss, as: :version, value: :version
       element :title
       element :ttl
-      elements :"atom:link", as: :hubs, value: :href, with: { rel: 'hub' }
+      elements :"atom:link", as: :hubs, value: :href, with: { rel: "hub" }
       elements :item, as: :entries, class: RSSEntry
 
       attr_accessor :feed_url
 
       def self.able_to_parse?(xml)
-        (/\<rss|\<rdf/ =~ xml) && !(/feedburner/ =~ xml)
+        (/<rss|<rdf/ =~ xml) && !(/feedburner/ =~ xml)
       end
     end
   end

data/lib/feedjira/parser/rss_entry.rb

@@ -1,33 +1,12 @@
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     # Parser for dealing with RDF feed entries.
     class RSSEntry
       include SAXMachine
       include FeedEntryUtilities
-
-      element :title
-      element :link, as: :url
-
-      element :"dc:creator", as: :author
-      element :author, as: :author
-      element :"content:encoded", as: :content
-      element :description, as: :summary
-
-      element :"media:content", as: :image, value: :url
-      element :enclosure, as: :image, value: :url
-
-      element :pubDate, as: :published
-      element :pubdate, as: :published
-      element :"dc:date", as: :published
-      element :"dc:Date", as: :published
-      element :"dcterms:created", as: :published
-
-      element :"dcterms:modified", as: :updated
-      element :issued, as: :published
-      elements :category, as: :categories
-
-      element :guid, as: :entry_id
-      element :"dc:identifier", as: :entry_id
+      include RSSEntryUtilities
     end
   end
 end

data/lib/feedjira/parser/rss_feed_burner.rb

@@ -1,4 +1,5 @@
-# rubocop:disable Style/DocumentationMethod
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     # Parser for dealing with RSS feeds.
@@ -9,13 +10,13 @@ module Feedjira
       element :description
       element :link, as: :url
       element :lastBuildDate, as: :last_built
-      elements :"atom10:link", as: :hubs, value: :href, with: { rel: 'hub' }
+      elements :"atom10:link", as: :hubs, value: :href, with: { rel: "hub" }
       elements :item, as: :entries, class: RSSFeedBurnerEntry
 
       attr_accessor :feed_url
 
       def self.able_to_parse?(xml) #:nodoc:
-        (/\<rss|\<rdf/ =~ xml) && (/feedburner/ =~ xml)
+        (/<rss|<rdf/ =~ xml) && (/feedburner/ =~ xml)
       end
     end
   end

data/lib/feedjira/parser/rss_feed_burner_entry.rb

@@ -1,38 +1,18 @@
-# rubocop:disable Style/DocumentationMethod
+# frozen_string_literal: true
+
 module Feedjira
   module Parser
     # Parser for dealing with RDF feed entries.
     class RSSFeedBurnerEntry
       include SAXMachine
       include FeedEntryUtilities
+      include RSSEntryUtilities
 
-      element :title
-
-      element :"feedburner:origLink", as: :url
-      element :link, as: :url
-
-      element :"dc:creator", as: :author
-      element :author, as: :author
-      element :"content:encoded", as: :content
-      element :description, as: :summary
-
-      element :"media:content", as: :image, value: :url
-      element :enclosure, as: :image, value: :url
-
-      element :pubDate, as: :published
-      element :pubdate, as: :published
-      element :"dc:date", as: :published
-      element :"dc:Date", as: :published
-      element :"dcterms:created", as: :published
-
-      element :"dcterms:modified", as: :updated
-      element :issued, as: :published
-      elements :category, as: :categories
-
-      element :guid, as: :entry_id
+      element :"feedburner:origLink", as: :orig_link
+      private :orig_link
 
       def url
-        @url || @link
+        orig_link || super
       end
     end
   end