diff --git a/.gitignore b/.gitignore index 6998627a..23643e5a 100644 --- a/.gitignore +++ b/.gitignore @@ -42,3 +42,7 @@ geocoder.rb ## editor temp files *.swp *.swo + +## Vagrant working directory +.vagrant +ruby diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..81d48416 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Contributing + +## Setting Up Development Environment + +### 1 Fork and clone the repository. + +### 2 Install Vagrant. +https://www.vagrantup.com/downloads + +### 3 Capture the powers of vagrant + * In the repo dir: vagrant up (Safely ignore: 'dpkg-preconfigure: unable to re-open stdin: No such file or directory') + * If changes have been made since running vagrant up: vagrant provision + * To login to the machine: vagrant ssh + +### 4 Optional tasks: +run rake db:fix_accents to clean up encoding problems in the safe2pee data. (Use rake db:fix_accents[dry_run] to preview the changes.) + +### 5 Assets +* [Assets Repo](https://github.com/RefugeRestrooms/refuge_assets) + +## Testing + +Please cover any new code with specs. We prefer code to be covered using RSpec or Capybara. + diff --git a/README.md b/README.md index 46e67ca2..1c5ae98f 100644 --- a/README.md +++ b/README.md @@ -7,11 +7,6 @@ REFUGE is an effort to fill the hole left by the now-defunct Safe2Pee website. I This project is open source. Feel free to contribute. We could use the help. - -## Set Up For Contributing -* [Enviroment Setup Wiki](https://github.com/RefugeRestrooms/refugerestrooms/wiki/Setting-up-the-Dev-Enviroment-for-Contributing-to-Refuge-Restrooms) -* [Assets Repo](https://github.com/RefugeRestrooms/refuge_assets) - ## Deployment Currently right now we deploy to heroku. Our application is small enough that it is free to host on Heroku, and we dont mind the server having to wake up if nobody has accessed the site in a while. @@ -31,12 +26,6 @@ Here are the steps to deploy: -### Testing - -Please cover any new code with specs. We prefer code to be covered using RSpec or Capybara. - - - ## Tech * Ruby Version - ruby-2.0.0-p247 diff --git a/Vagrantfile b/Vagrantfile new file mode 100644 index 00000000..9af219db --- /dev/null +++ b/Vagrantfile @@ -0,0 +1,57 @@ +# -*- mode: ruby -*- +# vi: set ft=ruby : + +# Vagrantfile API/syntax version. Don't touch unless you know what you're doing! +VAGRANTFILE_API_VERSION = "2" +BOXNAME = "refugerestrooms" + +Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| + # Ubuntu 14.04 base box + config.vm.box = "ubuntu/trusty64" + config.vm.hostname = BOXNAME + #config.vm.box_download_checksum = + + # Disable automatic box update checking. If you disable this, then + # boxes will only be checked for updates when the user runs + # `vagrant box outdated`. This is not recommended. + # config.vm.box_check_update = false + + # Access the rails server at localhost:3000 + config.vm.network "forwarded_port", guest: 3000, host: 3000 + + # Use this if you need to copy files via scp or something + # config.vm.network "private_network", ip: "192.168.33.10" + + # If true, then any SSH connections made will enable agent forwarding. + # Default value: false + # config.ssh.forward_agent = true + + # Share refuge repo in vagrant home folder + config.vm.synced_folder ".", "/vagrant/refugerestrooms" + + # View virtualbox provider docs for more options + config.vm.provider "virtualbox" do |vb| + vb.name = BOXNAME + # Uncomment this if you need more than default of 512 + #vb.customize ["modifyvm", :id, "--memory", "1024"] + end + + # If this gets bigger I can make it into a chef run + # mi-wood + config.vm.provision "shell", path: "setup/setup_vagrant.sh", privileged: false + + # Enable provisioning with chef solo, specifying a cookbooks path, roles + # path, and data_bags path (all relative to this Vagrantfile), and adding + # some recipes and/or roles. + # + # config.vm.provision "chef_solo" do |chef| + # chef.cookbooks_path = "../my-recipes/cookbooks" + # chef.roles_path = "../my-recipes/roles" + # chef.data_bags_path = "../my-recipes/data_bags" + # chef.add_recipe "mysql" + # chef.add_role "web" + # + # # You may also specify custom JSON attributes: + # chef.json = { mysql_password: "foo" } + # end +end diff --git a/setup/pg_hba.conf b/setup/pg_hba.conf new file mode 100644 index 00000000..e2e88588 --- /dev/null +++ b/setup/pg_hba.conf @@ -0,0 +1,99 @@ +# PostgreSQL Client Authentication Configuration File +# =================================================== +# +# Refer to the "Client Authentication" section in the PostgreSQL +# documentation for a complete description of this file. A short +# synopsis follows. +# +# This file controls: which hosts are allowed to connect, how clients +# are authenticated, which PostgreSQL user names they can use, which +# databases they can access. Records take one of these forms: +# +# local DATABASE USER METHOD [OPTIONS] +# host DATABASE USER ADDRESS METHOD [OPTIONS] +# hostssl DATABASE USER ADDRESS METHOD [OPTIONS] +# hostnossl DATABASE USER ADDRESS METHOD [OPTIONS] +# +# (The uppercase items must be replaced by actual values.) +# +# The first field is the connection type: "local" is a Unix-domain +# socket, "host" is either a plain or SSL-encrypted TCP/IP socket, +# "hostssl" is an SSL-encrypted TCP/IP socket, and "hostnossl" is a +# plain TCP/IP socket. +# +# DATABASE can be "all", "sameuser", "samerole", "replication", a +# database name, or a comma-separated list thereof. The "all" +# keyword does not match "replication". Access to replication +# must be enabled in a separate record (see example below). +# +# USER can be "all", a user name, a group name prefixed with "+", or a +# comma-separated list thereof. In both the DATABASE and USER fields +# you can also write a file name prefixed with "@" to include names +# from a separate file. +# +# ADDRESS specifies the set of hosts the record matches. It can be a +# host name, or it is made up of an IP address and a CIDR mask that is +# an integer (between 0 and 32 (IPv4) or 128 (IPv6) inclusive) that +# specifies the number of significant bits in the mask. A host name +# that starts with a dot (.) matches a suffix of the actual host name. +# Alternatively, you can write an IP address and netmask in separate +# columns to specify the set of hosts. Instead of a CIDR-address, you +# can write "samehost" to match any of the server's own IP addresses, +# or "samenet" to match any address in any subnet that the server is +# directly connected to. +# +# METHOD can be "trust", "reject", "md5", "password", "gss", "sspi", +# "krb5", "ident", "peer", "pam", "ldap", "radius" or "cert". Note that +# "password" sends passwords in clear text; "md5" is preferred since +# it sends encrypted passwords. +# +# OPTIONS are a set of options for the authentication in the format +# NAME=VALUE. The available options depend on the different +# authentication methods -- refer to the "Client Authentication" +# section in the documentation for a list of which options are +# available for which authentication methods. +# +# Database and user names containing spaces, commas, quotes and other +# special characters must be quoted. Quoting one of the keywords +# "all", "sameuser", "samerole" or "replication" makes the name lose +# its special character, and just match a database or username with +# that name. +# +# This file is read on server startup and when the postmaster receives +# a SIGHUP signal. If you edit the file on a running system, you have +# to SIGHUP the postmaster for the changes to take effect. You can +# use "pg_ctl reload" to do that. + +# Put your actual configuration here +# ---------------------------------- +# +# If you want to allow non-local connections, you need to add more +# "host" records. In that case you will also need to make PostgreSQL +# listen on a non-local interface via the listen_addresses +# configuration parameter, or via the -i or -h command line switches. + + + + +# DO NOT DISABLE! +# If you change this first entry you will need to make sure that the +# database superuser can access the database using some other method. +# Noninteractive access to all databases is required during automatic +# maintenance (custom daily cronjobs, replication, and similar tasks). +# +# Database administrative login by Unix domain socket +local all postgres peer + +# TYPE DATABASE USER ADDRESS METHOD + +# "local" is for Unix domain socket connections only +local all all trust +# IPv4 local connections: +host all all 127.0.0.1/32 trust +# IPv6 local connections: +host all all ::1/128 trust +# Allow replication connections from localhost, by a user with the +# replication privilege. +#local replication postgres peer +#host replication postgres 127.0.0.1/32 md5 +#host replication postgres ::1/128 md5 diff --git a/setup/setup_vagrant.sh b/setup/setup_vagrant.sh new file mode 100644 index 00000000..499aeb18 --- /dev/null +++ b/setup/setup_vagrant.sh @@ -0,0 +1,88 @@ +#!/bin/bash +# This script is run from vagrant to setup packages +# It's only tested with ubuntu 14.04 +set -e + +REFUGE_PATH=/vagrant/refugerestrooms + +# required packages +declare -A packages +packages=( + ["git"]="1:1.9.1-1" + ["nodejs"]="0.10.25~dfsg2-2ubuntu1" + ["phantomjs"]="1.9.0-1" + ["postgresql-server-dev-9.3"]="9.3.5-0ubuntu0.14.04.1" + ["postgresql-contrib-9.3"]="9.3.5-0ubuntu0.14.04.1" +) + +for package in "${!packages[@]}" +do + version=${packages["$package"]} + if dpkg -s $package | grep -q $version; then + echo $package' installed, skipping' + else + echo 'installing '$i', version '$version'...' + sudo apt-get install -y -q $package=$version + fi +done + +# Install rbenv and ruby-build +echo 'installing rbenv...' +cd +if ! [ -d .rbenv ]; then + git clone git://github.com/sstephenson/rbenv.git .rbenv +fi +if ! grep -q '.rbenv/bin' $HOME/.bashrc; then + echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc +fi +if ! grep -q 'rbenv init' $HOME/.bashrc; then + echo 'eval "$(rbenv init -)"' >> ~/.bashrc +fi +if ! [ -d ~/.rbenv/plugins/ruby-build ]; then + git clone git://github.com/sstephenson/ruby-build.git ~/.rbenv/plugins/ruby-build +fi +if ! grep -q ruby-build $HOME/.bashrc; then + echo 'export PATH="$HOME/.rbenv/plugins/ruby-build/bin:$PATH"' >> ~/.bashrc +fi + +# source .bashrc doesn't appear to be setting the path +# adding the following for now: +export PATH="$HOME/.rbenv/bin:$PATH" +eval "$(rbenv init -)" +export PATH="$HOME/.rbenv/plugins/ruby-build/bin:$PATH" + +# Install ruby +ruby_version=`cat $REFUGE_PATH/.ruby-version` +if rbenv versions | grep $ruby_version; then + echo 'ruby '$ruby_version' installed, skipping...' +else + echo 'install ruby '$ruby_version + rbenv install $ruby_version +fi + +# Install bundle reqs +cd $REFUGE_PATH +if which bundle; then + echo 'bundler installed, skipping' +else + echo 'Installing bundler...' + gem install bundler --no-rdoc --no-ri -q +fi +echo 'Running bundle install...' +bundle install --gemfile=$REFUGE_PATH/Gemfile + +# Change permissions on pg_hba.conf +pg_hba=/etc/postgresql/9.3/main/pg_hba.conf +sudo cp /vagrant/refugerestrooms/setup/pg_hba.conf $pg_hba +sudo chown postgres:postgres $pg_hba +sudo chmod 640 $pg_hba + +# Creating postres user +if ! psql -c 'SELECT rolname FROM pg_roles;' postgres | grep vagrant; then + echo 'Creating vagrant postgres user...' + sudo -u postgres createuser vagrant --createdb --superuser +fi + +# Seed db +echo 'Seeding db...' +bundle exec rake db:setup