jellyfish-notification 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/LICENSE +201 -0
- data/README.md +72 -0
- data/Rakefile +18 -0
- data/app/assets/javascripts/jellyfish_notification/application.js +13 -0
- data/app/assets/stylesheets/jellyfish_notification/application.css +15 -0
- data/app/controllers/jellyfish_notification/application_controller.rb +4 -0
- data/app/helpers/jellyfish_notification/application_helper.rb +4 -0
- data/app/views/jellyfish_mailer/publish_order_create.html.erb +32 -0
- data/app/views/jellyfish_mailer/publish_order_create.text.erb +9 -0
- data/app/views/jellyfish_mailer/publish_project_approval_update.html.erb +16 -0
- data/app/views/jellyfish_mailer/publish_project_approval_update.text.erb +8 -0
- data/app/views/jellyfish_mailer/publish_project_create_approvers.html.erb +16 -0
- data/app/views/jellyfish_mailer/publish_project_create_approvers.text.erb +8 -0
- data/app/views/jellyfish_mailer/publish_project_create_confirmation.html.erb +16 -0
- data/app/views/jellyfish_mailer/publish_project_create_confirmation.text.erb +8 -0
- data/app/views/layouts/jellyfish_notification/application.html.erb +14 -0
- data/config/enironments/test.rb +15 -0
- data/config/initializers/application.rb +12 -0
- data/config/initializers/default.rb +3 -0
- data/config/routes.rb +2 -0
- data/lib/jellyfish-notification.rb +2 -0
- data/lib/jellyfish_notification/engine.rb +9 -0
- data/lib/jellyfish_notification/jellyfish_mailer.rb +38 -0
- data/lib/jellyfish_notification/simple_listener.rb +32 -0
- data/lib/jellyfish_notification/version.rb +3 -0
- data/lib/jellyfish_notification.rb +4 -0
- data/lib/tasks/jellyfish_notification_tasks.rake +4 -0
- metadata +141 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 6ca67009e7fc8630306f3a9a003a0e42b906f8ca
|
4
|
+
data.tar.gz: c23de5a583f4808f8250bf2daed3045d20e0ddc2
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b9b0d8f1fae0661c8ad5924e50dce15b23513c6e156ad8b1a2474de857af43c495ed6d57ddf68bb2a09f222c29f1777f4d059ed41f872618244e36c41db552d9
|
7
|
+
data.tar.gz: 71bdc46c0248e93f739af96c06e61e074b9b4467ebc873e6ac25ecc9f93ac2ffa8957f8a1943bc632e58052bc5149b6e3d3e5ffaf40d8ce4cdb8c522c5d2e696
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright 2015 Booz Allen Hamilton
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,72 @@
|
|
1
|
+
Jellyfish Notification
|
2
|
+
=======
|
3
|
+
A notification system for [Project Jellyfish] (https://github.com/projectjellyfish/api). Can be used to send email notifications to users on project create and approval or order create.
|
4
|
+
|
5
|
+
#### Installation
|
6
|
+
Include in Gemfile:
|
7
|
+
```
|
8
|
+
gem 'jellyfish-notification'
|
9
|
+
```
|
10
|
+
|
11
|
+
Run `bundle install`.
|
12
|
+
|
13
|
+
Then add mail settings to your `.env` file:
|
14
|
+
```
|
15
|
+
JELLYFISH_ASYNCHRONOUS_DELIVERY = false
|
16
|
+
JELLYFISH_DELIVERY_METHOD = smtp
|
17
|
+
JELLYFISH_SMTP_ADDRESS = smtp.postmarkapp.com
|
18
|
+
JELLYFISH_SMTP_PORT = 587
|
19
|
+
JELLYFISH_SMTP_USER_NAME = POSTMARK-SERVER-API-TOKEN
|
20
|
+
JELLYFISH_SMTP_PASSWORD = POSTMARK-SERVER-API-TOKEN
|
21
|
+
JELLYFISH_SMTP_AUTHENTICATION = plain
|
22
|
+
JELLYFISH_SMTP_ENABLE_STARTTLS_AUTO = true
|
23
|
+
JELLYFISH_SMTP_DEFAULT_RECIPIENT = recipient@foobar.com
|
24
|
+
JELLYFISH_SMTP_DEFAULT_SENDER = sender@foobar.com
|
25
|
+
```
|
26
|
+
|
27
|
+
**Setting Descriptions**:
|
28
|
+
- `JELLYFISH_ASYNCHRONOUS_DELIVERY` will send mail asynchronously using Delayed Jobs if set to `true`. By default, the mailer will block until a message is sent.
|
29
|
+
|
30
|
+
- `JELLYFISH_DELIVERY_METHOD` specifies the delivery method used by ActionMailer.
|
31
|
+
|
32
|
+
- `JELLYFISH_SMTP_ADDRESS` is the address of your SMTP server.
|
33
|
+
|
34
|
+
- `JELLYFISH_SMTP_PORT` is the port of your SMTP server.
|
35
|
+
|
36
|
+
- `JELLYFISH_SMTP_USER_NAME` is your STMP user name. If sending mail through Postmark, this value will be your POSTMARK-SERVER-API-TOKEN.
|
37
|
+
|
38
|
+
- `JELLYFISH_SMTP_PASSWORD` is your STMP password. If sending mail through Postmark, this value will be your POSTMARK-SERVER-API-TOKEN.
|
39
|
+
|
40
|
+
- `JELLYFISH_SMTP_AUTHENTICATION` specifies authentication. If sending mail through Postmark, this value can be plain, CRAM-MD5 or TLS .
|
41
|
+
|
42
|
+
- `JELLYFISH_SMTP_ENABLE_STARTTLS_AUTO` specifies whether to start TLS automatically.
|
43
|
+
|
44
|
+
- `JELLYFISH_SMTP_DEFAULT_RECIPIENT` is the default recipient address.
|
45
|
+
|
46
|
+
- `JELLYFISH_SMTP_DEFAULT_SENDER` is the default sender address.
|
47
|
+
|
48
|
+
### Usage
|
49
|
+
The Jellyfish Notification gem has handlers for certain events that occur in the Jellyfish API:
|
50
|
+
- Project Create
|
51
|
+
- Project Approval
|
52
|
+
- Order Create
|
53
|
+
|
54
|
+
which can be orchestrated inside of their respective controller using the [Wisper](https://github.com/krisleech/wisper) gem.
|
55
|
+
```ruby
|
56
|
+
class OrdersController < ApplicationController
|
57
|
+
include Wisper::Publisher
|
58
|
+
after_action :publish_order_create, only: [:create]
|
59
|
+
...
|
60
|
+
def publish_order_create
|
61
|
+
recipients = current_user.email
|
62
|
+
orders_url = "#{request.protocol}#{request.host_with_port}/order-history"
|
63
|
+
publish(:publish_order_create, @order, recipients, orders_url)
|
64
|
+
end
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
### License
|
69
|
+
|
70
|
+
See [LICENSE](https://github.com/projectjellyfish/jellyfish-notification/blob/master/LICENSE).
|
71
|
+
|
72
|
+
Copyright 2015 Booz Allen Hamilton
|
data/Rakefile
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
begin
|
2
|
+
require 'bundler/setup'
|
3
|
+
rescue LoadError
|
4
|
+
puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
|
5
|
+
end
|
6
|
+
|
7
|
+
APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
|
8
|
+
load 'rails/tasks/engine.rake'
|
9
|
+
|
10
|
+
Bundler::GemHelper.install_tasks
|
11
|
+
|
12
|
+
Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
|
13
|
+
|
14
|
+
require 'rspec/core'
|
15
|
+
require 'rspec/core/rake_task'
|
16
|
+
desc 'Run all specs in spec directory'
|
17
|
+
RSpec::Core::RakeTask.new(:spec)
|
18
|
+
task default: :spec
|
@@ -0,0 +1,13 @@
|
|
1
|
+
// This is a manifest file that'll be compiled into application.js, which will include all the files
|
2
|
+
// listed below.
|
3
|
+
//
|
4
|
+
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
|
5
|
+
// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
|
6
|
+
//
|
7
|
+
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
|
8
|
+
// compiled file.
|
9
|
+
//
|
10
|
+
// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
|
11
|
+
// about supported directives.
|
12
|
+
//
|
13
|
+
//= require_tree .
|
@@ -0,0 +1,15 @@
|
|
1
|
+
/*
|
2
|
+
* This is a manifest file that'll be compiled into application.css, which will include all the files
|
3
|
+
* listed below.
|
4
|
+
*
|
5
|
+
* Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
|
6
|
+
* or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
|
7
|
+
*
|
8
|
+
* You're free to add application-wide styles to this file and they'll appear at the bottom of the
|
9
|
+
* compiled file so the styles you add here take precedence over styles defined in any styles
|
10
|
+
* defined in the other CSS/SCSS files in this directory. It is generally better to create a new
|
11
|
+
* file per style scope.
|
12
|
+
*
|
13
|
+
*= require_tree .
|
14
|
+
*= require_self
|
15
|
+
*/
|
@@ -0,0 +1,32 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
|
5
|
+
</head>
|
6
|
+
<body>
|
7
|
+
<p>Dear Admin,</p>
|
8
|
+
<p>An order has been placed with the following items:</p>
|
9
|
+
<table>
|
10
|
+
<thead>
|
11
|
+
<tr>
|
12
|
+
<td><b>Product Type</b></td>
|
13
|
+
<td><b>Product</b></td>
|
14
|
+
<td><b>Project</b></td>
|
15
|
+
</tr>
|
16
|
+
</thead>
|
17
|
+
<tbody>
|
18
|
+
<% @order.order_items.each do |o| %>
|
19
|
+
<tr>
|
20
|
+
<td><%= o.product.product_type.name %></td>
|
21
|
+
<td><%= o.product.name %></td>
|
22
|
+
<td><%= o.project.name %></td>
|
23
|
+
</tr>
|
24
|
+
<% end %>
|
25
|
+
</tbody>
|
26
|
+
</table>
|
27
|
+
<p>Order details can be found at <a href="<%= @order_url %>"><%= @order_url %></a>.</p>
|
28
|
+
<p>No further action is required at this point.</p>
|
29
|
+
<p>Thank you,</p>
|
30
|
+
<p>Project Jellyfish Mailer</p>
|
31
|
+
</body>
|
32
|
+
</html>
|
@@ -0,0 +1,9 @@
|
|
1
|
+
Dear Admin,
|
2
|
+
An order has been placed with the following items:
|
3
|
+
<% @order.order_items.each do |o| %>
|
4
|
+
Product Type: <%= o.product.product_type.name %>, Product: <%= o.product.name %>, Project: <%= o.project.name %>
|
5
|
+
<% end %>
|
6
|
+
Order details can be found at <%= @order_url %>.
|
7
|
+
No further action is required at this point.
|
8
|
+
Thank you,
|
9
|
+
Project Jellyfish Mailer
|
@@ -0,0 +1,16 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
|
5
|
+
</head>
|
6
|
+
<body>
|
7
|
+
<p>Dear Admin,</p>
|
8
|
+
<p>The following project has been approved:</p>
|
9
|
+
<p> Name: <%= @project.name.to_s.upcase %></p>
|
10
|
+
<p> Budget: <%= number_to_currency(@project.budget) %></p>
|
11
|
+
<p> URL: <a href="<%= @project_url %>"><%= @project_url %></a></p>
|
12
|
+
<p>No further action is required at this point.</p>
|
13
|
+
<p>Thank you,</p>
|
14
|
+
<p>Project Jellyfish Mailer</p>
|
15
|
+
</body>
|
16
|
+
</html>
|
@@ -0,0 +1,16 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
|
5
|
+
</head>
|
6
|
+
<body>
|
7
|
+
<p>Dear Admin,</p>
|
8
|
+
<p>The following project has been created:</p>
|
9
|
+
<p> Name: <%= @project['name'].to_s.upcase %></p>
|
10
|
+
<p> Budget: <%= number_to_currency(@project['budget']) %></p>
|
11
|
+
<p> URL: <a href="<%= @project_url %>"><%= @project_url %></a></p>
|
12
|
+
<p>Please navigate to the project and approve it at your discretion.</p>
|
13
|
+
<p>Thank you,</p>
|
14
|
+
<p>Project Jellyfish Mailer</p>
|
15
|
+
</body>
|
16
|
+
</html>
|
@@ -0,0 +1,8 @@
|
|
1
|
+
Dear Admin,
|
2
|
+
The following project has been created:
|
3
|
+
Name: <%= @project['name'].to_s.upcase %>
|
4
|
+
Budget: <%= number_to_currency(@project['budget']) %>
|
5
|
+
URL: <%= @project_url %>
|
6
|
+
Please navigate to the project and approve it at your discretion.
|
7
|
+
Thank you,
|
8
|
+
Project Jellyfish Mailer
|
@@ -0,0 +1,16 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
|
5
|
+
</head>
|
6
|
+
<body>
|
7
|
+
<p>Dear User,</p>
|
8
|
+
<p>The following project has been created:</p>
|
9
|
+
<p> Name: <%= @project['name'].to_s.upcase %></p>
|
10
|
+
<p> Budget: <%= number_to_currency(@project['budget']) %></p>
|
11
|
+
<p> URL: <a href="<%= @project_url %>"><%= @project_url %></a></p>
|
12
|
+
<p>Please wait for admin approval before using the project.</p>
|
13
|
+
<p>Thank you,</p>
|
14
|
+
<p>Project Jellyfish Mailer</p>
|
15
|
+
</body>
|
16
|
+
</html>
|
@@ -0,0 +1,8 @@
|
|
1
|
+
Dear User,
|
2
|
+
The following project has been created:
|
3
|
+
Name: <%= @project['name'].to_s.upcase %>
|
4
|
+
Budget: <%= number_to_currency(@project['budget']) %>
|
5
|
+
URL: <%= @project_url %>
|
6
|
+
Please wait for admin approval before using the project.
|
7
|
+
Thank you,
|
8
|
+
Project Jellyfish Mailer
|
@@ -0,0 +1,14 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<title>JellyfishNotification</title>
|
5
|
+
<%= stylesheet_link_tag "jellyfish_notification/application", media: "all" %>
|
6
|
+
<%= javascript_include_tag "jellyfish_notification/application" %>
|
7
|
+
<%= csrf_meta_tags %>
|
8
|
+
</head>
|
9
|
+
<body>
|
10
|
+
|
11
|
+
<%= yield %>
|
12
|
+
|
13
|
+
</body>
|
14
|
+
</html>
|
@@ -0,0 +1,15 @@
|
|
1
|
+
Rails.application.configure do
|
2
|
+
config.action_mailer.delivery_method = :test
|
3
|
+
config.action_mailer.smtp_settings = {
|
4
|
+
address: 'smtp.foo.com',
|
5
|
+
port: '587',
|
6
|
+
user_name: 'foobar',
|
7
|
+
password: 'foobar',
|
8
|
+
authentication: 'plain',
|
9
|
+
enable_starttls_auto: 'true'
|
10
|
+
}
|
11
|
+
config.action_mailer.default_params = {
|
12
|
+
from: 'tester@foo.com',
|
13
|
+
to: 'tested@foo.com'
|
14
|
+
}
|
15
|
+
end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
Rails.application.configure do
|
2
|
+
config.action_mailer.delivery_method = :smtp unless ENV['JELLYFISH_DELIVERY_METHOD'] != 'smtp'
|
3
|
+
config.action_mailer.delivery_method = :test if Rails.env == 'test'
|
4
|
+
config.action_mailer.smtp_settings = {
|
5
|
+
address: ENV['JELLYFISH_SMTP_ADDRESS'],
|
6
|
+
port: ENV['JELLYFISH_SMTP_PORT'],
|
7
|
+
user_name: ENV['JELLYFISH_SMTP_USER_NAME'],
|
8
|
+
password: ENV['JELLYFISH_SMTP_PASSWORD'],
|
9
|
+
authentication: ENV['JELLYFISH_SMTP_AUTHENTICATION'],
|
10
|
+
enable_starttls_auto: ENV['JELLYFISH_SMTP_ENABLE_STARTTLS_AUTO']
|
11
|
+
}
|
12
|
+
end
|
data/config/routes.rb
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
module JellyfishNotification
|
2
|
+
include ActionView::Helpers
|
3
|
+
|
4
|
+
class JellyfishMailer < ActionMailer::Base
|
5
|
+
default from: ENV['JELLYFISH_SMTP_DEFAULT_SENDER']
|
6
|
+
|
7
|
+
def publish_project_create_approvers(response, recipients, projects_url)
|
8
|
+
# format block causes weirdness, so depending on rails conventions so templates resolve
|
9
|
+
@project = JSON.parse(response.body).to_h
|
10
|
+
@project_url = projects_url+"/#{@project['id'].to_s}"
|
11
|
+
recipients = ENV['JELLYFISH_SMTP_DEFAULT_RECIPIENT'] if recipients.empty?
|
12
|
+
mail(template_path: 'jellyfish_mailer', to: recipients, subject: "Project Create Notification: #{@project['name'].to_s.upcase}") unless ENV['JELLYFISH_SMTP_DEFAULT_SENDER'].nil?
|
13
|
+
end
|
14
|
+
|
15
|
+
def publish_project_create_confirmation(response, recipients, projects_url)
|
16
|
+
# format block causes weirdness, so depending on rails conventions so templates resolve
|
17
|
+
@project = JSON.parse(response.body).to_h
|
18
|
+
@project_url = projects_url+"/#{@project['id'].to_s}"
|
19
|
+
recipients = ENV['JELLYFISH_SMTP_DEFAULT_RECIPIENT'] if recipients.empty?
|
20
|
+
mail(template_path: 'jellyfish_mailer', to: recipients, subject: "Project Create Notification: #{@project['name'].to_s.upcase}") unless ENV['JELLYFISH_SMTP_DEFAULT_SENDER'].nil?
|
21
|
+
end
|
22
|
+
|
23
|
+
def publish_project_approval_update(project, recipients, project_url)
|
24
|
+
# format block causes weirdness, so depending on rails conventions so templates resolve
|
25
|
+
@project = project
|
26
|
+
@project_url = project_url
|
27
|
+
recipients = ENV['JELLYFISH_SMTP_DEFAULT_RECIPIENT'] if recipients.empty?
|
28
|
+
mail(template_path: 'jellyfish_mailer', to: recipients, subject: "Project Approval Notification: #{@project.name.to_s.upcase}") unless ENV['JELLYFISH_SMTP_DEFAULT_SENDER'].nil?
|
29
|
+
end
|
30
|
+
|
31
|
+
def publish_order_create(order, recipients, orders_url)
|
32
|
+
@order = order
|
33
|
+
@order_url = orders_url+"/#{@order.id}"
|
34
|
+
recipients = ENV['JELLYFISH_SMTP_DEFAULT_RECIPIENT'] if recipients.empty?
|
35
|
+
mail(template_path: 'jellyfish_mailer', to: recipients, subject: 'Order Create Notification') unless ENV['JELLYFISH_SMTP_DEFAULT_SENDER'].nil?
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
@@ -0,0 +1,32 @@
|
|
1
|
+
module JellyfishNotification
|
2
|
+
class SimpleListener
|
3
|
+
# IF ENV['JELLYFISH_ASYNCHRONOUS_DELIVERY'] == 'true') THEN QUEUE WITH DELAYED JOBS ELSE DELIVER NOW
|
4
|
+
def publish_project_create(response, recipients, projects_url)
|
5
|
+
project_creator = recipients[:project_creator]
|
6
|
+
project_approvers = recipients[:project_approvers]
|
7
|
+
if ENV['JELLYFISH_ASYNCHRONOUS_DELIVERY'] == 'true'
|
8
|
+
JellyfishMailer.delay.publish_project_create_confirmation(response, project_creator, projects_url)
|
9
|
+
JellyfishMailer.delay.publish_project_create_approvers(response, project_approvers, projects_url)
|
10
|
+
else
|
11
|
+
JellyfishMailer.publish_project_create_confirmation(response, project_creator, projects_url).deliver_now
|
12
|
+
JellyfishMailer.publish_project_create_approvers(response, project_approvers, projects_url).deliver_now
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
def publish_project_approval_update(project, recipients, project_url)
|
17
|
+
if ENV['JELLYFISH_ASYNCHRONOUS_DELIVERY'] == 'true'
|
18
|
+
JellyfishMailer.delay.publish_project_approval_update(project, recipients, project_url)
|
19
|
+
else
|
20
|
+
JellyfishMailer.publish_project_approval_update(project, recipients, project_url).deliver_now
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
def publish_order_create(order, recipients, orders_url)
|
25
|
+
if ENV['JELLYFISH_ASYNCHRONOUS_DELIVERY'] == 'true'
|
26
|
+
JellyfishMailer.delay.publish_order_create(order, recipients, orders_url)
|
27
|
+
else
|
28
|
+
JellyfishMailer.publish_order_create(order, recipients, orders_url).deliver_now
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
metadata
ADDED
@@ -0,0 +1,141 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: jellyfish-notification
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- mafernando
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-09-09 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: rails
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: dotenv-rails
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: pg
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: wisper
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: delayed_job_active_record
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :runtime
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
description: A module that adds notification support to the Project Jellyfish API
|
84
|
+
email:
|
85
|
+
- fernando_michael@bah.com
|
86
|
+
executables: []
|
87
|
+
extensions: []
|
88
|
+
extra_rdoc_files: []
|
89
|
+
files:
|
90
|
+
- LICENSE
|
91
|
+
- README.md
|
92
|
+
- Rakefile
|
93
|
+
- app/assets/javascripts/jellyfish_notification/application.js
|
94
|
+
- app/assets/stylesheets/jellyfish_notification/application.css
|
95
|
+
- app/controllers/jellyfish_notification/application_controller.rb
|
96
|
+
- app/helpers/jellyfish_notification/application_helper.rb
|
97
|
+
- app/views/jellyfish_mailer/publish_order_create.html.erb
|
98
|
+
- app/views/jellyfish_mailer/publish_order_create.text.erb
|
99
|
+
- app/views/jellyfish_mailer/publish_project_approval_update.html.erb
|
100
|
+
- app/views/jellyfish_mailer/publish_project_approval_update.text.erb
|
101
|
+
- app/views/jellyfish_mailer/publish_project_create_approvers.html.erb
|
102
|
+
- app/views/jellyfish_mailer/publish_project_create_approvers.text.erb
|
103
|
+
- app/views/jellyfish_mailer/publish_project_create_confirmation.html.erb
|
104
|
+
- app/views/jellyfish_mailer/publish_project_create_confirmation.text.erb
|
105
|
+
- app/views/layouts/jellyfish_notification/application.html.erb
|
106
|
+
- config/enironments/test.rb
|
107
|
+
- config/initializers/application.rb
|
108
|
+
- config/initializers/default.rb
|
109
|
+
- config/routes.rb
|
110
|
+
- lib/jellyfish-notification.rb
|
111
|
+
- lib/jellyfish_notification.rb
|
112
|
+
- lib/jellyfish_notification/engine.rb
|
113
|
+
- lib/jellyfish_notification/jellyfish_mailer.rb
|
114
|
+
- lib/jellyfish_notification/simple_listener.rb
|
115
|
+
- lib/jellyfish_notification/version.rb
|
116
|
+
- lib/tasks/jellyfish_notification_tasks.rake
|
117
|
+
homepage: http://www.projectjellyfish.org
|
118
|
+
licenses:
|
119
|
+
- APACHE
|
120
|
+
metadata: {}
|
121
|
+
post_install_message:
|
122
|
+
rdoc_options: []
|
123
|
+
require_paths:
|
124
|
+
- lib
|
125
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
126
|
+
requirements:
|
127
|
+
- - ">="
|
128
|
+
- !ruby/object:Gem::Version
|
129
|
+
version: '0'
|
130
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
131
|
+
requirements:
|
132
|
+
- - ">="
|
133
|
+
- !ruby/object:Gem::Version
|
134
|
+
version: '0'
|
135
|
+
requirements: []
|
136
|
+
rubyforge_project:
|
137
|
+
rubygems_version: 2.4.8
|
138
|
+
signing_key:
|
139
|
+
specification_version: 4
|
140
|
+
summary: Jellyfish Notification Module
|
141
|
+
test_files: []
|