datadome_fraud_sdk_ruby 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 562e73467299bca33309183c1e8f84e26571346082000ca19767295d4bcdb558
-  data.tar.gz: 9f60b87c715a36bc402d76018b9b96f7d30a901d8f1e07b6488f7537c2251f87
+  metadata.gz: 92c514d743f75302d1d5feafa93f424f0835edf132d509586bbda5ecb7a88a46
+  data.tar.gz: 7ede40dea73ad22e61f486122f157e977856ca11ca9e7222de4294ef4e4c7262
 SHA512:
-  metadata.gz: 7163115049e8696367c168e69a36a1fa36f80f6bb64e72baeaab93c9614136feefe89954ec9e415913d51db72eb152670f91e2dac7f5223c5ddc225286d43979
-  data.tar.gz: 6600c8180c52163a5039c47d4ae5895142e57b63a602ae13bef327e4a8137e393a64540bdc00e2bcf8a549b38640c9915e77beb3cc75495ab7ab7a514300eafc
+  metadata.gz: 7d955b2b2051ecf0107fbd2a7f47d79471c6fa7774b61109c347a3a034fa1a2e1b972b08592332e89519686574f7d1c6f5468186210c3e0f0aef057f7357a882
+  data.tar.gz: ba94a9908561d38ef52605aedbccd8c567f8362cc188f688d4b40416b3353fec52efdef3135864830d4f304191c61ed1b23d607947f3cb3387e4bef3e14fcd53

data/README.md

@@ -1,2 +1,3 @@
-# fraud-sdk-ruby
-Fraud Protection for Ruby
+# DataDome Fraud Protection - Ruby SDK
+
+Documentation: https://docs.datadome.co/docs/account-protect

data/lib/constants.rb

@@ -1,2 +1,2 @@
-SDK_VERSION = '0.1.0'
+SDK_VERSION = '1.1.0'
 SDK_NAME = 'datadome_fraud_sdk_ruby'

data/lib/datadome_fraud_sdk_ruby.rb

@@ -12,26 +12,26 @@ require_relative "model/api/response"
 class DataDome
   attr_accessor :timeout, :endpoint, :logger
 
-  def initialize(timeout = 1500, endpoint = "account-api.datadome.co", logger = Logger.new(STDOUT))
+  def initialize(timeout: 1500, endpoint: "account-api.datadome.co", logger: Logger.new(STDOUT))
     @timeout = timeout
     @endpoint = endpoint
     @logger = logger
   end
 
-  def validate(request, event)
-    if event.status == StatusType::UNDEFINED
-      event.status = StatusType::SUCCEEDED
+  def validate(request:, event:)
+    if event.status == DataDomeStatusType::UNDEFINED
+      event.status = DataDomeStatusType::SUCCEEDED
     end
 
     payload = build_payload(request, event)
 
     begin
-      api_response = sendRequest(OperationType::VALIDATE, event.action, payload)
+      api_response = send_request(DataDomeOperationType::VALIDATE, event.action, payload)
 
       begin
         body = JSON.parse(api_response.body) unless api_response.body.nil?
       rescue JSON::ParserError => e
-        @logger.error("DataDome: error parsing JSON from Fraud API #{e.message}")
+        @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)
       end
 
@@ -41,7 +41,7 @@ class DataDome
           datadome_response.action = DataDomeResponseAction::DENY
         end
       else
-        @logger.error("DataDome: error on Fraud API response #{body["errors"]}")
+        @logger.error("DataDome: error on Fraud API /validate response #{body["errors"]}")
         return DataDomeResponseError.new(DataDomeResponseAction::ALLOW, DataDomeResponseStatus::FAILURE, body["message"], body["errors"])
       end
     rescue Faraday::TimeoutError => e
@@ -53,25 +53,25 @@ class DataDome
     datadome_response
   end
 
-  def collect(request, event)
-    if event.status == StatusType::UNDEFINED
-      event.status = StatusType::FAILED
+  def collect(request:, event:)
+    if event.status == DataDomeStatusType::UNDEFINED
+      event.status = DataDomeStatusType::FAILED
     end
 
     payload = build_payload(request, event)
 
     begin
-      api_response = sendRequest(OperationType::COLLECT, event.action, payload)
+      api_response = send_request(DataDomeOperationType::COLLECT, event.action, payload)
 
       if api_response.success?
         datadome_response = DataDomeResponseSuccess.new(nil, DataDomeResponseStatus::OK, nil, nil, nil)
       else
         begin
           body = JSON.parse(api_response.body)
-          @logger.error("DataDome: error on Fraud API response #{body["errors"]}")
+          @logger.error("DataDome: error on Fraud API /collect response #{body["errors"]}")
           datadome_response = DataDomeResponseError.new(nil, DataDomeResponseStatus::FAILURE, body["message"], body["errors"])
         rescue JSON::ParserError => e
-          @logger.error("DataDome: error parsing JSON from Fraud API #{e.message}")
+          @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)
         end
       end
@@ -86,7 +86,7 @@ class DataDome
 
   private
 
-  def sendRequest(operation, event, payload)
+  def send_request(operation, event, payload)
     api_response = client.post("/v1/" + operation + "/" + event) do |req|
       req.body = payload.to_json
     end

data/lib/model/address.rb

@@ -1,21 +1,20 @@
 # frozen_string_literal: true
 
-class Address
-  attr_accessor :name, :line1, :line2, :city, :countryCode, :country, :regionCode, :zipCode
+class DataDomeAddress
+  attr_accessor :name, :line1, :line2, :city, :countryCode, :regionCode, :zipCode
 
-  def initialize(name = nil, line1 = nil, line2 = nil, city = nil, countryCode = nil, country = nil, regionCode = nil, zipCode = nil)
+  def initialize(name: nil, line1: nil, line2: nil, city: nil, countryCode: nil, regionCode: nil, zipCode: nil)
     @name = name
     @line1 = line1
     @line2 = line2
     @city = city
     @countryCode = countryCode
-    @country = country
     @regionCode = regionCode
     @zipCode = zipCode
   end
 
   def to_s
-    "Address: name=#{name}, line1=#{line1}, line2=#{line2}, city=#{city}, countryCode=#{countryCode}, country=#{country}, regionCode=#{regionCode}, zipCode=#{zipCode}"
+    "DataDomeAddress: name=#{name}, line1=#{line1}, line2=#{line2}, city=#{city}, countryCode=#{countryCode}, regionCode=#{regionCode}, zipCode=#{zipCode}"
   end
 
   def to_json(options = {})
@@ -25,7 +24,6 @@ class Address
       line2: line2,
       city: city,
       countryCode: countryCode,
-      country: country,
       regionCode: regionCode,
       zipCode: zipCode,
     }.to_json

data/lib/model/api/request.rb

@@ -2,7 +2,7 @@
 
 require_relative "../../constants"
 
-class DatadomeModule
+class DataDomeModule
   attr_accessor :requestTimeMicros, :name, :version
 
   def initialize
@@ -21,16 +21,16 @@ class DatadomeModule
 end
 
 class DataDomeHeaders
-  attr_accessor :addr, :clientIp, :contentype, :host, :port, :xRealIP, :xForwardedForIp,
+  attr_accessor :addr, :clientIp, :contentType, :host, :port, :xRealIP, :xForwardedForIp,
                 :acceptEncoding, :acceptLanguage, :accept, :method, :protocol, :serverHostname,
                 :referer, :userAgent, :from, :request, :origin, :acceptCharset, :connection,
-                :clientId, :secCHUA, :secCHUAMobile, :secCHUAPlatform, :secCHUAArch,
+                :clientID, :secCHUA, :secCHUAMobile, :secCHUAPlatform, :secCHUAArch,
                 :secCHUAFullVersionList, :secCHUAModel, :secCHDeviceMemory
 
   def initialize(request)
     @addr = request.remote_ip
     @clientIp = request.headers["HTTP_CLIENT_IP"]
-    @contentype = truncate(request.headers["Content-Type"], 64)
+    @contentType = truncate(request.headers["Content-Type"], 64) # this value is a meta-variable of the request
     @host = truncate(request.headers["HTTP_HOST"], 512)
     @port = request.port || 0
     @xRealIP = truncate(request.headers["HTTP_X_REAL_IP"], 128)
@@ -48,7 +48,7 @@ class DataDomeHeaders
     @origin = truncate(request.headers["HTTP_ORIGIN"], 512)
     @acceptCharset = truncate(request.headers["HTTP_ACCEPT_CHARSET"], 128)
     @connection = truncate(request.headers["HTTP_CONNECTION"], 128)
-    @clientId = request.cookies["datadome"]
+    @clientID = request.cookies["datadome"]
     @secCHUA = truncate(request.headers["HTTP_SEC_CH_UA"], 128)
     @secCHUAMobile = truncate(request.headers["HTTP_SEC_CH_UA_MOBILE"], 8)
     @secCHUAPlatform = truncate(request.headers["HTTP_SEC_CH_UA_PLATFORM"], 32)
@@ -69,7 +69,7 @@ class DataDomeRequest
   attr_accessor :module, :header
 
   def initialize(request)
-    @module = DatadomeModule.new
+    @module = DataDomeModule.new
     @header = DataDomeHeaders.new(request)
   end
 

data/lib/model/api/response.rb

@@ -11,7 +11,7 @@ module DataDomeResponseStatus
   TIMEOUT = "timeout"
 end
 
-class Error
+class DataDomeError
   attr_accessor :field, :error
 end
 

data/lib/model/events.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-module ActionType
+module DataDomeActionType
   LOGIN = "login"
   REGISTER = "registration"
-  PAYMENT = "payment"
 end
 
-module StatusType
+module DataDomeStatusType
   SUCCEEDED = "succeeded"
   FAILED = "failed"
   UNDEFINED = "undefined"
@@ -15,7 +14,7 @@ end
 class DataDomeEvent
   attr_accessor :action, :status, :account
 
-  def initialize(action, account, status = StatusType::UNDEFINED)
+  def initialize(action, account, status = DataDomeStatusType::UNDEFINED)
     @action = action
     @account = account
     @status = status
@@ -28,17 +27,17 @@ class DataDomeEvent
   end
 end
 
-class LoginEvent < DataDomeEvent
-  def initialize(account, status = StatusType::UNDEFINED)
-    super(ActionType::LOGIN, account, status)
+class DataDomeLoginEvent < DataDomeEvent
+  def initialize(account:, status: DataDomeStatusType::UNDEFINED)
+    super(DataDomeActionType::LOGIN, account, status)
   end
 end
 
-class RegistrationEvent < DataDomeEvent
+class DataDomeRegistrationEvent < DataDomeEvent
   attr_accessor :user, :session
 
-  def initialize(account, user, session = nil, status = StatusType::UNDEFINED)
-    super(ActionType::REGISTER, account, status)
+  def initialize(account:, user:, session: nil, status: DataDomeStatusType::UNDEFINED)
+    super(DataDomeActionType::REGISTER, account, status)
     @session = session
     @user = user
   end

data/lib/model/operation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module OperationType
+module DataDomeOperationType
   VALIDATE = "validate"
   COLLECT = "collect"
 end

data/lib/model/session.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
+require "time"
+
 class DataDomeSession
-  def initialize(id, createdAt = Time.now.strftime("%s%6N").to_i)
+  attr_reader :id, :createdAt
+
+  def initialize(id:, createdAt: Time.now.iso8601)
     @id = id
     @createdAt = createdAt
   end

data/lib/model/user.rb

@@ -3,7 +3,7 @@
 require "time"
 require_relative "./address"
 
-module Title
+module DataDomeTitle
   EMPTY = nil
   MR = "mr"
   MRS = "mrs"
@@ -11,7 +11,7 @@ module Title
 end
 
 class DataDomeUser
-  def initialize(id, title = nil, firstName = nil, lastName = nil, createdAt = Time.now.iso8601, phone = nil, email = nil, address = nil)
+  def initialize(id:, title: nil, firstName: nil, lastName: nil, createdAt: Time.now.iso8601, phone: nil, email: nil, address: nil)
     @id = id
     @title = title
     @firstName = firstName

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: datadome_fraud_sdk_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - DataDome
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-17 00:00:00.000000000 Z
+date: 2024-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
 description: DataDome Fraud Protection - Ruby SDK
 email: support@datadome.co
 executables: []