minfraud 1.0.2 → 1.3.0

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

@@ -0,0 +1,233 @@
+# Copyright (c) 2020 by MaxMind, Inc.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require 'ipaddr'
+require 'maxmind/geoip2/record/abstract'
+
+module MaxMind
+  module GeoIP2
+    module Record
+      # Contains data for the traits record associated with an IP address.
+      #
+      # This record is returned by all location services and databases.
+      class Traits < Abstract
+        # @!visibility private
+        def initialize(record)
+          super(record)
+          if !record.key?('network') && record.key?('ip_address') &&
+             record.key?('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'])
+          end
+        end
+
+        # The autonomous system number associated with the IP address. See
+        # Wikipedia[https://en.wikipedia.org/wiki/Autonomous_system_(Internet)].
+        # This attribute is only available from the City and Insights web service
+        # and the GeoIP2 Enterprise database.
+        #
+        # @return [Integer, nil]
+        def autonomous_system_number
+          get('autonomous_system_number')
+        end
+
+        # The organization associated with the registered autonomous system number
+        # for the IP address. See
+        # Wikipedia[https://en.wikipedia.org/wiki/Autonomous_system_(Internet)].
+        # This attribute is only available from the City and Insights web service
+        # and the GeoIP2 Enterprise database.
+        #
+        # @return [String, nil]
+        def autonomous_system_organization
+          get('autonomous_system_organization')
+        end
+
+        # The connection type may take the following  values: "Dialup",
+        # "Cable/DSL", "Corporate", "Cellular". Additional values may be added in
+        # the future. This attribute is only available in the GeoIP2 Enterprise
+        # database.
+        #
+        # @return [String, nil]
+        def connection_type
+          get('connection_type')
+        end
+
+        # The second level domain associated with the IP address. This will be
+        # something like "example.com" or "example.co.uk", not "foo.example.com".
+        # This attribute is only available from the City and Insights web service
+        # and the GeoIP2 Enterprise database.
+        #
+        # @return [String, nil]
+        def domain
+          get('domain')
+        end
+
+        # The IP address that the data in the model is for. If you performed a "me"
+        # lookup against the web service, this will be the externally routable IP
+        # address for the system the code is running on. If the system is behind a
+        # NAT, this may differ from the IP address locally assigned to it. This
+        # attribute is returned by all end points.
+        #
+        # @return [String]
+        def ip_address
+          get('ip_address')
+        end
+
+        # This is true if the IP address belongs to any sort of anonymous network.
+        # This property is only available from GeoIP2 Precision Insights.
+        #
+        # @return [Boolean]
+        def anonymous?
+          get('is_anonymous')
+        end
+
+        # This is true if the IP address is registered to an anonymous VPN
+        # provider. If a VPN provider does not register subnets under names
+        # associated with them, we will likely only flag their IP ranges using the
+        # hosting_provider? property. This property is only available from GeoIP2
+        # Precision Insights.
+        #
+        # @return [Boolean]
+        def anonymous_vpn?
+          get('is_anonymous_vpn')
+        end
+
+        # This is true if the IP address belongs to a hosting or VPN provider (see
+        # description of the anonymous_vpn? property). This property is only
+        # available from GeoIP2 Precision Insights.
+        #
+        # @return [Boolean]
+        def hosting_provider?
+          get('is_hosting_provider')
+        end
+
+        # This attribute is true if MaxMind believes this IP address to be a
+        # legitimate proxy, such as an internal VPN used by a corporation. This
+        # attribute is only available in the GeoIP2 Enterprise database.
+        #
+        # @return [Boolean]
+        def legitimate_proxy?
+          get('is_legitimate_proxy')
+        end
+
+        # This is true if the IP address belongs to a public proxy. This property
+        # is only available from GeoIP2 Precision Insights.
+        #
+        # @return [Boolean]
+        def public_proxy?
+          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.
+        #
+        # @return [Boolean]
+        def tor_exit_node?
+          get('is_tor_exit_node')
+        end
+
+        # The name of the ISP associated with the IP address. This attribute is
+        # only available from the City and Insights web services and the GeoIP2
+        # Enterprise database.
+        #
+        # @return [String, nil]
+        def isp
+          get('isp')
+        end
+
+        # The network in CIDR notation associated with the record. In particular,
+        # this is the largest network where all of the fields besides ip_address
+        # have the same value.
+        #
+        # @return [String]
+        def network
+          get('network')
+        end
+
+        # The name of the organization associated with the IP address. This
+        # attribute is only available from the City and Insights web services and
+        # the GeoIP2 Enterprise database.
+        #
+        # @return [String, nil]
+        def organization
+          get('organization')
+        end
+
+        # An indicator of how static or dynamic an IP address is. This property is
+        # only available from GeoIP2 Precision Insights.
+        #
+        # @return [Float, nil]
+        def static_ip_score
+          get('static_ip_score')
+        end
+
+        # The estimated number of users sharing the IP/network during the past 24
+        # hours. For IPv4, the count is for the individual IP. For IPv6, the count
+        # is for the /64 network. This property is only available from GeoIP2
+        # Precision Insights.
+        #
+        # @return [Integer, nil]
+        def user_count
+          get('user_count')
+        end
+
+        # The user type associated with the IP address. This can be one of the
+        # following values:
+        #
+        # * business
+        # * cafe
+        # * cellular
+        # * college
+        # * content_delivery_network
+        # * dialup
+        # * government
+        # * hosting
+        # * library
+        # * military
+        # * residential
+        # * router
+        # * school
+        # * search_engine_spider
+        # * traveler
+        #
+        # This attribute is only available from the Insights web service and the
+        # GeoIP2 Enterprise database.
+        #
+        # @return [String, nil]
+        def user_type
+          get('user_type')
+        end
+      end
+    end
+  end
+end

data/lib/minfraud.rb

@@ -1,19 +1,24 @@
+# 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'
 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'
@@ -22,23 +27,58 @@ 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
+    # 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,90 +1,159 @@
+# 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 device
-    # @return [Minfraud::Components::Device] Device component
+    # The CustomInputs component.
+    #
+    # @return [Minfraud::Components::CustomInputs, nil]
+    attr_accessor :custom_inputs
+
+    # 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::ShoppingCarat] 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?
+
       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(
-          status:  raw.status.to_i,
-          body:    raw.body,
-          headers: raw.headers
-        )
-
-        ::Minfraud::ErrorHandler.inspect(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