psl-domain-extractor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32657f301009e0fc68ce843cb162292c680a3c336e7351619e1cc6838da5a088
+  data.tar.gz: 81a7d004e40bd6693ec531250f4f19a6da070d3e219d2508f6e0ce2ec6ead9ed
+SHA512:
+  metadata.gz: 56bc8686931f946a280b35f6d9a8fb5f31b18a75bdb8da8275002494ca0c0ca91e22088e9cae520f645e0d110af0bdde4386a32bbb3c2ef31de9353675a2702a
+  data.tar.gz: 4e711eaf219bbd5aec534afbd192a8c8c382ddacb43e98cd5f20dec3d2334a0e1c1f97d488f60a8135fc1c58c814f3d1ff7aeec25306f834226a774febb1f730

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+tu���c���^�ZY
+�i��is��ѓ���B��,fZ�ݪ,*vX�<�����k����g
+-��XmBc\�f�PN|�.rUl�n����&�<Z6���U���y�hb&��)�j	y��9QF�Gjv����f

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v1.0.0
+
+Initial version.

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Ruben Arakelyan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# PSL Domain Extractor
+
+[![Gem Version](https://badge.fury.io/rb/psl-domain-extractor.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/psl-domain-extractor)
+
+This gem provides methods for extracting domains, subdomains and public suffixes from hostnames using the [Public Suffix List](https://publicsuffix.org).
+
+Note this repository contains a submodule in `psl`. To clone the repository, run `git clone --recurse-submodules https://github.com/rubenarakelyan/psl-domain-extractor`.
+
+## Concepts
+
+A `hostname` is what you provide to this gem. For example, `www.example.com` is a hostname. You can then extract the `domain`, `subdomain` or `public suffix`.
+
+A `label` is one part of a `hostname` separated by a dot. For example, the labels for `www.example.com` are `www`, `example` and `com`.
+
+The `domain` is the part of the hostname that is registrable. For example, the domain for `www.example.com` is `example.com` because you could register `example.com` with a domain registrar.
+
+The `subdomain` is the part of the hostname that is under the control of the domain’s registrant. For example, the subdomain for `www.example.com` is `www` because as the registrant for `example.com`, you control `www`. Note that a subdomain may contain multiple labels. For example, the subdomain for `foo.bar.example.com` is `foo.bar`, which is made up of two labels, `foo` and `bar`.
+
+The `public suffix` is the part of the hostname that is allocated to the domain registry and hence not registrable. For example, the `public suffix` for `www.example.com` is `com`. `com` is allocated to the domain registry (in this case, Verisign) and you cannot register it. The `public suffix` is always one level below the `domain`. For example, `co.uk` and `uk` are both a `public suffix` because you can register `example.co.uk` and `example.uk`, but not `co.uk` or `uk`.
+
+### Important note on multi-tenant domains
+
+The actual rules for the public suffix list are more complex than this since they also include wildcards, exceptions, and private multi-tenant domains. This gem takes all those into consideration. For example, Netlify has registered `netlify.app` as a domain name to host apps from multiple customers. `netlify.app` is in the public suffix list. Therefore, even though `netlify.app` is a registrable domain, in this case it is considered the public suffix. A customer’s app at `bar.netlify.app` would be considered the domain (in a sense, this has been registered with Netlify), and for `foo.bar.netlify.app`, the subdomain would be `foo` (not `foo.bar`).
+
+## Getting started
+
+Add to your `Gemfile` then run `bundle install`:
+
+```ruby
+gem "psl-domain-extractor"
+```
+
+or install using `gem`:
+
+```bash
+gem install psl-domain-extractor
+```
+
+## Using with plain Ruby
+
+Extract the domain:
+
+```ruby
+PslDomainExtractor.extract_domain(domain)
+```
+
+Extract the subdomain:
+
+```ruby
+PslDomainExtractor.extract_subdomain(domain)
+```
+
+Extract the public suffix:
+
+```ruby
+PslDomainExtractor.extract_public_suffix(domain)
+```
+
+## Using with a Rails app as the default domain extractor
+
+Add the following to your Rails configuration:
+
+```ruby
+config.action_dispatch.domain_extractor = PslDomainExtractor
+```
+
+`request.domain` and `request.subdomain` will then be set using this gem’s logic.
+
+Of course if you don’t want to change the default logic for domain extraction, you can always call the gem’s standalone methods as required in your app.
+
+## Note on gem signing and verification
+
+This gem is cryptographically signed. To be sure the gem you install hasn’t been tampered with, run:
+```bash
+gem cert --add <(curl -Ls https://raw.github.com/rubenarakelyan/psl-domain-extractor/main/certs/rubena.pem)
+gem install psl-domain-extractor -P MediumSecurity
+```
+
+The `MediumSecurity` trust profile will verify signed gems, but allow the installation of unsigned dependencies.
+
+This is necessary because not all of this gem’s dependencies are signed, so we cannot use `HighSecurity`.
+
+## Licence
+
+This gem is licensed under the [MIT licence](LICENSE).

data/lib/psl-domain-extractor/extractors.rb

@@ -0,0 +1,64 @@
+module PslDomainExtractor
+  class Extractors
+    def initialize(rules)
+      @rules = rules
+    end
+
+    def extract_domain(domain)
+      domain = normalize_domain(domain)
+      return if domain.nil?
+
+      labels = domain.split(".")
+      find_match(labels, labels.length, effective_domain: true)
+    end
+
+    def extract_subdomain(domain)
+      domain = normalize_domain(domain)
+      return if domain.nil?
+
+      labels = domain.split(".")
+      effective_domain = find_match(labels, labels.length, effective_domain: true)
+      effective_domain = domain.gsub(/(\.)?#{effective_domain}/, "")
+
+      effective_domain.empty? ? nil : effective_domain
+    end
+
+    def extract_public_suffix(domain)
+      domain = normalize_domain(domain)
+      return if domain.nil?
+
+      labels = domain.split(".")
+      find_match(labels, labels.length)
+    end
+
+    private
+
+    def normalize_domain(domain)
+      return if domain.nil? || domain.empty?
+
+      domain = domain.downcase.gsub(/(^\.)|(\.$)/, "")
+      return if domain.include?("..") || domain.empty?
+
+      domain
+    end
+
+    def find_match(labels, pos, effective_domain: false)
+      return if pos < 1
+
+      suffix_labels = labels[-pos, pos]
+      suffix = suffix_labels.join(".")
+
+      if @rules.include?("!#{suffix}")
+        return labels[-(pos - 1), pos + 1]&.join(".") || suffix unless effective_domain
+        return suffix if effective_domain
+      end
+
+      match = @rules.include?(suffix) ||
+              (pos > 1 && @rules.include?("*.#{suffix_labels[1, pos - 1].join('.')}"))
+      return suffix if (match || pos == 1) && !effective_domain
+      return labels[-(pos + 1), pos + 1]&.join(".") || suffix if (match || pos == 1) && effective_domain
+
+      find_match(labels, pos - 1, effective_domain:)
+    end
+  end
+end

data/lib/psl-domain-extractor/public_suffix_list.rb

@@ -0,0 +1,17 @@
+module PslDomainExtractor
+  class PublicSuffixList
+    attr_reader :rules
+
+    def initialize(file_path)
+      @rules = Set.new
+      File.open(file_path, "r:utf-8") do |f|
+        f.each_line do |line|
+          line = line.strip
+          next if line.empty? || line.start_with?("//")
+
+          @rules.add(line)
+        end
+      end
+    end
+  end
+end

data/lib/psl-domain-extractor/version.rb

@@ -0,0 +1,3 @@
+module PslDomainExtractor
+  VERSION = "1.0.0".freeze
+end

data/lib/psl-domain-extractor.rb

@@ -0,0 +1,37 @@
+require "psl-domain-extractor/extractors"
+require "psl-domain-extractor/public_suffix_list"
+
+module PslDomainExtractor
+  def self.extract_domain(domain)
+    rules = rules_from_psl_file
+    Extractors.new(rules).extract_domain(domain)
+  end
+
+  def self.extract_subdomain(domain)
+    rules = rules_from_psl_file
+    Extractors.new(rules).extract_subdomain(domain)
+  end
+
+  def self.extract_public_suffix(domain)
+    rules = rules_from_psl_file
+    Extractors.new(rules).extract_public_suffix(domain)
+  end
+
+  # These two methods allow this class to be used with Rails as the domain extractor
+  # for `ActionDispatch`. Add the following to your Rails configuration:
+  # ```ruby
+  # config.action_dispatch.domain_extractor = PslDomainExtractor
+  # ```
+  def self.domain_from(host, _tld_length = nil)
+    extract_domain(host)
+  end
+
+  def self.subdomains_from(host, _tld_length = nil)
+    extract_subdomain(host)
+  end
+
+  def self.rules_from_psl_file
+    PublicSuffixList.new(File.join(__dir__, "..", "psl", "public_suffix_list.dat")).rules
+  end
+  private_class_method :rules_from_psl_file
+end