minfraud 1.0.1 → 1.2.0

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

@@ -0,0 +1,224 @@
+# 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 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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'minfraud'
 require 'minfraud/enum'
 require 'minfraud/components/base'
@@ -5,15 +7,16 @@ 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 +25,45 @@ require 'minfraud/http_service/request'
 require 'minfraud/http_service/response'
 require 'minfraud/error_handler'
 require 'minfraud/assessments'
+require 'minfraud/report'
 
 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
+
+    # 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
+    # Yield self to accept configuration settings.
+    #
+    # @yield [self]
     def configure
       yield self
     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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   class Assessments
     include ::Minfraud::HTTPService
@@ -15,6 +17,10 @@ module Minfraud
     # @return [Minfraud::Components::CreditCard] CreditCard component
     attr_accessor :credit_card
 
+    # @attribute custom_inputs
+    # @return [Minfraud::Components::CustomInputs] CustomInputs component
+    attr_accessor :custom_inputs
+
     # @attribute device
     # @return [Minfraud::Components::Device] Device component
     attr_accessor :device
@@ -40,16 +46,18 @@ module Minfraud
     attr_accessor :shipping
 
     # @!attribute shopping_cart
-    # @return [Minfraud::Components::ShoppingCarat] ShoppingCart component
+    # @return [Minfraud::Components::ShoppingCart] ShoppingCart component
     attr_accessor :shopping_cart
 
     # @param  [Hash] params hash of parameters
     # @param  [Minfraud::Resolver] resolver resolver that maps params to components
-    # In case if params is a Hash of components it just assignes them to corresponding
-    # instance variables
+    # @note In case when params is a Hash of components it just assigns them to the corresponding instance variables
     # @return [Minfraud::Assessments] Assessments instance
     def initialize(params = {}, resolver = ::Minfraud::Resolver)
-      resolver.assign(context: self, params: params)
+      @locales = params.delete('locales')
+      @locales = ['en'] if @locales.nil?
+
+      resolver.assign(self, params)
     end
 
     # @!macro [attach] define
@@ -59,14 +67,16 @@ module Minfraud
     #   @return [Minfraud::HTTPService::Response] Wrapped minFraud response
     def self.define(endpoint)
       define_method(endpoint) do
-        raw       = request.perform(verb: :post, endpoint: endpoint, body: request_body)
+        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
+          endpoint: endpoint,
+          locales:  @locales,
+          status:   raw.status.to_i,
+          body:     raw.body,
+          headers:  raw.headers
         )
 
-        ::Minfraud::ErrorHandler.inspect(response)
+        ::Minfraud::ErrorHandler.examine(response)
       end
     end
 
@@ -75,10 +85,15 @@ module Minfraud
     define :factors
 
     private
+
     # Creates a unified request body from components converted to JSON
     # @return [Hash] Request body
     def request_body
-      MAPPING.keys.inject({}) { |mem, e| mem.merge!(e.to_s => send(e)&.to_json) }
+      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

data/lib/minfraud/components/account.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
     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
+      # but rather should be an internal ID that does not change. This is not your MaxMind user ID.
       attr_accessor :user_id
 
       # @attribute username_md5

data/lib/minfraud/components/addressable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
     class Addressable < Base
@@ -14,39 +16,39 @@ module Minfraud
       attr_accessor :company
 
       # @attribute address
-      # @return [String] The first line of the user’s billing / shipping address
+      # @return [String] The first line of the user's billing / shipping address
       attr_accessor :address
 
       # @attribute address_2
-      # @return [String] The second line of the user’s billing / shipping address
+      # @return [String] The second line of the user's billing / shipping address
       attr_accessor :address_2
 
       # @attribute city
-      # @return [String] The city of the user’s billing / shipping address
+      # @return [String] The city of the user's billing / shipping address
       attr_accessor :city
 
       # @attribute region
-      # @return [String] The ISO 3166-2 subdivision code for the user’s billing / shipping address
+      # @return [String] The ISO 3166-2 subdivision code for the user's billing / shipping address
       attr_accessor :region
 
       # @attribute country
-      # @return [String] The two character ISO 3166-1 alpha-2 country code of the user’s billing / shipping address
+      # @return [String] The two character ISO 3166-1 alpha-2 country code of the user's billing / shipping address
       attr_accessor :country
 
       # @attribute postal
-      # @return [String] The postal code of the user’s billing / shipping address
+      # @return [String] The postal code of the user's billing / shipping address
       attr_accessor :postal
 
       # @attribute phone_number
-      # @return [String] The phone number without the country code for the user’s billing / shipping address
+      # @return [String] The phone number without the country code for the user's billing / shipping address
       attr_accessor :phone_number
 
       # @attribute phone_country_code
-      # @return [String] The country code for phone number associated with the user’s billing / shipping address
+      # @return [String] The country code for phone number associated with the user's billing / shipping address
       attr_accessor :phone_country_code
 
       # Creates Minfraud::Components::Addressable instance
-      # This class is used as a parent class for Billing and Shipping components
+      # @note This class is used as a parent class for Billing and Shipping components
       # @param  [Hash] params hash of parameters
       # @return [Minfraud::Components::Addressable] an Addressable instance
       def initialize(params = {})

data/lib/minfraud/components/base.rb

@@ -1,13 +1,37 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
-    # Note: This class is used as a parent class for all other components
-    # It defines a method which is used for basic JSON representation of PORO objects
+    # @note This class is used as a parent class for all other components
+    # @note It defines a method which is used for basic JSON representation of PORO objects
     class Base
       # @return [Hash] a JSON representation of component attributes
-      def to_json
-        instance_variables.inject({}) { |mem, e| mem.merge!(e.to_s.gsub(/@/, '') => instance_variable_get(e).to_s) }
-          .delete_if { |_, v| v.empty? }
+      def to_json(*_args)
+        instance_variables.reduce({}) { |mem, e| populate!(mem, e) }
       end
+
+      private
+
+      # @note   This method may modify passed hash. Non-existing instance variables are ignored
+      # @param  [Hash] hash an accumulator
+      # @param  [Symbol] v_sym an instance variable symbol
+      # @return [Hash] a hash containing a JSON representation of instance variable name and it's value
+      def populate!(hash, v_sym)
+        return hash unless (value = instance_variable_get(v_sym))
+
+        key = v_sym.to_s.gsub(/@/, '')
+        hash.merge!(key => represent(key, value))
+      end
+
+      # param [Symbol] key instance variable symbol
+      # param [Object] value instance variable value
+      # @return [Object] value representation according to the request format
+      def represent(key, value)
+        BOOLS.include?(key) ? value : value.to_s
+      end
+
+      # Keys that have to remain boolean
+      BOOLS = %w[was_authorized is_gift has_gift_message].freeze
     end
   end
 end