SingleEmailVerification 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19fa35eb35db463f12f5e9cc7643c2b6826d48b79ad2bb534a8b0f8497962789
-  data.tar.gz: 74a41e70c950497e98c3ea4828c3ba073c54a3825d4b6766ff5d1b042c0f24c1
+  metadata.gz: ba39a5ee1c1b2b428546ea535f57a63a547594177554ba92a27565fe744bb691
+  data.tar.gz: 7e626577b871807bfd59208622a2251835450a7797cc1b8a3f520e9572d3a64a
 SHA512:
-  metadata.gz: 3e8742cdfb034c82ef8ac75edd69d695f52d5491d457d68a1b1d59d3766e5eeb2969b29851e0e7ce9cf5c3ea7e4ec2d4d86ac460581e85aa1f95111fefa771b2
-  data.tar.gz: 20a7d8b2553de7c4bd7389aae9084d7327f125072f35b75b1d3104c0d8ace645a8de517be575533e402d040a3d81c12fb0253efd8a87bdccc5138ef9149c8feb
+  metadata.gz: 311914c90070ce655d5f4c8e36cdff2dba7f6c251c11fa3ff9a2540b948d009c7821f6de5b7b25957c502b082ddf21ec6575e52ebc45ab28dd1df5ed0137d223
+  data.tar.gz: abf373a8ec31164e5a353d9bf75d1be6281c455d8ba9ff66c6448397c3ddd7a424224df669b469ad021d40f0fcdc245a796a0896ab5138638b56a34ce7f897f2

data/README.md

@@ -1,39 +1,93 @@
 # EmailVerification
 
-Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/emailVerification`. To experiment with that code, run `bin/console` for an interactive prompt.
+The Single Email Verification Gem is a Ruby library that provides functionality to verify single email addresses. It allows you to easily integrate email verification into your Ruby applications.
 
 ## Installation
 
-Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+To install the gem, add the following line to your application's Gemfile:
+
+    $ gem install 'SingleEmailVerification'
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle nstall
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install SingleEmailVerification
 
 ## Usage
 
-TODO: Write usage instructions here
+To use the Single Email Verification gem, require it in your Ruby code:
+
+require 'emailVerification'
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Then, create an instance of the EmailVerification::Client class and use its single_verify method to verify a single email address:
+
+class ClientTest
+
+    def initialize
+        @client = EmailVerification::Client.new
+    end
+
+    def test_single_verify
+        email = 'sahal.abdullah@mslm.io'
+        resp = @client.single_verify(email)
+        puts resp
+    end
+
+end
+
+ClientTest.new.test_single_verify
+
+To modify your ClientTest class to allow users to add their API key from the MSL cloud, you can implement a method to set the API key and use it when initializing the EmailVerification::Client. Here's the updated code:
+
+require 'email_verification'
+
+class ClientTest
+def initialize(api_key = nil)
+@api_key = api_key
+@client = EmailVerification::Client.new(api_key: @api_key)
+end
+
+def set_api_key(api_key)
+@api_key = api_key
+@client = EmailVerification::Client.new(api_key: @api_key)
+end
+
+def test_single_verify
+email = 'sahal.abdullah@mslm.io'
+resp = @client.single_verify(email)
+puts resp
+end
+end
+
+# Example usage:
+
+# Instantiate ClientTest with API key
+
+client_test = ClientTest.new('your_api_key_here')
+
+# Alternatively, set API key after instantiation
+
+# client_test.set_api_key('your_api_key_here')
+
+# Perform single email verification
+
+client_test.test_single_verify
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+With this modification, users can provide their API key either during initialization or after instantiation using the set_api_key method. This gives them the flexibility to use their MSL cloud API key for unlimited hits.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/emailVerification. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/emailVerification/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/sahalAbdullah/emailVerification. Please provide detailed descriptions and steps to reproduce any bugs you encounter.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The Single Email Verification gem is available as open source under the terms of the MIT License. You are free to use and modify it as per your requirements.
 
 ## Code of Conduct
 
-Everyone interacting in the EmailVerification project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/emailVerification/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the EmailVerification project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sahalAbdullah/emailVerification/blob/master/CODE_OF_CONDUCT.md).

data/lib/emailVerification/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EmailVerification
-  VERSION = "0.1.0"
+  VERSION = "1.1.0"
 end

data/lib/emailVerification.rb

@@ -6,9 +6,15 @@ module EmailVerification
 
   class SingleVerifyReqOpts
     attr_accessor :disable_url_encode
+    attr_accessor :api_key
   end
 
   class Client
+
+    def initialize(api_key = nil)
+      @api_key = api_key
+    end
+
     def single_verify(email_addr, opts = nil)
       opt = SingleVerifyReqOpts.new
       opt = opts.last unless opts.nil? || opts.empty?
@@ -17,12 +23,55 @@ module EmailVerification
       email_addr = URI.encode_www_form_component(email_addr) unless opt.disable_url_encode
 
       qp = { 'email' => email_addr }
+      if @api_key || opt.api_key
+        api_key = opt.api_key || @api_key
+        qp['apikey'] = api_key
+      end
+
+      
       t_url = prepare_url('https://mslm.io/api/sv/v1', qp, opt)
+      puts "Url #{t_url}"
 
       sv_resp = req_and_resp('GET', t_url, nil, opt)
       return sv_resp
     end
 
+    def send_otp(otp_send_req, opts = nil)
+
+      opt = SingleVerifyReqOpts.new
+      opt = opts.last unless opts.nil? || opts.empty?
+      qp ={}
+      if @api_key || opt.api_key
+        api_key = opt.api_key || @api_key
+        qp['apikey'] = api_key
+      end
+
+      t_url = prepare_url('https://mslm.io/api/otp/v1/send', qp, opt)
+      puts "Url #{t_url}"
+      puts otp_send_req.to_json
+
+      otp_send_resp = req_and_resp('POST', t_url, otp_send_req, opt)
+      return otp_send_resp
+    end
+
+    def verify(otp_token_verify_req, opts = nil)
+      opt = SingleVerifyReqOpts.new
+      opt = opts.last unless opts.nil? || opts.empty?
+      opt.disable_url_encode = true if opt.disable_url_encode.nil?
+
+      qp = {}
+      if @api_key || opt.api_key
+        api_key = opt.api_key || @api_key
+        qp['apikey'] = api_key
+      end
+
+      t_url = prepare_url('https://mslm.io/api/otp/v1/token_verify', qp, opt)
+      puts "Url #{t_url}"
+
+      otp_token_verify_resp = req_and_resp('POST', t_url, otp_token_verify_req, opt)
+      return otp_token_verify_resp
+    end
+
     private
 
     def prepare_url(path, query_params, opts)
@@ -36,15 +85,29 @@ module EmailVerification
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.scheme == 'https'
 
-      request = Net::HTTP::Get.new(uri.request_uri)
+      if _method == 'POST'
+        request = Net::HTTP::Post.new(uri.request_uri)
+        request.body = _data.to_json
+        request.content_type = 'application/json'
+      elsif _method == 'GET'
+        request = Net::HTTP::Get.new(uri.request_uri)
+      else
+        return "Unsupported HTTP method: #{_method}"
+      end
+
       response_data = http.request(request)
 
-      if response_data.code.to_i == 200
+      if _method == 'POST' and response_data.code.to_i == 200
+        json_response = JSON.parse(response_data.body)
+        return json_response
+
+      elsif response_data.code.to_i == 200
         json_response = JSON.parse(response_data.body)
         response = [json_response["email"],json_response["username"],json_response["domain"],json_response["malformed"],json_response["suggestion"],json_response["status"],json_response["has_mailbox"],json_response["accept_all"],json_response["disposable"],json_response["free"],json_response["role"],json_response['mx']]
         return response
+        
       else
-        raise EmailVerification::Error, "HTTP #{response_data.code}: #{response_data.message}"
+        return "HTTP #{response_data.code}: #{response_data.message}"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: SingleEmailVerification
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sahal Abdullah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-07 00:00:00.000000000 Z
+date: 2024-03-08 00:00:00.000000000 Z
 dependencies: []
 description: Write a longer description or delete this line.
 email:
@@ -22,6 +22,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- SingleEmailVerification-0.1.0.gem
+- SingleEmailVerification-0.1.1.gem
 - emailVerification.gemspec
 - lib/emailVerification.rb
 - lib/emailVerification/version.rb