zerobounceindia-sdk 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75dd87aa7657862fa0eb77010eb648e96d07f3914d3939d97048ab3abb1849d5
-  data.tar.gz: 213eef658cf8f65081130288d0d6155b0cf31d7ab81e2da8110d3c05e739ae56
+  metadata.gz: 6fa7b16ed7f3d6433b147c71b8653f912ed92233e0a8886296f6dfc3119fa269
+  data.tar.gz: 52696da7f11e651bc6ddc6ab51979997fdaf9d4a181030add5477cec2d91d454
 SHA512:
-  metadata.gz: e8e1324056738f08f809110de5768fdc2748ee79e03b59cf8c9812d1cad531e722615880cd418b7475f6b56ba7aaf5928a3781ee7232b5c0992676ff1f073103
-  data.tar.gz: 267417eabc8f3c2b20f3fa22157a56d5388f7b40465bf84982a4f766b340cc312fde82938745a495596638217af7663a33834101ef44c362780f5916f5e32e30
+  metadata.gz: 34643b4ad277d00d32aced6f53e042d1801afc66a8ad7532e35203e6f653abc2551399e0b15d3843dae88925657e604c1493969b1eb4ed93711eef055ea7db32
+  data.tar.gz: 2add5c95922b48374dd211fa9167fc7c1f7cb48f416acb3ddbfc65e4a1141d26490ce976cdb54f6eccb8e6c16594095776b59c7d64170b6c2dab0234af5ad331

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    zerobounce (0.4.0)
+    zerobounce-sdk (1.1.1)
+      dotenv (~> 2.8.1)
       rest-client (~> 2.1)
 
 GEM
@@ -17,15 +18,16 @@ 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)
       domain_name (~> 0.5)
     json (2.6.3)
     method_source (1.0.0)
-    mime-types (3.4.1)
+    mime-types (3.5.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2023.0218.1)
+    mime-types-data (3.2023.0808)
     netrc (0.11.0)
     parallel (1.22.1)
     parser (3.2.2.0)
@@ -115,7 +117,7 @@ DEPENDENCIES
   vcr (~> 6.1.0)
   webmock (~> 3.18)
   yard (~> 0.9.26)
-  zerobounce!
+  zerobounce-sdk!
 
 BUNDLED WITH
    2.4.6

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/{README_es.md → documentation.md}

@@ -1,8 +1,4 @@
-
-# Zerobounce India
-Ruby client for Zerobounce.net API. Developed based on [this version](https://github.com/afrase/zerobounce) by Aaron Frase.
-
-## Usage
+#### Usage
 Add this line to your application's Gemfile:
 ```ruby
 gem 'zerobounceindia-sdk'
@@ -30,7 +26,7 @@ Zerobounce.configure do |config|
   ...
 end
 ```
-or 
+or
 ```
 Zerobounce.config.apikey = '<zerobounce-api-key>'
 ...
@@ -39,7 +35,7 @@ Zerobounce.config.apikey = '<zerobounce-api-key>'
 Credits
 ```ruby
 Zerobounce.credits
-=> 79   # returns -1 for invalid key
+=> 79   ### returns -1 for invalid key
 ```
 
 Activity
@@ -88,12 +84,12 @@ Zerobounce.api_usage(Date.today, Date.today)
  "end_date"=>"4/28/2023"}
 ```
 
-### Email Validation
+##### Email Validation
 
 Validate single eMail
 ```ruby
-Zerobounce.validate('valid@example.com') 
-# Zerobounce.validate('valid@example.com', '192.168.0.1') # optional IP address
+Zerobounce.validate('valid@example.com')
+### Zerobounce.validate('valid@example.com', '192.168.0.1') # optional IP address
 =>
 {"address"=>"valid@example.com",
  "status"=>"valid",
@@ -126,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, ip_addresses) # optional ip_addresses parameter
+
 Zerobounce.validate_batch(emails)
 =>
 [{"address"=>"disposable@example.com",
@@ -249,11 +245,11 @@ Zerobounce.validate_batch(emails)
   "processed_at"=>"2023-04-28 15:21:44.340"}]
 ```
 
-#### Batch File Validation
+###### Batch File Validation
 
 Send file
 ```ruby
-# sample file can be found in the files folder of this repository
+### sample file can be found in the files folder of this repository
  validate_file_path = File.join(Dir.pwd, 'files', 'validation.csv')
 => "/home/zb/wrappers/ruby-test/files/validation.csv"
  Zerobounce.validate_file_send(validate_file_path)
@@ -262,15 +258,15 @@ Send file
  "message"=>"File Accepted",
  "file_name"=>"validation.csv",
  "file_id"=>"75d854a6-565c-49f9-b4c8-b3344480ec4c"}
- # file_id will be required for next steps
- # optional named parameters: 
+ ### file_id will be required for next steps
+ ### 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) 
+    return_url: nil         ### results callback url
+ ### Zerobounce.validate_file_send(validate_file_path, email_address_column: 1, gender_column: 4)
 ```
 
 Check file
@@ -309,7 +305,7 @@ Zerobounce.validate_file_delete(file_id)
  "file_id"=>"75d854a6-565c-49f9-b4c8-b3344480ec4c"}
 ```
 
-### AI Scoring
+##### AI Scoring
 
 Send file
 ```ruby
@@ -321,12 +317,12 @@ Zerobounce.scoring_file_send(scoring_file_path)
  "message"=>"File Accepted",
  "file_name"=>"scoring.csv",
  "file_id"=>"89fb7262-b845-4fa1-aa25-e486347ec64e"}
-# file_id will be required for the next steps
-# optional named parameters
+### file_id will be required for the next steps
+### optional named parameters
     email_address_column: 1,
     has_header_row: true,
-    return_url: nil         # results callback url
-# Zerobounce.scoring_file_send(scoring_file_path, email_address_column: 1)
+    return_url: nil         ### results callback url
+### Zerobounce.scoring_file_send(scoring_file_path, email_address_column: 1)
 ```
 
 File check
@@ -360,12 +356,56 @@ 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
+#### Development
 
 After checking out the repo run tests
 ```bash
-rspec --init # if needed
+rspec --init ### if needed
 bundle exec rspec
 ```
 
@@ -379,7 +419,7 @@ Finished in 6.81 seconds (files took 0.40587 seconds to load)
 53 examples, 0 failures
 ```
 
-### Test parameters
+##### Test parameters
 The tests use the following environment parameters:
 TEST {unit|live} influences whether mocked unit tests are run or the live server is used (credits may be used if you choose to do this)
 ZEROBOUNCE_API_KEY {<zerobounce-api-key-value>} this key is used to make requests to the live server; it is also used in mock tests as a valid key sample (any value will work for mock tests)

data/documentation_es.md

@@ -0,0 +1,449 @@
+#### Uso
+Agrega esta línea a tu Gemfile de la aplicación:
+```ruby
+gem 'zerobounce-sdk'
+```
+
+Y luego ejecuta:
+```bash
+$ bundle
+```
+
+O instálalo directamente con:
+```bash
+$ gem install zerobounce-sdk
+```
+
+Importa:
+```ruby
+require 'zerobounce'
+```
+
+Configura una clave de API válida de ZeroBounce:
+```ruby
+Zerobounce.configure do |config|
+  config.apikey = '<clave-de-api-de-zerobounce>'
+  ...
+end
+```
+o
+```ruby
+Zerobounce.config.apikey = '<clave-de-api-de-zerobounce>'
+...
+```
+
+Créditos
+```ruby
+Zerobounce.credits
+=> 79   ### devuelve -1 si la clave es inválida
+```
+
+Actividad
+```ruby
+Zerobounce.activity('ss@gmail.com')
+=> {"found"=>true, "active_in_days"=>"180"}
+```
+
+Estadísticas de uso
+```ruby
+Zerobounce.api_usage(Date.today, Date.today)
+=>
+{"total"=>0,
+ "status_valid"=>0,
+ "status_invalid"=>0,
+ "status_catch_all"=>0,
+ "status_do_not_mail"=>0,
+ "status_spamtrap"=>0,
+ "status_unknown"=>0,
+ "sub_status_toxic"=>0,
+ "sub_status_disposable"=>0,
+ "sub_status_role_based"=>0,
+ "sub_status_possible_trap"=>0,
+ "sub_status_global_suppression"=>0,
+ "sub_status_timeout_exceeded"=>0,
+ "sub_status_mail_server_temporary_error"=>0,
+ "sub_status_mail_server_did_not_respond"=>0,
+ "sub_status_greylisted"=>0,
+ "sub_status_antispam_system"=>0,
+ "sub_status_does_not_accept_mail"=>0,
+ "sub_status_exception_occurred"=>0,
+ "sub_status_failed_syntax_check"=>0,
+ "sub_status_mailbox_not_found"=>0,
+ "sub_status_unroutable_ip_address"=>0,
+ "sub_status_possible_typo"=>0,
+ "sub_status_no_dns_entries"=>0,
+ "sub_status_role_based_catch_all"=>0,
+ "sub_status_mailbox_quota_exceeded"=>0,
+ "sub_status_forcible_disconnect"=>0,
+ "sub_status_failed_smtp_connection"=>0,
+ "sub_status_mx_forward"=>0,
+ "sub_status_alternate"=>0,
+ "sub_status_blocked"=>0,
+ "sub_status_allowed"=>0,
+ "start_date"=>"4/28/2023",
+ "end_date"=>"4/28/2023"}
+```
+
+##### Validación de correo electrónico
+
+Validar un solo correo electrónico
+```ruby
+Zerobounce.validate('valid@example.com')
+### Zerobounce.validate('valid@example.com', '192.168.0.1') # dirección IP opcional
+=>
+{"address"=>"valid@example.com",
+ "status"=>"valid",
+ "sub_status"=>"",
+ "free_email"=>false,
+ "did_you_mean"=>nil,
+ "account"=>nil,
+ "domain"=>nil,
+ "domain_age_days"=>"9692",
+ "smtp_provider"=>"example",
+ "mx_found"=>"true",
+ "mx_record"=>"mx.example.com",
+ "firstname"=>"zero",
+ "lastname"=>"bounce",
+ "gender"=>"male",
+ "country"=>nil,
+ "region"=>nil,
+ "city"=>nil,
+ "zipcode"=>nil,
+ "processed_at"=>"2023-04-28 15:18:45.631"}
+```
+
+Validar
+
+en lote
+```ruby
+emails
+=>
+["disposable@example.com",
+ "invalid@example.com",
+ "valid@example.com",
+ "toxic@example.com",
+ "donotmail@example.com",
+ "spamtrap@example.com"]
+
+### 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",
+  "status"=>"do_not_mail",
+  "sub_status"=>"disposable",
+  "free_email"=>false,
+  "did_you_mean"=>nil,
+  "account"=>nil,
+  "domain"=>nil,
+  "domain_age_days"=>"9692",
+  "smtp_provider"=>"example",
+  "mx_found"=>"true",
+  "mx_record"=>"mx.example.com",
+  "firstname"=>"zero",
+  "lastname"=>"bounce",
+  "gender"=>"male",
+  "country"=>nil,
+  "region"=>nil,
+  "city"=>nil,
+  "zipcode"=>nil,
+  "processed_at"=>"2023-04-28 15:21:44.340"},
+ {"address"=>"invalid@example.com",
+  "status"=>"invalid",
+  "sub_status"=>"mailbox_not_found",
+  "free_email"=>false,
+  "did_you_mean"=>nil,
+  "account"=>nil,
+  "domain"=>nil,
+  "domain_age_days"=>"9692",
+  "smtp_provider"=>"example",
+  "mx_found"=>"true",
+  "mx_record"=>"mx.example.com",
+  "firstname"=>"zero",
+  "lastname"=>"bounce",
+  "gender"=>"male",
+  "country"=>nil,
+  "region"=>nil,
+  "city"=>nil,
+  "zipcode"=>nil,
+  "processed_at"=>"2023-04-28 15:21:44.340"},
+ {"address"=>"valid@example.com",
+  "status"=>"valid",
+  "sub_status"=>"",
+  "free_email"=>false,
+  "did_you_mean"=>nil,
+  "account"=>nil,
+  "domain"=>nil,
+  "domain_age_days"=>"9692",
+  "smtp_provider"=>"example",
+  "mx_found"=>"true",
+  "mx_record"=>"mx.example.com",
+  "firstname"=>"zero",
+  "lastname"=>"bounce",
+  "gender"=>"male",
+  "country"=>nil,
+  "region"=>nil,
+  "city"=>nil,
+  "zipcode"=>nil,
+  "processed_at"=>"2023-04-28 15:21:44.340"},
+ {"address"=>"toxic@example.com",
+  "status"=>"do_not_mail",
+  "sub_status"=>"toxic",
+  "free_email"=>false,
+  "did_you_mean"=>nil,
+  "account"=>nil,
+  "domain"=>nil,
+  "domain_age_days"=>"9692",
+  "smtp_provider"=>"example",
+  "mx_found"=>"true",
+  "mx_record"=>"mx.example.com",
+  "firstname"=>"zero",
+  "lastname"=>"bounce",
+  "gender"=>"male",
+  "country"=>nil,
+  "region"=>nil,
+  "city"=>nil,
+  "zipcode"=>nil,
+  "processed_at"=>"2023-04-28 15:21:44.340"},
+ {"address"=>"donotmail@example.com",
+  "status"=>"do_not_mail",
+  "sub_status"=>"role_based",
+  "free_email"=>false,
+  "did_you_mean"=>nil,
+  "account"=>nil,
+  "domain"=>nil,
+  "domain
+
+_age_days"=>"9692",
+  "smtp_provider"=>"example",
+  "mx_found"=>"true",
+  "mx_record"=>"mx.example.com",
+  "firstname"=>"zero",
+  "lastname"=>"bounce",
+  "gender"=>"male",
+  "country"=>nil,
+  "region"=>nil,
+  "city"=>nil,
+  "zipcode"=>nil,
+  "processed_at"=>"2023-04-28 15:21:44.340"},
+ {"address"=>"spamtrap@example.com",
+  "status"=>"spamtrap",
+  "sub_status"=>"",
+  "free_email"=>false,
+  "did_you_mean"=>nil,
+  "account"=>nil,
+  "domain"=>nil,
+  "domain_age_days"=>"9692",
+  "smtp_provider"=>"example",
+  "mx_found"=>"true",
+  "mx_record"=>"mx.example.com",
+  "firstname"=>"zero",
+  "lastname"=>"bounce",
+  "gender"=>"male",
+  "country"=>nil,
+  "region"=>nil,
+  "city"=>nil,
+  "zipcode"=>nil,
+  "processed_at"=>"2023-04-28 15:21:44.340"}]
+```
+
+###### Validación de archivo en lote
+
+Enviar archivo
+```ruby
+### puedes encontrar un archivo de muestra en la carpeta files de este repositorio
+validate_file_path = File.join(Dir.pwd, 'files', 'validation.csv')
+=> "/home/zb/wrappers/ruby-test/files/validation.csv"
+Zerobounce.validate_file_send(validate_file_path)
+=>
+{"success"=>true,
+ "message"=>"File Accepted",
+ "file_name"=>"validation.csv",
+ "file_id"=>"75d854a6-565c-49f9-b4c8-b3344480ec4c"}
+ ### se requerirá el file_id para los próximos pasos
+ ### 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)
+```
+
+Verificar archivo
+```ruby
+file_id = "75d854a6-565c-49f9-b4c8-b3344480ec4c"
+=> "75d854a6-565c-49f9-b4c8-b3344480ec4c"
+Zerobounce.validate_file_check(file_id)
+=>
+{"success"=>true,
+ "file_id"=>"75d854a6-565c-49f9-b4c8-b3344480ec4c",
+ "file_name"=>"validation.csv",
+ "upload_date"=>"2023-04-28T15:25:41Z",
+ "file_status"=>"Greylisted",
+ "complete_percentage"=>"0%",
+ "error_reason"=>nil,
+ "return_url"=>nil}
+```
+
+Obtener archivo
+```ruby
+file_id = "75d854a6-565c-49f9-b4c8-b3344480ec4c"
+=> "75d854a6-565c-49f9-b4c8-b3344480ec4c"
+Zerobounce.validate_file_get(file_id)
+=> "\"email\",\"first\",\"last\",\"gender\",\"ip\",\"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\"\n\"disposable@example.com\",\"
+
+First\",\"Last\",\"male\",\"127.0.0.1\",\"do_not_mail\",\"disposable\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"invalid@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"invalid\",\"mailbox_not_found\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"valid@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"valid\",\"\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"toxic@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"do_not_mail\",\"toxic\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"donotmail@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"do_not_mail\",\"role_based\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"spamtrap@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"spamtrap\",\"\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"abuse@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"abuse\",\"\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"unknown@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"unknown\",\"mail_server_temporary_error\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"catch_all@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"catch-all\",\"\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"antispam_system@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"unknown\",\"antispam_system\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"does_not_accept_mail@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"invalid\",\"does_not_accept_mail\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"exception_occurred@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"unknown\",\"exception_occurred\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"failed_smtp_connection@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"unknown\",\"failed_smtp_connection\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"failed_syntax_check@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"invalid\",\"failed_syntax_check\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"forcible_disconnect@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"unknown\",\"forcible_disconnect\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"global_suppression@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"do_not_mail\",\"global_suppression\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"greylisted@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"unknown\",\"greylisted\",\"\",\"\",\"zero\",\"
+
+bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"leading_period_removed@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"valid\",\"leading_period_removed\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"mail_server_did_not_respond@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"unknown\",\"mail_server_did_not_respond\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"mail_server_temporary_error@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"unknown\",\"mail_server_temporary_error\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"mailbox_quota_exceeded@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"invalid\",\"mailbox_quota_exceeded\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"mailbox_not_found@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"invalid\",\"mailbox_not_found\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"no_dns_entries@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"invalid\",\"no_dns_entries\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"possible_trap@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"do_not_mail\",\"possible_trap\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"possible_typo@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"invalid\",\"possible_typo\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"role_based@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"do_not_mail\",\"role_based\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"timeout_exceeded@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"unknown\",\"timeout_exceeded\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"unroutable_ip_address@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"invalid\",\"unroutable_ip_address\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"free_email@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"valid\",\"\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"True\",\"true\",\"mx.example.com\",\"example\",\"\"\n\"role_based_catch_all@example.com\",\"First\",\"Last\",\"male\",\"127.0.0.1\",\"do_not_mail\",\"role_based_catch_all\",\"\",\"\",\"zero\",\"bounce\",\"male\",\"False\",\"true\",\"mx.example.com\",\"example\",\"\"\n"
+```
+
+Eliminar archivo
+```ruby
+file_id = "75d854a6-565c-49f9-b4c8-b3344480ec4c"
+=> "75d854a6-565c-49f9-b4c8-b3344480ec4c"
+Zerobounce.validate_file_delete(file_id)
+=>
+{"success"=>true,
+ "message"=>"File Deleted",
+ "file_name"=>"validation.csv",
+ "file_id"=>"75d854a6-565c-49f9-b4c8-b3344480ec4
+
+c"}
+```
+
+##### Puntuación de IA
+
+Enviar archivo
+```ruby
+scoring_file_path = File.join(Dir.pwd, 'files', 'scoring.csv')
+=> "/home/odin/zb/wrappers/ruby-test/files/scoring.csv"
+Zerobounce.scoring_file_send(scoring_file_path)
+=>
+{"success"=>true,
+ "message"=>"File Accepted",
+ "file_name"=>"scoring.csv",
+ "file_id"=>"89fb7262-b845-4fa1-aa25-e486347ec64e"}
+### se requerirá el file_id para los próximos pasos
+### parámetros opcionales
+    email_address_column: 1,
+    has_header_row: true,
+    return_url: nil         ### URL de devolución de resultados
+### Zerobounce.scoring_file_send(scoring_file_path, email_address_column: 1)
+```
+
+Verificar archivo
+```ruby
+file_id = "89fb7262-b845-4fa1-aa25-e486347ec64e"
+=> "89fb7262-b845-4fa1-aa25-e486347ec64e"
+Zerobounce.scoring_file_check(file_id)
+=>
+{"success"=>true,
+ "file_id"=>"89fb7262-b845-4fa1-aa25-e486347ec64e",
+ "file_name"=>"scoring.csv",
+ "upload_date"=>"2023-04-28T16:57:18Z",
+ "file_status"=>"Complete",
+ "complete_percentage"=>"100% Complete.",
+ "return_url"=>nil}
+```
+
+Obtener archivo
+```ruby
+file_id = "89fb7262-b845-4fa1-aa25-e486347ec64e"
+=> "89fb7262-b845-4fa1-aa25-e486347ec64e"
+Zerobounce.scoring_file_get(file_id)
+=> "\"email\",\"ZeroBounceQualityScore\"\r\n\"disposable@example.com\",\"0\"\r\n\"invalid@example.com\",\"10\"\r\n\"valid@example.com\",\"10\"\r\n\"toxic@example.com\",\"2\"\r\n\"donotmail@example.com\",\"0\"\r\n\"spamtrap@example.com\",\"0\"\r\n\"abuse@example.com\",\"10\"\r\n\"unknown@example.com\",\"10\"\r\n\"catch_all@example.com\",\"10\"\r\n\"antispam_system@example.com\",\"0\"\r\n\"does_not_accept_mail@example.com\",\"0\"\r\n\"exception_occurred@example.com\",\"0\"\r\n\"failed_smtp_connection@example.com\",\"0\"\r\n\"failed_syntax_check@example.com\",\"0\"\r\n\"forcible_disconnect@example.com\",\"0\"\r\n\"global_suppression@example.com\",\"0\"\r\n\"greylisted@example.com\",\"0\"\r\n\"leading_period_removed@example.com\",\"0\"\r\n\"mail_server_did_not_respond@example.com\",\"0\"\r\n\"mail_server_temporary_error@example.com\",\"0\"\r\n\"mailbox_quota_exceeded@example.com\",\"0\"\r\n\"mailbox_not_found@example.com\",\"0\"\r\n\"no_dns_entries@example.com\",\"0\"\r\n\"possible_trap@example.com\",\"0\"\r\n\"possible_typo@example.com\",\"0\"\r\n\"role_based@example.com\",\"0\"\r\n\"timeout_exceeded@example.com\",\"0\"\r\n\"unroutable_ip_address@example.com\",\"0\"\r\n\"free_email@example.com\",\"0\"\r\n\"role_based_catch_all@example.com\",\"0\""
+```
+
+Eliminar archivo
+```ruby
+file_id = "89fb7262-b845-4fa1-aa25-e486347ec64e"
+
+
+=> "89fb7262-b845-4fa1-aa25-e486347ec64e"
+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
+
+Después de revisar el repositorio, ejecuta las pruebas:
+```bash
+rspec --init ### si es necesario
+bundle exec rspec
+```
+
+Deberías ver una salida como esta:
+```bash
+Run options: include {:focus=>true}
+running live tests
+.....................................................
+
+Finished in 6.81 seconds (files took 0.40587 seconds to load)
+53 examples, 0 failures
+```
+
+##### Parámetros de prueba
+Las pruebas utilizan los siguientes parámetros de entorno:
+TEST {unit|live} influye en si se ejecutan las pruebas simuladas de unidad o se utiliza el servidor en vivo (se pueden utilizar créditos si eliges hacer esto)
+ZEROBOUNCE_API_KEY {<zerobounce-api-key-value>} esta clave se utiliza para realizar solicitudes al servidor en vivo; también se utiliza en las pruebas simuladas como un ejemplo de clave válida (cualquier valor funcionará para las pruebas simuladas)
+INCORRECT_API_KEY {cualquier cadena sin espacios en blanco que no sea una clave válida} se utiliza para pruebas en las que las solicitudes deben fallar debido al valor de la clave de la API.
+
+Para configurarlos:
+```bash
+export ZEROBOUNCE_API_KEY=99e7ef20ceea4480a173b07b1be75371
+export INCORRECT_API_KEY=thiskeyisinvalidorotherwiseincorrect
+export TEST=unit
+```
+
+Se proporciona un archivo .env.sample.
+
+Las pruebas simuladas se generaron utilizando webmock y vcr. Esto significa que se realizaron solicitudes reales y se grabaron en los archivos .yml bajo spec/cassettes con una clave API válida en ese momento utilizada con fines de prueba. Sin embargo, esta clave se ha invalidado en el ínterin, pero se proporciona en el archivo .env.sample para que las pruebas simuladas funcionen. Si no desea utilizar esta clave para simulaciones, puede reemplazarla con cualquier valor en los archivos .yml bajo spec/cassettes o eliminarlos todos y volver a ejecutar las pruebas para que vcr los grabe con una nueva clave.

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,7 +27,8 @@ module Zerobounce
     attr_accessor :mock
 
     def initialize(mock=false)
-      self.host = 'https://api.zerobounce.net'
+      if File.file?(".env") then Dotenv.load(".env") else Dotenv.load end
+      self.host = 'https://api.zerobounce.in'
       self.apikey = ENV['ZEROBOUNCE_API_KEY']
       self.valid_statuses = %i[valid catch_all]
       self.headers = { user_agent: "ZerobounceRubyGem/#{Zerobounce::VERSION}" }

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.0.1'
+  VERSION = '1.1.1'
 end

data/lib/zerobounce.rb

@@ -11,7 +11,7 @@ require 'zerobounce/configuration'
 
 # Validate an email address with Zerobounce.net
 module Zerobounce
-  
+
   API_ROOT_URL      = 'https://api.zerobounce.in/v2'
   BULK_API_ROOT_URL = 'https://bulkapi.zerobounce.in/v2'
 
@@ -44,7 +44,7 @@ module Zerobounce
     #
     # @param [String] :email The email address to validate.
     # @option [String] :ip_address IP address corresponding to the email.
-    # 
+    #
     # @return [Hash]
     # {
     #   "address": "valid@example.com",
@@ -96,16 +96,16 @@ module Zerobounce
     # @param [String] email
     # @return [Boolean]
     # def invalid?(email)
-    #   # todo: 
+    #   # todo:
     #   validate(email: email).invalid?
     # end
 
-    # Get API usage 
-    # 
+    # Get API usage
+    #
     # @param [Date] start_date
     # @param [Date] end_date
-    # 
-    # @return [Hash] 
+    #
+    # @return [Hash]
     # {
     #   "total": 5,
     #   "status_valid": 4,
@@ -156,8 +156,8 @@ module Zerobounce
     # Get Activty for email
     #
     # @param [String] :email Email to get activity for
-    # 
-    # @return [Hash] 
+    #
+    # @return [Hash]
     # {
     #   "found": true,
     #   "active_in_days": "180"
@@ -168,10 +168,10 @@ module Zerobounce
     end
 
     # Validate email batch
-    # 
+    #
     # @param [Array] :emails List of email addresses to validate.
     # @option [Array] :ip_addresses Corresponding list of IP addresses.
-    # 
+    #
     # @return [Array] list of validate result for each element
     # [
     #   {
@@ -220,7 +220,7 @@ module Zerobounce
     end
 
     # Validate CSV file
-    # 
+    #
     # @param [String] :filepath Path to the file to be uploaded
     # @option [Int] :email_address_column Specify which column the email address is on
     # @option [Int] :first_name_column Specify which column the first name is on
@@ -228,7 +228,7 @@ module Zerobounce
     # @option [Int] :gender_column Specify which column the gender is on
     # @option [Int] :has_header_row Specify whether the file includes a header row or not
     # @option [Int] :return_url Specify a callback URL (if nil, no callback will be performed)
-    # 
+    #
     # @return [Hash]
     # {
     #     "success": true,
@@ -247,19 +247,19 @@ module Zerobounce
       )
       params = {
         email_address_column: email_address_column,
-        first_name_column: first_name_column,
-        last_name_column: last_name_column,
-        gender_column: gender_column,
         has_header_row: has_header_row,
       }
+      params[:first_name_column] = first_name_column if first_name_column
+      params[:last_name_column] = last_name_column if last_name_column
+      params[:gender_column] = gender_column if gender_column
       params[:return_url] = return_url if return_url
       @@request.bulk_post('sendfile', params, 'multipart/form-data', filepath)
     end
 
     # Get validate file status
-    # 
+    #
     # @param [String] :file_id Id of the file.
-    # 
+    #
     # @return [Hash]
     # {
     #     "success": true,
@@ -270,28 +270,28 @@ module Zerobounce
     #     "complete_percentage": "100%",
     #     "error_reason": null,
     #     "return_url": null
-    # }    
+    # }
     def validate_file_check(file_id)
       # todo:
       params = {file_id: file_id}
       @@request.bulk_get('filestatus', params)
     end
 
-    # Get validate results file 
-    # 
+    # Get validate results file
+    #
     # @param [String] :file_id Id of the file.
-    # 
-    # @return [String/File?] 
+    #
+    # @return [String/File?]
     def validate_file_get(file_id)
       # todo:
       params = {file_id: file_id}
       @@request.bulk_get('getfile', params)
     end
 
-    # Delete validate file 
-    # 
+    # Delete validate file
+    #
     # @param file_id Id of the file.
-    # 
+    #
     # @return [Hash]
     # {
     #   "success": true,
@@ -306,12 +306,12 @@ module Zerobounce
     end
 
     # Score CSV file
-    # 
+    #
     # @param [String] :filepath Path to the file to be uploaded
     # @option [Int] :email_address_column Specify which column the email address is on
     # @option [Int] :has_header_row Specify whether the file includes a header row or not
     # @option [Int] :return_url Specify a callback URL (if nil, no callback will be performed)
-    # 
+    #
     # @return [Hash]
     # {
     #     "success": true,
@@ -333,11 +333,11 @@ module Zerobounce
       @@request.bulk_post('scoring/sendfile', params, 'multipart/form-data', filepath)
     end
 
-    # Get validate results file 
-    # 
+    # Get validate results file
+    #
     # @param [String] :file_id Id of the file.
-    # 
-    # @return [String/File?] 
+    #
+    # @return [String/File?]
     def scoring_file_get(file_id)
       # todo:
       params = {file_id: file_id}
@@ -345,9 +345,9 @@ module Zerobounce
     end
 
     # Get validate file status
-    # 
+    #
     # @param [String] :file_id Id of the file.
-    # 
+    #
     # @return [Hash]
     # {
     #   "success": true,
@@ -357,16 +357,16 @@ module Zerobounce
     #   "file_status": "Complete",
     #   "complete_percentage": "100% Complete.",
     #   "return_url": null
-    # } 
+    # }
     def scoring_file_check(file_id)
       params = {file_id: file_id}
       @@request.bulk_get('scoring/filestatus', params)
     end
 
-    # Delete validate file 
-    # 
+    # Delete validate file
+    #
     # @param file_id Id of the file.
-    # 
+    #
     # @return [Hash]
     # {
     #   "success": true,
@@ -375,10 +375,73 @@ module Zerobounce
     #   "file_id": "6d44a908-7283-42a9-aa5f-9e57b16f84bd"
     # }
     def scoring_file_delete(file_id)
-      # todo:
       params = {file_id: file_id}
       @@request.bulk_get('scoring/deletefile', params)
     end
 
+    # Guess email formatDomain to guess format for
+    #
+    # @param [String] domain Domain to guess format for
+    #
+    # @option [String] first_name   First name of target.
+    # @option [String] middle_name  Middle name of target.
+    # @option [String] last_name    Last name of target.
+    #
+    # @return [Hash]
+    # {
+    # 	"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"}
+    #    ]
+    # }
+    def guessformat(domain, first_name: '', middle_name: '', last_name: '')
+      params = {
+        domain: domain
+      }
+      unless first_name.empty?
+        params['first_name'] = first_name
+      end
+      unless middle_name.empty?
+        params['middle_name'] = middle_name
+      end
+      unless last_name.empty?
+        params['last_name'] = last_name
+      end
+
+      @@request.get('guessformat', params)
+    end
+
   end
 end

data/zerobounce.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.required_ruby_version = '>= 2.5'
 
   spec.add_dependency 'rest-client', '~>2.1'
+  spec.add_dependency 'dotenv', '~> 2.8.1'
 
   spec.add_development_dependency 'bundler', '~> 2.4.6'
   spec.add_development_dependency 'pry', '~> 0.14.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zerobounceindia-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Zero Bounce India
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-13 00:00:00.000000000 Z
+date: 2024-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -231,13 +245,14 @@ files:
 - LICENSE
 - LICENSE.txt
 - README.md
-- README_es.md
 - Rakefile
 - bin/bundle
 - bin/console
 - bin/setup
 - data/zerobounce-ai-scoring.csv
 - data/zerobounce-batch-validation.csv
+- documentation.md
+- documentation_es.md
 - files/scoring.csv
 - files/validation.csv
 - files/zerobounce-ai-scoring.csv