minfraud 1.0.4 → 2.4.0

data/lib/minfraud/model/warning.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Warning about the minFraud request.
+    #
+    # Although more codes may be added in the future, the current warning codes
+    # are:
+    #
+    # * BILLING_CITY_NOT_FOUND - the billing city could not be found in our
+    #   database.
+    # * BILLING_COUNTRY_MISSING - billing address information was provided
+    #   without providing a billing country.
+    # * BILLING_COUNTRY_NOT_FOUND - the billing country could not be found in
+    #   our database.
+    # * BILLING_POSTAL_NOT_FOUND - the billing postal could not be found in our
+    #   database.
+    # * 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_NOT_FOUND - the IP address could not be geolocated.
+    # * SHIPPING_COUNTRY_MISSING - shipping address information was provided
+    #   without providing a shipping country.
+    # * SHIPPING_CITY_NOT_FOUND - the shipping city could not be found in our
+    #   database.
+    # * 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.
+    class Warning < Abstract
+      # This value is a machine-readable code identifying the warning.
+      #
+      # @return [String]
+      attr_reader :code
+
+      # This property provides a human-readable explanation of the warning. The
+      # description may change at any time and should not be matched against.
+      #
+      # @return [String]
+      attr_reader :warning
+
+      # A JSON Pointer to the input field that the warning is associated with.
+      # For instance, if the warning was about the billing city, this would be
+      # '/billing/city'. If it was for the price in the second shopping cart
+      # item, it would be '/shopping_cart/1/price'.
+      #
+      # @return [String, nil]
+      attr_reader :input_pointer
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @code          = get('code')
+        @warning       = get('warning')
+        @input_pointer = get('input_pointer')
+      end
+    end
+  end
+end

data/lib/minfraud/report.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Minfraud
+  # Report is used to perform minFraud Report Transaction API requests.
+  #
+  # @see https://dev.maxmind.com/minfraud/report-a-transaction?lang=en
+  class Report
+    # The Report::Transaction component.
+    #
+    # @return [Minfraud::Components::Report::Transaction, nil]
+    attr_accessor :transaction
+
+    # @param params [Hash] Hash of parameters. The only supported key is
+    #   +:transaction+, which should have a
+    #   +Minfraud::Components::Report::Transaction+ as its value.
+    def initialize(params = {})
+      @transaction = params[:transaction]
+    end
+
+    # Perform a request to the minFraud Report Transaction API.
+    #
+    # @return [nil]
+    #
+    # @raise [JSON::ParserError] if there was invalid JSON in the response.
+    #
+    # @raise [Minfraud::AuthorizationError] If there was an authentication
+    #   problem.
+    #
+    # @raise [Minfraud::ClientError] If there was a critical problem with one
+    #   of your inputs.
+    #
+    # @raise [Minfraud::ServerError] If the server reported an error of some
+    #   kind.
+    def report_transaction
+      response = nil
+      body     = nil
+      Minfraud.connection_pool.with do |client|
+        response = client.post(
+          '/minfraud/v2.0/transactions/report',
+          json: @transaction.to_json,
+        )
+
+        body = response.to_s
+      end
+
+      endpoint = nil
+      locales  = nil
+      response = ::Minfraud::HTTPService::Response.new(
+        endpoint,
+        locales,
+        response,
+        body,
+      )
+
+      ::Minfraud::ErrorHandler.examine(response)
+
+      nil
+    end
+
+    private
+
+    def request
+      @request ||= Request.new(::Minfraud::HTTPService.configuration)
+    end
+  end
+end

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,18 +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,
-      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.negative? || 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.negative? || 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.0.4'
+  # The Gem version.
+  VERSION = '2.4.0'
 end

data/lib/minfraud.rb

@@ -1,49 +1,88 @@
+# frozen_string_literal: true
+
+require 'connection_pool'
+require 'http'
 require 'minfraud'
 require 'minfraud/enum'
+require 'minfraud/validates'
 require 'minfraud/components/base'
 require 'minfraud/components/account'
 require 'minfraud/components/addressable'
 require 'minfraud/components/billing'
 require 'minfraud/components/credit_card'
+require 'minfraud/components/custom_inputs'
 require 'minfraud/components/device'
 require 'minfraud/components/email'
 require 'minfraud/components/event'
 require 'minfraud/components/order'
 require 'minfraud/components/payment'
-require 'minfraud/components/shopping_cart_item'
+require 'minfraud/components/report/transaction'
 require 'minfraud/components/shipping'
 require 'minfraud/components/shopping_cart'
-require 'minfraud/components/device'
+require 'minfraud/components/shopping_cart_item'
 require 'minfraud/resolver'
 require 'minfraud/version'
 require 'minfraud/errors'
-require 'minfraud/http_service'
-require 'minfraud/http_service/request'
 require 'minfraud/http_service/response'
 require 'minfraud/error_handler'
 require 'minfraud/assessments'
+require 'minfraud/report'
 
+# This class holds global configuration parameters and provides a namespace
+# for the gem's classes.
 module Minfraud
   class << self
-    # @!attribute user_id
-    # @return [String] MaxMind username that is used for authorization
-    attr_accessor :user_id
+    # The MaxMind account ID that is used for authorization.
+    #
+    # @return [Integer, nil]
+    attr_accessor :account_id
+
+    # Enable client side validation. This is disabled by default.
+    #
+    # @return [Boolean, nil]
+    attr_accessor :enable_validation
 
-    # @!attribute license_key
-    # @return [String] MaxMind license key that is used for authorization
+    # The host to use when connecting to the web service.
+    # By default, the client connects to the production host. However,
+    # during testing and development, you can set this option to
+    # 'sandbox.maxmind.com' to use the Sandbox environment's host. The
+    # sandbox allows you to experiment with the API without affecting your
+    # production data.
+    #
+    # @return [String, nil]
+    attr_accessor :host
+
+    # The MaxMind license key that is used for authorization.
+    #
+    # @return [String, nil]
     attr_accessor :license_key
 
-    # @yield [self] to accept configuration settings
+    # @!visibility private
+    attr_reader :connection_pool
+
+    # Yield self to accept configuration settings.
+    #
+    # @yield [self]
     def configure
       yield self
+
+      pool_size        = 5
+      host             = @host.nil? ? 'minfraud.maxmind.com' : @host
+      @connection_pool = ConnectionPool.new(size: pool_size) do
+        make_http_client.persistent("https://#{host}")
+      end
     end
 
-    # @return [Hash] current Minfraud configuration
-    def configuration
-      {
-        user_id:     @user_id,
-        license_key: @license_key
-      }
+    private
+
+    def make_http_client
+      HTTP.basic_auth(
+        user: @account_id,
+        pass: @license_key,
+      ).headers(
+        accept:     'application/json',
+        user_agent: "minfraud-api-ruby/#{Minfraud::VERSION} ruby/#{RUBY_VERSION} http/#{HTTP::VERSION}",
+      )
     end
   end
 end

data/minfraud.gemspec

@@ -1,29 +1,38 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'minfraud/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "minfraud"
+  spec.name          = 'minfraud'
   spec.version       = Minfraud::VERSION
-  spec.authors       = ["kushnir.yb"]
-  spec.email         = ["kushnir.yb@gmail.com"]
+  spec.authors       = ['kushnir.yb', 'William Storey']
+  spec.email         = ['support@maxmind.com']
 
-  spec.summary       = %q{Ruby interface to the MaxMind minFraud v2.0 API services}
-  spec.homepage      = "https://github.com/kushniryb/minfraud-api-v2"
-  spec.license       = "MIT"
+  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.7.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency 'faraday', '~> 0.9', '>= 0.9.1'
-  spec.add_runtime_dependency 'faraday_middleware', '~> 0.9', '>= 0.9.1'
-  spec.add_runtime_dependency 'hashie', '~> 3.0'
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  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_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.23'
+  spec.add_development_dependency 'webmock', '~> 3.14'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end