Module: Emailverify

Defined in:
lib/emailverify.rb,
lib/emailverify/errors.rb,
lib/emailverify/request.rb,
lib/emailverify/version.rb,
lib/emailverify/response.rb,
lib/emailverify/configuration.rb

Defined Under Namespace

Classes: AuthenticationError, Configuration, Error, Request, RequestError, Response, UnexpectedResponseError

Constant Summary collapse

VERSION = 
"0.1.1"

Class Method Summary collapse

Class Method Details

.check_balance(batch_id = nil, endpoint: nil) ⇒ Object 



42
43
44
 
# File 'lib/emailverify.rb', line 42

def check_balance(batch_id = nil, endpoint: nil)
  request.check_balance(batch_id, endpoint: endpoint)
end

.configuration ⇒ Object 



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

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Configure the gem using a block:

Emailverify.configure do |config|

config.apikey = "xxx"

end

Yields:



16
17
18
19
 
# File 'lib/emailverify.rb', line 16

def configure
  yield configuration if block_given?
  configuration
end

.configure_from_env(env = ENV) ⇒ Object

Load configuration from environment variables; helpful for CLI/CI use. EMAILVERIFY_API_KEY and EMAILVERIFY_BASE_URL are supported, but base_url will be ignored and remain the fixed app.emailverify.io host per design.



49
50
51
52
53
 
# File 'lib/emailverify.rb', line 49

def configure_from_env(env = ENV)
  configuration.api_key ||= env["EMAILVERIFY_API_KEY"]
  # ignore env base_url to keep fixed host; but store if present
  configuration
end

.request ⇒ Object

Convenience client helper — builds a client using current configuration



30
31
32
 
# File 'lib/emailverify.rb', line 30

def request
  @request ||= Request.new(api_key: configuration.api_key, base_url: configuration.base_url, timeout: configuration.timeout)
end

.reset! ⇒ Object 



25
26
27
 
# File 'lib/emailverify.rb', line 25

def reset!
  @configuration = Configuration.new
end

.valid?(email, endpoint: nil) ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/emailverify.rb', line 38

def valid?(email, endpoint: nil)
  request.valid?(email, endpoint: endpoint)
end

.validate(email, endpoint: nil) ⇒ Object 



34
35
36
 
# File 'lib/emailverify.rb', line 34

def validate(email, endpoint: nil)
  request.validate(email, endpoint: endpoint)
end