notifun 1.6

data/lib/notifun/notifiers/cloud_five_notifier.rb

@@ -0,0 +1,32 @@
+class Notifun::Notifier::CloudFiveNotifier < Notifun::Notifier::ParentNotifier
+  def notify!(text, title, uuid, options)
+    if !defined?(CloudFivePush)
+      @success = false
+      @error_message = "CloudFivePush is not defined."
+      return
+    end
+    api_key = options[:api_key].presence
+    api_key ||= Notifun.configuration.push_config[:api_key]
+    return false unless api_key.present?
+    notification = CloudFivePush::Notification.new(api_key)
+    if title.present?
+      notification.alert = title
+      notification.message = text
+    else
+      notification.alert = text
+      notification.message = ""
+    end
+    notification.user_identifiers = [uuid]
+    notification.data = options[:push_data]
+    notification.content_available = options[:content_available]
+    notification.badge = options[:badge].presence
+    response = notification.notify!
+
+    if response['success']
+      @success = true
+    else
+      @error_message = response["error"].presence || "Failed to send push notification"
+      @success = false
+    end
+  end
+end

data/lib/notifun/notifiers/email_notifier.rb

@@ -0,0 +1,11 @@
+class Notifun::Notifier::EmailNotifier < Notifun::Notifier::ParentNotifier
+  def notify!(email, subject, html, text, message_template, options)
+    begin
+      Notifun::MessageMailer.send_message(email, subject, html, text, message_template, options).deliver_now
+      @success = true
+    rescue Net::SMTPSyntaxError => e
+      @error_message = e.message
+      @success = false
+    end
+  end
+end

data/lib/notifun/notifiers/empty_notifier.rb

@@ -0,0 +1,2 @@
+class Notifun::Notifier::EmptyNotifier < Notifun::Notifier::ParentNotifier
+end

data/lib/notifun/notifiers/notifier.rb

@@ -0,0 +1,17 @@
+module Notifun::Notifier
+  def self.email_notifier
+    "Notifun::Notifier::EmailNotifier".constantize
+  end
+  def self.push_notifier
+    "Notifun::Notifier::#{Notifun.configuration.push_notifier}Notifier".constantize
+  end
+  def self.text_notifier
+    "Notifun::Notifier::#{Notifun.configuration.text_notifier}Notifier".constantize
+  end
+end
+
+require 'notifun/notifiers/parent_notifier'
+require 'notifun/notifiers/email_notifier'
+require 'notifun/notifiers/empty_notifier'
+require 'notifun/notifiers/cloud_five_notifier'
+require 'notifun/notifiers/twilio_notifier'

data/lib/notifun/notifiers/parent_notifier.rb

@@ -0,0 +1,12 @@
+class Notifun::Notifier::ParentNotifier
+  attr_accessor :success, :error_message
+
+  def initialize
+    @success = false
+    @error_message = nil
+  end
+
+  def notify!(*arguments)
+    false
+  end
+end

data/lib/notifun/notifiers/twilio_notifier.rb

@@ -0,0 +1,28 @@
+class Notifun::Notifier::TwilioNotifier < Notifun::Notifier::ParentNotifier
+  def notify!(text, phone, options)
+    if !defined?(Twilio)
+      @success = false
+      @error_message = "Twilio is not defined."
+      return
+    end
+
+    account_sid = Notifun.configuration.text_config[:account_sid]
+    auth_token = Notifun.configuration.text_config[:auth_token]
+    from = Notifun.configuration.text_config[:from]
+    return false unless account_sid.present? && auth_token.present? && from.present?
+
+    begin
+      client = Twilio::REST::Client.new account_sid, auth_token
+      client.messages.create(
+        from: from,
+        to: phone,
+        body: text
+      )
+    rescue Twilio::REST::RequestError => e
+      @success = false
+      @error_message = e.message
+    end
+
+    @success = true
+  end
+end

data/lib/notifun/railtie.rb

@@ -0,0 +1,48 @@
+require_relative '../../app/models/notifun/message_template'
+require 'rails'
+
+class Notifun::Railtie < ::Rails::Railtie
+  railtie_name :notifun
+
+  console do
+    ActiveRecord::Base.connection
+  end
+
+  initializer "notifun.load_templates" do |config|
+    if ( File.basename($0) != 'rake' )
+      if !ActiveRecord::Base.connection.table_exists?('notifun_message_templates')
+        puts "Notifun not importing templates because Notifun tables don't exist."
+      else
+        if File.exists?('config/notifun_templates.json')
+          begin
+            template_json = JSON.parse(File.read("config/notifun_templates.json"))
+          rescue
+            puts "Notifun template json file is not valid json."
+          end
+
+          if template_json
+            template_json.each do |key, attributes|
+              begin
+                message_template = Notifun::MessageTemplate.where(key: key).first_or_initialize
+                message_template.attributes = attributes.slice("description", "category", "default_notification_methods", "backup_notification_methods", "merge_fields", "models", "editable", "preferences")
+                message_template.push_title ||= attributes["push_title"]
+                message_template.push_body ||= attributes["push_body"]
+                message_template.email_subject ||= attributes["email_subject"]
+                message_template.email_html ||= attributes["email_html"]
+                message_template.email_text ||= attributes["email_text"]
+
+                message_template.save!
+              rescue StandardError => e
+                puts "Failed to load message_template #{key}: #{e.message}"
+              end
+            end
+
+            puts "Notifun initialized successfully!"
+          end
+        else
+          puts "No Notifun message templates loaded because app/config/notifun_templates.json does not exist."
+        end
+      end
+    end
+  end
+end

data/lib/notifun/version.rb

@@ -0,0 +1,3 @@
+module Notifun
+  VERSION = "1.6"
+end

data/notifun.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notifun/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "notifun"
+  spec.version       = Notifun::VERSION
+  spec.authors       = ["Brett Samson"]
+  spec.email         = ["brett@tenforwardconsulting.com"]
+  spec.summary       = %q{Notification management.}
+  spec.description   = "Notification management."
+  spec.homepage      = "https://github.com/tenforwardconsulting/notifun/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '~> 3.0'
+end

data/spec/notifun_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+require 'json'
+require_relative '../lib/notifun/notification'
+require_relative '../lib/notifun/message_template'
+
+RSpec.describe Notifun do
+  let(:caddie_reminder_json) {%|
+{
+  "caddie_reminder" : {
+    "description" : "Reminder that goes out to caddies the night before, the morning of, and 24 hours before a booking.",
+    "category" : "booking",
+    "default_notification_methods" : ["push", "email"],
+    "backup_notification_methods" : [],
+    "merge_fields" : {
+      "caddie_full_name" : "Name of the caddie",
+      "golfer_full_name" : "Full name of the golfer",
+      "tee_time" : "The tee time of the booking",
+      "tee_date" : "The date of the tee time",
+      "tee_date_and_time" : "The date and time of the booking",
+      "location" : "Name of the course",
+      "confirmation_code" : "Reference code for the caddie"
+    },
+    "push_body" : "Reminder: You signed up to caddie at {tee_date_and_time} at {location}. Confirmation Code: {confirmation_code}",
+    "email_subject" : "You have a booking scheduled for tomorrow.",
+    "email_html" : "<h3>Hello, {caddie_full_name},</h3><p>You signed up to caddie for {golfer_full_name} at {location} on <span class='confirmation-date'>{tee_date}</span> at <span class='confirmation-time'>{tee_time}</span></p><p><span class='uppercase'>Confirmation Code:</span><span class='confirmation-code'>{confirmation_code}</span></p>",
+    "email_text" : "Hello, {caddie_full_name}, You signed up to caddie for {golfer_full_name} at {location} on {tee_date} at {tee_time} Confirmation Code: {confirmation_code}"
+  }
+}|
+}
+  let!(:message_template) {
+    hash = JSON.parse(caddie_reminder_json)
+    message_template = Notifun::MessageTemplate.where(key: "caddie_reminder").first_or_initialize
+    message_template.attributes = hash["caddie_reminder"]
+    message_template.save!
+    message_template
+  }
+  let(:caddie) { FactoryGirl.create :caddie }
+  it "sends push and email since both are in default_notification_methods" do
+    message_template.update(default_notification_methods: ["push", "email"], backup_notification_methods: [])
+    expect(CloudFivePush).to receive(:notify!).with("Reminder: You signed up to caddie at Tuesday 10AM at Test Course. Confirmation Code: 123456", caddie.uuid)
+    expect(Notifun::MessageMailer).to receive(:send_message).with(caddie.email, "You have a booking scheduled for tomorrow.", "Hello, Test Caddie, You signed up to caddie for Test Golfer at Test Course on Tuesday at 10AM Confirmation Code: 123456", "<h3>Hello, Test Caddie,</h3><p>You signed up to caddie for Test Golfer at Test Course on <span class=\"confirmation-date\">Tuesday</span> at <span class=\"confirmation-time\">10AM</span></p><p><span class=\"uppercase\">Confirmation Code:</span><span class=\"confirmation-code\">123456</span></p>").and_call_original
+
+    Notifun.notify(caddie, :caddie_reminder, {
+      caddie_full_name: "Test Caddie",
+      golfer_full_name: "Test Golfer",
+      tee_date: "Tuesday",
+      tee_time: "10AM",
+      tee_date_and_time: "Tuesday 10AM",
+      location: "Test Course",
+      confirmation_code: "123456"
+    })
+
+    expect(message_template.reload.messages.count).to eq 2
+
+    message = message_template.messages.first
+    expect(message.message_template_key).to eq "caddie_reminder"
+    expect(message.uuid).to eq caddie.uuid
+    expect(message.recipient).to eq caddie.uuid
+    expect(message.notification_method).to eq "push"
+    expect(message.message_text).to eq "Reminder: You signed up to caddie at Tuesday 10AM at Test Course. Confirmation Code: 123456"
+
+    message = message_template.messages.last
+    expect(message.message_template_key).to eq "caddie_reminder"
+    expect(message.uuid).to eq caddie.uuid
+    expect(message.recipient).to eq caddie.email
+    expect(message.notification_method).to eq "email"
+    expect(message.message_text).to eq "<h3>Hello, Test Caddie,</h3><p>You signed up to caddie for Test Golfer at Test Course on <span class=\"confirmation-date\">Tuesday</span> at <span class=\"confirmation-time\">10AM</span></p><p><span class=\"uppercase\">Confirmation Code:</span><span class=\"confirmation-code\">123456</span></p>"
+  end
+
+  it "sends just push if email is in backup and push works" do
+    message_template.update(default_notification_methods: ["push"], backup_notification_methods: ["email"])
+
+    expect(CloudFivePush).to receive(:notify!)
+    expect(Notifun::MessageMailer).to_not receive(:send_message)
+
+    Notifun.notify(caddie, :caddie_reminder, {
+      caddie_full_name: "Test Caddie",
+      golfer_full_name: "Test Golfer",
+      tee_date: "Tuesday",
+      tee_time: "10AM",
+      tee_date_and_time: "Tuesday 10AM",
+      location: "Test Course",
+      confirmation_code: "123456"
+    })
+
+    expect(message_template.reload.messages.count).to eq 1
+  end
+
+  it "sends email if push fails to send" do
+    message_template.update(default_notification_methods: ["push"], backup_notification_methods: ["email"])
+    caddie.user.update(disable_push_notifications: true)
+
+    expect(CloudFivePush).to_not receive(:notify!)
+    expect(Notifun::MessageMailer).to receive(:send_message).and_call_original
+
+    Notifun.notify(caddie, :caddie_reminder, {
+      caddie_full_name: "Test Caddie",
+      golfer_full_name: "Test Golfer",
+      tee_date: "Tuesday",
+      tee_time: "10AM",
+      tee_date_and_time: "Tuesday 10AM",
+      location: "Test Course",
+      confirmation_code: "123456"
+    })
+
+    expect(message_template.reload.messages.count).to eq 1
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,88 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  #config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: notifun
+version: !ruby/object:Gem::Version
+  version: '1.6'
+platform: ruby
+authors:
+- Brett Samson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Notification management.
+email:
+- brett@tenforwardconsulting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- app/assets/stylesheets/notifun.sass
+- app/controllers/notifun/message_templates_controller.rb
+- app/controllers/notifun/messages_controller.rb
+- app/controllers/notifun/preferences_controller.rb
+- app/mailers/notifun/message_mailer.rb
+- app/models/notifun/message.rb
+- app/models/notifun/message_template.rb
+- app/models/notifun/preference.rb
+- app/views/notifun/message_templates/edit.html.haml
+- app/views/notifun/message_templates/index.html.haml
+- app/views/notifun/messages/index.haml
+- app/views/notifun/messages/show.haml
+- app/views/notifun/preferences/index.haml
+- config/routes.rb
+- lib/generators/notifun/install_generator.rb
+- lib/generators/notifun/templates/migration.rb
+- lib/generators/notifun/templates/notifun.rb
+- lib/generators/notifun/templates/notifun_add_push_title.rb
+- lib/generators/notifun/templates/notifun_templates.json
+- lib/notifun.rb
+- lib/notifun/configuration.rb
+- lib/notifun/engine.rb
+- lib/notifun/notification.rb
+- lib/notifun/notifiers/cloud_five_notifier.rb
+- lib/notifun/notifiers/email_notifier.rb
+- lib/notifun/notifiers/empty_notifier.rb
+- lib/notifun/notifiers/notifier.rb
+- lib/notifun/notifiers/parent_notifier.rb
+- lib/notifun/notifiers/twilio_notifier.rb
+- lib/notifun/railtie.rb
+- lib/notifun/version.rb
+- notifun.gemspec
+- spec/notifun_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tenforwardconsulting/notifun/
+licenses:
+- MIT
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Notification management.
+test_files:
+- spec/notifun_spec.rb
+- spec/spec_helper.rb