verifalia 1.2.0 → 2.1.0

data/sig/verifalia/security/username_password_authenticator.rbs

@@ -0,0 +1,10 @@
+module Verifalia
+  module Security
+    class UsernamePasswordAuthenticator
+      @password: String | nil
+      @username: String
+
+      def authenticate: -> void
+    end
+  end
+end

data/verifalia.gemspec

@@ -1,29 +1,38 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'verifalia/version'
+require 'verifalia/client'
 
 Gem::Specification.new do |spec|
-  spec.name          = "verifalia"
-  spec.version       = Verifalia::VERSION
-  spec.authors       = ["Verifalia"]
-  spec.email         = ["support@verifalia.com"]
-  spec.summary       = "Verifalia API wrapper (email validation, list cleaning and scrubbing)"
-  spec.description   = "A simple library for communicating with the Verifalia RESTful API, validating lists of email addresses and checking whether or not they are deliverable."
-  spec.homepage      = "http://verifalia.com"
-  spec.license       = "MIT"
+  spec.name          = 'verifalia'
+  spec.version       = Verifalia::Client::VERSION
+  spec.authors       = ['Verifalia', 'Efran Cobisi', 'Guido Tersilli', 'Rudy Chiappetta', 'Germano Mosconi']
+  spec.email         = ['support@verifalia.com']
+  spec.summary       = 'Verifalia - Ruby SDK and helper library'
+  spec.description   = 'Verifalia provides a simple API for validating email addresses and checking whether they are deliverable or not. This library allows to easily integrate with Verifalia and verify email addresses in real-time.'
+  spec.homepage      = 'https://verifalia.com/'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/verifalia/verifalia-ruby-sdk.git'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
   spec.extra_rdoc_files = ['README.md']
-  spec.rdoc_options = ['--line-numbers', '--inline-source', '--title', '--main', 'README.md']
 
-  spec.add_dependency('builder', '>= 2.1.2')
-  spec.add_dependency('rest-client', '>= 2.0.0')
+  spec.add_dependency('faraday', '~> 2.7')
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 2.4.8'
+  spec.add_development_dependency 'rake', '~> 13.0'
 end

metadata

@@ -1,73 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: verifalia
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Verifalia
-autorequire: 
-bindir: bin
+- Efran Cobisi
+- Guido Tersilli
+- Rudy Chiappetta
+- Germano Mosconi
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: builder
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.2
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 2.4.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 2.4.8
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: A simple library for communicating with the Verifalia RESTful API, validating
-  lists of email addresses and checking whether or not they are deliverable.
+        version: '13.0'
+description: Verifalia provides a simple API for validating email addresses and checking
+  whether they are deliverable or not. This library allows to easily integrate with
+  Verifalia and verify email addresses in real-time.
 email:
 - support@verifalia.com
 executables: []
@@ -75,57 +66,74 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- lib/rest/account_balance.rb
-- lib/rest/client.rb
-- lib/rest/email_validations.rb
 - lib/verifalia.rb
-- lib/verifalia/util/configuration.rb
-- lib/verifalia/version.rb
-- spec/rest/account_balance_spec.rb
-- spec/rest/client_spec.rb
-- spec/rest/email_validations_spec.rb
-- spec/spec_helper.rb
-- spec/util/configuration_spec.rb
-- spec/verifalia_spec.rb
+- lib/verifalia/client.rb
+- lib/verifalia/credits/balance.rb
+- lib/verifalia/credits/client.rb
+- lib/verifalia/email_validation/client.rb
+- lib/verifalia/email_validation/completion_callback.rb
+- lib/verifalia/email_validation/entry.rb
+- lib/verifalia/email_validation/entry_classification.rb
+- lib/verifalia/email_validation/entry_status.rb
+- lib/verifalia/email_validation/exported_entries_format.rb
+- lib/verifalia/email_validation/job.rb
+- lib/verifalia/email_validation/job_status.rb
+- lib/verifalia/email_validation/overview.rb
+- lib/verifalia/email_validation/progress.rb
+- lib/verifalia/email_validation/request.rb
+- lib/verifalia/email_validation/request_entry.rb
+- lib/verifalia/email_validation/wait_options.rb
+- lib/verifalia/rest/client.rb
+- lib/verifalia/security/certificate_authenticator.rb
+- lib/verifalia/security/username_password_authenticator.rb
+- sig/completion_callback.rbs
+- sig/verifalia/client.rbs
+- sig/verifalia/credits/balance.rbs
+- sig/verifalia/credits/client.rbs
+- sig/verifalia/email_validations/client.rbs
+- sig/verifalia/email_validations/entry.rbs
+- sig/verifalia/email_validations/entry_classification.rbs
+- sig/verifalia/email_validations/entry_status.rbs
+- sig/verifalia/email_validations/exported_entries_format.rbs
+- sig/verifalia/email_validations/job.rbs
+- sig/verifalia/email_validations/job_status.rbs
+- sig/verifalia/email_validations/overview.rbs
+- sig/verifalia/email_validations/progress.rbs
+- sig/verifalia/email_validations/request.rbs
+- sig/verifalia/email_validations/request_entry.rbs
+- sig/verifalia/email_validations/wait_options.rbs
+- sig/verifalia/rest.rbs
+- sig/verifalia/rest/client.rbs
+- sig/verifalia/security/certificate_authenticator.rbs
+- sig/verifalia/security/username_password_authenticator.rbs
 - verifalia.gemspec
-homepage: http://verifalia.com
+homepage: https://verifalia.com/
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
-rdoc_options:
-- "--line-numbers"
-- "--inline-source"
-- "--title"
-- "--main"
-- README.md
+metadata:
+  homepage_uri: https://verifalia.com/
+  source_code_uri: https://github.com/verifalia/verifalia-ruby-sdk.git
+post_install_message:
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
-summary: Verifalia API wrapper (email validation, list cleaning and scrubbing)
-test_files:
-- spec/rest/account_balance_spec.rb
-- spec/rest/client_spec.rb
-- spec/rest/email_validations_spec.rb
-- spec/spec_helper.rb
-- spec/util/configuration_spec.rb
-- spec/verifalia_spec.rb
+summary: Verifalia - Ruby SDK and helper library
+test_files: []

data/.gitignore

@@ -1,24 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-.rvmrc
-test.rb

data/lib/rest/account_balance.rb

@@ -1,93 +0,0 @@
-require 'rest_client'
-require 'json'
-module Verifalia
-  module REST
-    class AccountBalance
-      ##
-      # The Verifalia::REST::AccountBalance class allow you to comminucate
-      # with Account balance Api. You don't need to instantiate this class, but
-      # use the client for autoconfiguration. # The +args+ parameter is a hash of configuration
-      def initialize(config, account_sid, account_token, args = {})
-        @resources = build_resources(config, account_sid, account_token)
-      end
-
-      ##
-      # Query the Account balance
-      #
-      def balance()
-        begin
-          response = multiplex_request do |resource|
-            resource[@unique_id].get
-          end
-          @error = nil
-          JSON.parse(response)
-        rescue => e
-          compute_error(e)
-          false
-        end
-      end
-
-      def error
-        @error
-      end
-
-      private
-
-        def multiplex_request
-          @resources.shuffle.each do |resource|
-            begin
-              response = yield(resource)
-              return response
-            rescue => e
-              if ((e.is_a? RestClient::Exception) && (e.http_code != 500))
-                raise e
-              end
-            end
-          end
-          raise RestClient::Exception.new(nil, 500)
-        end
-
-        def compute_error(e)
-          unless e.is_a? RestClient::Exception
-            @error = :internal_server_error
-          end
-
-          case e.http_code
-            when 400
-              @error = :bad_request
-            when 401
-              @error = :unauthorized
-            when 402
-              @error = :payment_required
-            when 403
-              @error = :forbidden
-            when 404
-              @error = :not_found
-            when 406
-              @error = :not_acceptable
-            when 410
-              @error = :gone
-            when 429
-              @error = :too_many_request
-            else
-              @error = :internal_server_error
-            end
-        end
-
-        def build_resources(config, account_sid, account_token)
-          opts = {
-            user: account_sid,
-            password: account_token,
-            headers: {
-              content_type: :json,
-              user_agent: "verifalia-rest-client/ruby/#{Verifalia::VERSION}"
-            }
-          }
-          config[:hosts].map do |host|
-            api_url = "#{host}/#{config[:api_version]}/account-balance"
-            RestClient::Resource.new api_url, opts
-          end
-        end
-    end
-  end
-end

data/lib/rest/client.rb

@@ -1,83 +0,0 @@
-require 'rest/email_validations'
-require 'rest/account_balance'
-
-module Verifalia
-  module REST
-    ##
-    # The Verifalia::REST::Client class caches authentication parameters and
-    # exposes methods to make HTTP requests to Verifalia's REST API. However, you
-    # should never really need to call these methods yourself since you can
-    # work with the more pleasant wrapper objects like Verifalia::REST::EmailValidations
-    #
-    # Instantiate a client like so:
-    #
-    #   @client = Verifalia::REST::Client.new account_sid, auth_token
-    #
-
-    # Once you have a client object you can use it to do fun things. Every
-    # client object exposes a wrapper for a specific API. For example:
-    #
-    # ==== @client.email_validations
-    #
-    class Client
-
-      attr_reader :account_sid, :account_token
-
-      API_VERSION = 'v1.4'
-
-      DEFAULTS = {
-        hosts: ['https://api-1.verifalia.com', 'https://api-2.verifalia.com'],
-        api_version: 'v1.4'
-      }
-
-      ##
-      # Instantiate a new HTTP client to talk to Verifalia. The parameters
-      # +account_sid+ and +auth_token+ are required, unless you have configured
-      # them already using the block configure syntax, and used to generate the
-      # HTTP basic auth header in each request. The +args+ parameter is a
-      # hash of connection configuration options. the following keys are
-      # supported:
-      #
-      # === <tt>host: 'https://api.verifalia.com'</tt>
-      #
-      # === <tt>api_version: 'v1.1'</tt>
-      #
-      def initialize(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        @config = DEFAULTS.merge! options
-        @account_sid = args[0] || Verifalia.account_sid
-        @auth_token = args[1] || Verifalia.auth_token
-
-        if @account_sid.nil? || @auth_token.nil?
-          raise ArgumentError, 'Account SID and auth token are required'
-        end
-
-      end
-
-      ##
-      # Instantiate a new HTTP client to talk to Verifalia Email Validation Api.
-      # The +args+ parameter is a hash of configuration
-      # The following keys are supported:
-      #
-      # === <tt>unique_id: 'example-example'</tt>
-      #
-      # The unique if of the Verifalia Email Validation resource
-      #
-      def email_validations(args = {})
-        if (args.empty?)
-          @email_validations ||= EmailValidations.new @config, @account_sid, @auth_token
-        else
-          EmailValidations.new @config, @account_sid, @auth_token, args
-        end
-      end
-
-      ##
-      # Instantiate a new HTTP client to talk to Verifalia Account Balance Api.
-      #
-      def account_balance()
-        @account_balance ||= AccountBalance.new @config, @account_sid, @auth_token
-      end
-
-    end
-  end
-end

data/lib/rest/email_validations.rb

@@ -1,195 +0,0 @@
-require 'rest_client'
-require 'json'
-module Verifalia
-  module REST
-    class EmailValidations
-
-      COMPLETION_MAX_RETRY = 5
-      COMPLETION_INTERVAL = 1
-      ##
-      # The Verifalia::REST::EmailValidations class allow you to comminucate
-      # with Email Validations Api. You don't need to instantiate this class, but
-      # use the client for autoconfiguration. # The +args+ parameter is a hash of configuration
-      # The following keys are supported:
-      #
-      # === <tt>unique_id: 'example-example'</tt>
-      #
-      # The unique if of the Verifalia Email Validation resource
-      #
-      def initialize(config, account_sid, account_token, args = {})
-        @resources = build_resources(config, account_sid, account_token)
-        @unique_id = args[:unique_id] if args[:unique_id]
-      end
-
-      ##
-      # Query the Email Validations Api with:
-      #
-      # === <tt> inputs: ['test@test.com']
-      # === <tt> inputs: data = [{ inputData: 'first@first.it' }, { inputData: 'first@first.it' } ]
-      # === <tt> options: { quality: 'high', priority: 100, deduplication: 'safe' } view verifalia API documentation
-      #
-      # An array of emails to validate
-      #
-      def verify(inputs, options = {})
-        raise ArgumentError, 'inputs must be not empty' if (inputs.nil? || inputs.empty?)
-        raise ArgumentError, 'options must be hash' if (!options.is_a?(Hash))
-        data = inputs.map do |input|
-          if (input.is_a? String)
-            { inputData: input }
-          elsif (input.is_a? Hash)
-            raise ArgumentError, 'if inputs content is a Hash you need to supply :inputData as key' if (!input.has_key?(:inputData))
-            input
-          else
-            raise ArgumentError, 'inputs content must be a String or a Hash'
-          end
-        end
-        content = ({ entries: data }.merge(options)).to_json
-        begin
-          @response = multiplex_request do |resource|
-            resource.post content
-          end
-          @query_result = JSON.parse(@response)
-          @unique_id = @query_result["uniqueID"]
-          @error = nil
-          @unique_id
-        rescue => e
-          compute_error(e)
-          false
-        end
-      end
-
-      ##
-      # Query the Email Validations Api for specific result. In order to use
-      # this method you need to supply unique_id uring initialization or call verify first. If request fail,
-      # you can call <tt>error</tt> to receive detailed information
-      #
-      # === <tt> options: { wait_for_completion: true, completion_max_retry: 5, completion_interval: 1(seconds) }
-      def query(options = {})
-        raise ArgumentError, 'You must call verify first or supply and uniqueId' unless @unique_id
-        opts = {
-          wait_for_completion: false,
-          completion_max_retry: COMPLETION_MAX_RETRY,
-          completion_interval: COMPLETION_INTERVAL,
-          }
-          .merge! options
-        if @query_result == nil || !completed?
-          begin
-            loop_count = 0
-            loop do
-              @response = multiplex_request do |resource|
-                resource[@unique_id].get
-              end
-              @query_result = JSON.parse(@response)
-              @error = nil
-              loop_count += 1
-              sleep opts[:completion_interval] if opts[:wait_for_completion]
-              break if !opts[:wait_for_completion] || (completed? || loop_count >= opts[:completion_max_retry])
-            end
-          rescue => e
-            compute_error(e)
-            return false
-          end
-        end
-        if (opts[:wait_for_completion] && !completed?)
-          @error = :not_completed
-          false
-        else
-          @query_result
-        end
-      end
-
-      ##
-      # Destroy an Email Validations entity. In order to use
-      # this method you need to supply unique_id during initialization or call verify first. If request fail,
-      # you can call <tt>error</tt> to receive detailed information
-      #
-      def destroy
-        raise ArgumentError, 'You must call verify first or supply and uniqueId' unless @unique_id
-        begin
-          r = multiplex_request do |resource|
-            resource[@unique_id].delete
-          end
-          @error = nil
-          @response = nil
-          @query_result = nil
-          @unique_id = nil
-          true
-        rescue => e
-          return true if (e.is_a? RestClient::Exception && e.http_code == 410)
-          compute_error(e)
-          return false
-        end
-      end
-
-      ##
-      # Check if the Email validation entity is completed processed. In order to use
-      # this method you need to supply unique_id during initialization or call verify first.
-      #
-      def completed?
-        @response.code == 200
-      end
-
-      def error
-        @error
-      end
-
-      private
-
-        def multiplex_request
-          @resources.shuffle.each do |resource|
-            begin
-              response = yield(resource)
-              return response
-            rescue => e
-              if ((e.is_a? RestClient::Exception) && (e.http_code != 500))
-                raise e
-              end
-            end
-          end
-          raise RestClient::Exception.new(nil, 500)
-        end
-
-        def compute_error(e)
-          unless e.is_a? RestClient::Exception
-            @error = :internal_server_error
-          end
-
-          case e.http_code
-            when 400
-              @error = :bad_request
-            when 401
-              @error = :unauthorized
-            when 402
-              @error = :payment_required
-            when 403
-              @error = :forbidden
-            when 404
-              @error = :not_found
-            when 406
-              @error = :not_acceptable
-            when 410
-              @error = :gone
-            when 429
-              @error = :too_many_request
-            else
-              @error = :internal_server_error
-            end
-        end
-
-        def build_resources(config, account_sid, account_token)
-          opts = {
-            user: account_sid,
-            password: account_token,
-            headers: {
-              content_type: :json,
-              user_agent: "verifalia-rest-client/ruby/#{Verifalia::VERSION}"
-            }
-          }
-          config[:hosts].map do |host|
-            api_url = "#{host}/#{config[:api_version]}/email-validations"
-            RestClient::Resource.new api_url, opts
-          end
-        end
-    end
-  end
-end

data/lib/verifalia/util/configuration.rb

@@ -1,7 +0,0 @@
-module Verifalia
-  module Util
-    class Configuration
-      attr_accessor :account_sid, :auth_token, :hosts
-    end
-  end
-end

data/lib/verifalia/version.rb

@@ -1,3 +0,0 @@
-module Verifalia
-  VERSION = "1.2.0"
-end