Class: Zerobounce::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/zerobounce/request.rb

Overview

Sends the HTTP request.

Author:

  • Aaron Frase

Constant Summary collapse

VALIDATE_PATH =

The normal email validation endpoint.

'/v1/validate'
VALIDATE_WITH_IP_PATH =

The validation endpoint for email and IP validation.

'/v1/validatewithip'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Request

Returns a new instance of Request.

Parameters:

  • params (Hash) (defaults to: {})

Options Hash (params):



36
37
38
39
40
41
 
# File 'lib/zerobounce/request.rb', line 36

def initialize(params={})
  @middleware = params[:middleware] || Zerobounce.config.middleware
  @headers = params[:headers] || Zerobounce.config.headers
  @host = params[:host] || Zerobounce.config.host
  @url = params.key?(:ipaddress) || params.key?(:ip_address) ? VALIDATE_WITH_IP_PATH : VALIDATE_PATH
end

Instance Attribute Details

#headers ⇒ Hash (readonly)

The headers used for the request.

Returns:

  • (Hash) —

    the current value of headers



21
22
23
 
# File 'lib/zerobounce/request.rb', line 21

def headers
  @headers
end

#host ⇒ String (readonly)

The host to send the request to.

Returns:

  • (String) —

    the current value of host



21
22
23
 
# File 'lib/zerobounce/request.rb', line 21

def host
  @host
end

#middleware ⇒ Proc (readonly)

Faraday middleware used for the request.

Returns:

  • (Proc) —

    the current value of middleware



21
22
23
 
# File 'lib/zerobounce/request.rb', line 21

def middleware
  @middleware
end

#url ⇒ String (readonly)

The path of the request.

Returns:

  • (String) —

    the current value of url



21
22
23
 
# File 'lib/zerobounce/request.rb', line 21

def url
  @url
end

Instance Method Details

#get(params = {}) ⇒ Zerobounce::Response

Sends a GET request.

Parameters:

  • params (Hash) (defaults to: {})

Returns:



47
48
49
 
# File 'lib/zerobounce/request.rb', line 47

def get(params={})
  Response.new(conn.get(url, get_params(params)), self)
end