mailboxvalidator_ruby 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 545fb96f0e69fd79fe99b2eac91ec6ea24222788
-  data.tar.gz: c14f0e3d4d235d1c1969fe2a939effb7c8b001b9
+SHA256:
+  metadata.gz: 4b106b9f3c1c8bb8eb76d52f21c8ca98d3c4b74420c945ba4fabece41fd654a7
+  data.tar.gz: e9e22f9f8b6437f55871bae91421525408257f0400d40fade9fda876855aac41
 SHA512:
-  metadata.gz: 876166562734586db3908977628088e98ed6ba4e28821e35a9e75d3e6d81e5b904cb84ac833265b8c3742da042e9fac8cd36eaddd37af4a9f2def5c030d1c83b
-  data.tar.gz: 05beff128529752e63bebe5bcbaa098fd6ca9730022103087bc66c01e6bde11c8685dc9531e9147ebaf907391e8f5bee4d3a73f35c28a5ef8abb8384174848e5
+  metadata.gz: 0551d315437005f3fac038bbb6379228d5ac090e09aa4718fcef2465a288dbe505f6dbe220d366d29c3fc49db7bcd8bbd643e11776f9000d01f977940d9d336d
+  data.tar.gz: 116c7a5f2b3bfcb61fa99804ba8b2993b29fbfb5762d0704bd2e4b69a746efb1a6d6361a5a7777f36c4cba19b606e99d28d888cc89d72f3efeaf52bc62c0c2f4

data/README.rdoc

@@ -1,71 +1,74 @@
-= MailboxValidator
-
-== Usage
-
-require "mailboxvalidator_ruby"
-
-apikey = "MY_API_KEY"
-email = "example@example.com"
-
-mbv = MailboxValidator::MBV.new()
-mbv.apikey = apikey
-
-mbv.query_single(email)
-
-if mbv.error != nil
-	puts "Error: #{mbv.error}"
-elsif mbv.result != nil
-	puts "email_address: #{mbv.result.email_address}"
-	puts "domain: #{mbv.result.domain}"
-	puts "is_free: #{mbv.result.is_free}"
-	puts "is_syntax: #{mbv.result.is_syntax}"
-	puts "is_domain: #{mbv.result.is_domain}"
-	puts "is_smtp: #{mbv.result.is_smtp}"
-	puts "is_verified: #{mbv.result.is_verified}"
-	puts "is_server_down: #{mbv.result.is_server_down}"
-	puts "is_greylisted: #{mbv.result.is_greylisted}"
-	puts "is_disposable: #{mbv.result.is_disposable}"
-	puts "is_suppressed: #{mbv.result.is_suppressed}"
-	puts "is_role: #{mbv.result.is_role}"
-	puts "is_high_risk: #{mbv.result.is_high_risk}"
-	puts "is_catchall: #{mbv.result.is_catchall}"
-	puts "mailboxvalidator_score: #{mbv.result.mailboxvalidator_score}"
-	puts "time_taken: #{mbv.result.time_taken}"
-	puts "status: #{mbv.result.status}"
-	puts "credits_available: #{mbv.result.credits_available}"
-	puts "error_code: #{mbv.result.error_code}"
-	puts "error_message: #{mbv.result.error_message}"
-end
-
-mbv.disposable_email(email)
-
-if mbv.error != nil
-	puts "Error: #{mbv.error}"
-elsif mbv.result != nil
-	puts "email_address: #{mbv.result.email_address}"
-	puts "is_disposable: #{mbv.result.is_disposable}"
-	puts "credits_available: #{mbv.result.credits_available}"
-	puts "error_code: #{mbv.result.error_code}"
-	puts "error_message: #{mbv.result.error_message}"
-end
-
-mbv.free_email(email)
-
-if mbv.error != nil
-	puts "Error: #{mbv.error}"
-elsif mbv.result != nil
-	puts "email_address: #{mbv.result.email_address}"
-	puts "is_free: #{mbv.result.is_free}"
-	puts "credits_available: #{mbv.result.credits_available}"
-	puts "error_code: #{mbv.result.error_code}"
-	puts "error_message: #{mbv.result.error_message}"
-end
-
-== Dependencies
- 
-* Go to https://www.mailboxvalidator.com/plans#api to sign up for a FREE API plan and you'll be given an API key.
-
-== Copyright
-
-Copyright (c) 2018 MailboxValidator.com
-
+= MailboxValidator
+
+== Usage
+
+require "mailboxvalidator_ruby"
+
+apikey = "MY_API_KEY"
+email = "example@example.com"
+
+mbv = MailboxValidator::MBV.new()
+mbv.apikey = apikey
+
+mbv.query_single(email)
+
+if mbv.error != nil && mbv.result != nil
+	puts "error_code: #{mbv.result.error.error_code}"
+	puts "error_message: #{mbv.result.error.error_message}"
+elsif mbv.error != nil
+	puts "Error: #{mbv.error}"
+elsif mbv.result != nil
+	puts "email_address: #{mbv.result.email_address}"
+	puts "domain: #{mbv.result.domain}"
+	puts "is_free: #{mbv.result.is_free}"
+	puts "is_syntax: #{mbv.result.is_syntax}"
+	puts "is_domain: #{mbv.result.is_domain}"
+	puts "is_smtp: #{mbv.result.is_smtp}"
+	puts "is_verified: #{mbv.result.is_verified}"
+	puts "is_server_down: #{mbv.result.is_server_down}"
+	puts "is_greylisted: #{mbv.result.is_greylisted}"
+	puts "is_disposable: #{mbv.result.is_disposable}"
+	puts "is_suppressed: #{mbv.result.is_suppressed}"
+	puts "is_role: #{mbv.result.is_role}"
+	puts "is_high_risk: #{mbv.result.is_high_risk}"
+	puts "is_catchall: #{mbv.result.is_catchall}"
+	puts "mailboxvalidator_score: #{mbv.result.mailboxvalidator_score}"
+	puts "time_taken: #{mbv.result.time_taken}"
+	puts "status: #{mbv.result.status}"
+	puts "credits_available: #{mbv.result.credits_available}"
+end
+
+mbv.disposable_email(email)
+
+if mbv.error != nil && mbv.result != nil
+	puts "error_code: #{mbv.result.error.error_code}"
+	puts "error_message: #{mbv.result.error.error_message}"
+elsif mbv.error != nil
+	puts "Error: #{mbv.error}"
+elsif mbv.result != nil
+	puts "email_address: #{mbv.result.email_address}"
+	puts "is_disposable: #{mbv.result.is_disposable}"
+	puts "credits_available: #{mbv.result.credits_available}"
+end
+
+mbv.free_email(email)
+
+if mbv.error != nil && mbv.result != nil
+	puts "error_code: #{mbv.result.error.error_code}"
+	puts "error_message: #{mbv.result.error.error_message}"
+elsif mbv.error != nil
+	puts "Error: #{mbv.error}"
+elsif mbv.result != nil
+	puts "email_address: #{mbv.result.email_address}"
+	puts "is_free: #{mbv.result.is_free}"
+	puts "credits_available: #{mbv.result.credits_available}"
+end
+
+== Dependencies
+ 
+* Go to https://www.mailboxvalidator.com/plans#api to sign up for a FREE API plan and you'll be given an API key.
+
+== Copyright
+
+Copyright (c) 2023 MailboxValidator.com
+

data/lib/mailboxvalidator_ruby.rb

@@ -16,7 +16,7 @@ module MailboxValidator
 		
 		def query_single(email)
 			@email = CGI.escape(email)
-			uri = URI("https://api.mailboxvalidator.com/v1/validation/single?key=#{@apikey}&email=#{@email}")
+			uri = URI("https://api.mailboxvalidator.com/v2/validation/single?key=#{@apikey}&email=#{@email}")
 			
 			begin
 				Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
@@ -28,7 +28,7 @@ module MailboxValidator
 						@error = nil
 					else
 						@error = "#{response.code} - #{response.message}"
-						@result = nil
+						@result = JSON.parse(response.body, object_class: OpenStruct)
 					end
 				end
 			rescue Exception => e
@@ -39,7 +39,7 @@ module MailboxValidator
 		
 		def disposable_email(email)
 			@email = CGI.escape(email)
-			uri = URI("https://api.mailboxvalidator.com/v1/email/disposable?key=#{@apikey}&email=#{@email}")
+			uri = URI("https://api.mailboxvalidator.com/v2/email/disposable?key=#{@apikey}&email=#{@email}")
 			
 			begin
 				Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
@@ -51,7 +51,7 @@ module MailboxValidator
 						@error = nil
 					else
 						@error = "#{response.code} - #{response.message}"
-						@result = nil
+						@result = JSON.parse(response.body, object_class: OpenStruct)
 					end
 				end
 			rescue Exception => e
@@ -62,7 +62,7 @@ module MailboxValidator
 		
 		def free_email(email)
 			@email = CGI.escape(email)
-			uri = URI("https://api.mailboxvalidator.com/v1/email/free?key=#{@apikey}&email=#{@email}")
+			uri = URI("https://api.mailboxvalidator.com/v2/email/free?key=#{@apikey}&email=#{@email}")
 			
 			begin
 				Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
@@ -74,7 +74,7 @@ module MailboxValidator
 						@error = nil
 					else
 						@error = "#{response.code} - #{response.message}"
-						@result = nil
+						@result = JSON.parse(response.body, object_class: OpenStruct)
 					end
 				end
 			rescue Exception => e

data/spec/mailboxvalidator_ruby_webservice_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "MailboxvalidatorRuby" do
+  it "work correctly with invalid api key" do
+    if $api_key == 'YOUR_API_KEY'
+      mbv = MailboxValidator::MBV.new()
+      mbv.apikey = $api_key
+      mbv.query_single('example@example.com')
+      expect(mbv.result.error.error_message).to eq 'API key not found.'
+    end
+  end
+
+  it "work correctly with api key exists" do
+    if $api_key == 'YOUR_API_KEY'
+      print "/*
+* You could enter a MailboxValidator API Key in spec/spec_helper.rb
+* for real web service calling test.
+* 
+* You could sign up for a free API key at https://www.mailboxvalidator.com/plans#api
+* if you do not have one.
+*/"
+      expect($api_key).to eq 'YOUR_API_KEY'
+    else
+      expect($api_key).to_not eq 'YOUR_API_KEY'
+    end
+  end
+
+  it "work correctly with validate email" do
+    mbv = MailboxValidator::MBV.new()
+    mbv.apikey = $api_key
+    mbv.query_single('example@example.com')
+    if $api_key == 'YOUR_API_KEY'
+      expect(mbv.result.error.error_code).to eq 10001
+    else
+      expect(mbv.result.status).to eq false
+    end
+  end
+
+  it "work correctly with disposable email" do
+    mbv = MailboxValidator::MBV.new()
+    mbv.apikey = $api_key
+    mbv.disposable_email('example@example.com')
+    if $api_key == 'YOUR_API_KEY'
+      expect(mbv.result.error.error_code).to eq 10001
+    else
+      expect(mbv.result.is_disposable).to eq false
+    end
+  end
+
+  it "work correctly with free email" do
+    mbv = MailboxValidator::MBV.new()
+    mbv.apikey = $api_key
+    mbv.free_email('example@example.com')
+    if $api_key == 'YOUR_API_KEY'
+      expect(mbv.result.error.error_code).to eq 10001
+    else
+      expect(mbv.result.is_free).to eq false
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'mailboxvalidator_ruby'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end
+
+$api_key = 'YOUR_API_KEY'

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: mailboxvalidator_ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - MailboxValidator
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2023-09-21 00:00:00.000000000 Z
 dependencies: []
-description: MailboxValidator API wrapper
+description: Enable users to block disposal email, detect free email and validate
+  if an email is valid
 email: support@mailboxvalidator
 executables: []
 extensions: []
@@ -18,12 +19,13 @@ extra_rdoc_files: []
 files:
 - README.rdoc
 - lib/mailboxvalidator_ruby.rb
-- test/test.rb
-homepage: http://www.mailboxvalidator.com/ruby
+- spec/mailboxvalidator_ruby_webservice_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.mailboxvalidator.com/ruby
 licenses:
-- LGPL-3.0+
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -38,9 +40,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: MailboxValidator API wrapper
 test_files: []

data/test/test.rb

@@ -1,58 +0,0 @@
-require "mailboxvalidator_ruby"
-
-apikey = "MY_API_KEY"
-email = "example@example.com"
-
-mbv = MailboxValidator::MBV.new()
-mbv.apikey = apikey
-
-mbv.query_single(email)
-
-if mbv.error != nil
-	puts "Error: #{mbv.error}"
-elsif mbv.result != nil
-	puts "email_address: #{mbv.result.email_address}"
-	puts "domain: #{mbv.result.domain}"
-	puts "is_free: #{mbv.result.is_free}"
-	puts "is_syntax: #{mbv.result.is_syntax}"
-	puts "is_domain: #{mbv.result.is_domain}"
-	puts "is_smtp: #{mbv.result.is_smtp}"
-	puts "is_verified: #{mbv.result.is_verified}"
-	puts "is_server_down: #{mbv.result.is_server_down}"
-	puts "is_greylisted: #{mbv.result.is_greylisted}"
-	puts "is_disposable: #{mbv.result.is_disposable}"
-	puts "is_suppressed: #{mbv.result.is_suppressed}"
-	puts "is_role: #{mbv.result.is_role}"
-	puts "is_high_risk: #{mbv.result.is_high_risk}"
-	puts "is_catchall: #{mbv.result.is_catchall}"
-	puts "mailboxvalidator_score: #{mbv.result.mailboxvalidator_score}"
-	puts "time_taken: #{mbv.result.time_taken}"
-	puts "status: #{mbv.result.status}"
-	puts "credits_available: #{mbv.result.credits_available}"
-	puts "error_code: #{mbv.result.error_code}"
-	puts "error_message: #{mbv.result.error_message}"
-end
-
-mbv.disposable_email(email)
-
-if mbv.error != nil
-	puts "Error: #{mbv.error}"
-elsif mbv.result != nil
-	puts "email_address: #{mbv.result.email_address}"
-	puts "is_disposable: #{mbv.result.is_disposable}"
-	puts "credits_available: #{mbv.result.credits_available}"
-	puts "error_code: #{mbv.result.error_code}"
-	puts "error_message: #{mbv.result.error_message}"
-end
-
-mbv.free_email(email)
-
-if mbv.error != nil
-	puts "Error: #{mbv.error}"
-elsif mbv.result != nil
-	puts "email_address: #{mbv.result.email_address}"
-	puts "is_free: #{mbv.result.is_free}"
-	puts "credits_available: #{mbv.result.credits_available}"
-	puts "error_code: #{mbv.result.error_code}"
-	puts "error_message: #{mbv.result.error_message}"
-end