minfraud 1.0.1 → 1.2.0

data/lib/minfraud/model/shipping_address.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/address'
+
+module Minfraud
+  module Model
+    # Model containing information about the shipping address.
+    class ShippingAddress < Address
+      # The distance in kilometers from the shipping address to billing
+      # address.
+      #
+      # @return [Integer, nil]
+      attr_reader :distance_to_billing_address
+
+      # This field is true if the shipping address is an address associated
+      # with fraudulent transactions. The field is false when the address is
+      # not associated with increased risk. The key will only be present when a
+      # shipping address is provided.
+      attr_reader :is_high_risk
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @distance_to_billing_address = get('distance_to_billing_address')
+        @is_high_risk                = get('is_high_risk')
+      end
+    end
+  end
+end

data/lib/minfraud/model/subscores.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require 'minfraud/model/abstract'
+
+module Minfraud
+  module Model
+    # Subscores for components that are used in calculating the riskScore.
+    class Subscores < Abstract
+      # The risk associated with the AVS result. If present, this is a value in
+      # the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :avs_result
+
+      # The risk associated with the billing address. If present, this is a
+      # value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :billing_address
+
+      # The risk associated with the distance between the billing address and
+      # the location for the given IP address. If present, this is a value in
+      # the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :billing_address_distance_to_ip_location
+
+      # The risk associated with the browser attributes such as the User-Agent
+      # and Accept-Language. If present, this is a value in the range 0.01 to
+      # 99.
+      #
+      # @return [Float, nil]
+      attr_reader :browser
+
+      # Individualized risk of chargeback for the given IP address given for
+      # your account and any shop ID passed. This is only available to users
+      # sending chargeback data to MaxMind. If present, this is a value in the
+      # range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :chargeback
+
+      # The risk associated with the country the transaction originated from.
+      # If present, this is a value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :country
+
+      # The risk associated with the combination of IP country, card issuer
+      # country, billing country, and shipping country. If present, this is a
+      # value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :country_mismatch
+
+      # The risk associated with the CVV result. If present, this is a value in
+      # the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :cvv_result
+
+      # 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
+
+      # The risk associated with the particular email address. If present, this
+      # is a value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :email_address
+
+      # The general risk associated with the email domain. If present, this is
+      # a value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :email_domain
+
+      # 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
+
+      # The risk associated with the issuer ID number on the email domain. If
+      # present, this is a value in the range 0.01 to 99.
+      #
+      # Deprecated effective August 29, 2019. This subscore will default to 1
+      # and will be removed in a future release. The user tenure on email is
+      # reflected in the /subscores/email_address output.
+      #
+      # @return [Float, nil]
+      attr_reader :email_tenure
+
+      # The risk associated with the issuer ID number on the IP address. If
+      # present, this is a value in the range 0.01 to 99.
+      #
+      # Deprecated effective August 29, 2019. This subscore will default to 1
+      # and will be removed in a future release. The IP tenure is reflected in
+      # the overall risk score.
+      #
+      # @return [Float, nil]
+      attr_reader :ip_tenure
+
+      # The risk associated with the particular issuer ID number (IIN) given
+      # the billing location and the history of usage of the IIN on your
+      # account and shop ID. If present, this is a value in the range 0.01 to
+      # 99.
+      #
+      # @return [Float, nil]
+      attr_reader :issuer_id_number
+
+      # The risk associated with the particular order amount for your account
+      # and shop ID. If present, this is a value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :order_amount
+
+      # The risk associated with the particular phone number. If present, this
+      # is a value in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :phone_number
+
+      # 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
+
+      # The risk associated with the distance between the shipping address and
+      # the IP location for the given IP address. If present, this is a value
+      # in the range 0.01 to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :shipping_address_distance_to_ip_location
+
+      # The risk associated with the local time of day of the transaction in
+      # the IP address location. If present, this is a value in the range 0.01
+      # to 99.
+      #
+      # @return [Float, nil]
+      attr_reader :time_of_day
+
+      # @!visibility private
+      def initialize(record)
+        super(record)
+
+        @avs_result                               = get('avs_result')
+        @billing_address                          = get('billing_address')
+        @billing_address_distance_to_ip_location  = get(
+          'billing_address_distance_to_ip_location'
+        )
+        @browser                                  = get('browser')
+        @chargeback                               = get('chargeback')
+        @country                                  = get('country')
+        @country_mismatch                         = get('country_mismatch')
+        @cvv_result                               = get('cvv_result')
+        @device                                   = get('device')
+        @email_address                            = get('email_address')
+        @email_domain                             = get('email_domain')
+        @email_local_part                         = get('email_local_part')
+        @email_tenure                             = get('email_tenure')
+        @ip_tenure                                = get('ip_tenure')
+        @issuer_id_number                         = get('issuer_id_number')
+        @order_amount                             = get('order_amount')
+        @phone_number                             = get('phone_number')
+        @shipping_address                         = get('shipping_address')
+        @shipping_address_distance_to_ip_location = get(
+          'shipping_address_distance_to_ip_location'
+        )
+        @time_of_day                              = get('time_of_day')
+      end
+    end
+  end
+end

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,40 @@
+# frozen_string_literal: true
+
+module Minfraud
+  class Report
+    include ::Minfraud::HTTPService
+
+    # @!attribute transaction
+    # @return [Minfraud::Components::Report::Transaction] Report::Transaction component
+    attr_accessor :transaction
+
+    # @param  [Hash] params hash of parameters
+    # @return [Minfraud::ReportTransaction] ReportTransaction instance
+    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.
+    # @return [nil]
+    def report_transaction
+      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
+    def request
+      @request ||= Request.new(::Minfraud::HTTPService.configuration)
+    end
+  end
+end

data/lib/minfraud/resolver.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Minfraud
   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
-      def assign(context:, params:)
+      # @note Raises RequestFormatError once unpermitted key is met
+      def assign(context, params)
         Array(params).each do |key, value|
           raise RequestFormatError, "#{key} does not belong to request document format" unless MAPPING[key]
 
@@ -17,16 +19,17 @@ module Minfraud
 
     # Mapping between components & minFraud request keys
     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/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minfraud
-  VERSION = "1.0.1"
+  VERSION = '1.2.0'
 end

data/minfraud.gemspec

@@ -1,26 +1,32 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', File.dirname(File.realpath(__FILE__)))
 $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']
+  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 interface to the MaxMind minFraud v2.0 API services'
+  spec.homepage      = 'https://github.com/maxmind/minfraud-api-ruby'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 1.9'
 
   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.require_paths = ['lib']
+
+  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 'faraday'
-  spec.add_runtime_dependency 'faraday_middleware'
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minfraud
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - kushnir.yb
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,56 +16,68 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,23 +92,55 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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:
-- kushnir.yb@gmail.com
+- support@maxmind.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- README.dev.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- lib/maxmind/geoip2/model/city.rb
+- lib/maxmind/geoip2/model/country.rb
+- lib/maxmind/geoip2/model/insights.rb
+- lib/maxmind/geoip2/record/abstract.rb
+- lib/maxmind/geoip2/record/city.rb
+- lib/maxmind/geoip2/record/continent.rb
+- lib/maxmind/geoip2/record/country.rb
+- lib/maxmind/geoip2/record/location.rb
+- lib/maxmind/geoip2/record/maxmind.rb
+- lib/maxmind/geoip2/record/place.rb
+- lib/maxmind/geoip2/record/postal.rb
+- lib/maxmind/geoip2/record/represented_country.rb
+- lib/maxmind/geoip2/record/subdivision.rb
+- lib/maxmind/geoip2/record/traits.rb
 - lib/minfraud.rb
 - lib/minfraud/assessments.rb
 - lib/minfraud/components/account.rb
@@ -104,11 +148,13 @@ files:
 - lib/minfraud/components/base.rb
 - lib/minfraud/components/billing.rb
 - lib/minfraud/components/credit_card.rb
+- lib/minfraud/components/custom_inputs.rb
 - lib/minfraud/components/device.rb
 - lib/minfraud/components/email.rb
 - lib/minfraud/components/event.rb
 - lib/minfraud/components/order.rb
 - lib/minfraud/components/payment.rb
+- lib/minfraud/components/report/transaction.rb
 - lib/minfraud/components/shipping.rb
 - lib/minfraud/components/shopping_cart.rb
 - lib/minfraud/components/shopping_cart_item.rb
@@ -118,10 +164,30 @@ files:
 - lib/minfraud/http_service.rb
 - lib/minfraud/http_service/request.rb
 - lib/minfraud/http_service/response.rb
+- lib/minfraud/model/abstract.rb
+- lib/minfraud/model/address.rb
+- lib/minfraud/model/billing_address.rb
+- lib/minfraud/model/credit_card.rb
+- lib/minfraud/model/device.rb
+- lib/minfraud/model/disposition.rb
+- lib/minfraud/model/email.rb
+- lib/minfraud/model/email_domain.rb
+- lib/minfraud/model/error.rb
+- lib/minfraud/model/factors.rb
+- lib/minfraud/model/geoip2_location.rb
+- lib/minfraud/model/insights.rb
+- lib/minfraud/model/ip_address.rb
+- lib/minfraud/model/issuer.rb
+- lib/minfraud/model/score.rb
+- lib/minfraud/model/score_ip_address.rb
+- lib/minfraud/model/shipping_address.rb
+- lib/minfraud/model/subscores.rb
+- lib/minfraud/model/warning.rb
+- lib/minfraud/report.rb
 - lib/minfraud/resolver.rb
 - lib/minfraud/version.rb
 - minfraud.gemspec
-homepage: https://github.com/kushniryb/minfraud-api-v2
+homepage: https://github.com/maxmind/minfraud-api-ruby
 licenses:
 - MIT
 metadata: {}
@@ -133,7 +199,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -141,9 +207,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Ruby interface to the MaxMind minFraud v2.0 API services
 test_files: []
-has_rdoc: