README - ermahgerd-rails-api-jwt

The Rails API server for Canadian Pump & Packing Distribution. Serves up JSONAPI payloads for an EmberJs SPA over at https://github.com/cybertooth-io/ccpdist-com-emberjs.

Development - Getting Started

You need the following:

• Ruby-2.3+ - suggest Ruby-2.5 but check your production environment to be sure -- e.g. AWS EB
• Docker - we use two containers, one for the PostgreSQL database and one for Redis
• The config/master.key file

First Time Setting Up

Perform the following from the command line:

1. bundle install - will install any of the missing gems declared in the Gemfile
2. docker-compose up -d - start up a Redis and PostgreSQL server in a container
3. rake db:create - only required the first time, make sure your database is created
4. rake db:migrate - run as required, your application will produce a stacktrace of errors if you're not up to date
5. rake db:seed_fu - run as required, to seed the database with data
6. rake test - run as required, test to make sure your API is behaving

Running The Server

rails s - to serve the API on http://localhost:3000

Database Seeds

For development, feel free to edit the db/fixtures/development/002_users.rb file to add yourself.

Seed the database with:

$ rake db:seed_fu

Redis

Redis is used by JWTSessions to store Tokens and is also used by Sidekiq to queue up jobs.

JWTSessions is configured in config/initializers/jwt_session.rb to use database 0.

Sidekiq is configured in config/initializers/sidekiq.rb to use database 1.

Crons/Jobs/Queues

If you're creating Sidekiq jobs please use the generator: rails g sidekiq:worker record_session_activity

Development Workflow

1. Create a model with its singular name: rails g model role key:string name:string notes:text
   1. Edit the migration to ensure the default and null values are defined
   2. Add validations, relationships, scopes, etc. to the new model class
   3. Is the model audited? Yes, then add the audited declaration to the model class
   4. Add test fixture data accordingly to test/fixtures/*.yml (keep it general and un-crazy)
   5. Unit test accordingly
   6. Add the model information to the config/locales/*.yml file(s)
2. Create the pundit policy with the model's singular name: rails g pundit:policy role
   1. Make sure your policy file extends ApplicationPolicy (it should by default)
   2. Override create?, destroy?, index?, show?, and update? accordingly
   3. Unit test accordingly
   4. Add the policy error messages to the config/locales/*.yml if so desired
3. Create the protected resource using the model's singular name at the appropriate api path: rails g jsonapi:resource api/v1/protected/role
   1. Make sure the resource extends BaseResource
   2. Add the appropriate attributes from the model that will be serialized in the JSONAPI payload
   3. Make sure all relationships you want exposed are added
   4. Add any filters that use model scopes
   5. Unit test accordingly through the controller (next step)
4. Create the protected controller using the model's plural name at the appropriate api path: rails g controller api/v1/protected/roles
   1. Make sure the controller extends BaseResourceController
   2. Add the controller's end points to the config/routes.rb file; use jsonapi_resources helper :-)
   3. Unit test accordingly (e.g. confirm returned payload only contains the fields specified in the resource)

Commiting Code

1. Use a branch and a pull request into master.
2. Run rubocop -a prior to commits to make sure your code conforms to the formatting and linting.

---

Configuration Notes

The config/application.rb sets the record_session_activity boolean which is used to determine whether we should be logging session activity.

---

Credentials

As of Rails-5.2 secrets are hashed and locked down with the config/master.key file. Run rails credentials:help for more information.

Do you need to create a key? Use rake secret

Do you need to edit some secrets? Do it from the command line:

$ rails credentials:edit

Keys in config/credentials.yml.enc

secret_key_base - used by Rails in many ways (e.g. BCrypt)

secret_jwt_encryption_key - used by JWT & JWT_Sessions to create access & refresh tokens

---

Releasing

1. Confirm (and edit) the config/application.rb's version property.
2. Commit.
3. Tag: git tag v#.#.#
4. Edit the config/application.rb's version property.
5. Commit & push everything.

---

Deployment

Coming soon

Contributing

Team members, create a branch and pull request.

General Public: Fork and create pull request.