web47core 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e82f9597abea49e585537bf7b37dd78220136b34e2f2bc0ade5592e4d70ae9d
-  data.tar.gz: 523f737ac0beae20e3203ba4188c66e4cf5c09b8749084bf67dfd07fb039a3e7
+  metadata.gz: 623ae80309063bdc6c27dee1668a86ae4473da7db27a6ffedb9bd75df3b83d40
+  data.tar.gz: e39e28438fb5247ddb2cc65c9dd3b5c8edb8a98d9079921b3dc07d511b587ecb
 SHA512:
-  metadata.gz: e4a973a0840c34dc033b5f512e9e5bb62618afa44f20fc5b9e6993a59ef0cbde59befc204becd175dd15db7f02f4952f516af9d77dfb9cbb8fd70fd17991fc32
-  data.tar.gz: 6b2dff4fb23a286a60a0cccc2cd618d17b38379148aad5d385463df8a81ce55542ec9cde451516a52c6dfaf68204f585682849d546c6989800c4006fac95c091
+  metadata.gz: db0cd4d93d34398cf6e3a4739016db9fd63337e048917403ea9ec624ee5f516ecdb8a9ac278925f8f329dde34c3a42af16b856530ae976c5cc9534eca0999143
+  data.tar.gz: b5304422a552e6ec81a9e188000533a8a4652e66d3e6e8096b81abaf45d5e4646cc5ed5b7591265c5639f56225e977ba26cb68351eda9e1c20743d70b81b3580

data/Gemfile

@@ -1,19 +1,5 @@
 source 'https://rubygems.org'
 ruby '2.4.1'
 
-git_source(:github) do |repo_name|
-  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
-  "https://github.com/#{repo_name}.git"
-end
-
 # Specify your gem's dependencies
 gemspec
-
-gem 'aws-sdk-ec2'
-gem 'jwt'
-gem 'mongoid', '~> 6.4'
-
-group :test do
-  gem 'simplecov'
-  gem 'simplecov-lcov'
-end

data/Gemfile.lock

@@ -1,15 +1,18 @@
 PATH
   remote: .
   specs:
-    web47core (0.0.8)
+    web47core (0.0.9)
       activesupport (~> 5.0)
-      aws-sdk-ec2 (>= 1.60, <= 1.151)
+      aws-sdk-ec2 (> 1.140, <= 1.160)
       delayed_job_mongoid (~> 2.3)
+      haml
       jwt
+      liquid
       mongoid (> 6, < 7)
       rails (>= 4.2, < 5.3)
       redis (~> 4.1)
       redis-rails (> 5, < 6)
+      rest-client (>= 0, <= 2.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -60,7 +63,7 @@ GEM
     ansi (1.5.0)
     arel (9.0.0)
     aws-eventstream (1.0.3)
-    aws-partitions (1.286.0)
+    aws-partitions (1.288.0)
     aws-sdk-core (3.92.0)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
@@ -94,6 +97,8 @@ GEM
       mongoid (>= 3.0, < 8)
       mongoid-compatibility (>= 0.4.0)
     docile (1.3.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
     erubi (1.9.0)
     factory_bot (5.1.1)
       activesupport (>= 4.2.0)
@@ -103,12 +108,19 @@ GEM
     ffi (1.12.2)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
+    haml (5.1.2)
+      temple (>= 0.8.0)
+      tilt
     hashdiff (1.0.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     jmespath (1.4.0)
     json (2.3.0)
     jwt (2.2.1)
+    liquid (4.0.3)
     listen (3.2.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -120,6 +132,9 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
     mimemagic (0.3.4)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
@@ -152,6 +167,7 @@ GEM
     mongoid-compatibility (0.5.1)
       activesupport
       mongoid (>= 2.0)
+    netrc (0.11.0)
     nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
@@ -205,6 +221,11 @@ GEM
       redis-store (>= 1.2, < 2)
     redis-store (1.8.2)
       redis (>= 4, < 5)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
     shoulda (3.6.0)
@@ -218,7 +239,6 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    simplecov-lcov (0.8.0)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -226,12 +246,17 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
+    temple (0.8.2)
     test-unit (3.3.5)
       power_assert
     thor (1.0.1)
     thread_safe (0.3.6)
+    tilt (2.0.10)
     tzinfo (1.2.6)
       thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
     vcr (5.1.0)
     webmock (3.8.3)
       addressable (>= 2.3.6)
@@ -247,24 +272,20 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  aws-sdk-ec2
   bundler
   codacy-coverage (~> 2.1.0)
   database_cleaner
   factory_bot
   factory_bot_rails
-  jwt
   listen
   minitest (= 5.10.3)
   minitest-rails (= 3.0.0)
   minitest-rails-capybara (= 3.0.1)
   minitest-reporters
   mocha
-  mongoid (~> 6.4)
   shoulda (= 3.6.0)
   shoulda-matchers (= 3.1.2)
-  simplecov
-  simplecov-lcov
+  simplecov (= 0.16.1)
   test-unit
   vcr
   web47core!

data/README.md

@@ -61,13 +61,24 @@ gem 'web47core', git: 'git@github.com:App47/web47core.git', branch: :develop
 
 _Please do not ship to production code using the git repo, as the production servers will not have keys to pull from the web47core repo_
 
-## Features
-
-### Models
-#### Concerns
+## Remove the following files
 1. `StandardModel` - Includes the common set of includes, Mongoid, Auditable, AutoClearCache, etc.
 1. `CdnUrl` - Provide CDN URLs of your classes URLs when cdn_url is configured in system configuration
 1. `AutoClearCache` - Clears your objects cache out of Rails.cache using the object's id
+1. `Formable` - Consolidated into StandardModel, was used to provide common form operations for mongoid documents
+1. `EmailNotification` 
+1. `EmailTemplate` 
+1. `Notification` 
+1. `NotificationTemplate` 
+1. `SlackNotification` 
+1. `SmsNotification`
+1. `Template` 
+
+### Models
+#### Concerns 
+1. `StandardModel` - Includes the common set of includes, Mongoid, etc.
+1. `CoreSystemConfiguration` - Base system configuration to be included in the app's SystemConfiguration Object
+1. `CoreAccount` - Base account object that is related to notifications and the ilk.
 #### System Configuration
 Define a `SystemConfiguration` class in your project and import the core concern.
 
@@ -80,4 +91,16 @@ class SystemConfiguration
   field :google_sso_client_id, type: String
 end
 ```
+#### Account
+Define a `Account` class in your project and import the core concern.
+
+```
+class Account
+  include StandardModel
+  include CoreAccount
+  
+  # Include your additional system configuration fields and methods
+  has_many :users
+end
+```
 

data/lib/app/models/concerns/app47_logger.rb

@@ -0,0 +1,175 @@
+#
+# Mixin for App47 objects to handle logging in both the rails environment as well
+# as the delayed jobs environment that doesn't know about Rails.logger
+#
+# Provides ways to log at the class level as well as instance level.
+#
+#
+# Usage:
+#  App47Logger.log_debug('message')
+#
+# or
+#
+# class ClassName
+#  include App47Logger
+#
+#  def method_name
+#    log_debug('message')
+#  end
+#
+module App47Logger
+  #
+  # Log a debug messages
+  #
+  def self.log_debug(message)
+    log_message :debug, message
+  end
+
+  #
+  # Log a warning messages
+  #
+  # 1. Prints the messages
+  # 2. If an exception is passed n
+  #   2a prints the exception message
+  #   2b prints the stack trace
+  #
+  def self.log_warn(message, exception = nil)
+    log_message :warn, message
+    log_exception :warn, exception
+  end
+
+  #
+  # Log an error messages
+  #
+  # 1. Prints the messages
+  # 2. If an exception is passed n
+  #   2a prints the exception message
+  #   2b prints the stack trace
+  #
+  def self.log_error(message, exception = nil)
+    log_message :error, message
+    log_exception(:error, exception)
+    message = { message: message, exception: exception&.message }
+    SlackNotification.say message, template: :error_message
+  end
+
+  #
+  # Log a given exception, but only the first 10 lines in anything but test.
+  #
+  # In testing, we want the full stack to know the test case that failed.
+  #
+  def self.log_exception(level, exception = nil, max_frame = 9)
+    return if exception.blank?
+
+    max_frame = -1 if ENV['RACK_ENV'].eql?('test')
+    log_message(level, exception.message)
+    exception.backtrace[0..max_frame].each { |frame| log_message(level, frame) } unless exception.backtrace.blank?
+  end
+
+  #
+  # Log a given message at the given level
+  #
+  def self.log_message(level, message)
+    if Rails.env.test?
+      puts "#{level}: #{message}"
+    elsif Delayed::Worker.logger.nil?
+      Rails.logger.send level, message
+    else
+      Delayed::Worker.logger.send level, message
+    end
+  end
+
+  #
+  # Log a debug message as part of the mixin
+  #
+  def log_message(level, message)
+    App47Logger.log_message level, message
+  end
+
+  #
+  # Log a debug message as part of the mixin
+  #
+  def log_debug(message)
+    App47Logger.log_debug message
+  end
+
+  #
+  # Log a warning message as part of the mixin
+  #
+  def log_warn(message, exception = nil)
+    App47Logger.log_warn message, exception
+  end
+
+  #
+  # Log an error message as part of the mixin
+  #
+  def log_error(message, exception = nil)
+    App47Logger.log_error message, exception
+  end
+
+  #
+  # Log a controller error message
+  #
+  def log_controller_error(exception, redirecting = false)
+    if exception.is_a? ActionController::RoutingError
+      App47Logger.log_warn "#{controller_name}##{action_name} #{clean_params(params)}", exception
+    else
+      App47Logger.log_error "#{controller_name}##{action_name} #{clean_params(params)}", exception
+    end
+    update_flash_messages(exception, redirecting) if defined?(request) && request.present?
+  end
+
+  #
+  # Update the flash message based on the type of exception we get
+  # Currently we only handle mongoid errors, but there may be other
+  # common errors we can handle formatting for...
+  #
+  def update_flash_messages(exception, redirecting = false)
+    case exception
+    when Mongoid::Errors::Validations
+      if redirecting
+        flash[:error] = exception.problem
+        flash[:warning] = exception.summary
+      else
+        flash.now[:error] = exception.problem
+        flash.now[:warning] = exception.summary
+      end
+    else
+      if redirecting
+        flash[:error] = exception.message
+      else
+        flash.now[:error] = exception.message
+      end
+    end
+  end
+
+  #
+  # Recursively hide any fields in the rails config filter_parameters
+  #
+  def clean_params(pars)
+    pars.each do |key, value|
+      if mask_parameter_keys.include?(key)
+        pars[key] = '[FILTERED]'
+      elsif delete_parameter_keys.include?(key)
+        pars.delete(key)
+      elsif value.is_a?(Hash) || value.is_a?(ActionController::Parameters)
+        pars[key] = clean_params(value)
+      end
+    end
+    pars
+  end
+
+  #
+  # which parameters to filter out
+  #
+  def mask_parameter_keys
+    @mask_parameter_keys ||= Rails.application.config.filter_parameters
+  end
+
+  #
+  # which parameters to filter out
+  #
+  def delete_parameter_keys
+    @delete_parameter_keys ||= %w[file authenticity_token commit upload]
+  end
+end

data/lib/app/models/concerns/core_account.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+#
+# The System configuration. Various configuration items that can be updated/defined at run time
+#
+# Use of this class allows you to simply ask for the configuration parameter directly without
+# first having to get an instance of it.
+#
+# SystemConfiguration.queue_impl #=> 'RedisQueue'
+#
+# This method only is allowed for accessors, you should NEVER set values on the SystemConfiguration
+# unless you are updating via the Admin or Stack UI, or during testing to setup a specific configuration
+# for that.
+#
+module CoreAccount
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      #
+      # Fields
+      #
+      field :name, type: String
+      #
+      # Relationships
+      #
+      has_many :notifications, dependent: :delete do
+        def emails
+          where(_type: 'EmailNotification')
+        end
+
+        def slacks
+          where(_type: 'SlackNotification')
+        end
+
+        def sms
+          where(_type: 'SmsNotification')
+        end
+      end
+      has_many :templates, dependent: :delete
+      embeds_one :smtp_configuration
+    end
+  end
+
+  #
+  # Return or build the smtp configuration for the account
+  #
+  def fetch_smtp_configuration
+    smtp_configuration || build_smtp_configuration
+  end
+end

data/lib/app/models/concerns/standard_model.rb

@@ -6,15 +6,18 @@
 #
 module StandardModel
   extend ActiveSupport::Concern
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include App47Logger
+  # include Auditable
 
   def self.included(base)
     base.class_eval do
-      include Mongoid::Document
-      include Mongoid::Timestamps
-      # include App47Logger
-      # include Auditable
-      include Formable
-      include AutoClearCache
+      #
+      # Callbacks
+      #
+      after_save :clear_cache
+      before_destroy :clear_cache
     end
   end
 
@@ -37,5 +40,100 @@ module StandardModel
     def make_options(options)
       options.collect { |t| [t, t.humanize] }
     end
+
+    #
+    # Return the complete list of key names that would appear in the form.
+    #
+    def allowed_param_names(filter_names = [])
+      # Always filter out the mongoid reserved items
+      filter_names += %w[created_at updated_at _type _id]
+      associations = all_associations
+      # filter out the relationship names so we don't have dups
+      associations.each { |association| filter_names << association.keys.first }
+      (field_names + associations).delete_if { |name| filter_names.include?(name) }
+    rescue StandardError
+      attribute_names.delete_if { |name| filter_names.include?(name) }
+    end
+
+    #
+    # allow the model to filter out a name if they want to, meaning the model
+    # can return a subset of attribute names
+    #
+    def field_names
+      attribute_names
+    end
+
+    #
+    # gather up the collections we care about and return them. For now, the
+    # many to many associations are the ones that need some extra help.
+    #
+    def all_associations
+      many_to_many_associations
+    end
+
+    #
+    # Return a collection of many to many assocations. We basically
+    # need to turn the current value returned by attribute names
+    #
+    # relationship_ids
+    #
+    # to
+    #
+    # { relationship_ids => [] }
+    #
+    # Telling the permit command to accept the value as an array of items.
+    #
+    def many_to_many_associations
+      associations = []
+      reflect_on_all_associations.each do |association|
+        next unless association.macro == :has_and_belongs_to_many
+
+        associations << { association.key => [] }
+      end
+      associations
+    end
+  end
+
+  #
+  # Remove updates for secure fields that come across as blank to start with and get removed on update
+  #
+  def update(params)
+    super(remove_blank_secure_fields(params))
+  end
+
+  alias :update_attributes :update
+
+  #
+  # Remove updates for secure fields that come across as blank to start with and get removed on update
+  #
+  def update!(params)
+    super(remove_blank_secure_fields(params))
+  end
+
+  alias :update_attributes! :update!
+
+  #
+  # List of secure fields, to add fields in concrete class, simply override this method
+  #
+  def secure_fields
+    []
+  end
+
+  def remove_blank_secure_fields(params)
+    secure_fields.each { |field| params.delete(field) if params[field].blank? }
+    params
+  end
+
+  #
+  # Clear the cache
+  #
+  def clear_cache
+    Rails.cache.delete_matched "*#{id}*"
+    return unless respond_to?(:account) && account.present? && account.is_a?(Account)
+
+    Rails.cache.delete_matched "*#{account.id}*"
+    true # Force a return of true so that we don't break the callback chain.
+  rescue StandardError
+    false
   end
 end