feedjira 2.2.0 → 3.0.0.beta1

data/lib/feedjira/configuration.rb

@@ -8,12 +8,9 @@ module Feedjira
   #   end
   module Configuration
     attr_accessor(
-      :follow_redirect_limit,
       :logger,
       :parsers,
-      :request_timeout,
       :strip_whitespace,
-      :user_agent
     )
 
     # Modify Feedjira's current configuration
@@ -42,12 +39,9 @@ module Feedjira
 
     # @private
     def set_default_configuration
-      self.follow_redirect_limit = 3
       self.logger = default_logger
       self.parsers = default_parsers
-      self.request_timeout = 30
       self.strip_whitespace = false
-      self.user_agent = "Feedjira #{Feedjira::VERSION}"
     end
 
     private
@@ -55,7 +49,7 @@ module Feedjira
     # @private
     def default_logger
       Logger.new(STDOUT).tap do |logger|
-        logger.progname = 'Feedjira'
+        logger.progname = "Feedjira"
         logger.level = Logger::WARN
       end
     end
@@ -69,7 +63,8 @@ module Feedjira
         Feedjira::Parser::AtomFeedBurner,
         Feedjira::Parser::Atom,
         Feedjira::Parser::ITunesRSS,
-        Feedjira::Parser::RSS
+        Feedjira::Parser::RSS,
+        Feedjira::Parser::JSONFeed,
       ]
     end
   end

data/lib/feedjira/core_ext.rb

@@ -1,3 +1,3 @@
-require 'feedjira/core_ext/time'
-require 'feedjira/core_ext/date'
-require 'feedjira/core_ext/string'
+require "feedjira/core_ext/time"
+require "feedjira/core_ext/date"
+require "feedjira/core_ext/string"

data/lib/feedjira/core_ext/date.rb

@@ -16,6 +16,6 @@ class Date
 
   def feed_utils_to_time(dest, method)
     Time.send(method, dest.year, dest.month, dest.day, dest.hour, dest.min,
-              dest.sec, dest.zone)
+      dest.sec, dest.zone)
   end
 end

data/lib/feedjira/core_ext/time.rb

@@ -1,5 +1,5 @@
-require 'time'
-require 'date'
+require "time"
+require "date"
 
 # rubocop:disable Style/DocumentationMethod
 class Time

data/lib/feedjira/date_time_utilities.rb

@@ -7,14 +7,14 @@ module Feedjira
       DateTimePatternParser,
       DateTimeLanguageParser,
       DateTimeEpochParser,
-      DateTime
+      DateTime,
     ].freeze
 
     # Parse the given string starting with the most common parser (default ruby)
     # and going over all other available parsers
     # rubocop:disable Metrics/MethodLength
     def parse_datetime(string)
-      res = DATE_PARSERS.find do |parser|
+      res = DATE_PARSERS.detect do |parser|
         begin
           return parser.parse(string).feed_utils_to_gm_time
         rescue StandardError => e

data/lib/feedjira/date_time_utilities/date_time_pattern_parser.rb

@@ -7,7 +7,7 @@ module Feedjira
       # Japanese Symbols are required for strange Date Strings like
       # '水, 31 8 2016 07:37:00 PDT'
       JAPANESE_SYMBOLS = %w(日 月 火 水 木 金 土).freeze
-      PATTERNS = ['%m/%d/%Y %T %p', '%d %m %Y %T %Z'].freeze
+      PATTERNS = ["%m/%d/%Y %T %p", "%d %m %Y %T %Z"].freeze
 
       # rubocop:disable Metrics/MethodLength
       def self.parse(string)
@@ -26,7 +26,7 @@ module Feedjira
 
       def self.prepare(string)
         rgx = Regexp.new("^(#{JAPANESE_SYMBOLS.join('|')}),\s")
-        string.gsub(rgx, '')
+        string.gsub(rgx, "")
       end
       private_class_method :prepare
     end

data/lib/feedjira/feed.rb

@@ -3,58 +3,33 @@
 module Feedjira
   class Feed
     class << self
-      def parse_with(parser, xml, &block)
-        parser.parse xml, &block
-      end
-
-      def parse(xml, &block)
-        parser = determine_feed_parser_for_xml(xml)
-        raise NoParserAvailable, 'No valid parser for XML.' unless parser
-        parse_with parser, xml, &block
-      end
-
-      def determine_feed_parser_for_xml(xml)
-        start_of_doc = xml.slice(0, 2000)
-        feed_classes.detect { |klass| klass.able_to_parse?(start_of_doc) }
-      end
-
-      def add_feed_class(klass)
-        feed_classes.unshift klass
-      end
-
-      def feed_classes
-        @feed_classes ||= Feedjira.parsers
-      end
-
-      def reset_parsers!
-        @feed_classes = nil
-      end
-
       def add_common_feed_element(element_tag, options = {})
-        feed_classes.each do |k|
-          k.element element_tag, options
+        Feedjira.parsers.each do |k|
+          k.element(element_tag, options)
         end
       end
 
       def add_common_feed_elements(element_tag, options = {})
-        feed_classes.each do |k|
-          k.elements element_tag, options
+        Feedjira.parsers.each do |k|
+          k.elements(element_tag, options)
         end
       end
 
       def add_common_feed_entry_element(element_tag, options = {})
-        call_on_each_feed_entry :element, element_tag, options
+        call_on_each_feed_entry(:element, element_tag, options)
       end
 
       def add_common_feed_entry_elements(element_tag, options = {})
-        call_on_each_feed_entry :elements, element_tag, options
+        call_on_each_feed_entry(:elements, element_tag, options)
       end
 
+      private
+
       def call_on_each_feed_entry(method, *parameters)
-        feed_classes.each do |klass|
+        Feedjira.parsers.each do |klass|
           klass.sax_config.collection_elements.each_value do |value|
             collection_configs = value.select do |v|
-              v.accessor == 'entries' && v.data_class.class == Class
+              v.accessor == "entries" && v.data_class.class == Class
             end
 
             collection_configs.each do |config|
@@ -63,51 +38,6 @@ module Feedjira
           end
         end
       end
-
-      def fetch_and_parse(url)
-        response = connection(url).get
-        unless response.success?
-          raise FetchFailure, "Fetch failed - #{response.status}"
-        end
-        feed = parse response.body
-        feed.feed_url = url
-        feed.etag = response.headers['etag'].to_s.delete '"'
-
-        feed.last_modified = parse_last_modified(response)
-        feed
-      end
-
-      # rubocop:disable LineLength
-      def connection(url)
-        Faraday.new(url: url, headers: headers, request: request_options) do |conn|
-          conn.use FaradayMiddleware::FollowRedirects, limit: Feedjira.follow_redirect_limit
-          conn.adapter(*Faraday.default_adapter)
-        end
-      end
-      # rubocop:enable LineLength
-
-      private
-
-      def headers
-        {
-          user_agent: Feedjira.user_agent
-        }
-      end
-
-      def request_options
-        {
-          timeout: Feedjira.request_timeout
-        }
-      end
-
-      def parse_last_modified(response)
-        lm = response.headers['last-modified']
-        DateTime.parse(lm).to_time
-      rescue StandardError => e
-        Feedjira.logger.warn { "Failed to parse last modified '#{lm}'" }
-        Feedjira.logger.debug(e)
-        nil
-      end
     end
   end
 end

data/lib/feedjira/feed_entry_utilities.rb

@@ -13,7 +13,7 @@ module Feedjira
       DateTime.parse(string).feed_utils_to_gm_time
     rescue StandardError => e
       Feedjira.logger.warn { "Failed to parse date #{string.inspect}" }
-      Feedjira.logger.debug(e)
+      Feedjira.logger.warn(e)
       nil
     end
 
@@ -28,14 +28,14 @@ module Feedjira
     # Writer for published. By default, we keep the "oldest" publish time found.
     def published=(val)
       parsed = parse_datetime(val)
-      @published = parsed if parsed && (!@published || parsed < @published)
+      @published = parsed if !@published || parsed < @published
     end
 
     ##
     # Writer for updated. By default, we keep the most recent update time found.
     def updated=(val)
       parsed = parse_datetime(val)
-      @updated = parsed if parsed && (!@updated || parsed > @updated)
+      @updated = parsed if !@updated || parsed > @updated
     end
 
     def sanitize!
@@ -52,7 +52,7 @@ module Feedjira
       @rss_fields ||= instance_variables
 
       @rss_fields.each do |field|
-        yield(field.to_s.sub('@', ''), instance_variable_get(field))
+        yield(field.to_s.sub("@", ""), instance_variable_get(field))
       end
     end
 

data/lib/feedjira/parser.rb

@@ -1 +1,4 @@
-module Feedjira::Parser; end # rubocop:disable Style/Documentation
+module Feedjira
+  module Parser
+  end
+end

data/lib/feedjira/parser/atom.rb

@@ -8,10 +8,10 @@ module Feedjira
 
       element :title
       element :subtitle, as: :description
-      element :link, as: :url, value: :href, with: { type: 'text/html' }
-      element :link, as: :feed_url, value: :href, with: { rel: 'self' }
+      element :link, as: :url, value: :href, with: { type: "text/html" }
+      element :link, as: :feed_url, value: :href, with: { rel: "self" }
       elements :link, as: :links, value: :href
-      elements :link, as: :hubs, value: :href, with: { rel: 'hub' }
+      elements :link, as: :hubs, value: :href, with: { rel: "hub" }
       elements :entry, as: :entries, class: AtomEntry
 
       def self.able_to_parse?(xml)

data/lib/feedjira/parser/atom_entry.rb

@@ -7,7 +7,7 @@ module Feedjira
       include FeedEntryUtilities
 
       element :title
-      element :link, as: :url, value: :href, with: { type: 'text/html', rel: 'alternate' } # rubocop:disable Metrics/LineLength
+      element :link, as: :url, value: :href, with: { type: "text/html", rel: "alternate" } # rubocop:disable Metrics/LineLength
       element :name, as: :author
       element :content
       element :summary

data/lib/feedjira/parser/atom_feed_burner.rb

@@ -9,12 +9,12 @@ module Feedjira
       element :title
       element :subtitle, as: :description
       element :link, as: :url_text_html, value: :href,
-                     with: { type: 'text/html' }
+                     with: { type: "text/html" }
       element :link, as: :url_notype, value: :href, with: { type: nil }
-      element :link, as: :feed_url_link, value: :href, with: { type: 'application/atom+xml' } # rubocop:disable Metrics/LineLength
+      element :link, as: :feed_url_link, value: :href, with: { type: "application/atom+xml" } # rubocop:disable Metrics/LineLength
       element :"atom10:link", as: :feed_url_atom10_link, value: :href,
-                              with: { type: 'application/atom+xml' }
-      elements :"atom10:link", as: :hubs, value: :href, with: { rel: 'hub' }
+                              with: { type: "application/atom+xml" }
+      elements :"atom10:link", as: :hubs, value: :href, with: { rel: "hub" }
       elements :entry, as: :entries, class: AtomFeedBurnerEntry
 
       attr_writer :url, :feed_url

data/lib/feedjira/parser/atom_feed_burner_entry.rb

@@ -8,7 +8,7 @@ module Feedjira
 
       element :title
       element :name, as: :author
-      element :link, as: :url, value: :href, with: { type: 'text/html', rel: 'alternate' } # rubocop:disable Metrics/LineLength
+      element :link, as: :url, value: :href, with: { type: "text/html", rel: "alternate" } # rubocop:disable Metrics/LineLength
       element :"feedburner:origLink", as: :url
       element :summary
       element :content

data/lib/feedjira/parser/atom_youtube.rb

@@ -6,8 +6,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

@@ -6,7 +6,7 @@ module Feedjira
       include FeedEntryUtilities
 
       element :title
-      element :link, as: :url, value: :href, with: { rel: 'alternate' }
+      element :link, as: :url, value: :href, with: { rel: "alternate" }
       element :name, as: :author
       element :"media:description", as: :content
       element :summary

data/lib/feedjira/parser/google_docs_atom.rb

@@ -1,4 +1,4 @@
-require File.expand_path('./atom', File.dirname(__FILE__))
+require File.expand_path("./atom", File.dirname(__FILE__))
 # rubocop:disable Style/Documentation
 # rubocop:disable Style/DocumentationMethod
 module Feedjira
@@ -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" } # rubocop:disable Metrics/LineLength
       elements :link, as: :links, value: :href
       elements :entry, as: :entries, class: GoogleDocsAtomEntry
 

data/lib/feedjira/parser/google_docs_atom_entry.rb

@@ -7,7 +7,7 @@ module Feedjira
       include FeedEntryUtilities
 
       element :title
-      element :link, as: :url, value: :href, with: { type: 'text/html', rel: 'alternate' } # rubocop:disable Metrics/LineLength
+      element :link, as: :url, value: :href, with: { type: "text/html", rel: "alternate" } # rubocop:disable Metrics/LineLength
       element :name, as: :author
       element :content
       element :summary

data/lib/feedjira/parser/itunes_rss_item.rb

@@ -34,7 +34,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 # rubocop:disable Metrics/LineLength
 
       # Podlove requires clients to re-order by start time in the
       # event the publisher doesn't provide them in that

data/lib/feedjira/parser/json_feed.rb

@@ -0,0 +1,39 @@
+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,51 @@
+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