minfraud 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dd67d789e955bf5a4d4bb1b1900439ae8a3b386
+  data.tar.gz: a6b08f07d7adf54d3df09823bb17b5d53644c354
+SHA512:
+  metadata.gz: f55e059b7e4d96be4d6b92247c3580bb4b5be5299a4f59264e2eaaf9c913e2b0c4ee1ac2b8786282c8bd255ffb343772e4311115343eff106c4e6c6dc91695aa
+  data.tar.gz: 85f7b208c1d116987a4754355d7ee4ec2295ea6a151a741eaf29d3280ba4ad8dcf04397817d454cced3cf712abbca6a687da19356cba66445bfb31af8d54d315

data/.gitignore

@@ -0,0 +1,7 @@
+pkg
+.project
+Gemfile.lock
+.rvmrc
+*.rbc
+*~
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kushnir.yb@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in minfraud.gemspec
+gem 'coveralls', require: false
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 kushnir.yb
+
+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.

data/README.md

@@ -0,0 +1,108 @@
+# Simple Ruby Wrapper to the MaxMind minFraud API
+
+[![Code Climate](https://codeclimate.com/github/kushniryb/minfraud-api-v2/badges/gpa.svg)](https://codeclimate.com/github/kushniryb/minfraud-api-v2)
+[![Coverage Status](https://coveralls.io/repos/github/kushniryb/minfraud-api-v2/badge.svg?branch=master)](https://coveralls.io/github/kushniryb/minfraud-api-v2?branch=master)
+[![Build Status](https://travis-ci.org/kushniryb/minfraud-api-v2.svg?branch=master)](https://travis-ci.org/kushniryb/minfraud-api-v2)
+
+Compatible with version minFraud API v2.0
+
+[minFraud API documentation](http://dev.maxmind.com/minfraud/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minfraud'
+```
+
+And then execute:
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install minfraud
+```
+
+## Configuration
+
+User Id and License Key are required to work with minFraud API
+
+```ruby
+Minfraud.configure do |c|
+  c.license_key = 'your_license_key'
+  c.user_id     = 'your_user_id'
+end
+```
+
+## Usage
+```ruby
+Minfraud.configure do |c|
+  c.user_id     = 'user_id' # your minFraud user id
+  c.license_key = 'license_key' # your minFraud license key
+end
+
+# You can either provide a hash of params to initializer
+assessment = Minfraud::Assessments.new(
+  device: {
+    ip_address: '1.2.3.4.5'
+  }
+)
+# or create a component and assign them to assessments object directly, e.g
+device = Minfraud::Components::Device.new(ip_address: '1.2.3.4.5')
+assessment = Minfraud::Assessments.new(device: device)
+# or
+assessment = Minfraud::Assessments.new
+assessment.device = device
+
+
+# There are multiple components that reflect minFraud request top level keys
+# You can now call 3 different minFraud endpoints: score, insights, factors
+assessment.insights
+assessment.factors
+
+result = assessment.score # => Minfraud::Response instance
+
+result.status # => Response status code
+result.code # => minFraud specific response code
+result.body # => Mashified body
+result.headers # => Response headers
+
+# You can also change data inbetween requests
+first_request = assessment.insights
+assessment.device.ip_address = '22.22.22.33'
+second_request = assessment.insights
+```
+
+### Exception handling
+
+Gem is supplied with four different types of exceptions:
+```ruby
+# Raised if unpermitted key is provided to Minfraud::Assessments initializer
+class RequestFormatError < BaseError; end
+
+# Raised if IP address is absent / it is reserved / JSON body can not be decoded
+class ClientError < BaseError; end
+
+# Raised if there are some problems with the user id and / or license key
+class AuthorizationError < BaseError; end
+
+# Raised if minFraud returns an error, or if there is an HTTP error
+class ServerError < BaseError; end
+
+# Raised if assigned value does not belong to enum list
+class NotEnumValueError < BaseError; end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/kushniryb/minfraud-api-v2]. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/minfraud.rb

@@ -0,0 +1,49 @@
+require 'minfraud'
+require 'minfraud/enum'
+require 'minfraud/components/base'
+require 'minfraud/components/account'
+require 'minfraud/components/addressable'
+require 'minfraud/components/billing'
+require 'minfraud/components/credit_card'
+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/shipping'
+require 'minfraud/components/shopping_cart'
+require 'minfraud/components/device'
+require 'minfraud/resolver'
+require 'minfraud/version'
+require 'minfraud/errors'
+require 'minfraud/http_service'
+require 'minfraud/http_service/request'
+require 'minfraud/http_service/response'
+require 'minfraud/error_handler'
+require 'minfraud/assessments'
+
+module Minfraud
+  class << self
+    # @!attribute user_id
+    # @return [String] MaxMind username that is used for authorization
+    attr_accessor :user_id
+
+    # @!attribute license_key
+    # @return [String] MaxMind license key that is used for authorization
+    attr_accessor :license_key
+
+    # @yield [self] to accept configuration settings
+    def configure
+      yield self
+    end
+
+    # @return [Hash] with the current configuration
+    def configuration
+      {
+        user_id:     @user_id,
+        license_key: @license_key
+      }
+    end
+  end
+end

data/lib/minfraud/assessments.rb

@@ -0,0 +1,82 @@
+module Minfraud
+  class Assessments
+    include ::Minfraud::HTTPService
+    include ::Minfraud::Resolver
+
+    # @attribute account
+    # @return [Minfraud::Components::Account] Account component
+    attr_accessor :account
+
+    # @attribute billing
+    # @return [Minfraud::Components::Billing] Billing component
+    attr_accessor :billing
+
+    # @attribute credit_card
+    # @return [Minfraud::Components::CreditCard] CreditCard component
+    attr_accessor :credit_card
+
+    # @attribute device
+    # @return [Minfraud::Components::Device] Device component
+    attr_accessor :device
+
+    # @attribute email
+    # @return [Minfraud::Components::Email] Email component
+    attr_accessor :email
+
+    # @attribute event
+    # @return [Minfraud::Components::Event] Event component
+    attr_accessor :event
+
+    # @attribute order
+    # @return [Minfraud::Components::Order] Order component
+    attr_accessor :order
+
+    # @attribute payment
+    # @return [Minfraud::Components::Payment] Payment component
+    attr_accessor :payment
+
+    # @!attribute shipping
+    # @return [Minfraud::Components::Shipping] Shipping component
+    attr_accessor :shipping
+
+    # @!attribute shopping_cart
+    # @return [Minfraud::Components::ShoppingCarat] ShoppingCart component
+    attr_accessor :shopping_cart
+
+    # @param  [Hash] params hash of parameters
+    # @param  [Minfraud::Resolver] resolver resolver that maps params to components
+    # @return [Minfraud::Assessments] Assessments instance
+    def initialize(params = {}, resolver = ::Minfraud::Resolver)
+      resolver.assign(context: self, params: params)
+    end
+
+    # These methods correspond to the minFraud API endpoints and require the same set of params
+    # Raises an error in case of invalid response
+    # @return [Minfraud::HTTPService::Response] Wrapped minFraud response
+    %w(score insights factors).each do |endpoint|
+      define_method endpoint do
+        raw       = request.perform(verb: :post, endpoint: endpoint, body: request_body)
+        response  = ::Minfraud::HTTPService::Response.new(
+          status:  raw.status.to_i,
+          body:    raw.body,
+          headers: raw.headers
+        )
+
+        ::Minfraud::ErrorHandler.inspect(response)
+      end
+    end
+
+    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) }
+    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/components/account.rb

@@ -0,0 +1,23 @@
+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
+      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
+      attr_accessor :username_md5
+
+      # Creates Minfraud::Components::Account instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Account] a Account instance
+      def initialize(params = {})
+        @user_id      = params[:user_id]
+        @username_md5 = params[:username_md5]
+      end
+    end
+  end
+end

data/lib/minfraud/components/addressable.rb

@@ -0,0 +1,67 @@
+module Minfraud
+  module Components
+    class Addressable < Base
+      # @attribute first_name
+      # @return [String] The first name of the end user as provided in their billing / shipping information
+      attr_accessor :first_name
+
+      # @attribute last_name
+      # @return [String] The last name of the end user as provided in their billing / shipping information
+      attr_accessor :last_name
+
+      # @attribute company
+      # @return [String] The company of the end user as provided in their billing / shipping information
+      attr_accessor :company
+
+      # @attribute 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
+      attr_accessor :address_2
+
+      # @attribute city
+      # @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
+      attr_accessor :region
+
+      # @attribute country
+      # @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
+      attr_accessor :postal
+
+      # @attribute phone_number
+      # @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
+      attr_accessor :phone_country_code
+
+      # Creates Minfraud::Components::Addressable instance
+      # 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 = {})
+        @first_name         = params[:first_name]
+        @last_name          = params[:last_name]
+        @company            = params[:company]
+        @address            = params[:address]
+        @address_2          = params[:address_2]
+        @city               = params[:city]
+        @region             = params[:region]
+        @country            = params[:country]
+        @postal             = params[:postal]
+        @phone_number       = params[:phone_number]
+        @phone_country_code = params[:phone_country_code]
+      end
+    end
+  end
+end

data/lib/minfraud/components/base.rb

@@ -0,0 +1,13 @@
+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
+    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? }
+      end
+    end
+  end
+end

data/lib/minfraud/components/billing.rb

@@ -0,0 +1,5 @@
+module Minfraud
+  module Components
+    class Billing < Addressable; end
+  end
+end

data/lib/minfraud/components/credit_card.rb

@@ -0,0 +1,47 @@
+module Minfraud
+  module Components
+    class CreditCard < Base
+      # @attribute issuer_id_number
+      # # @return [String] The issuer ID number for the credit card. This is the first 6 digits of the credit card number.
+      # It identifies the issuing bank
+      attr_accessor :issuer_id_number
+
+      # @attribute last_4_digits
+      # @return [String] The last four digits of the credit card number
+      attr_accessor :last_4_digits
+
+      # @attribute bank_name
+      # @return [String] The name of the issuing bank as provided by the end user
+      attr_accessor :bank_name
+
+      # @attribute bank_phone_country_code
+      # @return [String] The phone country code for the issuing bank as provided by the end user
+      attr_accessor :bank_phone_country_code
+
+      # @attribute phone_phone_number
+      # @return [String] The phone number, without the country code, for the issuing bank as provided by the end user
+      attr_accessor :bank_phone_number
+
+      # @attribute avs_result
+      # @return [String] The address verification system (AVS) check result, as returned to you by the credit card processor
+      attr_accessor :avs_result
+
+      # @attribute cvv_result
+      # @return [String] The card verification value (CVV) code as provided by the payment processor
+      attr_accessor :cvv_result
+
+      # Creates Minfraud::Components::CreditCard instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::CreditCard] a CreditCard instance
+      def initialize(params = {})
+        @bank_phone_country_code = params[:bank_phone_country_code]
+        @issuer_id_number        = params[:issuer_id_number]
+        @last_4_digits           = params[:last_4_digits]
+        @bank_name               = params[:bank_name]
+        @bank_phone_number       = params[:bank_phone_number]
+        @avs_result              = params[:avs_result]
+        @cvv_result              = params[:cvv_result]
+      end
+    end
+  end
+end

data/lib/minfraud/components/device.rb

@@ -0,0 +1,27 @@
+module Minfraud
+  module Components
+    class Device < Base
+      # @!attribute ip_address
+      # @return [String] The IP address associated with the device used by the customer in the transaction.
+      # The IP address must be in IPv4 or IPv6 presentation format
+      attr_accessor :ip_address
+
+      # @attribute user_agent
+      # @return [String] The HTTP "User-Agent" header of the browser used in the transaction
+      attr_accessor :user_agent
+
+      # @attribute :accept_language
+      # @return [String] The HTTP "Accept-Language" header of the browser used in the transaction
+      attr_accessor :accept_language
+
+      # Creates Minfraud::Components::Device instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Device] a Device instance
+      def initialize(params = {})
+        @ip_address      = params[:ip_address]
+        @user_agent      = params[:user_agent]
+        @accept_language = params[:accept_language]
+      end
+    end
+  end
+end

data/lib/minfraud/components/email.rb

@@ -0,0 +1,21 @@
+module Minfraud
+  module Components
+    class Email < Base
+      # @attribute address
+      # @return [String] This field must be either a valid email address or an MD5 of the email used in the transaction
+      attr_accessor :address
+
+      # @attribute domain
+      # @return [String] The domain of the email address used in the transaction
+      attr_accessor :domain
+
+      # Creates Minfraud::Components::Email instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Email] an Email instance
+      def initialize(params = {})
+        @address = params[:address]
+        @domain  = params[:domain]
+      end
+    end
+  end
+end

data/lib/minfraud/components/event.rb

@@ -0,0 +1,39 @@
+module Minfraud
+  module Components
+    class Event < Base
+      include ::Minfraud::Enum
+      # @attribute transaction_id
+      # @return [String] Internal ID for the transaction. Used to locate a specific transaction in minFraud logs
+      attr_accessor :transaction_id
+
+      # @attribute shop_id
+      # @return [String] Internal ID for the shop, affiliate, or merchant this order is coming from
+      attr_accessor :shop_id
+
+      # @attribute time
+      # @return [String] The date and time the event occurred. The string must be in the RFC 3339 date-time format.
+      # If this field is not in the request, the current time will be used
+      attr_accessor :time
+
+      # @attribute type
+      # @return [String] The type of event being scored. The valid types are:
+      #   => account_creation
+      #   => account_login
+      #   => purchase
+      #   => recurring_purchase
+      #   => referral
+      #   => survey
+      enum_accessor :type, [:account_creation, :account_login, :purchase, :recurring_purchase, :referral, :survey]
+
+      # Creates Minfraud::Components::Event instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Event] an Event instance
+      def initialize(params = {})
+        @transaction_id = params[:transaction_id]
+        @shop_id        = params[:shop_id]
+        @time           = params[:time]
+        @type           = params[:type]
+      end
+    end
+  end
+end

data/lib/minfraud/components/order.rb

@@ -0,0 +1,51 @@
+module Minfraud
+  module Components
+    class Order < Base
+      # @attribute amount
+      # @return [Decimal] The total order amount for the transaction
+      attr_accessor :amount
+
+      # @attribute currency
+      # @return [String] The ISO 4217 currency code for the currency used in the transaction
+      attr_accessor :currency
+
+      # @attribute discount_code
+      # @return [String] The discount code applied to the transaction. If multiple discount codes are used,
+      # please separate them with a comma.
+      attr_accessor :discount_code
+
+      # @attribute affiliate_id
+      # @return [String] The ID of the affiliate where the order is coming from
+      attr_accessor :affiliate_id
+
+      # @attribute subaffiliate_id
+      # @return [String] The ID of the sub-affiliate where the order is coming from
+      attr_accessor :subaffiliate_id
+
+      # @attribute :referrer_uri
+      # @return [String] The URI of the referring site for this order
+      attr_accessor :referrer_uri
+
+      # @attribute :is_gift
+      # @return [Boolean] Whether order was marked as a gift by the purchaser
+      attr_accessor :is_gift
+
+      # @attribute :has_gift_message
+      # @return [Boolean] Whether the purchaser included a gift message
+      attr_accessor :has_gift_message
+
+      # Creates Minfraud::Components::Order instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Order] an Order instance
+      def initialize (params = {})
+        @has_gift_message = params[:has_gift_message]
+        @affiliate_id     = params[:affiliate_id]
+        @subaffiliate_id  = params[:subaffiliate_id]
+        @currency         = params[:currency]
+        @discount_code    = params[:discount_cide]
+        @referrer_uri     = params[:referrer_uri]
+        @is_gift          = params[:is_gift]
+      end
+    end
+  end
+end

data/lib/minfraud/components/payment.rb

@@ -0,0 +1,40 @@
+module Minfraud
+  module Components
+    class Payment < Base
+      include ::Minfraud::Enum
+      # @attribute processor
+      # @return [String] The payment processor used for the transaction
+      enum_accessor :processor, [
+        :adyen, :altapay, :amazon_payments, :authorizenet, :balanced, :beanstream,
+        :bluepay, :braintree, :ccnow, :chase_paymentech, :cielo, :collector, :compropago,
+        :concept_payments, :conekta, :cuentadigital, :dalpay, :dibs, :digital_river, :ecomm365,
+        :elavon, :epay, :eprocessing_network, :eway, :first_data, :global_payments, :ingenico,
+        :internetsecure, :intuit_quickbooks_payments, :iugu, :mastercard_payment_gateway,
+        :mercadopago, :merchant_esolutions, :mirjeh, :mollie, :moneris_solutions, :nmi,
+        :openpaymx, :optimal_payments, :orangepay, :other, :pacnet_services, :payfast,
+        :paygate, :payone, :paypal, :payplus, :paystation, :paytrace, :paytrail, :payture,
+        :payu, :payulatam, :pinpayments, :princeton_payment_solutions, :psigate, :qiwi,
+        :quickpay, :raberil, :rede, :redpagos, :rewardspay, :sagepay, :simplify_commerce,
+        :skrill, :smartcoin, :sps_decidir, :stripe, :telerecargas, :towah, :usa_epay,
+        :verepay, :vindicia, :virtual_card_services, :vme, :worldpay
+      ]
+
+      # @attribute was_authorized
+      # @return [Boolean] The authorization outcome from the payment processor. If the transaction has not yet been approved or denied, do not include this field
+      attr_accessor :was_authorized
+
+      # @attribute decline_code
+      # @return [String] The decline code as provided by your payment processor. If the transaction was not declined, do not include this field
+      attr_accessor :decline_code
+
+      # Creates Minfraud::Components::Payment instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::Payment] Payment instance
+      def initialize(params = {})
+        @was_authorized = params[:was_authorized]
+        @decline_code   = params[:decline_code]
+        @processor      = params[:processor]
+      end
+    end
+  end
+end

data/lib/minfraud/components/shipping.rb

@@ -0,0 +1,22 @@
+module Minfraud
+  module Components
+    class Shipping < Addressable
+      include ::Minfraud::Enum
+      # @attribute delivery_speed
+      # @return [String] The shipping delivery speed for the order. The valid values are:
+      #    => same_day
+      #    => overnight
+      #    => expedited
+      #    => standard
+      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
+      def initialize(params = {})
+        @delivery_speed = params[:delivery_speed]
+        super
+      end
+    end
+  end
+end

data/lib/minfraud/components/shopping_cart.rb

@@ -0,0 +1,29 @@
+module Minfraud
+  module Components
+    class ShoppingCart < Base
+      # @attribute items
+      # @return [Array] An array of Minfraud::Components::ShoppingCartItem instances
+
+      attr_accessor :items
+      # Creates Minfraud::Components::ShoppingCart instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::ShoppingCart] ShoppingCart instance
+      def initialize(params = {})
+        @items = params.map(&method(:resolve))
+      end
+
+      # @return [Array] a JSON representation of Minfraud::Components::ShoppingCart items
+      def to_json
+        @items.map(&:to_json)
+      end
+
+      private
+
+      # @param  [Hash] params hash of parameters for Minfraud::Components::ShoppingCartItem
+      # @return [Minfraud::Components::ShoppingCart] ShoppingCart instance
+      def resolve(params)
+        ShoppingCartItem.new(params)
+      end
+    end
+  end
+end

data/lib/minfraud/components/shopping_cart_item.rb

@@ -0,0 +1,33 @@
+module Minfraud
+  module Components
+    class ShoppingCartItem < Base
+      # @attribute category
+      # @return [String] The category of the item
+      attr_accessor :category
+
+      # @attribute item_id
+      # @return [String] The internal ID of the item
+      attr_accessor :item_id
+
+      # @attribute quantity
+      # @return [Integer] The quantity of the item in the shopping cart
+      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
+      attr_accessor :price
+
+      # Creates Minfraud::Components::ShoppingCartItem instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::Components::ShoppingCartItem] ShoppingCartItem instance
+      def initialize(params = {})
+        @category = params[:category]
+        @item_id  = params[:item_id]
+        @quantity = params[:quantity]
+        @price    = params[:price]
+      end
+    end
+  end
+end
+
+

data/lib/minfraud/enum.rb

@@ -0,0 +1,30 @@
+module Minfraud
+  module Enum
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def mapping
+        @mapping ||= {}
+      end
+
+      def enum_accessor(attribute, assignable_values)
+        mapping[attribute] = assignable_values.map(&:to_s)
+
+        self.class.instance_eval do
+          define_method("#{attribute}_values") { mapping[attribute] }
+        end
+
+        self.class_eval do
+          define_method("#{attribute}") { instance_variable_get("@#{attribute}") }
+
+          define_method "#{attribute}=" do |value|
+            raise NotEnumValueError,  'Value is not permitted' unless self.class.mapping[attribute].include?(value.to_s)
+            instance_variable_set("@#{attribute}", value.to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minfraud/error_handler.rb

@@ -0,0 +1,45 @@
+module Minfraud
+  module ErrorHandler
+    class << self
+      # Returns a response if status code is 200, rises an error otherwise
+      # @param [Minfraud::HTTPService::Response] response
+      # @return [Minfraud::HTTPService::Response] if status code is 200
+      def inspect(response)
+        return response if response.status == 200
+
+        raise *STATUS_CODES.fetch(response.code&.intern, [ServerError, 'Service not available'])
+      end
+
+      # A hash that maps status codes returned by minFraud with errors & messages
+      STATUS_CODES = {
+        IP_ADDRESS_INVALID:    [
+          ClientError, 'You have no supplied a valid IPv4 or IPv6 address'
+        ],
+        IP_ADDRESS_REQUIRED:   [
+          ClientError,  'You have not supplied an IP address which is required filed'
+        ],
+        IP_ADDRESS_RESERVED:   [
+          ClientError, 'You have supplied an IP address which is reserved'
+        ],
+        JSON_INVALID:          [
+          ClientError, 'JSON body cannot be decoded'
+        ],
+        AUTHORIZATION_INVALID: [
+          AuthorizationError, 'Invalid license key and / or user id'
+        ],
+        LICENSE_KEY_REQUIRED:  [
+          AuthorizationError, 'You have not supplied a license key'
+        ],
+        USER_ID_REQUIRED:      [
+          AuthorizationError, 'You have not supplied a user id'
+        ],
+        INSUFFICIENT_FUNDS:    [
+          ClientError, 'The license key you have provided does not have a sufficient funds to use this service'
+        ],
+        PERMISSION_REQUIRED:   [
+          ClientError, 'You do not have permission to use this service'
+        ]
+      }
+    end
+  end
+end

data/lib/minfraud/errors.rb

@@ -0,0 +1,10 @@
+module Minfraud
+  # A list of Minfraud custom errors
+  class BaseError          < StandardError; end
+
+  class NotEnumValueError  < BaseError; end
+  class RequestFormatError < BaseError; end
+  class ClientError        < BaseError; end
+  class AuthorizationError < BaseError; end
+  class ServerError        < BaseError; end
+end

data/lib/minfraud/http_service.rb

@@ -0,0 +1,31 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Minfraud
+  module HTTPService
+    class << self
+      # @return [Hash] default HTTPService configuration
+      def configuration
+        {
+          middleware: DEFAULT_MIDDLEWARE,
+          server:     DEFAULT_SERVER
+        }
+      end
+    end
+
+    # Minfraud default middleware stack
+    DEFAULT_MIDDLEWARE = Proc.new do |builder|
+      builder.request    :json
+
+      builder.basic_auth *::Minfraud.configuration.values
+
+      builder.response   :mashify
+      builder.response   :json, content_type: /\bjson$/
+
+      builder.adapter    Faraday.default_adapter
+    end
+
+    # Minfraud default server
+    DEFAULT_SERVER = 'https://minfraud.maxmind.com/minfraud/v2.0'
+  end
+end

data/lib/minfraud/http_service/request.rb

@@ -0,0 +1,37 @@
+require 'faraday'
+
+module Minfraud
+  module HTTPService
+    class Request
+      # @attribute middleware
+      # @return [Proc] A proc containing Faraday configuration
+      attr_reader :middleware
+
+      # @attribute server
+      # @return [String] an API endpoint
+      attr_reader :server
+
+      # Creates Minfraud::HTTPService::Request instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::HTTPService::Request] Request instance
+      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
+      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)
+      end
+    end
+  end
+end

data/lib/minfraud/http_service/response.rb

@@ -0,0 +1,36 @@
+module Minfraud
+  module HTTPService
+    class Response
+      # @attribute status
+      # @return [Integer] HTTP response status
+      attr_reader :status
+
+      # @attribute body
+      # @return [Hash] HTTP response body
+      attr_reader :body
+
+      # @attribute headers
+      # @return [Hash] HTTP response headers
+      attr_reader :headers
+
+      # @attribute code
+      # @return [String] minFraud specific HTTP response code
+      attr_reader :code
+
+      # Creates Minfraud::HTTPService::Response instance
+      # @param  [Hash] params hash of parameters
+      # @return [Minfraud::HTTPService::Response] Response instance
+      def initialize(params)
+        @status  = params[:status]
+        @body    = params[:body]
+        @headers = params[:headers]
+      end
+
+      # Returns minFraud specific response code
+      # @return [String] minFraud specific request code
+      def code
+        body.code if body.respond_to?(:code)
+      end
+    end
+  end
+end

data/lib/minfraud/resolver.rb

@@ -0,0 +1,32 @@
+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:)
+        Array(params).each do |key, value|
+          raise RequestFormatError, "#{key} does not belong to request document format" unless MAPPING[key]
+
+          entity = MAPPING[key].new(value) unless value.is_a?(MAPPING[key])
+          context.send("#{key}=", entity || value)
+        end
+      end
+    end
+
+    # 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
+    }
+  end
+end

data/lib/minfraud/version.rb

@@ -0,0 +1,3 @@
+module Minfraud
+  VERSION = "1.0.0"
+end

data/minfraud.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minfraud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minfraud"
+  spec.version       = Minfraud::VERSION
+  spec.authors       = ["kushnir.yb"]
+  spec.email         = ["kushnir.yb@gmail.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.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: minfraud
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- kushnir.yb
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- kushnir.yb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minfraud.rb
+- lib/minfraud/assessments.rb
+- lib/minfraud/components/account.rb
+- lib/minfraud/components/addressable.rb
+- lib/minfraud/components/base.rb
+- lib/minfraud/components/billing.rb
+- lib/minfraud/components/credit_card.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/shipping.rb
+- lib/minfraud/components/shopping_cart.rb
+- lib/minfraud/components/shopping_cart_item.rb
+- lib/minfraud/enum.rb
+- lib/minfraud/error_handler.rb
+- lib/minfraud/errors.rb
+- lib/minfraud/http_service.rb
+- lib/minfraud/http_service/request.rb
+- lib/minfraud/http_service/response.rb
+- lib/minfraud/resolver.rb
+- lib/minfraud/version.rb
+- minfraud.gemspec
+homepage: https://github.com/kushniryb/minfraud-api-v2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Ruby interface to the MaxMind minFraud v2.0 API services
+test_files: []
+has_rdoc: