236 simple api rebased

Gemfile

@@ -3,9 +3,11 @@ ruby '2.2.3'
 
 gem 'airbrake', '~> 7.1'
 gem 'devise', '~> 3.0'
+gem 'faker', '~> 1.7.0'
 gem 'geokit', '~> 1.0'
 gem 'haml', '~> 5.0'
 gem 'http_accept_language', '~> 2.0'
+gem 'kaminari', '~> 1.0'
 gem 'local_time', '~> 2.0'
 gem 'obscenity', '~> 1.0', '>= 1.0.2'
 gem 'pg'

Gemfile.lock

@@ -76,6 +76,8 @@ GEM
       railties (>= 3.2, < 5.2)
     erubis (2.7.0)
     execjs (2.7.0)
+    faker (1.7.3)
+      i18n (~> 0.5)
     ffi (1.9.18)
     font-awesome-rails (4.7.0.2)
       railties (>= 3.2, < 5.2)
@@ -256,9 +258,11 @@ DEPENDENCIES
   coveralls
   devise (~> 3.0)
   dotenv-rails
+  faker (~> 1.7.0)
   geokit (~> 1.0)
   haml (~> 5.0)
   http_accept_language (~> 2.0)
+  kaminari (~> 1.0)
   local_time (~> 2.0)
   obscenity (~> 1.0, >= 1.0.2)
   paranoia (~> 2.4)
@@ -281,4 +285,4 @@ RUBY VERSION
    ruby 2.2.3p173
 
 BUNDLED WITH
-   1.15.4
+   1.16.1

app/assets/javascripts/adopted.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

app/assets/stylesheets/adopted.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the Adopted controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

app/controllers/adopted_controller.rb

@@ -0,0 +1,48 @@
+class AdoptedController < ApplicationController
+  before_action :authenticate
+
+  # GET /api/v1/drains/adopted
+  # Optional params:
+  #
+  #  page
+  def index
+    adopted_things
+    make_cur_page
+    make_other_pages
+    @results = {next_page: @next_page, prev_page: @prev_page, total_pages: @adopted_things.page(1).total_pages, drains: @things}
+    render json: @results
+  end
+
+private
+
+  def adopted_things
+    @adopted_things = Thing.adopted
+  end
+
+  # Determine if the user supplied a valid page number, if not they get first page
+  def make_cur_page
+    page = params[:page].blank? || params[:page].to_i.zero? ? 1 : params[:page]
+    @cur_page = @adopted_things.page(page)
+    @things = format_fields(@cur_page)
+  end
+
+  # Determine next and previous pages, so the user can navigate if needed
+  def make_other_pages
+    @next_page = @cur_page.next_page.nil? ? -1 : @cur_page.next_page
+    @prev_page = @cur_page.prev_page.nil? ? -1 : @cur_page.prev_page
+  end
+
+  def format_fields(obj)
+    obj.map { |thing| {latitude: thing.lat, longitude: thing.lng, city_id: 'N-' + thing.city_id.to_s} }
+  end
+
+  def authenticate
+    authenticate_or_request_with_http_basic('Administration') do |username, password|
+      user = User.find_by(email: username)
+      if user && user.valid_password?(password)
+        return true if user.admin?
+        render html: '<div> You must be an admin to access this page </div>'
+      end
+    end
+  end
+end

app/controllers/application_controller.rb

@@ -1,3 +1,5 @@
+require 'csv'
+
 class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.

app/helpers/adopted_helper.rb

@@ -0,0 +1,2 @@
+module AdoptedHelper
+end

config/environments/development.rb

@@ -9,7 +9,13 @@
   config.cache_classes = false
 
   # asset host
-  config.action_controller.asset_host = 'http://' + Socket.ip_address_list[1].ip_address + ':3000'
+  # There are two cases for dev asset_host to be aware of:
+  #
+  # "localhost"/127.0.0.1 ... when developing locally
+  # remote domainname/IP ... when developing on a remote server
+  this_server = Socket.ip_address_list[1]
+  this_server_hostname = this_server.getnameinfo[0] == 'localhost' ? 'localhost' : this_server.ip_address
+  config.action_controller.asset_host = 'http://' + this_server_hostname + ':3000'
   config.action_mailer.asset_host = config.action_controller.asset_host
 
   # Do not eager load code on boot.

config/initializers/devise.rb

@@ -59,7 +59,7 @@
   # given strategies, for example, `config.http_authenticatable = [:database]` will
   # enable it only for database authentication. The supported strategies are:
   # :database      = Support basic authentication with authentication key + password
-  # config.http_authenticatable = false
+  config.http_authenticatable = false
 
   # If http headers should be returned for AJAX requests. True by default.
   # config.http_authenticatable_on_xhr = true

config/initializers/kaminari_config.rb

@@ -0,0 +1,10 @@
+Kaminari.configure do |config|
+  config.default_per_page = 100
+  config.max_per_page = 1000
+  # config.window = 4
+  # config.outer_window = 0
+  # config.left = 0
+  # config.right = 0
+  # config.page_method_name = :page
+  # config.param_name = :page
+end

config/routes.rb

@@ -19,4 +19,13 @@
   resource :things
   mount RailsAdmin::Engine => '/admin', :as => 'rails_admin'
   root to: 'main#index'
+
+  # API
+  scope '/api' do
+    scope '/v1' do
+      scope '/drains' do
+        get '/adopted' => 'adopted#index'
+      end
+    end
+  end
 end

db/seeds.rb

@@ -1,14 +1,8 @@
 User.where(email: '[email protected]').first_or_initialize.tap do |user|
+  # Add a mock user with admin privileges
   user.first_name = 'John'
   user.last_name = 'Doe'
   user.password = 'password'
-  user.save!
-end
-
-User.where(email: '[email protected]').first_or_initialize.tap do |user|
-  user.first_name = 'Jane'
-  user.last_name = 'Doe'
-  user.password = 'password'
   user.admin = true
   user.save!
 end
@@ -24,3 +18,14 @@
     thing.save!
   end
 end
+
+1000.times do |i|
+  first_name = Faker::Name.first_name
+  last_name = Faker::Name.last_name 
+  email = "user-#{i+1}@usertest.org"
+  password = "pass1234"
+  User.create!(first_name: first_name,
+               last_name: last_name,
+               email: email,
+               password: password)
+end

lib/tasks/data.rake

@@ -17,9 +17,7 @@ namespace :data do
     ENV['MAXIMUM_MOVEMENT_IN_FEET'] || raise('$MAXIMUM_MOVEMENT_IN_FEET required')
 
     adoption_deletion_from = Time.zone.parse(ENV['ADOPTION_DELETION_FROM'])
-
     moved_adoptions = AdoptionMover.move_close_deleted_adoptions(adoption_deletion_from, ENV['MAXIMUM_MOVEMENT_IN_FEET'])
-
     CSV($stdout) do |csv|
       csv << %w[from to]
       moved_adoptions.each do |from, to|
@@ -28,3 +26,21 @@ namespace :data do
     end
   end
 end
+
+namespace :modify do
+  task auto_adopt: :environment do
+    # Make random users adopt drains to test server load when generating API data
+    # There has to be users in DB for this to work
+    if Rails.env.production?
+      puts "Can't run this in production"
+    else
+      Thing.first(1000).each_with_index do |t, i|
+        if t.user_id.blank?
+          t.user_id = User.order('RANDOM()').limit(1).first.id
+          t.save
+        end
+        puts i.to_s + ' Adopting a drain'
+      end
+    end
+  end
+end

test/controllers/adopted_controller_test.rb

@@ -0,0 +1,62 @@
+require 'test_helper'
+require 'rake'
+
+class AdoptedControllerTest < ActionController::TestCase
+  setup do
+    request.env['devise.mapping'] = Devise.mappings[:user]
+    @user = users(:erik)
+    @user2 = users(:dan)
+    @admin = users(:admin)
+    @thing = things(:thing_1)
+    @thing2 = things(:thing_2)
+
+    @thing.user_id = @user.id
+    @thing2.user_id = @user2.id
+    @thing.save
+    @thing2.save
+  end
+
+  test 'should get index' do
+    @request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials(@user.email, 'correct')
+
+    get :index
+    assert_response :success
+  end
+
+  test 'should get json' do
+    @request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials(@admin.email, 'correct')
+
+    get :index
+    assert_equal 'application/json', @response.content_type
+  end
+
+  test 'only admins get access' do
+    @request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials(@user.email, 'correct')
+
+    get :index
+    assert_equal 'text/html', @response.content_type # If user were an admin, content_type would be JSON, since that is default
+  end
+
+  test 'drain data is correct' do
+    @request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials(@admin.email, 'correct')
+    get :index
+    random_drain = JSON.parse(@response.body)['drains'].first
+    drain = Thing.find_by(city_id: random_drain['city_id'].gsub('N-', ''))
+
+    assert_not_nil drain
+    assert_equal drain.lat.to_s, random_drain['latitude']
+    assert_equal drain.lng.to_s, random_drain['longitude']
+  end
+
+  test 'page counts' do
+    Rails.application.load_seed # Seed the user with users and drains
+    Rake::Task['modify:auto_adopt'].invoke # Adopt the seeded drains with seeded users
+    @request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials(@admin.email, 'correct')
+    get :index
+    json = JSON.parse(@response.body)
+
+    assert_equal json['next_page'], 2
+    assert_equal json['prev_page'], -1
+    assert_equal json['total_pages'], 5 # Should be 5 - default drains per page is 100 and we seeded the DB with 500
+  end
+end