forked from DMPRoadmap/roadmap
-
Notifications
You must be signed in to change notification settings - Fork 1
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
Create GET "/api/ca_dashboard/stats"
endpoint
#852
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# frozen_string_literal: true | ||
|
||
module Api | ||
module CaDashboard | ||
# Handles CRUD operations for "/api/ca_dashboard/stats" | ||
class StatsController < Api::V1::BaseApiController | ||
# Allow public access / bypass JWT authentication via "POST /api/v1/authenticate" | ||
skip_before_action :authorize_request, only: [:index] | ||
|
||
# GET /api/ca_dashboard/stats | ||
def index | ||
base_hash = { | ||
'plans' => Plan.all, | ||
'orgs' => Org.where(managed: true).all, | ||
'users' => User.all | ||
} | ||
@totals = { | ||
'all_time' => all_time_counts(base_hash), | ||
'last_30_days' => last_30_days_counts(base_hash) | ||
} | ||
begin | ||
@totals['custom_range'] = custom_range_counts(base_hash) if date_params_present? | ||
render 'api/ca_dashboard/stats/index', status: :ok | ||
rescue ArgumentError | ||
error_msg = _('Invalid date format. please use YYYY-MM-DD when supplying `start` or `end` params.') | ||
render_error(errors: [error_msg], status: :bad_request) | ||
end | ||
end | ||
|
||
private | ||
|
||
def all_time_counts(base_hash) | ||
base_hash.transform_values(&:count) | ||
end | ||
|
||
def last_30_days_counts(base_hash) | ||
base_hash.transform_values do |scope| | ||
scope.where('created_at >= ?', 30.days.ago).count | ||
end | ||
end | ||
|
||
def custom_range_counts(base_hash) | ||
start_date = parse_date(params[:start]) | ||
end_date = parse_date(params[:end]) | ||
base_hash.transform_values do |scope| | ||
scope.where(created_at: start_date..end_date).count | ||
end | ||
end | ||
|
||
def date_params_present? | ||
params[:start].present? || params[:end].present? | ||
end | ||
|
||
def parse_date(date_string) | ||
Date.strptime(date_string, '%Y-%m-%d') if date_string.present? | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# frozen_string_literal: true | ||
|
||
json.partial! 'api/v1/standard_response' | ||
json.stats do | ||
json.totals @totals | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Just a quick question @aaronskiba , why do we have the value
"total_items": 0,
in the resulting json output?Is that something we need ?
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.
Good question; I guess that's just being inherited from
api/v1/standard_response
. I think it corresponds to the number of plans returned, which would always be zero for this new API endpoint:I guess it does a similar thing when I check
api/v1/heartbeat
:Here's an API request for a specific plan: