root.go

package http

import (
	"encoding/json"
	"fmt"
	"net/http"

	"github.com/18F/e-QIP-prototype/api"
)

var (
	// APIName ...
	APIName = "eqip"

	// APIVersion ...
	APIVersion = "v1"
)

type endpoint struct {
	Path        string
	Description string
	Verbs       []string
}

// RootHandler is the handler for the root endpoint.
type RootHandler struct {
	Env api.Settings
}

// ServeHTTP accepts GET requests to get all endpoints that the API
// supports.
func (service RootHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	w.Header().Set("X-Eqip-Media-Type", fmt.Sprintf("%s.%s", APIName, APIVersion))
	w.Header().Set("Content-Type", "application/json")

	// Core set of endpoints
	endpoints := []endpoint{
		{
			Path:        "/",
			Description: "root",
			Verbs:       []string{"GET"},
		},
		{
			Path:        "/refresh",
			Description: "web token refresh",
			Verbs:       []string{"POST"},
		},
		{
			Path:        "/me",
			Description: "me",
			Verbs:       []string{"GET"},
		},
		{
			Path:        "/me/logout",
			Description: "end session for account",
			Verbs:       []string{"GET"},
		},
		{
			Path:        "/me/validate",
			Description: "validation",
			Verbs:       []string{"POST"},
		},
		{
			Path:        "/me/save",
			Description: "save",
			Verbs:       []string{"POST", "PUT"},
		},
		{
			Path:        "/me/form",
			Description: "returns the form in its entirety",
			Verbs:       []string{"GET"},
		},
		{
			Path:        "/me/form/hash",
			Description: "returns the form hash code",
			Verbs:       []string{"GET"},
		},
		{
			Path:        "/me/section?:id",
			Description: "returns the form section",
			Verbs:       []string{"GET"},
		},
	}

	if service.Env.True(api.AttachmentsEnabled) {
		attachments := []endpoint{
			{
				Path:        "/me/attachment",
				Description: "store attachment",
				Verbs:       []string{"POST", "PUT"},
			},
			{
				Path:        "/me/attachment/:id",
				Description: "get attachment",
				Verbs:       []string{"GET"},
			},
			{
				Path:        "/me/attachment/:id/delete",
				Description: "delete attachment",
				Verbs:       []string{"POST", "DELETE"},
			},
		}
		endpoints = append(endpoints, attachments...)
	}

	if service.Env.True(api.BasicEnabled) {
		basic := []endpoint{
			{
				Path:        "/auth/basic",
				Description: "basic authentication",
				Verbs:       []string{"POST"},
			},
		}
		endpoints = append(endpoints, basic...)
	}

	if service.Env.True(api.SamlEnabled) {
		saml := []endpoint{
			{
				Path:        "/auth/saml",
				Description: "SAML entrypoint",
				Verbs:       []string{"GET"},
			},
			{
				Path:        "/auth/saml/callback",
				Description: "SAML callback",
				Verbs:       []string{"GET", "POST"},
			},
		}
		endpoints = append(endpoints, saml...)
	}

	json.NewEncoder(w).Encode(struct {
		Endpoints []endpoint `json:"endpoints"`
	}{
		Endpoints: endpoints,
	})
}