minfraud 1.1.0 → 1.5.0

data/Rakefile

@@ -1,6 +1,12 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+RuboCop::RakeTask.new
+
+task default: :spec
+task default: :rubocop

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "minfraud"
+require 'bundler/setup'
+require 'minfraud'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "minfraud"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/maxmind/geoip2/model/city.rb

@@ -68,9 +68,9 @@ module MaxMind
         # @!visibility private
         def initialize(record, locales)
           super(record, locales)
-          @city = MaxMind::GeoIP2::Record::City.new(record['city'], locales)
-          @location = MaxMind::GeoIP2::Record::Location.new(record['location'])
-          @postal = MaxMind::GeoIP2::Record::Postal.new(record['postal'])
+          @city         = MaxMind::GeoIP2::Record::City.new(record['city'], locales)
+          @location     = MaxMind::GeoIP2::Record::Location.new(record['location'])
+          @postal       = MaxMind::GeoIP2::Record::Postal.new(record['postal'])
           @subdivisions = create_subdivisions(record['subdivisions'], locales)
         end
 

data/lib/maxmind/geoip2/model/country.rb

@@ -69,16 +69,16 @@ module MaxMind
 
         # @!visibility private
         def initialize(record, locales)
-          @continent = MaxMind::GeoIP2::Record::Continent.new(
+          @continent           = MaxMind::GeoIP2::Record::Continent.new(
             record['continent'],
             locales,
           )
-          @country = MaxMind::GeoIP2::Record::Country.new(
+          @country             = MaxMind::GeoIP2::Record::Country.new(
             record['country'],
             locales,
           )
-          @maxmind = MaxMind::GeoIP2::Record::MaxMind.new(record['maxmind'])
-          @registered_country = MaxMind::GeoIP2::Record::Country.new(
+          @maxmind             = MaxMind::GeoIP2::Record::MaxMind.new(record['maxmind'])
+          @registered_country  = MaxMind::GeoIP2::Record::Country.new(
             record['registered_country'],
             locales,
           )
@@ -86,7 +86,7 @@ module MaxMind
             record['represented_country'],
             locales,
           )
-          @traits = MaxMind::GeoIP2::Record::Traits.new(record['traits'])
+          @traits              = MaxMind::GeoIP2::Record::Traits.new(record['traits'])
         end
       end
     end

data/lib/maxmind/geoip2/record/traits.rb

@@ -33,9 +33,9 @@ module MaxMind
         # @!visibility private
         def initialize(record)
           super(record)
-          if !record.key?('network') && record.key?('ip_address') &&
+          if record && !record.key?('network') && record.key?('ip_address') &&
              record.key?('prefix_length')
-            ip = IPAddr.new(record['ip_address']).mask(record['prefix_length'])
+            ip                = IPAddr.new(record['ip_address']).mask(record['prefix_length'])
             # We could use ip.prefix instead of record['prefix_length'], but that
             # method only becomes available in Ruby 2.5+.
             record['network'] = format('%s/%d', ip.to_s, record['prefix_length'])
@@ -89,7 +89,7 @@ module MaxMind
         # NAT, this may differ from the IP address locally assigned to it. This
         # attribute is returned by all end points.
         #
-        # @return [String]
+        # @return [String, nil]
         def ip_address
           get('ip_address')
         end
@@ -139,6 +139,15 @@ module MaxMind
           get('is_public_proxy')
         end
 
+        # This is true if the IP address is on a suspected anonymizing network
+        # and belongs to a residential ISP. This property is only available
+        # from GeoIP2 Precision Insights.
+        #
+        # @return [Boolean]
+        def residential_proxy?
+          get('is_residential_proxy')
+        end
+
         # This is true if the IP address is a Tor exit node. This property is only
         # available from GeoIP2 Precision Insights.
         #
@@ -160,7 +169,7 @@ module MaxMind
         # this is the largest network where all of the fields besides ip_address
         # have the same value.
         #
-        # @return [String]
+        # @return [String, nil]
         def network
           get('network')
         end

data/lib/minfraud.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
+require 'faraday'
 require 'minfraud'
 require 'minfraud/enum'
+require 'minfraud/validates'
 require 'minfraud/components/base'
 require 'minfraud/components/account'
 require 'minfraud/components/addressable'
@@ -25,22 +29,56 @@ 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 account ID that is used for authorization
+    # 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
+
+    # The host to use when connecting to the web service.
+    #
+    # @return [String, nil]
+    attr_accessor :host
+
+    # The MaxMind account ID that is used for authorization.
+    #
+    # @deprecated Use {::account_id} instead. This will be removed in the next
+    #   major version.
+    #
+    # @return [Integer, nil]
     attr_accessor :user_id
 
-    # @!attribute license_key
-    # @return [String] MaxMind license key that is used for authorization
+    # 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
+
+    # Yield self to accept configuration settings.
+    #
+    # @yield [self]
     def configure
       yield self
+
+      config      = Minfraud::HTTPService.configuration
+      @connection = Faraday.new(config[:server], {}, &config[:middleware])
     end
 
-    # @return [Hash] current Minfraud configuration
+    # The current Minfraud configuration.
+    #
+    # @deprecated This will be removed in the next major version.
+    #
+    # @return [Hash]
     def configuration
       {
         user_id:     @user_id,

data/lib/minfraud/assessments.rb

@@ -1,56 +1,76 @@
+# frozen_string_literal: true
+
 module Minfraud
+  # Assessments is used to perform minFraud Score, Insights, and Factors
+  # requests.
+  #
+  # @see https://dev.maxmind.com/minfraud/
   class Assessments
     include ::Minfraud::HTTPService
     include ::Minfraud::Resolver
 
-    # @attribute account
-    # @return [Minfraud::Components::Account] Account component
+    # The Account component.
+    #
+    # @return [Minfraud::Components::Account, nil]
     attr_accessor :account
 
-    # @attribute billing
-    # @return [Minfraud::Components::Billing] Billing component
+    # The Billing component.
+    #
+    # @return [Minfraud::Components::Billing, nil]
     attr_accessor :billing
 
-    # @attribute credit_card
-    # @return [Minfraud::Components::CreditCard] CreditCard component
+    # The CreditCard component.
+    #
+    # @return [Minfraud::Components::CreditCard, nil]
     attr_accessor :credit_card
 
-    # @attribute custom_inputs
-    # @return [Minfraud::Components::CustomInputs] CustomInputs component
+    # The CustomInputs component.
+    #
+    # @return [Minfraud::Components::CustomInputs, nil]
     attr_accessor :custom_inputs
 
-    # @attribute device
-    # @return [Minfraud::Components::Device] Device component
+    # The Device component.
+    #
+    # @return [Minfraud::Components::Device, nil]
     attr_accessor :device
 
-    # @attribute email
-    # @return [Minfraud::Components::Email] Email component
+    # The Email component.
+    #
+    # @return [Minfraud::Components::Email, nil]
     attr_accessor :email
 
-    # @attribute event
-    # @return [Minfraud::Components::Event] Event component
+    # The Event component.
+    #
+    # @return [Minfraud::Components::Event, nil]
     attr_accessor :event
 
-    # @attribute order
-    # @return [Minfraud::Components::Order] Order component
+    # The Order component.
+    #
+    # @return [Minfraud::Components::Order, nil]
     attr_accessor :order
 
-    # @attribute payment
-    # @return [Minfraud::Components::Payment] Payment component
+    # The Payment component.
+    #
+    # @return [Minfraud::Components::Payment, nil]
     attr_accessor :payment
 
-    # @!attribute shipping
-    # @return [Minfraud::Components::Shipping] Shipping component
+    # The Shipping component.
+    #
+    # @return [Minfraud::Components::Shipping, nil]
     attr_accessor :shipping
 
-    # @!attribute shopping_cart
-    # @return [Minfraud::Components::ShoppingCart] ShoppingCart component
+    # The ShoppingCart component.
+    #
+    # @return [Minfraud::Components::ShoppingCart, nil]
     attr_accessor :shopping_cart
 
-    # @param  [Hash] params hash of parameters
-    # @param  [Minfraud::Resolver] resolver resolver that maps params to components
-    # @note In case when params is a Hash of components it just assigns them to the corresponding instance variables
-    # @return [Minfraud::Assessments] Assessments instance
+    # @param params [Hash] Hash of parameters. Each key is a symbol
+    #   corresponding to one of the available component attributes. Values may
+    #   be component objects or hashes that will be provided to the component
+    #   constructors.
+    #
+    # @param resolver [Minfraud::Resolver] Resolver that maps parameters to
+    #   components.
     def initialize(params = {}, resolver = ::Minfraud::Resolver)
       @locales = params.delete('locales')
       @locales = ['en'] if @locales.nil?
@@ -58,42 +78,82 @@ module Minfraud
       resolver.assign(self, params)
     end
 
-    # @!macro [attach] define
-    #   @method $1
-    #   Makes a request to minFraud $1 endpoint.
-    #   Raises an error in case of invalid response
-    #   @return [Minfraud::HTTPService::Response] Wrapped minFraud response
-    def self.define(endpoint)
-      define_method(endpoint) do
-        raw       = request.perform(verb: :post, endpoint: endpoint.to_s, body: request_body)
-        response  = ::Minfraud::HTTPService::Response.new(
-          endpoint: endpoint,
-          locales:  @locales,
-          status:   raw.status.to_i,
-          body:     raw.body,
-          headers:  raw.headers
-        )
-
-        ::Minfraud::ErrorHandler.examine(response)
-      end
+    # Perform a minFraud Factors request.
+    #
+    # @return [Minfraud::HTTPService::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 factors
+      perform_request(:factors)
     end
 
-    define :score
-    define :insights
-    define :factors
+    # Perform a minFraud Insights request.
+    #
+    # @return [Minfraud::HTTPService::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 insights
+      perform_request(:insights)
+    end
+
+    # Perform a minFraud Score request.
+    #
+    # @return [Minfraud::HTTPService::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 score
+      perform_request(:score)
+    end
 
     private
-    # Creates a unified request body from components converted to JSON
-    # @return [Hash] Request body
+
+    def perform_request(endpoint)
+      raw = request.perform(
+        verb:     :post,
+        endpoint: endpoint.to_s,
+        body:     request_body,
+      )
+
+      response = ::Minfraud::HTTPService::Response.new(
+        endpoint: endpoint,
+        locales:  @locales,
+        status:   raw.status.to_i,
+        body:     raw.body,
+        headers:  raw.headers
+      )
+
+      ::Minfraud::ErrorHandler.examine(response)
+    end
+
     def request_body
-      MAPPING.keys.inject({}) do |mem, e|
-        next mem unless value = send(e)
+      MAPPING.keys.reduce({}) do |mem, e|
+        next mem unless (value = send(e))
+
         mem.merge!(e.to_s => value.to_json)
       end
     end
 
-    # Creates memoized Minfraud::HTTPService::Request instance
-    # @return [Minfraud::HTTPService::Request] Request instance based on configuration params
     def request
       @request ||= Request.new(::Minfraud::HTTPService.configuration)
     end

data/lib/minfraud/components/account.rb

@@ -1,22 +1,44 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # Account corresponds to the account object of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Account_(/account)
     class Account < Base
-      # @attribute user_id
-      # @return [String] A unique user ID associated with the end-user in your system.
-      # If your system allows the login name for the account to be changed, this should not be the login name for the account,
-      # but rather should be an internal ID that does not change. This is not your MaxMind user ID.
+      include Minfraud::Validates
+
+      # A unique user ID associated with the end-user in your system. If your
+      # system allows the login name for the account to be changed, this should
+      # not be the login name for the account, but rather should be an internal
+      # ID that does not change. This is not your MaxMind account ID. No
+      # specific format is required.
+      #
+      # @return [String, nil]
       attr_accessor :user_id
 
-      # @attribute username_md5
-      # @return [String] An MD5 hash as a hexadecimal string of the username or login name associated with the account
+      # An MD5 hash as a hexadecimal string of the username or login name
+      # associated with the account.
+      #
+      # @return [String, nil]
       attr_accessor :username_md5
 
-      # Creates Minfraud::Components::Account instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::Account] an Account instance
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         @user_id      = params[:user_id]
         @username_md5 = params[:username_md5]
+
+        validate
+      end
+
+      private
+
+      def validate
+        return if !Minfraud.enable_validation
+
+        validate_string('user_id', 255, @user_id)
+        validate_md5('username_md5', @username_md5)
       end
     end
   end