worldpay 1.0.6 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 035b83919e61de6a530c882706c513391dd2fa9a
-  data.tar.gz: 8d4c3e3d0226219f72464e4305ac3495dc9e8143
+  metadata.gz: eee0db6849c02df70489b192a32233a483e59879
+  data.tar.gz: 173aebc6ea7f5f2fcb5ba25c35276aa5e039770f
 SHA512:
-  metadata.gz: 97ac464d180ba7b8963f54f1081f24039cb3832fce88b97e5532f0dc134ef63419680fc9c23344867d2b5c87aae057ca969dabc73d3719b363975911dabd219b
-  data.tar.gz: 9ed4b54692604b6b5c21f7f44cf25ebc597fcdd3fe9df24eb992a0cfd2c1da56e9189ce7e75442fb4568aa15b25044343f1064bafe67b005c2a03f6d28ce6e32
+  metadata.gz: a9e7eda93ecf9485f4761c0f4d2c3989195f81d5456a391355a6ebd62fd1e61e020e2719611b64b83ffda68c2d8293dc2acd137348c752c6fb780be9ba8f8544
+  data.tar.gz: bc4cb570ac6766a3631628a2105a7b67cf1231fb680bf61c0c4d8a0d4742f11617015c86f84efb1e431516075a2dab6208a5dbfbae3b45a08c3e6916e8787be4

data/lib/worldpay.rb

@@ -6,319 +6,399 @@ require "json"
 
 class Worldpay
 
-  @service_key = ''
-  @timeout = 0
-  @disable_ssl = false
-  @endpoint = ''
-
-  @errors = {}
-  @raise_errors = true
-
-  @version = '1.0.6'
-
-  @orderTypes = ['ECOM','MOTO','RECURRING']
-
-
-  def initialize(service_key='', timeout=3, raise_errors=true)
-    if service_key.empty?
-      raise "Please set a Service Key"
-    else
-      @service_key = service_key
-      @timeout = timeout
-
-      @disable_ssl = false
-      @endpoint = 'api.worldpay.com'
-
-      @errors = {
-          'ip' => 'Invalid parameters',
-          'cine' => 'php_curl was not found',
-          'to' => 'Request timed out',
-          'nf' => 'Not found',
-          'apierror' => 'API Error',
-          'uanv' => 'Worldpay is currently unavailable, please try again later',
-          'contact' => 'Error contacting Worldpay, please try again later',
-          'ssl' => 'You must enable SSL check in production mode',
-          'verify' => 'Worldpay not verifying SSL connection',
-          'orderInput' => {
-              'token' => 'No token found',
-              'orderDescription' => 'No order_description found',
-              'amount' => 'No amount found, or it is not a whole number',
-              'currencyCode' => 'No currency_code found',
-              'name' => 'No name found',
-              'billingAddress' => 'No billing_address found'
-          },
-          'notificationPost' => 'Notification Error: Not a post',
-          'notificationUnknown' => 'Notification Error: Cannot be processed',
-          'capture' => {
-              'ordercode' => 'No order code entered'
-          },
-          'refund' => {
-              'ordercode' => 'No order code entered'
-          },
-          'json' => 'JSON could not be decoded',
-          'key' => 'Please enter your service key',
-          'sslerror' => 'Worldpay SSL certificate could not be validated'
-      }
-      @raise_errors = raise_errors
-    end
-  end
-
-
-  def setEndpoint(endpoint)
-      @endpoint = endpoint
-  end
-
-
-  #Disable SSL Check ~ Use only for testing!
-  def disableSSLCheck(disable = false)
-    @disable_ssl = disable
-
-  end
-
-  #Set timeout
-  def setTimeout(timeout = 3)
-    @timeout = timeout
-  end
-
-
-  #ERRORS
-  def onError(error, message=false, code=nil, httpStatusCode=nil, description=nil, customCode=nil)
-
-
-    if (@raise_errors)
-      raise message.to_s
-    else
-      p message.to_s
-    end
-  end
-
-
-
-
-
-  #ORDERS
-  def checkOrderInput(order)
-    errors2 = []
-
-    if (!order.any?)
-      onError('ip')
-    end
-    if (order['token']==nil)
-      errors2 << @errors['orderInput']['token']
-    end
-    if (order['orderDescription']==nil)
-      errors2 << @errors['orderInput']['orderDescription']
-    end
-    if (order['amount']==nil)
-      errors2 << @errors['orderInput']['amount']
-    end
-    if (order['currencyCode']==nil)
-      errors2 << @errors['orderInput']['currencyCode']
-    end
-    if (order['name']==nil)
-      errors2 << @errors['orderInput']['name']
-    end
-    if (order['billingAddress']==nil)
-      errors2 << @errors['orderInput']['billingAddress']
-    end
-
-    if (errors2.length > 0)
-      onError('ip', errors2.join(', '))
-    end
-  end
-
-  def createOrder(order={})
-
-    self.checkOrderInput(order)
-
-    defaults = {
-        'orderType' => 'ECOM',  #Order Type: ECOM/MOTO/RECURRING
-        'customerIdentifiers' => nil,
-        'billingAddress' => nil
-    }
-
-    order = defaults.merge(order)
-
-    fmt = "%05.2f" % order['amount']
-    cost_cents = fmt.split('.').join('')
-
-    request = {
-        'token' => order['token'],
-        'orderDescription' => order['orderDescription'],
-        'amount' => cost_cents,
-        'is3DSOrder' => order['3DS'],
-        'currencyCode' => order['currencyCode'],
-        'name' => order['name'],
-        'orderType' => order['orderType'] && @orderTypes ? (@orderTypes.include?(order['orderType']) ? order['orderType'] : 'ECOM') : 'ECOM',
-        'authorizeOnly' => order['authoriseOnly'] ? true : false,
-        'billingAddress' => order['billingAddress'],
-        'customerOrderCode' => order['customerOrderCode'],
-        'customerIdentifiers' => order['customerIdentifiers']
-    }
-
-    if(request['is3DSOrder'] == true)
-        threeDsInfo = {
-            'shopperIpAddress' => order['shopperIpAddress'],
-            'shopperSessionId' => order['shopperSessionId'],
-            'shopperUserAgent' => order['shopperUserAgent'],
-            'shopperAcceptHeader' => order['shopperAcceptHeader']
-        }
-        request.merge!(threeDsInfo)
-    end
-
-    response = sendRequest('orders', request.to_json, true)
-
-    if (response['body']['orderCode'])
-      #success
-      return response
-    else
-      onError('apierror', response.to_s)
-    end
-
-  end
-
-  def authorise3DSOrder(orderCode, responseCode, threeDsInfo)
-      request = {
-          'threeDSResponseCode' => responseCode,
-          'shopperSessionId' => threeDsInfo['shopperSessionId'],
-          'shopperAcceptHeader' => threeDsInfo['shopperAcceptHeader'],
-          'shopperUserAgent' => threeDsInfo['shopperUserAgent'],
-          'shopperIpAddress' => threeDsInfo['shopperIpAddress']
-      }
-
-      response = sendRequest('orders/'+orderCode, request.to_json, true, 'PUT')
-
-      if (response['body']['orderCode'])
-          #success
-          return response
-      else
-          onError('apierror', response.to_s)
-      end
-  end
-
-  #Capture Authorized Worldpay Order
-  def captureAuthorisedOrder(orderCode=false, amount=false)
-    if (orderCode || orderCode.is_a?(String))
-      #
-    else
-      onError('ip', @errors['capture']['ordercode'])
-    end
-
-    if (amount && amount.is_a?(Integer))
-      json = {'captureAmount'=>amount}.to_json
-    end
-
-    sendRequest('orders/'+orderCode+'/capture', (json||false))
-  end
-
-  #Cancel Authorized Worldpay Order
-  def cancelAuthorisedOrder(orderCode=false)
-    if (orderCode || orderCode.is_a?(String))
-      #
-    else
-      onError('ip', @errors['capture']['ordercode'])
-    end
-
-    sendRequest('orders/'+orderCode, false, false, 'DELETE')
-  end
-
-
-  #Refund Worldpay order
-  def refundOrder(orderCode=false, amount=false)
-    if (orderCode==false || orderCode!=orderCode.to_s)
-      onError('ip', @errors['refund']['ordercode'])
-    end
-    if (amount!=false)
-      json = {'refundAmount'=>amount}.to_json
-    else
-      json = false
-    end
-    sendRequest('orders/'+orderCode+'/refund', json)
-  end
-
-
-
-
-
-  #REQUESTS
-  def sendRequest(action='', json=false, expectResponse=false, method='POST')
-    net = Net::HTTP.new(@endpoint, '443')
-
-    if (method=="POST")
-      request = Net::HTTP::Post.new('/v1/'+action)
-    elsif (method=="GET")
-      request = Net::HTTP::Get.new('/v1/'+action)
-    elsif (method=="PUT")
-      request = Net::HTTP::Put.new('/v1/'+action)
-    elsif (method=="DELETE")
-      request = Net::HTTP::Delete.new('/v1/'+action)
-    end
-
-    # ? request = Net::HTTP::Put.new('/v1/'+action)
-
-    net.use_ssl = true
-    net.verify_mode = @disable_ssl ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
-
-    #request.set_form_data(JSON.parse(json))
-    if (json != false)
-      request.body = json
-    end
-    request.add_field("Authorization", @service_key)
-    request.add_field("Content-Type", "application/json")
-    request.add_field("X-wp-client-user-agent", "os.name="+RUBY_PLATFORM.to_s+";os.version="+RUBY_PLATFORM.to_s+";os.arch="+RUBY_PLATFORM.to_s+";lang.version="+RUBY_VERSION.to_s+";lib.version="+@version.to_s+";api.version=v1;lang=am;owner=worldpay")
-    if (json != false)
-      request.add_field("Content-Length", json.length)
-    end
-
-    net.set_debug_output $stdout #useful to see the raw messages going over the wire
-    net.read_timeout = @timeout
-    net.open_timeout = @timeout
-
-    response = net.start do |http|
-      http.request(request)
-    end
-
-    return {
-        "code"=>response.code,
-        "body"=>(JSON.parse(response.read_body) if response.read_body && response.read_body.length >= 2)
-    }
-
-  end
-
-
-
-
-
-
-  #RESPONSES
-  def handleResponse(response)
-    response = response.to_json
-  end
-
-
-
-
-
-  #TOKENS
-  #Get card details from Worldpay token
-  def getStoredCardDetails(token=false)
-    if (token==false || token!=token.to_s)
-      onError('ip', @errors['orderInput']['token'])
-    end
-
-    response = sendRequest('tokens/'+token, false, true, 'GET')
-
-
-    if (response['body']['paymentMethod'])
-      return response['body']['paymentMethod']
-    else
-      #onError('apierror')
-      return ""
-    end
-  end
-
-
-
-
+	@service_key = ''
+	@timeout = 0
+	@disable_ssl = false
+	@endpoint = ''
+
+	@errors = {}
+	@raise_errors = true
+
+	@version = '1.0.6'
+
+	@orderTypes = ['ECOM','MOTO','RECURRING']
+
+
+	def initialize(service_key='', timeout=3, raise_errors=true)
+		if service_key.empty?
+			raise "Please set a Service Key"
+		else
+			@service_key = service_key
+			@timeout = timeout
+
+			@disable_ssl = false
+			@endpoint = 'https://api.worldpay.com'
+
+			@errors = {
+					'ip' => 'Invalid parameters',
+					'cine' => 'php_curl was not found',
+					'to' => 'Request timed out',
+					'nf' => 'Not found',
+					'apierror' => 'API Error',
+					'uanv' => 'Worldpay is currently unavailable, please try again later',
+					'contact' => 'Error contacting Worldpay, please try again later',
+					'ssl' => 'You must enable SSL check in production mode',
+					'verify' => 'Worldpay not verifying SSL connection',
+					'orderInput' => {
+							'token' => 'No token found',
+							'orderCode' => 'No order_code entered',
+							'orderDescription' => 'No order_description found',
+							'amount' => 'No amount found, or it is not a whole number',
+							'currencyCode' => 'No currency_code found',
+							'name' => 'No name found',
+							'billingAddress' => 'No billing_address found'
+					},
+					'notificationPost' => 'Notification Error: Not a post',
+					'notificationUnknown' => 'Notification Error: Cannot be processed',
+					'capture' => {
+							'ordercode' => 'No order code entered'
+					},
+					'refund' => {
+							'ordercode' => 'No order code entered'
+					},
+					'json' => 'JSON could not be decoded',
+					'key' => 'Please enter your service key',
+					'sslerror' => 'Worldpay SSL certificate could not be validated'
+			}
+			@raise_errors = raise_errors
+		end
+	end
+
+	def setEndpoint(endpoint)
+			@endpoint = endpoint
+	end
+
+	#Disable SSL Check ~ Use only for testing!
+	def disableSSLCheck(disable = false)
+		@disable_ssl = disable
+
+	end
+
+	#Set timeout
+	def setTimeout(timeout = 3)
+		@timeout = timeout
+	end
+
+	#ERRORS
+	def onError(error, message=false, code=nil, httpStatusCode=nil, description=nil, customCode=nil)
+
+
+		if (@raise_errors)
+			raise message.to_s
+		else
+			p message.to_s
+		end
+	end
+
+	#ORDERS
+	def checkOrderInput(order)
+		errors2 = []
+
+		if (!order.any?)
+			onError('ip')
+		end
+		if (order['token']==nil)
+			errors2 << @errors['orderInput']['token']
+		end
+		if (order['orderDescription']==nil)
+			errors2 << @errors['orderInput']['orderDescription']
+		end
+		if (order['amount']==nil)
+			errors2 << @errors['orderInput']['amount']
+		end
+		if (order['currencyCode']==nil)
+			errors2 << @errors['orderInput']['currencyCode']
+		end
+		if (order['name']==nil)
+			errors2 << @errors['orderInput']['name']
+		end
+		if (order['billingAddress']==nil)
+			errors2 << @errors['orderInput']['billingAddress']
+		end
+
+		if (errors2.length > 0)
+			onError('ip', errors2.join(', '))
+		end
+	end
+
+	def createOrder(order={})
+
+		self.checkOrderInput(order)
+
+		defaults = {
+				'orderType' => 'ECOM',  #Order Type: ECOM/MOTO/RECURRING
+				'customerIdentifiers' => nil,
+				'billingAddress' => nil,
+				'deliveryAddress' => nil
+		}
+
+		order = defaults.merge(order)
+
+		fmt = "%05.2f" % order['amount']
+		cost_cents = fmt.split('.').join('')
+
+		_authorizeOnly = false
+		if order['authorizeOnly']
+			_authorizeOnly = order['authorizeOnly']
+		elsif
+			order['authoriseOnly']
+			_authorizeOnly = order['authoriseOnly']
+		end
+
+		request = {
+				'token' => order['token'],
+				'orderDescription' => order['orderDescription'],
+				'amount' => cost_cents,
+				'is3DSOrder' => order['3DS'],
+				'currencyCode' => order['currencyCode'],
+				'name' => order['name'],
+				'orderType' => order['orderType'] && @orderTypes ? (@orderTypes.include?(order['orderType']) ? order['orderType'] : 'ECOM') : 'ECOM',
+				'authorizeOnly' => _authorizeOnly,
+				'billingAddress' => order['billingAddress'],
+				'deliveryAddress' => order['deliveryAddress'],
+				'customerOrderCode' => order['customerOrderCode'],
+				'customerIdentifiers' => order['customerIdentifiers']
+		}
+
+		if(request['is3DSOrder'] == true)
+				threeDsInfo = {
+						'shopperIpAddress' => order['shopperIpAddress'],
+						'shopperSessionId' => order['shopperSessionId'],
+						'shopperUserAgent' => order['shopperUserAgent'],
+						'shopperAcceptHeader' => order['shopperAcceptHeader']
+				}
+				request.merge!(threeDsInfo)
+		end
+
+		response = sendRequest('orders', request.to_json, true)
+
+		if (response['body']['orderCode'])
+			#success
+			return response
+		else
+			onError('apierror', response.to_s)
+		end
+
+	end
+
+	def createAPMOrder(order={})
+
+		self.checkOrderInput(order)
+
+		defaults = {
+				'deliveryAddress' => nil,
+				'billingAddress' => nil,
+				'successUrl' => nil,
+				'pendingUrl' => nil,
+				'failureUrl' => nil,
+				'cancelUrl' => nil
+		}
+
+		order = defaults.merge(order)
+
+		fmt = "%05.2f" % order['amount']
+		cost_cents = fmt.split('.').join('')
+
+		request = {
+				'token' => order['token'],
+				'orderDescription' => order['orderDescription'],
+				'amount' => cost_cents,
+				'currencyCode' => order['currencyCode'],
+				'name' => order['name'],
+				'shopperEmailAddress' => order['shopperEmailAddress'],
+				'billingAddress' => order['billingAddress'],
+				'deliveryAddress' => order['deliveryAddress'],
+				'customerOrderCode' => order['customerOrderCode'],
+				'successUrl' => order['successUrl'],
+				'pendingUrl' => order['pendingUrl'],
+				'failureUrl' => order['failureUrl'],
+				'cancelUrl' => order['cancelUrl'],
+				'statementNarrative' => order['statementNarrative'],
+				'settlementCurrency' => order['settlementCurrency'],
+				'customerIdentifiers' => order['customerIdentifiers']
+		}
+
+		response = sendRequest('orders', request.to_json, true)
+
+		if (response['body']['orderCode'])
+			#success
+			return response
+		else
+			onError('apierror', response.to_s)
+		end
+
+	end
+
+	def authorise3DSOrder(orderCode, responseCode, threeDsInfo)
+			request = {
+					'threeDSResponseCode' => responseCode,
+					'shopperSessionId' => threeDsInfo['shopperSessionId'],
+					'shopperAcceptHeader' => threeDsInfo['shopperAcceptHeader'],
+					'shopperUserAgent' => threeDsInfo['shopperUserAgent'],
+					'shopperIpAddress' => threeDsInfo['shopperIpAddress']
+			}
+
+			response = sendRequest('orders/'+orderCode, request.to_json, true, 'PUT')
+
+			if (response['body']['orderCode'])
+					#success
+					return response
+			else
+					onError('apierror', response.to_s)
+			end
+	end
+
+	#Capture Authorized Worldpay Order
+	def captureAuthorisedOrder(orderCode=false, amount=false)
+		if (orderCode || orderCode.is_a?(String))
+			#
+		else
+			onError('ip', @errors['capture']['ordercode'])
+		end
+
+		if (amount && amount.is_a?(Integer))
+			json = {'captureAmount'=>amount}.to_json
+		end
+
+		sendRequest('orders/'+orderCode+'/capture', (json||false))
+	end
+
+	#Cancel Authorized Worldpay Order
+	def cancelAuthorisedOrder(orderCode=false)
+		if (orderCode || orderCode.is_a?(String))
+			#
+		else
+			onError('ip', @errors['capture']['ordercode'])
+		end
+
+		sendRequest('orders/'+orderCode, false, false, 'DELETE')
+	end
+
+	#Refund Worldpay order
+	def refundOrder(orderCode=false, amount=false)
+		if (orderCode==false || orderCode!=orderCode.to_s)
+			onError('ip', @errors['refund']['ordercode'])
+		end
+		if (amount!=false)
+			json = {'refundAmount'=>amount}.to_json
+		else
+			json = false
+		end
+		sendRequest('orders/'+orderCode+'/refund', json)
+	end
+
+	#REQUESTS
+	def sendRequest(action='', json=false, expectResponse=false, method='POST')
+		uri = URI.parse(@endpoint)
+
+		net = Net::HTTP.new(uri.host, uri.port)
+
+		if (method=="POST")
+			request = Net::HTTP::Post.new('/v1/'+action)
+		elsif (method=="GET")
+			request = Net::HTTP::Get.new('/v1/'+action)
+		elsif (method=="PUT")
+			request = Net::HTTP::Put.new('/v1/'+action)
+		elsif (method=="DELETE")
+			request = Net::HTTP::Delete.new('/v1/'+action)
+		end
+
+		net.use_ssl = true
+		net.verify_mode = @disable_ssl ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
+
+		if (json != false)
+			request.body = json
+		end
+		request.add_field("Authorization", @service_key)
+		request.add_field("Content-Type", "application/json")
+		request.add_field("X-wp-client-user-agent", "os.name="+RUBY_PLATFORM.to_s+";os.version="+RUBY_PLATFORM.to_s+";os.arch="+RUBY_PLATFORM.to_s+";lang.version="+RUBY_VERSION.to_s+";lib.version="+@version.to_s+";api.version=v1;lang=am;owner=worldpay")
+		if (json != false)
+			request.add_field("Content-Length", json.length)
+		end
+
+		net.set_debug_output $stdout #useful to see the raw messages going over the wire
+		net.read_timeout = @timeout
+		net.open_timeout = @timeout
+
+		result = net.start do |http|
+			http.request(request)
+		end
+
+		if (result.read_body && result.read_body.length >= 2)
+			response = JSON.parse(result.read_body)
+		else
+			response = false
+		end
+
+		if (expectResponse && !response.present?)
+				onError('uanv', @errors['json'], 503);
+		end
+
+		if (response && response["httpStatusCode"].present?)
+
+			if (response["httpStatusCode"] != '200')
+					onError(
+							false,
+							response["message"],
+							result.code,
+							response['httpStatusCode'],
+							response['description'],
+							response['customCode']
+					)
+			end
+		elsif (expectResponse && result.code != '200')
+			# If we expect a result and we have an error
+			onError('uanv', @errors['json'], 503)
+		elsif (!expectResponse)
+				if (result.code != '200')
+						onError('apierror', result.read_body, result.code)
+				else
+						response = true
+				end
+		end
+
+		return {
+				"code"=>result.code,
+				"body"=>response
+		}
+
+	end
+
+	#RESPONSES
+	def handleResponse(response)
+		response = response.to_json
+	end
+
+	#TOKENS
+	#Get card details from Worldpay token
+	def getStoredCardDetails(token=false)
+		if (token==false || token!=token.to_s)
+			onError('ip', @errors['orderInput']['token'])
+		end
+
+		response = sendRequest('tokens/'+token, false, true, 'GET')
+
+
+		if (response['body']['paymentMethod'])
+			return response['body']['paymentMethod']
+		else
+			return false
+		end
+	end
+
+
+	def getOrder(orderCode = false)
+		if (orderCode==false || !orderCode.present?)
+			onError('ip', @errors['orderInput']['orderCode']);
+		end
+
+		response = sendRequest('orders/' + orderCode, false, true, 'GET');
+
+		if (!response['body']['orderCode'].present?)
+				onError('apierror')
+		end
+
+		return response
+	end
 
 end

data/worldpay.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "worldpay"
-  spec.version       = "1.0.6"
+  spec.version       = "1.2.0"
   spec.authors       = ["Andrew Odendaal, Paul Beckford"]
   spec.email         = ["andrew.odendaal@worldpay.com"]
   spec.summary       = %q{online.worldpay.com ruby lib.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: worldpay
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrew Odendaal, Paul Beckford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,6 +64,9 @@ files:
 - worldpay-1.0.3.gem
 - worldpay-1.0.4.gem
 - worldpay-1.0.5.gem
+- worldpay-1.0.6.gem
+- worldpay-1.0.7.gem
+- worldpay-1.1.0.gem
 - worldpay.gemspec
 homepage: https://online.worldpay.com
 licenses: