zeroclick-sellers 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27bd4f5d8f10f026b12a89ee8681fef45ffbf58129df180f40903a55ec9743d3
-  data.tar.gz: 1ea73b94f08215d28c2974ac4937bdc423aa2f52a66c688a5746656ad837c8f2
+  metadata.gz: 2865ea4c52917887161bb00e22f46bdd275f28a6a7ac3a2e72d680b3db32323c
+  data.tar.gz: 4ca1a1c4665a099a54e15fb459a36eaa951feb718331fa6303cd4e81b2356d22
 SHA512:
-  metadata.gz: 73ef4fc05515a9d11212ca90c7df1c9f97c157bdc2628c4b1bb81738849552fbd7aca334986fc60f1c4d0d5cb6ca311b7663c453c1633a756950e82af4f06b42
-  data.tar.gz: 00dbf768601b7808759518ad6a507e0d238f4c6c65aecdd91ce5106488841a19538f5ea49ea5df93e776a049330f32f834d7d9216dd0ce58b212bf6da24e1748
+  metadata.gz: 1b9b122f2cea8b056f79fe2aa56af4d674818148ae8e6b60adb4ac9b000520f06d360c22980c0c6900e87bc02882218d1e9e4815248b8d65d5319608e1a4d0a4
+  data.tar.gz: 81c0463cda57c90787550a9215a786d41d555486eaef5af19f081b965af84608d87819f2f053be1195425e815aa985d777761897090049bbced8dcb74981e73c

data/lib/zeroclick/sellers/middleware/page_views.rb

@@ -22,6 +22,9 @@ module ZeroClick
       #   - the app runs FIRST, so the beacon carries the real status and
       #     duration; the visitor's user-agent, accept, and connecting IP are
       #     forwarded for server-side classification;
+      #   - the visitor's country rides along when the edge resolved it: the
+      #     header Cloudflare, CloudFront, Vercel or App Engine sets, or
+      #     +resolve_country+; a host whose edge sets none sends no country;
       #   - a ZeroClick agent-eval request's tag and signature are forwarded
       #     with the page's host, so the API can keep ZeroClick's own eval
       #     traffic out of the seller's numbers; a browser-based run, which
@@ -55,6 +58,20 @@ module ZeroClick
         # the whole visit out of the seller's numbers from it.
         EVAL_SOURCE_PREFIX = "ze-"
 
+        # The vendor request headers (as Rack env keys) that carry the
+        # visitor's country as the edge resolved it, outermost layer first: a
+        # CDN in front of a platform sees the true client, while the platform
+        # behind it geolocates the CDN's edge, so the outer header wins when
+        # both are present. Each is the vendor's documented header, forwarded
+        # raw; the API clamps it to a 2-letter code and drops the vendors'
+        # unknown sentinels (Cloudflare XX, App Engine ZZ).
+        COUNTRY_HEADERS = %w[
+          HTTP_CF_IPCOUNTRY
+          HTTP_CLOUDFRONT_VIEWER_COUNTRY
+          HTTP_X_VERCEL_IP_COUNTRY
+          HTTP_X_APPENGINE_COUNTRY
+        ].freeze
+
         # +seller+ may be a client, a callable returning one, or omitted to
         # resolve the process-wide ZeroClick::Sellers.seller on the first
         # request (the Rails path — see Base#initialize for why).
@@ -65,14 +82,19 @@ module ZeroClick
         # public URL of the request, for servers behind a proxy that rewrites
         # the host the runtime sees; its path is reported and, with an eval
         # tag, its host. +on_error+ observes the fire-and-forget
-        # path; it is never re-raised.
-        def initialize(app, seller_id:, seller: nil, clock: nil, resolve_url: nil, on_error: nil)
+        # path; it is never re-raised. +resolve_country+ is a callable taking
+        # the Rack env and returning the visitor's country, replacing the
+        # vendor-header read (COUNTRY_HEADERS) with the seller's own source:
+        # exactly one header, or a runtime that exposes the country another
+        # way. Return nil for unknown.
+        def initialize(app, seller_id:, seller: nil, clock: nil, resolve_url: nil, on_error: nil, resolve_country: nil)
           @app = app
           @seller_source = seller
           @seller_id = seller_id
           @clock = clock || DEFAULT_CLOCK
           @resolve_url = resolve_url
           @on_error = on_error
+          @resolve_country = resolve_country
         end
 
         def call(env)
@@ -114,7 +136,7 @@ module ZeroClick
             user_agent: env["HTTP_USER_AGENT"],
             accept: env["HTTP_ACCEPT"],
             client_ip: client_ip_of(env),
-            country: env["HTTP_CF_IPCOUNTRY"],
+            country: country_of(env),
             referrer_host: referrer_host_of(env),
             journey_id: journey_id_of(headers),
             **start_marker_of(uri),
@@ -205,6 +227,20 @@ module ZeroClick
           first.empty? ? nil : first
         end
 
+        # The visitor's country as the edge resolved it: the first present of
+        # COUNTRY_HEADERS, or whatever +resolve_country+ returns. nil when the
+        # edge set none of them, so a host without one sends no country rather
+        # than a guess; an empty value is left out the same way.
+        def country_of(env)
+          value = if @resolve_country
+                    @resolve_country.call(env)
+                  else
+                    COUNTRY_HEADERS.lazy.map { |key| env[key] }.find { |v| v && !v.strip.empty? }
+                  end
+          value = value&.strip
+          value.nil? || value.empty? ? nil : value
+        end
+
         # The referrer reduced to its host at the edge, so the full referrer
         # (its path and query, which can carry identifying values) never leaves
         # the site. A malformed referrer yields no host rather than the full URL.

data/lib/zeroclick/sellers/version.rb

@@ -4,6 +4,6 @@ module ZeroClick
   module Sellers
     # Bump this to publish. The workflow reads it, asks RubyGems whether this
     # version already exists, and publishes only when it does not.
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zeroclick-sellers
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - ZeroClick
@@ -15,7 +15,7 @@ description: |
   and report what was used. Ships Rack middleware, so it works in Rails,
   Sinatra, Hanami and Roda alike.
 email:
-- support@zeroclick.ai
+- help@zeroclick.ai
 executables: []
 extensions: []
 extra_rdoc_files: []