minfraud 2.9.0 → 2.10.0

data/lib/minfraud/model/warning.rb

@@ -17,19 +17,30 @@ module Minfraud
     #   our database.
     # * BILLING_POSTAL_NOT_FOUND - the billing postal could not be found in our
     #   database.
+    # * BILLING_REGION_NOT_FOUND - the billing region could not be found in our
+    #   database.
+    # * EMAIL_ADDRESS_UNUSABLE - the email address entered is likely incorrect
+    #   due to an integration issue. To avoid false positives, it has not been
+    #   used in scoring.
     # * INPUT_INVALID - the value associated with the key does not meet the
     #   required constraints, e.g., "United States" in a field that requires a
     #   two-letter country code.
     # * INPUT_UNKNOWN - an unknown key was encountered in the request body.
+    # * IP_ADDRESS_INVALID - the IP address supplied is not a valid IPv4 or
+    #   IPv6 address.
     # * IP_ADDRESS_NOT_FOUND - the IP address could not be geolocated.
-    # * SHIPPING_COUNTRY_MISSING - shipping address information was provided
-    #   without providing a shipping country.
+    # * IP_ADDRESS_RESERVED - the IP address supplied is in a reserved
+    #   network.
     # * SHIPPING_CITY_NOT_FOUND - the shipping city could not be found in our
     #   database.
+    # * SHIPPING_COUNTRY_MISSING - shipping address information was provided
+    #   without providing a shipping country.
     # * SHIPPING_COUNTRY_NOT_FOUND - the shipping country could not be found in
     #   our database.
     # * SHIPPING_POSTAL_NOT_FOUND - the shipping postal could not be found in
     #   our database.
+    # * SHIPPING_REGION_NOT_FOUND - the shipping region could not be found in
+    #   our database.
     class Warning < Abstract
       # This value is a machine-readable code identifying the warning.
       #

data/lib/minfraud/report.rb

@@ -3,7 +3,7 @@
 module Minfraud
   # Report is used to perform minFraud Report Transaction API requests.
   #
-  # @see https://dev.maxmind.com/minfraud/report-a-transaction?lang=en
+  # @see https://dev.maxmind.com/minfraud/report-a-transaction/?lang=en
   class Report
     # The Report::Transaction component.
     #

data/lib/minfraud/validates.rb

@@ -4,10 +4,23 @@ require 'date'
 require 'ipaddr'
 require 'uri'
 
-# rubocop:disable Metrics/ModuleLength
 module Minfraud
   # @!visibility private
+  # Validates provides validation helper methods for component input values.
+  # These methods are used internally when validation is enabled via
+  # Minfraud.enable_validation.
+  #
+  # rubocop:disable Metrics/ModuleLength
   module Validates
+    # Validates that a string value does not exceed a maximum length.
+    #
+    # @param field [String] The field name for error messages.
+    # @param length [Integer] The maximum allowed length.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value exceeds the maximum length.
+    #
+    # @return [nil]
     def validate_string(field, length, value)
       return if !value
 
@@ -16,6 +29,14 @@ module Minfraud
       end
     end
 
+    # Validates that a value is a valid MD5 hash string.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a valid MD5 hash.
+    #
+    # @return [nil]
     def validate_md5(field, value)
       return if !value
 
@@ -24,6 +45,14 @@ module Minfraud
       end
     end
 
+    # Validates that a value is a valid UUID string.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a valid UUID.
+    #
+    # @return [nil]
     def validate_uuid(field, value)
       return if !value
 
@@ -37,6 +66,14 @@ module Minfraud
       end
     end
 
+    # Validates that a value is a valid ISO 3166-2 subdivision code.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a valid subdivision code.
+    #
+    # @return [nil]
     def validate_subdivision_code(field, value)
       return if !value
 
@@ -45,6 +82,14 @@ module Minfraud
       end
     end
 
+    # Validates that a value is a valid ISO 3166-1 alpha-2 country code.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a valid country code.
+    #
+    # @return [nil]
     def validate_country_code(field, value)
       return if !value
 
@@ -53,6 +98,15 @@ module Minfraud
       end
     end
 
+    # Validates that a value is a valid telephone country code (1-4 digits).
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a valid telephone country
+    #   code.
+    #
+    # @return [nil]
     def validate_telephone_country_code(field, value)
       return if !value
 
@@ -61,6 +115,15 @@ module Minfraud
       end
     end
 
+    # Validates that a value matches a regular expression pattern.
+    #
+    # @param field [String] The field name for error messages.
+    # @param regex [Regexp] The regular expression pattern to match.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value does not match the pattern.
+    #
+    # @return [nil]
     def validate_regex(field, regex, value)
       return if !value
 
@@ -69,6 +132,14 @@ module Minfraud
       end
     end
 
+    # Validates that a value is a valid credit card token.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a valid credit card token.
+    #
+    # @return [nil]
     def validate_credit_card_token(field, value)
       return if !value
 
@@ -83,6 +154,14 @@ module Minfraud
       end
     end
 
+    # Validates a custom input value (boolean, numeric, or string).
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [Boolean, Numeric, String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not valid.
+    #
+    # @return [nil]
     def validate_custom_input_value(field, value)
       return if !value
 
@@ -101,6 +180,14 @@ module Minfraud
       validate_string(field, 255, value)
     end
 
+    # Validates that a value is a valid IPv4 or IPv6 address.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a valid IP address.
+    #
+    # @return [nil]
     def validate_ip(field, value)
       return if !value
 
@@ -120,6 +207,15 @@ module Minfraud
       nil
     end
 
+    # Validates that a value is a non-negative number within range.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [Numeric, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a valid non-negative
+    #   number.
+    #
+    # @return [nil]
     def validate_nonnegative_number(field, value)
       return if !value
 
@@ -132,6 +228,15 @@ module Minfraud
       end
     end
 
+    # Validates that a value is a non-negative integer within range.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [Integer, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a valid non-negative
+    #   integer.
+    #
+    # @return [nil]
     def validate_nonnegative_integer(field, value)
       return if !value
 
@@ -144,6 +249,14 @@ module Minfraud
       end
     end
 
+    # Validates that a value is a valid email address or MD5 hash of one.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a valid email or MD5 hash.
+    #
+    # @return [nil]
     def validate_email(field, value)
       return if !value
 
@@ -155,6 +268,14 @@ module Minfraud
       validate_md5(field, value)
     end
 
+    # Validates that a value is in RFC 3339 date-time format.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not in RFC 3339 format.
+    #
+    # @return [nil]
     def validate_rfc3339(field, value)
       return if !value
 
@@ -169,6 +290,14 @@ module Minfraud
       nil
     end
 
+    # Validates that a value is a boolean.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [Boolean, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a boolean.
+    #
+    # @return [nil]
     def validate_boolean(field, value)
       return if !value
 
@@ -177,6 +306,14 @@ module Minfraud
       end
     end
 
+    # Validates that a value is a valid absolute URI.
+    #
+    # @param field [String] The field name for error messages.
+    # @param value [String, nil] The value to validate.
+    #
+    # @raise [InvalidInputError] If the value is not a valid absolute URI.
+    #
+    # @return [nil]
     def validate_uri(field, value)
       return if !value
 
@@ -195,6 +332,6 @@ module Minfraud
       end
       # rubocop:enable Style/RescueStandardError
     end
+    # rubocop:enable Metrics/ModuleLength
   end
 end
-# rubocop:enable Metrics/ModuleLength

data/lib/minfraud/version.rb

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

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: minfraud
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - kushnir.yb
 - William Storey
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -14,16 +14,22 @@ dependencies:
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -33,7 +39,7 @@ dependencies:
         version: '4.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,21 +49,21 @@ dependencies:
         version: '4.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: maxmind-geoip2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: simpleidn
   requirement: !ruby/object:Gem::Requirement
@@ -210,18 +216,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
-- CLAUDE.md
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
-- README.dev.md
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/minfraud.rb
 - lib/minfraud/assessments.rb
 - lib/minfraud/components/account.rb
@@ -271,12 +268,16 @@ files:
 - lib/minfraud/resolver.rb
 - lib/minfraud/validates.rb
 - lib/minfraud/version.rb
-- minfraud.gemspec
 homepage: https://github.com/maxmind/minfraud-api-ruby
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/maxmind/minfraud-api-ruby/issues
+  changelog_uri: https://github.com/maxmind/minfraud-api-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/minfraud
+  homepage_uri: https://github.com/maxmind/minfraud-api-ruby
   rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/maxmind/minfraud-api-ruby
 rdoc_options: []
 require_paths:
 - lib
@@ -291,7 +292,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Ruby API for the minFraud Score, Insights, Factors, and Report Transactions
   services

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.rubocop.yml

@@ -1,113 +0,0 @@
-plugins:
-    - rubocop-performance
-    - rubocop-rake
-    - rubocop-rspec
-    - rubocop-thread_safety
-
-AllCops:
-    TargetRubyVersion: '3.2'
-    NewCops: enable
-
-# Metrics.
-
-Metrics/BlockLength:
-  Enabled: false # Default is true, but mostly hit in tests.
-
-Metrics/AbcSize:
-  Enabled: false # To allow for pre-existing code.
-
-Metrics/ClassLength:
-  Enabled: false # To allow for pre-existing code.
-
-Metrics/CyclomaticComplexity:
-  Enabled: false # To allow for pre-existing code.
-
-Metrics/MethodLength:
-  Enabled: false # To allow for pre-existing code.
-
-Metrics/PerceivedComplexity:
-  Enabled: false # To allow for pre-existing code.
-
-# Layout.
-
-Layout/LineLength:
-  Max: 150 # Default is 120.
-
-Layout/HashAlignment:
-  EnforcedHashRocketStyle: table # Default is key.
-  EnforcedColonStyle:      table # Default is key.
-
-Layout/ExtraSpacing:
-  ForceEqualSignAlignment: true # Default is false.
-
-Layout/IndentationStyle:
-  IndentationWidth: 2 # Default is <none>.
-
-# Style.
-
-Style/HashSyntax:
-  EnforcedStyle: ruby19_no_mixed_keys # Default is ruby19. This one is better.
-
-Style/CollectionMethods:
-  Enabled: true # Default is false.
-
-Style/NumericLiterals:
-  MinDigits: 4 # Default is 5.
-
-Style/NegatedIf: # I disagree with this.
-  Enabled: false
-
-Style/IfUnlessModifier: # This doesn't always make sense.
-  Enabled: false
-
-# Trailing commas are often good.
-Style/TrailingCommaInArguments:
-  Enabled: false
-Style/TrailingCommaInArrayLiteral:
-  Enabled: false
-Style/TrailingCommaInHashLiteral:
-  Enabled: false
-
-# Default is both which is probably fine, but it changes code and I don't want
-# to investigate any possible behavior change right now.
-Style/EmptyElse:
-  EnforcedStyle: empty
-
-Style/ConditionalAssignment:
-  Enabled: false # This produces kind of strange results.
-
-Style/GuardClause:
-  Enabled: false # Doesn't always make sense.
-
-Style/FormatStringToken:
-  Enabled: false # Seems unnecessary.
-
-# Seems unnecessary. Asks us to call super in a bunch of places when there's no
-# need.
-Lint/MissingSuper:
-  Enabled: false
-
-# Naming.
-
-Naming/VariableNumber:
-  Enabled: false # Doesn't always make sense.
-
-Gemspec/DevelopmentDependencies:
-  Enabled: false
-
-# This might make sense, but I don't think it's worth moving things around for.
-RSpec/SpecFilePathFormat:
-  Enabled: false
-# Sometimes it makes sense to have lots of assertions.
-RSpec/MultipleExpectations:
-  Enabled: false
-# Sometimes it makes sense to have long tests.
-RSpec/ExampleLength:
-  Enabled: false
-# This seems okay.
-RSpec/MultipleDescribes:
-  Enabled: false
-# This seems to give a bunch of false positives. Specifically it's flagging
-# things where we are creating an object and checking no exception happens.
-RSpec/NoExpectationExample:
-  Enabled: false