jellyfish-notice 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 960d7ceb1955bf1d0106355798192f03d5dcbb30
+  data.tar.gz: 620fa0a45a695ba2fb106a7a721d8be5eecafeb0
+SHA512:
+  metadata.gz: e1775e6a606e197a399132d2b2ec805090a47f0289d8af5ab87dbd82fd10dc99dcf05eb2d17011eb0e8c92ecdbb3a215349cff8b986d2a9e9f6492921972cfeb
+  data.tar.gz: 4b42310861bbe643229eb65f28d10385f5d3010c8f13500a4858544c6b4c21e063fae723fca477c44a68acf24b262e89e4c87ed90955c988b6e30b4074b9ec23

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2015 Booz Allen Hamilton
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,61 @@
+Jellyfish Notice
+=======
+A notification system for [Project Jellyfish] (https://github.com/projectjellyfish/api).
+
+https://rubygems.org/gems/jellyfish-notice
+#### Installation
+Include in Gemfile: 
+```
+  gem 'jellyfish-notice' 
+```
+
+Add settings to your .env file:
+```
+  PJ_PERFORM_DELIVERIES        = true
+  PJ_DELIVERY_METHOD           = smtp
+  PJ_SMTP_ADDRESS              = your.smtp.server
+  PJ_SMTP_PORT                 = 587
+  PJ_SMTP_USER_NAME            = API-KEY
+  PJ_SMTP_PASSWORD             = API-KEY
+  PJ_SMTP_AUTHENTICATION       = plain
+  PJ_SMTP_ENABLE_STARTTLS_AUTO = true
+  PJ_SMTP_DEFAULT_RECIPIENT    = from_who@foo.com
+  PJ_SMTP_DEFAULT_SENDER       = to_whom@bar.com
+```
+
+Make sure that ```before_commit``` and ```after_commit``` hooks are defined on controllers:
+```ruby
+class SessionsController < Devise::SessionsController
+  before_action :pre_hook
+  after_action :post_hook
+  ...
+  private
+  ...
+  def pre_hook
+    ActiveSupport::Notifications.instrument(controller_name + '#' + action_name + '/pre_hook')
+   end
+  def post_hook
+    ActiveSupport::Notifications.instrument(controller_name + '#' + action_name + '/post_hook')
+  end
+  ...
+end
+```
+
+#### Custom Subscriptions
+Jellyfish Notice comes with subscriptions to certain [pre-defined] (config/initializers/subscriptions.rb) events.
+
+Subscriptions to other events can be placed in config/initializers/subscriptions.rb:
+```ruby
+...
+ActiveSupport::Notifications.subscribe('sessions#create/pre_hook') do |*args|
+  JellyfishNotice.send(*args)
+end
+ActiveSupport::Notifications.subscribe('sessions#create/post_hook') do |*args|
+  JellyfishNotice.send(*args)
+end
+...
+```
+Events are instrumented using the following naming convention:
+```ruby
+controller_name + '#' + action_name + '/post_hook'
+```

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JellyfishNotice'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/jellyfish_notice/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/jellyfish_notice/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/jellyfish_notice/application_controller.rb

@@ -0,0 +1,4 @@
+module JellyfishNotice
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/jellyfish_notice/application_helper.rb

@@ -0,0 +1,4 @@
+module JellyfishNotice
+  module ApplicationHelper
+  end
+end

data/app/views/user_mailer/simple_notification.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+</head>
+<body>
+<h1>A <%= @name %> event has occurred.</h1>
+<p>
+  The event began at <b><%= @start %></b> and finished at <b><%= @finish %></b>.
+</p>
+<p>
+  Thank you,<br>
+  Project Jellyfish
+</p>
+<b>REFERENCE ID: <%= @id %></b>
+</body>
+</html>

data/app/views/user_mailer/simple_notification.text.erb

@@ -0,0 +1,9 @@
+A <%= @name %> event has occurred.
+===============================================
+
+This event began at <%= @start %> and finished at <%= @finish %>.
+
+Thank you,
+Team Jellyfish
+
+REFERENCE ID: <%= @id %>

data/config/environments/development.rb

@@ -0,0 +1,12 @@
+Rails.application.configure do
+  config.action_mailer.perform_deliveries = ENV['PJ_PERFORM_DELIVERIES']
+  config.action_mailer.delivery_method = :smtp unless ENV['PJ_DELIVERY_METHOD'] != 'smtp'
+  config.action_mailer.smtp_settings = {
+    address:              ENV['PJ_SMTP_ADDRESS'],
+    port:                 ENV['PJ_SMTP_PORT'],
+    user_name:            ENV['PJ_SMTP_USER_NAME'],
+    password:             ENV['PJ_SMTP_PASSWORD'],
+    authentication:       ENV['PJ_SMTP_AUTHENTICATION'],
+    enable_starttls_auto: ENV['PJ_SMTP_ENABLE_STARTTLS_AUTO']
+  }
+end

data/config/environments/production.rb

@@ -0,0 +1,12 @@
+Rails.application.configure do
+  config.action_mailer.perform_deliveries = ENV['PJ_PERFORM_DELIVERIES']
+  config.action_mailer.delivery_method = :smtp unless ENV['PJ_DELIVERY_METHOD'] != 'smtp'
+  config.action_mailer.smtp_settings = {
+    address:              ENV['PJ_SMTP_ADDRESS'],
+    port:                 ENV['PJ_SMTP_PORT'],
+    user_name:            ENV['PJ_SMTP_USER_NAME'],
+    password:             ENV['PJ_SMTP_PASSWORD'],
+    authentication:       ENV['PJ_SMTP_AUTHENTICATION'],
+    enable_starttls_auto: ENV['PJ_SMTP_ENABLE_STARTTLS_AUTO']
+  }
+end

data/config/environments/test.rb

@@ -0,0 +1,12 @@
+Rails.application.configure do
+  config.action_mailer.perform_deliveries = ENV['PJ_PERFORM_DELIVERIES']
+  config.action_mailer.delivery_method = :smtp unless ENV['PJ_DELIVERY_METHOD'] != 'smtp'
+  config.action_mailer.smtp_settings = {
+    address:              ENV['PJ_SMTP_ADDRESS'],
+    port:                 ENV['PJ_SMTP_PORT'],
+    user_name:            ENV['PJ_SMTP_USER_NAME'],
+    password:             ENV['PJ_SMTP_PASSWORD'],
+    authentication:       ENV['PJ_SMTP_AUTHENTICATION'],
+    enable_starttls_auto: ENV['PJ_SMTP_ENABLE_STARTTLS_AUTO']
+  }
+end

data/config/initializers/subscriptions.rb

@@ -0,0 +1,15 @@
+ActiveSupport::Notifications.subscribe('sessions#create/pre_hook') do |*args|
+  JellyfishNotice.send(*args)
+end
+
+ActiveSupport::Notifications.subscribe('sessions#create/post_hook') do |*args|
+  JellyfishNotice.send(*args)
+end
+
+ActiveSupport::Notifications.subscribe('sessions#destroy/pre_hook') do |*args|
+  JellyfishNotice.send(*args)
+end
+
+ActiveSupport::Notifications.subscribe('sessions#destroy/post_hook') do |*args|
+  JellyfishNotice.send(*args)
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+JellyfishNotice::Engine.routes.draw do
+end

data/lib/jellyfish-notice.rb

@@ -0,0 +1,2 @@
+# More logical way to require 'jellyfish-notice' - see 'rest-client' gem
+require File.dirname(__FILE__) + '/jellyfish_notice'

data/lib/jellyfish_notice.rb

@@ -0,0 +1,7 @@
+require 'jellyfish_notice/engine'
+
+module JellyfishNotice
+  def self.send(*args)
+    UserMailer.simple_notification(*args).deliver
+  end
+end

data/lib/jellyfish_notice/engine.rb

@@ -0,0 +1,6 @@
+module JellyfishNotice
+  class Engine < ::Rails::Engine
+    config.autoload_paths += %W(#{config.root}/lib)
+    isolate_namespace JellyfishNotice
+  end
+end

data/lib/jellyfish_notice/user_mailer.rb

@@ -0,0 +1,19 @@
+module JellyfishNotice
+  class UserMailer < ActionMailer::Base
+    default from: ENV['PJ_SMTP_DEFAULT_SENDER']
+
+    def simple_notification(*args)
+      @name    = args[0] # => String, name of the event
+      @start   = args[1] # => Time, when the instrumented block started execution
+      @finish  = args[2] # => Time, when the instrumented block ended execution
+      @id      = args[3] # => String, unique ID for this notification
+      @payload = args[4] # => Hash, the payload
+      Rails.logger.info(@name)
+      Rails.logger.info(@start)
+      Rails.logger.info(@finish)
+      Rails.logger.info(@id)
+      Rails.logger.info(@payload)
+      mail(template_path: 'user_mailer', to: ENV['PJ_SMTP_DEFAULT_RECIPIENT'], subject: "A #{@name} event has occurred")
+    end
+  end
+end

data/lib/jellyfish_notice/version.rb

@@ -0,0 +1,3 @@
+module JellyfishNotice
+  VERSION = '0.0.3'
+end

data/lib/tasks/jellyfish_notice_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :jellyfish_notice do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: jellyfish-notice
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- mafernando
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A notification system for Project Jellyfish
+email:
+- fernando_michael@bah.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/jellyfish_notice/application.js
+- app/assets/stylesheets/jellyfish_notice/application.css
+- app/controllers/jellyfish_notice/application_controller.rb
+- app/helpers/jellyfish_notice/application_helper.rb
+- app/views/user_mailer/simple_notification.html.erb
+- app/views/user_mailer/simple_notification.text.erb
+- config/environments/development.rb
+- config/environments/production.rb
+- config/environments/test.rb
+- config/initializers/subscriptions.rb
+- config/routes.rb
+- lib/jellyfish-notice.rb
+- lib/jellyfish_notice.rb
+- lib/jellyfish_notice/engine.rb
+- lib/jellyfish_notice/user_mailer.rb
+- lib/jellyfish_notice/version.rb
+- lib/tasks/jellyfish_notice_tasks.rake
+homepage: http://www.projectjellyfish.org/
+licenses:
+- APACHE
+metadata: {}
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Jellyfish Notification
+test_files: []