GOV.AU Beta Content Analysis

This project provides the content analysis API for the GOV.AU content site.

The API Specification draft can be found here

GOV.AU stack

If you're contributing to this repo, then you'll most likely be contributing to the other GOV.AU repos in the stack:

• GOV.AU Beta Frontend
• Experimental GOV.AU Authoring Tool

Local Ruby on Rails development environment on Mac OSX

#install homebrew
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
#install rbenv
brew install rbenv ruby-build

# Add rbenv to bash so that it loads every time you open a terminal
echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile
source ~/.bash_profile

# Install Ruby
rbenv install 2.3.1

#missing openssl.h
brew install openssl
brew link openssl --force

#Can't find the 'libpq-fe.h header
brew install postgresql
initdb /usr/local/var/postgres
ln -sfv /usr/local/opt/postgresql/*.plist ~/Library/LaunchAgents
launchctl load ~/Library/LaunchAgents/homebrew.mxcl.postgresql.plist
# logs etc. in /usr/local/var/postgres/

#install deps
bundle install

# setup db with seed data
rails db:setup

# run dev server at http://localhost:3001
bundle exec rake start

Setting Up/Deploying to cloudfoundry

Thanks to http://docs.cloudfoundry.org/buildpacks/ruby/ruby-tips.html

# first time setup
# https://docs.pivotal.io/pivotalcf/devguide/services/migrate-db.html
# http://stackoverflow.com/a/10302357/684978 for db: rake tasks
cf create-service aws-rds-postgres 5.6-t2.micro-5G gov-au-beta-content-analysis-db
cf service gov-au-beta-content-analysis-db # do until status is 'available' - 10 minutes or so
cf push -i 1 -u none -c "bundle exec rake db:schema:load db:seed" 
cf set-env gov-au-beta-content-analysis SECRET_KEY_BASE `rails secret`
cf set-env gov-au-beta-content-analysis ROLLBAR_ACCESS_TOKEN aabcc

Pull request approvals

Maintainers who can approve PRs on this repo are stored within MAINTAINERS. The minimum number of approvers by default is 2. A PR will not be able to merge without the required number of approvals.

Providing approval

If you are reviewing a PR, you should assign it to yourself so that people are aware of who is reviewing the branch. Once you are satisfied that the PR is in a mergeable state, and have no follow-up comments to make, you should comment with 'LGTM'.

You should not comment with 'LGTM' in any of your comments unless you are intending to approve the PR for merge, as the branch protection will look for this explicitly.