cli_application 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e981d5c55aa47613784ecc6f2d17c70ca88e92d
-  data.tar.gz: 03f5a07216b3b51a7b11810c245b383a8e96ff55
+  metadata.gz: 42d3b23f523ec6e2a71aec78781c946599743010
+  data.tar.gz: 278b38b045459d7b3bd2ebda1490e48ad2546004
 SHA512:
-  metadata.gz: fbe3f862151696d825fe8fb084662ebe8205e6b1387062f96dbdcea75d1624adf671c66b1be97e33bdd5e4fb90b8ceca0da256ce428c80da4f41cedb1615f9af
-  data.tar.gz: 493e7cd85f4b1c1bb7ffce61215a49617332415ab7f18e888030cfd3648737560c0a546cee0d2f4c88390d17199599cab5f36a11c0346ee8cf47a8d58309e3cc
+  metadata.gz: abedb19ca01a4c4eda33948a2028dbb706d4912d7e4607d2bd2221938e4e1be9292c5315cea15de4ca64567bbf3e89983cd3f096fa94c740462c8b42cbe5e181
+  data.tar.gz: 56c5b38a063b9b2b777b24ce957b68af7c12810d5ba0baf366eb117f1e2819c8f18dac44b33924f9737767705bc2034df1ab32845a1148d1f50192eab797acc9

data/README.md

@@ -81,7 +81,6 @@ end
 ```yaml
 cli:
   timezone: "Moscow"
-  ar_timezone: "Moscow"
 ```
 
 И создаем своё тестовое приложение
@@ -433,7 +432,6 @@ _См. /test/examples/6_
 ```yaml
 cli:
   timezone: "Moscow"
-  ar_timezone: "Moscow" # Active Record timezone
 
   databases:
     default:
@@ -475,6 +473,53 @@ end
 Таким образом, буквально в несколько строк мы можем работать с базами данных в CLI-приложении, так же, как в привычном
 Rails-окружении.
 
+### Пример 7 - Отправка электронной почты
+
+_См. /test/examples/7_
+
+Иногда нужно отправлять различные нотификации из скрипта. Для этого классе CliApplication есть почтовый дивжок mail.
+Попробуем использовать его
+
+Сначала пропишем в конфиге параметры подключения к почтовой системе. Имя конфигуарции - `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 )

data/lib/cli_application/app.rb

@@ -5,6 +5,8 @@ module CliApplication
   class App
     # Ссылка на класс, который содержит аргменты командной строки или значения по умолчанию
     attr_reader :argv
+    # Ссылка на класс - почтовик, для отсылки различных email'ов
+    attr_reader :mail
     # Код завершения приложения. Может быть использован в Bash-скриптах
     attr_reader :exitcode
     # Ссылка на массив, содержащий список директорий в которых исполняется приложение.
@@ -44,6 +46,7 @@ module CliApplication
       @config = ::CliApplication::Config.new(@folders)
 
       @databases = ::CliApplication::Databases.new(config.cli.databases)
+      @mail = ::CliApplication::Mail.new(config.cli.mail)
 
       @footer = nil
 

data/lib/cli_application/config.rb

@@ -67,7 +67,7 @@ module CliApplication
       valid?
 
       ::Time.zone = self.cli.timezone
-      ::ActiveRecord::Base.default_timezone = self.cli.ar_timezone
+      ::ActiveRecord::Base.default_timezone = :local
     end
 
     def set_pair(key, value)  # :nodoc:
@@ -77,8 +77,7 @@ module CliApplication
 
     def valid? # :nodoc:
       raise "ОШИБКА: не найдена секция 'cli'" if self.cli.nil?
-      raise "ОШИБКА: не найдена секция 'cli.tz'" if self.cli.timezone.nil?
-      raise "ОШИБКА: не найдена секция 'cli.active_record_tz'" if self.cli.ar_timezone.nil?
+      raise "ОШИБКА: не найдена секция 'cli.timezone'" if self.cli.timezone.nil?
     end
 
 

data/lib/cli_application/mail.rb

@@ -0,0 +1,79 @@
+# CliApplication::Mail - отсылка сообщений администратору системы
+# может быть использован для отсылки критических сообщений
+
+module CliApplication
+  class Mail
+
+    # Инициализация методов, позволяющих рассылать письма адимнистраторам
+    # системы
+    def initialize(config)
+      @config = config
+      if !@config.nil? && @config.enable
+        @is_valid = true
+      else
+        @is_valid = false
+      end
+    end
+
+    # Метод показывает готовность подсистемы отсылки почты администратору
+    # @return [Boolean] true, если разрешено отправлять письма администратору
+    def valid?
+      @is_valid
+    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
+    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/version.rb

@@ -1,3 +1,3 @@
 module CliApplication
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/cli_application.rb

@@ -10,12 +10,14 @@ require 'pg'
 require 'sqlite3'
 require 'active_record'
 require 'ostruct'
+require 'net/smtp'
 
 
 module CliApplication  # :nodoc:
   require 'cli_application/json_struct'
   require 'cli_application/config'
   require 'cli_application/databases'
+  require 'cli_application/mail'
   require 'cli_application/stat'
   require 'cli_application/argv'
   require 'cli_application/app'

data/test/examples/1/stat/app.yml

@@ -1,33 +1,33 @@
 ---
 :name: app.rb
-:shortdescription: "Пример 4 - Различные параметры командной строки"
+:shortdescription: "Пример 2 - Настройки CLI-приложения"
 :version: '1.0'
 :releasedate: '2015-05-11'
 :timezone: Moscow
-:last_started_at: '2015-05-14 00:34:52 +0300'
+:last_started_at: '2015-05-30 12:27:25 +0300'
 :folders:
-  :app: "/Users/Stan/Documents/Development/RubyMine/cli_application/test/examples/4"
+  :app: "/Users/Stan/Documents/Development/RubyMine/cli_application/test/examples/7"
   :class: "/Users/Stan/Documents/Development/RubyMine/cli_application/test/examples/1"
   :stat: "/Users/Stan/Documents/Development/RubyMine/cli_application/test/examples/1/stat"
 :avg:
-  :starts: 64
-  :executed_at: 0.058898
-  :executed_at_human: 0.058898 секунд
-  :memory: 32213
+  :starts: 87
+  :executed_at: 0.698304
+  :executed_at_human: 0.698304 секунд
+  :memory: 33244
 :last:
-  :started_at: '2015-05-14 00:34:52 +0300'
-  :executed_at: 0.036307
-  :executed_at_human: 0.036307 секунд
-  :memory: 34 кбайт
-  :exitcode: 0
+  :started_at: '2015-05-30 12:27:25 +0300'
+  :executed_at: 21.539793
+  :executed_at_human: 21.539793 секунд
+  :memory: 35 кбайт
+  :exitcode: true
 :last10:
-- 2015-05-14 00:34:52 +0300,0,0.036307,34 кбайт
-- 2015-05-14 00:34:41 +0300,255,0.056077,35 кбайт
-- 2015-05-14 00:34:16 +0300,255,0.036939,34 кбайт
-- 2015-05-14 00:00:49 +0300,0,0.045486,33 кбайт
-- 2015-05-13 22:04:12 +0300,0,1.267228,38 кбайт
-- 2015-05-13 22:02:47 +0300,0,0.034901,34 кбайт
-- 2015-05-13 21:58:13 +0300,0,0.061671,32 кбайт
-- 2015-05-13 21:55:36 +0300,0,0.033505,31 кбайт
-- 2015-05-13 21:54:50 +0300,0,0.034287,31 кбайт
-- 2015-05-13 21:50:54 +0300,255,0.045199,32 кбайт
+- 2015-05-30 12:27:25 +0300,true,21.539793,35 кбайт
+- 2015-05-30 11:52:07 +0300,true,0.880834,35 кбайт
+- 2015-05-30 11:51:13 +0300,true,16.334672,36 кбайт
+- 2015-05-30 11:43:31 +0300,true,1.077774,35 кбайт
+- 2015-05-30 11:40:30 +0300,#<Net::SMTP::Response:0x007fe89425e1d8>,16.540158,34 кбайт
+- 2015-05-30 11:26:21 +0300,255,0.031659,37 кбайт
+- 2015-05-30 11:22:50 +0300,255,0.031873,36 кбайт
+- 2015-05-30 11:22:36 +0300,255,0.034389,35 кбайт
+- 2015-05-30 11:18:59 +0300,255,0.030666,35 кбайт
+- 2015-05-30 11:18:33 +0300,255,0.030451,35 кбайт

data/test/examples/7/app.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+#encoding: utf-8
+require '../1/cli_example.rb'
+
+class TestApp < CliExample
+
+  def main
+    puts "Почта доступна?: #{mail.valid?.inspect}"
+    puts "Почтовый сервер: #{mail.host}:#{mail.port}"
+
+    mail.quick_send('stan@test-mail.ru', 'Stan', 'Тестовый заголовок', 'Hellow, world')
+  end
+
+end
+
+app = TestApp.new(ARGV, __dir__)
+
+app.version = '1.0'
+app.releasedate = '2015-05-11'
+app.shortdescription = 'Пример 2 - Настройки CLI-приложения'
+app.description = "CliApplication gem демо. #{app.shortdescription}"
+
+app.help
+
+app.run
+exit(app.exitcode)
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli_application
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Stan Zhuravlev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,7 @@ files:
 - lib/cli_application/databases.rb
 - lib/cli_application/includes.rb
 - lib/cli_application/json_struct.rb
+- lib/cli_application/mail.rb
 - lib/cli_application/stat.rb
 - lib/cli_application/version.rb
 - test/cli_example.rb
@@ -112,6 +113,7 @@ files:
 - test/examples/5/app.rb
 - test/examples/6/app.rb
 - test/examples/6/offer.rb
+- test/examples/7/app.rb
 - test/stat/rdebug-ide
 - test/stat/test_app.yml
 - test/test_app.rb