mn_utils_gem 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 419e0bfbbf1a78e1c98adcfbb2a9bfac214572f1cfd6c3f7f3b3a261e3e58e2d
+  data.tar.gz: bc949046b18e79169aeb93231177fbbcb518fb920d45391a90900e781c7695b6
+SHA512:
+  metadata.gz: f6d4f8e1121c6667735824ed70cdd2f5069dcadd8f7fa2cb01c75c6c008d1187a8a507c79c58a15e573e52891163975206ce226e2c9c15f6217f8f998d550086
+  data.tar.gz: d9e34a791f3d3c392d23d6ed3fe0f3da90f6413ba2d1da9ff26a898e6d8798629409f252e0384d3753a63f65e1e88fb49044f4fd59517b05dc75df57fd7c4223

data/lib/mn_utils_gem/site_action.rb

@@ -0,0 +1,144 @@
+require 'gelf'
+require 'aws-sdk-cloudwatch'
+require 'request_store'
+require 'singleton'
+
+# SiteAction class to log important site actions to Graylog
+# and send a matching metric to Cloudwatch
+#
+# usage: MnUtils::SiteAction.instance.log(message, site_action, optional_payload)
+#
+#    eg: MnUtils::SiteAction.instance.log(
+#           "Login attempted with non-existent email",
+#           :login_attempt_nonexistent_email,
+#           {_email: "fish@banana.com", _request_ip: "123.123.123.123"}
+#        )
+#        This logs all the details in Graylog and records a count of 1
+#        against a Cloudwatch metric called login_attempt_nonexistent_email in namespace mn/auth
+#
+# The optional payload should be a simple flat hash with all keys starting
+# with an underscore _ and all values being strings
+
+module MnUtils
+  class SiteAction
+
+    include Singleton
+
+    def initialize
+      # add new site actions here under the relevant group
+      # NO DUPLICATES please - a site action can only exist under one group
+      @_site_actions_and_groups = {
+          test: [
+              :test_event_1,
+              :test_event_2
+          ],
+          reg: [
+              :reg_success_via_email,
+              :reg_success_via_google,
+              :reg_success_via_facebook,
+              :reg_attempt_invalid_email,
+              :reg_attempt_invalid_password,
+              :reg_attempt_invalid_username,
+          ],
+          auth: [
+              :login_success_via_email,
+              :login_success_via_google,
+              :login_success_via_facebook,
+              :login_attempt_invalid_email,
+              :login_attempt_nonexistent_email,
+              :login_attempt_invalid_password,
+              :login_attempt_incorrect_password,
+          ],
+      }.freeze
+
+      # this creates 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,v| v.map {|x| [x, k]}}.flatten)].freeze
+    end
+
+    def log(message, site_action, payload = {})
+
+      # validate the parameters
+      raise ArgumentError, 'message cannot be blank' \
+        if message.blank?
+      raise ArgumentError, 'site_action must be a symbol' \
+        unless site_action.is_a?(Symbol)
+      raise ArgumentError, 'payload must be a hash' \
+        unless payload.is_a?(Hash)
+      raise ArgumentError, 'site_action value is not in allowed list' \
+        unless @_site_action_group_map.key? site_action
+
+      # validate the payload hash
+      payload.each do |key, value|
+        raise ArgumentError, "payload key #{key} must be a symbol" \
+          unless key.is_a?(Symbol)
+        key_string = key.to_s
+        raise ArgumentError, "payload key #{key} must begin with an underscore" \
+          unless key_string.chars.first == '_'
+        raise ArgumentError, "payload key #{key} must be at least 2 characters long" \
+          unless key_string.length >= 2
+        raise ArgumentError, "payload key cannot be _id" \
+          if key_string == '_id'
+        raise ArgumentError, "payload value for key #{key} must be a string" \
+          unless value.is_a?(String)
+      end
+
+      # validate the environment variables we need
+      raise ArgumentError, "ENV['SRV_CODE'] cannot be blank" \
+        unless ENV.key? 'SRV_CODE'
+
+      # setup the full payload
+      full_payload = payload.dup
+      full_payload[:short_message] = message
+      full_payload[:_site_action_group] = @_site_action_group_map[site_action]
+      full_payload[:_site_action] = site_action
+      full_payload[:_srv_code] = ENV['SRV_CODE']
+
+      # add the request ID if available
+      if RequestStore.store[:request_id]
+        full_payload[:_request_id] = RequestStore.store[:request_id]
+      end
+
+      # send it off
+      send_to_graylog full_payload
+      send_to_cloudwatch full_payload
+    end
+  end
+
+  private
+
+  def send_to_graylog(payload)
+    if ENV.key?('GRAYLOG_GELF_UDP_HOST') && ENV.key?('GRAYLOG_GELF_UDP_PORT')
+      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}")
+    end
+  rescue Exception => e
+    Rails.logger.error e
+  end
+
+  def send_to_cloudwatch(payload)
+    metric_name = payload[:_site_action]
+    metric_data = [{
+        metric_name: metric_name,
+        value: 1,
+        unit: "Count"
+    }]
+    if ENV.key?'CLOUDWATCH_ROOT_NAMESPACE'
+      root_namespace = ENV['CLOUDWATCH_ROOT_NAMESPACE']
+      second_namespace = payload[:_site_action_group]
+      namespace = "#{root_namespace}/#{second_namespace}"
+      cw = Aws::CloudWatch::Client.new
+      cw.put_metric_data({
+          namespace: namespace,
+          metric_data: metric_data
+      })
+    else
+      Rails.logger.debug("Payload for Cloudwatch #{metric_data}")
+    end
+  rescue Exception => e
+    Rails.logger.error e
+  end
+
+end

data/lib/mn_utils_gem/version.rb

@@ -0,0 +1,3 @@
+module MnUtilsGem
+  VERSION = "0.2.0"
+end

data/lib/mn_utils_gem.rb

@@ -0,0 +1,6 @@
+require "mn_utils_gem/version"
+
+module MnUtilsGem
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: mn_utils_gem
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Shamim Mirzai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gelf
+  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: aws-sdk-cloudwatch
+  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
+    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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mn_utils_gem.rb
+- lib/mn_utils_gem/site_action.rb
+- lib/mn_utils_gem/version.rb
+homepage: https://github.com/mumsnet/mn_utils_gem
+licenses: []
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Mumsnet utils gem for microservices
+test_files: []