paubox_rails 0.1.1 → 0.1.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/README.md +32 -6
- data/lib/paubox_rails/version.rb +1 -1
- data/paubox_rails.gemspec +7 -7
- metadata +28 -35
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ba84eed39a1ced7a4188e3b4d556e1eb0319af123cc42321bb13d07cadae126a
|
4
|
+
data.tar.gz: b146f6a504896c8c23a583de9ed7d0130b405aa07a8e6e20841a38aeff313f91
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 13add0018eaa4d54876b6ad7c34f99eb6929e1586a2f9bc0dea605ec8ba965f0b6ab9935b622c5ecbc68f196849dabf14978aeae3bcd9a7d429d7e35ad9354d9
|
7
|
+
data.tar.gz: d7b3839e27cd935f360dc5d919f68e2e0ea9820db93bceb003f90d1f9ffaca47494a938c3d954ae67e785d553f4e7aba4284f156ac7d630d012fa23bd60478b1
|
data/README.md
CHANGED
@@ -1,8 +1,13 @@
|
|
1
|
+
<img src="https://avatars.githubusercontent.com/u/22528478?s=200&v=4" alt="Paubox" width="150px">
|
2
|
+
|
1
3
|
# Paubox Rails
|
2
4
|
|
3
|
-
|
5
|
+
This gem extends the [Paubox Ruby Gem](https://github.com/paubox/paubox_ruby) for use with ActionMailer in Ruby on Rails.
|
6
|
+
|
7
|
+
The Paubox Email API allows your application to send secure, HIPAA compliant email via Paubox and track deliveries and opens.
|
4
8
|
|
5
|
-
|
9
|
+
## Compatibility
|
10
|
+
This gem has been tested and confirmed working with Rails 4-6
|
6
11
|
|
7
12
|
## Installation
|
8
13
|
|
@@ -22,8 +27,9 @@ Or install it yourself as:
|
|
22
27
|
|
23
28
|
|
24
29
|
### Getting Paubox API Credentials
|
25
|
-
You will need to have a Paubox account.
|
30
|
+
You will need to have a Paubox account. You can [sign up here](https://www.paubox.com/join/see-pricing?unit=messages).
|
26
31
|
|
32
|
+
Once you have an account, follow the instructions on the Rest API dashboard to verify domain ownership and generate API credentials.
|
27
33
|
|
28
34
|
### Configuring API Credentials
|
29
35
|
Create a new file at config/initializers/paubox.rb and add the following.
|
@@ -34,7 +40,7 @@ Paubox.configure do |config|
|
|
34
40
|
end
|
35
41
|
```
|
36
42
|
|
37
|
-
Keep your API credentials out of version control. Set
|
43
|
+
Note: Keep your unencrypted API credentials out of version control. Set as environment variables in a file that's not checked into version control, such as config/application.yml or config/secrets.yml. Better yet, use Rails Encrypted Secrets.
|
38
44
|
|
39
45
|
|
40
46
|
### Setting ActionMailer Delivery Method
|
@@ -46,8 +52,28 @@ config.action_mailer.delivery_method = :paubox
|
|
46
52
|
|
47
53
|
## Usage
|
48
54
|
|
49
|
-
|
55
|
+
You can use [Action Mailer](https://guides.rubyonrails.org/action_mailer_basics.html) as you normally would in a Rails app.
|
56
|
+
|
57
|
+
See the [Paubox Ruby Gem](https://github.com/Paubox/paubox_ruby) for more advanced usage examples.
|
58
|
+
|
59
|
+
## Allowing non-TLS message delivery with Action Mailer
|
60
|
+
|
61
|
+
Set ``allow_non_tls`` to true in the ``delivery_method_options`` hash argument and pass this into the mailer action.
|
50
62
|
|
63
|
+
For example:
|
64
|
+
|
65
|
+
```ruby
|
66
|
+
class UserMailer < ApplicationMailer
|
67
|
+
def welcome_email
|
68
|
+
@user = params[:user]
|
69
|
+
@url = user_url(@user)
|
70
|
+
delivery_options = { allow_non_tls: true }
|
71
|
+
mail(to: @user.email,
|
72
|
+
subject: "Welcome!",
|
73
|
+
delivery_method_options: delivery_options)
|
74
|
+
end
|
75
|
+
end
|
76
|
+
```
|
51
77
|
|
52
78
|
## Contributing
|
53
79
|
|
@@ -67,4 +93,4 @@ See the License for the specific language governing permissions and
|
|
67
93
|
limitations under the License.
|
68
94
|
|
69
95
|
## Copyright
|
70
|
-
Copyright ©
|
96
|
+
Copyright © 2021, Paubox, Inc.
|
data/lib/paubox_rails/version.rb
CHANGED
data/paubox_rails.gemspec
CHANGED
@@ -6,8 +6,8 @@ require 'paubox_rails/version'
|
|
6
6
|
Gem::Specification.new do |spec|
|
7
7
|
spec.name = "paubox_rails"
|
8
8
|
spec.version = PauboxRails::VERSION
|
9
|
-
spec.authors = ["
|
10
|
-
spec.email = ["
|
9
|
+
spec.authors = ["Paubox, Inc."]
|
10
|
+
spec.email = ["engineering@paubox.com"]
|
11
11
|
|
12
12
|
spec.summary = %q{Paubox Transactional Email API adapter for ActionMailer.'}
|
13
13
|
spec.description = %q{The Paubox Rails Gem integrates Paubox's Transactional Email HTTP API with ActionMailer.}
|
@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
|
|
22
22
|
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
23
23
|
spec.require_paths = ["lib"]
|
24
24
|
|
25
|
-
spec.add_development_dependency 'bundler', '~>
|
26
|
-
spec.add_development_dependency 'rake', '~> 10.0'
|
25
|
+
spec.add_development_dependency 'bundler', '~> 2.0'
|
27
26
|
spec.add_development_dependency 'rspec', '~> 3.2'
|
28
|
-
spec.add_development_dependency 'pry'
|
29
|
-
spec.
|
30
|
-
spec.add_dependency('
|
27
|
+
spec.add_development_dependency 'pry'
|
28
|
+
spec.add_development_dependency "rake", ">= 12.3.3"
|
29
|
+
spec.add_dependency('actionmailer', '>= 4.0')
|
30
|
+
spec.add_dependency('paubox', '~> 0.3', '>= 0.3.0')
|
31
31
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: paubox_rails
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.6
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
|
-
-
|
7
|
+
- Paubox, Inc.
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-09-27 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -16,56 +16,56 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: '
|
19
|
+
version: '2.0'
|
20
20
|
type: :development
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
24
|
- - "~>"
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version: '
|
26
|
+
version: '2.0'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
|
-
name:
|
28
|
+
name: rspec
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
31
|
- - "~>"
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: '
|
33
|
+
version: '3.2'
|
34
34
|
type: :development
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: '
|
40
|
+
version: '3.2'
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
|
-
name:
|
42
|
+
name: pry
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
|
-
- - "
|
45
|
+
- - ">="
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version: '
|
47
|
+
version: '0'
|
48
48
|
type: :development
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
|
-
- - "
|
52
|
+
- - ">="
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version: '
|
54
|
+
version: '0'
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
|
-
name:
|
56
|
+
name: rake
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
58
58
|
requirements:
|
59
|
-
- - "
|
59
|
+
- - ">="
|
60
60
|
- !ruby/object:Gem::Version
|
61
|
-
version:
|
61
|
+
version: 12.3.3
|
62
62
|
type: :development
|
63
63
|
prerelease: false
|
64
64
|
version_requirements: !ruby/object:Gem::Requirement
|
65
65
|
requirements:
|
66
|
-
- - "
|
66
|
+
- - ">="
|
67
67
|
- !ruby/object:Gem::Version
|
68
|
-
version:
|
68
|
+
version: 12.3.3
|
69
69
|
- !ruby/object:Gem::Dependency
|
70
70
|
name: actionmailer
|
71
71
|
requirement: !ruby/object:Gem::Requirement
|
@@ -73,9 +73,6 @@ dependencies:
|
|
73
73
|
- - ">="
|
74
74
|
- !ruby/object:Gem::Version
|
75
75
|
version: '4.0'
|
76
|
-
- - "<="
|
77
|
-
- !ruby/object:Gem::Version
|
78
|
-
version: '5.2'
|
79
76
|
type: :runtime
|
80
77
|
prerelease: false
|
81
78
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -83,33 +80,30 @@ dependencies:
|
|
83
80
|
- - ">="
|
84
81
|
- !ruby/object:Gem::Version
|
85
82
|
version: '4.0'
|
86
|
-
- - "<="
|
87
|
-
- !ruby/object:Gem::Version
|
88
|
-
version: '5.2'
|
89
83
|
- !ruby/object:Gem::Dependency
|
90
84
|
name: paubox
|
91
85
|
requirement: !ruby/object:Gem::Requirement
|
92
86
|
requirements:
|
93
|
-
- - "~>"
|
94
|
-
- !ruby/object:Gem::Version
|
95
|
-
version: '0.1'
|
96
87
|
- - ">="
|
97
88
|
- !ruby/object:Gem::Version
|
98
|
-
version: 0.
|
89
|
+
version: 0.3.0
|
90
|
+
- - "~>"
|
91
|
+
- !ruby/object:Gem::Version
|
92
|
+
version: '0.3'
|
99
93
|
type: :runtime
|
100
94
|
prerelease: false
|
101
95
|
version_requirements: !ruby/object:Gem::Requirement
|
102
96
|
requirements:
|
103
|
-
- - "~>"
|
104
|
-
- !ruby/object:Gem::Version
|
105
|
-
version: '0.1'
|
106
97
|
- - ">="
|
107
98
|
- !ruby/object:Gem::Version
|
108
|
-
version: 0.
|
99
|
+
version: 0.3.0
|
100
|
+
- - "~>"
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: '0.3'
|
109
103
|
description: The Paubox Rails Gem integrates Paubox's Transactional Email HTTP API
|
110
104
|
with ActionMailer.
|
111
105
|
email:
|
112
|
-
-
|
106
|
+
- engineering@paubox.com
|
113
107
|
executables: []
|
114
108
|
extensions: []
|
115
109
|
extra_rdoc_files: []
|
@@ -146,8 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
146
140
|
- !ruby/object:Gem::Version
|
147
141
|
version: '0'
|
148
142
|
requirements: []
|
149
|
-
|
150
|
-
rubygems_version: 2.6.13
|
143
|
+
rubygems_version: 3.0.3
|
151
144
|
signing_key:
|
152
145
|
specification_version: 4
|
153
146
|
summary: Paubox Transactional Email API adapter for ActionMailer.'
|