zerobounce-sdk 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f187873eefae835fa3cf0d83ee742ecac903880e67162f81b553e1a288170d2c
-  data.tar.gz: d169d4722b1fbfef58486a6495e144164fc5d1e2ca25d3c7d40ac691627cd39e
+  metadata.gz: 804ff0380f6e305c6b80ceaec623ed06f014927074ebef93598b9dab3d23c988
+  data.tar.gz: 64ff74c48f382f6cb50d29c1d9f6e95d149929289e3971f27c2e1cfcc7088706
 SHA512:
-  metadata.gz: cf05baf952979ea120118261ff907528188e6d50677ad40390159338db8d830918d9064399443ad0d3d08cd2f174bed769466965660e4b8c11e568aaa3f2a6d8
-  data.tar.gz: 689c70548c2b6b700ebc9b48cc8326ff8f7bd0e61713f48ad73c1fda9cbb003e448117678161a5a8dcb320da05343263945cb58ca2cb767b1e3a11d1311c1b65
+  metadata.gz: 8c4b82770126e3f7f0ef3699688ad11bf526163df669d3a6d637ff87d183955b1876e99e2a9e953eebb5b4102863ab8ff5204417a77d7e47722fe3b14977abcf
+  data.tar.gz: a9ebe2bd4422d96e85ffd5331456cb0669090a1ade71f828249b32a44730e843b05ffa24148673b353130b4e896075acf035d59c9963bc83ad60dcb841c56f4f

data/.gitignore

@@ -57,3 +57,8 @@ build-iPhoneSimulator/
 
 # Used by RSpec
 .rspec_status
+
+
+# Log files
+output.err
+output.log

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    zerobounce-sdk (1.1.0)
+    zerobounce-sdk (1.1.1)
+      dotenv (~> 2.8.1)
       rest-client (~> 2.1)
 
 GEM
@@ -17,6 +18,7 @@ GEM
     docile (1.4.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.8.1)
     hashdiff (1.0.1)
     http-accept (1.7.0)
     http-cookie (1.0.5)

data/README.md

@@ -30,7 +30,7 @@ Zerobounce.configure do |config|
   ...
 end
 ```
-or 
+or
 ```
 Zerobounce.config.apikey = '<zerobounce-api-key>'
 ...
@@ -92,7 +92,7 @@ Zerobounce.api_usage(Date.today, Date.today)
 
 Validate single eMail
 ```ruby
-Zerobounce.validate('valid@example.com') 
+Zerobounce.validate('valid@example.com')
 # Zerobounce.validate('valid@example.com', '192.168.0.1') # optional IP address
 =>
 {"address"=>"valid@example.com",
@@ -126,11 +126,11 @@ emails
  "toxic@example.com",
  "donotmail@example.com",
  "spamtrap@example.com"]
- 
-# ip_addresses 
+
+# ip_addresses
 => ["192.168.0.1", "192.168.0.1", "192.168.0.1", "192.168.0.1", "192.168.0.1", "192.168.0.1"]
 # Zerobounce.validate_batch(emails, ip_addresses) # optional ip_addresses parameter
- 
+
 Zerobounce.validate_batch(emails)
 =>
 [{"address"=>"disposable@example.com",
@@ -263,14 +263,14 @@ Send file
  "file_name"=>"validation.csv",
  "file_id"=>"75d854a6-565c-49f9-b4c8-b3344480ec4c"}
  # file_id will be required for next steps
- # optional named parameters: 
+ # optional named parameters:
     email_address_column: 1,
     first_name_column: 2,
     last_name_column: 3,
     gender_column: 4,
     has_header_row: true,
     return_url: nil         # results callback url
- # Zerobounce.validate_file_send(validate_file_path, email_address_column: 1, gender_column: 4) 
+ # Zerobounce.validate_file_send(validate_file_path, email_address_column: 1, gender_column: 4)
 ```
 
 Check file
@@ -361,6 +361,99 @@ Zerobounce.validate_file_delete(file_id)
 ```
 
 
+### More details on CSV file submission and CSV result retrieval
+
+This applies for both 'Email validation' and 'AI Scoring' functionalities.
+
+**The data** of the submitted CSV file **will be included** in the result CSV file. Therefore, the first columns of the result CSV file will consist of the submitted data and the following columns will provide information specific to each functionality.
+
+#### 'Email validation'
+
+The additional columns that would be included in result CSV file:
+* ZB Status
+* ZB Sub Status
+* ZB Account
+* ZB Domain
+* ZB First Name
+* ZB Last Name
+* ZB Gender
+* ZB Free Email
+* ZB MX Found
+* ZB MX Record
+* ZB SMTP Provider
+* ZB Did You Mean
+* ZB City
+* ZB Region/State
+* ZB Zip Code
+* ZB Country
+
+When `has_header_row: true` is provided to `validate_file_send()` method, original columns of the submitted file will be retained.
+
+When `has_header_row: false`, the columns that were explicitly specified in `validate_file_send()` will be given the following column title:
+```
+email_address_column    => "Email Address"
+first_name_column       => "First Name"
+last_name_column        => "Last Name"
+gender_column           => "Gender"
+```
+
+Any additional that were not (or can not be) specified by parameters, will be given column title "Custom".
+
+
+#### 'AI Scoring':
+The additional _column_ that would be included in result CSV file:
+* ZeroBounceQualityScore
+
+When `has_header_row: true` is provided to `scoring_file_send()` method, original columns of the submitted file will be retained.
+
+
+When `has_header_row: false` is provided to `scoring_file_send()` method, column title for the email column (as well as the other columns) will be _Email Address_.
+
+
+### Email Finder
+
+Guess Format
+```ruby
+Zerobounce.guessformat("zerobounce.net")
+=>
+{"email"=>"",
+ "domain"=>"zerobounce.net",
+ "format"=>"first.last",
+ "status"=>"",
+ "sub_status"=>"",
+ "confidence"=>"high",
+ "did_you_mean"=>"",
+ "failure_reason"=>"",
+ "other_domain_formats"=>
+  [{"format"=>"first", "confidence"=>"high"},
+   {"format"=>"last.first", "confidence"=>"high"},
+   {"format"=>"lfirst", "confidence"=>"high"},
+   {"format"=>"lastfirst", "confidence"=>"high"},
+   {"format"=>"firstl", "confidence"=>"high"},
+   {"format"=>"last", "confidence"=>"medium"},
+   {"format"=>"first.middle.last", "confidence"=>"medium"},
+   {"format"=>"first-last", "confidence"=>"medium"},
+   {"format"=>"l.first", "confidence"=>"medium"},
+   {"format"=>"f.last", "confidence"=>"medium"},
+   {"format"=>"f-last", "confidence"=>"medium"},
+   {"format"=>"first.l", "confidence"=>"medium"},
+   {"format"=>"first-l", "confidence"=>"medium"},
+   {"format"=>"firstlast", "confidence"=>"medium"},
+   {"format"=>"first_l", "confidence"=>"medium"},
+   {"format"=>"f_last", "confidence"=>"medium"},
+   {"format"=>"last.f", "confidence"=>"medium"},
+   {"format"=>"last-f", "confidence"=>"medium"},
+   {"format"=>"last-first", "confidence"=>"medium"},
+   {"format"=>"first_last", "confidence"=>"medium"},
+   {"format"=>"last_f", "confidence"=>"medium"},
+   {"format"=>"last_first", "confidence"=>"medium"},
+   {"format"=>"flast", "confidence"=>"medium"},
+   {"format"=>"lastf", "confidence"=>"medium"},
+   {"format"=>"l-first", "confidence"=>"low"},
+   {"format"=>"l_first", "confidence"=>"low"}]}
+# Zerobounce.guessformat("zerobounce.net", first_name: "John", middle_name: 'Deere', last_name: "Doe")
+```
+
 ## Development
 
 After checking out the repo run tests

data/documentation.md

@@ -26,7 +26,7 @@ Zerobounce.configure do |config|
   ...
 end
 ```
-or 
+or
 ```
 Zerobounce.config.apikey = '<zerobounce-api-key>'
 ...
@@ -88,7 +88,7 @@ Zerobounce.api_usage(Date.today, Date.today)
 
 Validate single eMail
 ```ruby
-Zerobounce.validate('valid@example.com') 
+Zerobounce.validate('valid@example.com')
 ### Zerobounce.validate('valid@example.com', '192.168.0.1') # optional IP address
 =>
 {"address"=>"valid@example.com",
@@ -122,11 +122,11 @@ emails
  "toxic@example.com",
  "donotmail@example.com",
  "spamtrap@example.com"]
- 
-### ip_addresses 
+
+### ip_addresses
 => ["192.168.0.1", "192.168.0.1", "192.168.0.1", "192.168.0.1", "192.168.0.1", "192.168.0.1"]
 ### Zerobounce.validate_batch(emails, ip_addresses) # optional ip_addresses parameter
- 
+
 Zerobounce.validate_batch(emails)
 =>
 [{"address"=>"disposable@example.com",
@@ -259,14 +259,14 @@ Send file
  "file_name"=>"validation.csv",
  "file_id"=>"75d854a6-565c-49f9-b4c8-b3344480ec4c"}
  ### file_id will be required for next steps
- ### optional named parameters: 
+ ### optional named parameters:
     email_address_column: 1,
     first_name_column: 2,
     last_name_column: 3,
     gender_column: 4,
     has_header_row: true,
     return_url: nil         ### results callback url
- ### Zerobounce.validate_file_send(validate_file_path, email_address_column: 1, gender_column: 4) 
+ ### Zerobounce.validate_file_send(validate_file_path, email_address_column: 1, gender_column: 4)
 ```
 
 Check file
@@ -356,6 +356,50 @@ Zerobounce.validate_file_delete(file_id)
 => {"success"=>false, "message"=>"File cannot be found."}
 ```
 
+##### Email Finder
+
+Guess Format
+```ruby
+Zerobounce.guessformat("zerobounce.net")
+=>
+{"email"=>"",
+ "domain"=>"zerobounce.net",
+ "format"=>"first.last",
+ "status"=>"",
+ "sub_status"=>"",
+ "confidence"=>"high",
+ "did_you_mean"=>"",
+ "failure_reason"=>"",
+ "other_domain_formats"=>
+  [{"format"=>"first", "confidence"=>"high"},
+   {"format"=>"last.first", "confidence"=>"high"},
+   {"format"=>"lfirst", "confidence"=>"high"},
+   {"format"=>"lastfirst", "confidence"=>"high"},
+   {"format"=>"firstl", "confidence"=>"high"},
+   {"format"=>"last", "confidence"=>"medium"},
+   {"format"=>"first.middle.last", "confidence"=>"medium"},
+   {"format"=>"first-last", "confidence"=>"medium"},
+   {"format"=>"l.first", "confidence"=>"medium"},
+   {"format"=>"f.last", "confidence"=>"medium"},
+   {"format"=>"f-last", "confidence"=>"medium"},
+   {"format"=>"first.l", "confidence"=>"medium"},
+   {"format"=>"first-l", "confidence"=>"medium"},
+   {"format"=>"firstlast", "confidence"=>"medium"},
+   {"format"=>"first_l", "confidence"=>"medium"},
+   {"format"=>"f_last", "confidence"=>"medium"},
+   {"format"=>"last.f", "confidence"=>"medium"},
+   {"format"=>"last-f", "confidence"=>"medium"},
+   {"format"=>"last-first", "confidence"=>"medium"},
+   {"format"=>"first_last", "confidence"=>"medium"},
+   {"format"=>"last_f", "confidence"=>"medium"},
+   {"format"=>"last_first", "confidence"=>"medium"},
+   {"format"=>"flast", "confidence"=>"medium"},
+   {"format"=>"lastf", "confidence"=>"medium"},
+   {"format"=>"l-first", "confidence"=>"low"},
+   {"format"=>"l_first", "confidence"=>"low"}]}
+# Zerobounce.guessformat("zerobounce.net", first_name: "John", middle_name: 'Deere', last_name: "Doe")
+```
+
 
 #### Development
 

data/documentation_es.md

@@ -88,7 +88,7 @@ Zerobounce.api_usage(Date.today, Date.today)
 
 Validar un solo correo electrónico
 ```ruby
-Zerobounce.validate('valid@example.com') 
+Zerobounce.validate('valid@example.com')
 ### Zerobounce.validate('valid@example.com', '192.168.0.1') # dirección IP opcional
 =>
 {"address"=>"valid@example.com",
@@ -124,11 +124,11 @@ emails
  "toxic@example.com",
  "donotmail@example.com",
  "spamtrap@example.com"]
- 
-### ip_addresses 
+
+### ip_addresses
 => ["192.168.0.1", "192.168.0.1", "192.168.0.1", "192.168.0.1", "192.168.0.1", "192.168.0.1"]
 ### Zerobounce.validate_batch(emails, ip_addresses) # parámetro ip_addresses opcional
- 
+
 Zerobounce.validate_batch(emails)
 =>
 [{"address"=>"disposable@example.com",
@@ -263,14 +263,14 @@ Zerobounce.validate_file_send(validate_file_path)
  "file_name"=>"validation.csv",
  "file_id"=>"75d854a6-565c-49f9-b4c8-b3344480ec4c"}
  ### se requerirá el file_id para los próximos pasos
- ### parámetros opcionales: 
+ ### parámetros opcionales:
     email_address_column: 1,
     first_name_column: 2,
     last_name_column: 3,
     gender_column: 4,
     has_header_row: true,
     return_url: nil         ### URL de devolución de resultados
- ### Zerobounce.validate_file_send(validate_file_path, email_address_column: 1, gender_column: 4) 
+ ### Zerobounce.validate_file_send(validate_file_path, email_address_column: 1, gender_column: 4)
 ```
 
 Verificar archivo
@@ -368,6 +368,50 @@ Zerobounce.validate_file_delete(file_id)
 => {"success"=>false, "message"=>"File cannot be found."}
 ```
 
+### Email Finder
+
+Guess Format
+```ruby
+Zerobounce.guessformat("zerobounce.net")
+=>
+{"email"=>"",
+ "domain"=>"zerobounce.net",
+ "format"=>"first.last",
+ "status"=>"",
+ "sub_status"=>"",
+ "confidence"=>"high",
+ "did_you_mean"=>"",
+ "failure_reason"=>"",
+ "other_domain_formats"=>
+  [{"format"=>"first", "confidence"=>"high"},
+   {"format"=>"last.first", "confidence"=>"high"},
+   {"format"=>"lfirst", "confidence"=>"high"},
+   {"format"=>"lastfirst", "confidence"=>"high"},
+   {"format"=>"firstl", "confidence"=>"high"},
+   {"format"=>"last", "confidence"=>"medium"},
+   {"format"=>"first.middle.last", "confidence"=>"medium"},
+   {"format"=>"first-last", "confidence"=>"medium"},
+   {"format"=>"l.first", "confidence"=>"medium"},
+   {"format"=>"f.last", "confidence"=>"medium"},
+   {"format"=>"f-last", "confidence"=>"medium"},
+   {"format"=>"first.l", "confidence"=>"medium"},
+   {"format"=>"first-l", "confidence"=>"medium"},
+   {"format"=>"firstlast", "confidence"=>"medium"},
+   {"format"=>"first_l", "confidence"=>"medium"},
+   {"format"=>"f_last", "confidence"=>"medium"},
+   {"format"=>"last.f", "confidence"=>"medium"},
+   {"format"=>"last-f", "confidence"=>"medium"},
+   {"format"=>"last-first", "confidence"=>"medium"},
+   {"format"=>"first_last", "confidence"=>"medium"},
+   {"format"=>"last_f", "confidence"=>"medium"},
+   {"format"=>"last_first", "confidence"=>"medium"},
+   {"format"=>"flast", "confidence"=>"medium"},
+   {"format"=>"lastf", "confidence"=>"medium"},
+   {"format"=>"l-first", "confidence"=>"low"},
+   {"format"=>"l_first", "confidence"=>"low"}]}
+# Zerobounce.guessformat("zerobounce.net", first_name: "John", middle_name: 'Deere', last_name: "Doe")
+```
+
 
 #### Desarrollo
 

data/lib/zerobounce/base_request.rb

@@ -7,11 +7,11 @@ require 'rest-client'
 
 
 module Zerobounce
-  
+
   # Sends the HTTP request.
   class BaseRequest
 
-    protected 
+    protected
 
     def self._get(root, path, params, content_type='application/json')
 

data/lib/zerobounce/configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rest-client'
+require 'dotenv'
 
 module Zerobounce
   # Configuration object for Zerobounce.
@@ -26,6 +27,7 @@ module Zerobounce
     attr_accessor :mock
 
     def initialize(mock=false)
+      if File.file?(".env") then Dotenv.load(".env") else Dotenv.load end
       self.host = 'https://api.zerobounce.net'
       self.apikey = ENV['ZEROBOUNCE_API_KEY']
       self.valid_statuses = %i[valid catch_all]

data/lib/zerobounce/mock_request.rb

@@ -3,15 +3,15 @@
 require 'zerobounce/base_request'
 
 module Zerobounce
-  
+
   # Sends the HTTP request.
   class MockRequest < BaseRequest
-    
+
     def self.get(path, params, content_type='application/json')
       response = self._get(Zerobounce::API_ROOT_URL, path, params, content_type)
       if response.headers[:content_type] == 'application/json'
         response_body = response.body
-        response_body_json = JSON.parse(response_body) 
+        response_body_json = JSON.parse(response_body)
 
         raise (response_body_json['error']) if response_body_json.key?('error')
         raise (response_body_json['errors'][0]['error']) \
@@ -19,7 +19,7 @@ module Zerobounce
             response_body_json['errors'].length > 0
 
         return response_body_json
-      else 
+      else
         return response
       end
     end
@@ -46,7 +46,7 @@ module Zerobounce
           content_type, filepath)
       if response.headers[:content_type] == 'application/json'
         response_body = response.body
-        response_body_json = JSON.parse(response_body) 
+        response_body_json = JSON.parse(response_body)
 
         raise (response_body_json['error']) if response_body_json.key?('error')
         raise (response_body_json['errors'][0]['error']) \

data/lib/zerobounce/request.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
+require 'stringio'
 require 'zerobounce/base_request'
 
 module Zerobounce
-  
+
   # Sends the HTTP request.
   class Request < BaseRequest
 
@@ -11,15 +12,18 @@ module Zerobounce
       response = self._get(Zerobounce::API_ROOT_URL, path, params, content_type)
       if response.headers[:content_type] == 'application/json'
         response_body = response.body
-        response_body_json = JSON.parse(response_body) 
+        response_body_json = JSON.parse(response_body)
 
         raise (response_body_json['error']) if response_body_json.key?('error')
+        raise (response_body_json['Message']) \
+          if response_body_json.key?('Message') and \
+            response_body_json.length == 1
         raise (response_body_json['errors'][0]['error']) \
           if response_body_json.key?('errors') and \
             response_body_json['errors'].length > 0
 
         return response_body_json
-      else 
+      else
         return response
       end
     end
@@ -37,7 +41,9 @@ module Zerobounce
 
         return response_body_json
       else
-        return response.body
+        content = StringIO.new(response.body)
+        content.set_encoding_by_bom
+        return content.string
       end
     end
 
@@ -46,7 +52,7 @@ module Zerobounce
           content_type, filepath)
       if response.headers[:content_type] == 'application/json'
         response_body = response.body
-        response_body_json = JSON.parse(response_body) 
+        response_body_json = JSON.parse(response_body)
 
         raise (response_body_json['error']) if response_body_json.key?('error')
         raise (response_body_json['errors'][0]['error']) \

data/lib/zerobounce/version.rb

@@ -2,5 +2,5 @@
 
 module Zerobounce
   # The version of the gem.
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end