verifalia 1.1.0 → 2.0.0

data/lib/verifalia/security/username_password_authenticator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Verifalia
+  module Security
+    # Allows to authenticate to Verifalia with a username and password pair.
+    class UsernamePasswordAuthenticator
+      def initialize(username, password = nil)
+        if username.nil? || username.strip.length == 0
+          raise ArgumentError, 'username is nil or empty: please visit https://verifalia.com/client-area to set up a new user, if you don\'t have one.'
+        end
+
+        @username = username
+        @password = password || ''
+      end
+
+      def authenticate(connection, request)
+        header = Faraday::Utils.basic_header_from(@username, @password)
+        request.headers[Faraday::Request::Authorization::KEY] = header
+      end
+    end
+  end
+end

data/lib/verifalia.rb

@@ -1,27 +1,12 @@
-require 'builder'
-require 'forwardable'
+# frozen_string_literal: true
 
-require 'verifalia/version'
-require 'verifalia/util/configuration'
+require_relative 'verifalia/client'
 
-require 'rest/client'
+require_relative 'verifalia/security/username_password_authenticator'
+require_relative 'verifalia/security/certificate_authenticator'
 
-module Verifalia
-  extend SingleForwardable
-
-  def_delegators :configuration, :account_sid, :auth_token
+require_relative 'verifalia/email_validation/client'
+require_relative 'verifalia/credits/client'
 
-  ##
-  # Pre-configure with account SID and auth token so that you don't need to
-  # pass them to various initializers each time.
-  def self.configure(&block)
-    yield configuration
-  end
-
-  ##
-  # Returns an existing or instantiates a new configuration object.
-  def self.configuration
-    @configuration ||= Util::Configuration.new
-  end
-  private_class_method :configuration
-end
+module Verifalia
+end

data/sig/completion_callback.rbs

@@ -0,0 +1,5 @@
+class CompletionCallback
+  attr_accessor skip_server_certificate_validation: bool | nil
+  attr_accessor url: String
+  attr_accessor version: String | nil
+end

data/sig/verifalia/client.rbs

@@ -0,0 +1,11 @@
+module Verifalia
+  class Client
+    VERSION: String
+
+    @base_urls: Array[String]
+    @rest_client: Rest::Client
+
+    attr_reader credits: Credits::Client
+    attr_reader email_validations: EmailValidations::Client
+  end
+end

data/sig/verifalia/credits/balance.rbs

@@ -0,0 +1,11 @@
+module Verifalia
+  module Credits
+    class Balance
+      def self.from_json: (Hash[String, untyped]) -> Balance
+
+      attr_reader credit_packs: BigDecimal
+      attr_reader free_credits: BigDecimal | nil
+      attr_reader free_credits_reset_in: String | nil
+    end
+  end
+end

data/sig/verifalia/credits/client.rbs

@@ -0,0 +1,7 @@
+module Verifalia
+  module Credits
+    class Client
+      def get_balance: -> Balance
+    end
+  end
+end

data/sig/verifalia/email_validations/client.rbs

@@ -0,0 +1,24 @@
+module Verifalia
+  module EmailValidations
+    class Client
+      @rest_client: Rest::Client
+
+      def delete: (String) -> void
+      def export: (String, String) -> String
+      def get: (String, wait_options: WaitOptions) -> (Job | nil)
+      def submit: ((String | Array[String] | Array[RequestEntry] | Array[Hash[String, untyped]] | RequestEntry | Request),
+          quality: String,
+          priority: (Integer | nil),
+          deduplication: String,
+          name: String,
+          retention: String,
+          completion_callback: CompletionCallback | Hash[String, untyped] | nil,
+          wait_options: WaitOptions) -> (Job | nil)
+
+      private
+
+      def build_job: -> Job
+      def wait_for_completion: (Job, WaitOptions) -> (Job | nil)
+    end
+  end
+end

data/sig/verifalia/email_validations/entry.rbs

@@ -0,0 +1,22 @@
+module Verifalia
+  module EmailValidations
+    class Entry
+      attr_reader completed_on: DateTime
+      attr_reader custom: String | nil
+      attr_reader duplicate_of: Integer | nil
+      attr_reader email_address: String | nil
+      attr_reader email_address_domain_part: String | nil
+      attr_reader email_address_local_part: String | nil
+      attr_reader has_international_domain_name: bool | nil
+      attr_reader has_international_mailbox_name: bool | nil
+      attr_reader index: Integer
+      attr_reader input_data: String
+      attr_reader classification: String
+      attr_reader is_disposable_email_address: bool | nil
+      attr_reader is_free_email_address: bool | nil
+      attr_reader is_role_account: bool | nil
+      attr_reader status: String
+      attr_reader syntax_failure_index: Integer | nil
+    end
+  end
+end

data/sig/verifalia/email_validations/job.rbs

@@ -0,0 +1,13 @@
+module Verifalia
+  module EmailValidations
+    class Job
+      @entries: Array[Entry]
+      @overview: Overview
+
+      def self.from_json: (Hash[String, untyped]) -> Job
+
+      attr_reader entries: Array[Entry]
+      attr_reader overview: Overview
+    end
+  end
+end

data/sig/verifalia/email_validations/overview.rbs

@@ -0,0 +1,20 @@
+module Verifalia
+  module EmailValidations
+    class Overview
+      attr_reader client_ip: IPAddr
+      attr_reader completed_on: (DateTime | nil)
+      attr_reader created_on: DateTime
+      attr_reader deduplication: String
+      attr_reader id: String
+      attr_reader name: String
+      attr_reader no_of_entries: Integer
+      attr_reader owner: String
+      attr_reader priority: (Integer | nil)
+      attr_reader progress: (Progress | nil)
+      attr_reader quality: String
+      attr_reader retention: String
+      attr_reader status: String
+      attr_reader submitted_on: DateTime
+    end
+  end
+end

data/sig/verifalia/email_validations/progress.rbs

@@ -0,0 +1,8 @@
+module Verifalia
+  module EmailValidations
+    class Progress
+      attr_reader estimated_time_remaining: String
+      attr_reader percentage: Float
+    end
+  end
+end

data/sig/verifalia/email_validations/request.rbs

@@ -0,0 +1,13 @@
+module Verifalia
+  module EmailValidations
+    class Request
+      attr_accessor callback: CompletionCallback | nil
+      attr_accessor deduplication: String | nil
+      attr_accessor entries: Array[RequestEntry]
+      attr_accessor name: String | nil
+      attr_accessor priority: Integer | nil
+      attr_accessor quality: String | nil
+      attr_accessor retention: String | nil
+    end
+  end
+end

data/sig/verifalia/email_validations/request_entry.rbs

@@ -0,0 +1,8 @@
+module Verifalia
+  module EmailValidations
+    class RequestEntry
+      attr_accessor custom: String
+      attr_accessor input_data: String
+    end
+  end
+end

data/sig/verifalia/email_validations/wait_options.rbs

@@ -0,0 +1,20 @@
+module Verifalia
+  module EmailValidations
+    class WaitOptions
+      @@default: WaitOptions
+      @@no_wait: WaitOptions
+      @submission_wait_time: Integer
+      @poll_wait_time: Integer
+
+      def self.default: -> WaitOptions
+      def self.no_wait: -> WaitOptions
+
+      attr_reader poll_wait_time: Integer
+      attr_reader progress: (^(Overview) -> void) | nil
+      attr_reader submission_wait_time: Integer
+
+      def initialize: (Integer, Integer) -> WaitOptions
+      def wait_for_next_poll: (Job) -> void
+    end
+  end
+end

data/sig/verifalia/rest/client.rbs

@@ -0,0 +1,12 @@
+module Verifalia
+  module Rest
+    class Client
+      @base_urls: Array[String]
+      @current_base_url_idx: Integer
+
+      @user_agent: String
+
+      def invoke: (String, String, (Hash[String, untyped] | nil)) -> untyped # Faraday::Response
+    end
+  end
+end

data/sig/verifalia/rest.rbs

@@ -0,0 +1,6 @@
+module Verifalia
+  module Rest
+    BASE_CCA_URLS: Array[String]
+    BASE_URLS: Array[String]
+  end
+end

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', '> 1.8.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'
 end

metadata

@@ -1,57 +1,47 @@
 --- !ruby/object:Gem::Specification
 name: verifalia
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Verifalia
+- Efran Cobisi
+- Guido Tersilli
+- Rudy Chiappetta
+- Germano Mosconi
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-07-22 00:00:00.000000000 Z
+date: 2023-03-12 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: 1.8.0
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.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
@@ -66,8 +56,9 @@ dependencies:
     - - ">="
       - !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.
+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,54 +66,65 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- lib/rest/client.rb
-- lib/rest/email_validations.rb
 - lib/verifalia.rb
-- lib/verifalia/util/configuration.rb
-- lib/verifalia/version.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/job.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/job.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/username_password_authenticator.rbs
 - verifalia.gemspec
-homepage: http://verifalia.com
+homepage: https://verifalia.com/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://verifalia.com/
+  source_code_uri: https://github.com/verifalia/verifalia-ruby-sdk.git
 post_install_message: 
-rdoc_options:
-- "--line-numbers"
-- "--inline-source"
-- "--title"
-- "--main"
-- README.md
+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
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
-summary: Verifalia API wrapper (email validation, list cleaning and scrubbing)
-test_files:
-- 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,23 +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

data/lib/rest/client.rb

@@ -1,75 +0,0 @@
-require 'rest/email_validations'
-
-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 = {
-        host: 'https://api.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
-
-    end
-  end
-end