Module: EZHttp

Defined in:
lib/ez_http.rb

Overview

A helper wrapper around net/http, supports http/https(with/without certificate), post/get requests, one method call does everything.

How to use:
 response = EZHttp.Send("https://www.example.com:83/api", {"key1"=>"value1"})
 or
 response = EZHttp.Send("https://www.example.com:83/api", {"key1"=>"value1"}, "post", "application/json")
 or
 response = EZHttp.Send("https://www.example.com:83/api", {"key1"=>"value1"}, "post", "application/json", "/path_to_cert.pem")

 puts response.body

Author:

Class Method Summary collapse

Class Method Details

.Send(url, data, method = "post", content_type = "application/json", cert_path = nil) ⇒ Net::HTTPResponse

Send request to specified url and will return responses

Parameters:

  • url: (String) —

    to send request to

  • data: (Hash) —

    to send

  • method: (String) —

    can be “get”/“post”/“delete”/“put”, if nil default is “post”

  • content_type: (String) —

    if nil default is “application/json”

  • cert_path: (String) —

    to the certificate file, set nil if none

Returns:

  • (Net::HTTPResponse) —

    response from remote server, example to access its fields: response.body, response.status



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
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
 
# File 'lib/ez_http.rb', line 27

def self.Send(url, data, method="post", content_type="application/json", cert_path=nil)

  # Hack to make it compatible with version <= 1.0.1
  unless (method.class.to_s == "String")
    if (method.respond_to?("merge"))
      temp_data = method
      method = data
      data = temp_data
    end
  end


  # Parse url
  begin
    uri = URI.parse(url)
    http = Net::HTTP.new(uri.host, uri.port)
    if (url.match(/^https/))
      http.use_ssl = true
    end
  rescue
    throw "Error in url"
  end


  # Create request
  begin
    method = method || "post"
    case method.downcase
    when "post"
      request = Net::HTTP::Post.new(uri.request_uri)
    when "get"
      request = Net::HTTP::Get.new(uri.request_uri)
    when "put"
      request = Net::HTTP::Put.new(uri.request_uri)
    when "delete"
      request = Net::HTTP::Delete.new(uri.request_uri)
    else
      request = Net::HTTP::Post.new(uri.request_uri)
    end

    request.set_form_data(data)
    request["Content-Type"] = content_type || "application/json"
  rescue
    throw "Error in creating request"
  end


  # Add cert if any
  begin
    if (cert_path.nil?)
      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    else
      http.use_ssl = true
      pem = File.read(cert_path)
      http.cert = OpenSSL::X509::Certificate.new(pem)
      http.key = OpenSSL::PKey::RSA.new(pem)
      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
    end
  rescue
    throw "Error in creating certificate"
  end


  # Send request and return response
  response = http.request(request)

end