feedbag 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43f044f914e64cb4abe7875271264f04d32c31730794340d41c116eb7e558b47
-  data.tar.gz: 61573a0de3b81e8bed311bd4049519034f8d8345b6612f8d82a8599f665698e1
+  metadata.gz: aed91daea08560f45514eb565a8f5524a02bb39cff16acec30d4fcbf72113944
+  data.tar.gz: a873374c6b527f7d55c582fe7126e6c6d26f873828a4f5bf804316d7c113218c
 SHA512:
-  metadata.gz: 375f6073c54ca181cca5277742a1b0353349d7aa6bf1a1491639cc5dc647903af8043aaedc28c0d16cf3ea263cf1bf1844928e7eb2b740da7f2618834780452f
-  data.tar.gz: 391142db8443a2601a7696868824027f791feaf13c7a585adc319722f1ae2ddaad4d36b23f8478e5d86fd20400ce721092d7c579f933916245cfe836c4d19a58
+  metadata.gz: a512e9f8d6e3994d14812681631faa38eb38d164d09b8fe5c8adb2f754a4728460e93079d01048c89e65c4f929276268fde16bc88b18cfa4d9736b411d94b219
+  data.tar.gz: c8be3cae759ded40c08737dea5b3547c0f7a9e9fd5a2403bd5cda280bae8af69227edbb34ecfc1a72b17931acb35935605f9cd682808bdd575383ff05bf0144f

data/README.markdown

@@ -1,7 +1,7 @@
 Feedbag
 =======
 
-Feedbag is Ruby's favorite auto-discovery tool/library!
+Feedbag is Ruby's favorite feed auto-discovery tool/library!
 
 ### Quick synopsis
 
@@ -10,9 +10,9 @@ Feedbag is Ruby's favorite auto-discovery tool/library!
 => true
 >> Feedbag.find "damog.net/blog"
 => ["http://damog.net/blog/atom.xml"]
->> Feedbag.feed? "perl.org"
+>> Feedbag.feed? "google.com"
 => false
->> Feedbag.feed?("https://m.signalvnoise.com/feed")
+>> Feedbag.feed?("https://daringfireball.net/feeds/main")
 => true
 ```
 
@@ -28,38 +28,62 @@ You can also use the command line tool for quick queries, if you install the gem
 
     » feedbag https://www.ruby-lang.org/en/
     == https://www.ruby-lang.org/en/:
-    - https://www.ruby-lang.org/en/feeds/news.rss
+     - https://www.ruby-lang.org/en/feeds/news.rss
     
 
 ### Usage
-Feedbag will find all RSS feed types.  Here's an example of finding ATOM and JSON Feed
+
+Feedbag will find RSS, Atom, and JSON feed types:
 
 ```ruby
-> Feedbag.find('https://daringfireball.net')
-=> ["https://daringfireball.net/feeds/main", "https://daringfireball.net/feeds/json", "https://daringfireball.net/linked/2021/02/17/bookfeed"]
+>> Feedbag.find('https://daringfireball.net')
+=> ["https://daringfireball.net/feeds/main", "https://daringfireball.net/feeds/json"]
 ```
 
-Feedbag defaults to a User-Agent string of **Feedbag/1.10.2**, however you can override this
+#### Custom User-Agent
+
+Feedbag defaults to a User-Agent string of `Feedbag/VERSION`, but you can override it:
 
 ```ruby
-0> Feedbag.find('https://kottke.org', 'User-Agent' => "My Personal Agent/1.0.1")
-=> ["http://feeds.kottke.org/main", "http://feeds.kottke.org/json"]
-````
+>> Feedbag.find('https://kottke.org', 'User-Agent' => "My Personal Agent/1.0.1")
+=> ["http://feeds.kottke.org/main"]
+```
 
-The other options passed to find, will be passed to OpenURI. For example:
+Other options passed to `find` will be forwarded to OpenURI:
 
 ```ruby
-Feedbag.find("https://kottke.org", 'User-Agent' => "My Personal Agent/1.0.1", open_timeout: 1000)
+Feedbag.find("https://example.com", 'User-Agent' => "My Agent/1.0", open_timeout: 10)
 ```
 
-You can find the other options to OpenURI [here](https://rubyapi.org/o/openuri/openread#method-i-open).
+See [OpenURI options](https://rubyapi.org/o/openuri/openread#method-i-open) for more details.
+
+#### Custom Logger
+
+By default, errors are written to `$stderr`. You can redirect them to a custom logger:
+
+```ruby
+# Use Rails logger
+Feedbag.logger = Rails.logger
 
+# Or silence all output
+Feedbag.logger = Logger.new('/dev/null')
+```
+
+#### Non-ASCII URL Support
+
+Feedbag handles internationalized URLs (IRIs) with non-ASCII characters:
+
+```ruby
+>> Feedbag.find("https://example.com/中文/feed/")
+# Works! URLs are automatically normalized
+```
 
 ### Why should you use it?
 
-- Because it only uses [Nokogiri](http://nokogiri.org/) as dependency.
+- Because it only uses [Nokogiri](http://nokogiri.org/) and [Addressable](https://github.com/sporkmonger/addressable) as dependencies.
 - Because it follows modern feed filename conventions (like those ones used by WordPress blogs, or Blogger, etc).
 - Because it's a single file you can embed easily in your application.
+- Because it handles international URLs with non-ASCII characters.
 - Because it's faster than anything else.
 
 ### Author

data/lib/feedbag.rb

@@ -6,9 +6,41 @@ require "rubygems"
 require "nokogiri"
 require "open-uri"
 require "net/http"
+require "logger"
+
+begin
+  require "addressable/uri"
+rescue LoadError
+  # addressable will be loaded after bundle install
+end
 
 class Feedbag
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
+
+  # Configurable logger for error output
+  # Default writes to $stderr. Can be set to Rails.logger or any Logger-compatible object.
+  #
+  # @example Silence all output
+  #   Feedbag.logger = Logger.new('/dev/null')
+  #
+  # @example Use Rails logger
+  #   Feedbag.logger = Rails.logger
+  #
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= default_logger
+    end
+
+    private
+
+    def default_logger
+      logger = Logger.new($stderr)
+      logger.formatter = proc { |severity, _datetime, _progname, msg| "#{msg}\n" }
+      logger
+    end
+  end
   CONTENT_TYPES = [
     'application/x.atom+xml',
     'application/atom+xml',
@@ -25,7 +57,7 @@ class Feedbag
   end
 
   def self.find(url, options = {})
-    new(options: options).find(url, **options)
+    new(options: options).find(url, options)
   end
 
   def initialize(options: nil)
@@ -34,9 +66,23 @@ class Feedbag
     @options["User-Agent"] ||= "Feedbag/#{VERSION}"
   end
 
+  # Normalize a URL to handle non-ASCII characters (IRIs)
+  # This converts internationalized URLs to valid ASCII URIs
+  def self.normalize_url(url)
+    return url if url.nil? || url.empty?
+    if defined?(Addressable::URI)
+      Addressable::URI.parse(url).normalize.to_s
+    else
+      url
+    end
+  rescue Addressable::URI::InvalidURIError
+    url
+  end
+
   def feed?(url)
-    # use LWR::Simple.normalize some time
-    url_uri = URI.parse(url)
+    # Normalize URL to handle non-ASCII characters
+    normalized_url = Feedbag.normalize_url(url)
+    url_uri = URI.parse(normalized_url)
     url = "#{url_uri.scheme or 'http'}://#{url_uri.host}#{url_uri.path}"
     url << "?#{url_uri.query}" if url_uri.query
 
@@ -52,7 +98,9 @@ class Feedbag
   end
 
   def find(url, options = {})
-    url_uri = URI.parse(url)
+    # Normalize URL to handle non-ASCII characters
+    normalized_url = Feedbag.normalize_url(url)
+    url_uri = URI.parse(normalized_url)
     url = nil
     if url_uri.scheme.nil?
       url = "http://#{url_uri.to_s}"
@@ -76,11 +124,11 @@ class Feedbag
       # TODO: actually find out timeout. use Terminator?
       # $stderr.puts "Feed looked like feed but might not have passed validation or timed out"
     rescue => ex
-      $stderr.puts "#{ex.class} error occurred with: `#{url}': #{ex.message}"
+      Feedbag.logger.error "#{ex.class} error occurred with: `#{url}': #{ex.message}"
     end
 
     begin
-      html = URI.open(url, **@options) do |f|
+      html = URI.open(url, @options) do |f|
         content_type = f.content_type.downcase
         if content_type == "application/octet-stream" # open failed
           content_type = f.meta["content-type"].gsub(/;.*$/, '')
@@ -135,13 +183,13 @@ class Feedbag
         end
       end
     rescue Timeout::Error => err
-      $stderr.puts "Timeout error occurred with `#{url}: #{err}'"
+      Feedbag.logger.error "Timeout error occurred with `#{url}: #{err}'"
     rescue OpenURI::HTTPError => the_error
-      $stderr.puts "Error occurred with `#{url}': #{the_error}"
+      Feedbag.logger.error "Error occurred with `#{url}': #{the_error}"
     rescue SocketError => err
-      $stderr.puts "Socket error occurred with: `#{url}': #{err}"
+      Feedbag.logger.error "Socket error occurred with: `#{url}': #{err}"
     rescue => ex
-      $stderr.puts "#{ex.class} error occurred with: `#{url}': #{ex.message}"
+      Feedbag.logger.error "#{ex.class} error occurred with: `#{url}': #{ex.message}"
     ensure
       return @feeds
     end
@@ -160,19 +208,24 @@ class Feedbag
     # puts "#{feed_url} - #{orig_url}"
     url = feed_url.sub(/^feed:/, '').strip
 
+    # Normalize URL to handle non-ASCII characters
+    url = Feedbag.normalize_url(url)
+
     if base_uri
       #	url = base_uri + feed_url
-      url = URI.parse(base_uri).merge(feed_url).to_s
+      normalized_base = Feedbag.normalize_url(base_uri)
+      url = URI.parse(normalized_base).merge(url).to_s
     end
 
     begin
       uri = URI.parse(url)
-    rescue
-      puts "Error with `#{url}'"
-      exit 1
+    rescue => ex
+      Feedbag.logger.error "Error parsing URL `#{url}': #{ex.message}"
+      return
     end
     unless uri.absolute?
-      orig = URI.parse(orig_url)
+      normalized_orig = Feedbag.normalize_url(orig_url)
+      orig = URI.parse(normalized_orig)
       url = orig.merge(url).to_s
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feedbag
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - David Moreno
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2025-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -48,22 +62,22 @@ dependencies:
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -138,7 +152,7 @@ homepage: http://github.com/damog/feedbag
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--main"
 - README.markdown
@@ -155,8 +169,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: RSS/Atom feed auto-discovery tool
 test_files: []