realex 0.1.1

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/README.md

@@ -0,0 +1,52 @@
+# RealEx library for interfacing with www.realexpayments.com #
+
+This is a Ruby library for interfacing with the RealEx API ( http://www.realexpayments.com )
+
+## Basic Usage ##
+
+    require 'realex'
+
+    RealEx::Config.shared_secret = 'YOUR SHARED SECRET'
+    RealEx::Config.merchant_id = 'YOUR MERCHANT ID'
+
+    card = RealEx::Card.new(:number => '4***************', :cvv => '509', :expiry_date => '0822', :cardholder_name => 'Paul Campbell', :type => 'VISA')
+
+    transaction = RealEx::Authorization.new(
+    :customer_number => 1234, :variable_reference => 1234,
+    :card => card, :amount => 500, :order_id => 12345, :currency => 'EUR', :autosettle => true)
+
+    transaction.comments << "Here's a comment"
+
+    transaction.to_xml
+
+    transaction.shipping_address = RealEx::Address.new(:type => 'shipping', :code => 'Postal Code', :country => 'Country')
+
+    transaction.billing_address = RealEx::Address.new(:type => 'billing', :code => 'Postal Code', :country => 'Country')
+
+    transaction.authorize!
+
+## Manual Request Type ##
+
+    transaction.manual = true
+    transaction.authcode = '12345'
+
+    transaction.authorize!
+
+
+## Recurring payments ##
+
+    payer = RealEx::Recurring::Payer.new(:type => 'Business', :reference => 'boom', :title => 'Mr.', :firstname => 'Paul', :lastname => 'Campbell', :company => 'Hyper Tiny')
+
+    payer.address = RealEx::Address.new(:street => '64 Dame Street', :city => 'Dublin', :county => 'Dublin', :post_code => 'Dublin 3', :country => 'Ireland', :country_code => 'IE', :phone_numbers => { :home => '1234', :work => '1234', :fax => '1234', :mobile => '1234'}, :email => 'paul@rslw.com')
+
+    payer.save!
+
+    recurring_card = RealEx::Recurring::Card.new(:payer => payer, :reference => 'paulcampbell')
+
+    recurring_card.card = card
+
+    recurring_card.save
+
+    transaction = RealEx::Recurring::Authorization.new(:amount => 500, :payer => payer, :order_id => order_id)
+
+    transaction.authorize!

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'lib/**/*',
+  'rails/**/*'
+]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "realex"
+    gemspec.summary = "Ruby interface to http://realexpayments.com"
+    gemspec.description = "A Ruby library to make use of the payments API at http://realexpayments.com"
+    gemspec.email = "paul@rslw.com"
+    gemspec.homepage = "http://github.com/paulca/realex"
+    gemspec.authors = ["Paul Campbell"]
+    gemspec.version = "0.1.1"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+Jeweler::GemcutterTasks.new

data/lib/real_ex/address.rb

@@ -0,0 +1,15 @@
+module RealEx
+  class Address
+    include Initializer
+    attributes :street, :city, :county
+    attributes :post_code, :country, :country_code, :phone_numbers, :email
+    
+    [1,2,3].each do |line|
+      class_eval do
+        define_method("line#{line}") do
+          street.split("\n")[line - 1]
+        end
+      end
+    end
+  end
+end

data/lib/real_ex/card.rb

@@ -0,0 +1,23 @@
+module RealEx
+  class Card
+    include Initializer
+    
+    attributes :number, :cvv, :expiry_date, :cardholder_name, :type, :issue_number
+    
+    # The luhn check is a check to see if a credit card
+    # is actually a credit card or not
+    def passes_luhn_check?
+      odd = true
+      luhn = number.to_s.gsub(/\D/,'').reverse.split('').collect { |d|
+        d = d.to_i
+        d *= 2 if odd = !odd
+        d > 9 ? d - 9 : d
+      }.inject(0) { |sum,number| sum + number }
+      luhn % 10 == 0
+    end
+    
+    def clean_name
+      cardholder_name.gsub(/[^a-zA-Z0-9 ]/, '')
+    end
+  end
+end

data/lib/real_ex/client.rb

@@ -0,0 +1,35 @@
+module RealEx
+  class Client
+    class << self
+      
+      def timestamp
+        Time.now.strftime('%Y%m%d%H%M%S')
+      end
+      
+      def build_hash(hash_string_items)
+        first_hash = Digest::SHA1.hexdigest(hash_string_items.join('.'))
+        Digest::SHA1.hexdigest("#{first_hash}.#{RealEx::Config.shared_secret}")
+      end
+  
+      def build_xml(type, &block)
+        xml = Builder::XmlMarkup.new(:indent => 2)
+        xml.instruct!
+        xml.request(:timestamp => timestamp, :type => type) { |r| block.call(r) }
+        xml.target!
+      end
+    
+      def call(url,xml)
+        h = Net::HTTP.new('epage.payandshop.com', 443)
+        h.use_ssl = true
+        response = h.request_post(url, xml)
+        result = Hpricot.XML(response.body)
+        result
+      end
+  
+      def parse(response)
+        status = (response/:result).inner_html
+        raise RealExError, "#{(response/:message).inner_html} (#{status})" unless status == "00"
+      end
+    end
+  end
+end

data/lib/real_ex/config.rb

@@ -0,0 +1,7 @@
+module RealEx
+  class Config
+    class << self
+      attr_accessor :shared_secret, :merchant_id, :account, :refund_password, :currency
+    end
+  end
+end

data/lib/real_ex/initializer.rb

@@ -0,0 +1,24 @@
+module RealEx
+  module Initializer
+    
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # this blatantly ripped from jnunemaker's Twitter gem. Thanks John!
+    module ClassMethods
+      # creates the attributes class variable and creates each attribute's accessor methods
+      def attributes(*attrs)
+        @@attributes = attrs
+        @@attributes.each { |a| attr_accessor a }
+      end
+      
+      # read method for attributes class variable
+      def self.attributes; @@attributes end
+    end
+    
+    def initialize(setters = {})
+      setters.each { |k, v| send("#{k}=", v) } unless setters.nil?
+    end
+  end
+end

data/lib/real_ex/recurring.rb

@@ -0,0 +1,151 @@
+module RealEx
+  module Recurring
+    
+    class Transaction < RealEx::Transaction
+      def authorize!
+        RealEx::Response.new_from_xml(RealEx::Client.call('/epage-remote-plugins.cgi', to_xml))
+      end
+    end
+    
+    class Payer < Transaction
+      attributes :type, :reference, :title, :firstname, :lastname, :address, :company, :comments
+      attributes :update
+      
+      def request_type
+        @request_type = update == true ? 'payer-edit' : 'payer-new'
+      end
+      
+      def to_xml
+        super do |per|
+          per.payer(:type => type, :ref => reference) do |payer|
+            payer.title title
+            payer.firstname firstname
+            payer.lastname lastname
+            payer.company company
+            payer.address do |add|
+                add.line1 address.line1
+                add.line1 address.line2
+                add.line3 address.line3
+                add.city address.city
+                add.county address.county
+                add.postcode address.post_code
+              add.country(address.country, :country_code => address.country_code)
+            end
+            payer.phonenumbers do |numbers|
+              numbers.home address.phone_numbers[:home]
+              numbers.work address.phone_numbers[:work]
+              numbers.fax address.phone_numbers[:fax]
+              numbers.mobile address.phone_numbers[:mobile]
+            end
+            payer.email address.email
+            if !comments.empty?
+              payer.comments do |c|
+                comments.each_with_index do |i,comment|
+                  c.comment(comment, :id => i + 1)
+                end
+              end
+            end
+          end
+        end
+      end
+
+      # 20030516175919.yourmerchantid.uniqueid…smithj01
+      def hash
+        RealEx::Client.build_hash([RealEx::Client.timestamp, RealEx::Config.merchant_id, order_id, '', '', reference])
+      end
+      
+      def save!
+        authorize!
+      end
+      
+      def update!
+        self.update = true
+        authorize!
+      end
+
+    end
+    
+    class Card < Transaction
+      attributes :card, :payer, :update, :reference
+
+      def request_type
+        @request_type = update == true ? 'eft-update-expiry-date' : 'card-new'
+      end
+      
+      def to_xml
+        super do |per|
+          per.card do |c|
+            c.ref reference
+            c.payerref payer.reference
+            c.number card.number
+            c.expdate card.expiry_date
+            c.chname card.cardholder_name
+            c.type card.type
+          end
+        end
+      end
+      
+      # 20030516181127.yourmerchantid.uniqueid…smithj01.John Smith.498843******9991
+      def hash
+        if update == true
+          RealEx::Client.build_hash([RealEx::Client.timestamp, RealEx::Config.merchant_id, payer.reference, reference,card.expiry_date])
+        else
+          RealEx::Client.build_hash([RealEx::Client.timestamp, RealEx::Config.merchant_id, order_id, '', '', payer.reference,card.cardholder_name,card.number])
+        end
+      end
+      
+      def save!
+        authorize!
+      end
+      
+      def update!
+        self.update = true
+        authorize!
+      end
+
+    end
+    
+    class Authorization < Transaction
+      attributes :payer, :reference, :customer_number, :variable_reference, :product_id
+      attributes :billing_address, :shipping_address
+      
+      def request_type
+        'receipt-in'
+      end
+      
+      def to_xml
+        super do |per|
+          per.amount(amount, :currency => currency)
+          per.payerref payer.reference
+          per.paymentmethod reference
+          if customer_number or variable_reference or billing_address or shipping_address
+            per.tssinfo do |t|
+              t.custnum customer_number if customer_number
+              t.varref variable_reference if variable_reference
+              t.prodid product_id if product_id
+              if billing_address
+                t.address :type => 'billing' do |a|
+                  a.code billing_address.post_code
+                  a.country billing_address.country
+                end
+              end
+              if shipping_address
+                t.address :type => 'shipping' do |a|
+                  a.code shipping_address.post_code
+                  a.country shipping_address.country
+                end
+              end
+            end
+          end
+        end
+      end
+      
+      # timesttimestamp.merchantid.orderid.amount.currency.payerref
+      def hash
+        RealEx::Client.build_hash([RealEx::Client.timestamp, RealEx::Config.merchant_id, order_id, amount, currency, payer.reference])
+      end
+      
+    end
+    
+  end
+end

data/lib/real_ex/response.rb

@@ -0,0 +1,38 @@
+module RealEx
+  class Response
+    class CardIssuer
+      include Initializer
+      attributes :bank, :country, :countrycode, :region
+    end
+    
+    include Initializer
+    
+    attributes :timestamp, :result, :message, :orderid, :merchantid, :account, :cvnresult, :avspostcoderesponse, :pasref, :timetaken, :authtimetaken, :batchid, :avsaddressresponse, :cardissuer
+    
+    def self.new_from_xml(xml)
+      parsed_xml = xml.kind_of?(String) ? Hpricot.XML(xml) : xml
+      r = new
+      r.timestamp = (parsed_xml).at('response')['timestamp'] if (parsed_xml).at('response')
+      r.result = (parsed_xml).at('result').inner_html if (parsed_xml).at('result')
+      r.message = (parsed_xml).at('message').inner_html if (parsed_xml).at('message')
+      r.orderid = (parsed_xml).at('orderid').inner_html if (parsed_xml).at('orderid')
+      r.merchantid = (parsed_xml).at('merchantid').inner_html if (parsed_xml).at('merchantid')
+      r.account = (parsed_xml).at('account').inner_html if (parsed_xml).at('account')
+      r.cvnresult = (parsed_xml).at('cvnresult').inner_html if (parsed_xml).at('cvnresult')
+      r.avspostcoderesponse = (parsed_xml).at('avspostcoderesponse').inner_html if (parsed_xml).at('avspostcoderesponse')
+      r.avsaddressresponse = (parsed_xml).at('avsaddressresponse').inner_html if (parsed_xml).at('avsaddressresponse')
+      r.batchid = (parsed_xml).at('batchid').inner_html if (parsed_xml).at('batchid')
+      r.pasref = (parsed_xml).at('pasref').inner_html if (parsed_xml).at('pasref')
+      r.timetaken = (parsed_xml).at('timetaken').inner_html if (parsed_xml).at('timetaken')
+      r.authtimetaken = (parsed_xml).at('authtimetaken').inner_html if (parsed_xml).at('authtimetaken')
+      if cardissuer = (parsed_xml).at('cardissuer')
+        r.cardissuer = CardIssuer.new()
+        r.cardissuer.bank = cardissuer.at('bank').inner_html
+        r.cardissuer.country = cardissuer.at('country').inner_html
+        r.cardissuer.countrycode = cardissuer.at('countrycode').inner_html
+        r.cardissuer.region = cardissuer.at('region').inner_html
+      end
+      r
+    end
+  end
+end

data/lib/real_ex/transaction.rb

@@ -0,0 +1,171 @@
+module RealEx
+  class Transaction
+    include Initializer
+    attributes :card, :amount, :order_id, :currency, :autosettle, :variable_reference
+    attr_accessor :comments
+    attr_accessor :authcode, :pasref
+    
+    REQUEST_TYPES = ['auth', 'manual', 'offline', 'tss', 'payer-new', 'payer-edit', 'card-new', 'eft-update-expiry-date']
+    
+    def initialize(hash = {})
+      super(hash)
+      self.comments ||= []
+      self.autosettle ||= true
+      self.currency ||= RealEx::Config.currency || 'EUR'
+    end
+    
+    def request_type
+      self.class.name.split('::').last.downcase
+    end
+    
+    def autosettle?
+      autosettle
+    end
+    
+    def to_xml(&block)
+      xml = RealEx::Client.build_xml(request_type) do |r|
+        r.merchantid RealEx::Config.merchant_id
+        r.orderid order_id
+        r.authcode authcode if authcode
+        r.pasref pasref if pasref
+        r.account RealEx::Config.account
+        if block_given?
+          block.call(r)
+        end
+        if !comments.empty?
+          r.comments do |c|
+            comments.each_with_index do |index,comment|
+              c.comment(comment, :id => index)
+            end
+          end
+        end
+        r.sha1hash hash
+      end
+    end
+    
+    def hash
+      RealEx::Client.build_hash([RealEx::Client.timestamp, RealEx::Config.merchant_id, order_id, '', '', ''])
+    end
+
+    def authorize!
+      RealEx::Response.new_from_xml(RealEx::Client.call('/epage-remote.cgi', to_xml))
+    end
+
+  end
+  
+  class Authorization < Transaction
+    attributes :shipping_address, :billing_address, :customer_number, :product_id, :customer_ip_address
+    attributes :offline, :manual
+    
+    def initialize(hash = {})
+      super(hash)
+      self.manual ||= false
+      self.offline ||= false
+    end
+    
+    REQUEST_TYPES.each do |type|
+      class_eval do
+        define_method("#{type}=") do |boolean|  # def manual=(boolean)
+          self.request_type = type if boolean   #   self.request_type = 'manual' if boolean
+        end                                     # end
+
+        define_method("#{type}?") do            # def manual?
+          request_type == type                  #   request_type == 'manual'
+        end                                     # end
+      end
+    end
+    
+    def request_type
+      @request_type ||= 'auth'
+    end
+    
+    def request_type=(type)
+      @request_type = type if REQUEST_TYPES.include?(type)
+    end
+    
+    def to_xml
+      super do |r|
+        r.amount(amount, :currency => currency) unless offline?
+        if !offline?
+          r.card do |c|
+            c.number card.number
+            c.expdate card.expiry_date
+            c.chname card.clean_name
+            c.type card.type
+          end
+          r.autosettle :flag => autosettle? ? '1' : '0'
+          r.tssinfo do |t|
+            t.custnum customer_number if customer_number
+            t.varref variable_reference if variable_reference
+            t.prodid product_id if product_id
+            t.custipaddress customer_ip_address if customer_ip_address
+            if billing_address
+              t.address :type => 'billing' do |a|
+                a.code billing_address.post_code
+                a.country billing_address.country
+              end
+            end
+            if shipping_address
+              t.address :type => 'shipping' do |a|
+                a.code shipping_address.post_code
+                a.country shipping_address.country
+              end
+            end
+          end
+        end
+      end
+    end
+    
+    def hash
+      RealEx::Client.build_hash([RealEx::Client.timestamp, RealEx::Config.merchant_id, order_id, (amount unless offline?), (currency unless offline?), (card.number unless offline?)])
+    end
+    
+    def rebate!
+      
+    end
+    
+    def void!
+      
+    end
+    
+    def settle!
+      
+    end
+    
+  end
+  
+  class Void < Transaction    
+  end
+  
+  class Settle < Transaction
+  end
+  
+  class Rebate < Transaction
+    
+    attr_accessor :refund_password
+    
+    def refund_hash
+      Digest::SHA1.hexdigest((refund_password || RealEx::Config.refund_password || ''))
+    end
+    
+    def to_xml(&block)
+      super do |per|
+        per.amount(amount, :currency => currency)
+        per.autosettle :flag => autosettle? ? '1' : '0'
+        per.refundhash refund_hash
+        if !comments.empty?
+          per.comments do |c|
+            comments.each_with_index do |index,comment|
+              c.comment(comment, :id => index)
+            end
+          end
+        end
+      end
+    end
+
+    
+    def hash
+      RealEx::Client.build_hash([RealEx::Client.timestamp, RealEx::Config.merchant_id, order_id, amount, currency, ''])
+    end
+  end
+end

data/lib/realex.rb

@@ -0,0 +1,20 @@
+require 'rio'
+require 'digest/sha1'
+require 'hpricot'
+require 'net/https'
+require 'builder'
+ 
+$:.unshift(File.dirname(__FILE__))
+require 'real_ex/initializer'
+require 'real_ex/config'
+require 'real_ex/client'
+
+require 'real_ex/address'
+require 'real_ex/card'
+require 'real_ex/transaction'
+require 'real_ex/response'
+require 'real_ex/recurring'
+ 
+module RealEx
+  class UnknownError < StandardError; end
+end

data/realex.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{realex}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Campbell"]
+  s.date = %q{2010-02-24}
+  s.description = %q{A Ruby library to make use of the payments API at http://realexpayments.com}
+  s.email = %q{paul@rslw.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.md",
+     "Rakefile",
+     "lib/real_ex/address.rb",
+     "lib/real_ex/card.rb",
+     "lib/real_ex/client.rb",
+     "lib/real_ex/config.rb",
+     "lib/real_ex/initializer.rb",
+     "lib/real_ex/recurring.rb",
+     "lib/real_ex/response.rb",
+     "lib/real_ex/transaction.rb",
+     "lib/realex.rb",
+     "realex.gemspec",
+     "spec/address_spec.rb",
+     "spec/card_spec.rb",
+     "spec/config_spec.rb",
+     "spec/real_ex_spec.rb",
+     "spec/recurring_spec.rb",
+     "spec/response_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/transaction_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/paulca/realex}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby interface to http://realexpayments.com}
+  s.test_files = [
+    "spec/address_spec.rb",
+     "spec/card_spec.rb",
+     "spec/config_spec.rb",
+     "spec/real_ex_spec.rb",
+     "spec/recurring_spec.rb",
+     "spec/response_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/transaction_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/spec/address_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "RealEx::Address" do
+  before do
+    @address = RealEx::Address.new(
+              :post_code => '1234',
+              :country => 'Ireland',
+              :street => "99 Street view,\nholleraino\npicksville"
+              )
+  end
+  
+  it "should just save the attributes" do
+    @address.post_code.should == '1234'
+  end
+  
+  it "should just save the attributes" do
+    @address.country.should == 'Ireland'
+  end
+  
+  it "should have line1 line2 and line3" do
+    @address.line1.should == "99 Street view,"
+    @address.line2.should == "holleraino"
+    @address.line3.should == "picksville"
+  end
+  
+end

data/spec/card_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "RealEx::Card" do
+  before do
+    @card = RealEx::Card.new(
+              :number => '4111111111111111',
+              :cvv => '509',
+              :expiry_date => '0802',
+              :cardholder_name => 'Paul Campbell',
+              :type => 'VISA',
+              :issue_number =>  nil
+              )
+  end
+  
+  it "should just save the attributes" do
+    @card.number.should == '4111111111111111'
+  end
+  
+  it "should pass the luhn check" do
+    @card.passes_luhn_check?.should == true
+  end
+  
+  it "should fail the luhn check if it's an invalid card" do
+    @card.number = '1234'
+    @card.passes_luhn_check?.should == false
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "RealEx::Config" do
+  before do
+    RealEx::Config.shared_secret = "He's actually a woman"
+  end
+  
+  it "should set the shared_secret" do
+    RealEx::Config.shared_secret.should == "He's actually a woman"
+  end
+end

data/spec/real_ex_spec.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "RealEx" do
+  
+  # before do
+  #   @card = RealEx::Cart
+  #   
+  #   RealEx::Connection
+  #   RealEx::Card
+  #   RealEx::Transaction
+  #   RealEx::Refund
+  #   RealEx::Recurring::Payer
+  #   RealEx::Recurring::Card
+  # end
+  # 
+  # it "should set the shared secret" do
+  #   RealEx.shared_secret.should == "He's a woman"
+  # end
+  # 
+  # it "should set the merchant_id" do
+  #   RealEx.merchant_id.should == '123456'
+  # end
+end

data/spec/recurring_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "RealEx::Recurring" do
+  before do
+    RealEx::Config.merchant_id = 'paul'
+    RealEx::Config.shared_secret = "He's not dead, he's just asleep!"
+    RealEx::Config.account = 'internet'
+
+    @card = RealEx::Card.new(
+              :number           => '4111111111111111',
+              :cvv              => '509',
+              :expiry_date      => '0802',
+              :cardholder_name  => 'Paul Campbell',
+              :type             => 'VISA',
+              :issue_number     =>  nil
+              )
+    @payer = RealEx::Recurring::Payer.new(:type => 'Business', :reference => 'boom', :title => 'Mr.', :firstname => 'Paul', :lastname => 'Campbell', :company => 'Contrast')
+    @payer.address = RealEx::Address.new(:street => 'My house', :city => 'Dublin', :county => 'Dublin', :post_code => 'Dublin 2', :country => 'Ireland', :country_code => 'IE',
+:phone_numbers => { :home => '1', :work => '2', :fax => '3', :mobile => '4'}, :email => 'paul@contrast.ie')
+    @card = RealEx::Recurring::Card.new(:payer => @payer, :card => @card, :reference => 'billabong')
+    @transaction = RealEx::Recurring::Authorization.new(
+                    :payer         => @payer,
+                    :amount       => 500,
+                    :order_id     => 1234,
+                    :currency     => 'EUR',
+                    :autosettle   => true
+                    )
+    RealEx::Client.stub!(:timestamp).and_return('20090326160218')
+  end
+  
+  it "should create tasty XML for the payer" do
+    @payer.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"payer-new\" timestamp=\"20090326160218\">\n  <merchantid>paul</merchantid>\n  <orderid></orderid>\n  <account>internet</account>\n  <payer type=\"Business\" ref=\"boom\">\n    <title>Mr.</title>\n    <firstname>Paul</firstname>\n    <lastname>Campbell</lastname>\n    <company>Contrast</company>\n    <address>\n      <line1>My house</line1>\n      <line1></line1>\n      <line3></line3>\n      <city>Dublin</city>\n      <county>Dublin</county>\n      <postcode>Dublin 2</postcode>\n      <country country_code=\"IE\">Ireland</country>\n    </address>\n    <phonenumbers>\n      <home>1</home>\n      <work>2</work>\n      <fax>3</fax>\n      <mobile>4</mobile>\n    </phonenumbers>\n    <email>paul@contrast.ie</email>\n  </payer>\n  <sha1hash>7e97b1b743c2599b6c1fd0c5515d369d8372df15</sha1hash>\n</request>\n"
+  end
+  
+  it "should create tasty XML for the payer update" do
+    @payer.update = true
+    @payer.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"payer-edit\" timestamp=\"20090326160218\">\n  <merchantid>paul</merchantid>\n  <orderid></orderid>\n  <account>internet</account>\n  <payer type=\"Business\" ref=\"boom\">\n    <title>Mr.</title>\n    <firstname>Paul</firstname>\n    <lastname>Campbell</lastname>\n    <company>Contrast</company>\n    <address>\n      <line1>My house</line1>\n      <line1></line1>\n      <line3></line3>\n      <city>Dublin</city>\n      <county>Dublin</county>\n      <postcode>Dublin 2</postcode>\n      <country country_code=\"IE\">Ireland</country>\n    </address>\n    <phonenumbers>\n      <home>1</home>\n      <work>2</work>\n      <fax>3</fax>\n      <mobile>4</mobile>\n    </phonenumbers>\n    <email>paul@contrast.ie</email>\n  </payer>\n  <sha1hash>7e97b1b743c2599b6c1fd0c5515d369d8372df15</sha1hash>\n</request>\n"
+  end
+  
+  it "should create lovely XML for the card" do
+    @card.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"card-new\" timestamp=\"20090326160218\">\n  <merchantid>paul</merchantid>\n  <orderid></orderid>\n  <account>internet</account>\n  <card>\n    <ref>billabong</ref>\n    <payerref>boom</payerref>\n    <number>4111111111111111</number>\n    <expdate>0802</expdate>\n    <chname>Paul Campbell</chname>\n    <type>VISA</type>\n  </card>\n  <sha1hash>24dc62271ccaddc59082b4db45c80b0241f630f7</sha1hash>\n</request>\n"
+  end
+  
+  it "should create lovely XML for the card update" do
+    @card.update = true
+    @card.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"eft-update-expiry-date\" timestamp=\"20090326160218\">\n  <merchantid>paul</merchantid>\n  <orderid></orderid>\n  <account>internet</account>\n  <card>\n    <ref>billabong</ref>\n    <payerref>boom</payerref>\n    <number>4111111111111111</number>\n    <expdate>0802</expdate>\n    <chname>Paul Campbell</chname>\n    <type>VISA</type>\n  </card>\n  <sha1hash>a97a52b7e5afa2980f4298251c2b8b836fd82331</sha1hash>\n</request>\n"
+  end
+  
+  it "should create tasty XML for the authorization" do
+    @transaction.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"receipt-in\" timestamp=\"20090326160218\">\n  <merchantid>paul</merchantid>\n  <orderid>1234</orderid>\n  <account>internet</account>\n  <amount currency=\"EUR\">500</amount>\n  <payerref>boom</payerref>\n  <paymentmethod></paymentmethod>\n  <sha1hash>ec3afd1714b4473210c2b1eda0c6675bd13c411b</sha1hash>\n</request>\n"
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+# <?xml version="1.0" ?>
+# <response timestamp="20090326164411">
+# <result>501</result>
+# <message>This transaction (1234) has already been processed! If you feel this is incorrect please contact the merchant!</message>
+# <orderid>1234</orderid>
+# </response>
+describe "RealEx::Response" do
+  before do
+    @response = RealEx::Response.new_from_xml(%Q[<?xml version="1.0" ?>
+<response timestamp="20090326164411">
+<result>501</result>
+<message>This transaction (1234) has already been processed! If you feel this is incorrect please contact the merchant!</message>
+<orderid>1234</orderid>
+</response>])
+  end
+  
+  it "should build the object" do
+    @response.timestamp.should == '20090326164411'
+    @response.result.should == '501'
+    @response.message.should == 'This transaction (1234) has already been processed! If you feel this is incorrect please contact the merchant!'
+    @response.orderid.should == '1234'
+  end
+end
+
+describe "RealEx::Response" do
+  before do
+    @response = RealEx::Response.new_from_xml(%Q[<?xml version="1.0" encoding="UTF-8" ?>
+<response timestamp="20090326171616">
+<merchantid>test</merchantid>
+<account>Realex</account>
+<orderid>12345</orderid>
+<authcode>171616</authcode>
+<result>00</result>
+<cvnresult>U</cvnresult>
+<avspostcoderesponse>U</avspostcoderesponse>
+<avsaddressresponse>U</avsaddressresponse>
+<batchid>136</batchid>
+<message>[ test system ] Authorised 171616</message>
+<pasref>12380877763476</pasref>
+<timetaken>1</timetaken>
+<authtimetaken>0</authtimetaken>
+<cardissuer>
+<bank>AIB BANK</bank>
+<country>IRELAND</country>
+<countrycode>IE</countrycode>
+<region>EUR</region>
+</cardissuer>])
+  end
+  
+  it "should build the object" do
+    @response.timestamp.should == '20090326171616'
+    @response.merchantid.should == 'test'
+    @response.account.should == 'Realex'
+    @response.orderid.should == '12345'
+    @response.cardissuer.bank.should == 'AIB BANK'
+    @response.cvnresult.should == 'U'
+    @response.cvnresult.should == 'U'
+    @response.avspostcoderesponse.should == 'U'
+    @response.avsaddressresponse.should == 'U'
+    @response.batchid.should == '136'
+    @response.message.should == '[ test system ] Authorised 171616'
+    @response.pasref.should == '12380877763476'
+    @response.timetaken.should == '1'
+    @response.authtimetaken.should == '0'
+    @response.cardissuer.country.should == 'IRELAND'
+    @response.cardissuer.countrycode.should == 'IE'
+    @response.cardissuer.region.should == 'EUR'
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+ 
+dir = File.dirname(__FILE__)
+ 
+$:.unshift(File.join(dir, '/../lib/'))
+require dir + '/../lib/real_ex'
+ 
+    
+def stdout_for(&block)
+  # Inspired by http://www.ruby-forum.com/topic/58647
+  old_stdout = $stdout
+  $stdout = StringIO.new
+  yield
+  output = $stdout.string
+  $stdout = old_stdout
+  output
+end

data/spec/transaction_spec.rb

@@ -0,0 +1,132 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "RealEx::Transaction" do
+  before do
+    RealEx::Config.merchant_id = 'paul'
+    RealEx::Config.shared_secret = "She's a man!"
+    RealEx::Config.account = 'internet'
+
+    @card = RealEx::Card.new(
+              :number           => '4111111111111111',
+              :cvv              => '509',
+              :expiry_date      => '0802',
+              :cardholder_name  => 'Paul Campbell',
+              :type             => 'VISA',
+              :issue_number     =>  nil
+              )
+    @transaction = RealEx::Authorization.new(
+                    :card         => @card,
+                    :amount       => 500,
+                    :order_id     => 1234,
+                    :currency     => 'EUR',
+                    :autosettle   => true
+                    )
+    RealEx::Client.stub!(:timestamp).and_return('20090326160218')
+  end
+  
+  it "should set up the card" do
+    @transaction.card.should == @card
+  end
+  
+  it "should allow setting comments" do
+    @transaction.comments << "This is a comment"
+    @transaction.comments.should == ["This is a comment"]
+  end
+  
+  it "should build the xml" do
+    @transaction.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"auth\" timestamp=\"20090326160218\">\n  <merchantid>paul</merchantid>\n  <orderid>1234</orderid>\n  <account>internet</account>\n  <amount currency=\"EUR\">500</amount>\n  <card>\n    <number>4111111111111111</number>\n    <expdate>0802</expdate>\n    <chname>Paul Campbell</chname>\n    <type>VISA</type>\n  </card>\n  <autosettle flag=\"1\"/>\n  <tssinfo>\n  </tssinfo>\n  <sha1hash>d979885b0a296469d85ada0f08c5577d857142a0</sha1hash>\n</request>\n"
+  end
+  
+  describe "with addresses" do
+    before do
+      @transaction.shipping_address = RealEx::Address.new(:post_code => 'Shipping Code', :country => 'Shipping Country')
+      @transaction.billing_address = RealEx::Address.new(:post_code => 'Biling Code', :country => 'Billing Country')
+    end
+    
+    it "should add the addresses into the xml" do
+      @transaction.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"auth\" timestamp=\"20090326160218\">\n  <merchantid>paul</merchantid>\n  <orderid>1234</orderid>\n  <account>internet</account>\n  <amount currency=\"EUR\">500</amount>\n  <card>\n    <number>4111111111111111</number>\n    <expdate>0802</expdate>\n    <chname>Paul Campbell</chname>\n    <type>VISA</type>\n  </card>\n  <autosettle flag=\"1\"/>\n  <tssinfo>\n    <address type=\"billing\">\n      <code>Biling Code</code>\n      <country>Billing Country</country>\n    </address>\n    <address type=\"shipping\">\n      <code>Shipping Code</code>\n      <country>Shipping Country</country>\n    </address>\n  </tssinfo>\n  <sha1hash>d979885b0a296469d85ada0f08c5577d857142a0</sha1hash>\n</request>\n"
+    end
+  end
+  
+  describe "actually going through" do
+    
+    it "should parse the response" do
+      RealEx::Client.should_receive(:call).and_return(Hpricot.XML('yay'))
+      @transaction.authorize!
+    end
+  end
+  
+  describe "a manual request type" do
+    before do
+      @transaction.manual = true
+      @transaction.authcode = '123456'
+    end
+    
+    it "should allow a manual request" do
+      @transaction.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"manual\" timestamp=\"20090326160218\">\n  <merchantid>paul</merchantid>\n  <orderid>1234</orderid>\n  <authcode>123456</authcode>\n  <account>internet</account>\n  <amount currency=\"EUR\">500</amount>\n  <card>\n    <number>4111111111111111</number>\n    <expdate>0802</expdate>\n    <chname>Paul Campbell</chname>\n    <type>VISA</type>\n  </card>\n  <autosettle flag=\"1\"/>\n  <tssinfo>\n  </tssinfo>\n  <sha1hash>d979885b0a296469d85ada0f08c5577d857142a0</sha1hash>\n</request>\n" 
+    end
+  end
+  
+  describe "an offline request type" do
+    before do
+      @transaction.offline = true
+      @transaction.authcode = '123456'
+    end
+    
+    it "should allow an offline request" do
+      @transaction.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"offline\" timestamp=\"20090326160218\">\n  <merchantid>paul</merchantid>\n  <orderid>1234</orderid>\n  <authcode>123456</authcode>\n  <account>internet</account>\n  <sha1hash>c01440492e678c7793cc7a221617384dec6d9ea1</sha1hash>\n</request>\n"
+    end
+  end
+  
+  describe "a bit of meta" do
+    it "should allow setting and getting of manual= and manual?" do
+      @transaction.manual = true
+      @transaction.manual?.should == true
+    end
+    
+    it "should allow setting and getting of offline= and offline?" do
+      @transaction.offline = true
+      @transaction.offline?.should == true
+    end
+  end
+  
+end
+
+describe "RealEx::Rebate" do
+  before do
+    RealEx::Config.merchant_id = 'paul'
+    RealEx::Config.shared_secret = "She's a man!"
+    RealEx::Config.account = 'internet'
+    RealEx::Config.refund_password = ''
+    @rebate = RealEx::Rebate.new(
+              :order_id           => '12345',
+              :pasref              => '23455',
+              :authcode      => '123123123',
+              :amount  => 500
+              )
+    RealEx::Client.stub!(:timestamp).and_return('20090326160218')
+  end
+  
+  it "should create some tasty xml" do
+    @rebate.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"rebate\" timestamp=\"20090326160218\">\n  <merchantid>paul</merchantid>\n  <orderid>12345</orderid>\n  <authcode>123123123</authcode>\n  <pasref>23455</pasref>\n  <account>internet</account>\n  <amount currency=\"EUR\">500</amount>\n  <autosettle flag=\"1\"/>\n  <refundhash>da39a3ee5e6b4b0d3255bfef95601890afd80709</refundhash>\n  <sha1hash>be2f8fdc84c32d8d77ab6fae7896c10530d9d80c</sha1hash>\n</request>\n"
+  end
+end
+
+describe "RealEx::Void" do
+  before do
+    RealEx::Config.merchant_id = 'paul'
+    RealEx::Config.shared_secret = "She's a man!"
+    RealEx::Config.account = 'internet'
+    RealEx::Config.refund_password = ''
+    @void = RealEx::Void.new(
+              :order_id           => '12345',
+              :pasref              => '23455',
+              :authcode      => '123123123'
+              )
+    RealEx::Client.stub!(:timestamp).and_return('20090326160218')
+  end
+  
+  it "should create some tasty xml" do
+    @void.to_xml.should == "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<request type=\"void\" timestamp=\"20090326160218\">\n  <merchantid>paul</merchantid>\n  <orderid>12345</orderid>\n  <authcode>123123123</authcode>\n  <pasref>23455</pasref>\n  <account>internet</account>\n  <sha1hash>16b04c4e989c413a54da8585266f6087cedccb0b</sha1hash>\n</request>\n"
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: realex
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Paul Campbell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-24 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: A Ruby library to make use of the payments API at http://realexpayments.com
+email: paul@rslw.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- lib/real_ex/address.rb
+- lib/real_ex/card.rb
+- lib/real_ex/client.rb
+- lib/real_ex/config.rb
+- lib/real_ex/initializer.rb
+- lib/real_ex/recurring.rb
+- lib/real_ex/response.rb
+- lib/real_ex/transaction.rb
+- lib/realex.rb
+- realex.gemspec
+- spec/address_spec.rb
+- spec/card_spec.rb
+- spec/config_spec.rb
+- spec/real_ex_spec.rb
+- spec/recurring_spec.rb
+- spec/response_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/transaction_spec.rb
+has_rdoc: true
+homepage: http://github.com/paulca/realex
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby interface to http://realexpayments.com
+test_files: 
+- spec/address_spec.rb
+- spec/card_spec.rb
+- spec/config_spec.rb
+- spec/real_ex_spec.rb
+- spec/recurring_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/transaction_spec.rb