hamburglar 0.1.0 → 0.1.1

data/README.markdown

@@ -1,10 +1,12 @@
-# Hamburglar
-
-[![Build Status](http://travis-ci.org/site5/hamburglar.png)](http://travis-ci.org/site5/hamburglar)
+# Hamburglar [![Hamburglar Build Status][Build Icon]][Build Status]
 
 Hamburglar helps you prevent fraudulent orders.
 
-Confirmed to work with ruby 1.8.7, 1.9.2, Rubinus, and JRuby 1.6.2.
+Hamburglar has been tested on MRI 1.8.7, MRI 1.9.2, MRI 1.9.3 Preview 1,
+Rubinius 2.0.0pre, and JRuby 1.6.2.
+
+[Build Icon]: https://secure.travis-ci.org/site5/hamburglar.png?branch=master
+[Build Status]: http://travis-ci.org/site5/hamburglar
 
 ## Prerequisites
 
@@ -49,7 +51,7 @@ By default, reports will use the minFraud API.
 
     report = Hamburglar::Report.new(
       :license_key   => 's3cr3tz',
-      :i             => '192.168.1.1',
+      :ip            => '192.168.1.1',
       :city          => 'Funland',
       :region        => 'US',
       :postal        => '12345',
@@ -64,9 +66,9 @@ By default, reports will use the minFraud API.
 **Generate a fraud report using Telephone Verification**
 
     report = Hamburglar::Report.new(
-      :gateway => :max_mind_telephone,
-      :l       => 's3cr3tz',
-      :phone   => '+18004445555'
+      :gateway     => :max_mind_telephone,
+      :license_key => 's3cr3tz',
+      :phone       => '+18004445555'
     )
 
 ## Optional Configuration

data/lib/hamburglar.rb

@@ -10,6 +10,12 @@ module Hamburglar
     attr_accessor :config
   end
 
+  # Set Hamburglar.config
+  #
+  # Example:
+  #   Hamburglar.configure do |config|
+  #     config.fraud_score = 10
+  #   end
   def self.configure
     yield config if block_given?
     config

data/lib/hamburglar/config.rb

@@ -1,10 +1,56 @@
 module Hamburglar
+  # The Hamburglar::Config class stores configuration variables used to generate
+  # fraud reports.
   class Config
+    # The gateway used when generating fraud reports via
+    # `Hamburglar::Report.new`.
+    #
+    # Example:
+    #   # Set gateway
+    #   config.gateway = :min_fraud
+    #
+    #   # Get gateway
+    #   config.gateway
     attr_accessor :gateway
+
+    # Credentials that should be used when communicating with
+    # upstream APIs.
+    #
+    # This should be a Hash. When a query is sent to a Gateway, this Hash
+    # will be merged in **if** it's keys exist in Gateway#optional_params
+    #
+    # Example:
+    #   # Set credentials:
+    #   config.credentials = { :license_key => 's3cretz' }
+    #
+    #   # Get credentials
+    #   config.credentials
     attr_accessor :credentials
+
+    # The score that should be considered fraud. This score will be
+    # checked when `Hamburglar::Report#fraud?` is called, unless
+    # `config.fraud_proc` is set
+    #
+    # Example:
+    #   # Set fraud score
+    #   config.fraud_score = 5
+    #
+    #   # Get fraud score
+    #   config.fraud_score
     attr_accessor :fraud_score
+
+    # An optional Proc that will be used to evaluate
+    # `Hamburglar::Report#fraud?` if set
+    #
+    # Example:
+    #   # Set proc
+    #   config.fraud_proc = lambda { |report| report.distance > 500 }
+    #
+    #   # Get proc
+    #   config.fraud_proc
     attr_accessor :fraud_proc
 
+    # Create a new Config instance and set some defaults
     def initialize
       @gateway     = :min_fraud
       @credentials = {}

data/lib/hamburglar/gateways.rb

@@ -1,4 +1,6 @@
 module Hamburglar
+  # The Hamburglar::Gateways module contains classes used to generate fraud
+  # reports
   module Gateways
     autoload :Base,    'hamburglar/gateways/base'
     autoload :MaxMind, 'hamburglar/gateways/max_mind'

data/lib/hamburglar/gateways/base.rb

@@ -8,6 +8,8 @@ module Hamburglar
     # this class
     class Base
 
+      # A regex for matching URLs with http or https
+      # This will be used to verify API urls
       URL_REGEX = /https?:\/\/[\S]+/
 
       # The parameters for the API request

data/lib/hamburglar/gateways/max_mind.rb

@@ -44,6 +44,11 @@ module Hamburglar
             :accept_language
           ].freeze
         end
+
+        def initialize(params = {})
+          params[:i] = params.delete(:ip) if params[:ip]
+          super params
+        end
       end
 
       # The TelephoneVerification class handles fraud verification
@@ -61,6 +66,11 @@ module Hamburglar
         def optional_params
           [:l, :phone, :verify_code].freeze
         end
+
+        def initialize(params = {})
+          params[:l] = params.delete(:license_key) if params[:license_key]
+          super params
+        end
       end
 
     end

data/lib/hamburglar/version.rb

@@ -1,3 +1,3 @@
 module Hamburglar
-  VERSION = Version = '0.1.0'
+  VERSION = Version = '0.1.1'
 end

metadata

@@ -1,109 +1,107 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hamburglar
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.1
   prerelease: 
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Joshua Priddle
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-03 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &21584760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.6'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *21584760
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &21584260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.8.7
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: fakeweb
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *21584260
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &21583660 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: vcr
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *21583660
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &21583080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.10"
+      - !ruby/object:Gem::Version
+        version: '1.10'
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *21583080
 description: Hamburglar helps you prevent fraudulent orders
 email: jpriddle@site5.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
-files: 
+files:
 - Rakefile
 - README.markdown
-- lib/cacert.pem
 - lib/hamburglar/config.rb
-- lib/hamburglar/errors.rb
-- lib/hamburglar/gateways/base.rb
-- lib/hamburglar/gateways/max_mind.rb
 - lib/hamburglar/gateways.rb
+- lib/hamburglar/errors.rb
 - lib/hamburglar/report.rb
 - lib/hamburglar/version.rb
+- lib/hamburglar/gateways/max_mind.rb
+- lib/hamburglar/gateways/base.rb
 - lib/hamburglar.rb
-has_rdoc: true
+- lib/cacert.pem
 homepage: https://github.com/site5/hamburglar
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2236720283326898591
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2236720283326898591
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Hamburglar helps you prevent fraudulent orders
 test_files: []
-