new commit

Author: MailboxValidator

README.md

@@ -0,0 +1,29 @@
+MailboxValidator Ruby Module
+============================
+
+This Ruby module provides an easy way to call the MailboxValidator API which validates if an email address is a valid one.
+
+This module can be used in many types of projects such as:
+
+ - validating a user's email during sign up
+ - cleaning your mailing list prior to an email marketing campaign
+ - a form of fraud check
+
+Installation
+============
+
+To install this module type the following:
+
+   gem install mailboxvalidator-ruby
+
+Dependencies
+============
+
+An api key is required for this module to function.
+
+Go to http://www.mailboxvalidator.com/plans to sign up for a trial plan or a paid plan and you'll be given an API key.
+
+Copyright
+=========
+
+Copyright (C) 2015 by MailboxValidator.com, [email protected]

README.rdoc

@@ -0,0 +1,43 @@
+= MailboxValidator
+
+== Usage
+
+require "mailboxvalidator_ruby"
+
+apikey = "MY_API_KEY"
+email = "[email protected]"
+
+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 "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
+
+== Dependencies
+ 
+* Go to http://www.mailboxvalidator.com/plans to sign up for a trial plan or a paid plan and you'll be given an API key.
+
+== Copyright
+
+Copyright (c) 2015 MailboxValidator.com
+

lib/mailboxvalidator_ruby.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby
+require 'cgi'
+require 'net/http'
+require 'json'
+require 'ostruct'
+
+module MailboxValidator
+	class MBV
+		attr_accessor :apikey
+		attr_reader :result, :error
+		
+		def initialize(apikey = "")
+			@apikey = apikey
+			@error = nil
+		end
+		
+		def query_single(email)
+			@email = CGI.escape(email)
+			uri = URI("https://api.mailboxvalidator.com?key=#{@apikey}&email=#{@email}")
+			
+			begin
+				Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+					request = Net::HTTP::Get.new uri
+					response = http.request request
+					
+					if response.code == "200"
+						@result = JSON.parse(response.body, object_class: OpenStruct)
+						@error = nil
+					else
+						@error = "#{response.code} - #{response.message}"
+						@result = nil
+					end
+				end
+			rescue Exception => e
+				@error = e.message
+				@result = nil
+			end
+		end
+	end
+end

mailboxvalidator_ruby.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'mailboxvalidator_ruby'
+  s.version     = '1.0.0'
+  s.required_ruby_version = '>= 2.0.0'
+  s.date        = '2015-11-19'
+  s.summary     = "MailboxValidator API wrapper"
+  s.description = "MailboxValidator API wrapper"
+  s.author      = "MailboxValidator"
+  s.email       = 'support@mailboxvalidator'
+  s.files       = ["lib/mailboxvalidator_ruby.rb","test/test.rb","README.rdoc"]
+  s.homepage    = 'http://www.mailboxvalidator.com/ruby'
+  s.license     = 'LGPL-3.0+'
+end

test/test.rb

@@ -0,0 +1,30 @@
+require "mailboxvalidator_ruby"
+
+apikey = "MY_API_KEY"
+email = "[email protected]"
+
+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 "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