callcredit 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 240b5ca3357002fdecfe94ff1b75791f1b26e987
+  data.tar.gz: c1f970fec32aa70def4515a9b8e8e6ae81748289
+SHA512:
+  metadata.gz: b653cfdaa53a961b7c1316af1f07446fb2ba9dcdfa69f73a646a33b542d8782ca06300aee0522c8dca720573659fb42da8a5a88050bf8a6b3e12b539b04c1941
+  data.tar.gz: 1573d606cd8d7128dc861427614e0758724adec9e1ace6b18a02eedc53633a99f39bab9af1578f60bf1bf830656f72f2cb727dd30b932b10547a4b83f77bbeea

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+.bundle

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+## 0.2.1 - February 10, 2014
+
+- Wrap responses in a Response object. Make config accessible from the client
+
+## 0.2.1 - February 9, 2014
+
+- Support Date, Time, and Datetime instances for `date_of_birth` param
+
+## 0.2.0 - February 7, 2014
+
+- Major refactor to make setup and use more explicit
+- Moved error checking to middleware
+- Fixed error handling for multiple errors
+
+## 0.1.1 - February 6, 2014
+
+- Added `id_enhanced_check` method to `Client`
+
+## 0.1.0 - February 6, 2014
+
+- Implemented `check` method on `Request` module to allow ID checks
+- Added readme
+
+## 0.0.1 - February 5, 2014
+
+- Initial commit

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Grey Baker
+
+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.md

@@ -0,0 +1,67 @@
+# Callcredit Ruby Client Library
+
+Simple Ruby Gem for interacting with Callcredit's CallValidate API. Wraps the
+XML submissions and responses required so you can deal with Ruby hashes
+instead.
+
+## Usage
+
+### Initialising the gem
+Requires your Callcredit credentials. If you don't have any, you'll need to
+call the sales team at [Callcredit](https://callcredit.co.uk).
+
+```ruby
+Callcredit.configure do |config|
+  config[:company]          = YOUR_COMPANY_NAME
+  config[:username]         = YOUR_USERNAME
+  config[:password]         = YOUR_PASSWORD
+  config[:application_name] = YOUR_APPLICATION_NAME
+  config[:api_endpoint]     = YOUR_API_ENDPOINT
+end
+```
+
+### Performing checks
+
+#### Standard AML checks
+To perform an IDEnhanced check (the standard AML check) use:
+
+```ruby
+Callcredit.id_enhanced_check(first_name: "Grey", last_name: "Baker")
+```
+
+The library will raise an error if you're missing any of the required
+parameters (first_name, last_name, date_of_birth, building_number and
+postcode).
+
+#### Other checks
+For any other check, simply pass the name of the check you'd like to perform
+into the `perform_check` method, along with details of the individual you're
+checking. Note that the gem **won't** validate your inputs for these checks.
+
+```ruby
+data_hash = { personal_data: { first_name: "Grey", last_name: "Baker" } }
+Callcredit.perform_check(:id_enhanced, data_hash)
+```
+
+If you'd like to perform multiple checks at once you can pass an array of
+checks.
+
+```ruby
+data_hash = { personal_data: { first_name: "Grey", last_name: "Baker" } }
+Callcredit.perform_check([:id_enhanced, :credit_score], data_hash)
+```
+
+NOTE: Currently, this gem only supports checks on the payer's personal
+information (other information won't be passed through to Callsredit).
+Extending the gem should be trivial if Callcredit have given you access to
+other checks.
+
+### Parsing responses
+
+By default the body of Callcredit's response is parsed and returned as a hash.
+Set the "raw" argument to true if you need the full, unprocessed response
+(including headers, etc.).
+
+```ruby
+Callcredit.config[:raw] = true
+```

data/callcredit.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/callcredit/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_runtime_dependency 'faraday'
+  gem.add_runtime_dependency 'faraday_middleware'
+  gem.add_runtime_dependency 'multi_xml'
+  gem.add_runtime_dependency 'nokogiri'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+
+  gem.authors = ['Grey Baker']
+  gem.description = %q{Ruby wrapper for Callcredit's CallValidate API}
+  gem.email = ['grey@gocardless.com']
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'https://github.com/gocardless/callcredit-ruby'
+  gem.name = 'callcredit'
+  gem.require_paths = ['lib']
+  gem.summary = %q{Ruby wrapper for Callcredit's CallValidate API}
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.version = Callcredit::VERSION.dup
+end

data/lib/callcredit.rb

@@ -0,0 +1,50 @@
+require 'faraday_middleware'
+require 'nokogiri'
+
+require 'callcredit/version'
+require 'callcredit/util'
+require 'callcredit/config'
+require 'callcredit/request'
+require 'callcredit/constants'
+require 'callcredit/client'
+require 'callcredit/response'
+require 'callcredit/checks/id_enhanced'
+require 'callcredit/middleware/check_response'
+
+# Errors
+require 'callcredit/errors/callcredit_error'
+require 'callcredit/errors/api_error'
+require 'callcredit/errors/authentication_error'
+require 'callcredit/errors/invalid_request_error'
+
+module Callcredit
+  def self.configure(&block)
+    @config = Config.new(&block)
+  end
+
+  def self.id_enhanced_check(*args)
+    client.id_enhanced_check(*args)
+  end
+
+  def self.perform_check(*args)
+    client.perform_check(*args)
+  end
+
+  # Require configuration before use
+  def self.config
+    if @config
+      @config
+    else
+      msg = "No config found. Use Callcredit.configure to set username, " +
+            "password, company and application name. See " +
+            "https://github.com/gocardless/callcredit for details."
+      raise CallcreditError.new(msg)
+    end
+  end
+
+  def self.client
+    @client ||= Client.new(config)
+  end
+  private_class_method :client
+end
+

data/lib/callcredit/checks/id_enhanced.rb

@@ -0,0 +1,34 @@
+module Callcredit
+  module Checks
+    class IDEnhanced
+      REQUIRED_INPUTS = [:date_of_birth, :first_name, :last_name, :postcode]
+
+      def initialize(client)
+        @client = client
+      end
+
+      def perform(data = {})
+        check_params(data)
+        response = @client.perform_check(:id_enhanced, personal_data: data)
+        @client.config[:raw] ? response : Response.new(response)
+      end
+
+      private
+
+      def check_params(data)
+        REQUIRED_INPUTS.each do |param|
+          if data[param].nil?
+            msg = "An IDEnhanced check requires a #{param}"
+            raise InvalidRequestError.new(msg, param)
+          end
+        end
+
+        # For and ID Enhanced check, we also need a building name or number
+        unless data[:building_number] || data[:building_name]
+          msg = "An IDEnhanced check requires a building number or name"
+          raise InvalidRequestError.new(msg, :building_number)
+        end
+      end
+    end
+  end
+end

data/lib/callcredit/client.rb

@@ -0,0 +1,42 @@
+module Callcredit
+  class Client
+    def initialize(config=nil)
+      @config = (config || Callcredit.config).clone
+    end
+
+    def id_enhanced_check(check_data)
+      check = Checks::IDEnhanced.new(self)
+      check.perform(check_data)
+    end
+
+    def perform_check(check_types, check_data)
+      request = Request.new(connection, @config)
+      request.perform(check_types, check_data)
+    end
+
+    def config
+      @config
+    end
+
+    private
+
+    def connection
+      options = {
+        ssl: { verify: false },
+        url: @config[:api_endpoint],
+        headers: {
+          'Accept' => "application/xml",
+          'User-Agent' => @config[:user_agent]
+        }
+      }
+
+      Faraday.new(options) do |conn|
+        conn.response :check_response unless @config[:raw]  # Check XML
+        conn.response :xml  unless @config[:raw]            # Parse response
+        conn.response :follow_redirects, limit: 3           # Follow redirect
+        conn.response :raise_error                          # Raise errors
+        conn.adapter @config[:adapter]
+      end
+    end
+  end
+end

data/lib/callcredit/config.rb

@@ -0,0 +1,32 @@
+module Callcredit
+  class Config
+    DEFAULT_OPTIONS = {
+      adapter:          Faraday.default_adapter,
+      company:          nil,
+      username:         nil,
+      password:         nil,
+      application_name: nil,
+      raw:              false,
+      api_endpoint:     "https://ct.callcreditsecure.co.uk/callvalidateapi/incomingserver.php",
+      user_agent:       "Callcredit Ruby Gem #{Callcredit::VERSION}".freeze
+    }.freeze
+
+    def initialize
+      @config = {}
+      yield self if block_given?
+    end
+
+    def [](name)
+      @config.fetch(name, DEFAULT_OPTIONS[name])
+    end
+
+    def []=(name, val)
+      @config[name] = val
+    end
+
+    def clone
+      Config.new { |config| @config.each { |k,v| config[k] = v } }
+    end
+  end
+end
+

data/lib/callcredit/constants.rb

@@ -0,0 +1,9 @@
+module Callcredit
+  module Constants
+    # Check types suported by the CallValidate API
+    CHECKS = %w(BankStandard BankEnhanced CardLive CardEnhanced IDEnhanced
+                NCOAAlert CallValidate3D TheAffordabilityReport DeliveryFraud
+                EmailValidate CreditScore Zodiac IPAddress BankAccountPlus
+                BankOFA CardOFA)
+  end
+end

data/lib/callcredit/errors/api_error.rb

@@ -0,0 +1,4 @@
+module Callcredit
+  class APIError < CallcreditError
+  end
+end

data/lib/callcredit/errors/authentication_error.rb

@@ -0,0 +1,4 @@
+module Callcredit
+  class AuthenticationError < CallcreditError
+  end
+end

data/lib/callcredit/errors/callcredit_error.rb

@@ -0,0 +1,18 @@
+module Callcredit
+  class CallcreditError < StandardError
+    attr_reader :message
+    attr_reader :status
+    attr_reader :response_body
+
+    def initialize(message=nil, status=nil, response=nil)
+      @message = message
+      @status = status
+      @response_body = response_body
+    end
+
+    def to_s
+      status_string = @status.nil? ? "" : "(Status #{@status}) "
+      "#{status_string}#{@message}"
+    end
+  end
+end

data/lib/callcredit/errors/invalid_request_error.rb

@@ -0,0 +1,10 @@
+module Callcredit
+  class InvalidRequestError < CallcreditError
+    attr_accessor :param
+
+    def initialize(message, param, status=nil, response_body=nil)
+      super(message, status, response_body)
+      @param = param
+    end
+  end
+end

data/lib/callcredit/middleware/check_response.rb

@@ -0,0 +1,26 @@
+module Callcredit
+  module Middleware
+    class CheckResponse < Faraday::Middleware
+      def call(env)
+        @app.call(env).on_complete do |env|
+          unless results = env[:body]["Results"]
+            raise APIError.new("Received unexpected XML (Results tag missing)")
+          end
+
+          if results["Errors"]
+            errors = results["Errors"].values.flatten
+            message = errors.map { |e| e["__content__"] }.join(" | ")
+            raise APIError.new(message, env[:status], env)
+          end
+          response_values(env)
+        end
+      end
+
+      def response_values(env)
+        { status: env[:status], headers: env[:headers], body: env[:body] }
+      end
+    end
+
+    Faraday.register_middleware :response, check_response: CheckResponse
+  end
+end

data/lib/callcredit/request.rb

@@ -0,0 +1,105 @@
+module Callcredit
+  class Request
+    def initialize(connection, config)
+      @connection = connection
+      @config = config
+    end
+
+    # Perform a credit check
+    def perform(checks, check_data = {})
+      response = @connection.get do |request|
+        request.path = @config[:api_endpoint]
+        request.body = build_request_xml(checks, check_data).to_s
+      end
+      @config[:raw] ? response : response.body
+    rescue Faraday::Error::ClientError => e
+      raise APIError.new(e.response[:body], e.response[:status], e.response)
+    end
+
+    # Compile the complete XML request to send to Callcredit
+    def build_request_xml(checks, check_data={})
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.callvalidate do
+          authentication(xml)
+          xml.sessions do
+            xml.session do
+              xml.data do
+                required_checks(xml, checks)
+                personal_data(xml, check_data[:personal_data])
+                card_data(xml, check_data[:card_data])
+                bank_data(xml, check_data[:bank_data])
+                income_data(xml, check_data[:income_data])
+              end
+            end
+          end
+          xml.application @config[:application_name]
+        end
+      end
+      builder.doc
+    end
+
+    private
+
+    # Authentication details
+    def authentication(xml)
+      xml.authentication do
+        xml.company @config[:company]
+        xml.username @config[:username]
+        xml.password @config[:password]
+      end
+    end
+
+    # Checks to be performed
+    def required_checks(xml, checks)
+      required_checks = [*checks].map { |c| Util.underscore(c).to_sym }
+      xml.ChecksRequired do
+        Callcredit::Constants::CHECKS.each do |check|
+          included = required_checks.include?(Util.underscore(check).to_sym)
+          xml.send(check, included ? "yes" : "no")
+        end
+      end
+    end
+
+    def personal_data(xml, data)
+      unless data.is_a? Hash
+        raise InvalidRequestError.new(
+          "All checks require personal_data",
+          :personal_data)
+      end
+      
+      if data[:date_of_birth].is_a? String
+        data[:date_of_birth] = Date.parse(data[:date_of_birth])
+      end
+
+      xml.Personal do
+        xml.Individual do
+          xml.Dateofbirth           data[:date_of_birth].strftime("%d/%m/%Y")
+          xml.Title                 "Mr" # Title is mandatory but ignored...
+          xml.Firstname             data[:first_name]
+          xml.Othernames            data[:middle_names]
+          xml.Surname               data[:last_name]
+          xml.Phonenumber           data[:phone]
+          xml.Drivinglicensenumber  data[:driving_license]
+        end
+        xml.Address do
+          xml.Buildingnumber        data[:building_number]
+          xml.Buildingname          data[:building_name]
+          xml.Address1              data[:address_line_1]
+          xml.Postcode              data[:postcode]
+        end
+      end
+    end
+
+    def card_data(xml, data)
+      # Not implemented
+    end
+
+    def bank_data(xml, data)
+      # Not implemented
+    end
+
+    def income_data(xml, data)
+      # Not implemented
+    end
+  end
+end

data/lib/callcredit/response.rb

@@ -0,0 +1,31 @@
+module Callcredit
+  class Response
+    def initialize(response_data)
+      @response_data = response_data
+    end
+
+    def rid
+      @response_data["Results"]["Result"]["RID"]
+    end
+
+    def pid
+      @response_data["Results"]["Result"]["PID"]
+    end
+
+    def input
+      @response_data["Results"]["Result"]["Displays"]["InputData"]
+    end
+
+    def result
+      @response_data["Results"]["Result"]["Displays"]["IdentityCheck"]
+    end
+
+    def warnings
+      @response_data["Results"]["Result"]["Displays"]["Warnings"]
+    end
+
+    def full_result
+      @response_data
+    end
+  end
+end

data/lib/callcredit/util.rb

@@ -0,0 +1,16 @@
+module Callcredit
+  module Util
+    extend self
+    # String helper
+    def camelize(str)
+      str.split('_').map(&:capitalize).join
+    end
+
+    def underscore(str)
+      str.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+  end
+end

data/lib/callcredit/version.rb

@@ -0,0 +1,3 @@
+module Callcredit
+  VERSION = '0.3.0'.freeze
+end

data/spec/callcredit_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Callcredit do
+  before { Callcredit.instance_variable_set(:@config, nil) }
+
+  describe '#configure' do
+    subject { Callcredit.config }
+    Callcredit::Config::DEFAULT_OPTIONS.keys.map(&:to_sym).each do |key|
+      context "setting #{key}" do
+        before { Callcredit.configure { |config| config[key] = key } }
+        its([key]) { should == key }
+      end
+    end
+  end
+
+  describe "#config" do
+    subject(:config) { Callcredit.config }
+
+    it "raises a CallcreditError if Callcredit hasn't been configured" do
+      expect { config }.to raise_error Callcredit::CallcreditError
+    end
+  end
+
+  describe '#id_enhanced_check' do
+    before { configure_callcredit }
+    let(:data) { { first_name: "Grey", last_name: "Baker" } }
+
+    it "delegates to the client" do
+      Callcredit::Client.any_instance.
+        should_receive(:id_enhanced_check).with(data)
+      Callcredit.id_enhanced_check(data)
+    end
+  end
+
+  describe '#perform_check' do
+    before { configure_callcredit }
+    let(:data) do
+      { personal_data: { first_name: "Grey", last_name: "Baker" } }
+    end
+
+    it "delegates to the client" do
+      Callcredit::Client.any_instance.
+        should_receive(:perform_check).with(:id_enhanced_check, data)
+      Callcredit.perform_check(:id_enhanced_check, data)
+    end
+  end
+end

data/spec/checks/id_enhanced_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Callcredit::Checks::IDEnhanced do
+  let(:id_enhanced_check) { Callcredit::Checks::IDEnhanced.new(client) }
+  let(:client) { Callcredit::Client.new(config) }
+  let(:config) { Callcredit::Config.new }
+
+  let(:response_hash) { { status: status, body: body } }
+  let(:status) { 200 }
+  let(:body) do
+    "<Results>
+      <Result>
+        <Displays>
+          <InputData/>
+          <IdentityCheck/>
+        </Displays>
+      </Result>
+      <Errors/>
+    </Results>"
+  end
+  before { stub_request(:get, config[:api_endpoint]).to_return(response_hash) }
+
+  describe "#perform" do
+    subject(:perform_check) { id_enhanced_check.perform(check_data) }
+
+    let(:check_data) do
+      { first_name: "Grey",
+        last_name: "Baker",
+        date_of_birth: "01/01/2000",
+        postcode: "EC2A 1DX",
+        building_number: "22-25" }
+    end
+
+    it "makes a get request" do
+      perform_check
+      a_request(:get, config[:api_endpoint]).should have_been_made
+    end
+
+    it { should be_a Callcredit::Response }
+
+    context "when the config[:raw] is true" do
+      before { config[:raw] = true }
+      it { should be_a Faraday::Response }
+      its(:body) { should be_a String }
+    end
+
+    describe "validates inputs" do
+      it_behaves_like "it validates presence", :first_name
+      it_behaves_like "it validates presence", :last_name
+      it_behaves_like "it validates presence", :postcode
+      it_behaves_like "it validates presence", :date_of_birth
+      it_behaves_like "it validates presence", :building_number
+
+      context "with a building_name instead of building number" do
+        before { check_data.delete(:building_number) }
+        before { check_data[:building_name] = "The Mill" }
+
+        it "makes a get request" do
+          perform_check
+          a_request(:get, config[:api_endpoint]).should have_been_made
+        end
+      end
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Callcredit::Client do
+  let(:client) { Callcredit::Client.new(config) }
+  let(:config) { Callcredit::Config.new }
+  let(:check_data) { {} }
+
+  describe "#new" do
+    context "without a config" do
+      before { configure_callcredit }
+      subject(:new_client) { Callcredit::Client.new }
+
+      its(:config) { should_not == Callcredit.config }
+      it "has the attributes of the global config" do
+        new_client.config[:first_name] == Callcredit.config[:first_name]
+      end
+    end
+
+    context "with a config" do
+      before { config[:first_name] = "test" }
+      subject(:new_client) { Callcredit::Client.new(config) }
+
+      its(:config) { should_not == config }
+      it "has the attributes of the passed in config" do
+        new_client.config[:first_name] == config[:first_name]
+      end
+    end
+  end
+
+  describe "#id_enhanced_check" do
+    it "delegates to an instance of IDEnhanced" do
+      expect_any_instance_of(Callcredit::Checks::IDEnhanced).
+        to receive(:perform).once
+      client.id_enhanced_check(check_data)
+    end
+  end
+
+  describe "#perform_check" do
+    subject(:perform_check) { client.id_enhanced_check(check_data) }
+
+    it "delegates to an instance of Request" do
+      expect_any_instance_of(Callcredit::Request).to receive(:perform).once
+      client.perform_check(:check_type, check_data)
+    end
+  end
+end

data/spec/fixtures/access_denied.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Results>
+  <Result PID="" RID="">
+    <Displays/>
+  </Result>
+  <Errors>
+    <Error module="auth">Error1</Error>
+    <Error module="default">Error2</Error>
+  </Errors>
+</Results>

data/spec/fixtures/bad_request.xml

@@ -0,0 +1,5 @@
+<Results>
+    <Errors>
+        <Error module="default">Single error</Error>
+    </Errors>
+</Results>

data/spec/fixtures/request.xml

@@ -0,0 +1,50 @@
+<?xml version="1.0"?>
+<callvalidate>
+  <authentication>
+    <company/>
+    <username/>
+    <password/>
+  </authentication>
+  <sessions>
+    <session>
+      <data>
+        <ChecksRequired>
+          <BankStandard>no</BankStandard>
+          <BankEnhanced>no</BankEnhanced>
+          <CardLive>no</CardLive>
+          <CardEnhanced>no</CardEnhanced>
+          <IDEnhanced>yes</IDEnhanced>
+          <NCOAAlert>no</NCOAAlert>
+          <CallValidate3D>no</CallValidate3D>
+          <TheAffordabilityReport>no</TheAffordabilityReport>
+          <DeliveryFraud>no</DeliveryFraud>
+          <EmailValidate>no</EmailValidate>
+          <CreditScore>no</CreditScore>
+          <Zodiac>no</Zodiac>
+          <IPAddress>no</IPAddress>
+          <BankAccountPlus>no</BankAccountPlus>
+          <BankOFA>no</BankOFA>
+          <CardOFA>no</CardOFA>
+        </ChecksRequired>
+        <Personal>
+          <Individual>
+            <Dateofbirth>01/01/2000</Dateofbirth>
+            <Title>Mr</Title>
+            <Firstname/>
+            <Othernames/>
+            <Surname/>
+            <Phonenumber/>
+            <Drivinglicensenumber/>
+          </Individual>
+          <Address>
+            <Buildingnumber/>
+            <Buildingname/>
+            <Address1/>
+            <Postcode/>
+          </Address>
+        </Personal>
+      </data>
+    </session>
+  </sessions>
+  <application/>
+</callvalidate>

data/spec/request_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe Callcredit::Request do
+  let(:request) { Callcredit::Request.new(connection, config) }
+  let(:config) { Callcredit::Config.new }
+  let(:connection) { Callcredit::Client.new(config).send(:connection) }
+
+  let(:response_hash) { { status: status, body: body } }
+  let(:status) { 200 }
+  let(:body) { "<Results><Errors/></Results>" }
+  before { stub_request(:get, config[:api_endpoint]).to_return(response_hash) }
+
+  let(:check_data) { { personal_data: { date_of_birth: date_of_birth } } }
+  let(:date_of_birth) { "01/01/2000" }
+
+  describe '#build_request_xml' do
+    subject(:build_request_xml) do
+      request.build_request_xml(:id_enhanced, check_data).to_s
+    end
+    let(:request_xml) do
+      path = File.join(File.dirname(__FILE__), 'fixtures', 'request.xml')
+      File.open(path.to_s).read
+    end
+
+    it { should == request_xml }
+
+    context "with a date object for date_of_birth" do
+      let(:date_of_birth) { Date.parse("01/01/2000") }
+      it { should == request_xml }
+    end
+  end
+
+  describe "#perform" do
+    subject(:perform_check) { request.perform(:id_enhanced, check_data) }
+
+    it "makes a get request" do
+      perform_check
+      a_request(:get, config[:api_endpoint]).should have_been_made
+    end
+
+    context "when the config[:raw] is true" do
+      before { config[:raw] = true }
+      it { should be_a Faraday::Response }
+      its(:body) { should be_a String }
+    end
+
+    context "when the config[:raw] is false" do
+      it { should be_a Hash }
+      it { should include "Results" }
+
+      context "errors" do
+        context "500" do
+          let(:status) { 500 }
+
+          it "wraps the error" do
+            expect { perform_check }.to raise_error Callcredit::APIError
+          end
+        end
+
+        context "400" do
+          let(:status) { 400 }
+
+          it "wraps the error" do
+            expect { perform_check }.to raise_error Callcredit::APIError
+          end
+        end
+
+        context "200 with a single error from Callcredit" do
+          let(:body) do
+            path = File.join(File.dirname(__FILE__),
+                             'fixtures', 'bad_request.xml')
+            File.open(path.to_s).read
+          end
+
+          it "wraps the error" do
+            expect { perform_check }.
+              to raise_error(Callcredit::APIError, "Single error")
+          end
+        end
+
+        context "200 with multiple errors from Callcredit" do
+          let(:body) do
+            path = File.join(File.dirname(__FILE__),
+                             'fixtures', 'access_denied.xml')
+            File.open(path.to_s).read
+          end
+
+          it "wraps the error" do
+            expect { perform_check }.
+              to raise_error(Callcredit::APIError, "Error1 | Error2")
+          end
+        end
+
+        context "200 with unexpected XML" do
+          let(:body) { "<TopLevel></TopLevel>" }
+
+          it "wraps the error" do
+            expect { perform_check }.to raise_error Callcredit::APIError
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'callcredit'
+require 'webmock/rspec'
+RSpec.configure { |config| config.include WebMock::API }
+
+def configure_callcredit
+  Callcredit.configure { |config| config[:first_name] = "Grey" }
+end
+
+shared_examples "it validates presence" do |property|
+  context "with a missing #{property}" do
+    before { check_data.delete(property) }
+
+    it "raises and error" do
+      expect { subject }.to raise_error Callcredit::InvalidRequestError
+    end
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: callcredit
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Grey Baker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for Callcredit's CallValidate API
+email:
+- grey@gocardless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- callcredit.gemspec
+- lib/callcredit.rb
+- lib/callcredit/checks/id_enhanced.rb
+- lib/callcredit/client.rb
+- lib/callcredit/config.rb
+- lib/callcredit/constants.rb
+- lib/callcredit/errors/api_error.rb
+- lib/callcredit/errors/authentication_error.rb
+- lib/callcredit/errors/callcredit_error.rb
+- lib/callcredit/errors/invalid_request_error.rb
+- lib/callcredit/middleware/check_response.rb
+- lib/callcredit/request.rb
+- lib/callcredit/response.rb
+- lib/callcredit/util.rb
+- lib/callcredit/version.rb
+- spec/callcredit_spec.rb
+- spec/checks/id_enhanced_spec.rb
+- spec/client_spec.rb
+- spec/fixtures/access_denied.xml
+- spec/fixtures/bad_request.xml
+- spec/fixtures/request.xml
+- spec/request_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gocardless/callcredit-ruby
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Callcredit's CallValidate API
+test_files:
+- spec/callcredit_spec.rb
+- spec/checks/id_enhanced_spec.rb
+- spec/client_spec.rb
+- spec/fixtures/access_denied.xml
+- spec/fixtures/bad_request.xml
+- spec/fixtures/request.xml
+- spec/request_spec.rb
+- spec/spec_helper.rb