worldpay_iadmin 1.0.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+worldpay_iadmin (1.0.0)
+
+  * initial import [Steven Cummings]

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+#--
+# Copyright (c) 2010 Steven Cummings
+#
+# 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

@@ -0,0 +1,69 @@
+== WorldPay iadmin Library
+
+WorldPay offer an api to do some remote administration tasks relating to FuturePay. The iadmin
+api is not available by default. You must contact WorldPay and ask them to activate it for you. A
+new installation id and password will be provided access the api. The api allows you to cancel a
+FuturePay agreement, change the start date, debit an agreement, or modify the amount. See the WorldPay
+docs for a list of error responses you can expect.
+
+WorldPay Docs: http://www.rbsworldpay.com/support/kb/bg/recurringpayments/rpfp8000.html
+
+== Requirements
+
+* Ruby 1.8.6 with openssl (Should work with previous versions. I've just not tested it)
+* Valid WorldPay account
+* Fakeweb gem for running tests
+
+== Example Usage:
+
+	# Create a new WorldpayIadmin instance
+	@installation_id = "12345"
+	@password = "mypass"
+	@iadmin = WorldpayIadmin.new(@installation_id, @password)
+	
+	@futurepay_id = "98765"  
+	
+	# Cancel a FuturePay agreement
+	if @iadmin.cancel_agreement(@futurepay_id)
+	  puts "Agreement Cancelled"
+	else
+	  puts "Agreement Cancellation Failed\n"
+	  puts @iadmin.response
+	end
+	
+	# Modify a start date
+	if @iadmin.modify_start_date(@futurepay_id, Time.now)
+	  puts "Start Date Changed"
+	else
+	  puts "Start Date Change Failed\n"
+	  puts @iadmin.response
+	end
+	
+	# Debit an agreement
+	if @iadmin.debit(@futurepay_id, 9.99)
+	  puts "Debit Successful"
+	else
+	  puts "Debit Failed\n"
+	  puts @iadmin.response
+	end
+	
+	# Change an amount
+	if @iadmin.change_amount(@futurepay_id, 9.99)
+	  puts "Change Amount Successful"
+	else
+  	puts "DChange Amount Failed\n"
+    puts @iadmin.response
+  end
+
+ == Test Mode:
+
+  @test_mode = true 
+  @iadmin = WorldpayIadmin.new(@installation_id, @password, @test_mode)
+  
+  or 
+  
+  @iadmin = WorldpayIadmin.new(@installation_id, @password)
+  @iadmin.test_mode = true
+
+
+

data/lib/worldpay_iadmin.rb

@@ -0,0 +1,152 @@
+# = WorldPay iadmin Library
+#  
+#  WorldPay offer an api to do some remote administration tasks relating to FuturePay. The iadmin
+#  api is not available by default. You must contact WorldPay and ask them to activate it for you. A
+#  new installation id and password will be provided access the api. The api allows you to cancel a
+#  FuturePay agreement, change the start date, debit an agreement, or change the amount. See the WorldPay
+#  docs for a list of error responses you can expect.
+#
+#  WorldPay API Docs: http://www.rbsworldpay.com/support/kb/bg/recurringpayments/rpfp8000.html
+#
+# == Requirements
+#
+# * Ruby 1.8.2 with openssl (Should work with previous versions. I've just not tested it)
+# * Valid WorldPay account.
+# * Fakeweb gem for running tests
+#
+# = Example Usage:
+#  
+#  # Create a new WorldpayIadmin instance
+#  @installation_id = "12345"
+#  @password = "mypass"
+#  @iadmin = WorldpayIadmin.new(@installation_id, @password)
+#
+#  @futurepay_id = "98765"  
+#
+#  # Cancel a FuturePay agreement
+#  if @iadmin.cancel_agreement(@futurepay_id)
+#    puts "Agreement Cancelled"
+#  else
+#    puts "Agreement Cancellation Failed\n"
+#    puts @iadmin.response
+#  end
+#
+#  # Modify a start date
+#  if @iadmin.modify_start_date(@futurepay_id, Time.now)
+#    puts "Start Date Changed"
+#  else
+#    puts "Start Date Change Failed\n"
+#    puts @iadmin.response
+#  end
+#
+#  # Debit an agreement
+#  if @iadmin.debit(@futurepay_id, 9.99)
+#    puts "Debit Successful"
+#  else
+#    puts "Debit Failed\n"
+#    puts @iadmin.response
+#  end
+#
+#  # Change an amount
+#  if @iadmin.change_amount(@futurepay_id, 9.99)
+#    puts "Change Amount Successful"
+#  else
+#    puts "DChange Amount Failed\n"
+#    puts @iadmin.response
+#  end
+#
+# = Test Mode:
+#
+#  @test_mode = true 
+#  @iadmin = WorldpayIadmin.new(@installation_id, @password, @test_mode)
+#  
+#  or 
+#  
+#  @iadmin = WorldpayIadmin.new(@installation_id, @password)
+#  @iadmin.test_mode = true
+
+class WorldpayIadmin
+    
+  require 'net/http'
+  require 'net/https'
+  require 'uri'
+  
+  # http://www.rbsworldpay.com/support/kb/bg/recurringpayments/rpfp8000.html
+  
+  
+  attr_accessor :worldpay_id, :password, :test_mode, :production_url, :test_url
+  
+  def initialize(worldpay_id, password, test_mode=false)
+    @worldpay_id = worldpay_id
+    @password = password
+    @test_mode = test_mode
+    @production_url = "https://secure-test.wp3.rbsworldpay.com/wcc/iadmin"
+    @test_url = "https://secure.wp3.rbsworldpay.com/wcc/iadmin"
+  end
+  
+  # Returns the url that the command will be sent to
+  def iadmin_url
+    @test_mode ? @test_url : @production_url
+  end
+  
+  # Cancels an existing FuturePay agreement
+  def cancel_agreement(futurepay_id)
+    run_command({:futurePayId => futurepay_id, "op-cancelFP" => "" })
+  end
+  
+  # Change or specify a FuturePay agreement's start date
+  def modify_start_date(futurepay_id, start_date)
+    run_command({:futurePayId => futurepay_id, :startDate => start_date.strftime("%Y-%m-%d"), "op-startDateRFP" => "" })
+  end
+  
+  # Change the amount/price of subsequent debits for option 1 or 2 agreements, providing that there is at least
+  # 8 days before 00:00 GMT on the day the payment is due.
+  def change_amount(futurepay_id, amount)
+    run_command({:futurePayId => futurepay_id, :amount => amount, "op-adjustRFP" => "" })
+  end
+  
+  # Debit from an agreement
+  def debit(futurepay_id, amount)
+    run_command({:futurePayId => futurepay_id, :amount => amount, "op-paymentLFP" => "" })
+  end
+  
+  # Returns the raw response string received from WorldPay
+  def response
+    @response
+  end
+  
+  protected
+  
+  # Returns <code>true</code> if the passed response string indicated the action was sucessful
+  def check_response(response)
+    response =~ /^Y,/ ? true : false
+  end
+  
+  # Returns <code>true</code> if able to connect to WorldPay the action was carried out
+  def run_command(command_params)
+    params = {:instId => @worldpay_id, :authPW => @password}
+    params.merge!(command_params)
+    params.merge!({ :testMode => "100" }) if @test_mode
+    
+    url = URI.parse(iadmin_url)
+    
+    req = Net::HTTP::Post.new(url.path)
+    req.set_form_data(params)
+    
+    http = Net::HTTP.new(url.host, url.port)
+    http.use_ssl = true
+                                  
+    response = http.request(req)
+    
+    case response
+    when Net::HTTPSuccess, Net::HTTPRedirection
+      @response = response.body.strip
+      return check_response(@response)
+    else
+      @response = "Connection Error"
+      return false
+    end
+    
+  end
+
+end

data/test/worldpay_iadmin_test.rb

@@ -0,0 +1,57 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'test/unit'
+require 'worldpay_iadmin'
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'fakeweb'
+
+class WorldpayIadminTest < Test::Unit::TestCase
+  
+  def create_worldpay_iadmin(response)
+    @worldpay_iadmin = WorldpayIadmin.new("123434", "password")
+    FakeWeb.register_uri(:any, @worldpay_iadmin.iadmin_url, :body => response)
+    @worldpay_iadmin
+  end
+  
+  def test_initialize
+    @worldpay_iadmin = WorldpayIadmin.new("123434", "password", true)
+    
+    assert_equal "123434", @worldpay_iadmin.worldpay_id
+    assert_equal "password", @worldpay_iadmin.password
+    assert_equal true, @worldpay_iadmin.test_mode
+  end
+  
+  def test_cancel_agreement
+    assert create_worldpay_iadmin("Y,Start date set OK").cancel_agreement("232323")
+  end
+  
+  def test_cancel_agreement_fail 
+    assert !create_worldpay_iadmin("E,Problem cancelling agreement").cancel_agreement("232323")
+  end
+  
+  def test_modify_start_date
+    assert create_worldpay_iadmin("Y,Start date set OK").modify_start_date("232323", Time.now)
+  end
+  
+  def test_modify_start_date_fail 
+    assert !create_worldpay_iadmin("E,Agreement already has start date").modify_start_date("232323", Time.now)
+  end
+
+  def test_change_amount
+    assert create_worldpay_iadmin("Y,Amount updated").change_amount("232323", 9.99)
+  end
+  
+  def test_change_amount_fail 
+    assert !create_worldpay_iadmin("E,Amount is fixed").change_amount("232323", 9.99)
+  end
+  
+  def test_debit
+    assert create_worldpay_iadmin("Y,transId,A,rawAuthMessage,Payment successful").debit("232323", 9.99)
+  end
+  
+  def test_debit
+    assert !create_worldpay_iadmin("E,Agreement already finished").debit("232323", 9.99)
+  end
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: worldpay_iadmin
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Steven Cummings
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-15 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: WorldPay iadmin provides a ruby interface to WorldPays remote administration interface.
+email: steven@actiontab.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- CHANGELOG
+- MIT-LICENSE
+- lib/worldpay_iadmin.rb
+- test/worldpay_iadmin_test.rb
+has_rdoc: true
+homepage: http://stevencummings.name/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: WorldPay Iadmin provides a ruby interface to WorldPays remote administration interface.
+test_files: []
+