minfraud 1.2.0 → 1.3.0

data/lib/minfraud/http_service/request.rb

@@ -4,36 +4,34 @@ require 'faraday'
 
 module Minfraud
   module HTTPService
+    # Request performs HTTP requests.
     class Request
-      # @attribute middleware
-      # @return [Proc] A proc containing Faraday configuration
+      # A proc containing Faraday configuration.
+      #
+      # @return [Proc, nil]
       attr_reader :middleware
 
-      # @attribute server
-      # @return [String] an API endpoint
+      # The API endpoint.
+      #
+      # @return [String, nil]
       attr_reader :server
 
-      # Creates Minfraud::HTTPService::Request instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::HTTPService::Request] Request instance
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         @middleware = params[:middleware]
         @server     = params[:server]
       end
 
-      # Performs an HTTP request to the specified endpoint with given body
-      # @param  [Hash] params hash of parameters.
-      # @return [Farday::Response] Faraday::Response instance
+      # Perform an HTTP request to the specified endpoint with given body.
+      #
+      # @param params [Hash] Hash of parameters, including +:verb+,
+      #   +:endpoint+, and +:body+.
+      #
+      # @return [Farday::Response]
       def perform(params)
-        adapter.send(*params.values_at(:verb, :endpoint, :body))
-      end
-
-      private
-
-      # Creates memoized Faraday::Connection instance
-      # @return [Faraday::Connection] Faraday::Connection instance
-      def adapter
-        @adapter ||= Faraday.new(server, {}, &middleware)
+        connection = Minfraud.connection
+        connection.send(*params.values_at(:verb, :endpoint, :body))
       end
     end
   end

data/lib/minfraud/http_service/response.rb

@@ -7,24 +7,26 @@ require 'minfraud/model/score'
 
 module Minfraud
   module HTTPService
-    # Response class for HTTP requests
+    # Response class for HTTP requests.
     class Response
-      # @attribute status
-      # @return [Integer] HTTP response status
+      # HTTP response status.
+      #
+      # @return [Integer, nil]
       attr_reader :status
 
-      # @attribute body
+      # HTTP response model.
+      #
       # @return [Minfraud::Model::Score, Minfraud::Model::Insights,
-      #   Minfraud::Model::Factors] HTTP response body
+      #   Minfraud::Model::Factors, nil]
       attr_reader :body
 
-      # @attribute headers
-      # @return [Hash] HTTP response headers
+      # HTTP response headers.
+      #
+      # @return [Hash, nil]
       attr_reader :headers
 
-      # Creates Minfraud::HTTPService::Response instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::HTTPService::Response] Response instance
+      # @param params [Hash] Hash of parameters. +:status+, +:endpoint+,
+      #   +:body+, +:locales+, and +:headers+ are used.
       def initialize(params = {})
         @status  = params[:status]
         @body    = make_body(
@@ -35,8 +37,9 @@ module Minfraud
         @headers = params[:headers]
       end
 
-      # Returns minFraud-specific response code
-      # @return [Symbol, nil] minFraud specific request code
+      # Return the minFraud-specific response code.
+      #
+      # @return [Symbol, nil]
       def code
         return nil if body.nil?
 

data/lib/minfraud/model/subscores.rb

@@ -61,6 +61,7 @@ module Minfraud
 
       # The risk associated with the device. If present, this is a value in the
       # range of 0.01 to 99.
+      #
       # @return [Float, nil]
       attr_reader :device
 
@@ -79,6 +80,7 @@ module Minfraud
       # The risk associated with the email address local part (the part of
       # the email address before the @ symbol). If present, this is a value
       # in the range 0.01 to 99.
+      #
       # @return [Float, nil]
       attr_reader :email_local_part
 
@@ -124,6 +126,7 @@ module Minfraud
 
       # The risk associated with the shipping address. If present, this is a
       # value in the range 0.01 to 99.
+      #
       # @return [Float, nil]
       attr_reader :shipping_address
 

data/lib/minfraud/report.rb

@@ -1,38 +1,56 @@
 # frozen_string_literal: true
 
 module Minfraud
+  # Report is used to perform minFraud Report Transaction API requests.
+  #
+  # @see https://dev.maxmind.com/minfraud/report-transaction/
   class Report
     include ::Minfraud::HTTPService
 
-    # @!attribute transaction
-    # @return [Minfraud::Components::Report::Transaction] Report::Transaction component
+    # The Report::Transaction component.
+    #
+    # @return [Minfraud::Components::Report::Transaction, nil]
     attr_accessor :transaction
 
-    # @param  [Hash] params hash of parameters
-    # @return [Minfraud::ReportTransaction] ReportTransaction instance
+    # @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
 
-    # @method report_transaction
-    # Makes a request to the minFraud report transactions API.
-    # Raises an error in case of invalid response.
+    # Perform a request to the minFraud Report Transaction API.
+    #
     # @return [nil]
+    #
+    # @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
-      raw = request.perform(verb: :post, endpoint: 'transactions/report', body: @transaction.to_json)
+      raw = request.perform(
+        verb:     :post,
+        endpoint: 'transactions/report',
+        body:     @transaction.to_json,
+      )
 
       response = ::Minfraud::HTTPService::Response.new(
         status:  raw.status.to_i,
         body:    raw.body,
         headers: raw.headers
       )
+
       ::Minfraud::ErrorHandler.examine(response)
 
       nil
     end
 
-    # Creates memoized Minfraud::HTTPService::Request instance
-    # @return [Minfraud::HTTPService::Request] Request instance based on configuration params
+    private
+
     def request
       @request ||= Request.new(::Minfraud::HTTPService.configuration)
     end

data/lib/minfraud/resolver.rb

@@ -1,12 +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]
@@ -17,7 +23,7 @@ module Minfraud
       end
     end
 
-    # Mapping between components & minFraud request keys
+    # @!visibility private
     MAPPING = {
       account:       ::Minfraud::Components::Account,
       billing:       ::Minfraud::Components::Billing,

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,5 +1,6 @@
 # frozen_string_literal: true
 
 module Minfraud
-  VERSION = '1.2.0'
+  # The Gem version.
+  VERSION = '1.3.0'
 end

data/minfraud.gemspec

@@ -11,11 +11,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ['kushnir.yb']
   spec.email         = ['support@maxmind.com']
 
-  spec.summary       = '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.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
@@ -24,9 +24,11 @@ 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_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.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - kushnir.yb
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -50,6 +50,26 @@ 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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,7 +126,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !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: []
@@ -185,13 +219,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
@@ -199,16 +234,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.0'
 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: []