minfraud 2.6.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d7569d3a79d640e8ecd0a2fe83996701e2d378bac780a2e0ee7e40ea0651136
-  data.tar.gz: 799568df38549e698099950480c8f88e8a395df2214cfd47beb830c9f1c42a85
+  metadata.gz: 94219dcd7ef78fdea77b06565b3a73ff8073ea56755f2a9ab25a0d4ba97eb692
+  data.tar.gz: a7e3cfa6b732da9f5d23877b4abef0cb7e7641ed30d690af2fc141ee6298cec8
 SHA512:
-  metadata.gz: f49ac7777a332043c94e1c73d5cfb34e1caa27477eeebc23ebb31b97929d3012378f40ebd78ca6662982d2ef3fc1f5f6f40862169e381ceb6f710e79c8e5a411
-  data.tar.gz: 40b65dd1c1eba11d44bb0fc82e0df0e67b943ed43b521198d5c4c4bc81fe2aa79077cc6d4ca86cf873e25f0930e0f7f77b49e4ff68b1b49919cc0d5e92da8b05
+  metadata.gz: d79f083900533abbe2fc0d82b5c67d91c8bf81cee4ac95ef37c42c40eb50cf8f1bd1642acc6b80fdc50234f1cded773f47a62548fa0d360bab92c5fcd6b3cbb5
+  data.tar.gz: 5d868acf7b455dd212b8481e0c31e1cc9156e5c39a38ddf38d9d230b2344250fbae51551aec91556e532a601f2e51e4424e8c2b02eca024e84b4b23a600f0c2b

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-    TargetRubyVersion: 2.7
+    TargetRubyVersion: '3.0'
     NewCops: enable
 
 # Metrics.

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## v2.7.1 (2025-02-10)
+
+* Re-release due to bug in release workflow.
+
+## v2.7.0 (2025-02-10)
+
+* The minFraud Factors subscores have been deprecated. They will be removed
+  in March 2025. Please see [our release notes](https://dev.maxmind.com/minfraud/release-notes/2024/#deprecation-of-risk-factor-scoressubscores)
+  for more information.
+* Ruby 3.0+ is now required. If you're using Ruby 2.7, please use version
+  2.7.0.beta1 or 2.6.0 of this gem.
+* Added the processor `:epayco` to `Minfraud::Components::Payment`.
+
+## v2.7.0.beta1 (2024-09-06)
+
+* Added support for the new risk reasons outputs in minFraud Factors. The risk
+  reasons output codes and reasons are currently in beta and are subject to
+  change. We recommend that you use these beta outputs with caution and avoid
+  relying on them for critical applications.
+
 ## v2.6.0 (2024-07-08)
 
 * Updated the validation for the Report Transactions API to make the

data/LICENSE.txt

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2016-2020 kushnir.yb
-Copyright (c) 2020-2024 MaxMind, Inc.
+Copyright (c) 2020-2025 MaxMind, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -275,7 +275,7 @@ to the client API, please see
 
 ## Requirements
 
-This gem works with Ruby 2.7 and above.
+This gem works with Ruby 3.0 and above.
 
 ## Contributing
 
@@ -293,7 +293,7 @@ This API uses [Semantic Versioning](https://semver.org/).
 
 Copyright (c) 2016-2020 kushnir.yb.
 
-Copyright (c) 2020-2024 MaxMind, Inc.
+Copyright (c) 2020-2025 MaxMind, Inc.
 
 The gem is available as open source under the terms of the [MIT
 License](https://opensource.org/licenses/MIT).

data/lib/minfraud/components/payment.rb

@@ -68,6 +68,7 @@ module Minfraud
         elavon
         emerchantpay
         epay
+        epayco
         eprocessing_network
         epx
         eway

data/lib/minfraud/model/factors.rb

@@ -2,21 +2,39 @@
 
 require 'minfraud/model/insights'
 require 'minfraud/model/subscores'
+require 'minfraud/model/risk_score_reason'
 
 module Minfraud
   module Model
     # Model representing the Factors response.
     class Factors < Insights
+      # This field contains RiskScoreReason objects that describe risk score reasons
+      # for a given transaction that change the risk score significantly.
+      # Risk score reasons are usually only returned for medium to high risk transactions.
+      # If there were no significant changes to the risk score due to these reasons,
+      # then this array will be empty.
+      #
+      # @return [Array<Minfraud::Model::RiskScoreReason>]
+      attr_reader :risk_score_reasons
+
       # An object containing scores for many of the individual risk factors
       # that are used to calculate the overall risk score.
       #
       # @return [Minfraud::Model::Subscores]
+      # @deprecated Use {::risk_score_reasons} instead.
       attr_reader :subscores
 
       # @!visibility private
       def initialize(record, locales)
         super
 
+        @risk_score_reasons = []
+        if record&.key?('risk_score_reasons')
+          record['risk_score_reasons'].each do |r|
+            @risk_score_reasons << Minfraud::Model::RiskScoreReason.new(r)
+          end
+        end
+
         @subscores = Minfraud::Model::Subscores.new(get('subscores'))
       end
     end

data/lib/minfraud/model/reason.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # The risk score reason for the multiplier.
+    #
+    # This class provides both a machine-readable code and a human-readable
+    # explanation of the reason for the risk score, see
+    # https://dev.maxmind.com/minfraud/api-documentation/responses/schema--response--risk-score-reason--multiplier-reason.
+    # Although more codes may be added in the future, the current codes are:
+    #
+    # * BROWSER_LANGUAGE - Riskiness of the browser user-agent and
+    #   language associated with the request.
+    # * BUSINESS_ACTIVITY - Riskiness of business activity
+    #   associated with the request.
+    # * COUNTRY - Riskiness of the country associated with the request.
+    # * CUSTOMER_ID - Riskiness of a customer's activity.
+    # * EMAIL_DOMAIN - Riskiness of email domain.
+    # * EMAIL_DOMAIN_NEW - Riskiness of newly-sighted email domain.
+    # * EMAIL_ADDRESS_NEW - Riskiness of newly-sighted email address.
+    # * EMAIL_LOCAL_PART - Riskiness of the local part of the email address.
+    # * EMAIL_VELOCITY - Velocity on email - many requests on same email
+    #   over short period of time.
+    # * ISSUER_ID_NUMBER_COUNTRY_MISMATCH - Riskiness of the country mismatch
+    #   between IP, billing, shipping and IIN country.
+    # * ISSUER_ID_NUMBER_ON_SHOP_ID - Risk of Issuer ID Number for the shop ID.
+    # * ISSUER_ID_NUMBER_LAST_DIGITS_ACTIVITY - Riskiness of many recent requests
+    #   and previous high-risk requests on the IIN and last digits of the credit card.
+    # * ISSUER_ID_NUMBER_SHOP_ID_VELOCITY - Risk of recent Issuer ID Number activity
+    #   for the shop ID.
+    # * INTRACOUNTRY_DISTANCE - Risk of distance between IP, billing,
+    #   and shipping location.
+    # * ANONYMOUS_IP - Risk due to IP being an Anonymous IP.
+    # * IP_BILLING_POSTAL_VELOCITY - Velocity of distinct billing postal code
+    #   on IP address.
+    # * IP_EMAIL_VELOCITY - Velocity of distinct email address on IP address.
+    # * IP_HIGH_RISK_DEVICE - High-risk device sighted on IP address.
+    # * IP_ISSUER_ID_NUMBER_VELOCITY - Velocity of distinct IIN on IP address.
+    # * IP_ACTIVITY - Riskiness of IP based on minFraud network activity.
+    # * LANGUAGE - Riskiness of browser language.
+    # * MAX_RECENT_EMAIL - Riskiness of email address
+    #   based on past minFraud risk scores on email.
+    # * MAX_RECENT_PHONE - Riskiness of phone number
+    #   based on past minFraud risk scores on phone.
+    # * MAX_RECENT_SHIP - Riskiness of email address
+    #   based on past minFraud risk scores on ship address.
+    # * MULTIPLE_CUSTOMER_ID_ON_EMAIL - Riskiness of email address
+    #   having many customer IDs.
+    # * ORDER_AMOUNT - Riskiness of the order amount.
+    # * ORG_DISTANCE_RISK - Risk of ISP and distance between
+    #   billing address and IP location.
+    # * PHONE - Riskiness of the phone number or related numbers.
+    # * CART - Riskiness of shopping cart contents.
+    # * TIME_OF_DAY - Risk due to local time of day.
+    # * TRANSACTION_REPORT_EMAIL - Risk due to transaction reports
+    #   on the email address.
+    # * TRANSACTION_REPORT_IP - Risk due to transaction reports on the IP address.
+    # * TRANSACTION_REPORT_PHONE - Risk due to transaction reports
+    #   on the phone number.
+    # * TRANSACTION_REPORT_SHIP - Risk due to transaction reports
+    #   on the shipping address.
+    # * EMAIL_ACTIVITY - Riskiness of the email address
+    #   based on minFraud network activity.
+    # * PHONE_ACTIVITY - Riskiness of the phone number
+    #   based on minFraud network activity.
+    # * SHIP_ACTIVITY - Riskiness of ship address based on minFraud network activity.
+    class Reason < Abstract
+      # This value is a machine-readable code identifying the reason.
+      #
+      # @return [String]
+      attr_reader :code
+
+      # This property provides a human-readable explanation of the reason. The
+      # description may change at any time and should not be matched against.
+      #
+      # @return [String]
+      attr_reader :reason
+
+      # @!visibility private
+      def initialize(record)
+        super
+
+        @code   = get('code')
+        @reason = get('reason')
+      end
+    end
+  end
+end

data/lib/minfraud/model/risk_score_reason.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/reason'
+
+module Minfraud
+  module Model
+    # The risk score multiplier and the reasons for that multiplier.
+    class RiskScoreReason < Abstract
+      # The factor by which the risk score is increased (if the value is greater than 1)
+      # or decreased (if the value is less than 1) for given risk reason(s).
+      # Multipliers greater than 1.5 and less than 0.66 are considered significant
+      # and lead to risk reason(s) being present.
+      #
+      # @return [Float]
+      attr_reader :multiplier
+
+      # This field contains Risk objects that describe one of the reasons for the multiplier.
+      #
+      # @return [Array<Minfraud::Model::Risk>]
+      attr_reader :reasons
+
+      # @!visibility private
+      def initialize(record)
+        super
+
+        @multiplier = get('multiplier')
+
+        @reasons = []
+        if record&.key?('reasons')
+          record['reasons'].each do |r|
+            @reasons << Minfraud::Model::Reason.new(r)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minfraud/model/subscores.rb

@@ -5,6 +5,8 @@ require 'minfraud/model/abstract'
 module Minfraud
   module Model
     # Score for risk factors that are used in calculating the riskScore.
+    #
+    # @deprecated Use {RiskScoreReason} instead.
     class Subscores < Abstract
       # The risk associated with the AVS result. If present, this is a value in
       # the range 0.01 to 99.

data/lib/minfraud/version.rb

@@ -2,5 +2,5 @@
 
 module Minfraud
   # The Gem version.
-  VERSION = '2.6.0'
+  VERSION = '2.7.1'
 end

data/minfraud.gemspec

@@ -15,17 +15,17 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/maxmind/minfraud-api-ruby'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^.gitignore$|^(?:\.github|dev-bin|spec)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'connection_pool', '~> 2.2'
-  spec.add_runtime_dependency 'http', '>= 4.3', '< 6.0'
-  spec.add_runtime_dependency 'maxmind-geoip2', '~> 1.2'
-  spec.add_runtime_dependency 'simpleidn', '~> 0.1', '>= 0.1.1'
+  spec.add_dependency 'connection_pool', '~> 2.2'
+  spec.add_dependency 'http', '>= 4.3', '< 6.0'
+  spec.add_dependency 'maxmind-geoip2', '~> 1.2'
+  spec.add_dependency 'simpleidn', '~> 0.1', '>= 0.1.1'
 
   spec.add_development_dependency 'bundler', '~> 2.2'
   spec.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minfraud
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.1
 platform: ruby
 authors:
 - kushnir.yb
 - William Storey
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -149,7 +148,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.14'
-description: 
 email:
 - support@maxmind.com
 executables: []
@@ -204,6 +202,8 @@ files:
 - lib/minfraud/model/ip_risk_reason.rb
 - lib/minfraud/model/issuer.rb
 - lib/minfraud/model/phone.rb
+- lib/minfraud/model/reason.rb
+- lib/minfraud/model/risk_score_reason.rb
 - lib/minfraud/model/score.rb
 - lib/minfraud/model/score_ip_address.rb
 - lib/minfraud/model/shipping_address.rb
@@ -219,7 +219,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -227,15 +226,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby API for the minFraud Score, Insights, Factors, and Report Transactions
   services