sxg_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36798f6fd5461309de602122e726814a47c484bcf798260796f2b74726d158d4
+  data.tar.gz: 6ececedef77191f20b4b15d9b32faf84837af6e8f3c03ab87f87cfde1a6d2229
+SHA512:
+  metadata.gz: f33f3769f4f2a2671d10434800e0b6d247d7088f98535ab8bda5175f78ab3f1a411f3669f32a95a490254fffb835b791d49691311d3769b51cca607e2fe97e10
+  data.tar.gz: 7ace8929013bf4681de47150ec6ea9f5e92b535eca33da5aac72293339ddbb64fbcaca477a798ba6af14e344c25193c494182348e1d9f2255dd617cd4d4e8668

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-08
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Paweł Pokrywka
+
+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,108 @@
+# SXG Checker
+
+[![Gem Version](https://badge.fury.io/rb/sxg_checker.svg)](https://badge.fury.io/rb/sxg_checker)
+
+A library and command-line tool for checking the Google SXG cache for the presence of a document and its subresources.
+
+It verifies if your web page and its resources are properly available in Google's Signed Exchanges (SXG) cache,
+helping you troubleshoot SXG implementation issues with detailed status reporting for each resource.
+
+## Status indicators
+
+| Symbol | Status | Description |
+|--------|---------|-------------|
+| ✓ | ok | Resource exists and is valid |
+| ? | missing | Resource not found in SXG cache |
+| x | invalid | Resource exists but its signature is invalid |
+| ! | parsing_error | Unable to parse the SXG resource |
+| ~ | links_mismatch | The subresources specified in SXG don't match subresources to be prefetched from SXG cache |
+| ≠ | integrity_mismatch | Subresource integrity hash mismatch |
+
+## Installation
+
+Make sure to install [dump-signedexchange](https://github.com/WICG/webpackage/blob/main/go/signedexchange/README.md).
+
+If you intend to use it as a library for your app, add to your `Gemfile`:
+```ruby
+gem "sxg_checker"
+```
+
+Otherwise, to make the command-line tool available to all users in the system, run:
+```shell
+sudo gem install sxg_checker
+```
+
+If you prefer to make it available to yourself only, execute instead:
+```shell
+gem install --user-install sxg_checker
+```
+
+In case of user-specific installation, make sure to add the directory containing the executable to your `$PATH`.
+You can find the executable location by running:
+
+```shell
+gem contents sxg_checker | grep sxg-checker
+```
+
+## Usage
+
+### Command line
+
+To check a URL in Google's SXG cache:
+
+```shell
+sxg-checker https://www.yourwebsite.com/your-page
+```
+
+If you installed the `dump-signedexchange` binary somewhere other than `~/go/bin/dump-signedexchange`, specify the
+path in the `DSXG_PATH` environment variable:
+
+```shell
+DSXG_PATH=/usr/local/bin/dump-signedexchange sxg-checker https://www.yourwebsite.com/your-page
+```
+
+### In Ruby applications
+
+You can also use SXG Checker as a library in your Ruby applications:
+
+```ruby
+require 'sxg_checker'
+
+checker = SxgChecker::Checker.new(tool: '/usr/local/bin/dump-signedexchange') # The `tool` parameter is optional
+result = checker.call(url)
+
+# Access the results
+puts result.url    # The URL of the cached document
+puts result.status # The status symbol (:ok, :missing, etc.)
+
+# Iterate through subresources
+result.subresources.each do |subresource|
+  puts "#{subresource.url}: #{subresource.status}"
+end
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To build the gem, run `bundle exec rake build`. 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 the created tag,
+and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/pepawel/sxg_checker].
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere
+to the code of conduct.
+
+## Author
+
+My name is Paweł Pokrywka and I'm the author of SXG Checker.
+
+If you want to contact me or get to know me better, check out
+[my blog](https://www.pawelpokrywka.com).
+
+## License
+
+The software is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]
+
+Rake::Task.define_task :validate_loader do
+  abort "Basic loader is stale, run `bin/loader generate` to fix" unless system("bin/loader validate")
+end
+
+Rake::Task[:build].enhance [:validate_loader]

data/exe/sxg-checker

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "sxg_checker"
+
+exe_name = File.basename($0)
+cli = SxgChecker::Cli.new(exe_name)
+cli.call(ARGV[0])

data/lib/basic_loader.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# File generated automatically, do not edit
+
+require "sxg_checker/checker"
+require "sxg_checker/cli"
+require "sxg_checker/document"
+require "sxg_checker/formatter"
+require "sxg_checker/subresource"

data/lib/sxg_checker/checker.rb

@@ -0,0 +1,118 @@
+require "uri"
+require "http"
+require "parallel"
+
+module SxgChecker
+  class Checker
+    def call(document_url)
+      raise ToolNotFound.new("executable not found: #{tool}") unless File.executable?(tool)
+
+      url = cacheify_document_url(document_url)
+      response = fetch_sxg(url)
+      return Document.new(url, :missing) unless response
+
+      sxg = extract_sxg(response.body)
+      return Document.new(url, :parsing_error) unless sxg
+
+      return Document.new(url, :invalid) unless sxg.fetch("Valid") == true
+
+      fresh_cached = extract_links(response.headers["Link"])
+      fresh_integrity = extract_integrity(sxg.fetch("ResponseHeaders").fetch("Link", [""]))
+      return Document.new(url, :links_mismatch) if fresh_cached.keys.sort != fresh_integrity.keys.sort
+
+      cached_integrity = fresh_integrity.map do |fresh, integrity|
+        cached = fresh_cached.fetch(fresh)
+        [cached, integrity]
+      end.to_h
+
+      subresources = mapper.call(cached_integrity, in_threads: [cached_integrity.size, 20].min) do |cached, integrity|
+        status = check_subresource(cached, integrity)
+        Subresource.new(cached, status)
+      end
+
+      Document.new(url, :ok, subresources)
+    end
+
+    attr_reader :default_tool
+
+    private
+
+    def check_subresource(url, expected_integrity)
+      response = fetch_sxg(url)
+      return :missing unless response
+
+      sxg = extract_sxg(response.body)
+      return :parsing_error unless sxg
+
+      actual_integrity = sxg.fetch("HeaderIntegrity")
+      return :integrity_mismatch unless actual_integrity == expected_integrity
+
+      return :invalid unless sxg.fetch("Valid") == true
+
+      :ok
+    end
+
+    def fetch_sxg(url)
+      response = HTTP.headers(accept: "application/signed-exchange;v=b3").get(url)
+      return nil unless response.content_type.mime_type == "application/signed-exchange"
+
+      response
+    end
+
+    def extract_links(link_header)
+      link_header.to_s.split(",")
+        .select { _1 =~ /application\/signed-exchange;v=b3/ }
+        .map do
+          _1 =~ /^<(.+)>.+anchor="(.+)"/
+          [$2, $1]
+        end.to_h
+    end
+
+    def extract_integrity(link_headers)
+      link_headers
+        .map { _1.to_s.split(",") }
+        .flatten
+        .select { _1 =~ /rel=allowed-alt-sxg/ }
+        .map do
+          _1 =~ /^<(.+)>.+header-integrity="(.+)"/
+          [$1, $2]
+        end
+        .to_h
+    end
+
+    def extract_sxg(body)
+      Tempfile.open("sxg", encoding: "ascii-8bit") do |file|
+        file.write body
+        file.flush
+        parse_sxg_file file.path
+      end
+    end
+
+    def parse_sxg_file(path)
+      command = "#{tool} -json -verify -i #{path}"
+      result = `#{command} 2> /dev/null`
+      return nil if result.empty?
+      JSON.parse(result)
+    end
+
+    def cacheify_document_url(url)
+      uri = URI.parse(url)
+      raise InvalidUrl.new("invalid URL") unless uri.scheme == "https" && uri.host && uri.fragment.nil?
+
+      host = uri.host.to_s.tr(".", "-")
+      "https://#{host}.webpkgcache.com/doc/-/s/#{url.sub("https://", "")}"
+    rescue URI::InvalidURIError
+      raise InvalidUrl.new("can't parse URL")
+    end
+
+    attr_reader :tool, :mapper
+
+    def initialize(mapper: Parallel.method(:map),
+      default_tool: "#{ENV["HOME"]}/go/bin/dump-signedexchange",
+      tool: ENV["DSXG_PATH"] || default_tool)
+      @mapper = mapper
+      @default_tool = default_tool
+      @tool = tool
+    end
+  end
+end

data/lib/sxg_checker/cli.rb

@@ -0,0 +1,49 @@
+module SxgChecker
+  class Cli
+    def call(url)
+      return show_usage if url.nil? || url == "-h" || url == "--help"
+
+      document = checker.call(url)
+      resources = [document] + document.subresources.sort
+      resources.each do |resource|
+        puts formatter.resource(resource)
+      end
+    rescue Error => e
+      puts "#{exe_name}: error: #{e.message}"
+      exit 1
+    end
+
+    private
+
+    def show_usage
+      puts "SXG Checker v#{VERSION}"
+      puts "  Checks the Google SXG cache for the presence of a document and its subresources."
+      puts
+      puts "Usage:"
+      puts "  #{exe_name} <URL>"
+      puts
+      puts "Example:"
+      puts "  #{exe_name} https://www.yourwebsite.com/your-page"
+      puts
+      puts "Environment variables:"
+      puts "  DSXG_PATH - path to dump-signedexchange binary (default: #{checker.default_tool})"
+      puts
+      show_statuses
+    end
+
+    def show_statuses
+      puts "Possible statuses:"
+      formatter.icons.map do |status, icon|
+        puts "  #{icon} #{status.to_s.tr("_", " ")}"
+      end
+    end
+
+    attr_reader :exe_name, :formatter, :checker
+
+    def initialize(exe_name)
+      @exe_name = exe_name
+      @formatter = SxgChecker::Formatter.new
+      @checker = SxgChecker::Checker.new
+    end
+  end
+end

data/lib/sxg_checker/document.rb

@@ -0,0 +1,13 @@
+module SxgChecker
+  class Document
+    attr_reader :url, :status, :subresources
+
+    private
+
+    def initialize(url, status, subresources = [])
+      @url = url
+      @status = status
+      @subresources = subresources
+    end
+  end
+end

data/lib/sxg_checker/formatter.rb

@@ -0,0 +1,23 @@
+module SxgChecker
+  class Formatter
+    def resource(resource)
+      icon = icons.fetch(resource.status)
+      "#{icon} #{resource.url}"
+    end
+
+    attr_reader :icons
+
+    private
+
+    def initialize(icons = {
+      ok: "✓",
+      missing: "?",
+      invalid: "x",
+      parsing_error: "!",
+      links_mismatch: "~",
+      integrity_mismatch: "≠"
+    })
+      @icons = icons
+    end
+  end
+end

data/lib/sxg_checker/subresource.rb

@@ -0,0 +1,22 @@
+module SxgChecker
+  class Subresource
+    include Comparable
+
+    attr_reader :url, :status
+
+    def fresh_url
+      @fresh_url ||= url.sub(/^.+\/s\//, "https://")
+    end
+
+    def <=>(other)
+      fresh_url <=> other.fresh_url
+    end
+
+    private
+
+    def initialize(url, status)
+      @url = url
+      @status = status
+    end
+  end
+end

data/lib/sxg_checker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SxgChecker
+  VERSION = "0.1.0"
+end

data/lib/sxg_checker.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "sxg_checker/version"
+
+if defined? SxgChecker::AUTOLOADERS
+  require "zeitwerk"
+  SxgChecker::AUTOLOADERS << Zeitwerk::Loader.for_gem.tap do |loader|
+    loader.ignore("#{__dir__}/basic_loader.rb")
+    loader.setup
+  end
+else
+  require "basic_loader"
+end
+
+module SxgChecker
+  Error = Class.new(StandardError)
+  InvalidUrl = Class.new(Error)
+  ToolNotFound = Class.new(Error)
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: sxg_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paweł Pokrywka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+description: 
+email:
+- pepawel@users.noreply.github.com
+executables:
+- sxg-checker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/sxg-checker
+- lib/basic_loader.rb
+- lib/sxg_checker.rb
+- lib/sxg_checker/checker.rb
+- lib/sxg_checker/cli.rb
+- lib/sxg_checker/document.rb
+- lib/sxg_checker/formatter.rb
+- lib/sxg_checker/subresource.rb
+- lib/sxg_checker/version.rb
+homepage: https://github.com/pepawel/sxg_checker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pepawel/sxg_checker
+  source_code_uri: https://github.com/pepawel/sxg_checker
+  changelog_uri: https://github.com/pepawel/sxg_checker/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Checks SXG document and its subresources validity.
+test_files: []