bimi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de80df0b6b1b4ff98eb97b27fa5ae7d2bdb42e58db45c20380b5a072c03e82b7
+  data.tar.gz: a6bb3274542892c548438303c4e5830c72fdafb21cbea418b5083fc2587b57a2
+SHA512:
+  metadata.gz: a6b9a15d363cbced4b264caf292d43c095708e965342a045398bde0de0eb628aa3079b4234bf709f2e11ac4ace204c904011b5ef70500b49e36ef25e4a77e0d5
+  data.tar.gz: dd141c1446d33d1a477ea14232236075861ad6512f260beca52963c880411bedb48406536b74fc5a841344a181b35ce8bff382e7bacbc6635dd6b7028628ec84

data/README.md

@@ -0,0 +1,39 @@
+# bimi
+
+A Ruby toolkit for [BIMI](https://bimigroup.org) — Brand Indicators for Message Identification.
+
+This is an early preview release. The full API (record discovery, SVG Tiny PS validation, VMC and CMC certificate chain verification) is in progress. For now, the gem ships a placeholder `BIMI.check` that animates in your terminal so you can confirm it loaded.
+
+## Installation
+
+```bash
+bundle add bimi
+```
+
+Or without bundler:
+
+```bash
+gem install bimi
+```
+
+## Usage
+
+```ruby
+require "bimi"
+
+BIMI.check                  # animates against a placeholder domain
+BIMI.check("example.com")   # animates against the domain you pass
+```
+
+In a non-TTY environment the output falls back to plain text.
+
+## Roadmap
+
+- Record discovery (`default._bimi` TXT lookup)
+- SVG Tiny PS fetch and validation
+- VMC and CMC certificate chain verification
+- DMARC policy assertion checks
+
+## License
+
+MIT.

data/lib/bimi/version.rb

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

data/lib/bimi.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative "bimi/version"
+
+module BIMI
+  class Error < StandardError; end
+
+  SPINNER = %w[⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏].freeze
+
+  STEPS = [
+    "Looking up DMARC policy",
+    "Resolving default._bimi TXT record",
+    "Fetching SVG Tiny PS logo",
+    "Validating VMC certificate chain",
+    "Verifying mark ownership",
+    "Polishing your brand indicator"
+  ].freeze
+
+  RAINBOW = [196, 208, 220, 190, 82, 51, 63, 129, 201].freeze
+
+  def self.check(domain = "yourdomain.example")
+    out = $stdout
+    return _static(domain, out) unless out.tty?
+
+    out.sync = true
+    out.print("\e[?25l")
+    begin
+      _banner(out)
+      _run_steps(domain, out)
+      _victory(domain, out)
+    ensure
+      out.print("\e[?25h")
+    end
+    true
+  end
+
+  def self._banner(out)
+    letters = %w[B I M I]
+    8.times do |frame|
+      out.print("\r")
+      letters.each_with_index do |ch, i|
+        color = RAINBOW[(frame + i * 2) % RAINBOW.length]
+        out.print("\e[38;5;#{color};1m #{ch} ")
+      end
+      out.print("\e[0m")
+      sleep(0.08)
+    end
+    out.puts("\e[0m  brand indicators for message identification\n\n")
+  end
+
+  def self._run_steps(domain, out)
+    STEPS.each_with_index do |step, idx|
+      label = "#{step} for \e[1m#{domain}\e[0m"
+      frames = 12 + rand(8)
+      frames.times do |f|
+        color = RAINBOW[(f + idx) % RAINBOW.length]
+        out.print("\r\e[38;5;#{color}m#{SPINNER[f % SPINNER.length]}\e[0m  #{label}\e[K")
+        sleep(0.05)
+      end
+      out.puts("\r\e[32m✓\e[0m  #{label}\e[K")
+    end
+    out.puts
+  end
+
+  def self._victory(domain, out)
+    msg = "  BIMI looks good for #{domain}!  "
+    bar = "═" * msg.length
+    out.puts("\e[38;5;82m╔#{bar}╗\e[0m")
+    8.times do |frame|
+      tinted = msg.each_char.with_index.map do |ch, i|
+        color = RAINBOW[(frame + i) % RAINBOW.length]
+        "\e[38;5;#{color};1m#{ch}"
+      end.join
+      out.print("\e[38;5;82m║\e[0m#{tinted}\e[0m\e[38;5;82m║\e[0m\r")
+      sleep(0.1)
+    end
+    out.puts
+    out.puts("\e[38;5;82m╚#{bar}╝\e[0m")
+    out.puts("\n  \e[2mpreview release — real record, SVG, and VMC checks land in a future version\e[0m\n\n")
+  end
+
+  def self._static(domain, out)
+    out.puts("BIMI check for #{domain}")
+    STEPS.each { |s| out.puts("  ok  #{s}") }
+    out.puts("BIMI looks good for #{domain}!")
+  end
+end

data/sig/bimi.rbs

@@ -0,0 +1,4 @@
+module BIMI
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: bimi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Steve Whittaker
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  A Ruby toolkit for working with BIMI — discovering records, fetching and
+  validating SVG Tiny PS logos, and verifying VMC and CMC certificate chains.
+  This is an early preview release; the public API will grow with subsequent
+  versions. Run BIMI.check in a terminal to see an animated placeholder for
+  the checker that's coming next.
+email:
+- swhitt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/bimi.rb
+- lib/bimi/version.rb
+- sig/bimi.rbs
+homepage: https://rubygems.org/gems/bimi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/bimi
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Ruby toolkit for BIMI (Brand Indicators for Message Identification).
+test_files: []