mn_utils_gem 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c233647ceb909d90fcddcab30b19819d749d2d82a0ae05c00b91fcb62e6498ae
-  data.tar.gz: 4c16da8fb1716345f068659a2043dc24848481ac05a6f09826fe845e4f80a9dc
+  metadata.gz: ad2f7397f4cf0a20fd6a4a2ab3a02827bc336ff19f84389b0418c3bf6e5c0475
+  data.tar.gz: 705a9af48e033b191bb1b3122f96a34cd730de35255f396d85a3ec6a390f0217
 SHA512:
-  metadata.gz: 026c351ad8e12472d2fc0651e5c0f8706aca912764983976bb51a41fabce8b891028bb5d9ab4260e969c778f666f603c1ba22beb1d1f083ba2b7a0d5de774421
-  data.tar.gz: dbcfb61093ac5200db3756a3abee4b6853754d2db488f18211c5d55903dcde77b5ce91d473e44ab57fafba91bfebf5b38d76ca584d9b26d4336e9d297b1c1d0c
+  metadata.gz: 6371fe07495e1581482c2c3f52c29ea3134b958c1301d39ee842a203d8be32b24ff150b83f5ab9adfff49023723744947d4b3950622ebaa4dce4a4b28d74189b
+  data.tar.gz: 00512bf9b87dfb58b928b53a84fdca92ce5607b33044335d23e3eabe8888f6c8af9c28c9c1aa39178e619887bb9fe707f3122d27aa82dffc9f1f280d3a22a6e7

data/lib/mn_utils_gem/site_action.rb

@@ -2,6 +2,8 @@ require 'gelf'
 require 'aws-sdk-cloudwatch'
 require 'request_store'
 require 'singleton'
+require 'active_support'
+require 'active_support/core_ext'
 
 # SiteAction class to log important site actions to Graylog
 # and send a matching metric to Cloudwatch
@@ -79,6 +81,9 @@ module MnUtilsLogging
               :mention_notif_email_success,
               :mention_notif_email_fail
           ],
+          voting: [
+              :aibu_vote_success
+          ],
           admin: [
               :admin_email_success,
               :admin_email_fail,
@@ -106,6 +111,9 @@ module MnUtilsLogging
       # create a reverse map of all site actions and their corresponding group
       # for quick lookups by the code
       @_site_action_group_map = Hash[*(@_site_actions_and_groups.map {|k, arr| arr.map {|v| [v, k]}}.flatten)].freeze
+
+      # setup the logger
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
     end
 
     def log(message, site_action, payload = {})
@@ -196,10 +204,10 @@ module MnUtilsLogging
         n = GELF::Notifier.new(ENV['GRAYLOG_GELF_UDP_HOST'], ENV['GRAYLOG_GELF_UDP_PORT'])
         n.notify! payload
       else
-        Rails.logger.debug("Payload for Graylog: #{payload}")
+        @logger.debug("Payload for Graylog: #{payload}")
       end
     rescue Exception => e
-      Rails.logger.error e
+      @logger.error e
     end
 
     def send_to_cloudwatch(site_action_group, site_action, site_hostname)
@@ -223,10 +231,10 @@ module MnUtilsLogging
         cw = Aws::CloudWatch::Client.new
         cw.put_metric_data(cloudwatch_payload)
       else
-        Rails.logger.debug("Payload for Cloudwatch: #{cloudwatch_payload}")
+        @logger.debug("Payload for Cloudwatch: #{cloudwatch_payload}")
       end
     rescue Exception => e
-      Rails.logger.error e
+      @logger.error e
     end
 
   end # of class SiteAction

data/lib/mn_utils_gem/transactional_email.rb

@@ -0,0 +1,75 @@
+require 'aws-sdk-sqs'
+require 'request_store'
+require 'singleton'
+
+# TransactionalEmail class to send transactional emails
+# via the mail service.
+#
+# usage: MnUtilsEmail::TransactionalEmail.instance.enqueue(
+#           message_type:, to_address:, subject:, fallback_text:, template_fields: {}, cc_addresses: '')
+#
+#    eg: MnUtilsEmail::TransactionalEmail.instance.enqueue(
+#           message_type: 'REGISTRATION_WELCOME',
+#           to_address: 'joe@example.com',
+#           subject: 'Welcome to Mumsnet',
+#           fallback_text: "Dear joe\nWelcome to Mumsnet\nMNHQ"
+#        )
+#        This puts the message onto the correct SQS queue
+#        which will then be picked up by the mail service and sent.
+
+module MnUtilsEmail
+  class TransactionalEmail
+
+    include Singleton
+
+    def initialize
+      # setup the logger
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+
+    def enqueue(message_type:, to_address:, subject:, fallback_text:, template_fields: {}, cc_addresses: '')
+
+      # validate the parameters
+      raise ArgumentError, "message_type cannot be blank" \
+          if message_type.blank?
+      raise ArgumentError, "to_address cannot be blank" \
+          if to_address.blank?
+      raise ArgumentError, "subject cannot be blank" \
+          if subject.blank?
+      raise ArgumentError, "fallback_text cannot be blank" \
+          if fallback_text.blank?
+      raise ArgumentError, "to_address #{to_address} is not a valid email address" \
+          unless to_address =~ /@/
+
+      # construct the message body for SQS
+      message_body = {
+          message_schema_version: 1,
+          message_type: message_type,
+          template_fields: template_fields.to_json,
+          to_address: to_address,
+          cc_addresses: cc_addresses,
+          subject: subject,
+          fallback_text: fallback_text
+      }
+
+      # add the request ID if available
+      request_id = ''
+      request_id = RequestStore.store[:request_id] if RequestStore.store[:request_id]
+      message_body[:request_id] = request_id
+
+      if ENV.key? 'SQS_MAIL2_QUEUE_URL'
+        # put it on the SQS queue
+        sqs = Aws::SQS::Client.new()
+        sqs.send_message(
+            queue_url: ENV['SQS_MAIL2_QUEUE_URL'],
+            message_body: message_body.to_json
+        )
+      else
+        @logger.debug("Payload for SQS: #{message_body}")
+      end
+
+    end # of method enqueue
+
+  end # of class TransactionalEmail
+
+end # of module MnUtilsEmail

data/lib/mn_utils_gem/version.rb

@@ -1,3 +1,3 @@
 module MnUtilsGem
-  VERSION = "1.7.0"
+  VERSION = "1.8.0"
 end

data/lib/mn_utils_gem.rb

@@ -1,5 +1,6 @@
 require "mn_utils_gem/version"
 require "mn_utils_gem/site_action"
+require "mn_utils_gem/transactional_email"
 
 module MnUtilsGem
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mn_utils_gem
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Shamim Mirzai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2019-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gelf
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sqs
+  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: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +130,7 @@ extra_rdoc_files: []
 files:
 - lib/mn_utils_gem.rb
 - lib/mn_utils_gem/site_action.rb
+- lib/mn_utils_gem/transactional_email.rb
 - lib/mn_utils_gem/version.rb
 homepage: https://github.com/mumsnet/mn_utils_gem
 licenses: []