adam12-maxmind 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Adam
+
+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.markdown

@@ -0,0 +1,93 @@
+maxmind
+=======
+
+Interfaces with Maxmind's minFraud anti-fraud service.
+
+Installation
+------------
+	gem install adam12-maxmind --source=http://gems.github.com
+	
+
+Dependencies
+------------
+* [httparty](http://github.com/jnunemaker/httparty/)
+* [shoulda](http://github.com/thoughtbot/shoulda/) (used in tests only)
+* [matchy](http://github.com/jeremymcanally/matchy/) (used in tests only)
+
+
+Usage
+-----
+
+### Minimum Required ###
+These are the only required fields to acquire a response from Maxmind.
+
+	request = Maxmind::Request.new('LICENSE_KEY',
+		:client_ip => '24.24.24.24',
+		:city => 'New York',
+		:region	=> 'NY',
+		:postal	=> '11434',
+		:country => 'US')
+		
+	response = Maxmind::Response.new(request.query)
+
+
+### 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.
+
+	request = Maxmind::Request.new('LICENSE_KEY',
+		: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 = Maxmind::Response.new(request.query)
+
+### Thorough ###
+
+	request = Maxmind::Request.new('LICENSE_KEY',
+		: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',
+		:requested_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 = Maxmind::Response.new(request.query)
+
+Also see examples/example.rb
+
+
+Reference
+---------
+[minFraud API Reference](http://www.maxmind.com/app/ccv)
+
+
+Copyright
+---------
+Copyright (c) 2009 Adam. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+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
+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 => :test
+
+require 'rake/rdoctask'
+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
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "maxmind #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/examples/example.rb

@@ -0,0 +1,39 @@
+require 'pp'
+require File.join(File.dirname(__FILE__), '..', 'lib/maxmind')
+
+required_fields = {
+  :client_ip => '24.24.24.24', 
+  :city => 'New York', 
+  :region => 'NY', 
+  :postal => '11434', 
+  :country => 'US'
+}
+
+recommended_fields = {
+  :domain => 'yahoo.com',
+  :bin => '549099',
+  :forwarded_ip => '24.24.24.25',
+  :email => 'test@test.com',
+  :username => 'test_carder_username',
+  :password => 'test_carder_password'
+}
+
+optional_fields = {
+  :bin_name => 'MBNA America Bank',
+  :bin_phone => '800-421-2110',
+  :cust_phone => '212-242',
+  :requested_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'
+}
+
+request = Maxmind::Request.new('LICENSE_KEY', required_fields.merge(recommended_fields).merge(optional_fields))
+response = Maxmind::Response.new(request.query)
+pp response

data/lib/maxmind.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+gem 'httparty'
+require 'httparty'
+require 'digest/md5'
+require File.join(File.dirname(__FILE__), 'maxmind/request')
+require File.join(File.dirname(__FILE__), 'maxmind/response')

data/lib/maxmind/request.rb

@@ -0,0 +1,89 @@
+module Maxmind
+  class Request
+    # Required Fields
+    attr_accessor :client_ip, :city, :region, :postal, :country, :license_key
+    
+    # Optional Fields
+    attr_accessor :domain, :bin, :bin_name, :bin_phone, :cust_phone, :requested_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)
+      end
+    end
+    
+    def query(string = false)
+      validate
+      
+      required_fields = {
+        :i                => @client_ip,
+        :city             => @city,
+        :region           => @region,
+        :postal           => @postal,
+        :country          => @country,
+        :license_key      => @license_key
+      }
+      
+      optional_fields = {
+        :domain           => @domain,
+        :bin              => @bin,
+        :binName          => @bin_name,
+        :binPhone         => @bin_phone,
+        :custPhone        => @cust_phone,
+        :requested_type   => @requested_type,
+        :forwardedIP      => @forwarded_ip,
+        :emailMD5         => @email,
+        :usernameMD5      => @username,
+        :passwordMD5      => @password,
+        :shipAddr         => @shipping_address,
+        :shipCity         => @shipping_city,
+        :shipRegion       => @shipping_region,
+        :shipPostal       => @shipping_postal,
+        :shipCountry      => @shipping_country,
+        :txnID            => @transaction_id,
+        :sessionID        => @session_id,
+        :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
+    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)
+    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?
+    end
+  end
+end

data/lib/maxmind/response.rb

@@ -0,0 +1,70 @@
+module Maxmind
+  class Response  
+    attr_accessor :country_match, :country_code, :high_risk_country, :distance, 
+      :ip_region, :ip_city, :ip_latitude, :ip_longitude, :ip_isp, :ip_org,
+      :anonymous_proxy, :proxy_score, :is_transparent_proxy,
+      :free_mail, :carder_email, :high_risk_username, :high_risk_password,
+      :bin_match, :bin_country, :bin_name_match, :bin_name, :bin_phone_match,
+      :bin_phone, :phone_in_billing_location, :ship_forward, :city_postal_match,
+      :ship_city_postal_match, :score, :explanation, :risk_score, :queries_remaining,
+      :maxmind_id, :error, :response
+  
+    def initialize(response = nil)
+      raise ArgumentError, 'need a valid response string' if response.nil?
+    
+      parse(response)
+    end
+      
+    def parse(response)
+      response.split(';').each do |parameter|
+        k, v = parameter.split('=')
+      
+        case k
+        when 'err'
+          set_attribute('error', v)
+        when 'custPhoneInBillingLoc'
+          set_attribute('phone_in_billing_location', v)
+        when 'maxmindID'
+          set_attribute('maxmind_id', v)
+        when 'isTransProxy'
+          set_attribute('is_transparent_proxy', v)
+        when 'explanation'
+          @explanation = v
+        else
+          set_attribute(k.gsub(/([A-Z])/, '_\1').downcase, v)
+        end
+      end
+    end   
+  
+    alias_method :country_match?, :country_match
+    alias_method :high_risk_country?, :high_risk_country
+    alias_method :anonymous_proxy?, :anonymous_proxy
+    alias_method :is_transparent_proxy?, :is_transparent_proxy
+    alias_method :free_mail?, :free_mail
+    alias_method :carder_email?, :carder_email
+    alias_method :high_risk_username?, :high_risk_username
+    alias_method :high_risk_password?, :high_risk_password
+    alias_method :city_postal_match?, :city_postal_match
+    alias_method :ship_city_postal_match?, :ship_city_postal_match 
+    alias_method :bin_match?, :bin_match
+  
+    protected
+    def set_attribute(k, v)      
+      if v.nil?
+        self.instance_variable_set("@#{k}", nil) 
+        return
+      end
+      
+      v = Integer(v) rescue Float(v) rescue v;
+      
+      case v
+      when /[Yy]es/
+        self.instance_variable_set("@#{k}", true)
+      when /[Nn]o/
+        self.instance_variable_set("@#{k}", false)
+      else
+        self.instance_variable_set("@#{k}", v)
+      end
+    end    
+  end
+end

data/maxmind.gemspec

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+#
+Gem::Specification.new do |s|
+  s.name = %q{maxmind}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Adam Daniels"]
+  s.date = %q{2009-05-16}
+  s.email = %q{adam@mediadrive.ca}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "examples/example.rb",
+     "lib/maxmind.rb",
+     "lib/maxmind/request.rb",
+     "lib/maxmind/response.rb",
+     "maxmind.gemspec",
+     "test/fixtures/response.txt",
+     "test/maxmind_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/adam12/maxmind}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{TODO}
+  s.test_files = [
+    "test/maxmind_test.rb",
+     "test/test_helper.rb",
+     "examples/example.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+  end
+end

data/test/fixtures/response.txt

@@ -0,0 +1 @@
+distance=329;countryMatch=Yes;countryCode=US;freeMail=Yes;anonymousProxy=No;score=7.66;binMatch=Yes;binCountry=US;err=;proxyScore=0.00;ip_region=NY;ip_city=Syracuse;ip_latitude=43.0514;ip_longitude=-76.1495;binName=;ip_isp=Road Runner;ip_org=Road Runner;binNameMatch=Yes;binPhoneMatch=Yes;binPhone=;custPhoneInBillingLoc=No;highRiskCountry=No;queriesRemaining=955;cityPostalMatch=No;shipCityPostalMatch=Yes;maxmindID=9VSOSDE2;isTransProxy=No;carderEmail=No;shipForward=Yes;highRiskUsername=No;highRiskPassword=No;riskScore=2.00;explanation=This order is very high risk, and we suggest you not accept it. This order is considered to be very slightly higher risk because the distance between the billing address and the user's actual location is larger than expected. The order is slightly riskier because the e-mail domain, yahoo.com, is a free e-mail provider. The order is slightly riskier because the phone number supplied by the user is not located within the zip code of the billing address for the credit card. The order is riskier because the shipping address given is a mail forwarding address, so there is no way to know where the products are actually going

data/test/maxmind_test.rb

@@ -0,0 +1,129 @@
+require 'test_helper'
+
+REQUIRED_FIELDS = {
+  :client_ip => '24.24.24.24', 
+  :city => 'New York', 
+  :region => 'NY', 
+  :postal => '11434', 
+  :country => 'US'
+}
+
+RECOMMENDED_FIELDS = {
+  :domain => 'yahoo.com',
+  :bin => '549099',
+  :forwarded_ip => '24.24.24.25',
+  :email => 'test@test.com',
+  :username => 'test_carder_username',
+  :password => 'test_carder_password'
+}
+
+OPTIONAL_FIELDS = {
+  :bin_name => 'MBNA America Bank',
+  :bin_phone => '800-421-2110',
+  :cust_phone => '212-242',
+  :requested_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'
+}
+
+class MaxmindTest < Test::Unit::TestCase
+  context "New Request object" do
+    setup do
+      @request = Maxmind::Request.new('key', REQUIRED_FIELDS)
+    end
+    
+    should "require a key" do
+      lambda { Maxmind::Request.new }.should raise_error(ArgumentError)
+      
+      Maxmind::Request.new('key').license_key.should == 'key'
+    end
+    
+    should "require client IP" do
+      lambda { @request.client_ip = nil; @request.query }.should raise_error(ArgumentError)
+    end
+    
+    should "require city" do
+      lambda { @request.city = nil; @request.query }.should raise_error(ArgumentError)
+    end
+    
+    should "require region" do
+      lambda { @request.region = nil; @request.query }.should raise_error(ArgumentError)
+    end
+    
+    should "require postal" do
+      lambda { @request.postal = nil; @request.query }.should raise_error(ArgumentError)
+    end
+    
+    should "require country" do
+      lambda { @request.country = nil; @request.query }.should raise_error(ArgumentError)
+    end
+    
+    should "convert username to MD5" do
+      @request.username = 'testuser'
+      @request.username.should == '5d9c68c6c50ed3d02a2fcf54f63993b6'
+    end
+    
+    should "convert password to MD5" do
+      @request.password = 'testpassword'
+      @request.password.should == 'e16b2ab8d12314bf4efbd6203906ea6c'
+    end
+    
+    should "convert email to MD5" do
+      @request.email = 'test@test.com'
+      @request.email.should == 'b642b4217b34b1e8d3bd915fc65c4452'
+    end
+  end
+  
+  #context "Requesting" do
+  #  setup do
+  #    request = Maxmind::Request.new('LICENSE_KEY', REQUIRED_FIELDS.merge(RECOMMENDED_FIELDS).merge(OPTIONAL_FIELDS))
+  #    FakeWeb.register_uri(:get, "http://minfraud3.maxmind.com/app/ccv2r?" + request.query(true), :string => File.read(File.join(File.dirname(__FILE__), "fixtures/basic.txt")))
+  #    
+  #    @response = Maxmind::Response.new(request) 
+  #  end
+  #end
+  
+  context "Response" do
+    setup do
+      request = Maxmind::Request.new('LICENSE_KEY', REQUIRED_FIELDS.merge(RECOMMENDED_FIELDS).merge(OPTIONAL_FIELDS))     
+      FakeWeb.register_uri(:get, "http://minfraud3.maxmind.com/app/ccv2r?" + request.query(true), :string => File.read(File.join(File.dirname(__FILE__), "fixtures/response.txt")))
+      
+      @response = Maxmind::Response.new(request.query) 
+    end
+    
+    should "require a response" do
+      lambda { Maxmind::Response.new }.should raise_error(ArgumentError)
+    end
+    
+    should "have a distance" do
+      @response.distance.should == 329
+    end
+    
+    should "have a maxmind ID" do
+      @response.maxmind_id.should == '9VSOSDE2'
+    end
+    
+    should "have a risk score" do
+      @response.risk_score.should == 2.0
+    end
+    
+    should "have a score" do
+      @response.score.should == 7.66
+    end
+    
+    should "have queries remaining" do
+      @response.queries_remaining.should == 955
+    end
+    
+    should "have an explanation" do
+      @response.explanation.should_not be_nil
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'matchy'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'maxmind'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: adam12-maxmind
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Adam Daniels
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: adam@mediadrive.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- examples/example.rb
+- lib/maxmind.rb
+- lib/maxmind/request.rb
+- lib/maxmind/response.rb
+- maxmind.gemspec
+- test/fixtures/response.txt
+- test/maxmind_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/adam12/maxmind
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- test/maxmind_test.rb
+- test/test_helper.rb
+- examples/example.rb