agms 0.1.0

data/lib/agms/configuration.rb

@@ -0,0 +1,71 @@
+require 'yaml'
+module Agms
+	class Configuration
+    # A class representing the configuration of AGMS Gateway
+    
+    # Attribute accessor for the class method
+    class << self
+      attr_accessor :server
+      attr_accessor :port
+      attr_accessor :use_unsafe_ssl
+      attr_accessor :gateway_username 
+      attr_accessor :gateway_password 
+      attr_accessor :gateway_account 
+      attr_accessor :gateway_api_key 
+      attr_accessor :gateway_max_amount
+      attr_accessor :gateway_min_amount
+      attr_accessor :verbose
+      attr_accessor :hpp_template
+    end
+
+
+    def self.init(init_file)
+      Configuration.server = 'gateway.agms.com'
+      Configuration.port = '443'
+      Configuration.use_unsafe_ssl = false
+
+      config = YAML::load_file(init_file)
+      Configuration.gateway_username = config['username']
+      Configuration.gateway_password = config['password']
+      Configuration.gateway_account = config['account']
+      Configuration.gateway_api_key = config['api_key']
+      Configuration.gateway_max_amount = config['max_amount']
+      Configuration.gateway_min_amount = config['min_amount']
+      if config['verbose']
+        Configuration.verbose = config['verbose']
+      end
+      if config['hpp_template']
+        Configuration.hpp_template = config['hpp_template']
+      end
+    end
+
+    def self.configure(gateway_username, gateway_password, gateway_account=nil, gateway_api_key=nil)
+      Configuration.server = 'gateway.agms.com'
+      Configuration.port = '443'
+      Configuration.use_unsafe_ssl = false
+
+      Configuration.gateway_username = gateway_username
+      Configuration.gateway_password = gateway_password
+      Configuration.gateway_account = gateway_account
+      Configuration.gateway_api_key = gateway_api_key
+    end
+
+    def self.instantiate()
+      return Configuration.new(
+        gateway_username = Configuration.gateway_username,
+        gateway_password = Configuration.gateway_password,
+        gateway_account = Configuration.gateway_account,
+        gateway_api_key = Configuration.gateway_api_key,
+      )
+    end
+
+    def initialize(gateway_username, gateway_password, gateway_account=nil, gateway_api_key=nil)
+      # TODO Add default value for max_amount and min_amount
+      @@gateway_username = gateway_username
+      @@gateway_password = gateway_password
+      @@gateway_account = gateway_account
+      @@gateway_api_key = gateway_api_key
+    end
+
+	end
+end

data/lib/agms/connect.rb

@@ -0,0 +1,176 @@
+module Agms
+	class Connect
+		
+		def self.is_exception_status(status)
+			if [200, 201, 422].include?(status)
+        return true
+      else
+      	return false
+      end
+    end
+
+		def self.raise_exception_for_status(status, message=nil)
+      case status.to_i
+        when 401
+          raise AuthenticationError
+        when 403
+          raise AuthorizationError, message
+        when 404
+          raise NotFoundError
+        when 426
+          raise UpgradeRequiredError
+        when 500
+          raise ServerError
+        when 503
+          raise DownForMaintenanceError
+        else
+          raise UnexpectedError, "Unexpected HTTP_RESPONSE #{status.to_i}"
+      end
+    end
+
+    def initialize(config)
+      @config = config
+    end
+
+    def connect(url, request, request_method, response_object)
+    	headers = _buildHeaders(request_method)
+      request_body = _buildRequest(request, request_method)
+      response_body = post(url, headers, request_body)
+      return _parseResponse(response_body, request_method)
+		end
+
+		def post(url, headers = nil, body = nil)
+      return _http_do(Net::HTTP::Post, url, headers, body)
+    end
+
+		def delete(url, headers = nil, body = nil)
+			return _http_do(Net::HTTP::Delete, url, headers, body)
+    end
+
+    def get(url, headers = nil, body = nil)
+    	return _http_do Net::HTTP::Get, url, headers, body
+    end
+
+    def put(url, headers = nil, body = nil)
+    	return _http_do Net::HTTP::Put, url, headers, body
+    end
+
+    def _http_do(http_verb, url, headers = nil, body = nil)
+      connection = Net::HTTP.new(Configuration.server, Configuration.port)
+      connection.open_timeout = 60
+      connection.read_timeout = 60
+      
+     	connection.use_ssl = true
+      connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      
+      # connection.ca_file = @config.ca_file
+      connection.verify_callback = proc { |preverify_ok, ssl_context| _verify_ssl_certificate(preverify_ok, ssl_context) }
+
+      # Debug connection
+      if Configuration.verbose
+        connection.set_debug_output($stdout)
+      end
+
+      connection.start do |http|
+      	request = http_verb.new(url)
+        
+      	if headers
+      		headers.each do |key, value|
+      			request[key] = value
+      		end
+        end
+        if body
+          request.body = body
+        end
+
+        response = http.request(request)
+        if response.code.to_i == 200 || response.code.to_i == 201 || response.code.to_i == 422
+        	return response.body
+      	else
+	        Connect.raise_exception_for_status(response.code)
+	      end
+      end
+    rescue OpenSSL::SSL::SSLError
+      raise SSLCertificateError
+    end
+
+		# Build Header
+		def _buildHeaders(request_method)
+			return {
+	            'Accept' => 'application/xml',
+	            'Content-type' => 'text/xml; charset=utf-8',
+	            'User-Agent' => '(Agms Ruby ' + Agms.getLibraryVersion() + ')',
+	            'X-ApiVersion' => Agms.getAPIVersion(),
+	            'SOAPAction' => 'https://gateway.agms.com/roxapi/' + request_method
+	        }
+		end
+
+		# Build Request
+		def _buildRequest(request, request_method)
+			header = '<soap:Envelope 
+				xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+				xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
+				xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+            	<soap:Body>'
+            
+        	header_line = '<' + request_method + ' xmlns="https://gateway.agms.com/roxapi/">'
+        	body = _hashToXml(request)
+          footer_line = '</' + request_method + '>'
+        	footer = '</soap:Body></soap:Envelope>'
+        	return header + header_line + body + footer_line + footer		
+		end
+
+    # Build xml from Hash
+    def _hashToXml(request)
+      data = ''
+      request.each do |key, value|
+        if value != ''
+          # Open Tag
+          data = data + "<#{key}>"
+          # Check whether value is still a hash
+          if value.class == Hash
+            value = _hashToXml(value)
+          end
+          # Add data
+          data = data + "#{value}"
+          # Close Tag
+          data = data + "</#{key}>"
+        end
+      end
+      return data
+    end
+
+		def _verify_ssl_certificate(preverify_ok, ssl_context)
+      if preverify_ok != true || ssl_context.error != 0
+        err_msg = "SSL Verification failed -- Preverify: #{preverify_ok}, Error: #{ssl_context.error_string} (#{ssl_context.error})"
+        @config.logger.error err_msg
+        false
+      else
+        true
+      end
+    end
+
+		# Parse the response received from gateway
+		def _parseResponse(xml, request_method)
+      # Parse the response body
+      doc = Nokogiri::XML(xml)
+      # Remove the namespaces
+      doc.remove_namespaces!
+      response = {}
+      # Extract the response data from the #{request_method}Result node
+      if request_method != 'ReturnHostedPaymentSetup'
+        doc.xpath("//#{request_method}Result//*").each do |node|
+          response[node.name] = node.children.text
+        end
+      else
+        doc.xpath("//#{request_method}Response//*").each do |node|
+          response = node.children.text
+        end
+      end
+
+      return response
+	  end
+
+	    
+	end
+end

data/lib/agms/error/agms_error.rb

@@ -0,0 +1,9 @@
+module Agms
+    class AgmsError < StandardError
+        attr_accessor :object
+        def initialize(message = nil, object = nil)
+          super(message)
+          self.object = object
+        end
+    end
+end

data/lib/agms/error/authentication_error.rb

@@ -0,0 +1,7 @@
+module Agms
+    class AuthenticationError < AgmsError
+      def initialize(message, object)
+        super(message, object)
+      end
+    end
+end

data/lib/agms/error/authorization_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class AuthorizationError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/client_error_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class ClientErrorError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/configuation_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class ConfigurationError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/down_for_maintenance_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class DownForMaintenanceError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/forged_query_String_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class ForgedQueryStringError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/invalid_parameter_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class InvalidParameterError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/invalid_request_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class InvalidRequestError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/invalid_signature_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class InvalidSignatureError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/not_found_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class NotFoundError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/request_validation_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class RequestValidationError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/response_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class ResponseError < AgmsError
+        def initialize(message, object)
+        	super(message, object)
+        end
+    end
+end

data/lib/agms/error/server_error_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class ServerErrorError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/ssl_certificate_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class SSLCertificateError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/unexpected_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class UnexpectedError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/error/upgrade_required_error.rb

@@ -0,0 +1,7 @@
+module Agms
+	class UpgradeRequiredError < AgmsError
+    def initialize(message, object)
+      super(message, object)
+    end
+  end
+end

data/lib/agms/hpp.rb

@@ -0,0 +1,65 @@
+module Agms
+  class HPP < Agms
+    # A class representing AGMS HPP objects.
+
+    alias AgmsResetParameters resetParameters
+    alias AgmsSetParameter setParameter
+    alias AgmsDoConnect doConnect
+
+    def initialize
+      super()
+      @api_url = 'https://gateway.agms.com/roxapi/AGMS_HostedPayment.asmx'
+      @requestObject = 'HPPRequest'
+      @responseObject = 'HPPResponse'
+    end
+
+    # @return [Object]
+    def generate(params)
+      @op = 'ReturnHostedPaymentSetup'
+      AgmsResetParameters()
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      self.execute()
+      return @response.toArray()
+    end
+
+    # @return [String]
+    def getHash
+      return @hash
+    end
+
+    # @return [String]
+    def getLink
+      if not @hash
+        raise UnexpectedError, 'Requested HPP link but no hash generated in HPP.'
+      else
+        format_field = @request.getField(:HPPFormat)
+        if format_field[:value]
+          if format_field[:value] == '1'
+            return "https://gateway.agms.com/HostedPaymentForm/HostedPaymentPage.aspx?hash=#{@hash}"
+          else
+            return "https://gateway.agms.com/HostedPaymentForm/HostedPaymentPage2.aspx?hash=#{@hash}"
+          end
+        else
+          if @@Configuration.Hpp_Template == 'TEMPLATE_1'
+            return "https://gateway.agms.com/HostedPaymentForm/HostedPaymentPage.aspx?hash=#{@hash}"
+          else
+            return "https://gateway.agms.com/HostedPaymentForm/HostedPaymentPage2.aspx?hash=#{@hash}"
+          end
+        end
+      end
+    end
+
+    protected
+    def execute
+      if @op == 'ReturnHostedPaymentSetup'
+        AgmsDoConnect('ReturnHostedPaymentSetup', @responseObject)
+        @hash = @response.getHash
+      else
+        raise InvalidRequestError, "Invalid request to Transaction API #{@op}"
+      end
+    end
+
+  end
+end