minfraud-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70984ef59b83860d9aa8683045bf0f7d38b2dfbb
+  data.tar.gz: a51d52744dbd3c64531d086812014a1d9baeeb6b
+SHA512:
+  metadata.gz: 50015aca3d50f32f23fe9a422c65c5ecc6625846076e00197030a174f87ff391ef694d100d2ea1c8ad9d02943cc544f8e066e759966936dbd99337b1307f8d31
+  data.tar.gz: 5a1ecf78b729dccef28f2e69d10d8e6496a7399575c6cfbe44f20d57ca3baef4c6f88242cbee84edb1f585caa0db04aac903341c2a64c31f1534c544a4a52696

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in minfraud-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,340 @@
+        GNU GENERAL PUBLIC LICENSE
+           Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+          Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+        GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+          NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+         END OF TERMS AND CONDITIONS
+
+      How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year  name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/README.md

@@ -0,0 +1,100 @@
+# Ruby interface to the MaxMind minFraud API
+
+Compatible with version minFraud API v1.3  
+[minFraud API documentation](http://dev.maxmind.com/minfraud/)  
+[minFraud](http://www.maxmind.com/en/ccv_overview)
+
+[![Build Status](https://travis-ci.org/rdpitts/minfraud-ruby.svg?branch=master)](https://travis-ci.org/rdpitts/minfraud-ruby)
+[![Code Climate](https://codeclimate.com/github/rdpitts/minfraud-ruby.png)](https://codeclimate.com/github/rdpitts/minfraud-ruby)
+
+[Rubydoc documentation](http://rubydoc.info/github/rdpitts/minfraud-ruby/master/frames)
+
+## Configuration
+
+Your license key is how MaxMind will identify you, so it is required.
+
+```ruby
+Minfraud.configure do |c|
+  c.license_key = 'abcd1234'
+  c.requested_type = 'standard'
+end
+```
+
+`requested_type` can be set during configuration to use that default value or it can be set on the transaction. If unset minFraud will default to the highest level of service available to you.
+
+## Usage
+
+```ruby
+transaction = Minfraud::Transaction.new do |t|
+  # Required fields
+  # Other fields listed later in documentation are optional
+  t.ip = '1.2.3.4'
+  t.city = 'richmond'
+  t.state = 'virginia'
+  t.postal = '12345'
+  t.country = 'US' # http://en.wikipedia.org/wiki/ISO_3166-1
+  # ...
+end
+
+transaction.risk_score
+# => 3.48
+```
+
+### Exception handling
+
+There are three different exceptions that this gem may raise. Please be prepared to handle them:
+
+```ruby
+# Raised if configuration is invalid
+class ConfigurationError < ArgumentError; end
+
+# Raised if a transaction is invalid
+class TransactionError < ArgumentError; end
+
+# Raised if minFraud returns an error, or if there is an HTTP error
+class ResponseError < ArgumentError; end
+```
+
+### Transaction fields
+
+#### Required
+
+| name          | type (length)         | example                             | description |
+| ------------- | --------------------- | ----------------------------------- | ----------- |
+| ip            | string                | `t.ip = '1.2.3.4'`                  | Customer IP address |
+| city          | string                | `t.city = 'new york'`               | Customer city |
+| state         | string                | `t.state = 'new york'`              | Customer state/province/region |
+| postal        | string                | `t.postal = '10014'`                | Customer zip/postal code |
+| country       | string                | `t.country = 'US'`                  | Customer ISO 3166-1 country code |
+
+#### Optional
+
+| name               | type (length)      | description |
+| ------------------ | ------------------ | ----------- |
+| ship_addr          | string             | |
+| ship_city          | string             | |
+| ship_state         | string             | |
+| ship_postal        | string             | |
+| ship_country       | string             | |
+| email              | string             | We will hash the email for you |
+| phone              | string             | Any format acceptable |
+| bin                | string             | CC bin number (first 6 digits) |
+| session_id         | string             | Used for linking transactions |
+| user_agent         | string             | Used for linking transactions |
+| accept_language    | string             | Used for linking transactions |
+| txn_id             | string             | Transaction/order id |
+| amount             | string             | Transaction amount |
+| currency           | string             | ISO 4217 currency code |
+| txn_type           | string             | creditcard/debitcard/paypal/google/other/lead/survey/sitereg |
+| avs_result         | string             | Standard AVS response code |
+| cvv_result         | string             | Y/N |
+| requested_type     | string             | standard/premium |
+| forwarded_ip       | string             | The end user’s IP address, as forwarded by a transparent proxy |
+
+## Contributing
+
+1. Fork it ( http://github.com/rdpitts/minfraud-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = %w[-w]
+  t.rspec_opts = %w[-c]
+end
+
+task default: :spec

data/lib/minfraud/minfraud.rb

@@ -0,0 +1,71 @@
+module Minfraud
+
+  # Raised if configuration is invalid
+  class ConfigurationError < ArgumentError; end
+
+  # Raised if a transaction is invalid
+  class TransactionError < ArgumentError; end
+
+  # Raised if minFraud returns an error, or if there is an HTTP error
+  class ResponseError < ArgumentError; end
+  
+  # May be used to configure using common block style:
+  #
+  # ```ruby
+  # Minfraud.configure do |c|
+  #   c.license_key = 'abcd1234'
+  # end
+  # ```
+  #
+  # @param [Proc] is passed the Minfraud module as its argument
+  # @return [nil, ConfigurationError]
+  def self.configure
+    yield self
+    unless has_required_configuration?
+      raise ConfigurationError, 'You must set license_key so MaxMind can identify you'
+    end
+  end
+
+  # Module attribute getter for license_key
+  # This is the MaxMind API consumer's license key.
+  # @return [String, nil] license key if set
+  def self.license_key
+    class_variable_defined?(:@@license_key) ? @@license_key : nil
+  end
+
+  # Module attribute setter for license_key
+  # This is the MaxMind API consumer's license key.
+  # It is required for this gem to work.
+  # @param key [String] license key
+  # @return [String] license key
+  def self.license_key=(key)
+    @@license_key = key
+  end
+
+  # Module attribute getter for requested_type
+  # minFraud service level (standard/premium)
+  # @return [String, nil] service level if set
+  def self.requested_type
+    class_variable_defined?(:@@requested_type) ? @@requested_type : nil
+  end
+
+  # Module attribute setter for requested_type
+  # Desired service level (standard/premium)
+  # @param type [String] service level
+  # @return [String] service level
+  def self.requested_type=(type)
+    @@requested_type = type
+  end
+
+  # MaxMind minFraud API service URI
+  # @return [URI::HTTPS] service uri
+  def self.uri
+    @@uri ||= URI('https://minfraud.maxmind.com/app/ccv2r')
+  end
+
+  # @return [Boolean] service URI
+  def self.has_required_configuration?
+    class_variable_defined?(:@@license_key)
+  end
+
+end

data/lib/minfraud/request.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+
+module Minfraud
+
+  class Request
+
+    FIELD_MAP = {
+      ip: 'i',
+      city: 'city',
+      state: 'region',
+      postal: 'postal',
+      country: 'country',
+      license_key: 'license_key',
+      ship_addr: 'shipAddr',
+      ship_city: 'shipCity',
+      ship_state: 'shipRegion',
+      ship_postal: 'shipPostal',
+      ship_country: 'shipCountry',
+      email_domain: 'domain',
+      email_md5: 'emailMD5',
+      phone: 'custPhone',
+      bin: 'bin',
+      session_id: 'sessionID',
+      user_agent: 'user_agent',
+      accept_language: 'accept_language',
+      txn_id: 'txnID',
+      amount: 'order_amount',
+      currency: 'order_currency',
+      txn_type: 'txn_type',
+      avs_result: 'avs_result',
+      cvv_result: 'cvv_result',
+      requested_type: 'requested_type',
+      forwarded_ip: 'forwardedIP'
+    }
+
+    # @param trans [Transaction] transaction to be sent to MaxMind
+    def initialize(trans)
+      @transaction = trans
+    end
+
+    # Sends transaction to MaxMind and gives raw response to Response for handling
+    # @return [Response] wrapper for minFraud response
+    def get
+      Response.new(send_get_request)
+    end
+
+    # (see #get)
+    # @param trans [Transaction] transaction to get to MaxMind
+    def self.get(trans)
+      new(trans).get
+    end
+
+    private
+
+    # Transforms Transaction object into a hash for Net::HTTP::Get
+    # @return [Hash] keys are strings with minFraud field names
+    def encoded_query
+      Hash[@transaction.attributes.map { |k, v| [FIELD_MAP[k], v] }]
+    end
+
+    # @return [Net::HTTPResponse]
+    def send_get_request
+      uri = Minfraud.uri
+      uri.query = URI.encode_www_form(encoded_query)
+      Net::HTTP.get_response(uri)
+    end
+
+  end
+end

data/lib/minfraud/response.rb

@@ -0,0 +1,71 @@
+module Minfraud
+
+  # This class wraps the raw minFraud response. Any minFraud response field is accessible on a Response
+  # instance as a snake-cased instance method. For example, if you want the `ip_corporateProxy`
+  # field from minFraud, you can get it with `#ip_corporate_proxy`.
+  class Response
+
+    ERROR_CODES = %w( INVALID_LICENSE_KEY IP_REQUIRED IP_NOT_FOUND LICENSE_REQUIRED COUNTRY_REQUIRED MAX_REQUESTS_REACHED )
+    WARNING_CODES = %w( COUNTRY_NOT_FOUND CITY_NOT_FOUND CITY_REQUIRED POSTAL_CODE_REQUIRED POSTAL_CODE_NOT_FOUND )
+
+    # Sets attributes on self using minFraud response keys and values
+    # Raises an exception if minFraud returns an error message
+    # Does nothing (at the moment) if minFraud returns a warning message
+    # Raises an exception if minFraud responds with anything other than an HTTP success code
+    # @param raw [Net::HTTPResponse]
+    def initialize(raw)
+      raise ResponseError, "The minFraud service responded with http error #{raw.class}" unless raw.is_a? Net::HTTPSuccess
+      decode_body(raw.body)
+      raise ResponseError, "Error message from minFraud: #{error}" if errored?
+    end
+
+    private
+
+    # True if minFraud returns an error (but not a warning), false if not.
+    # @return [Boolean]
+    def errored?
+      ERROR_CODES.include? err
+    end
+
+    # If minFraud sends back an error or warning message, this will return the message, otherwise nil.
+    # @return [String, nil] minFraud error field in response
+    def error
+      err
+    end
+
+    # Parses raw response body and turns its keys and values into attributes on self.
+    # @param body [String] raw response body string
+    def decode_body(body)
+      # We bind the resultant hash to @body for #method_missing
+      @body = transform_keys(Hash[body.split(';').map { |e| e.split('=') }])
+    end
+
+    # Snake cases and symbolizes keys in passed hash.
+    # @param hash [Hash]
+    def transform_keys(hash)
+      hash = hash.to_a
+      hash.map! do |e|
+        key = e.first
+        value = e.last
+        if key.match(/\A[A-Z]+\z/)
+          key = key.downcase
+        else
+          key = key.
+          gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+          gsub(/([a-z])([A-Z])/, '\1_\2').
+          downcase.
+          to_sym
+        end
+        [key, value]
+      end
+      Hash[hash]
+    end
+
+    # Allows keys in hash contained in @body to be used as methods
+    def method_missing(meth, *args, &block)
+      # We're not calling super because we want nil if an attribute isn't found
+      @body[meth]
+    end
+
+  end
+end

data/lib/minfraud/transaction.rb

@@ -0,0 +1,113 @@
+require 'digest/md5'
+
+module Minfraud
+
+  # This is the container for the data you're sending to MaxMind.
+  # A transaction holds data like name, address, IP, order amount, etc.
+  class Transaction
+
+    # Required attribute
+    attr_accessor :ip, :city, :state, :postal, :country
+
+    # Shipping address attribute (optional)
+    attr_accessor :ship_addr, :ship_city, :ship_state, :ship_postal, :ship_country
+
+    # User attribute (optional)
+    attr_accessor :email, :phone
+
+    # Credit card attribute (optional)
+    attr_accessor :bin
+
+    # Transaction linking attribute (optional)
+    attr_accessor :session_id, :user_agent, :accept_language
+
+    # Transaction attribute (optional)
+    attr_accessor :txn_id, :amount, :currency, :txn_type
+
+    # Credit card result attribute (optional)
+    attr_accessor :avs_result, :cvv_result
+
+    # Miscellaneous attribute (optional)
+    attr_accessor :requested_type, :forwarded_ip
+
+    def initialize
+      yield self
+      unless has_required_attributes?
+        raise TransactionError, 'You did not set all the required transaction attributes.'
+      end
+      validate_attributes
+    end
+
+    # Retrieves the risk score from MaxMind.
+    # A higher score indicates a higher risk of fraud.
+    # For example, a score of 20 indicates a 20% chance that a transaction is fraudulent.
+    # @return [Float] 0.01 - 100.0
+    def risk_score
+      results.risk_score
+    end
+
+    # Hash of attributes that have been set
+    # @return [Hash] present attributes
+    def attributes
+      attrs = [:ip, :city, :state, :postal, :country, :license_key, :ship_addr, :ship_city, :ship_state, :ship_postal, :ship_country, :email_domain, :email_md5, :phone, :bin, :session_id, :user_agent, :accept_language, :txn_id, :amount, :currency, :txn_type, :avs_result, :cvv_result, :requested_type, :forwarded_ip]
+      attrs.map! do |a|
+        [a, send(a)]
+      end
+      Hash[attrs]
+    end
+
+    # Uses the requested_type set on the instance, or if not present, the requested_type set during configuration
+    # @return [String, nil] requested type
+    def requested_type
+      @requested_type or Minfraud.requested_type
+    end
+
+    private
+
+    # Ensures the required attributes are present
+    # @return [Boolean]
+    def has_required_attributes?
+      ip and city and state and postal and country
+    end
+
+    # Validates the types of the attributes
+    # @return [nil, TransactionError]
+    def validate_attributes
+      [:ip, :city, :state, :postal, :country].each { |s| validate_string(s) }
+    end
+
+    # Given the symbol of an attribute that should be a string,
+    # it checks the attribute's type and throws an error if it's not a string.
+    # @param attr_name [Symbol] name of the attribute to validate
+    # @return [nil, TransactionError]
+    def validate_string(attr_name)
+      attribute = self.send(attr_name)
+      unless attribute.instance_of?(String)
+        raise TransactionError, "Transaction.#{attr_name} must me a string"
+      end
+    end
+
+    # Sends transaction to MaxMind in order to get risk data on it.
+    # Caches response object in @response.
+    # @return [Response]
+    def results
+      @response ||= Request.get(self)
+    end
+
+    # @return [String, nil] domain of the email address
+    def email_domain
+      email.to_s.split('@').last
+    end
+
+    # @return [String, nil] MD5 hash of the whole email address
+    def email_md5
+      Digest::MD5.hexdigest(email.to_s)
+    end
+
+    # @return [String] license key set during configuration
+    def license_key
+      Minfraud.license_key
+    end
+
+  end
+end

data/lib/minfraud/version.rb

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

data/lib/minfraud-ruby.rb

@@ -0,0 +1,5 @@
+require 'minfraud/minfraud'
+require 'minfraud/transaction'
+require 'minfraud/request'
+require 'minfraud/response'
+require 'minfraud/version'

data/minfraud-ruby.gemspec

@@ -0,0 +1,27 @@
+# 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-ruby"
+  spec.version       = Minfraud::VERSION
+  spec.authors       = ["Robbie Pitts"]
+  spec.email         = ["robbie@sweatypitts.com"]
+  spec.summary       = %q{Ruby interface to the MaxMind minFraud API service.}
+  spec.license       = "GNU GPL"
+  spec.homepage      = "https://github.com/rdpitts/minfraud-ruby"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "ffaker"
+end

data/spec/minfraud/minfraud_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe Minfraud do
+
+  describe '.configure' do
+    it 'yields the Minfraud module' do
+      Minfraud.stub(:has_required_configuration?).and_return(true)
+      Minfraud.configure do |c|
+        expect(c).to eql(Minfraud)
+      end
+    end
+
+    it 'raises an exception if required fields are not set' do
+      expect { Minfraud.configure { |c| true } }.to raise_exception(Minfraud::ConfigurationError)
+    end
+  end
+
+  describe '.license_key' do
+    let(:license_key) { 'asdf' }
+
+    before { Minfraud.remove_class_variable(:@@license_key) if Minfraud.class_variable_defined?(:@@license_key) }
+
+    it 'gets license key attribute set on Minfraud module' do
+      Minfraud.class_variable_set(:@@license_key, license_key)
+      expect(Minfraud.license_key).to eq(license_key)
+    end
+
+    it 'returns nil when license key attribute is not set' do
+      expect(Minfraud.license_key).to eq(nil)
+    end
+  end
+
+  describe '.license_key=' do
+    let(:license_key) { 'asdf' }
+
+    before { Minfraud.remove_class_variable(:@@license_key) if Minfraud.class_variable_defined?(:@@license_key) }
+
+    it 'sets license key attribute on Minfraud module' do
+      Minfraud.license_key = license_key
+      expect(Minfraud.class_variable_get(:@@license_key)).to eq(license_key)
+    end
+  end
+
+  describe '.uri' do
+    after do
+      Minfraud.remove_class_variable(:@@uri)
+    end
+
+    it 'returns a URI::HTTPS object' do
+      expect(Minfraud.uri).to be_instance_of(URI::HTTPS)
+    end
+
+    it 'returns URI::HTTPS object containing the minFraud service uri' do
+      expect(Minfraud.uri.to_s).to eq('https://minfraud.maxmind.com/app/ccv2r')
+    end
+
+    it 'caches URI::HTTPS object' do
+      Minfraud.uri
+      expect(Minfraud.class_variable_defined?(:@@uri)).to be_true
+    end
+  end
+
+  describe '.has_required_configuration?' do
+    let(:license_key) { 'asdf' }
+
+    before do
+      Minfraud.remove_class_variable(:@@license_key) if Minfraud.class_variable_defined?(:@@license_key)
+    end
+
+    it 'returns true if license_key is set' do
+      Minfraud.class_variable_set(:@@license_key, license_key)
+      expect(Minfraud.has_required_configuration?).to be_true
+    end
+
+    it 'returns false if license_key is not set' do
+      expect(Minfraud.has_required_configuration?).to be_false
+    end
+  end
+
+end

data/spec/minfraud/request_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Minfraud::Request do
+  subject(:request) { Minfraud::Request.new(transaction) }
+  let(:transaction) { double(Minfraud::Transaction, attributes: {}) }
+  let(:success_response) { double(Minfraud::Response, errored?: false, body: '') }
+  let(:exception) { Minfraud::ResponseError.new('Message from MaxMind: INVALID_LICENSE_KEY') }
+
+  describe '.new' do
+    it 'binds the @transaction instance variable' do
+      expect(request.instance_variable_get(:@transaction)).to eql(transaction)
+    end
+  end
+
+  describe '#get' do
+    it 'sends appropriately encoded transaction data to minFraud service' do
+      Minfraud.stub(:license_key).and_return('6')
+      Minfraud::Response.stub(:new).and_return(success_response)
+      trans = Minfraud::Transaction.new do |t|
+        t.ip = '1'
+        t.city = '2'
+        t.state = '3'
+        t.postal = '4'
+        t.country = '5'
+      end
+      request_body = {
+        'i' => '1',
+        'city' => '2',
+        'region' => '3',
+        'postal' => '4',
+        'country' => '5',
+        'license_key' => '6'
+      }
+      expect(Net::HTTP).to receive(:get_response) do |uri|
+        expect(uri.to_s).to include(Minfraud.uri.to_s)
+        expect(uri.query).to include(URI.encode_www_form(request_body))
+      end
+      Minfraud::Request.new(trans).get
+    end
+
+    it 'creates Response object out of raw response' do
+      expect(request).to receive(:send_get_request)
+      expect(Minfraud::Response).to receive(:new).and_return(success_response)
+      request.get
+    end
+
+    it 'returns Response object' do
+      request.stub(:send_get_request)
+      Minfraud::Response.stub(:new).and_return(success_response)
+      expect(request.get).to eql(success_response)
+    end
+  end
+
+end

data/spec/minfraud/response_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Minfraud::Response do
+  let(:ok_response_double) { double(Net::HTTPOK, body: 'firstKey=first value;second_keyName=second value', is_a?: true) }
+  let(:warning_response_double) { double(Net::HTTPOK, body: 'err=COUNTRY_NOT_FOUND', is_a?: true) }
+  let(:error_response_double) { double(Net::HTTPOK, body: 'err=INVALID_LICENSE_KEY', is_a?: true) }
+  let(:server_error_response) { double(Net::HTTPInternalServerError) }
+  let(:err) { Faker::HipsterIpsum.word }
+
+  describe '.new' do
+    subject(:response) { Minfraud::Response.new(ok_response_double) }
+
+    it 'raises exception without an OK response' do
+      expect { Minfraud::Response.new(server_error_response)}
+    end
+
+    it 'raises exception if minFraud returns an error' do
+      expect { Minfraud::Response.new(error_response_double) }.to raise_exception(Minfraud::ResponseError, /INVALID_LICENSE_KEY/)
+    end
+
+    it 'does not raise an exception if minFraud returns a warning' do
+      expect { Minfraud::Response.new(warning_response_double) }.not_to raise_exception
+    end
+
+    it 'turns raw body keys and values into attributes on the object' do
+      expect(response.first_key).to eq('first value')
+      expect(response.second_key_name).to eq('second value')
+    end
+  end
+
+end

data/spec/minfraud/transaction_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+describe Minfraud::Transaction do
+
+  describe '.new' do
+    it 'yields the current instance module' do
+      Minfraud::Transaction.new do |t|
+        t.stub(:has_required_attributes?).and_return(true)
+        t.stub(:validate_attributes).and_return(nil)
+        expect(t).to be_an_instance_of(Minfraud::Transaction)
+      end
+    end
+
+    it 'raises an exception if required attributes are not set' do
+      expect { Minfraud::Transaction.new { |c| true } }.to raise_exception(Minfraud::TransactionError, /required/)
+    end
+
+    it 'raises an exception if attributes are invalid' do
+      transaction = lambda do
+        Minfraud::Transaction.new do |t|
+          t.ip = ''
+          t.city = 2
+          t.state = ''
+          t.postal = ''
+          t.country = ''
+        end
+      end
+      expect { transaction.call }.to raise_exception(Minfraud::TransactionError, /city must me a string/)
+    end
+  end
+
+  describe '#risk_score' do
+    subject(:transaction) do
+      Minfraud::Transaction.new do |t|
+        t.stub(:has_required_attributes?).and_return(true)
+        t.stub(:validate_attributes).and_return(nil)
+      end
+    end
+    let(:response) { double(risk_score: risk_score) }
+    let(:risk_score) { 3.4 }
+
+    before do
+      Minfraud::Request.stub(:get).and_return(response)
+    end
+
+    context 'transaction has not already been sent to MaxMind' do
+      it 'sends transaction to MaxMind' do
+        expect(Minfraud::Request).to receive(:get).with(transaction)
+        transaction.risk_score
+      end
+
+      it 'caches response' do
+        transaction.risk_score
+        expect(transaction.instance_variable_get(:@response)).to eql(response)
+      end
+
+      it 'returns float containing risk score' do
+        transaction.risk_score
+        expect(transaction.risk_score).to eq(risk_score)
+      end
+    end
+
+    context 'transaction has already been sent to MaxMind' do
+      before { transaction.instance_variable_set(:@response, response) }
+
+      it 'does not send transaction to MaxMind' do
+        expect(Minfraud::Request).not_to receive(:get)
+        transaction.risk_score
+      end
+
+      it 'returns float containing risk score' do
+        expect(transaction.risk_score).to eq(risk_score)
+      end
+    end
+  end
+
+  describe '#attributes' do
+    subject(:transaction) do
+      Minfraud::Transaction.new do |t|
+        t.ip = 'ip'
+        t.city = 'city'
+        t.state = 'state'
+        t.postal = 'postal'
+        t.country = 'country'
+        t.email = 'hughjass@example.com'
+        t.requested_type = 'standard'
+      end
+    end
+
+    before { Minfraud.requested_type = 'premium' }
+    after { Minfraud.remove_class_variable(:@@requested_type) }
+
+    it 'returns a hash of attributes' do
+      expect(transaction.attributes[:ip]).to eq('ip')
+      expect(transaction.attributes[:city]).to eq('city')
+      expect(transaction.attributes[:state]).to eq('state')
+      expect(transaction.attributes[:postal]).to eq('postal')
+      expect(transaction.attributes[:country]).to eq('country')
+    end
+
+    it 'derives email domain and an md5 hash of whole email from email attribute' do
+      expect(transaction.attributes[:email_domain]).to eq('example.com')
+      expect(transaction.attributes[:email_md5]).to eq('01ddb59d9bc1d1bfb3eb99a22578ce33')
+    end
+
+  end
+
+  describe '#requested_type' do
+    subject(:transaction) do
+      Minfraud::Transaction.new do |t|
+        t.ip = 'ip'
+        t.city = 'city'
+        t.state = 'state'
+        t.postal = 'postal'
+        t.country = 'country'
+        t.email = 'hughjass@example.com'
+        t.requested_type = 'standard'
+      end
+    end
+
+    before { Minfraud.requested_type = 'premium' }
+    after { Minfraud.remove_class_variable(:@@requested_type) }
+
+    it 'uses requested type as set on transaction if present' do
+      expect(transaction.attributes[:requested_type]).to eq('standard')
+    end
+
+    it 'uses requested type as set during configuration if not present in transaction' do
+      transaction = Minfraud::Transaction.new do |t|
+        t.ip = 'ip'
+        t.city = 'city'
+        t.state = 'state'
+        t.postal = 'postal'
+        t.country = 'country'
+        t.email = 'hughjass@example.com'
+      end
+      expect(transaction.attributes[:requested_type]).to eq('premium')
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'minfraud-ruby'
+require 'ffaker'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: minfraud-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robbie Pitts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  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:
+- robbie@sweatypitts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minfraud-ruby.rb
+- lib/minfraud/minfraud.rb
+- lib/minfraud/request.rb
+- lib/minfraud/response.rb
+- lib/minfraud/transaction.rb
+- lib/minfraud/version.rb
+- minfraud-ruby.gemspec
+- spec/minfraud/minfraud_spec.rb
+- spec/minfraud/request_spec.rb
+- spec/minfraud/response_spec.rb
+- spec/minfraud/transaction_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rdpitts/minfraud-ruby
+licenses:
+- GNU GPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby interface to the MaxMind minFraud API service.
+test_files:
+- spec/minfraud/minfraud_spec.rb
+- spec/minfraud/request_spec.rb
+- spec/minfraud/response_spec.rb
+- spec/minfraud/transaction_spec.rb
+- spec/spec_helper.rb
+has_rdoc: