capi_param_builder_ruby 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8525b1ab84c2d04fa5557b0aaba420e7963136503d972a09bdb616f99a18711e
-  data.tar.gz: 5810250eddcd721a5051e678b23b0165b2b4d84e2683bbf860dd2f9e54751324
+  metadata.gz: 4a33297523bdd07b142d4a946e4b3134675aec7d95d3479dad27647e566e36e4
+  data.tar.gz: e62d98b35b46fd27adb878d736f8640c8cb589d437f94a7a19ab9d986eb2d38c
 SHA512:
-  metadata.gz: 8aaa07d83a623a1f10cd4d34c73c55e6056fc20048006a0c263bd4fe372bb5ae6d2f476a91bd75db02a4a4b103a7d376793c16ae2474b476efb8d670de45166d
-  data.tar.gz: 9919b3befd095f7bf7cbd88d8ccac7cc6c09ce86a60f8dbcf163beb2af1b22ad876ac5c82b80e03c89d41efdb518de27408ba6cba73d64e1055a9cdc1167c966
+  metadata.gz: 0c0a171eb5f541ca08f7a08c23f7505bdc5a00818668126698b440ea2268670f17bedefeadf10f2b6b89a9c504111a55b1050a2988180a12165c28e5e3cd5498
+  data.tar.gz: a44149e6a88bddb67c82239b9f680668fc54f73e4ed6fcc16c6748b541110c1086e9f639cfca24aca7ac701ec11568e45cb2a5e8dae92f5fd3c0c1fd5dc071ea

data/lib/capi_param_builder.rb

@@ -7,23 +7,39 @@
 require_relative 'model/fbc_param_configs'
 require_relative 'model/cookie_settings'
 require_relative 'model/etld_plus_one_resolver'
+require_relative 'release_config'
 require 'set'
 require 'uri'
 require 'cgi'
+require 'base64'
 
 class ParamBuilder
   FBC_NAME = "_fbc"
   FBP_NAME = "_fbp"
   DEFAULT_1PC_AGE = 90 * 24 * 3600
-  LANGUAGE_TOKEN = "BQ"
+  LANGUAGE_TOKEN = "BQ"  # Original Ruby language token
   SUPPORTED_LANGUAGE_TOKENS = ["AQ", "Ag", "Aw", "BA", "BQ", "Bg"]
   MIN_PAYLOAD_SPLIT_LENGTH = 4
   MAX_PAYLOAD_WITH_LANGUAGE_TOKEN_LENGTH = 5
   IPV4_REGEX = /\A(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\z/
   IPV6_REGEX = /\A(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}\z|\A(?:[0-9a-fA-F]{1,4}:){1,7}:\z|\A(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}\z|\A(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}\z|\A(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}\z|\A(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}\z|\A(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}\z|\A[0-9a-fA-F]{1,4}:(?::[0-9a-fA-F]{1,4}){1,6}\z|\A:(?::[0-9a-fA-F]{1,4}){1,7}\z|\A::\z|\A(?:[0-9a-fA-F]{1,4}:){6}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\z/
+  # Appendix constants
+  DEFAULT_FORMAT = 0x01
+  LANGUAGE_TOKEN_INDEX = 0x05  # Ruby language token index
+  APPENDIX_LENGTH_V1 = 2
+  APPENDIX_LENGTH_V2 = 8
+
+  # Appendix type constants
+  APPENDIX_NO_CHANGE = 0x00
+  APPENDIX_GENERAL_NEW = 0x01
+  APPENDIX_NET_NEW = 0x02
+  APPENDIX_MODIFIED_NEW = 0x03
 
   def initialize(input = nil)
     @fbc_params_configs = [FbcParamConfigs.new("fbclid", "", "clickID")]
+    @appendix_net_new = get_appendix(APPENDIX_NET_NEW)
+    @appendix_modified_new = get_appendix(APPENDIX_MODIFIED_NEW)
+    @appendix_no_change = get_appendix(APPENDIX_NO_CHANGE)
 
     if input.nil?
       return
@@ -39,6 +55,45 @@ class ParamBuilder
     end
   end
 
+  private def get_appendix(appendix_type)
+    begin
+      version = ReleaseConfig::VERSION
+      version_parts = version.split(".")
+      major = version_parts[0].to_i
+      minor = version_parts[1].to_i
+      patch = version_parts[2].to_i
+
+      # Validate appendix type
+      valid_types = [APPENDIX_NET_NEW, APPENDIX_GENERAL_NEW, APPENDIX_MODIFIED_NEW]
+      if valid_types.include?(appendix_type)
+        type_byte = appendix_type
+      else
+        type_byte = APPENDIX_NO_CHANGE
+      end
+
+      # Create byte array
+      bytes_array = [
+        DEFAULT_FORMAT,        # 0x01 = 1
+        LANGUAGE_TOKEN_INDEX,  # 0x05 = 5
+        type_byte,            # appendix type
+        major,                # Major version number
+        minor,                # Minor version number
+        patch                 # Patch version number
+      ]
+
+      # Convert to bytes and then to base64url-safe string
+      byte_data = bytes_array.pack("C*")  # Pack as unsigned chars (bytes)
+      base64_encoded = Base64.encode64(byte_data).strip  # Remove newlines
+      # Make it URL-safe by replacing characters
+      base64url_safe = base64_encoded.tr('+/', '-_').gsub(/=+$/, '')
+      return base64url_safe
+    rescue Exception => e
+      puts "Failed to parse version in appendix: #{e}"
+      return LANGUAGE_TOKEN # Fall back to original Ruby language token
+    end
+  end
+
+
   private def pre_process_cookies(cookies, cookie_name)
     # Sanity check
     if cookies.nil? || cookies[cookie_name].nil?
@@ -50,13 +105,19 @@ class ParamBuilder
       parts.size > MAX_PAYLOAD_WITH_LANGUAGE_TOKEN_LENGTH
       return nil
     end
-    if parts.size == MAX_PAYLOAD_WITH_LANGUAGE_TOKEN_LENGTH && \
-      !SUPPORTED_LANGUAGE_TOKENS.include?(parts[MAX_PAYLOAD_WITH_LANGUAGE_TOKEN_LENGTH - 1])
-      return nil
+    if parts.size == MAX_PAYLOAD_WITH_LANGUAGE_TOKEN_LENGTH
+      appendix = parts[MAX_PAYLOAD_WITH_LANGUAGE_TOKEN_LENGTH - 1]
+      if appendix.size == APPENDIX_LENGTH_V1
+        if !SUPPORTED_LANGUAGE_TOKENS.include?(appendix)
+          return nil
+        end
+      elsif appendix.size != APPENDIX_LENGTH_V2
+        return nil
+      end
     end
     # Append language token if not present
     if parts.size == MIN_PAYLOAD_SPLIT_LENGTH
-      updated_cookie_value = cookie_value + "." + LANGUAGE_TOKEN
+      updated_cookie_value = cookie_value + "." + @appendix_no_change
       @cookie_to_set_dict[cookie_name] = CookieSettings.new(
         cookie_name, updated_cookie_value, @etld_plus_one, DEFAULT_1PC_AGE)
       return updated_cookie_value
@@ -234,17 +295,26 @@ class ParamBuilder
       return nil
     end
 
+    cookie_update = false
+    is_net_new = false
     if existing_fbc.nil?
       cookie_update = true
+      is_net_new = true
     else
       parts = existing_fbc.split(/\./)
-      cookie_update = new_fbc_payload != parts[3]
+      if parts.size < MIN_PAYLOAD_SPLIT_LENGTH
+        cookie_update = true
+        is_net_new = true
+      else
+        cookie_update = new_fbc_payload != parts[3]
+      end
     end
     if cookie_update == false
       return nil
     end
 
     current_ms = (Time.now.to_f * 1000).to_i.to_s
+    appendix = is_net_new ? @appendix_net_new : @appendix_modified_new
     new_fbc = "fb." +
       @sub_domain_index.to_s +
       "." +
@@ -252,7 +322,7 @@ class ParamBuilder
       "." +
       new_fbc_payload +
       "." +
-      LANGUAGE_TOKEN
+      appendix
     updated_cookie_setting = CookieSettings.new(
       FBC_NAME, new_fbc, @etld_plus_one, DEFAULT_1PC_AGE)
     return updated_cookie_setting
@@ -271,7 +341,7 @@ class ParamBuilder
       "." +
       new_fbp_payload +
       "." +
-      LANGUAGE_TOKEN
+      @appendix_net_new
     updated_cookie_setting = CookieSettings.new(
       FBP_NAME, new_fbp, @etld_plus_one, DEFAULT_1PC_AGE)
     return updated_cookie_setting

data/lib/release_config.rb

@@ -0,0 +1,8 @@
+# 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.
+module ReleaseConfig
+  VERSION = "1.1.1"
+end

metadata

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