validatemail 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2cf96d6c64ed3589ccb30bdc24617a2769cc48b449b3b1ccbf52947bce1f7bd7
+  data.tar.gz: f35e605affa914372bc060954b81fe9b447fa880c1bd70f264b52f21cd004850
+SHA512:
+  metadata.gz: 8db378bd246095c716b60fab890a223cada22955f19202c3c6d25f4ea840816e444ae88102bfbf87fd302868541be8d46f5de6e45765ab1fb37573e35f8989c8
+  data.tar.gz: 906e6dc6939f2810a7ced0c4fe050b4448f56bbbbc90ee705fee71da4c11459ca9abeb5da96bcd242c8688ca767a1f52c72a7631a97a7b1ae8c1379d5b28237b

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/validatemail/agent/a_base.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Validatemail
+  module Agent
+    class ABase
+      def initialize(email)
+        @email = email
+        @config = ::Validatemail::Config.new
+      end
+
+      def data
+        return @data if defined?(@data)
+
+        @data = Validatemail::Struct.new(
+          email: email,
+          autocorrect: autocorrect,
+          score: score,
+          valid: valid,
+          free: free,
+          first_name: first_name,
+          last_name: last_name,
+          validated_by: self.class.name.demodulize,
+        )
+      end
+
+      def ok?
+        api_url.present? &&
+          api_key.present? &&
+          http.code.between?(200, 299) &&
+          data.is_a?(Validatemail::Struct)
+      rescue StandardError => _e
+        false
+      end
+
+      def body
+        return @body if defined?(@body)
+
+        @body = JSON.parse(http.body).deep_symbolize_keys
+      end
+
+      def http
+        @http ||= HTTParty.get(
+          request_url,
+          headers: request_headers,
+          query: request_query,
+        )
+      end
+
+      def request_url
+        api_url
+      end
+
+      def request_headers
+        {}
+      end
+
+      def request_query
+        {}
+      end
+
+      private
+
+      attr_reader :email, :config
+
+      def api_url
+        config.public_send("#{name}_url")
+      end
+
+      def api_key
+        config.public_send("#{name}_api_key")
+      end
+
+      def name
+        self.class.name.demodulize.downcase
+      end
+    end
+  end
+end

data/lib/validatemail/agent/abstract.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Validatemail
+  module Agent
+    class Abstract < Validatemail::Agent::ABase
+      PRIORITY = 0
+      VALID = "DELIVERABLE"
+
+      def autocorrect
+        body[:autocorrect]
+      end
+
+      def score
+        body[:quality_score].to_f
+      end
+
+      def first_name
+        nil
+      end
+
+      def last_name
+        nil
+      end
+
+      def free
+        body[:is_free_email][:value]
+      end
+
+      def valid
+        body[:is_valid_format][:value] && body[:is_smtp_valid][:value] && body[:deliverability] == VALID
+      end
+
+      def request_query
+        { api_key: api_key, email: email }
+      end
+    end
+  end
+end

data/lib/validatemail/agent/apilayer.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Validatemail
+  module Agent
+    class Apilayer < Validatemail::Agent::ABase
+      PRIORITY = 0
+
+      def autocorrect
+        body[:did_you_mean]
+      end
+
+      def score
+        body[:score].to_f
+      end
+
+      def first_name
+        nil
+      end
+
+      def last_name
+        nil
+      end
+
+      def free
+        body[:free]
+      end
+
+      def valid
+        body[:syntax_valid] && body[:is_deliverable] && body[:can_connect_smtp]
+      end
+
+      def request_url
+        "#{api_url}/#{email}"
+      end
+
+      def request_headers
+        { apikey: api_key }
+      end
+    end
+  end
+end

data/lib/validatemail/agent/hunter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Validatemail
+  module Agent
+    class Hunter < Validatemail::Agent::ABase
+      PRIORITY = 1
+      VALID = "valid"
+
+      def autocorrect
+        nil
+      end
+
+      def score
+        body[:data][:score].to_f / 100.0
+      end
+
+      def first_name
+        nil
+      end
+
+      def last_name
+        nil
+      end
+
+      def free
+        nil
+      end
+
+      def valid
+        body[:data][:regexp] && body[:data][:smtp_check] && body[:data][:status] == VALID
+      end
+
+      def request_query
+        { api_key: api_key, email: email }
+      end
+    end
+  end
+end

data/lib/validatemail/agent/reacher.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Validatemail
+  module Agent
+    class Reacher < Validatemail::Agent::ABase
+      PRIORITY = 1
+      VALID = "safe"
+
+      def autocorrect
+        nil
+      end
+
+      def score
+        nil
+      end
+
+      def first_name
+        nil
+      end
+
+      def last_name
+        nil
+      end
+
+      def free
+        nil
+      end
+
+      def valid
+        body[:syntax][:is_valid_syntax] && body[:smtp][:can_connect_smtp] && body[:is_reachable] == VALID
+      end
+
+      def http
+        @http ||= HTTParty.post(
+          api_url,
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: api_key,
+          },
+          data: { to_email: email },
+        )
+      end
+    end
+  end
+end

data/lib/validatemail/agent/whoisxml.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Validatemail
+  module Agent
+    class Whoisxml < Validatemail::Agent::ABase
+      PRIORITY = 1
+      API_TRUE = "true"
+      API_FALSE = "false"
+
+      def autocorrect
+        nil
+      end
+
+      def score
+        nil
+      end
+
+      def first_name
+        nil
+      end
+
+      def last_name
+        nil
+      end
+
+      def free
+        body[:freeCheck] == API_TRUE
+      end
+
+      def valid
+        body[:formatCheck] == API_TRUE &&
+          body[:smtpCheck] == API_TRUE &&
+          body[:dnsCheck] == API_TRUE &&
+          body[:disposableCheck] == API_FALSE &&
+          body[:catchAllCheck] == API_FALSE
+      end
+
+      def request_query
+        { apiKey: api_key, emailAddress: email }
+      end
+    end
+  end
+end

data/lib/validatemail/agent/zerobounce.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Validatemail
+  module Agent
+    class Zerobounce < Validatemail::Agent::ABase
+      PRIORITY = 1
+      VALID = "valid"
+
+      def autocorrect
+        body[:did_you_mean]
+      end
+
+      def score
+        nil
+      end
+
+      def first_name
+        body[:firstname]
+      end
+
+      def last_name
+        body[:lastname]
+      end
+
+      def free
+        body[:free_email]
+      end
+
+      def valid
+        body[:status] == VALID
+      end
+
+      def request_query
+        { api_key: api_key, email: email, ip_address: "0.0.0.0" }
+      end
+    end
+  end
+end

data/lib/validatemail/agent.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Dir[__FILE__.sub(/\.rb$/, "/**/*.rb").to_s].each { |rb| require rb }
+
+module Validatemail
+  module Agent; end
+end

data/lib/validatemail/api.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Validatemail
+  class API
+    PROVIDERS = %w[
+      Abstract
+      Apilayer
+      Hunter
+      Reacher
+      Whoisxml
+      Zerobounce
+    ].freeze
+
+    attr_reader :email, :data
+
+    def initialize(email)
+      @email = email
+      @ok = false
+      validate!
+    end
+
+    def ok?
+      ok
+    end
+
+    private
+
+    attr_reader :ok
+
+    def validate!
+      done = false
+      @data = nil
+      until done
+        agent = providers.delete(providers.sample).new(email)
+        done = agent.ok? || providers.empty?
+        @data = agent.data if agent.ok?
+        @ok = true if agent.ok?
+      end
+    end
+
+    def providers
+      @providers ||= PROVIDERS.map { |provider| "Validatemail::Agent::#{provider}".constantize }
+      # .sort { |left, right| left::PRIORITY <=> right::PRIORITY }
+    end
+  end
+end

data/lib/validatemail/config.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Validatemail
+  class Config < Anyway::Config
+    attr_config(
+      :abstract_api_key,
+      :apilayer_api_key,
+      :hunter_api_key,
+      :reacher_api_key,
+      :whoisxml_api_key,
+      :zerobounce_api_key,
+    )
+
+    # https://app.abstractapi.com/api/email-validation/documentation
+    def abstract_url
+      "https://emailvalidation.abstractapi.com/v1"
+    end
+
+    # https://apilayer.com/marketplace/email_verification-api#documentation-tab
+    def apilayer_url
+      "https://api.apilayer.com/email_verification"
+    end
+
+    # https://hunter.io/api-keys
+    def hunter_url
+      "https://api.hunter.io/v2/email-verifier"
+    end
+
+    # https://app.reacher.email/dashboard
+    def reacher_url
+      "https://api.reacher.email/v0/check_email"
+    end
+
+    # https://emailverification.whoisxmlapi.com/api/documentation/making-requests
+    def whoisxml_url
+      "https://emailverification.whoisxmlapi.com/api/v2"
+    end
+
+    # https://www.zerobounce.net/docs/email-validation-api-quickstart#validate_emails__v2__
+    def zerobounce_url
+      "https://api.zerobounce.net/v2/validate"
+    end
+  end
+end

data/lib/validatemail/struct.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Validatemail
+  class Struct < Dry::Struct
+    attribute(:email, Types::Strict::String)
+    attribute(:valid, Types::Strict::Bool)
+    attribute(:validated_by, Types::Strict::String.enum(
+                               "Abstract",
+                               "Apilayer",
+                               "Hunter",
+                               "Reacher",
+                               "Whoisxml",
+                               "Zerobounce",
+                             ),)
+    attribute(:autocorrect, Types::Strict::String.optional.default(nil))
+    attribute(:score, Types::Strict::Float.optional.default(nil))
+    attribute(:first_name, Types::Strict::String.optional.default(nil))
+    attribute(:last_name, Types::Strict::String.optional.default(nil))
+    attribute(:free, Types::Strict::Bool.optional.default(nil))
+  end
+end

data/lib/validatemail/types.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Types
+  include Dry.Types
+end

data/lib/validatemail/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Validatemail
+  class Version
+    STRING = File.read(__dir__.sub(%r{lib/validatemail$}, "VERSION"))
+  end
+end

data/lib/validatemail.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "active_support/all"
+require "anyway_config"
+require "dry-struct"
+require "httparty"
+require "json"
+require "pry"
+
+require_relative "validatemail/config"
+require_relative "validatemail/types"
+require_relative "validatemail/struct"
+require_relative "validatemail/agent"
+require_relative "validatemail/api"
+require_relative "validatemail/version"
+
+module Validatemail; end

metadata

@@ -0,0 +1,249 @@
+--- !ruby/object:Gem::Specification
+name: validatemail
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Wiktor Plaga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.36'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: |2
+      Email validator that hits freemium providers one by one and returns
+      normalized response.
+email: hix.dev@tzif.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- VERSION
+- assets/bg.png
+- assets/logo.png
+- lib/validatemail.rb
+- lib/validatemail/agent.rb
+- lib/validatemail/agent/a_base.rb
+- lib/validatemail/agent/abstract.rb
+- lib/validatemail/agent/apilayer.rb
+- lib/validatemail/agent/hunter.rb
+- lib/validatemail/agent/reacher.rb
+- lib/validatemail/agent/whoisxml.rb
+- lib/validatemail/agent/zerobounce.rb
+- lib/validatemail/api.rb
+- lib/validatemail/config.rb
+- lib/validatemail/struct.rb
+- lib/validatemail/types.rb
+- lib/validatemail/version.rb
+homepage: https://github.com/hixdevs/email-validator-rubygem
+licenses:
+- GPL-3.0
+metadata:
+  homepage_uri: https://github.com/hixdevs/email-validator-rubygem
+  changelog_uri: https://github.com/hixdevs/email-validator-rubygem/blob/prd/CHANGELOG.md
+  source_code_uri: https://github.com/hixdevs/email-validator-rubygem/
+  documentation_uri: https://github.com/hixdevs/email-validator-rubygem/blob/prd/README.md
+  bug_tracker_uri: https://github.com/hixdevs/email-validator-rubygem/issues
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: Email validation via freemium providers.
+test_files: []