allaboardapps / happenings-server

Happenings Server

Documentation

• We use YARD for documentation
• To update docs, run yard doc
• To view docs locally, run yard server and visit http://localhost:8808

Annotations in the codebase

• Ref: http://guides.rubyonrails.org/command_line.html#notes
• View annotations in the command line with rails notes
• Notes in rb files need to be written as # TODO: This is a task
• Notes in js files need to be written as // TODO This is a task %>
• Notes in scss, css files need to be written as // TODO This is a task
• Notes in erb files need to be written as <% TODO This is a task %>
• You must have SOURCE_ANNOTATION_DIRECTORIES: "spec" specified in your environment variables for spec file annotations to be captured.

Heroku Versions

Staging

• ruby 2.4.1
• rails 5.0.2
• postgres 9.6.2
• elasticsearch 5.1.2

Production

• ruby 2.4.1
• rails 5.0.2
• postgres 9.6.2
• elasticsearch 5.1.2

Installation

rails new happenings-server --database=postgresql --skip-spring --skip-turbolinks --skip-test --skip-action-cable

Heroku Setup

• Deploys from Github master branch
• Utilizes CodeShip for CI
• git remote add staging https://git.heroku.com/happenings-server-staging.git
• git remote add production https://git.heroku.com/happenings-server-production.git

Security Checks

• run bundle outdated > update gems with bundle update > run tests
• run bundle-audit update
• run bundle-audit
• run brakeman
• run hakiri system:steps
• run hakiri manifest:generate > hakiri system:scan
• run hakiri gemfile:scan

Security References

• How Do Ruby/Rails Developers Keep Updated on Security Alerts?
• Ruby Security Mailing List
• Rails Security Mailing List
• CVE Details
• Hakiri service (fee-based)
• AppCanary service (fee-based)

Setup Heroku

First, you'll need to ask to be added as a collaborator to the Heroku projects for access.

Second, you'll need to connect your local git repo to the heroku repos:

• connect to staging: git remote add staging https://git.heroku.com/happenings-server-staging.git
• connect to production: git remote add production https://git.heroku.com/happenings-server-production.git
• review your remotes: git remote -v

You should see something like this:

origin  https://github.com/allaboardapps/happenings-server-server.git (fetch)
origin  https://github.com/allaboardapps/happenings-server-server.git (push)
production  https://git.heroku.com/happenings-server-production.git (fetch)
production  https://git.heroku.com/happenings-server-production.git (push)
staging https://git.heroku.com/happenings-server-staging.git (fetch)
staging https://git.heroku.com/happenings-server-staging.git (push)

Setup RVM

• Ref: https://gist.github.com/wrburgess/a6fc079cee6f14fc601b1
• Install with curl: \curl -sSL https://get.rvm.io | bash -s stable
• Source RVM: source /Users/[user]/.rvm/scripts/rvm
• As a routine process, you may want to update with: rvm get stable

Setup Ruby

• Ref: https://gist.github.com/wrburgess/a6fc079cee6f14fc601b
• Update ruby: rvm get stable --ruby
• Confirm ruby version changed: ruby -v
• Create .ruby-version file in root dir with ruby version number, ex: 2.4.1

Setup Rails

• Note: This app utilizes uuid data types for all model/table ids.
• Ref: (Rails 5 UUIDs) https://gist.github.com/wrburgess/c1678788181d5f5577c6e84ac5a3efab

Setup Environment Variables

• Ref: https://github.com/laserlemon/figaro
• Note: We use the figaro gem to store and access env variables out of the reach of source control
• Note: You will need to retrieve the valid variables from a team member and place the contents in the /config/application.yml file.

Setup Foreman

• Ref: https://github.com/ddollar/foreman
• Install: gem install foreman
• Note: This will run the Procfile and Procfile.development instructions
• Note: You can run your processes with foreman start -f Procfile.development
• Note: Heroku will utilize the Procfile instructions

Run Servers

• to run the local server type rails server or rails s
• visit localhost:3000

Understanding Pundit for Authorization

• We use the pundit gem for authorization in controllers
• Ref: https://github.com/elabs/pundit
• Ref: https://github.com/chrisalley/pundit-matchers
• Policies are located in app/policies
• Specs for policies are located in spec/policies

robots.txt

• Ref: http://www.jakobbeyer.de/creating-a-dynamic-robots-txt-for-ruby-on-rails
• Note: Changes to the robots.txt file can be adjusted in the /app/views/static/robots.text.erb file

Deployment

1. Push your branch to GitHub with git push origin [branch-name]
2. HerokuCI will build the app, run rspec, and scan style with rubocop.
3. When the master branch passes on the HerokuCI build, the app will be deployed to the staging server on Heroku
4. The application is hosted on a Heroku Pipeline named happenings-server
5. You can promote the staging app to production (happenings-server-staging to happenings-server-production) via heroku pipelines:promote -r staging
6. Post-deploy tasks are referenced in the Procfile after the release: instruction
7. The deploy tasks are located in the /lib/tasks/app.rake file
8. To create a new version tag the last commit with git tag -d v[semver] and git push --tags origin

Quality Control

• run Rails tests: bundle exec rspec spec
• run Rubocop linting: rubocop

Email Systems

Development

We are using Letter Opener Web which will ease the development of emails. Instead of actually sending the emails, they will be caught and stored at /tmp/letter_opener. This way they can be viewed and evaluated. You can view and delete the emails at http://localhost:3000/letter_opener/

Staging

Using Mailtrap

Production

Using Postmark