minfraud 1.1.0 → 1.5.0

data/lib/minfraud/resolver.rb

@@ -1,10 +1,18 @@
+# frozen_string_literal: true
+
 module Minfraud
+  # Resolver provides functionality for setting component attributes.
   module Resolver
     class << self
-      # @param  [Object] context an object for variable assignment
-      # @param  [Hash] params a hash of parameters
-      # @return [Array] a list of supplied params
-      # @note Raises RequestFormatError once unpermitted key is met
+      # Set keys on the context based on the provided parameters.
+      #
+      # @param context [Object] An object for variable assignment.
+      #
+      # @param params [Hash] A hash of parameters.
+      #
+      # @return [Array]
+      #
+      # @raise [Minfraud::RequestFormatError] If an unexpected key is found.
       def assign(context, params)
         Array(params).each do |key, value|
           raise RequestFormatError, "#{key} does not belong to request document format" unless MAPPING[key]
@@ -15,19 +23,19 @@ module Minfraud
       end
     end
 
-    # Mapping between components & minFraud request keys
+    # @!visibility private
     MAPPING = {
-      account:            ::Minfraud::Components::Account,
-      billing:            ::Minfraud::Components::Billing,
-      credit_card:        ::Minfraud::Components::CreditCard,
-      custom_inputs:      ::Minfraud::Components::CustomInputs,
-      device:             ::Minfraud::Components::Device,
-      email:              ::Minfraud::Components::Email,
-      event:              ::Minfraud::Components::Event,
-      order:              ::Minfraud::Components::Order,
-      payment:            ::Minfraud::Components::Payment,
-      shipping:           ::Minfraud::Components::Shipping,
-      shopping_cart:      ::Minfraud::Components::ShoppingCart,
-    }
+      account:       ::Minfraud::Components::Account,
+      billing:       ::Minfraud::Components::Billing,
+      credit_card:   ::Minfraud::Components::CreditCard,
+      custom_inputs: ::Minfraud::Components::CustomInputs,
+      device:        ::Minfraud::Components::Device,
+      email:         ::Minfraud::Components::Email,
+      event:         ::Minfraud::Components::Event,
+      order:         ::Minfraud::Components::Order,
+      payment:       ::Minfraud::Components::Payment,
+      shipping:      ::Minfraud::Components::Shipping,
+      shopping_cart: ::Minfraud::Components::ShoppingCart,
+    }.freeze
   end
 end

data/lib/minfraud/validates.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'ipaddr'
+require 'uri'
+
+# rubocop:disable Metrics/ModuleLength
+module Minfraud
+  # @!visibility private
+  module Validates
+    def validate_string(field, length, value)
+      return if !value
+
+      if value.to_s.length > length
+        raise InvalidInputError, "The #{field} value is not valid. The maximum length is #{length}."
+      end
+    end
+
+    def validate_md5(field, value)
+      return if !value
+
+      if !value.to_s.match(/\A[a-fA-F0-9]{32}\z/)
+        raise InvalidInputError, "The #{field} value is not valid. It must be an MD5 hash as a string."
+      end
+    end
+
+    def validate_subdivision_code(field, value)
+      return if !value
+
+      if !value.to_s.match(/\A[0-9A-Z]{1,4}\z/)
+        raise InvalidInputError, "The #{field} value is not valid. It must be an ISO 3166-2 subdivision code."
+      end
+    end
+
+    def validate_country_code(field, value)
+      return if !value
+
+      if !value.to_s.match(/\A[A-Z]{2}\z/)
+        raise InvalidInputError, "The #{field} value is not valid. It must be an ISO 3166-1 alpha-2 country code."
+      end
+    end
+
+    def validate_telephone_country_code(field, value)
+      return if !value
+
+      if !value.to_s.match(/\A[0-9]{1,4}\z/)
+        raise InvalidInputError, "The #{field} value is not valid. It must be at most 4 digits."
+      end
+    end
+
+    def validate_regex(field, regex, value)
+      return if !value
+
+      if !regex.match(value.to_s)
+        raise InvalidInputError, "The #{field} value is not valid. It must match the pattern #{regex}."
+      end
+    end
+
+    def validate_credit_card_token(field, value)
+      return if !value
+
+      s = value.to_s
+
+      if !/\A[\x21-\x7E]{1,255}\z/.match(s)
+        raise InvalidInputError, "The #{field} value is not valid. It must contain only non-space printable ASCII characters."
+      end
+
+      if /\A[0-9]{1,19}\z/.match(s)
+        raise InvalidInputError, "The #{field} value is not valid. If it is all digits, it must be longer than 19 characters."
+      end
+    end
+
+    def validate_custom_input_value(field, value)
+      return if !value
+
+      if [true, false].include?(value)
+        return
+      end
+
+      if value.is_a? Numeric
+        if value < -1e13 + 1 || value > 1e13 - 1
+          raise InvalidInputError, "The #{field} value is not valid. Numeric values must be between -1e13 and 1e13."
+        end
+
+        return
+      end
+
+      validate_string(field, 255, value)
+    end
+
+    def validate_ip(field, value)
+      return if !value
+
+      s = value.to_s
+      if s.include? '/'
+        raise InvalidInputError, "The #{field} value is not valid. It must be an individual IP address."
+      end
+
+      # rubocop:disable Style/RescueStandardError
+      begin
+        IPAddr.new(s)
+      rescue
+        raise InvalidInputError, "The #{field} value is not valid. It must be an IPv4 or IPv6 address."
+      end
+      # rubocop:enable Style/RescueStandardError
+
+      nil
+    end
+
+    def validate_nonnegative_number(field, value)
+      return if !value
+
+      if !value.is_a? Numeric
+        raise InvalidInputError, "The #{field} value is not valid. It must be numeric."
+      end
+
+      if value < 0 || value > 1e13 - 1
+        raise InvalidInputError, "The #{field} value is not valid. It must be at least 0 and at most 1e13 - 1."
+      end
+    end
+
+    def validate_nonnegative_integer(field, value)
+      return if !value
+
+      if !value.is_a? Integer
+        raise InvalidInputError, "The #{field} is not valid. It must be an integer."
+      end
+
+      if value < 0 || value > 1e13 - 1
+        raise InvalidInputError, "The #{field} is not valid. It must be at least 0 and at most 1e13 - 1."
+      end
+    end
+
+    def validate_email(field, value)
+      return if !value
+
+      if /.@./.match(value)
+        validate_string(field, 255, value)
+        return
+      end
+
+      validate_md5(field, value)
+    end
+
+    def validate_rfc3339(field, value)
+      return if !value
+
+      # rubocop:disable Style/RescueStandardError
+      begin
+        DateTime.rfc3339(value)
+      rescue
+        raise InvalidInputError, "The #{field} value is not valid. It must be in the RFC 3339 date-time format."
+      end
+      # rubocop:enable Style/RescueStandardError
+
+      nil
+    end
+
+    def validate_boolean(field, value)
+      return if !value
+
+      if ![false, true].include? value
+        raise InvalidInputError, "The #{field} value is not valid. It must be boolean."
+      end
+    end
+
+    def validate_uri(field, value)
+      return if !value
+
+      if value.to_s.length > 1_024
+        raise InvalidInputError, "The #{field} value is not valid. It must not exceed 1024 characters."
+      end
+
+      # rubocop:disable Style/RescueStandardError
+      begin
+        u = URI(value)
+        if !u.scheme
+          raise InvalidInputError
+        end
+      rescue
+        raise InvalidInputError, "The #{field} value is not valid. It must be an absolute URI."
+      end
+      # rubocop:enable Style/RescueStandardError
+    end
+  end
+end
+# rubocop:enable Metrics/ModuleLength

data/lib/minfraud/version.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
 module Minfraud
-  VERSION = '1.1.0'
+  # The Gem version.
+  VERSION = '1.5.0'
 end

data/minfraud.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', File.dirname(File.realpath(__FILE__)))
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -9,11 +11,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ['kushnir.yb']
   spec.email         = ['support@maxmind.com']
 
-  spec.summary       = %q(Ruby interface to the MaxMind minFraud v2.0 API services)
+  spec.summary       = 'Ruby API for the minFraud Score, Insights, Factors, and Report Transactions services'
   spec.homepage      = 'https://github.com/maxmind/minfraud-api-ruby'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = '>= 1.9'
+  spec.required_ruby_version = '>= 2.1'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
@@ -22,8 +24,12 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'faraday', '>= 0.9.1', '< 2.0'
   spec.add_runtime_dependency 'faraday_middleware', '>= 0.9.1', '< 2.0'
+  spec.add_runtime_dependency 'net-http-persistent', '>= 2.0.0', '< 5.0'
+  spec.add_runtime_dependency 'simpleidn', '>= 0.1.1'
 
   spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minfraud
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.5.0
 platform: ruby
 authors:
 - kushnir.yb
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -50,6 +50,40 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simpleidn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -92,16 +126,46 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email:
 - support@maxmind.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -161,6 +225,7 @@ files:
 - lib/minfraud/model/geoip2_location.rb
 - lib/minfraud/model/insights.rb
 - lib/minfraud/model/ip_address.rb
+- lib/minfraud/model/ip_risk_reason.rb
 - lib/minfraud/model/issuer.rb
 - lib/minfraud/model/score.rb
 - lib/minfraud/model/score_ip_address.rb
@@ -169,13 +234,14 @@ files:
 - lib/minfraud/model/warning.rb
 - lib/minfraud/report.rb
 - 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: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,16 +249,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 2.7.6.2
-signing_key: 
+signing_key:
 specification_version: 4
-summary: Ruby interface to the MaxMind minFraud v2.0 API services
+summary: Ruby API for the minFraud Score, Insights, Factors, and Report Transactions
+  services
 test_files: []

data/.travis.yml

@@ -1,22 +0,0 @@
-language: ruby
-
-rvm:
-  - 1.9
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-
-notifications:
-  email:
-    on_failure: always
-    on_success: change
-    recipients:
-      - dev-ci@maxmind.com
-  slack:
-    rooms:
-      secure: "wuwMo+BWnaBtkt1uGAi4Zd0EARX3B2TXDmBGCtn8r4PLfehh61S6nLQDASNXSk200PmniFM8PyOUNVGVJqWpYQAEMn32WWdy4vTK2c8CsjwfsMhgnOI2YDCzw+jiP+8EfIGBsPO4xA7yrzweP8gkzBtplb3LbaCiW83WfFo9+402yr0/0F9gfWi8qvuIw29XAS1XWhTY4itqGfkSPdOHQz/45ElpLkGlgreuRrih3tAgn9YLb/Uh/6McHfHkL74YwQU3p0NiZcoleWYM0CLpPzyrN8EsbmIT+L75nIVwXnh62Gx2jJWayj7ZzvyKtVKHtLb/LKRs4Dg0UEg65xX1EcBAkC5fn4KG1jQHvi/tdOx1Sfh3hO6OK+68q1R6cQQYy+uG84q8RUjpO6dzFcWpE1yMdbQ5XMKfTh56ZdhXJ803LD2gGeIgcMwJp6HK9tnf0vaPPI9kbr8fqJBUUkciUoqpYzFd5m0ZCUbJsMD0oPY19FSRtfCNQvCbmhYrLy1sQ5FeMzbF0bi2oaUv+JD/A5RKokNMrrwv3nnTtG4vN1hJklQk2VW3sZWl6UjYgzhrbmKABtvPuB+xcYywIu4+JSworpfDwM/PZAKOfd6n+r8OdNV256l8WaNeF6osvXkUR7yxYpytywdQPA0d/z8mxTVoATE3wat7pnmTrqI5fqw=\n"