minfraud 1.1.0 → 1.5.0

data/lib/minfraud/components/shipping.rb

@@ -1,14 +1,23 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # Shipping corresponds to the shipping object of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Shipping_(/shipping)
     class Shipping < Addressable
       include ::Minfraud::Enum
-      # @attribute delivery_speed
-      # @return [String] The shipping delivery speed for the order. The valid values are:
+
+      # The shipping delivery speed for the order. Must be one of +:same_day+,
+      # +:overnight+, +:expedited+, or +:standard+.
+      #
+      # @!attribute delivery_speed
+      #
+      # @return [Symbol, nil]
       enum_accessor :delivery_speed, [:same_day, :overnight, :expedited, :standard]
 
-      # Creates Minfraud::Components::Shipping instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::Shipping] Shipping instance
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         self.delivery_speed = params[:delivery_speed]
         super

data/lib/minfraud/components/shopping_cart.rb

@@ -1,27 +1,34 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # ShoppingCart corresponds to the shopping_cart object of a minFraud
+    # request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Shopping_Cart_(/shoppingcart)
     class ShoppingCart < Base
-      # @attribute items
-      # @return [Array] An array of Minfraud::Components::ShoppingCartItem instances
-
+      # An array of Minfraud::Components::ShoppingCartItem instances.
+      #
+      # @return [Array<Minfraud::Components::ShoppingCartItem>]
       attr_accessor :items
-      # Creates Minfraud::Components::ShoppingCart instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::ShoppingCart] ShoppingCart instance
-      def initialize(params = {})
+
+      # @param params [Array] Array of shopping cart items. You may provide
+      #   each item as either a Hash where each key is a symbol corresponding
+      #   to an item's field, or as a Minfraud:::Components::ShoppingCartItem
+      #   object.
+      def initialize(params = [])
         @items = params.map(&method(:resolve))
       end
 
-      # @return [Array] a JSON representation of Minfraud::Components::ShoppingCart items
-      def to_json
+      # A JSON representation of Minfraud::Components::ShoppingCart items.
+      #
+      # @return [Array]
+      def to_json(*_args)
         @items.map(&:to_json)
       end
 
       private
 
-      # @param  [Hash] params hash of parameters for Minfraud::Components::ShoppingCartItem
-      # or Minfraud::Components::ShoppingCartItem instance
-      # @return [Minfraud::Components::ShoppingCart] ShoppingCart instance
       def resolve(params)
         params.is_a?(ShoppingCartItem) ? params : ShoppingCartItem.new(params)
       end

data/lib/minfraud/components/shopping_cart_item.rb

@@ -1,33 +1,62 @@
+# frozen_string_literal: true
+
 module Minfraud
   module Components
+    # ShoppingCartItem corresponds to objects in the shopping_cart object
+    # of a minFraud request.
+    #
+    # @see https://dev.maxmind.com/minfraud/#Shopping_Cart_Item
     class ShoppingCartItem < Base
-      # @attribute category
-      # @return [String] The category of the item
+      include Minfraud::Validates
+
+      # The category of the item. This can also be a hashed value; see link.
+      #
+      # @see https://dev.maxmind.com/minfraud/#cart-hashing
+      #
+      # @return [String, nil]
       attr_accessor :category
 
-      # @attribute item_id
-      # @return [String] The internal ID of the item
+      # The internal ID of the item. This can also be a hashed value; see link.
+      #
+      # @see https://dev.maxmind.com/minfraud/#cart-hashing
+      #
+      # @return [String, nil]
       attr_accessor :item_id
 
-      # @attribute quantity
-      # @return [Integer] The quantity of the item in the shopping cart
+      # The quantity of the item in the shopping cart. The value must be at
+      # least 0, at most 10^13-1, and have no fractional part.
+      #
+      # @return [Integer, nil]
       attr_accessor :quantity
 
-      # @attribute price
-      # @return [Float] The per-unit price of this item in the shopping cart. This should use the same currency as the order currency
+      # The per-unit price of this item in the shopping cart. This should use
+      # the same currency as the order currency. The value must be at least 0
+      # and at most 1e14 - 1.
+      #
+      # @return [Float, nil]
       attr_accessor :price
 
-      # Creates Minfraud::Components::ShoppingCartItem instance
-      # @param  [Hash] params hash of parameters
-      # @return [Minfraud::Components::ShoppingCartItem] ShoppingCartItem instance
+      # @param params [Hash] Hash of parameters. Each key/value should
+      #   correspond to one of the available attributes.
       def initialize(params = {})
         @category = params[:category]
         @item_id  = params[:item_id]
         @quantity = params[:quantity]
         @price    = params[:price]
+
+        validate
+      end
+
+      private
+
+      def validate
+        return if !Minfraud.enable_validation
+
+        validate_string('category', 255, @category)
+        validate_string('item_id', 255, @item_id)
+        validate_nonnegative_integer('quantity', @quantity)
+        validate_nonnegative_number('price', @price)
       end
     end
   end
 end
-
-

data/lib/minfraud/enum.rb

@@ -1,19 +1,30 @@
+# frozen_string_literal: true
+
 module Minfraud
+  # Enum provides helpers for working with attributes with enumerated types.
   module Enum
     def self.included(base)
       base.extend(ClassMethods)
     end
 
+    # ClassMethods provides helpers for working with attributes with enumerated
+    # types.
     module ClassMethods
-      # Returns a hash with in the following format: attribute_name => permitted_values
-      # @return [Hash] mapping
+      # Returns a hash in the following format: attribute_name =>
+      # permitted_values
+      #
+      # @return [Hash]
       def mapping
         @mapping ||= {}
       end
 
-      # Creates a set of methods for enum-like behaviour of the attribute
-      # @param [Symbol] attribute attribute name
-      # @param [Array] assignable_values a set of values which are permitted
+      # Create a set of methods for enum-like behavior of the attribute.
+      #
+      # @param attribute [Symbol] The attribute name.
+      #
+      # @param assignable_values [Array] The set of permitted values.
+      #
+      # @return [nil]
       def enum_accessor(attribute, assignable_values)
         mapping[attribute] = assignable_values.map(&:intern)
 
@@ -21,13 +32,16 @@ module Minfraud
           define_method("#{attribute}_values") { mapping[attribute] }
         end
 
-        self.class_eval do
-          define_method("#{attribute}") { instance_variable_get("@#{attribute}") }
+        class_eval do
+          define_method(attribute.to_s) { instance_variable_get("@#{attribute}") }
           define_method "#{attribute}=" do |value|
-            raise NotEnumValueError,  'Value is not permitted' if value && !self.class.mapping[attribute].include?(value.intern)
+            raise NotEnumValueError, 'Value is not permitted' if value && !self.class.mapping[attribute].include?(value.intern)
+
             instance_variable_set("@#{attribute}", value ? value.intern : nil)
           end
         end
+
+        nil
       end
     end
   end

data/lib/minfraud/error_handler.rb

@@ -1,62 +1,69 @@
 # frozen_string_literal: true
 
 module Minfraud
+  # ErrorHandler provides a method to raise exceptions on errors.
   module ErrorHandler
     class << self
-      # Returns a response if status code is 2xx, raises an error otherwise
-      # @param [Minfraud::HTTPService::Response] response
-      # @return [Minfraud::HTTPService::Response] if status code is 200
+      # Return the response if the HTTP status code is 2xx. Otherwise raise
+      # an error.
+      #
+      # @param response [Minfraud::HTTPService::Response]
+      #
+      # @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 examine(response)
         return response if response.status > 199 && response.status < 300
 
-        raise *STATUS_CODES.fetch(response.code, [ServerError, 'Server error'])
+        raise(*STATUS_CODES.fetch(response.code, [ServerError, 'Server error']))
       end
 
-      # A hash that maps status codes returned by minFraud with errors & messages
+      # @!visibility private
       STATUS_CODES = {
-        IP_ADDRESS_INVALID: [
-          ClientError, 'You have not supplied a valid IPv4 or IPv6 address'
-        ],
-        IP_ADDRESS_REQUIRED: [
-          ClientError, 'You have not supplied an IP address which is a required field'
-        ],
-        IP_ADDRESS_RESERVED: [
-          ClientError, 'You have supplied an IP address which is reserved'
-        ],
-        JSON_INVALID: [
+        JSON_INVALID:          [
           ClientError, 'JSON body cannot be decoded'
         ],
-        MAXMIND_ID_INVALID: [
+        MAXMIND_ID_INVALID:    [
           ClientError, 'You have not supplied a valid maxmind_id'
         ],
-        MINFRAUD_ID_INVALID: [
+        MINFRAUD_ID_INVALID:   [
           ClientError, 'You have not supplied a valid minfraud_id'
         ],
-        PARAMETER_UNKNOWN: [
+        PARAMETER_UNKNOWN:     [
           ClientError, 'You have supplied an unknown parameter'
         ],
-        TAG_REQUIRED: [
+        REQUEST_INVALID:       [
+          ClientError, 'The request did not contain any valid input values.'
+        ],
+        TAG_REQUIRED:          [
           ClientError, 'You have not supplied a tag, which is a required field'
         ],
-        TAG_INVALID: [
+        TAG_INVALID:           [
           ClientError, 'You have not supplied a valid tag'
         ],
-        ACCOUNT_ID_REQUIRED: [
+        ACCOUNT_ID_REQUIRED:   [
           AuthorizationError, 'You have not supplied a account ID'
         ],
         AUTHORIZATION_INVALID: [
           AuthorizationError, 'Invalid license key and / or account ID'
         ],
-        LICENSE_KEY_REQUIRED: [
+        LICENSE_KEY_REQUIRED:  [
           AuthorizationError, 'You have not supplied a license key'
         ],
-        USER_ID_REQUIRED: [
+        USER_ID_REQUIRED:      [
           AuthorizationError, 'You have not supplied a account id'
         ],
-        INSUFFICIENT_FUNDS: [
+        INSUFFICIENT_FUNDS:    [
           ClientError, 'The license key you have provided does not have a sufficient funds to use this service'
         ],
-        PERMISSION_REQUIRED: [
+        PERMISSION_REQUIRED:   [
           ClientError, 'You do not have permission to use this service'
         ]
       }.freeze

data/lib/minfraud/errors.rb

@@ -1,10 +1,30 @@
+# frozen_string_literal: true
+
 module Minfraud
-  # A list of Minfraud custom errors
-  class BaseError          < StandardError; end
+  # The base error class for Minfraud exceptions.
+  class BaseError < StandardError; end
+
+  # An error indicating the input value is not valid.
+  class InvalidInputError < BaseError; end
 
+  # An error indicating the value is not valid for the enumerated type.
   class NotEnumValueError  < BaseError; end
+
+  # An error indicating the field is not recognized.
   class RequestFormatError < BaseError; end
+
+  # An error indicating minFraud cannot serve your request as there is a
+  # problem on the client side.
+  #
+  # For example, this may happen if there is a problem with the format or
+  # contents of your request, if you lack funds to use the service, or if you
+  # don't have permission to use the service.
   class ClientError        < BaseError; end
+
+  # An error indicating there is a problem with authorization or
+  # authentication.
   class AuthorizationError < BaseError; end
+
+  # An error indicating the server had an error handling the request.
   class ServerError        < BaseError; end
 end

data/lib/minfraud/http_service.rb

@@ -1,30 +1,45 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 
 module Minfraud
+  # HTTPService holds the HTTP client configuration.
   module HTTPService
     class << self
-      # @return [Hash] default HTTPService configuration
+      # The default HTTPService configuration.
+      #
+      # @return [Hash]
       def configuration
+        server = DEFAULT_SERVER
+        if !Minfraud.host.nil?
+          server = "https://#{Minfraud.host}/minfraud/v2.0"
+        end
+
         {
           middleware: DEFAULT_MIDDLEWARE,
-          server:     DEFAULT_SERVER
+          server:     server,
         }
       end
     end
 
-    # Minfraud default middleware stack
-    DEFAULT_MIDDLEWARE = Proc.new do |builder|
+    # @!visibility private
+    DEFAULT_MIDDLEWARE = proc do |builder|
       builder.request    :json
 
-      builder.basic_auth *::Minfraud.configuration.values
+      account_id = Minfraud.account_id
+      account_id = Minfraud.user_id if account_id.nil?
+
+      builder.basic_auth account_id, Minfraud.license_key
 
       builder.response   :json, content_type: /\bjson$/
 
-      builder.adapter    Faraday.default_adapter
+      builder.adapter :net_http_persistent, pool_size: 5 do |http|
+        http.idle_timeout = 30
+      end
     end
 
-    # Minfraud default server
-    DEFAULT_SERVER = 'https://minfraud.maxmind.com/minfraud/v2.0'.freeze
+    # Default base URL for minFraud.
+    DEFAULT_SERVER = 'https://minfraud.maxmind.com/minfraud/v2.0'
   end
 end

data/lib/minfraud/http_service/request.rb

@@ -1,36 +1,37 @@
+# frozen_string_literal: true
+
 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