zerobounce-sdk 1.0.1 → 1.1.1

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.net/v2'
   BULK_API_ROOT_URL = 'https://bulkapi.zerobounce.net/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: zerobounce-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Zero Bounce
 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
@@ -249,8 +264,6 @@ files:
 - lib/zerobounce/mock_request.rb
 - lib/zerobounce/request.rb
 - lib/zerobounce/version.rb
-- output.err
-- output.log
 - zerobounce.gemspec
 homepage: https://zerobounce.net
 licenses: