routes.jl

using PkgVizBoard.DashboardController, PkgVizBoard.StatsController
using Genie, Stipple, StippleUI, StipplePlotly
using SwagUI, SwaggerMarkdown

#=== constants ==#

const ALL_REGIONS = "all"
const REGIONS = String[ALL_REGIONS, "au", "cn-east", "cn-northeast", "cn-southeast", "eu-central", "in", "jp", "kr", "sa", "sg", "us-east", "us-west"]

const DAY = "day"
const MONTH = "month"
const YEAR = "year"

#=== config ==#

if Genie.Configuration.isprod()
  Genie.Assets.assets_config!([Genie, Stipple, StippleUI, StipplePlotly], host = "https://cdn.statically.io/gh/GenieFramework")
end

#== server ==#

route("/", PkgVizBoard.DashboardController.dashboard)

swagger"""
/api/v1/regions:
  get:
    summary: Get regions
    description: Get regions
    responses:
      '200':
        description: Returns a JSON object with all the regions
"""
route("/api/v1/regions", PkgVizBoard.StatsController.API.V1.regions, method = GET)

swagger"""
/api/v1/packages:
  get:
    summary: Get the list of packages
    description: Get the list of packages
    responses:
      '200':
        description: Returns a JSON object with all the packages
"""
route("/api/v1/packages", PkgVizBoard.StatsController.API.V1.packages, method = GET)

swagger"""
/api/v1/stats:
  get:
    summary: Query the download stats
    description: Query the download stats
    parameters:
      - in: query
        name: packages
        description: A list of package names
        schema:
          type: array
          items:
            type: string
          example: ['Genie', 'Stipple']
      - in: query
        name: regions
        description: A list of regions
        schema:
          type: array
          items:
            type: string
          example: ['eu-central', 'us-west']
      - in: query
        name: startdate
        schema:
          type: string
          format: date
          example: '2021-12-30'
        description: The start date
      - in: query
        name: enddate
        schema:
          type: string
          format: date
          example: '2022-01-15'
        description: The end date
    responses:
      '200':
        description: Returns a JSON object with all the download stats
  post:
    summary: Query the download stats
    description: Query the download stats
    parameters:
      - in: query
        name: packages
        description: A list of package names
        schema:
          type: array
          items:
            type: string
          example: ['Genie', 'Stipple']
      - in: query
        name: regions
        description: A list of regions
        schema:
          type: array
          items:
            type: string
          example: ['eu-central', 'us-west']
      - in: query
        name: startdate
        schema:
          type: string
          format: date
          example: '2021-12-30'
        description: The start date
      - in: query
        name: enddate
        schema:
          type: string
          format: date
          example: '2022-01-15'
        description: The end date
    responses:
      '201':
        description: Returns a JSON object with all the download stats
"""
[route("/api/v1/stats", PkgVizBoard.StatsController.API.V1.search, method = m) for m in [GET, POST]]

swagger"""
/api/v1/badge/{packages}:
  get:
    summary: Get badge
    description: Get badge
    parameters:
      - in: path
        name: packages
        required: true
        schema:
          type: string
          example: 'Genie'
    responses:
      '200':
        description: Returns a badge
"""
route("/api/v1/badge/:packages", PkgVizBoard.StatsController.API.V1.badge, method = GET)

swagger"""
/api/v1/badge/{packages}/{options}:
  get:
    summary: Get badge
    description: Get badge
    parameters:
      - in: path
        name: packages
        required: true
        schema:
          type: string
          example: 'Genie'
      - in: path
        name: options
        required: true
        schema:
          type: string
    responses:
      '200':
        description: Returns a badge
"""
route("/api/v1/badge/:packages/:options", PkgVizBoard.StatsController.API.V1.badge, method = GET, named = :get_api_v1_badge_packages_options)

route("/docs") do
  render_swagger(
    build(
      OpenAPI("3.0",
              Dict( "title" => "PkgVizBoard API",
                    "version" => "1.0.5")
              )
    ),
    options = Options(
      custom_favicon = "/favicon.ico",
      custom_site_title = "Package download stats for Julia - Swagger",
      show_explorer = false
    )
  )
end