datadome_fraud_sdk_ruby 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fff528a204778f50d85c8eccd4c202a66d94a24109f994cfc5cd3a64c53d0bdb
-  data.tar.gz: 49bd243556c8c8b756d7f738cb9cf969f1c080a0d960dc208970d0c29509ee13
+  metadata.gz: af46bd76291b91fa6eed5fd45415a7661783391ff657e6d202a9da6a006ee662
+  data.tar.gz: d3437a3c2e3f4a51bc44a3e4337454910281edccc5e4c05b9382feddbe3416d1
 SHA512:
-  metadata.gz: c6030c2e8c3ccca6d88b60ff5814795d45f0313f613103fdc987d46ca5cd376557aa1a44c75e1f9361e076a38dcd164166ee27b375c2db20bcdf63b4a7c969d2
-  data.tar.gz: 565a4385c6367b9d5a0f6e46d9cc4cd1c651083262e02fe521b3a9a88eca0fa94819880ed59f44765892fe1fb3cfabb7272336ead08e96c8dc2d3e0c9cd00ebb
+  metadata.gz: 9ffdf60d53ae616ade9ce9dace737b6df6e1a4a54ec198514dbd1a305ad4575232fbae7e9e58a847888b277b5da81bcce7a1d9495536558bac1a6d9fde0e8044
+  data.tar.gz: c33e5e9069a1d693a87b5fb8278e852d49ae87cb7ee013c77faf6634f0451e950fb9c4b627389b9d176fff8a77d494358d9a68e0bb5e9581ba9a4801da407f3d

data/lib/constants.rb

@@ -1,2 +1,2 @@
-SDK_VERSION = '2.1.0'
+SDK_VERSION = '2.3.0'
 SDK_NAME = 'datadome_fraud_sdk_ruby'

data/lib/datadome_fraud_sdk_ruby.rb

@@ -6,6 +6,7 @@ require_relative "model/events"
 require_relative "model/location"
 require_relative "model/user"
 require_relative "model/session"
+require_relative "model/authentication"
 require_relative "model/operation"
 require_relative "model/api/request"
 require_relative "model/api/response"
@@ -20,7 +21,7 @@ class DataDome
   end
 
   def validate(request:, event:)
-    if event.status == DataDomeStatusType::UNDEFINED
+    if event.respond_to?(:status) && event.status == DataDomeStatusType::UNDEFINED
       event.status = DataDomeStatusType::SUCCEEDED
     end
 
@@ -33,29 +34,34 @@ class DataDome
         body = JSON.parse(api_response.body) unless api_response.body.nil?
       rescue JSON::ParserError => e
         @logger.error("DataDome: error parsing JSON from Fraud API /validate #{e.message}")
-        return DataDomeResponseError.new(DataDomeResponseAction::ALLOW, DataDomeResponseStatus::FAILURE, "DataDome: error parsing JSON from Fraud API", e.message)
+        return DataDomeResponseError.new(status: DataDomeResponseStatus::FAILURE, message: "DataDome: error parsing JSON from Fraud API", errors: e.message)
       end
 
       if api_response.success?
-        datadome_response = DataDomeResponseSuccess.new(DataDomeResponseAction::ALLOW, body["score"], DataDomeResponseStatus::OK, body["reasons"], body["ip"], DataDomeLocation.new(location: body["location"]))
+        datadome_response = DataDomeResponseSuccess.new(status:DataDomeResponseStatus::OK, score:body["score"], 
+          event_id:body["eventId"]&.to_s, reasons: body["reasons"], ip: body["ip"], location: DataDomeLocation.new(location: body["location"]))
         if body["action"] === DataDomeResponseAction::DENY
           datadome_response.action = DataDomeResponseAction::DENY
+        elsif body["action"] === DataDomeResponseAction::REVIEW
+          datadome_response.action = DataDomeResponseAction::REVIEW
+        elsif body["action"] === DataDomeResponseAction::CHALLENGE
+          datadome_response.action = DataDomeResponseAction::CHALLENGE
         end
       else
         @logger.error("DataDome: error on Fraud API /validate response #{body["errors"]}")
-        return DataDomeResponseError.new(DataDomeResponseAction::ALLOW, DataDomeResponseStatus::FAILURE, body["message"], body["errors"].map { |error| DataDomeError.new(error) })
+        return DataDomeResponseError.new(status: DataDomeResponseStatus::FAILURE, message: body["message"], errors: body["errors"].map { |error| DataDomeError.new(error) })
       end
     rescue Faraday::TimeoutError => e
-      return DataDomeResponseError.new(DataDomeResponseAction::ALLOW, DataDomeResponseStatus::TIMEOUT, "DataDome Fraud API request timeout", e.message)
+      return DataDomeResponseError.new(status: DataDomeResponseStatus::TIMEOUT, message: "DataDome Fraud API request timeout", errors: e.message)
     rescue Faraday::ConnectionFailed => e
-      return DataDomeResponseError.new(DataDomeResponseAction::ALLOW, DataDomeResponseStatus::FAILURE, "DataDome Fraud API request failed", e.message)
+      return DataDomeResponseError.new(status: DataDomeResponseStatus::FAILURE, message: "DataDome Fraud API request failed", errors: e.message)
     end
 
     datadome_response
   end
 
   def collect(request:, event:)
-    if event.status == DataDomeStatusType::UNDEFINED
+    if event.respond_to?(:status) && event.status == DataDomeStatusType::UNDEFINED
       event.status = DataDomeStatusType::FAILED
     end
 
@@ -65,21 +71,21 @@ class DataDome
       api_response = send_request(DataDomeOperationType::COLLECT, event.action, payload)
 
       if api_response.success?
-        datadome_response = DataDomeResponseSuccess.new(nil, nil, DataDomeResponseStatus::OK, nil, nil, nil)
+        datadome_response = DataDomeResponseSuccess.new(status: DataDomeResponseStatus::OK)
       else
         begin
           body = JSON.parse(api_response.body)
           @logger.error("DataDome: error on Fraud API /collect response #{body["errors"]}")
-          datadome_response = DataDomeResponseError.new(nil, DataDomeResponseStatus::FAILURE, body["message"], body["errors"].map { |error| DataDomeError.new(error) })
+          datadome_response = DataDomeResponseError.new(status: DataDomeResponseStatus::FAILURE, message: body["message"], errors: body["errors"].map { |error| DataDomeError.new(error) })
         rescue JSON::ParserError => e
           @logger.error("DataDome: error parsing JSON from Fraud API /collect #{e.message}")
-          return DataDomeResponseError.new(nil, DataDomeResponseStatus::FAILURE, "DataDome: error parsing JSON from Fraud API", e.message)
+          return DataDomeResponseError.new(status: DataDomeResponseStatus::FAILURE, message: "DataDome: error parsing JSON from Fraud API", errors: e.message)
         end
       end
     rescue Faraday::TimeoutError => e
-      datadome_response = DataDomeResponseError.new(nil, DataDomeResponseStatus::TIMEOUT, "DataDome Fraud API request timeout", e.message)
+      datadome_response = DataDomeResponseError.new(status: DataDomeResponseStatus::TIMEOUT, message: "DataDome Fraud API request timeout", errors: e.message)
     rescue Faraday::ConnectionFailed => e
-      datadome_response = DataDomeResponseError.new(nil, DataDomeResponseStatus::FAILURE, "DataDome Fraud API request failed", e.message)
+      datadome_response = DataDomeResponseError.new(status: DataDomeResponseStatus::FAILURE, message: "DataDome Fraud API request failed", errors: e.message)
     end
 
     datadome_response

data/lib/model/api/request.rb

@@ -149,7 +149,7 @@ class DataDomeHeaders
       contentType: @content_type,
       host: @host,
       port: @port,
-      xRealIP: @x_real_ip,
+      xRealIp: @x_real_ip,
       xForwardedForIp: @x_forwarded_for_ip,
       acceptEncoding: @accept_encoding,
       acceptLanguage: @accept_language,
@@ -177,7 +177,7 @@ class DataDomeHeaders
 end
 
 class DataDomeRequest
-  attr_reader :module, :header, :account, :status, :session, :user
+  attr_reader :module, :header, :account, :status, :session, :user, :authentication, :reason
 
   def initialize(datadome_headers)
     @module = DataDomeModule.new
@@ -189,6 +189,8 @@ class DataDomeRequest
     @status = {}
     @session = {}
     @user = {}
+    @authentication = {}
+    @reason = nil
   end
 
   def to_json(options = {})
@@ -199,6 +201,8 @@ class DataDomeRequest
       status: @status,
       session: @session,
       user: @user,
+      authentication: @authentication,
+      reason: @reason,
     }
     JSON.generate(data, options)
   end

data/lib/model/api/response.rb

@@ -2,6 +2,8 @@
 
 module DataDomeResponseAction
   ALLOW = "allow"
+  CHALLENGE = "challenge"
+  REVIEW = "review"
   DENY = "deny"
 end
 
@@ -21,16 +23,17 @@ class DataDomeError
 end
 
 class DataDomeResponse
-  attr_accessor :action, :score, :status
+  attr_accessor :action, :score, :status, :event_id
 
-  def initialize(action, score, status)
-    @action = action
-    @score = score
+  def initialize(status:, score:nil, event_id:nil)
+    @action = DataDomeResponseAction::ALLOW
     @status = status
+    @score = score
+    @event_id = event_id
   end
 
   def to_s
-    "DataDomeResponse: action=#{@action}, score=#{@score}, status=#{@status}"
+    "DataDomeResponse: action=#{@action}, score=#{@score}, status=#{@status}, event_id=#{@event_id}"
   end
 
   def to_json(options = {})
@@ -38,6 +41,7 @@ class DataDomeResponse
       action: @action,
       score: @score,
       status: @status,
+      event_id: @event_id,
     }.to_json
   end
 end
@@ -45,15 +49,15 @@ end
 class DataDomeResponseSuccess < DataDomeResponse
   attr_reader :ip, :reasons, :location
 
-  def initialize(action, score, status, reasons, ip, location)
-    super(action, score, status)
+  def initialize(status:, score:, event_id:, reasons:, ip:, location:)
+    super(status: status, score: score, event_id: event_id)
     @reasons = reasons
     @ip = ip
     @location = location
   end
 
   def to_s
-    "DataDomeResponseSuccess: action=#{@action}, score=#{@score}, status=#{@status}, reasons=#{@reasons}, ip=#{@ip}, location=#{@location}"
+    "DataDomeResponseSuccess: action=#{@action}, score=#{@score}, status=#{@status}, event_id=#{@event_id}, reasons=#{@reasons}, ip=#{@ip}, location=#{@location}"
   end
 
   def to_json(options = {})
@@ -61,6 +65,7 @@ class DataDomeResponseSuccess < DataDomeResponse
       action: @action,
       score: @score,
       status: @status,
+      event_id: @event_id,
       reasons: @reasons,
       ip: @ip,
       location: @location,
@@ -71,8 +76,8 @@ end
 class DataDomeResponseError < DataDomeResponse
   attr_reader :message, :errors
 
-  def initialize(action, status, message, errors)
-    super(action, nil, status)
+  def initialize(status:, message:, errors:)
+    super(status: status)
     @message = message
     @errors = errors
   end

data/lib/model/authentication.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module DataDomeAuthenticationMode
+  OTHER = "other"
+  BIOMETRIC = "biometric"
+  MAIL = "mail"
+  MFA = "mfa"
+  OTP = "otp"
+  PASSWORD = "password"
+end
+
+module DataDomeAuthenticationType
+  OTHER = "other"
+  LOCAL = "local"
+  SOCIAL = "social"
+end
+
+module DataDomeSocialProvider
+  OTHER = "other"
+  AMAZON = "amazon"
+  APPLE = "apple"
+  FACEBOOK = "facebook"
+  GITHUB = "github"
+  GOOGLE = "google"
+  LINKEDIN = "linkedin"
+  MICROSOFT = "microsoft"
+  TWITTER = "twitter"
+  YAHOO = "yahoo"
+end
+
+class DataDomeAuthentication
+  attr_accessor :mode, :type, :social_provider
+
+  def initialize(mode: DataDomeAuthenticationMode::OTHER, type: DataDomeAuthenticationType::OTHER, social_provider: DataDomeSocialProvider::OTHER)
+    @mode = mode
+    @type = type
+    @social_provider = social_provider
+  end
+
+  def to_s
+    "DataDomeAuthentication: mode=#{@mode}, type=#{@type}, socialProvider=#{@social_provider}"
+  end
+
+  def to_json(options = {})
+    {
+      mode: @mode,
+      type: @type,
+      socialProvider: @social_provider,
+    }.to_json
+  end
+end

data/lib/model/events.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "./authentication"
+require_relative "./session"
+
 module DataDomeActionType
   LOGIN = "login"
   REGISTER = "registration"
+  ACCOUNT_UPDATE = "account/update"
+  PASSWORD_UPDATE = "password/update"
 end
 
 module DataDomeStatusType
@@ -11,41 +16,117 @@ module DataDomeStatusType
   UNDEFINED = "undefined"
 end
 
+module DataDomePasswordUpdateReason
+  FORCED_RESET = "forcedReset"
+  FORGOT_PASSWORD = "forgotPassword"
+  USER_UPDATE = "userUpdate"
+end
+
+module DataDomePasswordUpdateStatus
+  ATTEMPTED = "attempted"
+  FAILED = "failed"
+  SUCCEEDED = "succeeded"
+  LINK_EXPIRED = "linkExpired"
+end
+
+class DataDomeUserId
+  attr_accessor :id
+
+  def initialize(id:)
+    @id = id
+  end
+
+  def to_s
+    "DataDomeUserId: id=#{@id}"
+  end
+
+  def to_json(options = {})
+    {
+      id: @id,
+    }.to_json
+  end
+end
+
 class DataDomeEvent
-  attr_accessor :action, :status, :account
+  attr_accessor :action, :account, :authentication, :session
 
-  def initialize(action, account, status = DataDomeStatusType::UNDEFINED)
+  def initialize(action, account, authentication: nil, session: nil)
     @action = action
     @account = account
-    @status = status
+    @authentication = authentication
+    @session = session
   end
 
   def merge_with(request_data)
     request_data.instance_variable_set(:@account, @account)
-    request_data.instance_variable_set(:@status, @status)
+    request_data.instance_variable_set(:@authentication, @authentication) if @authentication
+    request_data.instance_variable_set(:@session, @session) if @session
     request_data
   end
 end
 
 class DataDomeLoginEvent < DataDomeEvent
-  def initialize(account:, status: DataDomeStatusType::UNDEFINED)
-    super(DataDomeActionType::LOGIN, account, status)
+  attr_accessor :user, :status
+
+  def initialize(account:, status: DataDomeStatusType::UNDEFINED, authentication: nil, session: nil, user: nil)
+    super(DataDomeActionType::LOGIN, account, authentication: authentication, session: session)
+    @user = user
+    @status = status
+  end
+
+  def merge_with(request_data)
+    super(request_data)
+    request_data.instance_variable_set(:@user, @user) if @user
+    request_data.instance_variable_set(:@status, @status)
+    request_data
   end
 end
 
 class DataDomeRegistrationEvent < DataDomeEvent
-  attr_accessor :user, :session
+  attr_accessor :user
 
-  def initialize(account:, user:, session: nil, status: DataDomeStatusType::UNDEFINED)
-    super(DataDomeActionType::REGISTER, account, status)
-    @session = session
+  def initialize(account:, user:, authentication: nil, session: nil)
+    super(DataDomeActionType::REGISTER, account, authentication: authentication, session: session)
     @user = user
   end
 
   def merge_with(request_data)
     super(request_data)
-    request_data.instance_variable_set(:@session, @session)
     request_data.instance_variable_set(:@user, @user)
     request_data
   end
 end
+
+class DataDomeAccountUpdateEvent < DataDomeEvent
+  attr_accessor :user
+
+  def initialize(account:, user: nil, authentication: nil, session: nil)
+    super(DataDomeActionType::ACCOUNT_UPDATE, account, authentication: authentication, session: session)
+    @user = user
+  end
+
+  def merge_with(request_data)
+    super(request_data)
+    request_data.instance_variable_set(:@user, @user) if @user
+    request_data
+  end
+end
+
+class DataDomePasswordUpdateEvent < DataDomeEvent
+  attr_accessor :reason, :user, :status
+
+  def initialize(account:, reason: nil, status:, authentication: nil, session: nil, user: nil)
+    super(DataDomeActionType::PASSWORD_UPDATE, account, authentication: authentication, session: session)
+    @reason = reason
+    @user = user
+    @status = status
+  end
+
+  def merge_with(request_data)
+    super(request_data)
+    request_data.instance_variable_set(:@reason, @reason)
+    request_data.instance_variable_set(:@user, @user) if @user
+    request_data.instance_variable_set(:@status, @status)
+    request_data
+  end
+end

data/lib/model/user.rb

@@ -1,19 +1,17 @@
 # frozen_string_literal: true
 
-require "time"
 require_relative "./address"
 
 module DataDomeTitle
-  EMPTY = nil
   MR = "mr"
   MRS = "mrs"
   MX = "mx"
 end
 
 class DataDomeUser
-  attr_accessor :id, :title, :first_name, :last_name, :created_at, :phone, :email, :address
+  attr_accessor :id, :title, :first_name, :last_name, :created_at, :phone, :email, :display_name, :description, :picture_urls, :external_urls, :address, :payment_method_updated
 
-  def initialize(id:, title: nil, first_name: nil, last_name: nil, created_at: Time.now.iso8601, phone: nil, email: nil, address: nil)
+  def initialize(id:, title: nil, first_name: nil, last_name: nil, created_at: nil, phone: nil, email: nil, display_name: nil, description: nil, picture_urls: nil, external_urls: nil, address: nil, payment_method_updated: nil)
     @id = id
     @title = title
     @first_name = first_name
@@ -21,22 +19,33 @@ class DataDomeUser
     @created_at = created_at
     @phone = phone
     @email = email
+    @display_name = display_name
+    @description = description
+    @picture_urls = picture_urls || []
+    @external_urls = external_urls || []
     @address = address
+    @payment_method_updated = payment_method_updated
   end
 
   def to_s
-    "DataDomeUser: id=#{@id}, title=#{@title}, firstName=#{@first_name}, lastName=#{@last_name}, createdAt=#{@created_at}, phone=#{@phone}, address=#{@address}"
+    "DataDomeUser: id=#{@id}, title=#{@title}, firstName=#{@first_name}, lastName=#{@last_name}, createdAt=#{@created_at}, phone=#{@phone}, email=#{@email}, displayName=#{@display_name}, description=#{@description}, pictureUrls=#{@picture_urls}, externalUrls=#{@external_urls}, address=#{@address}, paymentMethodUpdated=#{@payment_method_updated}"
   end
 
   def to_json(options = {})
     {
       id: @id,
+      title: @title,
       firstName: @first_name,
       lastName: @last_name,
       createdAt: @created_at,
       phone: @phone,
       email: @email,
-      address: @address,
+      displayName: @display_name,
+      description: @description,
+      pictureUrls: @picture_urls,
+      externalUrls: @external_urls,
+      address: @address.respond_to?(:to_json) ? JSON.parse(@address.to_json) : @address,
+      paymentMethodUpdated: @payment_method_updated,
     }.to_json
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadome_fraud_sdk_ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - DataDome
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2025-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -36,6 +36,7 @@ files:
 - lib/model/address.rb
 - lib/model/api/request.rb
 - lib/model/api/response.rb
+- lib/model/authentication.rb
 - lib/model/events.rb
 - lib/model/location.rb
 - lib/model/operation.rb