web47core 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fcbe8a6af006b83e043ed3a844a0204f2b48f1373c2403a3fbd823b20cadd8a
-  data.tar.gz: 65d2aebcd8a3b59742f7d01ccbe6aeebb612df2d187f1eb9e07ae475c9027d33
+  metadata.gz: 2e82f9597abea49e585537bf7b37dd78220136b34e2f2bc0ade5592e4d70ae9d
+  data.tar.gz: 523f737ac0beae20e3203ba4188c66e4cf5c09b8749084bf67dfd07fb039a3e7
 SHA512:
-  metadata.gz: e92b025b5e9d068db7a50c12af80081f131e71c5291853f6150ad0ed0ec0e9e4d1f4f172b197aa071068256a8226aaac42967377141dc3a8f571915102eff1a4
-  data.tar.gz: 0c21a7924482f948f40511c4575971d81387a84c88f214e8df039ffe1c0aa7980e8a025fc8efb0587e470a9ca5186362b9f400cad668b0c252d3ee950c1d59ea
+  metadata.gz: e4a973a0840c34dc033b5f512e9e5bb62618afa44f20fc5b9e6993a59ef0cbde59befc204becd175dd15db7f02f4952f516af9d77dfb9cbb8fd70fd17991fc32
+  data.tar.gz: 6b2dff4fb23a286a60a0cccc2cd618d17b38379148aad5d385463df8a81ce55542ec9cde451516a52c6dfaf68204f585682849d546c6989800c4006fac95c091

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    web47core (0.0.7)
+    web47core (0.0.8)
       activesupport (~> 5.0)
       aws-sdk-ec2 (>= 1.60, <= 1.151)
       delayed_job_mongoid (~> 2.3)

data/README.md

@@ -37,4 +37,47 @@ bundle exec rake test
 # 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`
+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
+
+# 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)
+```
+gem 'web47core'
+```
+
+If you need the gem immediately or need to pull from development branch, you can use the git repo
+```
+gem 'web47core', git: 'git@github.com:App47/web47core.git', branch: :master
+```
+or from the develop branch
+```
+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
+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
+#### System Configuration
+Define a `SystemConfiguration` class in your project and import the core concern.
+
+```
+class SystemConfiguration
+  include StandardModel
+  include CoreSystemConfiguration
+  
+  # Include your additional system configuration fields and methods
+  field :google_sso_client_id, type: String
+end
+```
+

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

@@ -64,6 +64,9 @@ module CoreSystemConfiguration
       # Validations
       #
       validates :environment, presence: true, uniqueness: true
+      validates :slack_support_channel, presence: true
+      validates :slack_sales_channel, presence: true
+      validates :default_time_zone, presence: true
     end
     base.extend ClassMethods
   end
@@ -116,12 +119,17 @@ module CoreSystemConfiguration
     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)
+  def secure_fields
+    super + %i[smtp_password
+               aws_access_secret
+               mailgun_api_key
+               switchboard_stack_api_token
+               twilio_auth_token
+               zendesk_token]
   end
 
   #
@@ -247,6 +255,18 @@ module CoreSystemConfiguration
     [twilio_account_id.present?, twilio_auth_token.present?, twilio_phone_number.present?].all?
   end
 
+  #
+  # Determine if Slack is configured
+  #
+  # Examples
+  #
+  #   switchboard_configured?
+  #   # => true || false
+  #
+  def slack_configured?
+    slack_api_url.present?
+  end
+
   private
 
   #

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+#
+# For models that are updated via forms, we need an easy and consistent way to
+# return a list of allowed parameters for a given model. While doing Model.attribute_names
+# is working for most forms, it DOES NOT deal with relationships at all.
+#
+# This mix is should be included in those models, and the model then calls
+# Model.allowed_param_names to retrieve a complete (dynamic) list of
+#   * Attribute names
+#   * Many to many relationships (has_many_and_belongs_to)
+#   * One to many relationships (belongs to)
+#
+module Formable
+  extend ActiveSupport::Concern
+  #
+  # Include the class methods into the model
+  #
+  def self.included(base)
+    base.class_eval do
+      base.extend ClassMethods
+    end
+  end
+
+  #
+  # Public: Add to class methods
+  #
+  module ClassMethods
+    #
+    # 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
+end

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

@@ -13,8 +13,29 @@ module StandardModel
       include Mongoid::Timestamps
       # include App47Logger
       # include Auditable
-      # include Formable
+      include Formable
       include AutoClearCache
     end
   end
+
+  #
+  # Mixin to add methods to the classes themselves
+  # Used by calling model.method_name
+  #
+  module ClassMethods
+    # Used by calling 'model.without_callback(*.args, &block) do'
+    def without_callback(*args, &_block)
+      skip_callback(*args)
+      result = yield
+      set_callback(*args)
+      result
+    end
+
+    #
+    # Turn the array into a list of options
+    #
+    def make_options(options)
+      options.collect { |t| [t, t.humanize] }
+    end
+  end
 end

data/lib/web47core.rb

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

data/test/models/concerns/formable_test.rb

@@ -0,0 +1,74 @@
+require 'test_helper'
+
+# TODO: CMS add tests for clearing by account id as well as id
+class FormableTest < ActiveSupport::TestCase
+
+  context 'allowed_params' do
+    should 'return test form fields' do
+      allowed = TestForm.allowed_param_names
+      assert_equal 2, allowed.count
+      assert allowed.include?('name'), allowed.inspect
+      assert allowed.include?('password'), allowed.inspect
+    end
+    should 'return test input fields' do
+      allowed = TestInput.allowed_param_names
+      assert_equal 2, allowed.count
+      assert allowed.include?('input_type'), allowed.inspect
+      assert allowed.include?('test_form_id'), allowed.inspect
+    end
+  end
+  context 'update the model safely' do
+    setup do
+      @model = TestForm.create! name: 'name', password: 'abc123'
+    end
+    should 'update password' do
+      assert @model.update name: 'foo', password: 'bar'
+      assert_equal 'foo', @model.name
+      assert_equal 'bar', @model.password
+    end
+    should 'update not blank password' do
+      assert @model.update name: 'foo', password: ''
+      assert_equal 'foo', @model.name
+      assert_equal 'abc123', @model.password
+    end
+    should 'update not nil password' do
+      assert @model.update name: 'foo', password: nil
+      assert_equal 'foo', @model.name
+      assert_equal 'abc123', @model.password
+    end
+    should 'update! not blank password' do
+      assert @model.update! name: 'foo', password: ''
+      assert_equal 'foo', @model.name
+      assert_equal 'abc123', @model.password
+    end
+    should 'update_attributes! not blank password' do
+      assert @model.update_attributes! name: 'foo', password: ''
+      assert_equal 'foo', @model.name
+      assert_equal 'abc123', @model.password
+    end
+    should 'update_attributes not blank password' do
+      assert @model.update_attributes name: 'foo', password: ''
+      assert_equal 'foo', @model.name
+      assert_equal 'abc123', @model.password
+    end
+  end
+end
+
+class TestForm
+  include Mongoid::Document
+  include Formable
+  field :name
+  field :password
+  has_many :test_inputs
+
+  def secure_fields
+    super + %i[password]
+  end
+end
+
+class TestInput
+  include Mongoid::Document
+  include Formable
+  field :input_type
+  belongs_to :test_form
+end

data/web47core.gemspec

@@ -8,7 +8,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 Gem::Specification.new do |spec|
   spec.required_ruby_version = '~> 2.4.1'
   spec.name          = 'web47core'
-  spec.version       = '0.0.7'
+  spec.version       = '0.0.8'
   spec.authors       = ['Chris Schroeder']
   spec.email         = ['chris@app47.com']
   spec.summary       = 'App47 Web Core Library.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: web47core
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Chris Schroeder
@@ -402,11 +402,13 @@ files:
 - lib/app/models/concerns/auto_clear_cache.rb
 - lib/app/models/concerns/cdn_url.rb
 - lib/app/models/concerns/core_system_configuration.rb
+- lib/app/models/concerns/formable.rb
 - lib/app/models/concerns/standard_model.rb
 - lib/web47core.rb
 - test/fixtures/mongoid.yml
 - test/models/concerns/auto_clear_cache_test.rb
 - test/models/concerns/cdn_url_test.rb
+- test/models/concerns/formable_test.rb
 - test/models/concerns/system_configuration_test.rb
 - test/rails_setup.rb
 - test/shoulda_macros/mongoid.rb
@@ -439,6 +441,7 @@ test_files:
 - test/fixtures/mongoid.yml
 - test/models/concerns/auto_clear_cache_test.rb
 - test/models/concerns/cdn_url_test.rb
+- test/models/concerns/formable_test.rb
 - test/models/concerns/system_configuration_test.rb
 - test/rails_setup.rb
 - test/shoulda_macros/mongoid.rb