Skip to content

Latest commit

 

History

History
240 lines (187 loc) · 9.03 KB

README.md

File metadata and controls

240 lines (187 loc) · 9.03 KB
Raw

Patterns

Coverage Status

Build Status

Code Climate

Patterns is an application to manage people that are involved with Blue Ridge Labs' Design Insight Group.

NOTE:

Currently specs are almost all integration specs.

Heroku Trial in progress

Features

Patterns is a customer relationship management application at its heart. Patterns holds people that have signed up to participate with the Design Insight Group, what they like to talk about, and their involvement in research, testing, co-design and focus groups.

Setup

Patterns is a Ruby on Rails app: Mysql, Redis, Sidekiq

Additional Services: Rapidpro for sms (https://textit.com) Afterpattern for consent form signatures https://afterpattern.com LibPostal Rest API for address parsing: https://github.com/ClickSend/libpostal-rest-docker

Hosted on a single machine:

  • Server Set up:

    • It currently uses heroku for deployment to staging and production instances.
    • Environment Variables are used (saved in a sample.env file) for some non-Rails things.
    • credentials are stored in encrypted files, in yaml format. You'll need the production.key on your server.
    • you'll need ssh-agent forwarding: ssh-add -L

    If the command says that no identity is available, you'll need to add your key:

    ssh-add yourkey On Mac OS X, ssh-agent will "forget" this key, once it gets restarted during reboots. But you can import your SSH keys into Keychain using this command:

    /usr/bin/ssh-add -K yourkey

  • Provisioning a new server:

    • change your .env to point production to the right url/git/branch/etc/

      • PRODUCTION_SERVER: "example.com"
      • PRODUCTION_BRANCH: "production"
      • STAGING_SERVER: "staging.example.com"
      • STAGING_BRANCH: "devlopment"
      • GIT_REPOSITORY: "[email protected]:example/example.git"

    • use the provision_new_server.sh script.

      • Ensure that DNS for your hostname is pointing at the server, or else this script will exit.
      • provision_new_server.sh staging staging.example.com [email protected] will provision staging
      • don't forget to add your deploy key and person ssh pubkey to the provision.sh script!

    • run 'cap staging deploy:setup' (if you are deploying to staging)

    • run 'cap staging deploy:cold' ( starts up all of the daemons.)

    SSL certificates are provided free of charge and automatically updated by LetsEncrypt!

Heroku

Should be pretty plug and play, make sure you have these environment variables set:

  • DATABASE_URL
  • RACK_ENV
  • RAILS_ENV
  • RAILS_MASTER_KEY # for encrypted credentials
  • RAILS_SERVE_STATIC_FILES
  • REDIS_URL
  • PRODUCTION_SERVER # domain of production, i.e. production.patterns.com

Once those are set, should be as simple as pushing to heroku, and ensuring that the database is setup. Note: Must use JAWSDB for mysql, as the schema requires a reasonable recent version of mysql to run.

Services and Environment Variables.

Patterns uses encypted credentials. All of what is needed is in "sample_environment.yml" in config/credentials. You should fork this repository and setup your own credentials. We strongly recommend different encrypted credentials for each environment (production, development, staging, test etc.)

You can edit credentials like so: rails credentials:edit --environment production

  • Mailchimp:

    • all new people get added to mailchimp.
    • we also get webhooks now for unsubscribes
    • On the Server Side there are 2 environment variables used:
      • MAILCHIMP_API_KEY
      • MAILCHIMP_LIST_ID
      • MAILCHIMP_WEBHOOK_SECRET_KEY
    • Mailchimp Web hook url is: -?

  • SMTP

    • we now send transactional emails!
    • Use Mandrill, which is built into Mailchimp.
    • Credentials

  • Backups!

    • things now get backed up to AWS
    • need a bucket for each environment, set it in the rails credentials:edit --environment production
    • runs with sidekiq-scheduler (slightly abandonware. keep an eye on it)
    • or run jobs manually:
      • rake backup
      • rake download_backup path_to_private_key {optional_filename}
    • encrypted: so you'll need keys. There are "testing" keys in the fixtures/files folder.
      • DO NOT USE THESE IN PRODUCTION!
    • Generating Keys:
      • Private Key: openssl genrsa -out patterns.pem 2048
      • Public Key: openssl rsa -in patterns.pem -outform PEM -pubout -out patterns_public.pem
      • store the contents of the public key in your environment's credentials.
      • store the private key somewhere safe. NOT in your git repo!
    • AWS Policy permissions: they are super weird and arcane. Use the Simulator!
      • Policy Simulator: https://policysim.aws.amazon.com/home/index.jsp?#
      • permissions that work for us: Read/Write/List only {"Statement": [ { "Effect": "Allow", "Action": [ "s3:PutObject" ], "Resource": "arn:aws:s3:::YOURBUCKETNAME/*", "Condition": {} }, { "Effect": "Allow", "Action": "s3:ListBucket", "Resource": "arn:aws:s3:::YOURBUCKETNAME/*", "Condition": {} }, { "Effect": "Allow", "Action": "s3:GetObject", "Resource": "arn:aws:s3:::YOURBUCKETNAME/*", "Condition": {} } ] }

  • Rapidpro

    • we used to deploy ours with docker-compose: cromulus/rapidpro-docker-compose
    • It's not easy to keep running, so we switched to the hosted provider, https://textit.com
    • It is a UI for creating sms workflows that are designed to communicate with backend services like patterns.
    • add the URL and your rapidpro API token to encrypted credentials.
    • new people are added to rapidpro using sidekiq.
    • eventually we will be able to start rapidpro flows from Patterns.

TODO

  • People

    • Add arbitrary fields
    • Attach photograph
    • Attach files
    • Link with their social networks
    • Show activity streams
    • contact info verification

  • Research Session Completeness

    • Complete should be an attribute on Sessions.
    • after save for both sessions, invitations, and people (if we add a consent form)
    • Background task that uses action cable to update the session
    • update should be global.
    • every invitation that changes calls the front end update function
    • need to turn sessions into partials

  • Digital GiftCard Cancel

    • should have an attribute on reward: active/cancelled or something that is default scope
    • on cancel, through webhook, we:
      • make reward inactive, thus hidden and make a transaction that reverses the prior.
      • also make digital gift inactive/cancelled. Probably have a default scope there.
      • sort of "acts as paranoid" style https://github.com/ActsAsParanoid/acts_as_paranoid
      • perhaps use acts as paranoid?

Hacking

Main development occurs in the development branch. HEAD on production is always ready to be released. staging is, well, staging. New features are created in topic branches, and then merged to development via pull requests. Candidate releases are tagged from development and deployed to staging, tested, then merged into the production and deployed.

We use Github Actions for continuous integration testing and linting. see: .github/workflows for details.

Specs are, well, heisenbuggish. If they don't pass, try rspec --only-failures and they will. Why, I don't know.

Development workflow: Install mysql & redis

bundle install -j4
bundle exec rake db:setup
bundle exec rails s

Login with: email: '[email protected]', password: 'foobar123!01203$#$%R',

Codespaces and Devcontainer

Should be able to launch a codespace in github and in vscode. It's got Redis & Mysql and everything. It runs bundle install, and you'll need to copy config/credentials/development.key into the codespace and run rake db:setup to get it going.

Unit and Integration Tests

To run all tests:

bundle exec rake

To constantly run red-green-refactor tests:

bundle exec guard -g red_green_refactor

Todo:

Contributors

License

The application code is released under the MIT License. See LICENSE for terms.