Class: Agms::Connect

Inherits:
Object
  • Object
show all
Defined in:
lib/agms/connect.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Connect

Returns a new instance of Connect.



33
34
35
 
# File 'lib/agms/connect.rb', line 33

def initialize(config)
  @config = config
end

Class Method Details

.is_exception_status(status) ⇒ Object

Returns boolean.

Parameters:

  • integer —

    status

Returns:

  • boolean



6
7
8
9
10
11
12
 
# File 'lib/agms/connect.rb', line 6

def self.is_exception_status(status)
  if [200, 201, 422].include?(status)
    return true
  else
    return false
  end
end

.raise_exception_for_status(status, message = nil) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/agms/connect.rb', line 14

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

Instance Method Details

#_buildHeaders(request_method) ⇒ Object

Build Header



100
101
102
103
104
105
106
107
108
 
# File 'lib/agms/connect.rb', line 100

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

#_buildRequest(request, request_method) ⇒ Object

Build Request



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/agms/connect.rb', line 111

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

#_hashToXml(request) ⇒ Object

Build xml from Hash



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/agms/connect.rb', line 126

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

#_http_do(http_verb, url, headers = nil, body = nil) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/agms/connect.rb', line 60

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

#_parseResponse(xml, request_method) ⇒ Object

Parse the response received from gateway



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/agms/connect.rb', line 156

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

#_verify_ssl_certificate(preverify_ok, ssl_context) ⇒ Object 



145
146
147
148
149
150
151
152
153
 
# File 'lib/agms/connect.rb', line 145

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

#connect(url, request, request_method, response_object) ⇒ Object 



37
38
39
40
41
42
 
# File 'lib/agms/connect.rb', line 37

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

#delete(url, headers = nil, body = nil) ⇒ Object 



48
49
50
 
# File 'lib/agms/connect.rb', line 48

def delete(url, headers = nil, body = nil)
  return _http_do(Net::HTTP::Delete, url, headers, body)
end

#get(url, headers = nil, body = nil) ⇒ Object 



52
53
54
 
# File 'lib/agms/connect.rb', line 52

def get(url, headers = nil, body = nil)
  return _http_do Net::HTTP::Get, url, headers, body
end

#post(url, headers = nil, body = nil) ⇒ Object 



44
45
46
 
# File 'lib/agms/connect.rb', line 44

def post(url, headers = nil, body = nil)
  return _http_do(Net::HTTP::Post, url, headers, body)
end

#put(url, headers = nil, body = nil) ⇒ Object 



56
57
58
 
# File 'lib/agms/connect.rb', line 56

def put(url, headers = nil, body = nil)
  return _http_do Net::HTTP::Put, url, headers, body
end