feedjira 2.1.0 → 2.1.1

data/lib/feedjira/date_time_utilities.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/Documentation
 module Feedjira
   module DateTimeUtilities
     # This is our date parsing heuristic.
@@ -5,20 +6,27 @@ module Feedjira
     DATE_PARSERS = [
       DateTimePatternParser,
       DateTimeLanguageParser,
+      DateTimeEpochParser,
       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)
-      DATE_PARSERS.find do |parser|
+      res = DATE_PARSERS.find do |parser|
         begin
           return parser.parse(string).feed_utils_to_gm_time
-        rescue
+        rescue StandardError => e
+          Feedjira.logger.debug { "Failed to parse date #{string}" }
+          Feedjira.logger.debug(e)
           nil
         end
       end
-      warn "Failed to parse date #{string.inspect}"
+
+      Feedjira.logger.warn { "Failed to parse date #{string}" } if res.nil?
+
+      res
     end
   end
 end

data/lib/feedjira/date_time_utilities/date_time_epoch_parser.rb

@@ -0,0 +1,13 @@
+# rubocop:disable Style/Documentation
+# rubocop:disable Style/DocumentationMethod
+module Feedjira
+  module DateTimeUtilities
+    class DateTimeEpochParser
+      def self.parse(string)
+        epoch_time = string.to_i
+        return Time.at(epoch_time).to_datetime if epoch_time.to_s == string
+        raise "#{string} is not a valid epoch time"
+      end
+    end
+  end
+end

data/lib/feedjira/date_time_utilities/date_time_language_parser.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Style/Documentation
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module DateTimeUtilities
     class DateTimeLanguageParser

data/lib/feedjira/date_time_utilities/date_time_pattern_parser.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Style/Documentation
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module DateTimeUtilities
     class DateTimePatternParser
@@ -7,12 +9,15 @@ module Feedjira
       JAPANESE_SYMBOLS = %w(日 月 火 水 木 金 土).freeze
       PATTERNS = ['%m/%d/%Y %T %p', '%d %m %Y %T %Z'].freeze
 
+      # rubocop:disable Metrics/MethodLength
       def self.parse(string)
         PATTERNS.each do |p|
           begin
             datetime = DateTime.strptime(prepare(string), p)
             return datetime
-          rescue
+          rescue StandardError => e
+            Feedjira.logger.debug("Failed to parse date #{string}")
+            Feedjira.logger.debug(e)
             nil
           end
         end

data/lib/feedjira/feed.rb

@@ -1,95 +1,113 @@
+# rubocop:disable Style/Documentation
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   class Feed
-    def self.parse_with(parser, xml, &block)
-      parser.parse xml, &block
-    end
+    class << self
+      def parse_with(parser, xml, &block)
+        parser.parse xml, &block
+      end
 
-    def self.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 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 self.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 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 self.add_feed_class(klass)
-      feed_classes.unshift klass
-    end
+      def add_feed_class(klass)
+        feed_classes.unshift klass
+      end
 
-    def self.feed_classes
-      @feed_classes ||= [
-        Feedjira::Parser::RSSFeedBurner,
-        Feedjira::Parser::GoogleDocsAtom,
-        Feedjira::Parser::AtomYoutube,
-        Feedjira::Parser::AtomFeedBurner,
-        Feedjira::Parser::Atom,
-        Feedjira::Parser::ITunesRSS,
-        Feedjira::Parser::RSS
-      ]
-    end
+      def feed_classes
+        @feed_classes ||= Feedjira.parsers
+      end
 
-    def self.add_common_feed_element(element_tag, options = {})
-      feed_classes.each do |k|
-        k.element element_tag, options
+      def reset_parsers!
+        @feed_classes = nil
       end
-    end
 
-    def self.add_common_feed_elements(element_tag, options = {})
-      feed_classes.each do |k|
-        k.elements element_tag, options
+      def add_common_feed_element(element_tag, options = {})
+        feed_classes.each do |k|
+          k.element element_tag, options
+        end
       end
-    end
 
-    def self.add_common_feed_entry_element(element_tag, options = {})
-      call_on_each_feed_entry :element, element_tag, options
-    end
+      def add_common_feed_elements(element_tag, options = {})
+        feed_classes.each do |k|
+          k.elements element_tag, options
+        end
+      end
 
-    def self.add_common_feed_entry_elements(element_tag, options = {})
-      call_on_each_feed_entry :elements, element_tag, options
-    end
+      def add_common_feed_entry_element(element_tag, options = {})
+        call_on_each_feed_entry :element, element_tag, options
+      end
 
-    def self.call_on_each_feed_entry(method, *parameters)
-      feed_classes.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
-          end
+      def add_common_feed_entry_elements(element_tag, options = {})
+        call_on_each_feed_entry :elements, element_tag, options
+      end
 
-          collection_configs.each do |config|
-            config.data_class.send(method, *parameters)
+      def call_on_each_feed_entry(method, *parameters)
+        feed_classes.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
+            end
+
+            collection_configs.each do |config|
+              config.data_class.send(method, *parameters)
+            end
           end
         end
       end
-    end
 
-    def self.fetch_and_parse(url)
-      response = connection(url).get
-      unless response.success?
-        raise FetchFailure, "Fetch failed - #{response.status}"
+      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
-      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 :net_http
+        end
+      end
+      # rubocop:enable LineLength
+
+      private
 
-    def self.connection(url)
-      Faraday.new(url: url) do |conn|
-        conn.use FaradayMiddleware::FollowRedirects, limit: 3
-        conn.adapter :net_http
+      def headers
+        {
+          user_agent: Feedjira.user_agent
+        }
+      end
+
+      def request_options
+        {
+          timeout: Feedjira.request_timeout
+        }
       end
-    end
 
-    def self.parse_last_modified(response)
-      DateTime.parse(response.headers['last-modified']).to_time
-    rescue
-      nil
+      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
-    private_class_method :parse_last_modified
   end
 end

data/lib/feedjira/feed_entry_utilities.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Style/Documentation
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module FeedEntryUtilities
     include Enumerable
@@ -9,8 +11,9 @@ module Feedjira
 
     def parse_datetime(string)
       DateTime.parse(string).feed_utils_to_gm_time
-    rescue
-      warn "Failed to parse date #{string.inspect}"
+    rescue StandardError => e
+      Feedjira.logger.warn { "Failed to parse date #{string.inspect}" }
+      Feedjira.logger.warn(e)
       nil
     end
 

data/lib/feedjira/feed_utilities.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Style/Documentation
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module FeedUtilities
     UPDATABLE_ATTRIBUTES = %w(title feed_url url last_modified etag).freeze
@@ -11,7 +13,7 @@ module Feedjira
 
     module ClassMethods
       def parse(xml, &block)
-        xml = xml.lstrip
+        xml = strip_whitespace(xml)
         xml = preprocess(xml) if preprocess_xml
         super xml, &block
       end
@@ -28,6 +30,14 @@ module Feedjira
       def preprocess_xml
         @preprocess_xml
       end
+
+      def strip_whitespace(xml)
+        if Feedjira.strip_whitespace
+          xml.strip
+        else
+          xml.lstrip
+        end
+      end
     end
 
     def last_modified

data/lib/feedjira/parser.rb

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

data/lib/feedjira/parser/atom.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     # Parser for dealing with Atom feeds.

data/lib/feedjira/parser/atom_entry.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     # Parser for dealing with Atom feed entries.

data/lib/feedjira/parser/atom_feed_burner.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     # Parser for dealing with Feedburner Atom feeds.
@@ -7,8 +8,12 @@ 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: { type: 'application/atom+xml' } # rubocop:disable Metrics/LineLength
+      element :link, as: :url_text_html, value: :href,
+                     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 :"atom10:link", as: :feed_url_atom10_link, value: :href,
+                              with: { type: 'application/atom+xml' }
       elements :"atom10:link", as: :hubs, value: :href, with: { rel: 'hub' }
       elements :entry, as: :entries, class: AtomFeedBurnerEntry
 
@@ -16,6 +21,18 @@ module Feedjira
         ((/Atom/ =~ xml) && (/feedburner/ =~ xml) && !(/\<rss|\<rdf/ =~ xml)) || false # rubocop:disable Metrics/LineLength
       end
 
+      # Feed url is <link> with type="text/html" if present,
+      # <link> with no type attribute otherwise
+      def url
+        @url_text_html || url_notype
+      end
+
+      # Feed feed_url is <link> with type="application/atom+xml" if present,
+      # <atom10:link> with type="application/atom+xml" otherwise
+      def feed_url
+        @feed_url_link || feed_url_atom10_link
+      end
+
       def self.preprocess(xml)
         Preprocessor.new(xml).to_xml
       end

data/lib/feedjira/parser/atom_feed_burner_entry.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     # Parser for dealing with Feedburner Atom feed entries.

data/lib/feedjira/parser/atom_youtube.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     # Parser for dealing with RSS feeds.

data/lib/feedjira/parser/atom_youtube_entry.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/Documentation
 module Feedjira
   module Parser
     class AtomYoutubeEntry

data/lib/feedjira/parser/google_docs_atom.rb

@@ -1,5 +1,6 @@
 require File.expand_path('./atom', File.dirname(__FILE__))
-
+# rubocop:disable Style/Documentation
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     class GoogleDocsAtom

data/lib/feedjira/parser/google_docs_atom_entry.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Style/Documentation
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     class GoogleDocsAtomEntry

data/lib/feedjira/parser/itunes_rss.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     # iTunes is RSS 2.0 + some apple extensions

data/lib/feedjira/parser/itunes_rss_category.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     # iTunes extensions to the standard RSS2.0 item

data/lib/feedjira/parser/itunes_rss_owner.rb

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

data/lib/feedjira/parser/podlove_chapter.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Style/Documentation
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     class PodloveChapter

data/lib/feedjira/parser/rss.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     # Parser for dealing with RSS feeds.

data/lib/feedjira/parser/rss_feed_burner.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     # Parser for dealing with RSS feeds.

data/lib/feedjira/parser/rss_feed_burner_entry.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Style/DocumentationMethod
 module Feedjira
   module Parser
     # Parser for dealing with RDF feed entries.