Locaweb Test

For more information about the test itself, check the README.md file (in pt-br) at docs/locaweb-test-overview/ folder.

Programming Language, Docker and Docker Compose version, and libraries used to solve the problems

Ruby 2.4.1 @ Ubuntu 17.04 64-bits
Docker 17.06.0-ce
Docker Compose 1.14.0

Main libraries:

cucumber ~>2.4.0
httparty ~>0.15.5
puma ~>3.9.1
rspec ~>3.6.0
shotgun ~>0.9.2
sinatra ~>2.0.0
sinatra-contrib ~>2.0.0
webmock ~>3.0.1

Running the code with Docker Compose

Clone this repository and access its root folder
Run Docker Compose (re)start a container
- If there is no image available (or it is the first time) then Docker Compose will build the image

$ docker-compose up

Access localhost:9292/api/v1/most_relevants or localhost:9292/api/v1/most_mentions to see the data (JSON format)

Running the code with Docker

Clone this repository and access its root folder
Build a Docker image for this project

$ docker build -t my-app-locaweb-tweets-test .

Run a Docker container with the image

$ docker run -d --name locaweb-tweets-test -p 9292:9292 my-app-locaweb-tweets-test

Access localhost:9292/api/v1/most_relevants or localhost:9292/api/v1/most_mentions to see the data (JSON format)

Running the code without Docker or Docker Compose

Clone this repository and access its root folder
Execute bundle install to install all dependencies

Then

Start server with autoreload (for development)

$ shotgun --port=9292

Access localhost:9292/api/v1/most_relevants or localhost:9292/api/v1/most_mentions to see the data (JSON format)

Start server with autoreload (for production/test)

$ puma

Access localhost:9292/api/v1/most_relevants or localhost:9292/api/v1/most_mentions to see the data (JSON format)

For tests

In the root folder:

Execute tests with a Cucumber profile (see more at cucumber.yml)

$ cucumber -p html_reports

Execute tests with RSpec

$ rspec

Why did I use such technologies?

Ruby

I chose Ruby for two reasons:

It is the main programming language at Locaweb
It is my favorite language (although I could have done this project with Node.js or Python -- my other favorites)

RSpec, Cucumber, and Webmock

I have a strong experience with tests (academic and professional) and I like both. So I used them. Yes, I could have used just one of them (for this project I would prefer to use RSpec) but I chose to show both of them here in my code.

This was my first time using Webmock. Since Locaweb Tweets changes every time I make a request, I realized that it was necessary to mock some data and simulate (stub) a request to test my methods always with this mocked data. For my first time with this library, I could say that I liked.

HTTParty

Frankly, once I met this library, I fell in love with it. I use it whenever possible.

Puma and Shotgun

I use Shotgun for autoreload when developing (a habit that I got in Node.js with nodemon). As for Web Server, I prefer to not use WebBrick in production. I could use Thin, but I have little more experience with Puma. So, I used it.

Sinatra

Since this was a small project with only two endpoints, I decided that Sinatra was a better fit. I could used Rails but (at least for me) it would be a cannon to kill a fly.

Extra features

APIDocs -- generate documentation
Travis CI -- continuous integration
Simplecov -- test code coverage
Code Climate -- automated code review
- Code Review
- Test Coverage
Gemnasium -- dependencies tracking
- PS: my badge is out-to-date due a conflict between simplecov 0.14.1 and codeclimate-test-reporter 1.0.8. If I use the 1.0.8, then I need to use simplecov 0.13.

Benchmarking

This is ApacheBench, Version 2.3 <$Revision: 1757674 $>
Copyright 1996 Adam Twiss, Zeus Technology Ltd, http://www.zeustech.net/
Licensed to The Apache Software Foundation, http://www.apache.org/

Benchmarking localhost (be patient)
Finished 149 requests


Server Software:
Server Hostname:        localhost
Server Port:            9292

Document Path:          /
Document Length:        27577 bytes

Concurrency Level:      200
Time taken for tests:   10.046 seconds
Complete requests:      149
Failed requests:        0
Total transferred:      4551492 bytes
HTML transferred:       4522628 bytes
Requests per second:    14.83 [#/sec] (mean)
Time per request:       13484.114 [ms] (mean)
Time per request:       67.421 [ms] (mean, across all concurrent requests)
Transfer rate:          442.46 [Kbytes/sec] received

Connection Times (ms)
              min  mean[+/-sd] median   max
Connect:        2    3   0.5      2       4
Processing:  1147 5692 2483.1   5663   10042
Waiting:      768 4810 2481.5   4729    9150
Total:       1150 5694 2482.8   5666   10045
WARNING: The median and mean for the initial connection time are not within a normal deviation
        These results are probably not that reliable.

Percentage of the requests served within a certain time (ms)
  50%   5666
  66%   7239
  75%   7619
  80%   8305
  90%   9167
  95%   9385
  98%   9969
  99%   9990
 100%  10045 (longest request)

vinpereira/locaweb-test