final_redirect_url 0.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f25dc104a0c41353b83a49d45abd4146fe306b6d
-  data.tar.gz: 8ec79086342e96fec99c9ff81e2b71122021e95e
+SHA256:
+  metadata.gz: 522f5bf5f63725bfacfd9615a3b37ae003e42712a9663fd5f7af11b8ce2c2f52
+  data.tar.gz: b25c7ff42bade483244d24c1642da9097cd930326f6ebbee4f1e1aba5e854699
 SHA512:
-  metadata.gz: 91de374d15554f862bf75ca659e1f4f69d1425d3df59f95f382d19150d896308ed4462e95278412a54eca21bdb8aba25160f6456f4cdd3d531817b11776d142f
-  data.tar.gz: 73b1cc9a2031fdb1a744957f13ce4707a46e8a26b3307341ad4fa01730cb786f1a44ea8c848e05e0873151f61294b4af95c3c08fac9c48859e433866a201ad6c
+  metadata.gz: bafed8a367867eee62492c7f101682595a7a0c37736e3d71e7e79b29f0716c962b5e00af2ef3c5338148fb7e2e533a003a8e20b42dc852dbd0fa16d866b30514
+  data.tar.gz: e3dd7b15536e3e4bdcccfed12b227042707c6134f64f32d8045f86dd9c015ed1d5dfd05e119673416a1bd97efd0d4d79a7863e929adb893685fef2e1d429982e

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [master, main, "feature/**"]
+  pull_request:
+    branches: [master, main]
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/bundle
 
 # rspec failure tracking
 .rspec_status

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [2.0.0] – 2026-11-05
+
+### Breaking Changes
+- **Minimum Ruby version raised to 3.0.** Ruby 2.x is no longer supported.
+- Private helper methods (`valid_url?`, `resolve_redirects`, `fetch_response`, `absolute_url`) are now
+  truly private (defined inside `class << self` with `private`). Calling them from outside the module
+  now raises `NoMethodError`. This was always the intended behaviour; previous versions accidentally
+  exposed them as public singleton methods (fixes [#4][i4]).
+
+### Added
+- **GitHub Actions CI** replacing the removed Travis CI configuration. The matrix tests Ruby 3.0,
+  3.1, 3.2, and 3.3 on every push and pull request.
+- **WebMock** test dependency — the full test suite now runs without any real network connections.
+- `CHANGELOG.md` (this file).
+- Gem metadata fields (`homepage_uri`, `source_code_uri`, `changelog_uri`).
+
+### Fixed
+- **Port numbers are now preserved** in final URLs. For example,
+  `final_redirect_url("http://localhost:3000/path")` now correctly returns
+  `"http://localhost:3000/path"` instead of `"http://localhost/path"` (fixes [#6][i6]).
+- **Redirect depth limit now works correctly.** When the hop limit was reached the gem previously
+  returned a bare `String` to `url_string_from_uri`, causing a `NoMethodError`. The limit guard now
+  returns the current `URI` object (fixes [#2][i2]).
+- **Relative-path redirects now carry forward the original host's port.** The gem uses `URI.join`
+  instead of manual string concatenation, so a redirect `Location: /new-path` from
+  `http://localhost:3000/old-path` resolves to `http://localhost:3000/new-path`.
+- **Non-redirect, non-200 responses** (403, 404, 500 …) are now handled gracefully: the gem returns
+  the last reachable URL rather than crashing with a `TypeError` on a nil `Location` header.
+- **HTTPS support** — connections now set `use_ssl = true` when the scheme is `https`. Previously
+  only plain-HTTP URLs worked.
+- **`URI::regexp` removed** — the old `is_valid_url?` used the deprecated (and Ruby-3.x-removed)
+  `URI::regexp`. Replaced with `URI.parse` + `URI::HTTP` class check.
+- **`rescue Exception`** replaced with `rescue StandardError` to avoid masking signals and other
+  non-recoverable errors.
+- **`$stdout`** used instead of bare `STDOUT` constant (style/frozen-string consistency).
+
+### Changed
+- Switched from `Net::HTTP.get_response` (GET) to explicit `Net::HTTP::Head` requests. HEAD is
+  sufficient for redirect resolution and avoids downloading response bodies.
+- Added `open_timeout` and `read_timeout` (10 s each) to prevent indefinite hangs.
+- Added a `User-Agent` header so servers that require it don't return unexpected responses.
+
+### Known Limitations
+- JavaScript- and AMP-based redirects (e.g. certain Google News AMP URLs — [#3][i3]) require a
+  headless browser and are outside the scope of this gem. The gem returns the last HTTP-level
+  reachable URL in such cases.
+
+[2.0.0]: https://github.com/indyarocks/final_redirect_url/compare/v0.1.1...v2.0.0
+[i2]: https://github.com/indyarocks/final_redirect_url/issues/2
+[i3]: https://github.com/indyarocks/final_redirect_url/issues/3
+[i4]: https://github.com/indyarocks/final_redirect_url/issues/4
+[i6]: https://github.com/indyarocks/final_redirect_url/issues/6

data/README.md

@@ -1,6 +1,13 @@
 # FinalRedirectUrl
 
-Ruby gem to get a final redirect url for any given url.
+[![CI](https://github.com/indyarocks/final_redirect_url/actions/workflows/ci.yml/badge.svg)](https://github.com/indyarocks/final_redirect_url/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/final_redirect_url.svg)](https://badge.fury.io/rb/final_redirect_url)
+
+Ruby gem that follows HTTP/HTTPS redirects and returns the final destination URL.
+
+## Requirements
+
+- Ruby >= 3.0
 
 ## Installation
 
@@ -10,30 +17,55 @@ Add this line to your application's Gemfile:
 gem 'final_redirect_url'
 ```
 
-And then execute:
+Then run:
 
-    $ bundle
+```
+$ bundle install
+```
 
-Or install it yourself as:
+Or install directly:
 
-    $ gem install final_redirect_url
+```
+$ gem install final_redirect_url
+```
 
 ## Usage
 
-Usually the gem checks for redirect upto 10 depth level. However you can pass `{depth: 20}` to check redirects upto `20` depth.
+The input URL **must** include the `http://` or `https://` scheme.
 
-## Development
+```ruby
+require 'final_redirect_url'
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# Simple redirect following
+FinalRedirectUrl.final_redirect_url('http://google.com')
+# => "https://www.google.com/"
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+# Ports are preserved
+FinalRedirectUrl.final_redirect_url('http://localhost:3000/items/42')
+# => "http://localhost:3000/items/42"
 
-## Contributing
+# Custom redirect depth (default: 10)
+FinalRedirectUrl.final_redirect_url('http://example.com', depth: 5)
+# => "http://final.example.com/"
+
+# Invalid / missing protocol → empty string
+FinalRedirectUrl.final_redirect_url('www.example.com')
+# => ""
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/indyarocks/final_redirect_url. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+## Limitations
 
+- **JavaScript / AMP redirects** (e.g. some Google News AMP URLs) are not followed. These require a
+  headless browser. The gem returns the last HTTP-reachable URL in such cases.
+- Redirects are followed using HTTP `HEAD` requests. Servers that reject `HEAD` with `405 Method Not Allowed`
+  may not resolve correctly.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/indyarocks/final_redirect_url>.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/final_redirect_url.gemspec

@@ -1,37 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'final_redirect_url/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "final_redirect_url"
+  spec.name          = 'final_redirect_url'
   spec.version       = FinalRedirectUrl::VERSION
-  spec.authors       = ["Chandan Jhunjhunwal"]
-  spec.email         = ["chandan.jhun@gmail.com"]
+  spec.authors       = ['Chandan Jhunjhunwal']
+  spec.email         = ['chandan.jhun@gmail.com']
 
-  spec.summary       = %q{Get a final redirect url for a given url.}
-  spec.description   = %q{A URL might have multiple redirects. The objective of this gem is to
-                         extract the final redirected url.}
-  spec.homepage      = "https://github.com/indyarocks/final_redirect_url"
-  spec.license       = "MIT"
+  spec.summary       = 'Get the final redirect URL for any given URL.'
+  spec.description   = 'Follows HTTP redirects (including HTTPS, relative paths, and ' \
+                       'non-standard ports) to resolve the final destination URL.'
+  spec.homepage      = 'https://github.com/indyarocks/final_redirect_url'
+  spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  # if spec.respond_to?(:metadata)
-  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against " \
-  #     "public gem pushes."
-  # end
+  spec.required_ruby_version = '>= 3.0'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri']   = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  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']
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake',    '~> 13.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
 end

data/lib/final_redirect_url/version.rb

@@ -1,3 +1,3 @@
 module FinalRedirectUrl
-  VERSION = "0.1.0"
+  VERSION = '2.0.0'
 end

data/lib/final_redirect_url.rb

@@ -1,50 +1,90 @@
 require 'final_redirect_url/version'
 require 'net/http'
+require 'net/https'
+require 'uri'
 require 'logger'
 
 module FinalRedirectUrl
+  DEFAULT_DEPTH = 10
+  USER_AGENT = "FinalRedirectUrl/#{VERSION} (+https://github.com/indyarocks/final_redirect_url)".freeze
 
-  def self.final_redirect_url(url, options={})
-    final_url = ''
-    if is_valid_url?(url)
-      begin
-        redirect_lookup_depth = options[:depth].to_i > 0 ? options[:depth].to_i : 10
-        response_uri = get_final_redirect_url(url, redirect_lookup_depth)
-        final_url =  url_string_from_uri(response_uri)
-      rescue Exception => ex
-        logger = Logger.new(STDOUT)
-        logger.error(ex.message)
-      end
+  class << self
+    # Resolves all HTTP/HTTPS redirects for the given URL and returns the final
+    # destination as a string. Returns an empty string for invalid input or on
+    # unrecoverable network errors.
+    #
+    # @param url [String] the starting URL (must include http:// or https://)
+    # @param options [Hash]
+    # @option options [Integer] :depth maximum redirect hops (default: 10)
+    # @return [String]
+    def final_redirect_url(url, options = {})
+      return '' unless valid_url?(url)
+
+      limit = options.fetch(:depth, DEFAULT_DEPTH).to_i
+      limit = DEFAULT_DEPTH unless limit.positive?
+
+      resolve_redirects(url, limit).to_s
+    rescue StandardError => ex
+      Logger.new($stdout).error(ex.message)
+      ''
     end
-    final_url
-  end
 
-  private
-  def self.is_valid_url?(url)
-    url.to_s =~ /\A#{URI::regexp(['http', 'https'])}\z/
-  end
+    private
+
+    # Returns true only for syntactically valid HTTP/HTTPS URLs.
+    # Fixes issue #4: private via class << self so the method is genuinely
+    # inaccessible from outside the module.
+    def valid_url?(url)
+      uri = URI.parse(url.to_s)
+      uri.is_a?(URI::HTTP)
+    rescue URI::InvalidURIError
+      false
+    end
 
-  def self.get_final_redirect_url(url, limit = 10)
-    uri = URI.parse(url)
-    response = ::Net::HTTP.get_response(uri)
-    if response.class == Net::HTTPOK
-      return uri
-    else
-      redirect_location = response['location']
-      location_uri = URI.parse(redirect_location)
-      if location_uri.host.nil?
-        redirect_location = uri.scheme + '://' + uri.host + redirect_location
+    # Recursively follows redirects up to +limit+ hops.
+    # Fixes issue #2: when the hop limit is reached, returns the current URI
+    # (a proper URI object, not a bare string) so url_string_from_uri never
+    # receives a plain String.
+    # Fixes issue #6: uses URI.join to build absolute redirect targets, which
+    # preserves non-standard ports from the base URI (e.g. localhost:3000).
+    def resolve_redirects(url, limit)
+      uri = URI.parse(url)
+      return uri if limit <= 0
+
+      response = fetch_response(uri)
+
+      case response
+      when Net::HTTPOK
+        uri
+      when Net::HTTPRedirection
+        location = response['location']
+        warn "redirected to #{location}"
+        resolve_redirects(absolute_url(uri, location), limit - 1)
+      else
+        # Non-redirect, non-200 response (e.g. 404, 403, 500): return the
+        # current URI rather than trying to follow a missing Location header.
+        uri
       end
-      warn "redirected to #{redirect_location}"
-      get_final_redirect_url(redirect_location, limit - 1)
     end
-  end
 
-  def self.url_string_from_uri(uri)
-    url_str = "#{uri.scheme}://#{uri.host}#{uri.request_uri}"
-    if uri.fragment
-      url_str = url_str + "##{uri.fragment}"
+    # Opens an HTTP/HTTPS connection and fires a HEAD request.
+    # HEAD is sufficient for redirect resolution and avoids downloading bodies.
+    def fetch_response(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl     = (uri.scheme == 'https')
+      http.open_timeout = 10
+      http.read_timeout = 10
+
+      request = Net::HTTP::Head.new(uri.request_uri)
+      request['User-Agent'] = USER_AGENT
+
+      http.request(request)
+    end
+
+    # Converts a potentially relative +location+ into an absolute URL,
+    # keeping the scheme, host, and port of +base_uri+.
+    def absolute_url(base_uri, location)
+      URI.join(base_uri.to_s, location).to_s
     end
-    url_str
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: final_redirect_url
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Chandan Jhunjhunwal
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2026-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,18 +52,33 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: |-
-  A URL might have multiple redirects. The objective of this gem is to
-                           extract the final redirected url.
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Follows HTTP redirects (including HTTPS, relative paths, and non-standard
+  ports) to resolve the final destination URL.
 email:
 - chandan.jhun@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -77,8 +92,11 @@ files:
 homepage: https://github.com/indyarocks/final_redirect_url
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/indyarocks/final_redirect_url
+  source_code_uri: https://github.com/indyarocks/final_redirect_url
+  changelog_uri: https://github.com/indyarocks/final_redirect_url/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,16 +104,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
-summary: Get a final redirect url for a given url.
+summary: Get the final redirect URL for any given URL.
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.14.6