maxmind 0.1.2 → 0.4.2

data/.gitignore

@@ -3,3 +3,6 @@
 coverage
 rdoc
 pkg
+Gemfile.lock
+.rvmrc
+*.sublime*

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :version => 2, :cli => '--color --format doc' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('lib/eventricle.rb') { "spec/eventricle.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/README.md

@@ -0,0 +1,134 @@
+maxmind
+==========
+
+A wrapper around MaxMind's minFraud anti-fraud service.
+
+
+Installation
+------------
+
+In your Gemfile;
+
+    gem 'maxmind'
+
+Tests
+------------
+
+    bundle install
+    guard
+
+Dependencies
+------------
+
+    bundle install
+
+Running Tests
+-------------
+
+Run `bundle install` to make sure you have all the dependencies. Once that's done, run:
+
+    rake test
+
+Usage
+-----
+
+### Minimum Required ###
+These are the only required fields to acquire a response from MaxMind.
+
+    require 'maxmind'
+    Maxmind.license_key = 'LICENSE_KEY'
+    request = Maxmind::Request.new(
+      :client_ip => '24.24.24.24',
+      :city => 'New York',
+      :region	=> 'NY',
+      :postal	=> '11434',
+      :country => 'US'
+    )
+
+	  response = request.process!
+
+
+### Recommended ###
+For increased accuracy, these are the recommended fields to submit to MaxMind. The additional
+fields here are optional and can be all or none.
+
+    require 'maxmind'
+    Maxmind.license_key = 'LICENSE_KEY'
+    request = Maxmind::Request.new(
+		  :client_ip => '24.24.24.24',
+		  :city => 'New York',
+		  :region	=> 'NY',
+		  :postal	=> '11434',
+		  :country => 'US',
+		  :domain => 'yahoo.com',
+      :bin => '549099',
+      :forwarded_ip => '24.24.24.25',
+      :email => 'test@test.com',
+      :username => 'test_carder_username',
+      :password => 'test_carder_password'
+    )
+
+	  response = request.process!
+
+### Thorough ###
+This is every field available.
+
+    require 'maxmind'
+    Maxmind.license_key = 'LICENSE_KEY'
+    request = Maxmind::Request.new(
+      :client_ip => '24.24.24.24',
+      :city => 'New York',
+      :region	=> 'NY',
+      :postal	=> '11434',
+      :country => 'US',
+      :domain => 'yahoo.com',
+      :bin => '549099',
+      :forwarded_ip => '24.24.24.25',
+      :email => 'test@test.com',
+      :username => 'test_carder_username',
+      :password => 'test_carder_password'
+      :bin_name => 'MBNA America Bank',
+      :bin_phone => '800-421-2110',
+      :cust_phone => '212-242',
+      :request_type => 'premium',
+      :shipping_address => '145-50 157th Street',
+      :shipping_city => 'Jamaica',
+      :shipping_region => 'NY',
+      :shipping_postal => '11434',
+      :shipping_country => 'US',
+      :transaction_id => '1234',
+      :session_id => 'abcd9876',
+      :user_agent => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_5; en-us) AppleWebKit/525.18 (KHTML, like Gecko) Version/3.1.2 Safari/525.20.1',
+      :accept_language => 'en-us'
+    )
+
+	  response = request.process!
+
+
+Also see examples/example.rb
+
+TODO
+----
+* Improve specs (eg, test server failover)
+
+Reference
+---------
+[minFraud API Reference](http://www.maxmind.com/app/ccv)
+
+Contributors
+------------
+Sam Oliver <sam@samoliver.com>
+Nick Wilson <nick@di.fm>
+Wolfram Arnold <wolfram@rubyfocus.biz>
+Jonathan Lim <snowblink@gmail.com>
+Tom Blomfield
+Thomas Morgan
+Tinu Cleatus <tinu.cleatus@me.com>
+
+Thanks to all :)
+
+Copyright
+---------
+Copyright (c) 2009 Adam Daniels <adam@mediadrive.ca>.
+
+See LICENSE for details.

data/Rakefile

@@ -1,57 +1,20 @@
-require 'rubygems'
-require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "maxmind"
-    gem.summary = %Q{TODO}
-    gem.email = "adam@mediadrive.ca"
-    gem.homepage = "http://github.com/adam12/maxmind"
-    gem.authors = ["Adam Daniels"]
-    gem.add_dependency 'httparty'
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+  t.rspec_opts = %w(--color --format doc)
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
+task :default => :spec
 
-
-task :default => :test
-
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
+  version = File.read 'VERSION' rescue nil
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "maxmind #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-

data/examples/example.rb

@@ -22,7 +22,7 @@ optional_fields = {
   :bin_name => 'MBNA America Bank',
   :bin_phone => '800-421-2110',
   :cust_phone => '212-242',
-  :requested_type => 'premium',
+  :request_type => 'premium',
   :shipping_address => '145-50 157th Street',
   :shipping_city => 'Jamaica',
   :shipping_region => 'NY',
@@ -34,6 +34,8 @@ optional_fields = {
   :accept_language => 'en-us'
 }
 
-request = Maxmind::Request.new('LICENSE_KEY', required_fields.merge(recommended_fields).merge(optional_fields))
-response = Maxmind::Response.new(request.query)
-pp response
+Maxmind.license_key = 'LICENSE_KEY'
+Maxmind::Request.default_request_type = 'standard'
+request = Maxmind::Request.new(required_fields.merge(recommended_fields).merge(optional_fields))
+response = request.process!
+pp response

data/lib/maxmind.rb

@@ -1,6 +1,11 @@
-require 'rubygems'
-gem 'httparty'
-require 'httparty'
+require 'active_support'
+unless Module.respond_to?(:mattr_accessor)
+  require 'active_support/core_ext/module/attribute_accessors'# rescue nil  # this may be needed for ActiveSupport versions >= 3.x
+end
+require 'active_support/core_ext/hash'
+require 'net/http'
+require 'net/https'
+require 'uri'
 require 'digest/md5'
 require File.join(File.dirname(__FILE__), 'maxmind/request')
 require File.join(File.dirname(__FILE__), 'maxmind/response')

data/lib/maxmind/request.rb

@@ -1,41 +1,107 @@
 module Maxmind
+  # Your license key
+  class << self
+    attr_accessor :license_key
+  end
+	
+  SERVERS = %w(minfraud.maxmind.com minfraud-us-east.maxmind.com minfraud-us-west.maxmind.com)
+
   class Request
+    DefaultTimeout = 60
+
+    # optionally set a default request type (one of 'standard' or 'premium')
+    #   Maxmind's default behavior is to use premium if you have credits, else use standard
+    class << self
+      attr_accessor :default_request_type
+      attr_accessor :timeout
+    end
+
+
     # Required Fields
-    attr_accessor :client_ip, :city, :region, :postal, :country, :license_key
-    
+    attr_accessor :client_ip, :city, :region, :postal, :country
+
     # Optional Fields
-    attr_accessor :domain, :bin, :bin_name, :bin_phone, :cust_phone, :requested_type,
+    attr_accessor :domain, :bin, :bin_name, :bin_phone, :cust_phone, :request_type,
       :forwarded_ip, :email, :username, :password, :transaction_id, :session_id,
       :shipping_address, :shipping_city, :shipping_region, :shipping_postal,
-      :shipping_country, :user_agent, :accept_language
-    
-    def initialize(license_key, options = {}) 
-      @license_key = license_key
-      
-      options.each do |k, v|
-        self.instance_variable_set("@#{k}", v)
+      :shipping_country, :user_agent, :accept_language, :order_amount,
+      :order_currency
+
+    def initialize(attrs={})
+      self.attributes = attrs
+    end
+
+
+    def attributes=(attrs={})
+      attrs.each do |k, v|
+        self.send("#{k}=", v)
       end
     end
-    
-    def query(string = false)
+
+
+    # email domain ... if a full email is provided, take just the domain portion
+    def domain=(email)
+      @domain = if email =~ /@(.+)/
+        $1
+      else
+        email
+      end
+    end
+
+    # customer email ... sends just an MD5 hash of the email.
+    # also sets the email domain at the same time.
+    def email=(email)
+      @email = Digest::MD5.hexdigest(email.downcase)
+      self.domain = email unless domain
+    end
+
+    def username=(username)
+      @username = Digest::MD5.hexdigest(username.downcase)
+    end
+
+    def password=(password)
+      @password = Digest::MD5.hexdigest(password.downcase)
+    end
+
+    # if a full card number is passed, grab just the first 6 digits (which is the bank id number)
+    def bin=(bin)
+      @bin = bin ? bin[0,6] : nil
+    end
+
+
+    def process!
+      resp = post(query)
+      Maxmind::Response.new(resp)
+    end
+
+    def process
+      process!
+    rescue Exception => e
+      false
+    end
+
+
+    private
+
+    def query
       validate
-      
+
       required_fields = {
         :i                => @client_ip,
         :city             => @city,
         :region           => @region,
         :postal           => @postal,
         :country          => @country,
-        :license_key      => @license_key
+        :license_key      => Maxmind::license_key
       }
-      
+
       optional_fields = {
         :domain           => @domain,
         :bin              => @bin,
         :binName          => @bin_name,
         :binPhone         => @bin_phone,
         :custPhone        => @cust_phone,
-        :requested_type   => @requested_type,
+        :requested_type   => @request_type || self.class.default_request_type,
         :forwardedIP      => @forwarded_ip,
         :emailMD5         => @email,
         :usernameMD5      => @username,
@@ -50,40 +116,45 @@ module Maxmind
         :user_agent       => @user_agent,
         :accept_language  => @accept_langage
       }
-      
-      query = required_fields.merge(optional_fields)
-      if string == false
-        return get(query.reject {|k, v| v.nil? })    
-      else
-        return query.reject {|k, v| v.nil? }.to_params
-      end
+
+      field_set = required_fields.merge(optional_fields)
+      field_set.reject {|k, v| v.nil? }
     end
-    
-    def get(query)
-      response = HTTParty.get('http://minfraud3.maxmind.com/app/ccv2r', :query => query)
-      return response.body
-    end
-    
-    def email=(email)
-      @email = Digest::MD5.hexdigest(email.downcase)
-    end
-    
-    def username=(username)
-      @username = Digest::MD5.hexdigest(username.downcase)
-    end
-    
-    def password=(password)
-      @password = Digest::MD5.hexdigest(password.downcase)
+
+    # Upon a failure at the first URL, will automatically retry with the
+    # second & third ones before finally raising an exception
+    def post(query_params)
+      servers ||= SERVERS.map{|hostname| "https://#{hostname}/app/ccv2r"}
+      url = URI.parse(servers.shift)
+      
+      req = Net::HTTP::Post.new(url.path)
+      req.set_form_data(query_params)
+
+      h = Net::HTTP.new(url.host, url.port)
+      h.use_ssl = true
+      h.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      
+      # set some timeouts
+      h.open_timeout  = 60 # this blocks forever by default, lets be a bit less crazy.
+      h.read_timeout  = self.class.timeout || DefaultTimeout
+      h.ssl_timeout   = self.class.timeout || DefaultTimeout
+
+      response = h.start { |http| http.request(req) }
+      response.body
+
+    rescue Exception => e
+      retry if servers.size > 0
+      raise e
     end
     
     protected
     def validate
-      raise ArgumentError, 'license key required' if @license_key.nil?
-      raise ArgumentError, 'IP address required' if @client_ip.nil?
-      raise ArgumentError, 'city required' if @city.nil?
-      raise ArgumentError, 'region required' if @region.nil?
-      raise ArgumentError, 'postal code required' if @postal.nil?
-      raise ArgumentError, 'country required' if @country.nil?
+      raise ArgumentError, 'License key is required' unless Maxmind::license_key
+      raise ArgumentError, 'IP address is required' unless client_ip
+      raise ArgumentError, 'City is required' unless city
+      raise ArgumentError, 'Region is required' unless region
+      raise ArgumentError, 'Postal code is required' unless postal
+      raise ArgumentError, 'Country is required' unless country
     end
   end
-end
+end