onlyoffice_iredmail_helper 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9871762acd906ea08deb24f3f27ad70a705a77381dc78efe717a2c3fa543a644
+  data.tar.gz: d6ec13250ef152c8bc686947358c328b60c3124ccc94172134a58840c2d9bf33
+SHA512:
+  metadata.gz: 0b9640e4a34616eba140e99dd20f1e25438fbc1a5c09cce770b25f9a5d713af922e965ee8f50453f25d5ec81a306d06ba0b53cad193fe853680970b1ca7239e2
+  data.tar.gz: e0cb81aaca023ab6c20f9e3640b27ec4d5ae56140b68ba7010b33902f35ecb3a4265674771d7d86e3185834d307978e9d8fc63caa4fd05ea01c60733d036a8ef

data/lib/onlyoffice_iredmail_helper.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'mail'
+require 'net/imap'
+require 'net/smtp'
+require 'onlyoffice_logger_helper'
+require 'time'
+require 'yaml'
+require_relative 'onlyoffice_iredmail_helper/mailboxes_methods'
+require_relative 'onlyoffice_iredmail_helper/mail_getters'
+require_relative 'onlyoffice_iredmail_helper/message_methods'
+require_relative 'onlyoffice_iredmail_helper/version'
+
+# Namespace of Gem
+module OnlyofficeIredmailHelper
+  # Class for working with mail
+  class IredMailHelper
+    include MailboxesMethods
+    include MailGetters
+    include MessageMethods
+    attr_reader :username
+
+    def initialize(options = {})
+      read_defaults
+      @domainname = options[:domainname] || @default_domain
+      @username = options[:username] || @default_user
+      @password = options[:password] || @default_password
+      @subject = options[:subject] || @default_subject
+      @body = options[:body]
+      @mailbox_for_archive = 'checked'
+    end
+
+    # @return [String] inspect info
+    def inspect
+      "IredMailHelper domain: #{@domainname}, " \
+      "user: #{@username}, " \
+      "subject: #{@subject}"
+    end
+
+    # Login to email via IMAP
+    # @return [nil]
+    def login
+      @imap = Net::IMAP.new(@domainname)
+      @imap.authenticate('LOGIN', @username, @password)
+    end
+
+    # Form a email string
+    # @param msg_data [Hash] params
+    # @return [String] formed mail message
+    def create_msg(msg_data = {})
+      <<~END_OF_MESSAGE
+        From: #{@username}
+        To: #{msg_data[:mailto]}
+        Subject: #{msg_data[:subject]}
+        Date: #{Time.now.rfc2822}
+        Message-Id: "#{Digest::SHA2.hexdigest(Time.now.to_i.to_s)}@#{@username.split('@').last}"
+        
+        #{msg_data[:body]}
+      END_OF_MESSAGE
+    end
+
+    # Send mail
+    # @param options [Hash] hash with params
+    # @return [nil]
+    def send_mail(options = {})
+      options[:subject] ||= @default_subject
+      options[:body] ||= @default_body
+      options[:mailto] ||= @default_user
+      smtp = Net::SMTP.start(@domainname, 25, @username, @username, @password, :login)
+      smtp.send_message create_msg(options), @username, options[:mailto]
+      smtp.finish
+    end
+
+    # Delete all messages in inbox
+    # @return [nil]
+    def delete_all_messages
+      login
+      @imap.select('INBOX')
+      @imap.store(@imap.search(['ALL']), '+FLAGS', [:Deleted]) unless @imap.search(['ALL']).empty?
+      OnlyofficeLoggerHelper.log('Delete all messages')
+      close
+    end
+
+    # Delete email by subject
+    # @param subject [String] email title
+    # @return [nil]
+    def delete_email_by_subject(subject)
+      login
+      @imap.select('INBOX')
+      id_emails = @imap.search(['SUBJECT', subject.dup.force_encoding('ascii-8bit')])
+      @imap.store(id_emails, '+FLAGS', [:Deleted]) unless id_emails.empty?
+      close
+    end
+
+    # Get email
+    # @param options [Hash] options of get
+    # @param times [Integer] count to check
+    # @return [Hash] mail
+    def mail_by_subject(options = {}, times = 300)
+      login
+      @imap.select('INBOX')
+      start_time = Time.now
+      while Time.now - start_time < times
+        get_emails_search_or_new(options).each do |message_id|
+          mail = get_mail_data(message_id)
+          mail_subject_found = mail[:subject].to_s.upcase
+          mail_subject_to_be_found = options[:subject].to_s.upcase
+          next unless mail_subject_found.include? mail_subject_to_be_found
+
+          if options[:move_out]
+            move_out_message(message_id)
+          else
+            mark_message_as_seen(message_id)
+          end
+          return mail
+        end
+      end
+      nil
+    end
+
+    # Check if message exists by params
+    # @param options [Hash] options of get
+    # @param times [Integer] count to check
+    # @return [True, False] result of check
+    def check_email_by_subject(options = {}, times = 300, move_out = false)
+      login
+      @imap.select('INBOX')
+      start_time = Time.now
+      while Time.now - start_time < times
+        get_emails_search_or_new(options).each do |message_id|
+          string_found = get_mail_data(message_id, options[:search])[:subject].to_s.upcase.gsub(/\s+/, ' ')
+          string_to_be_found = options[:subject].to_s.upcase.gsub(/\s+/, ' ')
+          next unless string_found.include? string_to_be_found
+
+          if move_out
+            move_out_message(message_id)
+          else
+            mark_message_as_seen(message_id)
+          end
+          return true
+        end
+      end
+      false
+    end
+
+    # Get email by subject
+    # @param options [Hash] options of get
+    # @param times [Integer] count to check
+    # @param move_out [True, False] should message to move out
+    # @return [Hash] mail
+    def get_email_by_subject(options = {}, times = 300, move_out = false)
+      login
+      @imap.select('INBOX')
+      start_time = Time.now
+      while Time.now - start_time < times
+        get_emails_search_or_new(options).each do |message_id|
+          mail = get_mail_data(message_id)
+          string_found = mail[:subject].to_s.upcase.gsub(/\s+/, ' ')
+          string_to_be_found = options[:subject].to_s.upcase.gsub(/\s+/, ' ')
+          next unless string_found.include? string_to_be_found
+
+          if move_out
+            move_out_message(message_id)
+          else
+            mark_message_as_seen(message_id)
+          end
+          return mail
+        end
+      end
+      nil
+    end
+
+    private
+
+    # Correct close of mail account
+    # @return [Void]
+    def close
+      @imap.close
+      @imap.logout
+      @imap.disconnect
+    end
+
+    # Move out message to `checked` directory
+    # @param message_id [String] id of message
+    # @return [Void]
+    def move_out_message(message_id)
+      create_mailbox(@mailbox_for_archive) unless mailboxes.include?(@mailbox_for_archive)
+
+      login
+      @imap.select('INBOX')
+      @imap.copy(message_id, @mailbox_for_archive)
+      @imap.store(message_id, '+FLAGS', [:Deleted])
+      @imap.expunge
+      close
+    end
+
+    # Get email list via search or all unseen
+    # @param options [Hash] options to search
+    # @return [Array<Mail>] list of mails
+    def get_emails_search_or_new(options)
+      if options[:search]
+        @imap.search([(options[:search_type] || 'BODY').to_s.upcase, options[:search]])
+      else
+        @imap.search(['UNSEEN'])
+      end
+    end
+
+    # Get mail data by mail id
+    # @param message_id [Integer] id of message
+    # @param search [String] param to search
+    # @return [Hash] found data
+    def get_mail_data(message_id, search = nil)
+      msg = @imap.fetch(message_id, 'RFC822')[0].attr['RFC822']
+      mail = Mail.read_from_string(msg)
+      subject = mail.subject.force_encoding('utf-8')
+      body = mail.text_part
+      body = body.body.to_s.gsub(/\s+/, ' ').strip.force_encoding('utf-8') if body
+      html_body = mail.html_part
+      html_body = html_body.body.to_s.gsub(/\s+/, ' ').strip.force_encoding('utf-8') if html_body
+      mark_message_as_seen(message_id, close_connection: false) unless search
+      { subject: subject, body: body, html_body: html_body }
+    end
+
+    # Get S3 key and S3 private key
+    # @return [Array <String>] list of keys
+    def read_defaults
+      return if read_env_defaults
+
+      yaml = YAML.load_file("#{Dir.home}/.gem-onlyoffice_iredmail_helper/config.yml")
+      @default_domain = yaml['domain']
+      @default_user = yaml['user']
+      @default_password = yaml['password'].to_s
+      @default_subject = yaml['subject']
+    rescue Errno::ENOENT
+      raise Errno::ENOENT, 'No config found. Please create ~/.gem-onlyoffice_iredmail_helper/config.yml'
+    end
+
+    # Read keys from env variables
+    def read_env_defaults
+      return false unless ENV['IREDMAIL_PASSWORD']
+
+      @default_domain = ENV['IREDMAIL_DOMAIN']
+      @default_user = ENV['IREDMAIL_USER']
+      @default_password = ENV['IREDMAIL_PASSWORD'].to_s
+      @default_subject = ENV['IREDMAIL_SUBJECT']
+    end
+  end
+end

data/lib/onlyoffice_iredmail_helper/mail_getters.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module OnlyofficeIredmailHelper
+  # Modules to get mail by different parameters
+  module MailGetters
+    # Search email by specific date and message title
+    # @param date [Date] date to search
+    # @param subject [String] check if message is start_with this string
+    # @param timeout [Integer] How much time to wait in seconds
+    # @param range [Integer] range in days to extend specified date
+    # @return [Hash, False] mail data and false is none found
+    def email_by_date_and_title(date: Date.today,
+                                subject: nil,
+                                timeout: 300,
+                                move_out: true,
+                                range: 1)
+      start_date = (date - range).strftime('%d-%b-%Y')
+      end_date = (date + range).strftime('%d-%b-%Y')
+
+      login
+      @imap.select('INBOX')
+      start_time = Time.now
+      while (Time.now - start_time) < timeout
+        @imap.search(['SINCE', start_date, 'BEFORE', end_date]).each do |message_id|
+          mail_data = get_mail_data(message_id)
+          next unless mail_data[:subject].start_with?(subject)
+
+          if move_out
+            move_out_message(message_id)
+          else
+            mark_message_as_seen(message_id)
+          end
+          return mail_data
+        end
+      end
+      false
+    end
+
+    # Get email text body by subject
+    # @param options [Hash] options of get
+    # @param times [Integer] count to check
+    # @return [String] text body
+    def get_text_body_email_by_subject(options = {}, times = 300)
+      mail = mail_by_subject(options, times)
+      return nil unless mail
+
+      mail[:body]
+    end
+
+    # Get email html body by subject
+    # @param options [Hash] options of get
+    # @param times [Integer] count to check
+    # @return [String] html body
+    def get_html_body_email_by_subject(options = {}, times = 300)
+      mail = mail_by_subject(options, times)
+      return nil unless mail
+
+      mail[:html_body]
+    end
+  end
+end

data/lib/onlyoffice_iredmail_helper/mailboxes_methods.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OnlyofficeIredmailHelper
+  # Methods for working with Mail account Mailboxes
+  module MailboxesMethods
+    # @return [Array<String>] list of folder names
+    def mailboxes
+      login
+      @imap.select('INBOX')
+      folders = @imap.list('%', '%').map(&:name)
+      close
+      OnlyofficeLoggerHelper.log("Get list of mailboxes: #{folders}")
+      folders
+    end
+
+    # Create new mailbox with name
+    # @param name [String] name of folder
+    # @return [nil]
+    def create_mailbox(name)
+      login
+      @imap.select('INBOX')
+      @imap.create(name)
+      close
+      OnlyofficeLoggerHelper.log("Created new mailbox: #{name}")
+    end
+
+    # Delete mailbox with name
+    # @param name [String] name of folder
+    # @return [nil]
+    def delete_mailbox(name)
+      raise("There is no mailbox #{name} to delete") unless mailboxes.include?(name)
+
+      login
+      @imap.select('INBOX')
+      @imap.delete(name)
+      close
+      OnlyofficeLoggerHelper.log("Delete mailbox by name: #{name}")
+    end
+  end
+end

data/lib/onlyoffice_iredmail_helper/message_methods.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module OnlyofficeIredmailHelper
+  # Methods to work with messages
+  module MessageMethods
+    # Mark message as seen
+    # @param message_id [Integer] message to mark
+    # @param close_connection [True, False] should connection be closed
+    # @return [nil]
+    def mark_message_as_seen(message_id, close_connection: true)
+      login
+      @imap.select('INBOX')
+      @imap.store(message_id, '+FLAGS', [:Seen])
+      close if close_connection
+    end
+  end
+end

data/lib/onlyoffice_iredmail_helper/name.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module OnlyofficeIredmailHelper
+  # [String] name of gem
+  NAME = 'onlyoffice_iredmail_helper'
+end

data/lib/onlyoffice_iredmail_helper/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module OnlyofficeIredmailHelper
+  # [String] version of gem
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: onlyoffice_iredmail_helper
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- ONLYOFFICE
+- Pavel Lobashov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: onlyoffice_logger_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.91.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.91.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.43.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.43.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+description: ONLYOFFICE Helper Gem for iRedMail. Used in QA
+email:
+- shockwavenn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/onlyoffice_iredmail_helper.rb
+- lib/onlyoffice_iredmail_helper/mail_getters.rb
+- lib/onlyoffice_iredmail_helper/mailboxes_methods.rb
+- lib/onlyoffice_iredmail_helper/message_methods.rb
+- lib/onlyoffice_iredmail_helper/name.rb
+- lib/onlyoffice_iredmail_helper/version.rb
+homepage: https://github.com/ONLYOFFICE-QA/onlyoffice_iredmail_helper
+licenses:
+- AGPL-3.0
+metadata:
+  bug_tracker_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_iredmail_helper/issues
+  changelog_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_iredmail_helper/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/onlyoffice_iredmail_helper
+  homepage_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_iredmail_helper
+  source_code_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_iredmail_helper
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: ONLYOFFICE Helper Gem for iRedMail
+test_files: []