cli_application 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42d3b23f523ec6e2a71aec78781c946599743010
-  data.tar.gz: 278b38b045459d7b3bd2ebda1490e48ad2546004
+  metadata.gz: 3ba78168735c942c873ef29654d0e1c9c8d73a81
+  data.tar.gz: 76dbb97ca5ca031783e2fa207b2c3d0f49b92ba9
 SHA512:
-  metadata.gz: abedb19ca01a4c4eda33948a2028dbb706d4912d7e4607d2bd2221938e4e1be9292c5315cea15de4ca64567bbf3e89983cd3f096fa94c740462c8b42cbe5e181
-  data.tar.gz: 56c5b38a063b9b2b777b24ce957b68af7c12810d5ba0baf366eb117f1e2819c8f18dac44b33924f9737767705bc2034df1ab32845a1148d1f50192eab797acc9
+  metadata.gz: 143517fb5880d225cdc28ae474e3e4543ff8a6708a4f48b90fb352c363ba80c37c33af67d35a8957ee3bea57946e3eaed1a7e233dc3cc17431ea403249755943
+  data.tar.gz: 481c7078e467fd2dccd06d0a742c491084b05e147273346a83b022ce590eaee0ad7d01985e3976d7bd35816ca15a43c73017b5ddb6ebc0af530f648ef104f4a9

data/README.md

@@ -467,7 +467,7 @@ end
 Запустим приложение, посомтрим на результат
 
 ```text
-#<Offer id: 10, category: 1, name: "Игрушка десткая", description: "Эта игрушка непременно понравится...", ...
+#<Offer id: 10, category: 1, name: "Игрушка детская", description: "Эта игрушка непременно понравится...", ...
 ```
 
 Таким образом, буквально в несколько строк мы можем работать с базами данных в CLI-приложении, так же, как в привычном
@@ -478,52 +478,5 @@ Rails-окружении.
 _См. /test/examples/7_
 
 Иногда нужно отправлять различные нотификации из скрипта. Для этого классе CliApplication есть почтовый дивжок mail.
-Попробуем использовать его
+Детальное описание его работы с примерами приведено [здесь](/examples/admin_mailer/README.md).
 
-Сначала пропишем в конфиге параметры подключения к почтовой системе. Имя конфигуарции - `cli/mail`.
-
-```yaml
-cli:
-  timezone: "Moscow"
-
-  mail:
-    enable: true
-    from: 'Admin <admin@test-mail.ru>'
-    host: test-mail.ru
-    port: 25
-    footer: '<br><br>--------------<br>Your gem <b>cli_application</b>'
-```
-
-Допустимые ключи:
-* `enable` - если true, то допускается отправка сообщений. Через эту опцию можно запретить отправку
-* `from` - адрес почты, с которой будет отправлено сообщение
-* `host` - SMPT-сервер. Пока имеется ограничение - использование должно быть без пароля
-* `port` - IP-порт почтового сервера
-* `footer` - Подпись сообщения
-
-Затем отправим письмо.
-
-```ruby
-def main
-  mail.quick_send('stan@test-mail.ru', 'Stan', 'Тестовый заголовок', 'Hellow, world')
-  0
-end
-```
-
-В итоге получим.
-
-```html
-Hellow, world
-
---------------
-Your gem <b>cli_application</b>
-```
-
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/cli_application/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/lib/cli_application.rb

@@ -4,6 +4,7 @@ require "cli_application/version"
 require 'st_tools'
 require 'cli_application/includes'
 
+require 'rubygems'
 require 'active_support/time'
 require 'mysql2'
 require 'pg'
@@ -11,9 +12,18 @@ require 'sqlite3'
 require 'active_record'
 require 'ostruct'
 require 'net/smtp'
+require 'htmlentities'
+require "base64"
 
 
 module CliApplication  # :nodoc:
+  require 'cli_application/mail_lib/message'
+  require 'cli_application/mail_lib/base'
+  require 'cli_application/mail_lib/error'
+  require 'cli_application/mail_lib/smtp'
+  require 'cli_application/mail_lib/sendmail'
+  require 'cli_application/mail_lib/log'
+
   require 'cli_application/json_struct'
   require 'cli_application/config'
   require 'cli_application/databases'

data/lib/cli_application/app.rb

@@ -46,7 +46,7 @@ module CliApplication
       @config = ::CliApplication::Config.new(@folders)
 
       @databases = ::CliApplication::Databases.new(config.cli.databases)
-      @mail = ::CliApplication::Mail.new(config.cli.mail)
+      @mail = ::CliApplication::Mail.new(config.cli.mail, @folders)
 
       @footer = nil
 
@@ -248,6 +248,12 @@ module CliApplication
       end
     end
 
+    def reserved_methods
+      out = ['argv', 'folders', 'config', 'mail', 'executed_at', 'version', 'description', 'footer', 'databases']
+      out += ['help', 'run']
+      out.sort
+    end
+
 
     private
 

data/lib/cli_application/argv.rb

@@ -84,6 +84,8 @@ module CliApplication
 
     # Метод выводит подсказку по аргументам командной строки
     def help
+      return if @full.empty?
+
       puts
       puts "Параметры приложения:"
 

data/lib/cli_application/mail.rb

@@ -2,77 +2,50 @@
 # может быть использован для отсылки критических сообщений
 
 module CliApplication
-  class Mail
+  class Mail # :nodoc:
 
     # Инициализация методов, позволяющих рассылать письма адимнистраторам
     # системы
-    def initialize(config)
-      @config = config
-      if !@config.nil? && @config.enable
-        @is_valid = true
-      else
-        @is_valid = false
+    def self.new(config, folders)
+      res = self.check(config)
+
+      case res[:delivery_method]
+        when :log
+          ::CliApplication::MailLib::Log.new(config, folders)
+        when :smtp
+          ::CliApplication::MailLib::SMTP.new(config, folders)
+        when :sendmail
+          ::CliApplication::MailLib::Sendmail.new(config, folders)
+        else
+          ::CliApplication::MailLib::Error.new(config, folders)
       end
     end
 
-    # Метод показывает готовность подсистемы отсылки почты администратору
-    # @return [Boolean] true, если разрешено отправлять письма администратору
-    def valid?
-      @is_valid
+    def self.check(config)
+      methods = ['log', 'sendmail', 'smtp']
+
+      return self.set_valid_state(false, 'Отсутствует секция mail') if config.nil?
+      return self.set_valid_state(false, 'Отсутствует параметр enable в секции mail') if config.enable.nil?
+      return self.set_valid_state(false, 'Отсутствует параметр from в секции mail') if config.from.nil?
+      return self.set_valid_state(false, 'Параметр from в секции mail не должен быть пустым') if config.from.strip == ''
+      warn "Внимание: передача почтовых сообщений отключена" unless config.enable
+      return self.set_valid_state(false, "Метод доставки должен быть один из: #{methods.inspect}") unless methods.include?(config.delivery_method.to_s)
+
+      res = Hash.new
+      res[:valid] = true
+      res[:delivery_method] = config.delivery_method.to_sym
+      res[:error_msg] = ''
+      res
     end
 
-    # Функция отправляет сообщение по электронной почте
-    # @param [String] to электронная почта лица, которому отправляется сообщение
-    # @param [String] name имя клиента, которому отправляется сообщение
-    # @param [String] title заголовок письма
-    # @param [String] body текст письма
-    # @return [Boolean] true, если письмо отправлено
-    def quick_send(to, name, title, body)
-      return false unless valid?
-
-      to_email = (name.nil? || name == '') ? to : "#{name} <#{to}>"
-      body_full = (@config.footer.nil? || @config.footer == '') ? body : (body+@config.footer)
-
-      begin
-        send_message(to_email, title, body_full)
-        true
-      rescue Errno::ECONNREFUSED
-        puts "Почтовый сервер не найден, выводим почтовое сообщение в консоль"
-        puts "From: #{@config.from.inspect}"
-        puts "To: #{to_email.inspect}"
-        puts "Title: #{title.inspect}"
-        puts "Body: #{(body_full[0,256] + '...').inspect}"
-        false
-      rescue Exception => e
-        puts "Ошибка отправки письма: #{e.message}"
-        false
-      end
+    def self.set_valid_state(state, error_msg)
+      res = Hash.new
+      res[:valid] = false
+      res[:delivery_method] = :error
+      res[:error_msg] = error_msg
+      res
     end
 
-    def send_message(to, title, body)
-      msgstr = <<MESSAGE_END
-From: #{@config.from}
-To: #{to}
-Subject: #{title}
-Date: #{::Time.zone.now.to_formatted_s(:rfc822) }
-MIME-Version: 1.0
-Content-type: text/html
-
-#{body}
-MESSAGE_END
-
-      Net::SMTP.start(host, port) do |smtp|
-        smtp.send_message msgstr, @config.from, to
-      end
-    end
-
-    def host
-      @config.host || 'none'
-    end
-
-    def port
-      @config.port || 0
-    end
 
   end
 end

data/lib/cli_application/mail_lib/base.rb

@@ -0,0 +1,142 @@
+# CliApplication::MailLib::Base - базовый класс валидации конфига почты
+
+module CliApplication
+  module MailLib
+    class Base # :nodoc:
+      attr_reader :delivery_method
+      attr_reader :config_fail_message
+
+      def initialize(config, folders) # :nodoc:
+        @config = config
+        @folders = folders
+      end
+
+      # Метод возвращает true, если подсистема отсылки почтовых сообщений настроена корректна
+      # и готова к рассылке сообщений
+      #
+      # @return [Boolean] true - если подсистема почта настроена корректно
+      def valid?
+        @is_valid
+      end
+
+      # Метод является заглушкой функции, которая должна быть переписана в дочерних классах
+      # ::Log, ::Error, ::Smpt, ::Sendmail
+      #
+      # @param [String] электронная почта лица, которому отправляется сообщение, или массив адресов
+      # @param [String] name имя клиента, которому отправляется сообщение
+      # @param [String] title заголовок письма
+      # @param [String] body текст письма
+      # @return [Boolean] true, если письмо отправлено
+      def simple_send(to, name, title, body)
+        warn "Необходимо переопределить функцию отправки электронной почты (simple_send)"
+        warn "Обратитесь к разработчику данного скрипта"
+      end
+
+      # Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Log
+      #
+      # @return [String] пустая строка
+      def log_filename
+        ''
+      end
+
+      # Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp
+      #
+      # @return [String] пустая строка
+      def address
+        ''
+      end
+
+      # Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp
+      #
+      # @return [String] пустая строка
+      def domain
+        ''
+      end
+
+      # Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp
+      #
+      # @return [String] пустая строка
+      def port
+        ''
+      end
+
+      # Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp
+      #
+      # @return [String] пустая строка
+      def user_name
+        ''
+      end
+
+      # Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp
+      #
+      # @return [Boolean] необходимость использовать SSL/TLS
+      def tls?
+        false
+      end
+
+      # Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp
+      #
+      # @return [Boolean] необходимость использовать SSL/TLS
+      def smpt_log?
+        false
+      end
+
+      # Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp
+      #
+      # @return [String] пустая строка
+      def authentication
+        ''
+      end
+
+      # Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Smtp
+      #
+      # @return [String] пустая строка
+      def password
+        ''
+      end
+
+      # Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Sendmail
+      #
+      # @return [String] пустая строка
+      def sendmail_location
+        ''
+      end
+
+      # Заглушка на случай вызова данной функции из класса иного, чем CliApplication::MailLib::Sendmail
+      #
+      # @return [String] пустая строка
+      def sendmail_arguments
+        ''
+      end
+
+
+      private
+
+
+
+      def set_check_config_state(state, message) # :nodoc:
+        @is_valid = state
+        @config_fail_message = message
+        state
+      end
+
+      def build_rfc822_name(to, name) # :nodoc:
+        return to if name.nil? || name == ''
+        "#{name} <#{to}>"
+      end
+
+      def processing_to(to, name, message) # :nodoc:
+        if to.is_a?(::Array)
+          # Несколько адресов
+          to.each do |one|
+            message.add_to(one, '')
+          end
+        else
+          # Один адрес
+          message.add_to(to, name)
+        end
+      end
+
+    end
+  end
+end

data/lib/cli_application/mail_lib/error.rb

@@ -0,0 +1,45 @@
+# CliApplication::MailLib::Log - класс хранения почты в файлы
+
+module CliApplication
+  module MailLib
+    class Error < ::CliApplication::MailLib::Base
+
+      def initialize(config, folders) # :nodoc:
+        @delivery_method = :error
+        super(config, folders)
+        @is_valid = false
+
+        check_config
+      end
+
+      # Функция всегда возвращает false
+      #
+      # @param [String] to электронная почта лица, которому отправляется сообщение, или массив адресов
+      # @param [String] name имя клиента, которому отправляется сообщение
+      # @param [String] title заголовок письма
+      # @param [String] body текст письма
+      # @return [Boolean] false
+      def simple_send(to, name, title, body)
+        false
+      end
+
+
+      private
+
+
+
+      def check_config  # :nodoc:
+        methods = ['log', 'sendmail', 'smtp']
+
+        return set_check_config_state(false, "Отсутствует секция mail") if @config.nil?
+        return set_check_config_state(false, 'Отсутствует параметр enable в секции mail') if @config.enable.nil?
+        return set_check_config_state(false, 'Отсутствует параметр from в секции mail') if @config.from.nil?
+        return set_check_config_state(false, 'Параметр from в секции mail не должен быть пустым') if @config.from.strip == ''
+        return set_check_config_state(false, "Метод доставки должен быть один из: #{methods.inspect}") unless methods.include?(@config.delivery_method.to_s)
+
+        set_check_config_state(false, 'Неизвестная ошибка (почтовая подсистема)')
+      end
+
+    end
+  end
+end

data/lib/cli_application/mail_lib/log.rb

@@ -0,0 +1,90 @@
+# CliApplication::MailLib::Log - класс хранения почты в файлы
+
+module CliApplication
+  module MailLib
+    class Log < ::CliApplication::MailLib::Base
+
+      def initialize(config, folders) # :nodoc:
+        @delivery_method = :log
+        super(config, folders)
+        check_config
+
+        prepare_log_filename
+      end
+
+      # Данный метод возвращает имя файла для записи логов. В этом методе происходит
+      # обработка параметра даты {date}, что позволяет разбивать логи по дням.
+      #
+      # @return [String] имя лог-файла для записи сообщений
+      def log_filename
+        @log_filename.gsub('{date}', ::Time.zone.now.to_date.to_s(:db))
+      end
+
+      # Функция записывает сообщение электронной почты в лог-файл, с преобразованием HTML-формата в текст
+      #
+      # @param [String] to электронная почта лица, которому отправляется сообщение, или массив адресов
+      # @param [String] name имя клиента, которому отправляется сообщение
+      # @param [String] title заголовок письма
+      # @param [String] body текст письма
+      # @return [Boolean] true, если письмо отправлено
+      def simple_send(to, name, title, body)
+        message = CliApplication::MailLib::Message.new
+        message.from_email = @config.from
+        message.subject = title
+        message.body = (@config.footer.nil? || @config.footer == '') ? body : (body+@config.footer)
+
+        processing_to(to, name, message)
+
+        out = Array.new
+        out << ''
+        out << "--- #{StTools::Human.format_time(::Time.zone.now, :full, :full)} -------------------"
+        out << message.to_log
+        record = out.join("\n")
+
+        open(log_filename, 'a') do |f|
+          f.puts record
+        end
+
+        true
+      rescue Exception => e
+        $stderr.puts "Ошибка записи электронного сообщения: #{e.message}"
+        false
+      end
+
+
+      private
+
+
+      def check_config # :nodoc:
+        return set_check_config_state(false, "Не найдена секция конфиг-файла cli/mail/log") if @config.log.nil?
+        return set_check_config_state(false, "Не найден параметр конфиг-файла cli/mail/log/location") if @config.log.location.nil?
+        return set_check_config_state(false, "Параметр конфиг-файла cli/mail/log/location не должен быть пустым") if @config.log.location == ''
+        set_check_config_state(true, '')
+      end
+
+      def prepare_log_filename # :nodoc:
+        return '' unless valid?
+
+        res = @config.log.location
+        res.gsub!('{exe}', File.basename(StTools::System.exename, '.rb').gsub(/\_/, '-'))
+        res.gsub!('****', @folders[:app])
+        res.gsub!('***', @folders[:class])
+        @log_filename = res
+
+        path = File.dirname(@log_filename)
+        begin
+          unless Dir.exist?(path)
+            FileUtils.mkdir_p(path)
+            FileUtils.chmod(0777, path)
+          end
+        rescue Exception => e
+          $stderr.puts "Ошибка создания папки для записи сообщений электронной почты (#{e.message})"
+          $stderr.puts "  #{path}"
+          $stderr.puts "  Обратитесь к разработчику данного скрипта"
+        end
+
+      end
+
+    end
+  end
+end