paubox_rails 0.1.3 → 0.1.4

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 3789b01ff7af1c9d011cb8f44712ae0fdc61165a
4
- data.tar.gz: 0322ae0f1b1700dd7d3a78e1ea689e52bb111dbe
2
+ SHA256:
3
+ metadata.gz: 9a023452d054705c5dc7907d3858d8719554962a34616f2ff20bdbc9140b5dcd
4
+ data.tar.gz: 04d69a975c4ab61e942f9de49ebdf7d8e1b17f0d683858db4b950f4f5dc3644e
5
5
  SHA512:
6
- metadata.gz: 746a6d3006b5d5999f04457b5ced89d15ac4134e5fb6d61927680ed8c323e691a614a75b0483046ad4cfe16201d9d85a2ff8fceb2c8c9618a4c56dd763f1bb17
7
- data.tar.gz: 5eb59dcd86c6870329c667f51694bfb7f96a9ccbac86f133c79bc5f6f258c82b22f1b5a9dd5dbbaa3d9dff1fdb2664317d2af379ff0925ac172ee65853d3a986
6
+ metadata.gz: ad6ce3024228e34780a5e8e799c30f38671a7bbe61ba5b2efb4c6970cf2240aa636a0801950a74a6a84d92ca22ee071ab2823346753787de1d2a7e2df4b5d1ac
7
+ data.tar.gz: 2dac98b6ed9f8d9935893ed0ad68970966e55bbb6f15fe404676cfbeee903e5028a1c59bf8c088167e8787826dbc89d9ba407c95159c1194b19fbfcaa6d3c111
data/.gitignore CHANGED
@@ -1,13 +1,13 @@
1
- /.bundle/
2
- /.yardoc
3
- /Gemfile.lock
4
- /_yardoc/
5
- /coverage/
6
- /doc/
7
- /pkg/
8
- /spec/reports/
9
- /tmp/
10
-
11
- # rspec failure tracking
12
- .rspec_status
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
13
13
  *.gem
data/.rspec CHANGED
@@ -1,2 +1,2 @@
1
- --format documentation
2
- --color
1
+ --format documentation
2
+ --color
@@ -1,5 +1,5 @@
1
- sudo: false
2
- language: ruby
3
- rvm:
4
- - 2.3.1
5
- before_install: gem install bundler -v 1.14.6
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.14.6
data/Gemfile CHANGED
@@ -1,4 +1,4 @@
1
- source 'https://rubygems.org'
2
-
3
- # Specify your gem's dependencies in paubox_rails.gemspec
4
- gemspec
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in paubox_rails.gemspec
4
+ gemspec
@@ -1,21 +1,21 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2018 Jonathan Greeley
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.
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Jonathan Greeley
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 CHANGED
@@ -1,74 +1,94 @@
1
- <img src="https://github.com/Paubox/paubox-csharp/raw/master/paubox_logo.png" alt="Paubox" width="150px">
2
-
3
- # Paubox Rails
4
-
5
- This gem extends the [Paubox Ruby Gem](https://github.com/paubox/paubox_ruby) for use with ActionMailer in Ruby on Rails. Paubox Ruby the official Ruby wrapper for the Paubox Transactional Email HTTP API. The Paubox Transactional Email API allows your application to send secure, HIPAA-compliant email via Paubox and track deliveries and opens.
6
-
7
- This gem, Paubox Ruby, and Paubox Transactional Email HTTP API are currently in alpha development.
8
-
9
-
10
- ## Installation
11
-
12
- Add this line to your application's Gemfile:
13
-
14
- ```ruby
15
- gem 'paubox_rails'
16
- ```
17
-
18
- And then execute:
19
-
20
- $ bundle
21
-
22
- Or install it yourself as:
23
-
24
- $ gem install paubox_rails
25
-
26
-
27
- ### Getting Paubox API Credentials
28
- You will need to have a Paubox account. You can [sign up here](https://www.paubox.com/join/see-pricing?unit=messages).
29
-
30
- Once you have an account, follow the instructions on the Rest API dashboard to verify domain ownership and generate API credentials.
31
-
32
- ### Configuring API Credentials
33
- Create a new file at config/initializers/paubox.rb and add the following.
34
- ```ruby
35
- Paubox.configure do |config|
36
- config.api_key = ENV['PAUBOX_API_KEY']
37
- config.api_user = ENV['PAUBOX_API_USER']
38
- end
39
- ```
40
-
41
- Keep your API credentials out of version control. Set these environmental variables in a file that's not checked into version control, such as config/application.yml or config/secrets.yml.
42
-
43
-
44
- ### Setting ActionMailer Delivery Method
45
-
46
- Add the following to the configuration block in config/application.rb or the desired environment config in config/environments (e.g. config/environments/production.rb for production.)
47
- ```ruby
48
- config.action_mailer.delivery_method = :paubox
49
- ```
50
-
51
- ## Usage
52
-
53
- See the [Paubox Ruby Gem](https://github.com/Paubox/paubox_ruby) for usage examples.
54
-
55
-
56
- ## Contributing
57
-
58
- Bug reports and pull requests are welcome on GitHub at https://github.com/paubox/paubox_rails.
59
-
60
-
61
- ## License
62
-
63
- Licensed under the Apache License, Version 2.0 (the "License");
64
- you may not use this file except in compliance with the License.
65
- You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
66
-
67
- Unless required by applicable law or agreed to in writing, software
68
- distributed under the License is distributed on an "AS IS" BASIS,
69
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
70
- See the License for the specific language governing permissions and
71
- limitations under the License.
72
-
73
- ## Copyright
74
- Copyright &copy; 2018, Paubox Inc.
1
+ <img src="https://github.com/Paubox/paubox-csharp/raw/master/paubox_logo.png" alt="Paubox" width="150px">
2
+
3
+ # Paubox Rails
4
+
5
+ This gem extends the [Paubox Ruby Gem](https://github.com/paubox/paubox_ruby) for use with ActionMailer in Ruby on Rails. Paubox Ruby the official Ruby wrapper for the Paubox Transactional Email HTTP API. The Paubox Transactional Email API allows your application to send secure, HIPAA-compliant email via Paubox and track deliveries and opens.
6
+
7
+ This gem, Paubox Ruby, and Paubox Transactional Email HTTP API are currently in alpha development.
8
+
9
+
10
+ ## Installation
11
+
12
+ Add this line to your application's Gemfile:
13
+
14
+ ```ruby
15
+ gem 'paubox_rails'
16
+ ```
17
+
18
+ And then execute:
19
+
20
+ $ bundle
21
+
22
+ Or install it yourself as:
23
+
24
+ $ gem install paubox_rails
25
+
26
+
27
+ ### Getting Paubox API Credentials
28
+ You will need to have a Paubox account. You can [sign up here](https://www.paubox.com/join/see-pricing?unit=messages).
29
+
30
+ Once you have an account, follow the instructions on the Rest API dashboard to verify domain ownership and generate API credentials.
31
+
32
+ ### Configuring API Credentials
33
+ Create a new file at config/initializers/paubox.rb and add the following.
34
+ ```ruby
35
+ Paubox.configure do |config|
36
+ config.api_key = ENV['PAUBOX_API_KEY']
37
+ config.api_user = ENV['PAUBOX_API_USER']
38
+ end
39
+ ```
40
+
41
+ Keep your API credentials out of version control. Set these environmental variables in a file that's not checked into version control, such as config/application.yml or config/secrets.yml.
42
+
43
+
44
+ ### Setting ActionMailer Delivery Method
45
+
46
+ Add the following to the configuration block in config/application.rb or the desired environment config in config/environments (e.g. config/environments/production.rb for production.)
47
+ ```ruby
48
+ config.action_mailer.delivery_method = :paubox
49
+ ```
50
+
51
+ ## Usage
52
+
53
+ You can use [Action Mailer](https://guides.rubyonrails.org/action_mailer_basics.html) as you normally would in a Rails app.
54
+
55
+ See the [Paubox Ruby Gem](https://github.com/Paubox/paubox_ruby) for more advanced usage examples.
56
+
57
+ ## Allowing non-TLS message delivery with Action Mailer
58
+
59
+ Set ``allow_non_tls`` to true in the ``delivery_method_options`` hash argument and pass this into the mailer action.
60
+
61
+ For example:
62
+
63
+ ```ruby
64
+ class UserMailer < ApplicationMailer
65
+ def welcome_email
66
+ @user = params[:user]
67
+ @url = user_url(@user)
68
+ delivery_options = { allow_non_tls: true }
69
+ mail(to: @user.email,
70
+ subject: "Welcome!",
71
+ delivery_method_options: delivery_options)
72
+ end
73
+ end
74
+ ```
75
+
76
+ ## Contributing
77
+
78
+ Bug reports and pull requests are welcome on GitHub at https://github.com/paubox/paubox_rails.
79
+
80
+
81
+ ## License
82
+
83
+ Licensed under the Apache License, Version 2.0 (the "License");
84
+ you may not use this file except in compliance with the License.
85
+ You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
86
+
87
+ Unless required by applicable law or agreed to in writing, software
88
+ distributed under the License is distributed on an "AS IS" BASIS,
89
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
90
+ See the License for the specific language governing permissions and
91
+ limitations under the License.
92
+
93
+ ## Copyright
94
+ Copyright &copy; 2019, Paubox Inc.
data/Rakefile CHANGED
@@ -1,6 +1,6 @@
1
- require "bundler/gem_tasks"
2
- require "rspec/core/rake_task"
3
-
4
- RSpec::Core::RakeTask.new(:spec)
5
-
6
- task :default => :spec
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -1,14 +1,14 @@
1
- #!/usr/bin/env ruby
2
-
3
- require "bundler/setup"
4
- require "paubox_rails"
5
-
6
- # You can add fixtures and/or initialization code here to make experimenting
7
- # with your gem easier. You can also use a different console, if you like.
8
-
9
- # (If you use this, don't forget to add pry to your Gemfile!)
10
- # require "pry"
11
- # Pry.start
12
-
13
- require "irb"
14
- IRB.start(__FILE__)
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "paubox_rails"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup CHANGED
@@ -1,8 +1,8 @@
1
- #!/usr/bin/env bash
2
- set -euo pipefail
3
- IFS=$'\n\t'
4
- set -vx
5
-
6
- bundle install
7
-
8
- # Do any other automated setup that you need to do here
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -1,17 +1,17 @@
1
- require "paubox_rails/version"
2
- require 'action_mailer'
3
- require 'paubox'
4
-
5
- module PauboxRails
6
- extend self
7
-
8
- def add_base_delivery
9
- ActionMailer::Base.add_delivery_method :paubox, Mail::Paubox
10
- end
11
- end
12
-
13
- if defined?(Rails)
14
- require 'paubox_rails/railtie'
15
- else
16
- PauboxRails.add_base_delivery
1
+ require "paubox_rails/version"
2
+ require 'action_mailer'
3
+ require 'paubox'
4
+
5
+ module PauboxRails
6
+ extend self
7
+
8
+ def add_base_delivery
9
+ ActionMailer::Base.add_delivery_method :paubox, Mail::Paubox
10
+ end
11
+ end
12
+
13
+ if defined?(Rails)
14
+ require 'paubox_rails/railtie'
15
+ else
16
+ PauboxRails.add_base_delivery
17
17
  end
@@ -1,9 +1,9 @@
1
- module PauboxRails
2
- class Railtie < Rails::Railtie
3
- initializer 'paubox_rails', :before => 'action_mailer.set_configs' do
4
- ActiveSupport.on_load :action_mailer do
5
- PauboxRails.add_base_delivery
6
- end
7
- end
8
- end
9
- end
1
+ module PauboxRails
2
+ class Railtie < Rails::Railtie
3
+ initializer 'paubox_rails', :before => 'action_mailer.set_configs' do
4
+ ActiveSupport.on_load :action_mailer do
5
+ PauboxRails.add_base_delivery
6
+ end
7
+ end
8
+ end
9
+ end
@@ -1,3 +1,3 @@
1
- module PauboxRails
2
- VERSION = "0.1.3"
3
- end
1
+ module PauboxRails
2
+ VERSION = "0.1.4"
3
+ end
@@ -1,31 +1,31 @@
1
- # coding: utf-8
2
- lib = File.expand_path('../lib', __FILE__)
3
- $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
- require 'paubox_rails/version'
5
-
6
- Gem::Specification.new do |spec|
7
- spec.name = "paubox_rails"
8
- spec.version = PauboxRails::VERSION
9
- spec.authors = ["Jonathan Greeley"]
10
- spec.email = ["jonathan@paubox.com"]
11
-
12
- spec.summary = %q{Paubox Transactional Email API adapter for ActionMailer.'}
13
- spec.description = %q{The Paubox Rails Gem integrates Paubox's Transactional Email HTTP API with ActionMailer.}
14
- spec.homepage = "https://www.paubox.com"
15
- spec.license = 'Apache-2.0'
16
-
17
- spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
- f.match(%r{^(test|spec|features)/})
19
- end
20
-
21
- spec.bindir = "exe"
22
- spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
- spec.require_paths = ["lib"]
24
-
25
- spec.add_development_dependency 'bundler', '~> 1.14'
26
- spec.add_development_dependency 'rake', '~> 10.0'
27
- spec.add_development_dependency 'rspec', '~> 3.2'
28
- spec.add_development_dependency 'pry', '~> 0.10.4'
29
- spec.add_dependency('actionmailer', '>= 4.0', '<= 5.3')
30
- spec.add_dependency('paubox', '~> 0.2', '>= 0.2.3')
31
- end
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'paubox_rails/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "paubox_rails"
8
+ spec.version = PauboxRails::VERSION
9
+ spec.authors = ["Jonathan Greeley"]
10
+ spec.email = ["jonathan@paubox.com"]
11
+
12
+ spec.summary = %q{Paubox Transactional Email API adapter for ActionMailer.'}
13
+ spec.description = %q{The Paubox Rails Gem integrates Paubox's Transactional Email HTTP API with ActionMailer.}
14
+ spec.homepage = "https://www.paubox.com"
15
+ spec.license = 'Apache-2.0'
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+
21
+ spec.bindir = "exe"
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ["lib"]
24
+
25
+ spec.add_development_dependency 'bundler', '~> 1.14'
26
+ spec.add_development_dependency 'rake', '~> 10.0'
27
+ spec.add_development_dependency 'rspec', '~> 3.2'
28
+ spec.add_development_dependency 'pry', '~> 0.10.4'
29
+ spec.add_dependency('actionmailer', '>= 4.0', '<= 5.3')
30
+ spec.add_dependency('paubox', '~> 0.3', '>= 0.3.0')
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.3
4
+ version: 0.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jonathan Greeley
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2018-10-04 00:00:00.000000000 Z
11
+ date: 2019-07-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -90,22 +90,22 @@ dependencies:
90
90
  name: paubox
91
91
  requirement: !ruby/object:Gem::Requirement
92
92
  requirements:
93
- - - "~>"
94
- - !ruby/object:Gem::Version
95
- version: '0.2'
96
93
  - - ">="
97
94
  - !ruby/object:Gem::Version
98
- version: 0.2.3
95
+ version: 0.3.0
96
+ - - "~>"
97
+ - !ruby/object:Gem::Version
98
+ version: '0.3'
99
99
  type: :runtime
100
100
  prerelease: false
101
101
  version_requirements: !ruby/object:Gem::Requirement
102
102
  requirements:
103
- - - "~>"
104
- - !ruby/object:Gem::Version
105
- version: '0.2'
106
103
  - - ">="
107
104
  - !ruby/object:Gem::Version
108
- version: 0.2.3
105
+ version: 0.3.0
106
+ - - "~>"
107
+ - !ruby/object:Gem::Version
108
+ version: '0.3'
109
109
  description: The Paubox Rails Gem integrates Paubox's Transactional Email HTTP API
110
110
  with ActionMailer.
111
111
  email:
@@ -146,8 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
146
146
  - !ruby/object:Gem::Version
147
147
  version: '0'
148
148
  requirements: []
149
- rubyforge_project:
150
- rubygems_version: 2.6.13
149
+ rubygems_version: 3.0.1
151
150
  signing_key:
152
151
  specification_version: 4
153
152
  summary: Paubox Transactional Email API adapter for ActionMailer.'