zerobounce-sdk 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce3b4157b9478ba02c42a325862699aa7679b4270504ac7cc5448f5b7d4538fe
-  data.tar.gz: f95a6733dc75b74bcf4fcfc341eb84baa4e539ea54eaf70ac38d64fe2aa63655
+  metadata.gz: f187873eefae835fa3cf0d83ee742ecac903880e67162f81b553e1a288170d2c
+  data.tar.gz: d169d4722b1fbfef58486a6495e144164fc5d1e2ca25d3c7d40ac691627cd39e
 SHA512:
-  metadata.gz: 3e0382eb10b8a5aac8edfdd6fedf4c50ab6de72333f5f648f0d9cac64d41af67412cf8dfbd77ba10731f1185b05f2c84b252bb25a2bd98a1827fc55397b77c1a
-  data.tar.gz: b9213e632058dd88944cb0499d6dfbdbf343138547296644a3843ef7e860d59fc808c7b8429ec3c86df81a971cf1891006c61a7982aeae9ba236789a9dd36b0f
+  metadata.gz: cf05baf952979ea120118261ff907528188e6d50677ad40390159338db8d830918d9064399443ad0d3d08cd2f174bed769466965660e4b8c11e568aaa3f2a6d8
+  data.tar.gz: 689c70548c2b6b700ebc9b48cc8326ff8f7bd0e61713f48ad73c1fda9cbb003e448117678161a5a8dcb320da05343263945cb58ca2cb767b1e3a11d1311c1b65

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zerobounce (0.4.0)
+    zerobounce-sdk (1.1.0)
       rest-client (~> 2.1)
 
 GEM
@@ -23,9 +23,9 @@ GEM
       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 +115,7 @@ DEPENDENCIES
   vcr (~> 6.1.0)
   webmock (~> 3.18)
   yard (~> 0.9.26)
-  zerobounce!
+  zerobounce-sdk!
 
 BUNDLED WITH
    2.4.6

data/{README_es.md → documentation.md}

@@ -1,8 +1,4 @@
-
-# Zerobounce
-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 'zerobounce-sdk'
@@ -39,7 +35,13 @@ Zerobounce.config.apikey = '<zerobounce-api-key>'
 Credits
 ```ruby
 Zerobounce.credits
-=> 79   # returns -1 for invalid key
+=> 79   ### returns -1 for invalid key
+```
+
+Activity
+```ruby
+Zerobounce.activity('ss@gmail.com')
+=> {"found"=>true, "active_in_days"=>"180"}
 ```
 
 Usage statistics
@@ -82,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', '192.168.0.1') # optional IP address
 =>
 {"address"=>"valid@example.com",
  "status"=>"valid",
@@ -121,9 +123,9 @@ emails
  "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)
 =>
@@ -243,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)
@@ -256,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
@@ -303,7 +305,7 @@ Zerobounce.validate_file_delete(file_id)
  "file_id"=>"75d854a6-565c-49f9-b4c8-b3344480ec4c"}
 ```
 
-### AI Scoring
+##### AI Scoring
 
 Send file
 ```ruby
@@ -315,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
@@ -355,11 +357,11 @@ Zerobounce.validate_file_delete(file_id)
 ```
 
 
-## Development
+#### Development
 
 After checking out the repo run tests
 ```bash
-rspec --init # if needed
+rspec --init ### if needed
 bundle exec rspec
 ```
 
@@ -373,7 +375,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,405 @@
+#### 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."}
+```
+
+
+#### 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/version.rb

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

data/lib/zerobounce.rb

@@ -375,10 +375,27 @@ 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
 
+
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zerobounce-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Zero Bounce
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-13 00:00:00.000000000 Z
+date: 2023-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -231,13 +231,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