hamburglar 0.1.0

data/lib/hamburglar/config.rb

@@ -0,0 +1,14 @@
+module Hamburglar
+  class Config
+    attr_accessor :gateway
+    attr_accessor :credentials
+    attr_accessor :fraud_score
+    attr_accessor :fraud_proc
+
+    def initialize
+      @gateway     = :min_fraud
+      @credentials = {}
+      @fraud_score = 2.5
+    end
+  end
+end

data/lib/hamburglar/errors.rb

@@ -0,0 +1,26 @@
+module Hamburglar
+  # Raised when trying to assign an invalid gateway to Hamburglar.gateway
+  class InvalidGateway < StandardError
+    def initialize(gateway = nil)
+      msg = "Invalid gateway"
+      msg << ", #{gateway}" if gateway
+      super msg
+    end
+  end
+
+  # Raised when trying to assign an invalid gateway URL
+  class InvalidURL < StandardError
+    def initialize(url = nil)
+      msg = "Invalid url"
+      msg << ", #{url}" if url
+      super msg
+    end
+  end
+
+  # Raised if Hamburglar::Gateways::Base.validate! fails
+  class InvalidRequest < StandardError
+    def initialize(msg = nil)
+      super "Invalid request"
+    end
+  end
+end

data/lib/hamburglar/gateways/base.rb

@@ -0,0 +1,152 @@
+require 'net/https'
+require 'cgi'
+
+module Hamburglar
+  module Gateways
+    # Hamburglar::Gateways::Base is the main class that handles sending API
+    # requests to upstream providers. All other gateways should inherit from
+    # this class
+    class Base
+
+      URL_REGEX = /https?:\/\/[\S]+/
+
+      # The parameters for the API request
+      attr_reader :params
+
+      # Errors returned when validating or submitting a request
+      attr_reader :errors
+
+      # Response returned by an API call
+      attr_reader :response
+
+      class << self
+        # The API URL
+        attr_reader :api_url
+      end
+
+      def initialize(params = {})
+        defaults  = (Hamburglar.config.credentials || {}).select do |key, val|
+          optional_params.include? key
+        end
+        @params   = Hash[defaults].merge(params)
+        @errors   = {}
+        @response = {}
+      end
+
+      # Get or set the API URL for the gateway
+      def self.set_api_url(url = '')
+        if url.match URL_REGEX
+          @api_url = url
+        else
+          raise Hamburglar::InvalidURL, url
+        end
+      end
+
+      # Set required parameters for an API call
+      def self.set_required_params(*params)
+        @required_params = params
+      end
+
+      # Required parameters for an API call
+      def self.required_params
+        @required_params || []
+      end
+
+      # Validate presence of required_params
+      #
+      # Returns false if a parameter isn't set
+      def validate(revalidate = false)
+        @validated = false if revalidate
+        unless @validated
+          @errors[:missing_parameters] = []
+          self.class.required_params.each do |req|
+            unless @params.has_key?(req)
+              @errors[:missing_parameters] << req
+            end
+          end
+          @validated = true
+        end
+        @errors[:missing_parameters].empty?
+      end
+      alias_method :valid?, :validate
+
+      # Validate presence of required_params
+      #
+      # Raises Hamburglar::InvalidRequest if validation fails
+      def validate!
+        validate || raise(Hamburglar::InvalidRequest)
+      end
+
+      # Submit a request upstream to generate a fraud report
+      def submit
+        return false unless valid?
+        url = "#{self.class.api_url}?#{query_string}"
+        if res = fetch(url)
+          @response = parse_response(res.body)
+        end
+      end
+
+      # Optional parameters that *may* be present in a query
+      #
+      # This method should be overridden by classes than inherit from
+      # Hamburglar::Gateways::Base
+      #
+      # Defaults to self.required_params
+      def optional_params
+        self.class.required_params
+      end
+
+      private
+
+      # Formats @params into a query string for an HTTP GET request
+      def query_string
+        @params.map { |key, val| "#{key}=#{CGI.escape(val.to_s)}" }.join('&')
+      end
+
+      # Parses raw data returned from an API call
+      #
+      # This method should be overwritten by any API subclasses that
+      # return data in a different format
+      #
+      # Returns [Hash]
+      def parse_response(raw = '')
+        data = raw.to_s.split(';').map do |line|
+          key, val = line.split('=')
+          if key.to_s != "" && val.to_s != ""
+            [key.to_sym, val]
+          else
+            next
+          end
+        end
+        Hash[data]
+      end
+
+      # Performs a GET request on the given URI, redirects if needed
+      #
+      # See Following Redirection at
+      # http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/classes/Net/HTTP.html
+      def fetch(uri_str, limit = 10)
+        # You should choose better exception.
+        raise ArgumentError, 'HTTP redirect too deep' if limit == 0
+
+        uri = URI.parse(uri_str)
+        http = Net::HTTP.new(uri.host, uri.port)
+        if uri.scheme == 'https'
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          http.ca_file = File.expand_path('../../../cacert.pem', __FILE__)
+        end
+        request = Net::HTTP::Get.new(uri.request_uri)
+        response = http.start { |http| http.request(request) }
+
+        case response
+        when Net::HTTPSuccess     then response
+        when Net::HTTPRedirection then fetch(response['location'], limit - 1)
+        else
+          response.error!
+        end
+      end
+
+    end
+  end
+end

data/lib/hamburglar/gateways/max_mind.rb

@@ -0,0 +1,68 @@
+module Hamburglar
+  module Gateways
+    # The MaxMind module contains classes for working
+    # with MaxMind's minFraud and Telephone Verification APIs
+    module MaxMind
+      # The MinFraud class handles fraud verification
+      # through MaxMind's minFraud API.
+      #
+      # See: http://www.maxmind.com/app/ccv
+      class MinFraud < Base
+        # The MaxMind API URL
+        set_api_url "https://minfraud2.maxmind.com/app/ccv2r"
+
+        # Required parameters for a minFraud API call
+        set_required_params :i, :city, :region, :postal, :country, :license_key
+
+        # Optional parameters
+        def optional_params
+          [
+            :i,
+            :city,
+            :region,
+            :postal,
+            :country,
+            :license_key,
+            :domain,
+            :bin,
+            :binName,
+            :binPhone,
+            :custPhone,
+            :requested_type,
+            :forwardedIP,
+            :emailMD5,
+            :usernameMD5,
+            :passwordMD5,
+            :shipAddr,
+            :shipCity,
+            :shipRegion,
+            :shipPostal,
+            :shipCountry,
+            :textID,
+            :sessionID,
+            :user_agent,
+            :accept_language
+          ].freeze
+        end
+      end
+
+      # The TelephoneVerification class handles fraud verification
+      # through MaxMind's Telephone Verification API
+      #
+      # See: http://www.maxmind.com/app/telephone_api
+      class TelephoneVerification < Base
+        # The MaxMind Telephone Verification API URL
+        set_api_url "https://www.maxmind.com/app/telephone_http"
+
+        # Required parameters for a Telephone Verification API call
+        set_required_params :l, :phone
+
+        # Optional parameters
+        def optional_params
+          [:l, :phone, :verify_code].freeze
+        end
+      end
+
+    end
+  end
+end

data/lib/hamburglar/gateways.rb

@@ -0,0 +1,6 @@
+module Hamburglar
+  module Gateways
+    autoload :Base,    'hamburglar/gateways/base'
+    autoload :MaxMind, 'hamburglar/gateways/max_mind'
+  end
+end

data/lib/hamburglar/report.rb

@@ -0,0 +1,61 @@
+module Hamburglar
+  # Hamburglar::Report is the main class for generating fraud reports
+  class Report
+    # Parameters that will be used to generate this fraud report
+    attr_reader :params
+
+    # Response from gateway
+    attr_reader :response
+
+    def initialize(params = {})
+      @gateway  = params.delete(:gateway) || Hamburglar.config.gateway
+      @params   = params
+      @response = generate_report!
+    end
+
+    def method_missing(method, *args, &block)
+      if @response && @response[method.to_sym]
+        @response[method.to_sym]
+      else
+        super
+      end
+    end
+
+    def respond_to?(key)
+      @response.has_key?(key) || super
+    end
+
+    def fraud?
+      @fraud = true if @response.nil? || @response.empty?
+      return @fraud if @fraud
+      if Hamburglar.config.fraud_proc.nil?
+        @fraud = @response[:score].to_f >= Hamburglar.config.fraud_score.to_f
+      else
+        @fraud = Hamburglar.config.fraud_proc.call(self) == true
+      end
+    end
+
+  private
+
+    def generate_report!
+      api = gateway.new(@params)
+      if api.valid?
+        api.submit
+      else
+        api.errors
+      end
+    end
+
+    def gateway
+      case @gateway.to_s
+      when /min_fraud/
+        Gateways::MaxMind::MinFraud
+      when /telephone/
+        Gateways::MaxMind::TelephoneVerification
+      else
+        raise Hamburglar::InvalidGateway, @gateway
+      end
+    end
+
+  end
+end

data/lib/hamburglar/version.rb

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

data/lib/hamburglar.rb

@@ -0,0 +1,19 @@
+require 'hamburglar/errors'
+
+module Hamburglar
+  autoload :Version,  'hamburglar/version'
+  autoload :Config,   'hamburglar/config'
+  autoload :Report,   'hamburglar/report'
+  autoload :Gateways, 'hamburglar/gateways'
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    yield config if block_given?
+    config
+  end
+
+  self.config = Config.new
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: hamburglar
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Joshua Priddle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-03 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !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 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !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 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.10"
+  type: :development
+  version_requirements: *id004
+description: Hamburglar helps you prevent fraudulent orders
+email: jpriddle@site5.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+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/report.rb
+- lib/hamburglar/version.rb
+- lib/hamburglar.rb
+has_rdoc: true
+homepage: https://github.com/site5/hamburglar
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Hamburglar helps you prevent fraudulent orders
+test_files: []
+