experian 0.1.0

data/lib/experian/connect_check/response.rb

@@ -0,0 +1,103 @@
+module Experian
+  module ConnectCheck
+    class Response < Experian::Response
+
+      def input_type
+        return unless connect_check_segment
+        connect_check_segment[7]
+      end
+
+      def credit_match_code
+        return unless connect_check_segment
+        connect_check_segment[8]
+      end
+
+      def credit_match_code_message
+        MATCH_CODES[credit_match_code]
+      end
+
+      def credit_class_code
+        return unless connect_check_segment
+        connect_check_segment[10]
+      end
+
+      def credit_score
+        return unless risk_score_segment
+        risk_score_segment[7..10].to_i
+      end
+
+      def high_risk_address_alert
+        return unless connect_check_segment
+        connect_check_segment[11]
+      end
+
+      def credit_fraud_code
+        case statement_type_code
+        when 25 then 'X' # file frozen due to state legislation
+        when 26..31 then 'Y' # active credit alerts
+        else 'Z' # assume no fraud
+        end if success?
+      end
+
+      def statement_type_code
+        return unless consumer_statement_segment
+        consumer_statement_segment[7..8].to_i
+      end
+
+      def customer_name_length
+        return unless connect_check_segment
+        connect_check_segment[23..25].to_i
+      end
+
+      def customer_name
+        return unless connect_check_segment
+        connect_check_segment[25, customer_name_length]
+      end
+
+      def customer_names
+        segments(335).map do |segment|
+          segment[9, segment[7..8].to_i]
+        end
+      end
+
+      def customer_addresses
+        segments(336).map do |segment|
+          segment[36, segment[34..35].to_i]
+        end
+      end
+
+      def customer_message_length
+        return unless connect_check_segment
+        connect_check_segment[25 + customer_name_length, 2].to_i
+      end
+
+      def customer_message
+        return unless connect_check_segment
+        connect_check_segment[25 + customer_name_length + 2, customer_message_length]
+      end
+
+      def success?
+        super && !header_segment.nil?
+      end
+
+      private
+
+      def consumer_statement_segment
+        segment(365)
+      end
+
+      def connect_check_segment
+        segment(111)
+      end
+
+      def risk_score_segment
+        segment(125)
+      end
+
+      def header_segment
+        segment(110)
+      end
+
+    end
+  end
+end

data/lib/experian/constants.rb

@@ -0,0 +1,41 @@
+module Experian
+  module Constants
+
+    LOOKUP_SERVLET_URL = "http://www.experian.com/lookupServlet1"
+    ECALS_TIMEOUT = 86400 # 24 hours in seconds
+
+    LOOKUP_SERVICE_NAME = "AccessPoint"
+    LOOKUP_SERVICE_VERSION = 1.0
+
+    SERVICE_NAME = "NetConnect"
+    SERVICE_NAME_TEST = "NetConnectDemo"
+
+    SERVICE_VERSION = 2.0
+
+    ARF_VERSION = "06"
+
+    XML_NAMESPACE = "http://www.experian.com/NetConnect"
+    XML_SCHEMA_INSTANCE = "http://www.w3.org/2001/XMLSchema-instance"
+    XML_SCHEMA_LOCATION = "http://www.experian.com/NetConnect NetConnect.xsd"
+    XML_REQUEST_NAMESPACE = "http://www.experian.com/WebDelivery"
+
+    COMPLETION_CODES = {
+      "0000" => "Request processed successfully",
+      "1000" => "Invalid request format",
+      "1001" => "Invalid length",
+      "1002" => "Invalid length",
+      "1003" => "No XML request",
+      "1004" => "Invalid request parameter",
+      "2000" => "Authorization failure",
+      "4000" => "System error. Call Experian Technical Support at 1-800-854-7201."
+    }
+
+    ERROR_ACTION_INDICATORS = {
+      "I" => "Informative",
+      "C" => "Correct and/or resubmit",
+      "R" => "Report condition or database problem",
+      "S" => "Suspend"
+    }
+
+  end
+end

data/lib/experian/error.rb

@@ -0,0 +1,22 @@
+module Experian
+  class Error < StandardError
+
+    def self.message(code)
+      "Experian: " + (codes[code] || "Error Code #{code}")
+    end
+
+    # Experian has hundreds of codes documented, only populated small set
+    def self.codes
+      {
+        1 => "System temporarily unavailable. Please resubmit",
+        53 => "Invalid social security number"
+      }
+    end
+  end
+
+  class ClientError < Error; end
+  class ArgumentError < ClientError; end
+  class Forbidden < ClientError; end
+  class ServerError < Error; end
+
+end

data/lib/experian/request.rb

@@ -0,0 +1,23 @@
+module Experian
+  class Request
+
+    attr_reader :xml
+
+    def initialize(options = {})
+      @options = options
+      @xml = build_request
+    end
+
+    def build_request
+      xml = Builder::XmlMarkup.new(:indent => 2)
+      xml.instruct!(:xml, :version => '1.0', :encoding => 'utf-8')
+      xml.tag!("NetConnectRequest",
+        :xmlns => Experian::XML_NAMESPACE,
+        'xmlns:xsi' => Experian::XML_SCHEMA_INSTANCE,
+        'xsi:schemaLocation' => Experian::XML_SCHEMA_LOCATION) do
+          yield xml if block_given?
+      end
+    end
+
+  end
+end

data/lib/experian/response.rb

@@ -0,0 +1,118 @@
+require 'rexml/document'
+
+module Experian
+  class Response
+
+      attr_reader :xml
+
+      def initialize(xml)
+        @xml = xml
+        @response = parse_xml_response
+      end
+
+      def error_message
+        @response["ErrorMessage"] || (Experian::Error.message(error_code) if error_code)
+      end
+
+      def host_response
+        @response["HostResponse"]
+      end
+
+      def completion_code
+        @response["CompletionCode"]
+      end
+
+      def completion_message
+        Experian::COMPLETION_CODES[completion_code]
+      end
+
+      def transaction_id
+        @response["TransactionId"]
+      end
+
+      def segments(segment_id = nil)
+        @segments ||= host_response ? host_response.split("@") : []
+
+        if segment_id
+          @segments.select { |segment| segment.length >= 3 ? segment[0..2].to_i == segment_id : false }
+        else
+          @segments
+        end
+      end
+
+      def segment(segment_id)
+        segments(segment_id).first
+      end
+
+      def success?
+        completion_code == "0000"
+      end
+
+      def error?
+        completion_code != "0000" || !error_segment.nil?
+      end
+
+      # error_segment returns the entire host response (segments 100, 200, 900)
+      # since error responses do not separate segments with "@".
+      def error_segment
+        segment(100)
+      end
+
+      # The error message segment is embedded in the error segment :(
+      def error_message_segment
+        return unless error_segment
+        error_segment[error_segment.index("200")..-1]
+      end
+
+      def error_code
+        return unless error_segment
+        error_message_segment[6..8].to_i
+      end
+
+      def error_action_indicator
+        return unless error_segment
+        error_message_segment[9]
+      end
+
+      def error_action_indicator_message
+        Experian::ERROR_ACTION_INDICATORS[error_action_indicator]
+      end
+
+      private
+
+      def parse_xml_response
+        xml = REXML::Document.new(@xml)
+        root = REXML::XPath.first(xml, "//NetConnectResponse")
+        if root
+          parse_element(root)
+        else
+          raise Experian::ClientError, "Invalid xml response from Experian"
+        end
+      end
+
+      # parse xml node elements recursively into hash
+      def parse_element(node)
+        if node.has_elements?
+          response = {}
+          node.elements.each do |e|
+            key = e.name
+            value = parse_element(e)
+            if response.has_key?(key)
+              if response[key].is_a?(Array)
+                response[key].push(value)
+              else
+                response[key] = [response[key], value]
+              end
+            else
+              response[key] = parse_element(e)
+            end
+          end
+        else
+          response = node.text
+        end
+        response
+      end
+
+  end
+end
+

data/lib/experian/version.rb

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

data/test/client_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+describe Experian::Client do
+
+  before do
+    stub_experian_uri_lookup
+    @client = Experian::Client.new
+    @client.stubs(:request).returns(stub(xml: "fake xml content"))
+  end
+
+  it "should submit the request and return the response body" do
+    Excon::Connection.any_instance.expects(:post).returns(stub(body: "fake body content", headers: {}))
+    assert_equal "fake body content", @client.submit_request
+  end
+
+  it "should set the correct content type header" do
+    assert_equal "application/x-www-form-urlencoded", @client.request_headers["Content-Type"]
+  end
+
+  it "should set the body to the url encoded request xml" do
+    assert_equal "NETCONNECT_TRANSACTION=fake+xml+content", @client.request_body
+  end
+
+  it "should raise a forbidden exception if logon location header returned" do
+    Excon::Connection.any_instance.expects(:post).returns(stub(headers: { "Location" => "sso_logon" }))
+    assert_raises(Experian::Forbidden) do
+      @client.submit_request
+    end
+  end
+
+end

data/test/connect_check/client_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+describe Experian::ConnectCheck::Client do
+
+  before do
+    @client = Experian::ConnectCheck::Client.new
+  end
+
+  it "should perform a credit check" do
+    stub_experian_request("connect_check", "response.xml")
+    assert_kind_of Experian::ConnectCheck::Response,
+      @client.check_credit(first_name: "Homer", last_name: "Simpson", ssn: "123456789")
+  end
+
+  it "should raise an ArgumentError if passed bad arguments" do
+    assert_raises(Experian::ArgumentError) do
+      @client.assert_check_credit_options({})
+    end
+  end
+
+end

data/test/connect_check/request_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+describe Experian::ConnectCheck::Request do
+
+  it "creates a request in xml format" do
+    request = Experian::ConnectCheck::Request.new(
+      first_name: 'Homer',
+      last_name: 'Simpson',
+      ssn: '123456789',
+      reference_id: 'fakeReferenceId',
+      street: '10655 NorthBirch Street',
+      city: 'Springfield',
+      state: 'IL',
+      zip: '60611',
+      yob: '1951',
+      reference_number: '00234',
+      end_user: 'homer'
+    )
+
+    assert_equal request.xml, fixture("connect_check", "request.xml")
+  end
+
+end

data/test/connect_check/response_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+describe Experian::ConnectCheck::Response do
+
+  describe "successful response" do
+    before do
+      stub_experian_request("connect_check", "response.xml")
+      @response = Experian::ConnectCheck.check_credit(first_name: "Homer", last_name: "Simpson", ssn: "123456789")
+    end
+
+    it "receives a successful response" do
+      assert @response.success?
+      refute @response.error?
+    end
+
+    it "extracts the credit match code" do
+      assert_equal "C", @response.credit_match_code
+    end
+
+    it "maps the credit match code message" do
+      assert_equal "ID Match", @response.credit_match_code_message
+    end
+
+    it "extracts the credit class code" do
+      assert_equal "3", @response.credit_class_code
+    end
+
+    it "extracts the credit score" do
+      assert_equal 603, @response.credit_score
+    end
+
+    it "extracts the high risk address alert" do
+      assert_equal "X", @response.high_risk_address_alert
+    end
+
+    it "extracts the credit fraud code" do
+      assert_equal "Z", @response.credit_fraud_code
+    end
+
+    it "extracts the input type" do
+      assert_equal "S", @response.input_type
+    end
+
+    it "extracts the customer name" do
+      assert_equal "AMBLE,ROBERT", @response.customer_name
+    end
+
+    it "extracts the customer message" do
+      assert_equal "Fraud alert on account. Deposit required to complete enrollment.", @response.customer_message
+    end
+
+    it "extracts the statement type code" do
+      assert_equal 6, @response.statement_type_code
+      @response.customer_names
+    end
+
+    it "extracts the customer name aliases" do
+      assert_includes @response.customer_names, "ROBERT K AMBLE"
+    end
+
+    it "extracts the customer addresses" do
+      assert_includes @response.customer_addresses, "6717 11TH AVE  /BROOKLYN NY 112195904"
+    end
+  end
+
+  describe "error response" do
+    before do
+      stub_experian_request("connect_check", "response_error_legacy.xml")
+      @response = Experian::ConnectCheck.check_credit(first_name: "Homer", last_name: "Simpson", ssn: "123456789")
+    end
+
+    it "receives an error response" do
+      refute @response.success?
+      assert @response.error?
+    end
+
+    it "extracts the error code" do
+      assert_equal 45, @response.error_code
+    end
+
+    it "extracts the error action indicator" do
+      assert_equal "C", @response.error_action_indicator
+    end
+
+    it "translates the error action indicator message" do
+      assert_equal "Correct and/or resubmit", @response.error_action_indicator_message
+    end
+
+    it "maps an error message based on code" do
+      assert_equal "Experian: Error Code 45", @response.error_message
+    end
+  end
+
+end