ombu_labs-notifications 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49291d1cca1c5739ff9f34e8e37b26ec8f2e9209349869d86f6f6c9bcbcc18ac
+  data.tar.gz: '091ecb37aae22fcb44b061e4e8f770b70265fbbf09f488e309fc20c2887cd855'
+SHA512:
+  metadata.gz: 9ea20982214f6e618b33a082a1e19df9fd7a0dc388a33d62f52ecdc2d7ff5b551ba1013d7e542681606260f31be208be27a096abb0cb7c41106b2ba247fcaf9f
+  data.tar.gz: a9536245616fa49f7469d6dc1f44dabf8c03aa508815104781319bd95e9587c38893b7b86d763d923f6dbc14abd4e6554874421eb492ff07c0de9b6440c011bc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Fiona
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# OmbuLabs::Notifications
+Source code for OmbuLabs notifications. 
+
+## Usage
+This gem can be used in any of our sites to send email and slack notifications. The aim of this gem is to simplify things when we need to update some code when something is broken in all of our sites. 
+
+There are some ENV variables in this gem that will need to be defined in any new site. 
+You will also need to include a Contact model that had the following:
+email, email_sent_at, slack_notified_at, and id. You will also need an update_column method. 
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ombu_labs-notifications'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ombu_labs-notifications
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/mailers/contact_mailer.rb

@@ -0,0 +1,11 @@
+# Mailer for the contact form
+
+class ContactMailer < ApplicationMailer
+  CONTACT_FORM_TO = ENV["CONTACT_FORM_TO"].presence || "hello@ombulabs.com"
+  def contact_email(contact)
+    @contact = contact
+    mail(subject: "[OmbuLabs] #{contact.email} just sent you a message!",
+         to: CONTACT_FORM_TO,
+         reply_to: contact.email)
+  end
+end

data/app/services/slack_notifier.rb

@@ -0,0 +1,25 @@
+class SlackNotifier
+  def notify_new_contact(contact)
+    notifier = Slack::Notifier.new ENV["SLACK_WEBHOOK_URL"]
+    notifier.ping contact_message(contact)
+  end
+
+  private
+
+  def contact_message(contact)
+    <<~TEXT
+      Hello <!subteam^#{ENV["SLACK_GROUP_ID"]}>!\n
+      #{contact.name.titleize} has submitted the following message in our contact form :tada: :
+      ```
+      #{contact.message}
+      ```
+      Email: #{contact.email}
+      How they found us: #{contact.found_us}
+      Request Type: #{contact.request_type&.titleize}\n
+      In House Developers: #{contact&.in_house_developers}\n
+      They plan to start at: #{contact&.starting_at}\n
+      Cheers,\nYour OmbuLabs Robot!
+
+    TEXT
+  end
+end

data/app/views/contact_mailer/contact_email.html.erb

@@ -0,0 +1,5 @@
+<p>Hello!</p>
+
+<p>A message has been submitted.</p>
+
+<p>Cheers,<br/>Your OmbuLabs Robot!</p>

data/app/workers/contact_mailer_worker.rb

@@ -0,0 +1,15 @@
+class ContactMailerWorker
+  include Sidekiq::Worker
+
+  def perform(contact_id)
+    return unless (contact = Contact.find(contact_id))
+
+    if contact.email_sent_at.blank?
+      ContactMailer.contact_email(contact).deliver_now
+      contact.update_column :email_sent_at, Time.current
+      Sidekiq.logger.info "Sent email to #{contact.email}"
+    else
+      Sidekiq.logger.info "Skipping email to #{contact.email}"
+    end
+  end
+end

data/app/workers/contact_slack_worker.rb

@@ -0,0 +1,15 @@
+class ContactSlackWorker
+  include Sidekiq::Worker
+
+  def perform(contact_id)
+    return unless (contact = Contact.find(contact_id))
+
+    if contact.slack_notified_at.blank?
+      SlackNotifier.new.notify_new_contact(contact)
+      contact.update_column :slack_notified_at, Time.current
+      Sidekiq.logger.info "Slack notification sent: #{contact.email}"
+    else
+      Sidekiq.logger.info "Slack notification skipped: #{contact.email}"
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/ombu_labs/notifications/engine.rb

@@ -0,0 +1,6 @@
+module OmbuLabs
+  module Notifications
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/ombu_labs/notifications/version.rb

@@ -0,0 +1,5 @@
+module OmbuLabs
+  module Notifications
+    VERSION = '0.1.0'
+  end
+end

data/lib/ombu_labs/notifications.rb

@@ -0,0 +1,9 @@
+require "ombu_labs/notifications/version"
+require "ombu_labs/notifications/engine"
+require "slack-notifier"
+
+module OmbuLabs
+  module Notifications
+    # Your code goes here...
+  end
+end

data/lib/tasks/ombu_labs/notifications_tasks.rake

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

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: ombu_labs-notifications
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fiona
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Knows how to send a new contact email, new contact Slack notification
+email:
+- fiona@ombulabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/mailers/contact_mailer.rb
+- app/services/slack_notifier.rb
+- app/views/contact_mailer/contact_email.html.erb
+- app/workers/contact_mailer_worker.rb
+- app/workers/contact_slack_worker.rb
+- config/routes.rb
+- lib/ombu_labs/notifications.rb
+- lib/ombu_labs/notifications/engine.rb
+- lib/ombu_labs/notifications/version.rb
+- lib/tasks/ombu_labs/notifications_tasks.rake
+homepage: https://github.com/fastruby/ombu_labs-notifications
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/fastruby/ombu_labs-notifications
+  source_code_uri: https://github.com/fastruby/ombu_labs-notifications
+  changelog_uri: https://github.com/fastruby/ombu_labs-notifications
+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: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A gem to send notifications via email, Slack
+test_files: []