-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
236 simple api #241
base: main
Are you sure you want to change the base?
236 simple api #241
Changes from 11 commits
1ad6247
900eae4
43f7697
3b65084
69d6af7
b1b4305
91b0e3b
7371587
15fae71
7287643
160a045
0b4dab3
ceca853
b8fff22
88a33a7
b893346
973efac
5f868d1
5772058
da2f4b1
01c0719
343a600
78c0c75
cfeba19
417c95f
2953cf3
e24cea2
dcc6277
e66a624
4032d8d
c375680
ea959a8
57f6f42
739d86c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/ |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
class AdoptedController < ApplicationController | ||
before_action :authenticate | ||
|
||
def index | ||
@things = Thing.where.not(user_id: !nil) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think you want Interestingly -- not that anyone cares -- There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this is true, good catch |
||
render_types | ||
end | ||
|
||
private | ||
|
||
def render_types | ||
respond_to do |format| | ||
format.csv do | ||
headers['Content-Type'] ||= 'text/csv' | ||
headers['Content-Disposition'] = 'attachment; filename=\'adopted_drains.csv\'' | ||
end | ||
format.xml { render xml: format_fields(@things) } | ||
format.all { render json: format_fields(@things) } | ||
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 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
module AdoptedHelper | ||
end |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
<%- headers = ['Lat', 'Lng', 'City ID'] -%> | ||
<%= CSV.generate_line headers %> | ||
<%- @things.each do |thing| -%> | ||
<%= CSV.generate_line([thing.lat, thing.lng, "N-" + thing.city_id.to_s]) -%> | ||
<%- end -%> |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why was this uncommented? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Never mind, I see that the API is locked to authenticated users. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. cool |
||
|
||
# If http headers should be returned for AJAX requests. True by default. | ||
# config.http_authenticatable_on_xhr = true | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,4 +19,13 @@ | |
resource :things | ||
mount RailsAdmin::Engine => '/admin', :as => 'rails_admin' | ||
root to: 'main#index' | ||
|
||
# API | ||
scope '/api' do | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 to the URL pathing here |
||
scope '/v1' do | ||
scope '/drains' do | ||
get '/adopted' => 'adopted#index' | ||
end | ||
end | ||
end | ||
end |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,7 @@ | |
|
||
r = Random.new | ||
|
||
=begin | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Did you mean to leave this commented? |
||
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 | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
require 'test_helper' | ||
|
||
class AdoptedControllerTest < ActionController::TestCase | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I like checking the content-type, but could we make a few assertions on the response content to make sure the right records are returned? It'd also be nice to exercise the paging logic a little here. |
||
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need an exact version here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed that to have the version ~> 1.7.0... These are the sure compatible versions, not sure if they will change support in the future.