capi_param_builder_ruby 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a33297523bdd07b142d4a946e4b3134675aec7d95d3479dad27647e566e36e4
-  data.tar.gz: e62d98b35b46fd27adb878d736f8640c8cb589d437f94a7a19ab9d986eb2d38c
+  metadata.gz: 666e5be3f9571422768ea730eb957935a5212dc0ede2d0cb2a98cee69b8acee0
+  data.tar.gz: a041d8fb610f9b6282ea7552225c8816930939f74237d1dfc6da25fb0cafeb43
 SHA512:
-  metadata.gz: 0c0a171eb5f541ca08f7a08c23f7505bdc5a00818668126698b440ea2268670f17bedefeadf10f2b6b89a9c504111a55b1050a2988180a12165c28e5e3cd5498
-  data.tar.gz: a44149e6a88bddb67c82239b9f680668fc54f73e4ed6fcc16c6748b541110c1086e9f639cfca24aca7ac701ec11568e45cb2a5e8dae92f5fd3c0c1fd5dc071ea
+  metadata.gz: eba9eaab35779653e37b304bacdaa41b198ad95c704e1f94c4670e3682577d9a546fd7a378f89c89b0270a20f7e4df450dcb81f1d78700922b9730d7fe908070
+  data.tar.gz: 4101a8e7fa1b721663c5368a42292174ed1cd7e59c5bf6ddec5f5eab6f552d004150417f4ff4636e810825e83cea4bb56fc1fe1723e9cdbabad95c1501770cda

data/lib/capi_param_builder.rb

@@ -7,6 +7,8 @@
 require_relative 'model/fbc_param_configs'
 require_relative 'model/cookie_settings'
 require_relative 'model/etld_plus_one_resolver'
+require_relative 'model/plain_data_object'
+require_relative 'util/request_context_adaptor'
 require_relative 'release_config'
 require 'set'
 require 'uri'
@@ -40,6 +42,8 @@ class ParamBuilder
     @appendix_net_new = get_appendix(APPENDIX_NET_NEW)
     @appendix_modified_new = get_appendix(APPENDIX_MODIFIED_NEW)
     @appendix_no_change = get_appendix(APPENDIX_NO_CHANGE)
+    @referrer_url = nil
+    @event_source_url = nil
 
     if input.nil?
       return
@@ -175,12 +179,18 @@ class ParamBuilder
   end
 
   def process_request(host, queries, cookies, referer=nil)
+    @event_source_url = nil
     compute_etld_plus_one_for_host(host)
     @cookie_to_set_dict = {}
     @cookie_to_set = Set.new()
     @fbc = pre_process_cookies(cookies, FBC_NAME)
     @fbp = pre_process_cookies(cookies, FBP_NAME)
 
+    @referrer_url = referer
+    if @referrer_url.is_a?(String) && !@referrer_url.empty?
+      @referrer_url = "#{@referrer_url}.#{@appendix_no_change}"
+    end
+
     # Get new fbc payload
     new_fbc_payload = get_new_fbc_payload_from_url(queries, referer)
 
@@ -200,6 +210,32 @@ class ParamBuilder
     return @cookie_to_set
   end
 
+  # Process a request from a context object.
+  #
+  # Accepts either a PlainDataObject (used directly) or any framework
+  # request / Rack-style env Hash that RequestContextAdaptor knows how to
+  # extract from. Nil falls through to the adapter's empty-default behavior.
+  #
+  # Note: PlainDataObject carries x_forwarded_for and remote_address for
+  # parity with the JS / PHP SDKs, but the Ruby ParamBuilder does not yet
+  # implement client-IP attribution; those fields are extracted by the
+  # adapter but ignored here.
+  def process_request_from_context(context = nil)
+    data = context.is_a?(PlainDataObject) ?
+      context : RequestContextAdaptor.extract(context)
+
+    process_request(
+      data.host,
+      data.query_params,
+      data.cookies,
+      data.referer
+    )
+
+    @event_source_url = construct_event_source_url(data)
+
+    return @cookie_to_set
+  end
+
   def get_cookies_to_set()
     return @cookie_to_set
   end
@@ -212,9 +248,25 @@ class ParamBuilder
     return @fbp
   end
 
+  def get_referrer_url()
+    return @referrer_url
+  end
+
+  def get_event_source_url()
+    return @event_source_url
+  end
+
   private def compute_etld_plus_one_for_host(host)
     if @etld_plus_one.nil? || @host.nil?
       @host = host
+      # Guard empty/nil host: Ruby's "".split(".") returns [], so naively
+      # computing size - 1 would yield -1 and emit malformed `fb.-1.…`
+      # cookies. Match Python's behavior: empty host -> nil etld+1, index 0.
+      if host.nil? || host.empty?
+        @etld_plus_one = nil
+        @sub_domain_index = 0
+        return
+      end
       host_name = extract_host_from_http_host(host)
       if is_ip_address(host_name)
         @etld_plus_one = maybe_bracket_ipv6(host_name)
@@ -286,6 +338,21 @@ class ParamBuilder
     return host_name
   end
 
+  private def construct_event_source_url(data)
+    return nil if data.nil?
+    return nil if data.host.nil? || data.host.empty?
+    return nil if data.scheme.nil? || data.scheme.empty?
+
+    url = "#{data.scheme.downcase}://#{data.host}"
+    if !data.request_uri.nil? && !data.request_uri.empty?
+      url += data.request_uri
+    end
+    if url.is_a?(String) && !url.empty?
+      url = "#{url}.#{@appendix_net_new}"
+    end
+    url
+  end
+
   private def get_updated_fbc_cookie(existing_fbc = nil, new_fbc_payload)
     if @fbc_params_configs.nil?
       return nil

data/lib/model/plain_data_object.rb

@@ -0,0 +1,24 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+class PlainDataObject
+    attr_accessor :host, :query_params, :cookies, :referer,
+                  :x_forwarded_for, :remote_address, :scheme,
+                  :request_uri
+
+    def initialize(host, query_params, cookies, referer = nil,
+                   x_forwarded_for = nil, remote_address = nil,
+                   scheme = nil, request_uri = nil)
+      @host = host
+      @query_params = query_params
+      @cookies = cookies
+      @referer = referer
+      @x_forwarded_for = x_forwarded_for
+      @remote_address = remote_address
+      @scheme = scheme
+      @request_uri = request_uri
+    end
+end

data/lib/release_config.rb

@@ -4,5 +4,5 @@
 # This source code is licensed under the license found in the
 # LICENSE file in the root directory of this source tree.
 module ReleaseConfig
-  VERSION = "1.1.1"
+  VERSION = "1.3.0"
 end

data/lib/util/request_context_adaptor.rb

@@ -0,0 +1,170 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+
+# This source code is licensed under the license found in the
+# LICENSE file in the root directory of this source tree.
+
+require 'cgi'
+require_relative '../model/plain_data_object'
+
+# Universal Request Context Adaptor for Ruby.
+#
+# Extracts request data (host, query params, cookies, referer,
+# x-forwarded-for, remote address) from a Rack-style environ hash or any
+# framework request object that exposes #env (Rack, Rails, Sinatra). Falls
+# back to empty defaults for nil or unrecognized inputs.
+class RequestContextAdaptor
+  HTTP_DEFAULT_PORT = 80
+  HTTPS_DEFAULT_PORT = 443
+
+  def self.extract(request_obj = nil)
+    host = ''
+    query_params = {}
+    cookies = {}
+    referer = nil
+    x_forwarded_for = nil
+    remote_address = nil
+    scheme = nil
+    request_uri = nil
+
+    if request_obj.nil?
+      return PlainDataObject.new(
+        host, query_params, cookies, referer, x_forwarded_for, remote_address,
+        scheme, request_uri
+      )
+    end
+
+    begin
+      env = resolve_env(request_obj)
+      if env.is_a?(Hash) && !env.empty?
+        host = wsgi_host(env)
+        referer = nilify(env['HTTP_REFERER'])
+        x_forwarded_for = nilify(env['HTTP_X_FORWARDED_FOR'])
+        remote_address = nilify(env['REMOTE_ADDR'])
+
+        query_params = parse_query_string(env['QUERY_STRING'])
+        cookies = parse_cookie_header(env['HTTP_COOKIE'])
+
+        scheme = extract_scheme(env)
+        request_uri = extract_request_uri(env)
+      end
+    rescue StandardError
+      # Silently swallow exceptions and return the object with default values.
+    end
+
+    PlainDataObject.new(
+      host, query_params, cookies, referer, x_forwarded_for, remote_address,
+      scheme, request_uri
+    )
+  end
+
+  def self.resolve_env(request_obj)
+    if request_obj.respond_to?(:env) && request_obj.env.is_a?(Hash)
+      return request_obj.env
+    end
+    return request_obj if request_obj.is_a?(Hash)
+    nil
+  end
+  private_class_method :resolve_env
+
+  def self.parse_query_string(query_string)
+    return {} if query_string.nil? || query_string.to_s.empty?
+    CGI.parse(query_string.to_s)
+  end
+  private_class_method :parse_query_string
+
+  def self.parse_cookie_header(raw_cookie)
+    return {} if raw_cookie.nil? || raw_cookie.to_s.empty?
+    raw_cookie.to_s.split(';').each_with_object({}) do |pair, hash|
+      parts = pair.split('=', 2)
+      next unless parts.size == 2
+      key = parts[0].strip
+      next if key.empty?
+      begin
+        hash[key] = percent_decode(parts[1].strip)
+      rescue StandardError
+        # Per-pair isolation: a single bad cookie (e.g. an encoding error)
+        # must not drop the other valid cookies in the same header.
+      end
+    end
+  end
+  private_class_method :parse_cookie_header
+
+  # Percent-decode a cookie value WITHOUT converting `+` to space. CGI.unescape
+  # applies form decoding (`+` -> ` `), which would corrupt base64 / JWT-like
+  # cookie values that legitimately contain `+`.
+  #
+  # Operates on a BINARY copy first so that gsub-ing ASCII-8BIT bytes (from
+  # `pack("H2")`) into a string that already carries UTF-8 multi-byte
+  # characters does not raise `Encoding::CompatibilityError`. After decoding
+  # we relabel as UTF-8 and `scrub` any invalid byte sequences (e.g. lone
+  # `%FF`) so downstream JSON / logging / hashing does not choke on
+  # invalid UTF-8.
+  def self.percent_decode(value)
+    value.to_s.b
+         .gsub(/%([0-9a-fA-F]{2})/) { [Regexp.last_match(1)].pack('H2') }
+         .force_encoding(Encoding::UTF_8)
+         .scrub
+  end
+  private_class_method :percent_decode
+
+  def self.wsgi_host(env)
+    host = env['HTTP_HOST']
+    return host if host && !host.empty?
+    server_name = env['SERVER_NAME']
+    return '' if server_name.nil? || server_name.empty?
+    server_port = env['SERVER_PORT']
+    scheme = env['rack.url_scheme'] || 'http'
+    format_host_port(server_name, server_port, scheme)
+  end
+  private_class_method :wsgi_host
+
+  # Build a host[:port] authority, bracketing bare IPv6 literals. We always
+  # bracket bare IPv6 — even when the port is omitted — so that downstream
+  # `extract_host_from_http_host` (which treats the last `:` as a port
+  # separator when no `]` is present) does not truncate the address.
+  def self.format_host_port(host, port, scheme)
+    bracketed = host.include?(':') && !host.start_with?('[') ? "[#{host}]" : host
+    default_port =
+      scheme == 'https' || scheme == 'wss' ? HTTPS_DEFAULT_PORT : HTTP_DEFAULT_PORT
+    if port.nil? || port.to_s.empty? || port.to_s == default_port.to_s
+      return bracketed
+    end
+    "#{bracketed}:#{port}"
+  end
+  private_class_method :format_host_port
+
+  def self.extract_scheme(env)
+    raw_str = (env['REQUEST_SCHEME'] || env['rack.url_scheme']).to_s
+    return raw_str.downcase unless raw_str.empty?
+
+    https_str = env['HTTPS'].to_s
+    return 'https' if !https_str.empty? && https_str.downcase != 'off'
+    nil
+  end
+  private_class_method :extract_scheme
+
+  def self.extract_request_uri(env)
+    raw = env['REQUEST_URI']
+    return raw.to_s if raw && !raw.to_s.empty?
+
+    script_name = env['SCRIPT_NAME'].to_s
+    path_info = env['PATH_INFO'].to_s
+    uri = script_name + path_info
+    query_string = env['QUERY_STRING']
+    has_qs = query_string && !query_string.to_s.empty?
+
+    return nil if uri.empty? && !has_qs
+    uri = '/' if uri.empty?
+    uri = "#{uri}?#{query_string}" if has_qs
+    uri
+  end
+  private_class_method :extract_request_uri
+
+  def self.nilify(value)
+    return nil if value.nil?
+    return nil if value.respond_to?(:empty?) && value.empty?
+    value
+  end
+  private_class_method :nilify
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capi_param_builder_ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Facebook
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-30 00:00:00.000000000 Z
+date: 2026-05-28 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -20,7 +20,9 @@ files:
 - lib/model/cookie_settings.rb
 - lib/model/etld_plus_one_resolver.rb
 - lib/model/fbc_param_configs.rb
+- lib/model/plain_data_object.rb
 - lib/release_config.rb
+- lib/util/request_context_adaptor.rb
 homepage:
 licenses:
 - Nonstandard