posten 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +1 -0
- data/Gemfile +5 -0
- data/LICENSE +21 -0
- data/README.md +182 -0
- data/lib/posten.rb +37 -0
- data/lib/posten/test.rb +15 -0
- data/lib/posten/version.rb +3 -0
- data/makefile +5 -0
- data/posten.gemspec +19 -0
- data/test/posten_test.rb +98 -0
- metadata +110 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 5507003d22cfa28e7cb3865873dfa9a2a78e605c
|
4
|
+
data.tar.gz: cf35fd60c024ef13458b75a9acc1ec831c136c5a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: df08b2bdddb0971061ed214f587d8868af81edc94b85238f5b04283ee238e3224c7afc0cd0b3a86a72523a9659747559e8b408750ca17db137844ea334db55da
|
7
|
+
data.tar.gz: 93063845d9e06717188efa7493e7f1c8cf682012c791305b9eb7c6cd04688bc8c2665639bc972b2f8415b7eeb6b7e1baa2a40bdd1286aa21c820c9c7224e8822
|
data/.gitignore
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
Gemfile.lock
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2015 Francesco Rodríguez
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,182 @@
|
|
1
|
+
posten
|
2
|
+
======
|
3
|
+
|
4
|
+
Mail delivery.
|
5
|
+
|
6
|
+
Usage
|
7
|
+
-----
|
8
|
+
|
9
|
+
Configure the client with your SMTP credentials:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require "posten"
|
13
|
+
|
14
|
+
Posten.connect(
|
15
|
+
host: "smtp.posten.gem",
|
16
|
+
port: "587",
|
17
|
+
user: "eve@posten.gem",
|
18
|
+
password: "secret"
|
19
|
+
)
|
20
|
+
|
21
|
+
# or:
|
22
|
+
|
23
|
+
Posten.connect(url: "smtp://eve%40posten.gem:secret@smtp.posten.gem:587")
|
24
|
+
```
|
25
|
+
|
26
|
+
Use the `deliver` method to send mails:
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
posten = Posten.new
|
30
|
+
|
31
|
+
posten.deliver(
|
32
|
+
from: "bob@posten.gem",
|
33
|
+
to: "alice@posten.gem",
|
34
|
+
subject: "Hei",
|
35
|
+
text: "hvordan går det?",
|
36
|
+
html: "<b>hvordan går det?</b>"
|
37
|
+
)
|
38
|
+
```
|
39
|
+
|
40
|
+
Check [SMTP settings](#smtp-settings) and [Delivery Options](#delivery-options)
|
41
|
+
for more supported options.
|
42
|
+
|
43
|
+
Defaults
|
44
|
+
--------
|
45
|
+
|
46
|
+
You can use the `defaults` method to set default values for
|
47
|
+
the `deliver` method options.
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
Posten.defaults(
|
51
|
+
from: "no-reply@posten.gem",
|
52
|
+
cc: "jameson@posten.gem"
|
53
|
+
)
|
54
|
+
|
55
|
+
posten = Posten.new
|
56
|
+
|
57
|
+
posten.deliver(to: "alice@posten.gem", subject: "hei")
|
58
|
+
# from: no-reply@posten.gem
|
59
|
+
# to: alice@posten.gem
|
60
|
+
# cc: jameson@posten.gem
|
61
|
+
# subject: =?utf-8?Q?hei?=
|
62
|
+
```
|
63
|
+
|
64
|
+
Mailers
|
65
|
+
-------
|
66
|
+
|
67
|
+
You can use inheritance to create mailer classes:
|
68
|
+
|
69
|
+
```ruby
|
70
|
+
class UserMailer < Posten
|
71
|
+
defaults from: "admin@posten.gem"
|
72
|
+
|
73
|
+
def welcome_mail(user)
|
74
|
+
deliver(
|
75
|
+
to: user.email,
|
76
|
+
subject: "Welcome #{ user.name }!",
|
77
|
+
text: "You have successfully signed up."
|
78
|
+
)
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
mailer = UserMailer.new
|
83
|
+
mailer.welcome_mail(User.first)
|
84
|
+
```
|
85
|
+
|
86
|
+
Defaults are inherited but can be changed through the `defaults` method.
|
87
|
+
|
88
|
+
Testing
|
89
|
+
-------
|
90
|
+
|
91
|
+
If you don't want to call the actual delivery method in your tests, you
|
92
|
+
can use `posten/test`:
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
require "posten/test"
|
96
|
+
|
97
|
+
posten = Posten.new
|
98
|
+
posten.deliver(to: "alice@posten.gem", subject: "hei")
|
99
|
+
|
100
|
+
Posten.deliveries.count # => 1
|
101
|
+
|
102
|
+
mail = Posten.deliveries.first
|
103
|
+
mail.to == "alice@posten.gem" # => true
|
104
|
+
mail.subject == "hei" # => true
|
105
|
+
|
106
|
+
mailer = UserMailer.new
|
107
|
+
mailer.welcome_mail(User.first)
|
108
|
+
|
109
|
+
UserMailer.deliveries.count # => 1
|
110
|
+
```
|
111
|
+
|
112
|
+
`Posten.deliveries` is simply an array. If you want to have a clean slate,
|
113
|
+
you can reset it manually using Array's `clear` method before each test is
|
114
|
+
executed. The next example uses the testing library [Cutest][cutest]:
|
115
|
+
|
116
|
+
```ruby
|
117
|
+
require "cutest"
|
118
|
+
require "posten/test"
|
119
|
+
|
120
|
+
setup do
|
121
|
+
Posten.deliveries.clear
|
122
|
+
end
|
123
|
+
|
124
|
+
scope "signup" do
|
125
|
+
test "welcome" do
|
126
|
+
post "/signup", email: "bob@posten.gem", name: "bob"
|
127
|
+
|
128
|
+
assert_equal 1, UserMailer.deliveries.count
|
129
|
+
|
130
|
+
mail = UserMailer.deliveries.first
|
131
|
+
|
132
|
+
assert_equal "bob@posten.gem", mail.to
|
133
|
+
assert /Welcome bob!/ === mail.text
|
134
|
+
end
|
135
|
+
end
|
136
|
+
```
|
137
|
+
|
138
|
+
SMTP Settings
|
139
|
+
-------------
|
140
|
+
|
141
|
+
This is a list of supported STMP settings:
|
142
|
+
|
143
|
+
| Option | Description | Default |
|
144
|
+
| ----------- | -------------------------------- | ------- |
|
145
|
+
| `:url` | URL connection | `nil` |
|
146
|
+
| `:host` | hostname or IP address | `nil` |
|
147
|
+
| `:port` | port to connect | `25` |
|
148
|
+
| `:user` | user for SMTP authentication | `nil` |
|
149
|
+
| `:password` | password for SMTP authentication | `nil` |
|
150
|
+
| `:domain` | HELO domain | `nil` |
|
151
|
+
| `:auth` | type of authentication | `nil` |
|
152
|
+
| `:tls` | enables SMTP/TLS | `true` |
|
153
|
+
|
154
|
+
Delivery Options
|
155
|
+
----------------
|
156
|
+
|
157
|
+
This is a list of supported delivery options:
|
158
|
+
|
159
|
+
```ruby
|
160
|
+
posten = Posten.new
|
161
|
+
|
162
|
+
posten.deliver(
|
163
|
+
from: "bob@posten.gem",
|
164
|
+
to: "alice@posten.gem",
|
165
|
+
subject: "Here are some files for you!",
|
166
|
+
text: "This is what people with plain text mail readers will see",
|
167
|
+
html: "A little something <b>special</b> for people with HTML readers",
|
168
|
+
cc: "carboncopy@posten.gem",
|
169
|
+
bcc: "blindcarboncopy@posten.gem",
|
170
|
+
attach: "/path/to/your/file.pdf",
|
171
|
+
attach_as: ["/path/to/your/file.pdf", "new_name.pdf"]
|
172
|
+
)
|
173
|
+
```
|
174
|
+
|
175
|
+
Installation
|
176
|
+
------------
|
177
|
+
|
178
|
+
```
|
179
|
+
$ gem install posten
|
180
|
+
```
|
181
|
+
|
182
|
+
[cutest]: https://github.com/djanowski/cutest
|
data/lib/posten.rb
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
require "malone"
|
2
|
+
require "seteable"
|
3
|
+
require_relative "posten/version"
|
4
|
+
|
5
|
+
class Posten
|
6
|
+
include Seteable
|
7
|
+
|
8
|
+
def self.connect(options)
|
9
|
+
settings[:smtp] = options
|
10
|
+
end
|
11
|
+
|
12
|
+
def self.defaults(defaults)
|
13
|
+
settings[:defaults].update(defaults)
|
14
|
+
end
|
15
|
+
|
16
|
+
def initialize
|
17
|
+
@malone = Malone.new(config)
|
18
|
+
end
|
19
|
+
|
20
|
+
private def config
|
21
|
+
return Malone::Configuration.new(smtp_settings)
|
22
|
+
end
|
23
|
+
|
24
|
+
private def smtp_settings
|
25
|
+
settings[:smtp] or raise("Missing configuration: Try `Posten.connect`")
|
26
|
+
end
|
27
|
+
|
28
|
+
def deliver(options)
|
29
|
+
return @malone.deliver(defaults.merge(options))
|
30
|
+
end
|
31
|
+
|
32
|
+
def defaults
|
33
|
+
return settings[:defaults]
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
Posten.settings[:defaults] = {}
|
data/lib/posten/test.rb
ADDED
data/posten.gemspec
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
require_relative "lib/posten/version"
|
2
|
+
|
3
|
+
Gem::Specification.new do |s|
|
4
|
+
s.name = "posten"
|
5
|
+
s.version = Posten::VERSION
|
6
|
+
s.summary = "Mail delivery"
|
7
|
+
s.description = s.summary
|
8
|
+
s.authors = ["Francesco Rodríguez"]
|
9
|
+
s.email = ["frodsan@protonmail.ch"]
|
10
|
+
s.homepage = "https://github.com/harmoni/posten"
|
11
|
+
s.license = "MIT"
|
12
|
+
|
13
|
+
s.files = `git ls-files`.split("\n")
|
14
|
+
|
15
|
+
s.add_dependency "malone", "~> 1.1.0"
|
16
|
+
s.add_dependency "seteable", "1.0.0"
|
17
|
+
s.add_development_dependency "bundler", "~> 1.10"
|
18
|
+
s.add_development_dependency "cutest", "~> 1.2"
|
19
|
+
end
|
data/test/posten_test.rb
ADDED
@@ -0,0 +1,98 @@
|
|
1
|
+
require "bundler/setup"
|
2
|
+
require "cutest"
|
3
|
+
require_relative "../lib/posten"
|
4
|
+
|
5
|
+
require "malone/test"
|
6
|
+
|
7
|
+
setup do
|
8
|
+
Malone.deliveries.clear
|
9
|
+
|
10
|
+
Posten.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587")
|
11
|
+
end
|
12
|
+
|
13
|
+
test "raise if not smtp settings" do
|
14
|
+
Posten.settings.delete(:smtp)
|
15
|
+
|
16
|
+
assert_raise do
|
17
|
+
Posten.new
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
test "settings" do
|
22
|
+
Posten.settings[:foo] = "foo"
|
23
|
+
|
24
|
+
Notifier = Class.new(Posten)
|
25
|
+
|
26
|
+
assert_equal "foo", Notifier.settings[:foo]
|
27
|
+
|
28
|
+
Notifier.settings[:foo] = "bar"
|
29
|
+
|
30
|
+
assert_equal "foo", Posten.settings[:foo]
|
31
|
+
assert_equal "bar", Notifier.settings[:foo]
|
32
|
+
end
|
33
|
+
|
34
|
+
test "defaults" do
|
35
|
+
Posten.defaults(from: "bob@posten.gem")
|
36
|
+
|
37
|
+
class EveMailer < Posten
|
38
|
+
defaults to: "eve@posten.gem"
|
39
|
+
end
|
40
|
+
|
41
|
+
params = { from: "bob@posten.gem" }
|
42
|
+
|
43
|
+
assert_equal params, Posten.settings[:defaults]
|
44
|
+
|
45
|
+
params = params.merge(to: "eve@posten.gem")
|
46
|
+
|
47
|
+
assert_equal params, EveMailer.settings[:defaults]
|
48
|
+
end
|
49
|
+
|
50
|
+
test "deliver use defaults" do
|
51
|
+
defaults = { from: "bob@posten.gem", to: "eve@posten.gem" }
|
52
|
+
|
53
|
+
Posten.defaults(defaults)
|
54
|
+
|
55
|
+
params = {
|
56
|
+
subject: "subject",
|
57
|
+
text: "text",
|
58
|
+
html: "<html></html>"
|
59
|
+
}
|
60
|
+
|
61
|
+
Posten.new.deliver(params)
|
62
|
+
|
63
|
+
options = Malone.deliveries.last.to_h
|
64
|
+
|
65
|
+
assert_equal options, defaults.merge(params)
|
66
|
+
|
67
|
+
class Mailer < Posten
|
68
|
+
defaults to: "alice@posten.gem"
|
69
|
+
end
|
70
|
+
|
71
|
+
Mailer.new.deliver(params)
|
72
|
+
|
73
|
+
defaults = defaults.merge(to: "alice@posten.gem")
|
74
|
+
|
75
|
+
options = Malone.deliveries.last.to_h
|
76
|
+
|
77
|
+
assert_equal options, defaults.merge(params)
|
78
|
+
end
|
79
|
+
|
80
|
+
test "testing" do
|
81
|
+
require_relative "../lib/posten/test"
|
82
|
+
|
83
|
+
defaults = { from: "bob@posten.gem", to: "eve@posten.gem" }
|
84
|
+
|
85
|
+
Posten.defaults(defaults)
|
86
|
+
|
87
|
+
params = {
|
88
|
+
subject: "subject",
|
89
|
+
text: "text",
|
90
|
+
html: "<html></html>"
|
91
|
+
}
|
92
|
+
|
93
|
+
Posten.new.deliver(params)
|
94
|
+
|
95
|
+
mail = Posten.deliveries.first
|
96
|
+
|
97
|
+
assert_equal defaults.merge(params), mail.to_h
|
98
|
+
end
|
metadata
ADDED
@@ -0,0 +1,110 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: posten
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Francesco Rodríguez
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-09-15 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: malone
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 1.1.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 1.1.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: seteable
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 1.0.0
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 1.0.0
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.10'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.10'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: cutest
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '1.2'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '1.2'
|
69
|
+
description: Mail delivery
|
70
|
+
email:
|
71
|
+
- frodsan@protonmail.ch
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- Gemfile
|
78
|
+
- LICENSE
|
79
|
+
- README.md
|
80
|
+
- lib/posten.rb
|
81
|
+
- lib/posten/test.rb
|
82
|
+
- lib/posten/version.rb
|
83
|
+
- makefile
|
84
|
+
- posten.gemspec
|
85
|
+
- test/posten_test.rb
|
86
|
+
homepage: https://github.com/harmoni/posten
|
87
|
+
licenses:
|
88
|
+
- MIT
|
89
|
+
metadata: {}
|
90
|
+
post_install_message:
|
91
|
+
rdoc_options: []
|
92
|
+
require_paths:
|
93
|
+
- lib
|
94
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
95
|
+
requirements:
|
96
|
+
- - ">="
|
97
|
+
- !ruby/object:Gem::Version
|
98
|
+
version: '0'
|
99
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
requirements: []
|
105
|
+
rubyforge_project:
|
106
|
+
rubygems_version: 2.4.8
|
107
|
+
signing_key:
|
108
|
+
specification_version: 4
|
109
|
+
summary: Mail delivery
|
110
|
+
test_files: []
|