RelevamientosArt

API Documentation

URL: http://relevamientos-art.herokuapp.com/

Headers:

For GET requests: Accept: application/json
For POST & PUT requests (with a body): Content-Type: application/json

Users

Body: { "session": { "email": "juan_perez@example.com", "password": "abcdef" } }

Reset password: POST /users/new_password_request

Body: { "user_email": "juan_perez@example" }

Update password: PUT /users/:user_id/new_password

Body: { "user": { "current_password": "abc", "password": "def", "password_confirmation": "def" } }

Institutions

Details of an Institution: GET /institutions/:id

Visits

List of all visits: GET /visits{?status=:some_status&user_id=:id}

Details of a visit: GET /visits/:id

Complete a Visit (with a body): PUT /visits/:visit_id/completion

Assign Visits (with a body): POST /visits/auto_assignments2

Body: { "users":[1,2,3], "visits":[54,43,32] }

Mark visit as in process: PUT /visits/:id/in_process

Tasks

Complete a task (with a body): PUT /tasks/:task_id/completion

Ruby on Rails Learning

Recomended sites to start discovering Ruby and the Ruby on Rails framework!

Useful links to start learning how to program in Ruby language, and particulary on Ruby on Rails framework

Running local server

Git pre push hook

You can modify the pre-push.sh script to run different scripts before you git push (e.g Rspec, Linters). Then you need to run the following:

  chmod +x script/pre-push.sh
  ln -s ../../script/pre-push.sh .git/hooks/pre-push

You can skip the hook by adding --no-verify to your git push.

1- Installing Ruby

Clone the repository by running git clone https://github.com/ignaciocapuccio/Relevamientos-ART.git
Go to the project root by running cd Relevamientos-ART
Download and install Rbenv.
Download and install Ruby-Build.
Install the appropriate Ruby version by running rbenv install [version] where version is the one located in .ruby-version

2- Installing Rails gems

Install Bundler.

  gem install bundler --no-ri --no-rdoc
  rbenv rehash

Install basic dependencies if you are using Ubuntu:

  sudo apt-get install build-essential libpq-dev nodejs

Install all the gems included in the project.

  bundle -j 20

[Kickoff] Application Setup

The app is ready!

Database Setup

Run in terminal:

  sudo -u postgres psql
  CREATE ROLE "Relevamientos-ART" LOGIN CREATEDB PASSWORD 'Relevamientos-ART';

Log out from postgres and run:

  bundle exec rake db:create db:migrate

Your server is ready to run. You can do this by executing rails server and going to http://localhost:3000.

Running with Docker

Deploy Guide

Heroku

If you we want to deploy the app using Heroku you need to do the following:

Add the Heroku Git URL to your remotes
Push to heroku

	git remote add heroku-prod your-git-url
	git push heroku-prod your-branch:master

Rbenv

If you have an error while executing install_bundler capistrano task then modify the ~/.bash_profile as indicated here.

and run rbenv global with the version in .ruby-version

Sidekiq

If Sidekiq start fails when you make the first deploy. You can comment the sidekiq lines in deploy.rb and Capfile during the first deploy.

Rollbar Configuration

Rollbar is used for exception errors report. To complete this configuration setup the following environment variables in your server

ROLLBAR_ACCESS_TOKEN

with the credentials located in the rollbar application.

If you have several servers with the same environment name you may want to difference them in Rollbar. For this set the ROLLBAR_ENVIRONMENT environment variable with your environment name.

Staging Environment

For the staging environment label to work, set the TRELLO_URL environment variable.

Google Analytics

Modified the XX-XXXXXXX-X code in the _google_analytics.html.slim file

SEO Meta Tags

Just add a the meta element to your view.

For example

  = meta title: "My Title", description: "My description", keywords: %w(keyword1 keyword2)

You can read more about it here

Brakeman

To run the static analyzer for security vulnerabilities run:

  bundle exec brakeman -z -i config/brakeman.ignore

PGHero Authentication

Set the following variables in your server.

  PGHERO_USERNAME=username
  PGHERO_PASSWORD=password

And you can access the PGHero information by entering /pghero.

Dotenv

We use dotenv to set up our environment variables in combination with secrets.yml.

For example, you could have the following secrets.yml:

production: &production
  foo: <%= ENV['FOO'] %>
  bar: <%= ENV['BAR'] %>

and a .env file in the project root that looks like this:

FOO=1
BAR=2

When you load up your application, Rails.application.secrets.foo will equal ENV['FOO'], making your environment variables reachable across your Rails app. The .env will be ignored by git so it won't be pushed into the repository, thus keeping your tokens and passwords safe.

Debugging Chrome Console

It is a simple and useful way to look at Rails logs without having to look at the console, it also show queries executed and response times. Install the Rails Panel Extension (https://chrome.google.com/webstore/detail/railspanel/gjpfobpafnhjhbajcjgccbbdofdckggg). This is recommended way of installing extension, since it will auto-update on every new version. Note that you still need to update meta_request gem yourself.

Documentation

You can find more documentation in the docs folder. The documentation available is:

Generating API documentation

You can generate API documentation running:

bundle exec rake dictum:document

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Run rspec tests (bundle exec rspec spec -fd)
Run scss lint (bundle exec scss-lint app/assets/stylesheets/)
Run rubocop lint (bundle exec rubocop app spec -R)
Push your branch (git push origin my-new-feature)
Create a new Pull Request

icapuccio/Relevamientos-ART