email-verification 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f15443c9ec1e533893b1eb3a32775b2fbc3ab0c98c7a79d8b48a30c5cf6600
-  data.tar.gz: d513f67f6824f045487e8783d13db9dbf5ffea4605ab689dbb8e64a7cf302c07
+  metadata.gz: 280d7dfab6e3eb5b6f4fe8aa6e95423d19f6f7a0fc575c42b8c357d113ea4801
+  data.tar.gz: 53805c28a691d7285c7c12c05be4f14e46328829c46a501e9954a4b14dc6f81b
 SHA512:
-  metadata.gz: 9bc77e4d23247da0cb79006e16b0bcd93d5aaf591ba97c3cb0801dbc2676fdeddb3796078f00339ae9c140c898bb72a14cf1f8ce1ba7f3271746ae2774b5af0a
-  data.tar.gz: aa20717ebbbc67c2bd56c23af65b3576ffd8dd2216f0627ac73b9e4ac7c51055208d8c4841c538006e2c3f8b1740b7f0f0fd149ddc08ffb1cf82c43e093efaa8
+  metadata.gz: 6813e1ef4ae7155ea78180943982d5f1acf775d3612ed32ebde9c6fa7abc94558ad71d5acc4c1ff9617cff00ba589f8b8d4cfce561b446b4d0e3834a838e07e2
+  data.tar.gz: 1b3d4bd66d845ba96cc4c53c0c3fc0708adb730189acf3197c5415fe513a7c03cb55a53e664203a3bc1f088f7195a5aaa18e94c2731c4eeb238b66db73af3409

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    email-verification (0.1.9)
+    email-verification (0.2.0)
       gmail (~> 0.7.1)
       highline (~> 2.0, >= 2.0.2)
+      net-imap-proxy (~> 0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -20,7 +21,10 @@ GEM
       mini_mime (>= 0.1.1)
     method_source (0.9.2)
     mini_mime (1.0.2)
+    net-imap-proxy (0.1.0)
+      proxifier (~> 1.0, >= 1.0.3)
     oauth (0.5.4)
+    proxifier (1.0.3)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)

data/README.md

@@ -27,7 +27,7 @@ Email::Verification expects a settings hash in the following format:
 ```ruby
 settings = {
   address: "confirmation@foo.com",
-  from:    "Confirmation",
+  from:    "Confirmation", # Optional
   subject: /Confirm your email!/i,
   regex:   /<a href=['"](?<match>[^"]*)['"]>\s*Click here\s*<\/a>/i
 }
@@ -41,6 +41,18 @@ Then the client is invoked using:
 Email::Verification.retrieve_verification_code(email: 'email.address@gmail.com', password: 's0mEpasSwOrD', settings: settings)
 ```
 
+### Proxy support
+
+Email::Verification can also be used together with proxies to fetch IMAP messages.
+
+Simply provide a hash { host: "http://someproxyhost.com", port: 8080 } to the retrieve_verification_code method:
+
+```ruby
+Email::Verification.retrieve_verification_code(email: 'email.address@gmail.com', password: 's0mEpasSwOrD', settings: settings, proxy: {host: "http://someproxyhost.com", port: 8080})
+```
+
+Proxy authentication is also supported using the format {host: "http://user:password@someproxyhost.com", port: 8080}
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/email-verification.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   
   spec.add_dependency "gmail", "~> 0.7.1"
   spec.add_dependency "highline", "~> 2.0", ">= 2.0.2"
+  spec.add_dependency "net-imap-proxy", "~> 0.1.0"
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/email/verification/base.rb

@@ -7,19 +7,36 @@ module Email
         self.configuration      =     configuration
       end
       
-      def retrieve_verification_code(email:, password:, host:, port: 993, enable_ssl: true, count: :all, mailboxes: %w(Inbox), settings: {})
+      def set_retriever(email:, password:, host:, port: 993, enable_ssl: true, proxy: nil)
+        retriever               =   :imap
+        
+        options                 =   {
+          address:    host,
+          port:       port,
+          user_name:  email,
+          password:   password,
+          enable_ssl: enable_ssl
+        }
+        
+        if proxy && !proxy.empty? && !proxy[:host].to_s.empty? && !proxy[:port].to_s.empty?
+          retriever             =   ::Net::IMAP::Proxy::RetrieverMethod
+          proxy[:host]          =   "http://#{proxy[:host]}" unless proxy[:host] =~ /^http(s)?:\/\//i
+          options               =   options.merge(proxy_address: proxy[:host], proxy_port: proxy[:port])
+          log("Using proxy #{proxy[:host]}:#{proxy[:port]} to fetch messages from #{options[:address]}:#{options[:port]}")
+        end
+        
+        Mail.defaults do                      
+          retriever_method retriever, options
+        end
+      end
+      
+      def retrieve_verification_code(email:, password:, host:, port: 993, enable_ssl: true, count: :all, mailboxes: %w(Inbox), settings: {}, proxy: nil)
         emails    =   []
         result    =   nil
         
         begin
-          Mail.defaults do                      
-            retriever_method :imap, address:    host,
-                                    port:       port,
-                                    user_name:  email,
-                                    password:   password,
-                                    enable_ssl: enable_ssl
-          end
-        
+          set_retriever(email: email, password: password, host: host, port: port, enable_ssl: enable_ssl, proxy: proxy)
+          
           mailboxes.each do |mailbox|
             Mail.find(mailbox: mailbox, order: :desc, count: count)&.each do |email|
               log("From: #{email.from&.first&.strip}. Subject: #{email.subject}")

data/lib/email/verification/gmail.rb

@@ -2,7 +2,15 @@ module Email
   module Verification
     class Gmail < Base
       
-      def retrieve_verification_code(email:, password:, mark_as_read: true, count: :all, mailboxes: %w(Inbox), settings: {})
+      def retrieve_verification_code(email:, password:, mark_as_read: true, count: :all, mailboxes: %w(Inbox), settings: {}, proxy: nil)
+        if proxy && !proxy.empty? && !proxy[:host].to_s.empty? && !proxy[:port].to_s.empty?
+          return super(email: email, password: password, host: "imap.gmail.com", port: 993, enable_ssl: true, mailboxes: mailboxes, count: count, settings: settings, proxy: proxy)
+        else
+          return normal_retrieve_verification_code(email: email, password: password, mark_as_read: mark_as_read, count: count, mailboxes: mailboxes, settings: settings)
+        end
+      end
+      
+      def normal_retrieve_verification_code(email:, password:, mark_as_read: true, count: :all, mailboxes: %w(Inbox), settings: {})
         emails    =   []
         result    =   nil
     

data/lib/email/verification/hotmail.rb

@@ -2,8 +2,8 @@ module Email
   module Verification
     class Hotmail < Base
       
-      def retrieve_verification_code(email:, password:, mailboxes: %w(Inbox Junk), count: :all, settings: {})
-        super(email: email, password: password, host: "outlook.office365.com", port: 993, enable_ssl: true, mailboxes: mailboxes, count: count, settings: settings)
+      def retrieve_verification_code(email:, password:, mailboxes: %w(Inbox Junk), count: :all, settings: {}, proxy: nil)
+        super(email: email, password: password, host: "outlook.office365.com", port: 993, enable_ssl: true, mailboxes: mailboxes, count: count, settings: settings, proxy: proxy)
       end
       
     end

data/lib/email/verification/verifier.rb

@@ -18,14 +18,14 @@ module Email
         end
       end
       
-      def retrieve_verification_code(email:, password:, mailboxes: %w(Inbox), count: :all, settings: {}, wait: 3, retries: 3)
+      def retrieve_verification_code(email:, password:, mailboxes: %w(Inbox), count: :all, settings: {}, proxy: nil, wait: 3, retries: 3)
         service       =   determine_email_service(email)
         
         result        =   case service
           when :gmail
-            perform_retrieval(::Email::Verification::Gmail.new, email: email, password: password, mailboxes: mailboxes, count: count, settings: settings, wait: wait, retries: retries)
+            perform_retrieval(::Email::Verification::Gmail.new, email: email, password: password, mailboxes: mailboxes, count: count, settings: settings, proxy: proxy, wait: wait, retries: retries)
           when :hotmail
-            perform_retrieval(::Email::Verification::Hotmail.new, email: email, password: password, mailboxes: mailboxes, count: count, settings: settings, wait: wait, retries: retries)
+            perform_retrieval(::Email::Verification::Hotmail.new, email: email, password: password, mailboxes: mailboxes, count: count, settings: settings, proxy: proxy, wait: wait, retries: retries)
           when :protonmail, :tutanota
             if self.mode.eql?(:interactive)
               puts "[Email::Verification::Verifier] - #{Time.now}: You're using an email account that doesn't have support for POP3 or IMAP. You have to manually retrieve the code or URL from the account and post it below."
@@ -40,7 +40,7 @@ module Email
         return result
       end
       
-      def perform_retrieval(verifier, email:, password: nil, mailboxes: %w(Inbox), count: :all, settings: {}, wait: 3, retries: 3)
+      def perform_retrieval(verifier, email:, password: nil, mailboxes: %w(Inbox), count: :all, settings: {}, proxy: nil, wait: 3, retries: 3)
         result        =   nil
         
         if password.to_s.empty? && self.mode.eql?(:interactive)
@@ -50,20 +50,20 @@ module Email
           raise ::Email::Verification::Errors::InvalidCredentialsError.new("Password wasn't provided for #{email} and automatic mode is enabled. Please provide a password or switch to interactive mode.")
         else
           if settings_provided?(settings) && !wait.nil? && !retries.nil?
-            result    =   retrieve_with_retries(verifier, email: email, password: password, mailboxes: mailboxes, count: count, settings: settings, wait: wait, retries: retries)
+            result    =   retrieve_with_retries(verifier, email: email, password: password, mailboxes: mailboxes, count: count, settings: settings, proxy: proxy, wait: wait, retries: retries)
           else
-            result    =   verifier.retrieve_verification_code(email: email, password: password, mailboxes: mailboxes, count: count, settings: settings)
+            result    =   verifier.retrieve_verification_code(email: email, password: password, mailboxes: mailboxes, count: count, settings: settings, proxy: proxy)
           end
         end
         
         return result
       end
       
-      def retrieve_with_retries(verifier, email:, password: nil, mailboxes: %w(Inbox), count: :all, settings: {}, wait: 3, retries: 3)
+      def retrieve_with_retries(verifier, email:, password: nil, mailboxes: %w(Inbox), count: :all, settings: {}, proxy: nil, wait: 3, retries: 3)
         result        =   nil
         
         begin
-          result      =   verifier.retrieve_verification_code(email: email, password: password, mailboxes: mailboxes, count: count, settings: settings)
+          result      =   verifier.retrieve_verification_code(email: email, password: password, mailboxes: mailboxes, count: count, settings: settings, proxy: proxy)
           
           if result.to_s.empty?
             sleep wait if wait

data/lib/email/verification/version.rb

@@ -1,5 +1,5 @@
 module Email
   module Verification
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/email/verification.rb

@@ -3,6 +3,8 @@ require "mail"
 require "yaml"
 require "highline"
 
+require "net/imap/proxy"
+
 require "email/verification/version"
 
 require "email/verification/configuration"
@@ -35,8 +37,8 @@ module Email
       yield(configuration)
     end
     
-    def self.retrieve_verification_code(email:, password: nil, mailboxes: %w(Inbox), settings: {}, mode: :interactive)
-      ::Email::Verification::Verifier.new(mode: mode).retrieve_verification_code(email: email, password: password, mailboxes: mailboxes, settings: settings)
+    def self.retrieve_verification_code(email:, password: nil, mailboxes: %w(Inbox), settings: {}, mode: :interactive, proxy: nil)
+      ::Email::Verification::Verifier.new(mode: mode).retrieve_verification_code(email: email, password: password, mailboxes: mailboxes, settings: settings, proxy: proxy)
     end
     
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: email-verification
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sebastian Johnsson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-13 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gmail
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: net-imap-proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement