easyemail 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9a220b8980346e9ac6c59b62eaa2f42601ed821
+  data.tar.gz: eb8dbd1b9c262a456aa14b7c3c60a803333269d0
+SHA512:
+  metadata.gz: 378e054803df07e7973fc8d31f2b947ca88a5a8ed3e86d742f1af54d1f66f04d00cb32367847da1b0e51d56c84c39c231037425176b9b89acaa3763232609cf3
+  data.tar.gz: ea630d6f6647bd74486942902e63bd971a73e8c4cf12dd8efcd6c4871fe0358b08ae6b128eb8fa63fbada6cb1a09b131f82e80be6e2c8ddf8d4aa51ea1aeb46e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+build.sh

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 tuitu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# Easyemail
+
+Easyemail是一个为简化邮件发送流程而发布的gem.
+
+## Installation
+
+`gem install easyemail`
+
+## Usage
+
+### 第一步:设置smtp
+
+该gem为三个知名的邮件服务商`163.com qq.com gmail.com`和我学校(HHU)的邮箱服务做了预先的设置,如果你用来发送邮件的账号来自于以上的邮件服务商,设置smtp的方法如下:
+```ruby
+# 以163邮箱为例
+# 确保该账号开通了smtp服务
+# username 和 password 是你的邮箱账号(账号包括完整后缀)和密码
+  mailer = Easyemail.new
+  mailer.smtp_settings_for_163  user_name, password
+# 同样的方法还有:
+#   smtp_settings_for_hhu
+#   smtp_settings_for_qq
+#   smtp_settings_for_gmail
+```
+
+如果你使用的不是以上任何一种,设置方法如下:
+```ruby
+# 确保该账号开通了smtp服务
+# username 和 password 是你的邮箱账号(账号包括完整后缀)和密码
+  mailer = Easyemail.new
+  smtp = {
+    "address" => "**",
+    "port" => **,
+    "authentication" => "**",
+    "user_name" => "**",
+    "password" => "**",
+    "enable_starttls_auto" => **
+  }
+  mailer.smtp_settings smtp
+```
+
+另外,还可以从yaml配置文件中导入smtp信息,同样的,如果来自以上四个邮件服务商,配置文件可以这样写
+```
+provider: ** # (只能从163, qq, gmail, hhu中任选一个)
+user_name: **
+password: **
+```
+否则配置文件需这样写:
+```
+address: **
+port: **
+authentication: **
+user_name: **
+password: **
+enable_starttls_auto: **
+```
+
+调用代码如下:
+```ruby
+  mailer = Easyemail.new
+  mailer.load_smtp_settings_from_yaml file_path
+```
+
+### 第二步:设置收件人
+
+允许群发邮件, 设置收件人代码如下:
+```ruby
+  mailer.to = "someone@**.com" # 单收件人
+  mailer.to = ["someone@**.com", "**"] # 多收件人
+```
+
+### 第三步:发送邮件
+
+邮件内容支持文本和html格式,两者都以字符串的形式作为参数,调用代码如下:
+```ruby
+# subject是邮件主题, content是邮件内容
+  mailer.email(subject, content)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "easyemail"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/easyemail.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easyemail/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easyemail"
+  spec.version       = Easyemail::VERSION
+  spec.authors       = ["TUITU"]
+  spec.email         = ["1965972530@qq.com"]
+
+  spec.summary       = %q{"easyemail"}
+  spec.description   = %q{"send email in a simple way"}
+  spec.homepage      = "https://github.com/hellotuitu/easyemail."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "yaml"
+  spec.add_development_dependency "action_mailer"
+  spec.add_development_dependency "active_support"
+end

data/lib/easyemail/mailer/send_email.html.erb

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+  </head>
+  <body>
+    <%= raw @content %>
+  </body>
+</html>

data/lib/easyemail/version.rb

@@ -0,0 +1,3 @@
+class Easyemail
+  VERSION = "0.1.1"
+end

data/lib/easyemail.rb

@@ -0,0 +1,123 @@
+require "easyemail/version"
+
+class Easyemail
+  require 'active_support'
+  require 'action_mailer'
+  require "yaml"
+
+  ActionMailer::Base.raise_delivery_errors = true
+  ActionMailer::Base.perform_deliveries = true
+  ActionMailer::Base.delivery_method = :smtp
+  ActionMailer::Base.view_paths = File.dirname(__FILE__)
+
+  class Mailer < ActionMailer::Base
+    def send_email from, to, subject, content
+      @content = content
+      mail(
+        to: to,
+        from: from,
+        subject: subject
+      ) do | format |
+        format.html
+      end
+    end
+  end
+
+  def load_smtp_settings_from_yaml path
+    smtp = YAML.load_file(path)
+    if smtp["provider"]
+      # 如果指定了邮件服务商 就直接跳转到该服务商
+      # 待选列表 163, hhu, qq, gmail
+      self.send("smtp_settings_for_#{smtp["provider"]}", smtp["user_name"], smtp["password"])
+    else
+      self.smtp_settings smtp
+    end
+  end
+
+  def smtp_settings smtp
+    # common settings for smtp, all provided by user.
+    begin
+      ActionMailer::Base.smtp_settings = {
+        address: smtp['address'],
+        port: smtp["port"],
+        authentication: smtp["authentication"],
+        user_name: smtp['user_name'],
+        password: smtp['password'],
+        enable_starttls_auto: smtp["enable_starttls_auto"]
+      }
+      @from = smtp["user_name"]
+      @config = true
+    rescue
+      raise "wrong parameters for smtp settings."
+    end
+  end
+
+  def to= to
+    # 支持群发
+    @to = to
+  end
+
+  def email subject, content
+    # content支持html
+
+    if @config && @to
+      if @to.respond_to? :each
+        @to.each do | e |
+          Mailer.send_email(@from, e, subject, content).deliver
+        end
+      else
+        Mailer.send_email(@from, @to, subject, content).deliver
+      end
+    else
+      raise "check smtp_settings and receiver!"
+    end
+  end
+
+  def smtp_settings_for_163 user_name, password
+    smtp = {
+      "address" => "smtp.163.com",
+      "port" => 25,
+      "authentication" => "login",
+      "user_name" => user_name,
+      "password" => password,
+      "enable_starttls_auto" => true
+    }
+    self.smtp_settings smtp
+  end
+
+  def smtp_settings_for_hhu user_name, password
+    smtp = {
+      "address" => "mail.hhu.edu.cn",
+      "port" => 25,
+      "authentication" => "login",
+      "user_name" => user_name,
+      "password" => password,
+      "enable_starttls_auto" => false
+    }
+    self.smtp_settings smtp
+  end
+
+  def smtp_settings_for_qq user_name, password
+    smtp = {
+      "address" => "smtp.qq.com",
+      "port" => 25,
+      "authentication" => "login",
+      "user_name" => user_name,
+      "password" => password,
+      "enable_starttls_auto" => false
+    }
+    self.smtp_settings smtp
+  end
+
+  def smtp_settings_for_gmail user_name, password
+    smtp = {
+      "address" => "smtp.gmail.com",
+      "port" => 587,
+      "authentication" => "login",
+      "user_name" => user_name,
+      "password" => password,
+      "enable_starttls_auto" => true
+    }
+    self.smtp_settings smtp
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: easyemail
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- TUITU
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: action_mailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: '"send email in a simple way"'
+email:
+- 1965972530@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easyemail.gemspec
+- lib/easyemail.rb
+- lib/easyemail/mailer/send_email.html.erb
+- lib/easyemail/mailer/send_email.text.erb
+- lib/easyemail/version.rb
+homepage: https://github.com/hellotuitu/easyemail.
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: '"easyemail"'
+test_files: []