web47core 0.0.8 → 0.0.9

data/lib/app/models/smtp_configuration.rb

@@ -0,0 +1,148 @@
+#
+# SMTP Configuration for an account
+#
+class SmtpConfiguration
+  include StandardModel
+
+  field :email_address, type: String
+  field :reply_to_address, type: String
+  field :domain, type: String
+  field :port, type: Integer, default: 587
+  field :authentication_method, type: String
+  field :confirmation_token, type: String
+  field :confirmed, type: Boolean, default: false
+  field :verification_message, type: String
+  field :active, type: Boolean, default: false
+  field :ssl, type: Boolean, default: false
+  field :server_name, type: String
+  field :username, type: String
+  field :password, type: String
+  #
+  # Relationships
+  #
+  embedded_in :account
+  #
+  # Validations
+  validates :server_name, :username, :email_address, :port, presence: true
+  #
+  # Callbacks
+  #
+  before_save :update_token
+  #after_save :send_smtp_verification
+
+  #
+  # If we can use this SMTP configuration or not, it must be confirmed and
+  # activate. Otherwise we return false.
+  #
+  def use?
+    confirmed? && active?
+  end
+
+  def secure_fields
+    super + %i[password]
+  end
+
+  def validate_token(token)
+    valid = false
+    unless confirmation_token.nil?
+      if confirmation_token.eql? token
+        valid = true
+        unset(:confirmation_token)
+        unset(:verification_message)
+      end
+    end
+    set(confirmed: valid)
+    valid
+  end
+
+  #
+  # Update the token on save if we are active and the token is not already set.
+  def update_token
+    if active?
+      set(confirmation_token: Devise.friendly_token) if confirmation_token.nil?
+      set(confirmed: false)
+      set(verification_message: 'Sending SMTP verification email(s) to SMTP admins.')
+    else
+      set(verification_message: 'SMTP Configuration is not active, no verification email will be sent.')
+    end
+  end
+
+  def send_smtp_verification
+    if self.active?
+      sent_to= []
+      self.account.smtp_admins.each do |admin|
+        sent_to << admin.email if self.send_confirmation(admin)
+      end
+      if sent_to.empty?
+        set(verification_message: "No confirmations emails sent: (#{verification_message}).")
+      else
+        set(verification_message: "Confirmation emails sent to SMTP admins: #{sent_to.join(", ")}")
+      end
+    end
+  end
+
+  def send_confirmation(member)
+    sent = false
+    begin
+      mail = Mail.new
+      # Set the from line
+      mail.from = email_address
+
+      # Set the to address
+      mail.to = member.email
+
+      # Set the subject line
+      mail.subject = 'Verify SMTP configuration change'
+
+      # set the message body and send
+      html_message = build_message
+      mail.html_part do
+        content_type 'text/html; charset=UTF-8'
+        body html_message
+      end
+
+      # Setup the delivery method for this message only.
+      if Rails.env.test?
+        mail.delivery_method :test
+      else
+        config = { address: self.server_name,
+                   port:  self.port,
+                   authentication: self.authentication_method.to_sym,
+                   enable_starttls_auto: self.ssl.eql?(true) }
+        config[:domain] = self.domain unless self.domain.nil? or self.domain.empty?
+        config[:user_name] = self.username unless self.username.nil? or self.username.empty?
+        config[:password] = self.password unless self.password.nil? or self.password.empty?
+
+        mail.delivery_method :smtp, config
+      end
+
+      # Deliver it
+      mail.deliver
+      sent = true
+
+    rescue Exception=>e
+      App47::Logger.log_error "Unable to send SMTP confirmation email #{e.message}"
+      App47::Logger.log_error e.backtrace
+      set(verification_message: "Unable to send verification email to #{member.email}, error: #{e.message}")
+    end
+    sent
+  end
+
+  def build_message
+    template = File.read(Rails.root.join('app', 'assets', 'templates', 'email', "verify_smtp_configuration.liquid"))
+    engine = Liquid::Template.parse(template)
+    engine.render({
+                    'account_name' => account.name,
+                    'confirmation_url' => "#{SystemConfiguration.webui_url}/smtp_configuration/confirm_change?token=#{confirmation_token}"
+                  })
+  end
+
+  def to_yaml_properties(wrap = true)
+    if wrap
+      self.class.new.to_yaml_properties(false)
+    else
+      super()
+    end
+  end
+
+end

data/lib/app/models/template.rb

@@ -0,0 +1,21 @@
+#
+# Base template object for managing all communications templates
+#
+class Template
+  include StandardModel
+  #
+  # Fields
+  #
+  field :name, type: String
+  field :template, type: String
+  #
+  # Relationships
+  #
+  belongs_to :account, inverse_of: :templates
+  #
+  # Validations
+  #
+  validates :name, uniqueness: {scope: :account_id}
+  validates :name, presence: true
+  validates :template, presence: true
+end

data/lib/templates/email/notification_failure.liquid

@@ -0,0 +1,10 @@
+<html>
+  <meta content="text/html; charset=UTF-8"/>
+  <body style='margin:20px'>
+    <p>Failed to send the following notification due to the following error:</p>
+    <ul style='list-style-type:none; margin:25px 15px;'>
+      <li><b>Error:</b> {{ error_message }}</li>
+      <li><b>Notification:</b> {{ notification_url }}</li>
+     </ul>
+  </body>
+</html>

data/lib/templates/email/notification_failure.subject.liquid

@@ -0,0 +1 @@
+Failed to send email

data/lib/templates/slack/error_message.liquid

@@ -0,0 +1 @@
+*ERROR:* `{{message}}`{% if exception != blank %} - `{{exception}}`{% endif %}

data/lib/web47core.rb

@@ -1,5 +1,13 @@
-require 'app/models/concerns/auto_clear_cache'
+require 'app/models/concerns/app47_logger'
 require 'app/models/concerns/cdn_url'
-require 'app/models/concerns/formable'
 require 'app/models/concerns/standard_model'
 require 'app/models/concerns/core_system_configuration'
+require 'app/models/concerns/core_account'
+require 'app/models/notification'
+require 'app/models/template'
+require 'app/models/notification_template'
+require 'app/models/email_notification'
+require 'app/models/email_template'
+require 'app/models/slack_notification'
+require 'app/models/smtp_configuration'
+require 'app/models/sms_notification'

data/test/factories/account_factories.rb

@@ -0,0 +1,9 @@
+#
+# Create basic accounts
+#
+FactoryBot.define do
+  # default account
+  factory :account, class: Account do
+    sequence(:name) { |n| "Account-#{n}" }
+  end
+end

data/test/factories/notification_factories.rb

@@ -0,0 +1,14 @@
+FactoryBot.define do
+
+  factory :notification, class: Notification do
+    to { "noone@app47.com" }
+    message { "None message" }
+  end
+
+  factory :email_notification, class: EmailNotification do
+    to { "noone@app47.com" }
+    sender { "someone@app47.com" }
+    subject { "here me roar!" }
+    message { "None message" }
+  end
+end

data/test/models/app47_logger_test.rb

@@ -0,0 +1,88 @@
+require 'test_helper'
+
+class App47LoggerTestCase < ActiveSupport::TestCase
+  include App47Logger
+  context 'as singleton' do
+    should 'log a debug message' do
+      App47Logger.expects(:log_message).once
+      App47Logger.log_debug('Foo')
+    end
+    should 'log a warn message with out exception' do
+      App47Logger.expects(:log_message).once
+      App47Logger.log_warn('Foo')
+    end
+    should 'log a warn message with exception' do
+      App47Logger.expects(:log_message).twice
+      App47Logger.log_warn('Foo', Exception.new)
+    end
+    should 'log a error message with out exception' do
+      App47Logger.expects(:log_message).once
+      App47Logger.log_error('Foo')
+    end
+    should 'log a error message with exception' do
+      App47Logger.expects(:log_message).twice
+      App47Logger.log_error('Foo', Exception.new)
+    end
+  end
+
+  context 'as class method' do
+    should 'log a debug message' do
+      App47Logger.expects(:log_message).once
+      log_debug('Foo')
+    end
+    should 'log a message' do
+      App47Logger.expects(:log_message).once
+      log_message(:debug, 'Foo')
+    end
+    should 'log a warn message with out exception' do
+      App47Logger.expects(:log_message).once
+      log_warn('Foo')
+    end
+    should 'log a warn message with exception' do
+      App47Logger.expects(:log_message).twice
+      log_warn('Foo', Exception.new)
+    end
+    should 'log a error message with out exception' do
+      App47Logger.expects(:log_message).once
+      SlackNotification.expects(:say)
+      log_error('Foo')
+    end
+    should 'log a error message with exception' do
+      App47Logger.expects(:log_message).twice
+      SlackNotification.expects(:say)
+      log_error('Foo', Exception.new)
+    end
+  end
+
+  context 'log message' do
+    should 'Log debug' do
+      App47Logger.expects(:puts).once
+      App47Logger.log_debug('Foo')
+    end
+  end
+
+  context 'as a controller' do
+    should 'log a controller' do
+      App47Logger.expects(:log_message).once
+      log_controller_error(nil)
+    end
+    should 'log a controller with exception' do
+      App47Logger.expects(:log_message).twice
+      log_controller_error(Exception.new('Message'))
+    end
+  end
+  #
+  # Support the testing of log_controller_error
+  #
+  def controller_name
+    'tester'
+  end
+
+  def action_name
+    'tester'
+  end
+
+  def params
+    {}
+  end
+end

data/test/models/concerns/{formable_test.rb → standard_model_test.rb}

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 # TODO: CMS add tests for clearing by account id as well as id
-class FormableTest < ActiveSupport::TestCase
+class StandardModelTest < ActiveSupport::TestCase
 
   context 'allowed_params' do
     should 'return test form fields' do
@@ -52,11 +52,23 @@ class FormableTest < ActiveSupport::TestCase
       assert_equal 'abc123', @model.password
     end
   end
+
+  context 'Remove cache on save' do
+    setup do
+      @model = TestAutoClearCache.new
+      assert @model.save
+      @model.update_cache
+    end
+    should 'return the original url' do
+      assert Rails.cache.exist? @model.id.to_s
+      assert @model.save
+      refute Rails.cache.exist? @model.id.to_s
+    end
+  end
 end
 
 class TestForm
-  include Mongoid::Document
-  include Formable
+  include StandardModel
   field :name
   field :password
   has_many :test_inputs
@@ -67,8 +79,15 @@ class TestForm
 end
 
 class TestInput
-  include Mongoid::Document
-  include Formable
+  include StandardModel
   field :input_type
   belongs_to :test_form
 end
+
+class TestAutoClearCache
+  include StandardModel
+
+  def update_cache(value = 'abc123')
+    Rails.cache.write id.to_s, value, expires_in: 60
+  end
+end

data/test/models/email_notification_test.rb

@@ -0,0 +1,297 @@
+require 'test_helper'
+require 'notification_test_helper'
+
+class EmailNotificationTest < ActiveSupport::TestCase
+
+  include Mail::Matchers
+  include NotificationTestHelper
+
+  setup do
+    @account = FactoryBot.create(:account)
+    assert_not_nil @account
+    assert @account.persisted?
+  end
+
+  context 'Create simple account notification' do
+    setup do
+      @email = EmailNotification.new
+      @email.account = @account
+      @email.to = 'a@app47.com'
+      @email.message = 'Now is the time for all men to come to the aid of their country'
+      @email.subject = 'Testing'
+      assert @email.save
+      assert @email.send_notification
+    end
+    should 'Have one email notification that is successfully sent' do
+      mails = Mail::TestMailer.deliveries
+      assert_equal 1, mails.count, 'Should only send one email'
+      mail = mails.first
+      assert_equal 'support@app47.com', mail.from.first, 'Should send from default mailer'
+    end
+
+    # MAM-8438 Hide the image better
+    should 'have the notifications url in the email to track it' do
+      mail_body = Mail::TestMailer.deliveries.first.all_parts.first.body
+      assert mail_body.include?("notifications/#{@email.id}/img"), mail_body.inspect
+      assert mail_body.include?("style='height:0;width:0;border:none;display:none;'"), mail_body.inspect
+    end
+  end
+  # context 'MAM-5971' do
+  #   should 'have mailgun smtp header when mailgun configured' do
+  #     email = EmailNotification.new
+  #     email.account = @account
+  #     email.to = 'a@app47.com'
+  #     email.message = 'Now is the time for all men to come to the aid of their country'
+  #     email.subject = 'Testing'
+  #     assert email.save
+  #     assert email.send_notification
+  #     mail = Mail::TestMailer.deliveries.first
+  #     assert_equal 'yes', mail.header['X-Mailgun-Native-Send'].value, mail.header.inspect
+  #   end
+  #   should 'NOT have mailgun smtp header when mailgun not configured' do
+  #     config = SystemConfiguration.configuration
+  #     config.mailgun_api_key = nil
+  #     assert config.save
+  #     email = EmailNotification.new
+  #     email.account = @account
+  #     email.to = 'a@app47.com'
+  #     email.message = 'Now is the time for all men to come to the aid of their country'
+  #     email.subject = 'Testing'
+  #     assert email.save
+  #     assert email.send_notification
+  #     mail = Mail::TestMailer.deliveries.first
+  #     assert_nil mail.header['X-Mailgun-Native-Send'], mail.header.inspect
+  #   end
+  # end
+
+  context 'Create an account notification with an array of addresses' do
+    setup {
+      email = EmailNotification.new
+      email.account = @account
+      email.to = ['a@app47.com', 'b@app47.com', 'c@app47.com']
+      email.message = 'Now is the time for all men to come to the aid of their country'
+      email.subject = 'Testing'
+      assert email.save
+      assert email.send_notification
+    }
+    should 'send three emails' do
+      mails = Mail::TestMailer.deliveries
+      email = mails.first
+      assert email.to.include?('a@app47.com'), email.to.inspect
+      assert email.to.include?('b@app47.com'), email.to.inspect
+      assert email.to.include?('c@app47.com'), email.to.inspect
+    end
+  end
+
+  # context 'Create account notification with smtp configuration' do
+  #   setup {
+  #     smtp = @account.fetch_or_build_smtp_configuration
+  #     smtp.email_address = "blue@red.com"
+  #     smtp.active = true
+  #     smtp.username = 'purple'
+  #     smtp.server_name = 'lost.in.space'
+  #     assert smtp.save!
+  #     # Need to set the confirmation manually as it's reset every time the smtp
+  #     # config is saved
+  #     smtp.set(confirmed: true)
+  #
+  #     email = EmailNotification.new
+  #     email.account = @account
+  #     email.to = 'a@app47.com'
+  #     email.message = 'Now is the time for all men to come to the aid of their country'
+  #     email.subject = 'Testing'
+  #     assert email.save
+  #     Mail::TestMailer.deliveries.clear
+  #     assert email.deliver
+  #   }
+  #   should 'Have one email notification that is successfully sent' do
+  #     mails = Mail::TestMailer.deliveries
+  #     assert_equal 1, mails.count, "Should only send one email"
+  #     mail = mails.first
+  #     assert_equal "purple", mail.sender, "Should send from smtp settings"
+  #   end
+  # end
+
+  # context 'Fail to send email via smtp ' do
+  #   setup {
+  #     # Kill the reporting of the error so it doesn't look like an error on the test run.
+  #     EmailNotification.any_instance.expects(:log_error).at_least_once
+  #     FactoryBot.create(:member_has_role_view, account: @account)
+  #     @admin = FactoryBot.create(:member_has_role_admin, account: @account)
+  #     @account.smtp_configuration = FactoryBot.build(:active_smtp_configuration)
+  #     assert @account.save
+  #     @account.fetch_or_build_smtp_configuration.set(confirmed: true)
+  #     EmailNotification.destroy_all
+  #     email = EmailNotification.new
+  #     email.account = @account
+  #     email.to = 'a@app47.com'
+  #     email.subject = 'Fail' # This matches the exception below in the monkey patch
+  #     email.message = "me"
+  #     assert email.save
+  #     assert email.deliver
+  #   }
+  #   should 'have an email to the admin that the notification failed' do
+  #     mails = Mail::TestMailer.deliveries
+  #     assert_equal 1, mails.count, "Email should be to admin though"
+  #     mail = mails.first
+  #     assert_equal @admin.email, mail.to.first, "Should send to the smtp admin"
+  #     assert_equal "Failed to send email notification", mail.subject
+  #
+  #     email = EmailNotification.excludes(account_id: nil).first
+  #     assert_not_nil email
+  #     assert email.state.eql? NotificationState::INVALID
+  #     email = EmailNotification.where(account_id: nil).first
+  #     assert_not_nil email
+  #     assert email.state.eql? NotificationState::PROCESSED
+  #   end
+  #
+  # end
+
+  context 'Set reply to and from addresses on email correctly' do
+    should 'No reply to and from based on system configuration' do
+      email = EmailNotification.new(account: @account)
+      email.to = 'a@app47.com'
+      email.from_template('notification_failure', test_values)
+      assert email.save
+      assert_nothing_raised { email.send_notification }
+
+      mails = Mail::TestMailer.deliveries
+      assert_equal 1, mails.count, "Should only send one email"
+      mail = mails.first
+
+      assert_equal SystemConfiguration.default_email, mail.from.first, "Should send from default mailer"
+      assert_nil mail.reply_to, "Reply to should be nil: #{mail.inspect}"
+    end
+
+    # should 'no reply to and from address from SMTP configuration' do
+    #   @account.smtp_configuration = FactoryBot.build(:active_smtp_configuration)
+    #   assert @account.save
+    #   @account.smtp_configuration.set(confirmed: true)
+    #   email = EmailNotification.new(account: @account)
+    #   email.to = 'a@app47.com'
+    #   email.from_template(AccountEmailTemplate::APP_STORE_USER_INVITE, test_values)
+    #   assert email.save
+    #   assert_nothing_raised { email.deliver }
+    #
+    #   mails = Mail::TestMailer.deliveries
+    #   assert_equal 1, mails.count, "Should only send one email"
+    #   mail = mails.first
+    #
+    #   assert_equal @account.smtp_configuration.email_address, mail.from.first, mail.inspect
+    #   assert_nil mail.reply_to, "Reply to should be nil: #{mail.inspect}"
+    # end
+    # should 'no reply to and from address from system configuration because smtp is not confirmed' do
+    #   @account.smtp_configuration = FactoryBot.build(:active_smtp_configuration)
+    #   assert @account.save
+    #   email = EmailNotification.new(account: @account)
+    #   email.to = 'a@app47.com'
+    #   email.from_template(AccountEmailTemplate::APP_STORE_USER_INVITE, test_values)
+    #   assert email.save
+    #   assert_nothing_raised { email.deliver }
+    #
+    #   mails = Mail::TestMailer.deliveries
+    #   assert_equal 1, mails.count, "Should only send one email"
+    #   mail = mails.first
+    #
+    #   assert_equal SystemConfiguration.default_email, mail.from.first, mail.inspect
+    #   assert_nil mail.reply_to, "Reply to should be nil: #{mail.inspect}"
+    # end
+
+  end
+
+  def test_values
+    {
+      'app_store_name' => 'Test app store name',
+      'device_description' => 'Tom\'s iPad',
+      'device_unique_identifier' => 'abc123def132afd1213afas',
+      'device_model' => 'iPad 3',
+      'app_name' => 'Test app name',
+      'build_version' => '1.3',
+      'profile_expiration_date' => 'July 31, 1968 20:45Z',
+      'profile_name' => 'Test Ad Hoc Distro',
+      'builds_url' => "#{SystemConfiguration.base_url}/builds",
+      'show_branding' => true,
+      'release_notes' => 'Fixed app bugs, software is perfect now!!',
+      'invitation_message' => 'You are invited, join the fun!!',
+      'registration_url' => "#{SystemConfiguration.base_url}/register",
+      'invitation_url' => "#{SystemConfiguration.base_url}/invitation",
+      'reset_password_url' => "#{SystemConfiguration.base_url}/reset_password",
+      'require_authentication' => false,
+      'passphrase' => 'letmein123',
+      'passphrase_expiration' => '48 hours',
+      'user_name' => 'Test User',
+      'user_email' => 'test@abc.com',
+      'app_names' => ['app1', 'app2', 'app3'],
+      'user_url' => "#{SystemConfiguration.base_url}/users?search=test@abc.com"
+    }
+  end
+
+  # context 'email attachments' do
+  #   should 'not have any attachments' do
+  #     email = EmailNotification.new(account: @account)
+  #     email.to = 'a@app47.com'
+  #     email.from_template('notification_failure', test_values)
+  #     assert email.save
+  #     assert_nothing_raised { email.send_notification }
+  #
+  #     assert_emails_attachment_count @account, 0
+  #
+  #     mails = Mail::TestMailer.deliveries
+  #     assert_equal 1, mails.count, 'Should only send one email'
+  #     mail = mails.first
+  #     assert_empty mail.attachments
+  #   end
+  #
+  #   should 'send one attachment' do
+  #     email = EmailNotification.new(account: @account)
+  #     email.to = 'a@app47.com'
+  #     email.from_template('notification_failure', test_values)
+  #     email.add_file 'test/etc/images/featured.jpg'
+  #     assert email.save
+  #     assert_nothing_raised { email.send_notification }
+  #
+  #     assert_not_nil email.reload
+  #     assert_equal Notification::STATE_PROCESSED, email.state
+  #
+  #     assert_emails_attachment_count @account
+  #
+  #     mails = Mail::TestMailer.deliveries
+  #     assert_equal 1, mails.count, 'Should only send one email'
+  #     mail = mails.first
+  #     assert_equal 1, mail.attachments.count
+  #   end
+  #   should 'send two attachment' do
+  #     email = EmailNotification.new(account: @account)
+  #     email.to = 'a@app47.com'
+  #     email.from_template('notification_failure', test_values)
+  #     email.add_file 'test/etc/images/featured.jpg'
+  #     email.add_file 'test/etc/images/featured.jpg'
+  #     assert email.save
+  #     assert_nothing_raised { email.send_notification }
+  #
+  #     assert_not_nil email.reload
+  #     assert_equal Notification::STATE_PROCESSED, email.state
+  #
+  #     assert_emails_attachment_count @account, 2
+  #
+  #     mails = Mail::TestMailer.deliveries
+  #     assert_equal 1, mails.count, 'Should only send one email'
+  #     mail = mails.first
+  #     assert_equal 2, mail.attachments.count
+  #   end
+  # end
+
+end
+
+# Override this method to thrown an exception if the subject is 'Fail'
+module Mail
+  class TestMailer
+
+    def deliver!(mail)
+      throw Exception('Fail') if mail.subject.eql? 'Fail'
+      # check_delivery_params(mail)
+      Mail::TestMailer.deliveries << mail
+    end
+
+  end
+end