web47core 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 623ae80309063bdc6c27dee1668a86ae4473da7db27a6ffedb9bd75df3b83d40
-  data.tar.gz: e39e28438fb5247ddb2cc65c9dd3b5c8edb8a98d9079921b3dc07d511b587ecb
+  metadata.gz: 97cb8fc1a923a3c6a911a319404529ef67ad9de4d1f20d6c90b088f99d8e366a
+  data.tar.gz: 53ce4e9da8a4279b4bc4eb3ffb7a0f58b9ec1844c6f1f42adeed9d3e572f3f7e
 SHA512:
-  metadata.gz: db0cd4d93d34398cf6e3a4739016db9fd63337e048917403ea9ec624ee5f516ecdb8a9ac278925f8f329dde34c3a42af16b856530ae976c5cc9534eca0999143
-  data.tar.gz: b5304422a552e6ec81a9e188000533a8a4652e66d3e6e8096b81abaf45d5e4646cc5ed5b7591265c5639f56225e977ba26cb68351eda9e1c20743d70b81b3580
+  metadata.gz: e3598aefea3e3b1411e4e4c60c1096129ba90fc5d33ae2c0907762d223ce234f3a4c56e50d28b2dc218a82544a51e9003bc20e0bf4f68bff70d0e767667887ad
+  data.tar.gz: 773f67eac21317c9da0c286c1071383f864b42f4a1d36dcef624bf3968dedf40d96452f9a3eb252057fb805dd6ce66c4302746e72838a4fcd856d30c23e95563

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    web47core (0.0.9)
+    web47core (0.0.10)
       activesupport (~> 5.0)
       aws-sdk-ec2 (> 1.140, <= 1.160)
       delayed_job_mongoid (~> 2.3)
+      email_format
       haml
       jwt
       liquid
@@ -13,6 +14,8 @@ PATH
       redis (~> 4.1)
       redis-rails (> 5, < 6)
       rest-client (>= 0, <= 2.1.0)
+      twilio-ruby (>= 3.0, <= 4.13)
+      tzinfo
 
 GEM
   remote: https://rubygems.org/
@@ -63,7 +66,7 @@ GEM
     ansi (1.5.0)
     arel (9.0.0)
     aws-eventstream (1.0.3)
-    aws-partitions (1.288.0)
+    aws-partitions (1.289.0)
     aws-sdk-core (3.92.0)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
@@ -99,6 +102,10 @@ GEM
     docile (1.3.2)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    email_format (1.0.0)
+      activemodel
+      email_regex
+    email_regex (0.0.1)
     erubi (1.9.0)
     factory_bot (5.1.1)
       activesupport (>= 4.2.0)
@@ -119,7 +126,7 @@ GEM
       concurrent-ruby (~> 1.0)
     jmespath (1.4.0)
     json (2.3.0)
-    jwt (2.2.1)
+    jwt (1.5.6)
     liquid (4.0.3)
     listen (3.2.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
@@ -167,6 +174,7 @@ GEM
     mongoid-compatibility (0.5.1)
       activesupport
       mongoid (>= 2.0)
+    multi_json (1.14.1)
     netrc (0.11.0)
     nio4r (2.5.2)
     nokogiri (1.10.9)
@@ -252,6 +260,10 @@ GEM
     thor (1.0.1)
     thread_safe (0.3.6)
     tilt (2.0.10)
+    twilio-ruby (4.13.0)
+      builder (>= 2.1.2)
+      jwt (~> 1.0)
+      multi_json (>= 1.3.0)
     tzinfo (1.2.6)
       thread_safe (~> 0.1)
     unf (0.1.4)
@@ -284,7 +296,7 @@ DEPENDENCIES
   minitest-reporters
   mocha
   shoulda (= 3.6.0)
-  shoulda-matchers (= 3.1.2)
+  shoulda-matchers
   simplecov (= 0.16.1)
   test-unit
   vcr

data/README.md

@@ -1,6 +1,11 @@
 # web47core
 Core components used commonly among all web apps for both App47 and RedMonocle
 
+## We don't need no sticking badges
+
+*  [![Codacy Badge](https://api.codacy.com/project/badge/Grade/acc591f31c214849959f71e210e7edbd)](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=App47/web47core&utm_campaign=Badge_Grade)
+*  [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/acc591f31c214849959f71e210e7edbd)](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=App47/web47core&utm_campaign=Badge_Coverage)
+
 ## Requirements
 
 *  Ruby 2.4.1
@@ -27,62 +32,62 @@ bundle install --path vendor
 ```
 The `--path vendor` simply puts all gem files in a `vendor` directory. 
 
-# Development
+## Development
 
 Your `RubyMine` environment should be setup now, however to verify all is well, please run the test suite
 ``` 
 bundle exec rake test
 ```
 
-# Deployment
+## Deployment
 The `web47core` project is a gem that will be deployed via [Ruby Gems](https://rubygems.org). When an update is ready, the following steps should be followed
 
-1. Build the gem `gem build web47core.gemspec`
-1. Push the new gem to [Ruby Gems](https://rubygems.org) `gem push web47core-<<version>>.gem`
-1. There may be a delay when using the gem file
+1.  Build the gem `gem build web47core.gemspec`
+2.  Push the new gem to [Ruby Gems](https://rubygems.org) `gem push web47core-version.gem`
+3.  There may be a delay when using the gem file
 
-# Usage
-## Importing the gem
+## Usage
+### Importing the gem
 To use the `app47core` gem in a project, first add the gem to your Gemfile in one of two ways
 
 Using the gem from [Ruby Gems](https://rubygems.org)
-```
+```rbenv-gemsets
 gem 'web47core'
 ```
 
 If you need the gem immediately or need to pull from development branch, you can use the git repo
-```
+```rbenv-gemsets
 gem 'web47core', git: 'git@github.com:App47/web47core.git', branch: :master
 ```
 or from the develop branch
-```
+```rbenv-gemsets
 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_
 
-## 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
+### Remove the following files
+1.  `StandardModel` - Includes the common set of includes, Mongoid, Auditable, AutoClearCache, etc.
+2.  `CdnUrl` - Provide CDN URLs of your classes URLs when cdn_url is configured in system configuration
+3.  `AutoClearCache` - Clears your objects cache out of Rails.cache using the object's id
+4.  `Formable` - Consolidated into StandardModel, was used to provide common form operations for mongoid documents
+5.  `EmailNotification` 
+6.  `EmailTemplate` 
+7.  `Notification` 
+8.  `NotificationTemplate` 
+9.  `SlackNotification` 
+10.  `SmsNotification`
+11.  `Template` 
+
+#### Models
+##### Concerns 
+1.  `StandardModel` - Includes the common set of includes, Mongoid, etc.
+2.  `CoreSystemConfiguration` - Base system configuration to be included in the app's SystemConfiguration Object
+3.  `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.
 
-```
+```ruby
 class SystemConfiguration
   include StandardModel
   include CoreSystemConfiguration
@@ -91,10 +96,10 @@ class SystemConfiguration
   field :google_sso_client_id, type: String
 end
 ```
-#### Account
+##### Account
 Define a `Account` class in your project and import the core concern.
 
-```
+```ruby
 class Account
   include StandardModel
   include CoreAccount
@@ -103,4 +108,3 @@ class Account
   has_many :users
 end
 ```
-

data/config/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  time:
+    formats:
+      long: '%Y-%m-%d %H:%M:%ss (%Z)'
+      medium: '%Y-%m-%d %H:%M (%Z)'
+      short: '%m/%d/%Y'
+  date:
+    formats:
+      long: '%B %d, %Y'
+      medium: '%b %d, %Y'
+      short: '%m/%d/%Y'

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

@@ -63,7 +63,7 @@ module App47Logger
 
     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?
+    exception.backtrace[0..max_frame].each { |frame| log_message(level, frame) } if exception.backtrace.present?
   end
 
   #

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

@@ -117,6 +117,10 @@ module CoreSystemConfiguration
     def respond_to?(method_name, _include_private = false)
       SystemConfiguration.fields.include?(method_name)
     end
+
+    def respond_to_missing?(method_name, _include_private = false)
+      SystemConfiguration.fields.include?(method_name)
+    end
     # rubocop:enable Style/MethodMissingSuper
   end
 
@@ -208,7 +212,7 @@ module CoreSystemConfiguration
     config = SystemConfiguration.configuration
     path = if config.zendesk_configured? && user.present?
              time_now = Time.now.to_i
-             jti = "#{time_now}/#{rand(36 ** 64).to_s(36)}"
+             jti = "#{time_now}/#{rand(36**64).to_s(36)}"
              payload = { jwt: JWT.encode({ iat: time_now, # Seconds since epoch, determine when this token is stale
                                            jti: jti, # Unique token identifier, helps prevent replay attacks
                                            name: user.name,

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

@@ -0,0 +1,84 @@
+#
+# Objects that emails can be sent too...
+#
+module EmailAble
+  extend ActiveSupport::Concern
+  include App47Logger
+
+  def self.included(base)
+    base.class_eval do
+      field :email, type: String
+      field :email_bounced_at, type: Time
+      field :email_bounce_reason, type: String
+      field :unconfirmed_email, type: String
+      field :email_enabled, type: Boolean, default: true
+      #
+      # Validations
+      #
+      validates :email, presence: true, email_format: { strict: true }
+      #
+      # Callbacks
+      #
+      before_validation :downcase_email
+    end
+  end
+
+  #
+  # Support legacy apps with old name
+  #
+  def email_bounce_date(date = nil)
+    self.email_bounced_at = date if date.present?
+    email_bounced_at
+  end
+
+  #
+  # Is this a valid email to send to?
+  #
+  def valid_email?
+    email_enabled? && !email_bounced?
+  end
+
+  #
+  # Has the email bounced?
+  #
+  def email_bounced?
+    email_bounced_at.present?
+  end
+
+  #
+  # Set the email to a bounced status with the given reason
+  #
+  def bounced(reason)
+    set email_bounced_at: Time.now.utc, email_bounce_reason: reason
+  end
+
+  #
+  # Reset the bounced email
+  #
+  def reset_bounce_status
+    return unless SystemConfiguration.mailgun_configured? && email_bounced?
+
+    reset_url = "https://api.mailgun.net/v3/#{SystemConfiguration.smtp_domain}/bounces/#{CGI.escape(email)}"
+    RestClient.delete(reset_url, user: 'api', password: SystemConfiguration.mailgun_api_key)
+  rescue RestClient::Exception => error
+    log_error "Unable to reset email bounce status: #{inspect}", error
+  ensure
+    set email_bounced_at: nil, email_bounce_reason: nil
+  end
+
+  #
+  # Return the gravatar URL based on email address
+  #
+  def gravatar_url(size = '32', default = 'mm')
+    "https://www.gravatar.com/avatar/#{Digest::MD5.hexdigest(email)}?s=#{size}&d=#{default}"
+  end
+
+  private
+
+  #
+  # Make sure emails are always downcased
+  #
+  def downcase_email
+    self.email = email.strip.downcase if email.present?
+  end
+end

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+#
+# Public: Add search and sort text to an object
+#
+module SearchAble
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      #
+      # Fields
+      #
+      field :search_text, type: String
+      field :sort_text, type: String
+      #
+      # Call backs
+      #
+      before_validation :update_search_and_sort_text
+    end
+  end
+
+  #
+  # Public: Add to class methods a way to search for records with matching
+  # search text.
+  #
+  # Examples
+  #
+  #   Model.matching_search_text('some text')
+  #   # => <Mongoid::critera>
+  #
+  module ClassMethods
+    def matching_search_text(search_text = nil)
+      (search_text.blank? ? all : where(search_text: /#{search_text.downcase}/)).order(sort_order)
+    end
+
+    def sort_order
+      new.sort_fields.collect { |field| [field, 1] }
+    end
+  end
+
+  #
+  # Internal: Update the search and sort text
+  #
+  # Call before validation to update, changes are persisted with the object.
+  #
+  def update_search_and_sort_text
+    return if destroyed?
+
+    update_text(search_fields, :search_text)
+    update_text(sort_fields, :sort_text)
+  end
+
+  #
+  # Internal: Update the search text
+  #
+  # Examples
+  #
+  #   update_search_text
+  #
+  def update_text(fields, field_to_update)
+    items = fields.reject { |field| send(field.to_sym).blank? }.collect do |field|
+      value = send(field.to_sym)
+      if value.is_a? String
+        value.downcase
+      elsif value.is_a? Array
+        value.empty? ? nil : value.join(' ').downcase
+      end
+    end
+    send "#{field_to_update}=", items.compact.join(' ')
+  end
+
+  #
+  # Internal: Which fields to add to search text
+  #
+  # Examples
+  #
+  #   search_fields
+  #   # => ['name', 'email', 'code']
+  #
+  # Return which fields should be added to search
+  #
+  def search_fields
+    %w[name]
+  end
+
+  #
+  # Internal: Which fields to add to sort on
+  #
+  # Examples
+  #
+  #   sort_fields
+  #   # => ['name', 'email']
+  #
+  # Return which fields should be added to sort
+  #
+  def sort_fields
+    search_fields
+  end
+end

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

@@ -101,7 +101,7 @@ module StandardModel
     super(remove_blank_secure_fields(params))
   end
 
-  alias :update_attributes :update
+  alias update_attributes update
 
   #
   # Remove updates for secure fields that come across as blank to start with and get removed on update
@@ -110,7 +110,7 @@ module StandardModel
     super(remove_blank_secure_fields(params))
   end
 
-  alias :update_attributes! :update!
+  alias update_attributes! update!
 
   #
   # List of secure fields, to add fields in concrete class, simply override this method