Skip to content

Latest commit

 

History

History
188 lines (156 loc) · 7.04 KB

README.md

File metadata and controls

188 lines (156 loc) · 7.04 KB
Raw

Kimball

Coverage StatusBuild StatusCode Climate

Kimball is an application to manage people that are involved with the Smart Chicago CUTGroup.

Features

Kimball is a customer relationship management application at its heart. Kimball tracks people that have signed up to participate with the CUTGroup, their involvement in events and CUTGroup programs.

Setup

Kimball is a Ruby on Rails app.

  • Server Set up:
    • It currently uses Capistrano for deployment to staging and production instances.
    • ElasticSearch needs to be installed and running for Kimball to work.
    • Environment Variables are used (saved in a local_env.yml file) for API keys and other IDs.
    • 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 local_env.yml to point production to the right url/git/branch/etc/
      • PRODUCTION_SERVER: "example.com"
      • PRODUCTION_BRANCH: "master"
      • STAGING_SERVER: "staging.example.com"
      • STAGING_BRANCH: "devlopment"
      • GIT_REPOSITORY: "[email protected]:example/example.git"
    • use the provision_new_server.sh script.
      • script defaults to production, however, the first arg is the environment you want.
      • provision_new_server.sh staging will provision staging
      • don't forget to add your deploy key and person ssh pubkey to the provision.sh script!
    • run 'cap production deploy:setup' (if you are deploying to production)
    • run 'cap production deploy:cold' ( starts up all of the daemons.)

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

Services and Environment Variables.

Environment variables live here: /config/local_env.yml. The defaults are drawn from /config/sample.local_env.yml.

local_env.yml, which should not be committed, and should store your API credentials, etc.

If a variable isn't defined in your local_env.yml, we use the default value from sample.local_env.yml, which is checked into the respository.

  • Organizational Defaults

  • Wufoo

    • Wufoo hosts all forms used for Kimball.
    • On the Server Side there are 3 environment variables used:
      • WUFOO_ACCOUNT
      • WUFOO_API
      • WUFOO_SIGNUP_FORM
      • WUFOO_HANDSHAKE_KEY
    • For SMS signup and form fills, "SMS Campaigns" are created in the Kimball app to associate a Wufoo form ID.
    • Webhooks are used on Wufoo to send data back to Kimball. Currently there are 2 webhooks in use:
      • /people : This endpoint is used for new signups via the main signup/registration wufoo form.
      • /people/create_sms : This endpoint is used for new signups via the signup/registration Wufoo form that has been customized for SMS signup.
      • /submissions : This endpoint is for all other Wufoo forms (call out, availability, tests). It saves the results in the submissions model.

  • Twilio:

    • Twilio is used to
      • send and receive text messages for sign up, notifications, and surveys.
      • schedule interviews and calls
    • Three Twilio phone numbers are needed.
      • Text message signup, notifications, and surveys.
      • Text message verification.
      • Scheduling
    • On the Server Side there are several environment variables used:
      • TWILIO_ACCOUNT_SID
      • TWILIO_AUTH_TOKEN
      • TWILIO_SURVEY_NUMBER
        • /receive_text/smssignup #POST
      • TWILIO_SIGNUP_VERIFICATION_NUMBER
        • /receive_text/index #POST
      • TWILIO_SCHEDULING_NUMBER
        • /v2/sms_reservations #POST

  • Mailchimp:

    • Mailchimp is used to send emails.
    • 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
      • AWS_API_TOKEN
      • AWS_API_SECRET
      • AWS_S3_BUCKET
    • provisioning script sets this up for you. runs 32 minutes after the hour, ever hour.

TODO

  • Events
    • Invite
    • RSVP
    • Attendance tracking
    • Reminder emails
  • Programs
    • Associate results
  • People
    • Add arbitrary fields
    • Attach photograph
    • Attach files
    • Link with their social networks
    • Show activity streams
    • Track program status (e.g. has received Visa card)
    • Show output from Tribune boundaries service on individual person pages
  • Backend
    • Terms of service/privacy policy
    • Managed access to anonymized data for research
    • Audit trails
    • Comments on all objects

Usage

Running a Test!

  1. create a survey * email and web link: https://smartchicago2012.wufoo.com/forms/cutgroup-test-political-contribution-website/ * SMS survey: https://smartchicago2012.wufoo.com/forms/sms-cutgroup-test-political-contributions-website/
  2. Pick people to receive the survey and send it to em.
  3. Choose people and send them an availability survey: * https://smartchicago2012.wufoo.com/forms/cutgroup-test-political-contribution-availability/ * people can choose multiple slots
  4. Tell people individually what tests youve chosen for them and manually create a reservation for them.
  5. create a survey that is filled out during the test itself, either via SMS or web.

Hacking

Main development occurs in the development branch. HEAD on master is always the production release. 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 pushed to master and production.

Development workflow: Install Vagrant: https://vagrantup.com/

vagrant plugin install vagrant-cachier vagrant-hostmanager
vagrant up
open http://`whoami`.patterns.dev

To access the virtual machine, run:

vagrant ssh
bundle exec rails c # etc. etc. etc.

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

Contributors

License

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