RubyGems - onlyoffice_iredmail_helper - Versions diffs - 0.2.1 → 0.3.0 - Mend

onlyoffice_iredmail_helper 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

checksums.yaml +4 -4
data/lib/onlyoffice_iredmail_helper/delete_methods.rb +27 -0
data/lib/onlyoffice_iredmail_helper/login_methods.rb +26 -0
data/lib/onlyoffice_iredmail_helper/move_message_methods.rb +34 -0
data/lib/onlyoffice_iredmail_helper/read_defaults_methods.rb +32 -0
data/lib/onlyoffice_iredmail_helper/send_message_methods.rb +33 -0
data/lib/onlyoffice_iredmail_helper/version.rb +1 -1
data/lib/onlyoffice_iredmail_helper.rb +19 -121
metadata +52 -54

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e74825ff4765edfd4366de74a790cba2cc02da5af7d8c0ebc837306fd6aff2b
-  data.tar.gz: 713bf750990f35c858ea73e6c79919dbc66952a39943140eb35b164fab213395
+  metadata.gz: aee7216a8ce608e7e08e4b625f0257abe4390bdf25587be65ec8c37a88d42911
+  data.tar.gz: e0aa9ec14113d81cdab2c1f879d59b9c4ff2b8d637ea2363684d93b79ae365df
 SHA512:
-  metadata.gz: c89ff66486363120c32aff5c92c5f9729caf7ab0a897605bfa66404aee6057e00bc3de70f9a9aeea75b5a28eba42c777db55521a4ed9de3a183fad97c66e1bb9
-  data.tar.gz: 35a00878f246327b96bdc8300b59126c0b0c93e87c9df83143ea964c902b1e3c05e9bd63736d959ca0d230450f273d32d861a171fa254c85c3b4c32c28f6f897
+  metadata.gz: 776d866b181e61ce9e1254096766f6578b9617a2fbd9f4f6c155de41bb9acf99f034330789109daf4ae21cf9c2dcb5ee425a070de6463f8977c6db38d3d5707e
+  data.tar.gz: 10eb89d22588e0275d83a7aeb1ee48600ffa9699817239a3396b16c25d22483a5d75636dc0bd34761de3196cc6e0a7488f54a9a0403d37b7777b560cf072ba4a

data/lib/onlyoffice_iredmail_helper/delete_methods.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module OnlyofficeIredmailHelper
+  # Methods to delete messages
+  module DeleteMethods
+    # 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
+  end
+end

data/lib/onlyoffice_iredmail_helper/login_methods.rb ADDED Viewed

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module OnlyofficeIredmailHelper
+  # Methods to login and logout
+  module LoginMethods
+    # Login to email via IMAP
+    # @return [nil]
+    def login
+      return if @imap
+      @imap = Net::IMAP.new(@domainname)
+      @imap.authenticate('LOGIN', @username, @password)
+    end
+    private
+    # Correct close of mail account
+    # @return [Void]
+    def close
+      @imap.close
+      @imap.logout
+      @imap.disconnect
+      @imap = nil
+    end
+  end
+end

data/lib/onlyoffice_iredmail_helper/move_message_methods.rb ADDED Viewed

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module OnlyofficeIredmailHelper
+  # Methods to move message
+  module MoveMessageMethods
+    private
+    # 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
+    # Should message be moved out or marked as seen
+    # @param [String] message_id message to handle
+    # @param [Boolean] move_out should it be moved
+    # @return [Void]
+    def move_out_or_mark_seen(message_id, move_out)
+      if move_out
+        move_out_message(message_id)
+      else
+        mark_message_as_seen(message_id)
+      end
+    end
+  end
+end

data/lib/onlyoffice_iredmail_helper/read_defaults_methods.rb ADDED Viewed

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module OnlyofficeIredmailHelper
+  # Methods to read default values
+  module ReadDefaultsMethods
+    private
+    # 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/send_message_methods.rb ADDED Viewed

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module OnlyofficeIredmailHelper
+  # Methods to send message
+  module SendMessageMethods
+    # 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
+  end
+end

data/lib/onlyoffice_iredmail_helper/version.rb CHANGED Viewed

@@ -2,5 +2,5 @@
 module OnlyofficeIredmailHelper
   # [String] version of gem
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/onlyoffice_iredmail_helper.rb CHANGED Viewed

@@ -7,18 +7,28 @@ require 'net/smtp'
 require 'onlyoffice_logger_helper'
 require 'time'
 require 'yaml'
+require_relative 'onlyoffice_iredmail_helper/delete_methods'
+require_relative 'onlyoffice_iredmail_helper/login_methods'
 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/move_message_methods'
+require_relative 'onlyoffice_iredmail_helper/read_defaults_methods'
+require_relative 'onlyoffice_iredmail_helper/send_message_methods'
 require_relative 'onlyoffice_iredmail_helper/version'
 # Namespace of Gem
 module OnlyofficeIredmailHelper
   # Class for working with mail
   class IredMailHelper
+    include DeleteMethods
+    include LoginMethods
     include MailboxesMethods
     include MailGetters
     include MessageMethods
+    include MoveMessageMethods
+    include ReadDefaultsMethods
+    include SendMessageMethods
     attr_reader :username
     def initialize(options = {})
@@ -34,65 +44,8 @@ module OnlyofficeIredmailHelper
     # @return [String] inspect info
     def inspect
       "IredMailHelper domain: #{@domainname}, " \
-      "user: #{@username}, " \
-      "subject: #{@subject}"
-    end
-    # Login to email via IMAP
-    # @return [nil]
-    def login
-      return if @imap
-      @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
+        "user: #{@username}, " \
+        "subject: #{@subject}"
     end
     # Get email
@@ -110,11 +63,7 @@ module OnlyofficeIredmailHelper
           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
+          move_out_or_mark_seen(message_id, options[:move_out])
           return mail
         end
       end
@@ -135,11 +84,7 @@ module OnlyofficeIredmailHelper
           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
+          move_out_or_mark_seen(message_id, move_out)
           return true
         end
       end
@@ -162,11 +107,7 @@ module OnlyofficeIredmailHelper
           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
+          move_out_or_mark_seen(message_id, move_out)
           return mail
         end
       end
@@ -175,35 +116,16 @@ module OnlyofficeIredmailHelper
     private
-    # Correct close of mail account
-    # @return [Void]
-    def close
-      @imap.close
-      @imap.logout
-      @imap.disconnect
-      @imap = nil
-    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
+    # @option options [String] :search call search by this string
+    # @option options [Boolean] :include_read should messages marked as read included
     # @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]])
+      elsif options[:include_read]
+        @imap.search(['ALL'])
       else
         @imap.search(['UNSEEN'])
       end
@@ -224,29 +146,5 @@ module OnlyofficeIredmailHelper
       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

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_iredmail_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2021-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -39,146 +39,138 @@ dependencies:
     - - "~>"
       - !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
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.43.2
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.43.2
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov-cobertura
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.25
+        version: 0.9.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.25
+        version: 0.9.20
 description: ONLYOFFICE Helper Gem for iRedMail. Used in QA
 email:
 - shockwavenn@gmail.com
@@ -187,10 +179,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/onlyoffice_iredmail_helper.rb
+- lib/onlyoffice_iredmail_helper/delete_methods.rb
+- lib/onlyoffice_iredmail_helper/login_methods.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/move_message_methods.rb
 - lib/onlyoffice_iredmail_helper/name.rb
+- lib/onlyoffice_iredmail_helper/read_defaults_methods.rb
+- lib/onlyoffice_iredmail_helper/send_message_methods.rb
 - lib/onlyoffice_iredmail_helper/version.rb
 homepage: https://github.com/ONLYOFFICE-QA/onlyoffice_iredmail_helper
 licenses:
@@ -201,6 +198,7 @@ metadata:
   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
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -216,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.29
 signing_key:
 specification_version: 4
 summary: ONLYOFFICE Helper Gem for iRedMail