web47core 0.0.2 → 0.0.7

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

@@ -0,0 +1,258 @@
+# 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 CoreSystemConfiguration
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      #
+      # Fields
+      #
+      field :environment, type: String, default: 'test'
+      # SMTP configuration
+      field :default_email, type: String, default: 'support@app47.com'
+      field :support_email, type: String, default: 'support@app47.com'
+      field :smtp_name, type: String
+      field :smtp_address, type: String
+      field :smtp_domain, type: String
+      field :smtp_port, type: Integer, default: 587
+      field :smtp_user_name, type: String
+      field :smtp_password, type: String
+      field :smtp_enable_starttls_auto, type: Boolean
+      field :mailgun_api_key, type: String
+      # Twillio support
+      field :twilio_account_id, type: String
+      field :twilio_auth_token, type: String
+      field :twilio_phone_number, type: String
+      # URLs
+      field :base_url, type: String
+      field :cdn_url, type: String
+      # Slack support
+      field :slack_api_url, type: String
+      field :slack_support_channel, type: String, default: 'support'
+      field :slack_sales_channel, type: String, default: 'sales'
+      # Time Zone Support
+      field :default_time_zone, type: String, default: 'US/Eastern'
+      # AWS
+      field :aws_region, type: String
+      field :aws_access_key, type: String
+      field :aws_access_secret, type: String
+      field :aws_auto_scaling_group_name, type: String
+      # Zendesk
+      field :zendesk_token, type: String
+      field :zendesk_base_url, type: String, default: 'https://app47.zendesk.com'
+      field :zendesk_documentation_path, type: String, default: 'hc'
+      field :zendesk_support_path, type: String, default: 'hc/en-us/requests'
+      field :zendesk_updates_path, type: String, default: 'hc'
+      # Switchboard
+      field :switchboard_base_url, type: String, default: 'https://switchboard.app47.com'
+      field :switchboard_stack_id, type: String
+      field :switchboard_stack_api_token, type: String
+      #
+      # Validations
+      #
+      validates :environment, presence: true, uniqueness: true
+    end
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    #
+    # Fetch the system configuration based on environment name. First try the rails cache
+    # if not there, then go to the database.
+    #
+    # Also, if an argument error is thrown, then just fetch from the database.
+    #
+    def configuration
+      cache_key = "SystemConfiguration::#{Rails.env}"
+
+      begin
+        config = Rails.cache.fetch(cache_key, expires_in: 90.seconds) do
+          SystemConfiguration.find_by(environment: Rails.env)
+        end
+      rescue StandardError
+        # This seems to happen in testing relative to Country, when it does, remove
+        # ourselves from the cache and return the DB entry.
+        Rails.cache.delete cache_key
+        config = SystemConfiguration.find_or_create_by!(environment: Rails.env)
+      end
+
+      config.nil? ? SystemConfiguration.create(environment: Rails.env) : config
+    end
+
+    def smtp_configuration
+      output = {}
+      config = configuration
+      fields = %w[name address domain port user_name password enable_starttls_auto]
+      fields.each do |field|
+        field_name = "smtp_#{field}".to_sym
+        output[field.to_sym] = config.send(field_name)
+      end
+      output
+    end
+
+    #
+    # NOTE: Currently ignored Codacy issue: When using 'method_missing', fall back on 'super'
+    #
+    # rubocop:disable Style/MethodMissingSuper
+    def method_missing(method, *args, &block)
+      configuration.send method, *args
+    end
+
+    def respond_to?(method_name, _include_private = false)
+      SystemConfiguration.fields.include?(method_name)
+    end
+    # rubocop:enable Style/MethodMissingSuper
+  end
+  #
+  # Make sure the password doesn't get blanked out on an update
+  #
+  def update_attributes(params)
+    %i[smtp_password aws_access_secret].each { |field| params[field] = send(field) if params[field].blank? }
+    super(params)
+  end
+
+  #
+  # Determine if SMTP is configured
+  #
+  def smtp_configured?
+    smtp_name.present? && smtp_address.present? && smtp_domain.present?
+  end
+
+  #
+  # Determine if mailgun is configured
+  #
+  def mailgun_configured?
+    smtp_configured? && mailgun_api_key.present?
+  end
+
+  #
+  # Determine if AWS is configured
+  #
+  def aws_configured?
+    [aws_region.present?, aws_access_key.present?, aws_access_secret.present?].all?
+  end
+
+  #
+  # Determine if auto scaling group is configured
+  #
+  def aws_auto_scaling_configured?
+    aws_configured? && aws_auto_scaling_group_name.present?
+  end
+
+  #
+  # AWS client.
+  #
+  def aws_ec2_client
+    return nil unless aws_configured?
+
+    Aws::EC2::Client.new region: aws_region,
+                         credentials: Aws::Credentials.new(aws_access_key, aws_access_secret)
+  end
+
+  #
+  # Return the zendesk documentation URL
+  #
+  def zendesk_documentation_url(user = nil)
+    zendesk_url(forward_to: zendesk_documentation_path, user: user)
+  end
+
+  #
+  # Return the zendesk support URL
+  #
+  def zendesk_requests_url(user = nil)
+    zendesk_url(forward_to: zendesk_support_path, user: user)
+  end
+
+  #
+  # Return the zendesk support URL
+  #
+  def zendesk_new_request_url(user = nil)
+    zendesk_url(forward_to: "#{zendesk_support_path}/new", user: user)
+  end
+
+  #
+  # Return the zendesk update URL
+  #
+  def zendesk_updates_url(user = nil)
+    zendesk_url(forward_to: zendesk_updates_path, user: user)
+  end
+
+  #
+  # Generate a Zendesk URL
+  #
+  # If a user is passed in and Zendesk is configured then return a JWT enabled URL for
+  # SSO authentication to Zendesk.
+  #
+  def zendesk_url(forward_to: zendesk_documentation_path, user: nil)
+    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)}"
+             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,
+                                           email: user.email }, config.zendesk_token),
+                         return_to: CGI.escape([config.zendesk_base_url, forward_to].join('/')) }
+             ['access/jwt', payload.to_query].join('?')
+           else
+             forward_to
+           end
+    [config.zendesk_base_url, path].join('/')
+  end
+
+  #
+  # Is zendesk configured?
+  #
+  def zendesk_configured?
+    [zendesk_token.present?,
+     zendesk_base_url.present?,
+     zendesk_documentation_path.present?,
+     zendesk_support_path.present?].all?
+  end
+
+  #
+  # Public: Determine if switchboard is configured
+  #
+  # Examples
+  #
+  #   switchboard_configured?
+  #   # => true || false
+  #
+  def switchboard_configured?
+    [switchboard_base_url.present?, switchboard_stack_api_token.present?, switchboard_stack_id.present?].all?
+  end
+
+  #
+  # Determine if twillio is configured at a system configuration
+  #
+  # Examples
+  #
+  #   switchboard_configured?
+  #   # => true || false
+  #
+  def twilio_configured?
+    [twilio_account_id.present?, twilio_auth_token.present?, twilio_phone_number.present?].all?
+  end
+
+  private
+
+  #
+  # Clear the cache when the object is saved
+  #
+  def clear_cache
+    Rails.cache.delete "SystemConfiguration::#{Rails.env}"
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+#
+# Mixin to standardize the setup of all models, i.e., the standard or base model
+# definitions they should all have
+#
+module StandardModel
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      include Mongoid::Document
+      include Mongoid::Timestamps
+      # include App47Logger
+      # include Auditable
+      # include Formable
+      include AutoClearCache
+    end
+  end
+end

data/lib/web47core.rb

@@ -1 +1,4 @@
-require 'app/models/concerns/auto_clear_cache'
+require 'app/models/concerns/auto_clear_cache'
+require 'app/models/concerns/cdn_url'
+require 'app/models/concerns/standard_model'
+require 'app/models/concerns/core_system_configuration'

data/test/models/concerns/auto_clear_cache_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+# TODO: CMS add tests for clearing by account id as well as id
+class AutoClearCacheTest < ActiveSupport::TestCase
+  setup do
+    @model = TestAutoClearCache.new
+    assert @model.save
+    @model.update_cache
+  end
+
+  context 'Remove cache on save' do
+    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 TestAutoClearCache
+  include Mongoid::Document
+  include AutoClearCache
+
+  def update_cache(value = 'abc123')
+    Rails.cache.write id.to_s, value, expires_in: 60
+  end
+end

data/test/models/concerns/cdn_url_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+class CdnUrlTest < ActiveSupport::TestCase
+
+  setup do
+    @original_url = 'https://s3.amazon.com/test_bucket/test_cdn_url_models/id/original.png'
+    @model = TestCdnUrlModel.new
+    @model.file_url = @original_url
+    assert @model.save
+  end
+
+  context 'CDN not setup' do
+
+    should 'not respond to errant entry' do
+      assert_raises(NoMethodError) { @model.cdn_bad_url }
+    end
+
+    should 'return the original url' do
+      assert_equal @original_url, @model.file_url
+      assert_equal @original_url, @model.cdn_file_url
+    end
+  end
+
+  context 'CDN setup' do
+    setup do
+      @cdn_url = 'https://9asdfasd9asd.amazon.com'
+      config = SystemConfiguration.configuration
+      assert config.update cdn_url: @cdn_url
+    end
+    should 'return CDN url' do
+      assert_equal @original_url, @model.file_url
+      assert_not_equal @original_url, @model.cdn_file_url
+      assert_equal "#{@cdn_url}/test_cdn_url_models/id/original.png", @model.cdn_file_url
+    end
+    should 'return CDN url with size' do
+      assert_equal "#{@original_url}?size=medium", @model.image_url('medium')
+      assert_equal "#{@cdn_url}/test_cdn_url_models/id/original.png?size=medium", @model.cdn_image_url('medium')
+    end
+    should 'return url' do
+      assert @model.update file_url: 'https://s3.amazon.com/test_bucket/another_model/id/original.png'
+      assert_equal 'https://s3.amazon.com/test_bucket/another_model/id/original.png', @model.cdn_file_url
+    end
+  end
+end
+
+class TestCdnUrlModel
+  include Mongoid::Document
+  include CdnUrl
+  field :file_url, type: String
+
+  def image_url(size)
+    "#{file_url}?size=#{size}"
+  end
+end

data/test/models/concerns/system_configuration_test.rb

@@ -0,0 +1,223 @@
+require 'test_helper'
+
+#
+# Test the system configuration model object
+#
+class SystemConfigurationTest < ActiveSupport::TestCase
+  should_have_field :environment, type: String, klass: SystemConfiguration, default: 'test'
+  should_have_field :default_email, type: String, klass: SystemConfiguration, default: 'support@app47.com'
+  should_have_field :support_email, type: String, klass: SystemConfiguration, default: 'support@app47.com'
+  should_have_field :smtp_name, type: String, klass: SystemConfiguration
+  should_have_field :smtp_address, type: String, klass: SystemConfiguration
+  should_have_field :smtp_domain, type: String, klass: SystemConfiguration
+  should_have_field :smtp_port, type: Integer, klass: SystemConfiguration, default: 587
+  should_have_field :smtp_user_name, type: String, klass: SystemConfiguration
+  should_have_field :smtp_password, type: String, klass: SystemConfiguration
+  should_have_field :smtp_enable_starttls_auto, type: Mongoid::Boolean, klass: SystemConfiguration
+  should_have_field :mailgun_api_key, type: String, klass: SystemConfiguration
+  should_have_field :base_url, type: String, klass: SystemConfiguration
+  should_have_field :cdn_url, type: String, klass: SystemConfiguration
+  # Slack
+  should_have_field :slack_api_url, type: String, klass: SystemConfiguration
+  should_have_field :slack_support_channel, type: String, klass: SystemConfiguration, default: 'support'
+  should_have_field :slack_sales_channel, type: String, klass: SystemConfiguration, default: 'sales'
+  # Twillo
+  should_have_field :twilio_account_id, type: String, klass: SystemConfiguration
+  should_have_field :twilio_auth_token, type: String, klass: SystemConfiguration
+  should_have_field :twilio_phone_number, type: String, klass: SystemConfiguration
+  # Zendesk
+  should_have_field :zendesk_token, type: String, klass: SystemConfiguration
+  should_have_field :zendesk_base_url, type: String, default: 'https://app47.zendesk.com', klass: SystemConfiguration
+  should_have_field :zendesk_documentation_path, type: String, default: 'hc', klass: SystemConfiguration
+  should_have_field :zendesk_support_path, type: String, default: 'hc/en-us/requests', klass: SystemConfiguration
+  should_have_field :zendesk_updates_path, type: String, klass: SystemConfiguration, default: 'hc'
+  # AWS
+  should_have_field :aws_region, type: String, klass: SystemConfiguration
+  should_have_field :aws_access_key, type: String, klass: SystemConfiguration
+  should_have_field :aws_access_secret, type: String, klass: SystemConfiguration
+  should_have_field :aws_auto_scaling_group_name, type: String, klass: SystemConfiguration
+  # Switchboard
+  should_have_field :switchboard_base_url, type: String, klass: SystemConfiguration, default: 'https://switchboard.app47.com'
+  should_have_field :switchboard_stack_id, type: String, klass: SystemConfiguration
+  should_have_field :switchboard_stack_api_token, type: String, klass: SystemConfiguration
+
+  teardown do
+    Rails.cache.delete 'SystemConfiguration::test'
+  end
+
+  context 'default behavior' do
+    should 'automatically create a system configuration' do
+      SystemConfiguration.destroy_all
+      assert_equal 0, SystemConfiguration.all.count
+      SystemConfiguration.configuration
+      assert_equal 1, SystemConfiguration.all.count
+    end
+    should 'have default values' do
+      assert_equal 587, SystemConfiguration.smtp_port
+    end
+  end
+
+  context 'handle exception' do
+    should 'deal with rails catch throwing an exception' do
+      Rails.cache.expects(:fetch).once.raises(ArgumentError)
+      Rails.cache.expects(:delete).twice
+      SystemConfiguration.expects(:create).never
+      SystemConfiguration.base_url
+      Rails.cache.unstub(:fetch)
+      Rails.cache.unstub(:delete)
+    end
+  end
+
+  context 'handle' do
+    should 'respond_to_missing?' do
+      assert SystemConfiguration.respond_to? 'base_url'
+      refute SystemConfiguration.respond_to? 'url'
+    end
+  end
+
+  context 'only call things once' do
+    setup do
+      if SystemConfiguration.all.blank?
+        SystemConfiguration.create!(base_url: 'http://somewhere.com',
+                                    environment: Rails.env,
+                                    smtp_name: 'SMTP')
+      end
+      SystemConfiguration.expects(:where).once.returns(SystemConfiguration.all)
+    end
+    should 'only call once' do
+      SystemConfiguration.base_url
+      SystemConfiguration.smtp_port
+      SystemConfiguration.smtp_name
+    end
+    should 'update base_url' do
+      url = 'http://something.new'
+      config = SystemConfiguration.all.first || SystemConfiguration.new
+      config.update_attributes!(base_url: url)
+      assert_equal url, SystemConfiguration.base_url
+    end
+  end
+
+  context 'smtp configuration' do
+    should 'have smtp config' do
+      smtp_config = SystemConfiguration.smtp_configuration
+      assert_not_nil smtp_config
+      assert_not_empty smtp_config
+    end
+    should 'not be configured' do
+      refute SystemConfiguration.smtp_configured?
+      refute SystemConfiguration.mailgun_configured?
+    end
+    should 'be configured' do
+      assert SystemConfiguration.configuration.update smtp_name: 'app47', smtp_address: 'app47.com', smtp_domain: 'app47.com'
+      assert SystemConfiguration.smtp_configured?
+      refute SystemConfiguration.mailgun_configured?
+    end
+    should 'be configured with mailgun' do
+      assert SystemConfiguration.configuration.update smtp_name: 'app47', smtp_address: 'app47.com', smtp_domain: 'app47.com', mailgun_api_key: 'abc123'
+      assert SystemConfiguration.smtp_configured?
+      assert SystemConfiguration.mailgun_configured?
+    end
+  end
+
+  context 'aws configuration' do
+    should 'not be configured' do
+      refute SystemConfiguration.aws_configured?
+      refute SystemConfiguration.aws_auto_scaling_configured?
+    end
+    should 'aws is configured' do
+      assert SystemConfiguration.configuration.update aws_region: 'us'
+      refute SystemConfiguration.aws_configured?
+      refute SystemConfiguration.aws_auto_scaling_configured?
+      assert SystemConfiguration.configuration.update aws_access_key: 'key'
+      refute SystemConfiguration.aws_configured?
+      refute SystemConfiguration.aws_auto_scaling_configured?
+      assert SystemConfiguration.configuration.update aws_access_secret: 'abc123'
+      assert SystemConfiguration.aws_configured?
+      refute SystemConfiguration.aws_auto_scaling_configured?
+      assert SystemConfiguration.configuration.update aws_auto_scaling_group_name: 'g1'
+      assert SystemConfiguration.aws_configured?
+      assert SystemConfiguration.aws_auto_scaling_configured?
+    end
+    should 'not retrieve client' do
+      assert_nil SystemConfiguration.aws_ec2_client
+    end
+    should 'retrieve client' do
+      assert SystemConfiguration.configuration.update aws_region: 'us',
+                                                      aws_access_key: 'key',
+                                                      aws_access_secret: 'key'
+      client = SystemConfiguration.aws_ec2_client
+      assert_not_nil client
+      assert client.is_a?(Aws::EC2::Client)
+    end
+  end
+
+  context 'twilio configuration' do
+    should 'not be configured' do
+      refute SystemConfiguration.twilio_configured?
+    end
+    should 'configured' do
+      assert SystemConfiguration.configuration.update twilio_account_id: 'us'
+      refute SystemConfiguration.twilio_configured?
+      assert SystemConfiguration.configuration.update twilio_auth_token: 'key'
+      refute SystemConfiguration.twilio_configured?
+      assert SystemConfiguration.configuration.update twilio_phone_number: 'abc123'
+      assert SystemConfiguration.twilio_configured?
+    end
+  end
+
+  context 'switchboard configuration' do
+    should 'not be configured' do
+      refute SystemConfiguration.switchboard_configured?
+    end
+    should 'configured' do
+      assert SystemConfiguration.configuration.update switchboard_base_url: 'us'
+      refute SystemConfiguration.switchboard_configured?
+      assert SystemConfiguration.configuration.update switchboard_stack_api_token: 'key'
+      refute SystemConfiguration.switchboard_configured?
+      assert SystemConfiguration.configuration.update switchboard_stack_id: 'abc123'
+      assert SystemConfiguration.switchboard_configured?
+    end
+  end
+
+  context 'zendesk configuration' do
+    should 'not be configured' do
+      refute SystemConfiguration.zendesk_configured?
+    end
+    should 'configured' do
+      assert SystemConfiguration.configuration.update zendesk_token: 'us'
+      assert SystemConfiguration.zendesk_configured?
+    end
+    should 'zendesk url with no user' do
+      assert_equal 'https://app47.zendesk.com/hc', SystemConfiguration.zendesk_url
+      assert_equal 'https://app47.zendesk.com/hc', SystemConfiguration.zendesk_documentation_url
+      assert_equal 'https://app47.zendesk.com/hc/en-us/requests', SystemConfiguration.zendesk_requests_url
+      assert_equal 'https://app47.zendesk.com/hc/en-us/requests/new', SystemConfiguration.zendesk_new_request_url
+      assert_equal 'https://app47.zendesk.com/hc', SystemConfiguration.zendesk_updates_url
+    end
+    should 'zendesk url with user but not configured' do
+      user = MockUser.new email: 'foo@bar.com'
+      assert_equal 'https://app47.zendesk.com/hc', SystemConfiguration.zendesk_url(user: user)
+      assert_equal 'https://app47.zendesk.com/hc', SystemConfiguration.zendesk_documentation_url(user)
+      assert_equal 'https://app47.zendesk.com/hc/en-us/requests', SystemConfiguration.zendesk_requests_url(user)
+      assert_equal 'https://app47.zendesk.com/hc/en-us/requests/new', SystemConfiguration.zendesk_new_request_url(user)
+      assert_equal 'https://app47.zendesk.com/hc', SystemConfiguration.zendesk_updates_url(user)
+    end
+    should 'zendesk url with user and configured' do
+      assert SystemConfiguration.configuration.update zendesk_token: 'us'
+      user = MockUser.create(email: 'foo@bar.com', name: 'Foo')
+      assert_not_nil user
+      assert SystemConfiguration.zendesk_url(user: user).start_with?('https://app47.zendesk.com/access/jwt?jwt=')
+      assert SystemConfiguration.zendesk_documentation_url(user).start_with?('https://app47.zendesk.com/access/jwt?jwt=')
+      assert SystemConfiguration.zendesk_requests_url(user).start_with?('https://app47.zendesk.com/access/jwt?jwt=')
+      assert SystemConfiguration.zendesk_new_request_url(user).start_with?('https://app47.zendesk.com/access/jwt?jwt=')
+      assert SystemConfiguration.zendesk_updates_url(user).start_with?('https://app47.zendesk.com/access/jwt?jwt=')
+    end
+  end
+end
+
+class MockUser
+  include StandardModel
+  field :email, type: String
+  field :name, type: String
+end
+

data/test/rails_setup.rb

@@ -1,4 +1,3 @@
-ENV['RAILS_ENV'] = 'test'
 # require File.expand_path('../../config/environment', __FILE__)
 # Load the Rails application.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
@@ -28,6 +27,7 @@ end
 # you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)
 
+
 module WebCore
   class Application < Rails::Application
     # Settings in config/environments/* take precedence over those specified here.
@@ -36,7 +36,7 @@ module WebCore
     # Configure redis cache
     config.eager_load = false
     config.cache_store = :redis_store, 'redis://127.0.0.1:6379/11/cache'
-    config.autoload_paths += %W(#{config.root}/lib #{File.join(Rails.root, 'app', 'mixins')} #{File.join(Rails.root, 'app', 'classes')})
+    config.autoload_paths += %W(#{config.root}/lib)
     config.generators do |g|
       g.template_engine :haml
       g.orm :mongoid
@@ -46,9 +46,10 @@ module WebCore
     end
     config.active_job.queue_adapter = :delayed_job
 
-    config.exceptions_app = ->(env) { ExceptionsController.action(:show).call(env) }
     # Configure the default encoding used in templates for Ruby 1.9.
     config.encoding = 'utf-8'
+    config.logger = Logger.new(STDOUT)
+    config.logger.level = Logger::DEBUG
   end
 end