Pre-Handoff fixes

[adamdill]

Items we need to address before handing off

Project Settings, etc.

• project wide - remove blocks of code that is commented out (like blocks of lines starting with # in gemfile and in db seeds)
• project wide - bump ruby to 2.6.3
• project wide - bump rails to 6.0.0rc2
• yarn - update yarn dependencies, there are some security issues according to github
• gemfile - update gems to current version
• gemfile - alphabetize gemfile by section
• administrate - lets see if the current thoughtbot version will work, if not let's writeup why we are on a fork
• rubocop - check why ' vs " isn't getting flagged and failing builds
• project wide - let's check that we are using single and double quotes properly. unless we are doing some type of parsing then we should always use single quotes. I know gemfile and routes have this problem, but we should check everywhere.
• get master branch up to date and ready for next review
• get lograge working (one line logs, etc), this may just need merging

Documentation

• readme - should talk through how to setup dev environment
• readme - link to example project and ruby gem
• readme - put in basic overview of the application up top on line 3
• readme - migrate all the troubleshooting file into the readme, and ensure it's accurate. cut sections that are no longer needed. Any thing that shouldn't be in readme move to docs/troubleshooting.md
• readme - link to docs folder
• docs - update system architecture file to be accurate and link in readme
• docs - clean up docs folder and make sure it is accurate
• .generators - what's with this file? can we remove it? maybe it should be added to gitignore
• readme - lets look at generating a diagram of the database structure, putting it in the docs folder, and embedding it into the readme. Look at https://github.com/voormedia/rails-erd and https://github.com/preston/railroady or rubymine to see if they can make this easy
• readme/seeds - including bearer token is great in the readme, let's also add a curl request to verify the API works that a dev can copy/paste
• documentation - highlands_client/clients/base_client.rb - put a brief bit of docs up top so future devs know what this file is and how it works
• documentation - clearstream base_client throw a few liens of text at the top in a comment describing what this file does
• documentation - add docs to HighlandsClient
• documentation - in Lib folder docs check that the bigger files all have some brief docs

Code Changes

• database.yml - remove production section and comment in the supplied databaseurl one
• HighlandsClient - don't disable rubocop
• Convert Sidekiq workers to Jobs with ActiveJob (note: you can still use sidekiq)
• look for FIXMEs and fix those
• remove slim and convert the one slim page (homepage) to erb (or convert everything to slim)
• views - does admin do anything? don't think we need site admin and admin
• remove any API views we don't need (like some of the jbuilder views for lists)
• update js packages so we don't get security warnings on github

Things to check in the next revision

• check app
• check ruby gem
• check spec
• check example project
• setup procedure - follow steps in readme to ensure project is running, properly seeded, and that we can run a curl command to verify the API is working
• filter_parameter_logging - is there anything else we should be checking?
• uhura/lib/highlands_client/clients/message_client.rb - check refactor
• why is public_token required in message body?
• validations in uhura client?
• triplicate Subject (email_options: email_options_hash <= capture outgoing HTTP request)
• implement From Email Address and From Name in uhura_example_app