236 simple api

Gemfile

@@ -3,6 +3,7 @@ ruby '2.2.3'
 
 gem 'dotenv-rails', groups: [:development, :test]
 gem 'rails', '~> 4.2.4'
+gem 'faker', '1.7.3'
 gem 'airbrake', '~> 5.2'
 gem 'devise'
 gem 'geokit'
@@ -25,6 +26,7 @@ end
 group :development do
   gem 'byebug'
   gem 'spring'
+  gem 'kaminari'
 end
 
 group :production do

Gemfile.lock

@@ -75,6 +75,8 @@ GEM
       railties (>= 4.0, < 5.1)
     erubis (2.7.0)
     execjs (2.6.0)
+    faker (1.7.3)
+      i18n (~> 0.5)
     font-awesome-rails (4.5.0.1)
       railties (>= 3.2, < 5.1)
     geokit (1.10.0)
@@ -233,9 +235,11 @@ DEPENDENCIES
   coveralls
   devise
   dotenv-rails
+  faker (= 1.7.3)
   geokit
   haml
   http_accept_language
+  kaminari
   local_time
   obscenity (~> 1.0, >= 1.0.2)
   paranoia (~> 2.2)
@@ -258,4 +262,4 @@ RUBY VERSION
    ruby 2.2.3p173
 
 BUNDLED WITH
-   1.13.7
+   1.15.3

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,57 @@
+class AdoptedController < ApplicationController
+  before_action :authenticate
+  before_action :make_cur_page, :make_other_pages, only: [:index]
+
+  # GET /api/v1/drains/adopted
+  # Optional params:
+  #
+  #  format=[json|xml|csv]
+  #  page
+  def index
+    @results = {next_page: @next_page, prev_page: @prev_page, drains: @things}
+    render_types
+  end
+
+private
+
+  # Determine if the user supplied a valid page number, if not they get first page
+  def make_cur_page
+    page = params[:page].blank? ? 2 : params[:page]
+    @cur_page = Thing.where.not(user_id: nil).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? ? 0 : @cur_page.next_page
+    @prev_page = @cur_page.prev_page.nil? ? 0 : @cur_page.prev_page
+  end
+
+  def render_types
+    respond_to do |format|
+      format.csv do
+        headers['Content-Type'] ||= 'text/csv'
+        headers['Content-Disposition'] = 'attachment; filename=\'adopted_drains.csv\''
+
+        # Assuming that a CSV was requested in order to retrieve all results at once
+        @allthings = Thing.where.not(user_id: nil)
+      end
+      format.xml { render xml: @results }
+      format.all { render json: @results }
+    end
+  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>'.html_safe
+      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

app/views/adopted/index.csv.erb

@@ -0,0 +1,5 @@
+<%- headers = ['Lat', 'Lng', 'City ID'] -%>
+<%= CSV.generate_line headers %>
+<%- @allthings.each do |thing| -%>
+<%= CSV.generate_line([thing.lat, thing.lng, "N-" + thing.city_id.to_s]) -%>
+<%- end -%>

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 = 1000
+  # config.max_per_page = nil
+  # 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

@@ -6,6 +6,7 @@
 
 r = Random.new
 
+=begin
 500.times do |i|
   Thing.where(city_id: i).first_or_initialize.tap do |thing|
     thing.name = "Some Drain #{i}"
@@ -15,3 +16,18 @@
     thing.save!
   end
 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

@@ -6,4 +6,18 @@ namespace :data do
 
     ThingImporter.load('https://data.sfgov.org/api/views/jtgq-b7c5/rows.csv?accessType=DOWNLOAD')
   end
+
+  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
+
+    unless Rails.env.production?
+      Thing.first(10_000).each do |t|
+        if t.user_id.blank?
+          t.user_id = User.find_by('id' => Random.rand(1..User.last.id)).id
+          t.save
+        end
+      end
+    end
+  end
 end

test/controllers/adopted_controller_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class AdoptedControllerTest < ActionController::TestCase
+  setup do
+    request.env['devise.mapping'] = Devise.mappings[:user]
+    @user = users(:erik)
+    @admin = users(:admin)
+  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, format: :json
+    assert_equal 'application/json', @response.content_type
+  end
+
+  test 'should get xml' do
+    @request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials(@admin.email, 'correct')
+
+    get :index, format: :xml
+    assert_equal 'application/xml', @response.content_type
+  end
+
+  test 'should get csv' do
+    @request.env['HTTP_AUTHORIZATION'] = ActionController::HttpAuthentication::Basic.encode_credentials(@admin.email, 'correct')
+
+    get :index, format: :csv
+    assert_equal 'text/csv', @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
+end