naptime

Type Members

trait DangerousAccessToUnderlyingRequest extends AnyRef
sealed trait ETag extends AnyRef

Resources should always use weak validators because Naptime does not guarantee byte-equality between responses.
Resources should always use weak validators because Naptime does not guarantee byte-equality between responses. See ETag.Weak.
trait Errors extends AnyRef

Error responses.
Error responses. Note: these error responses work by throwing special exceptions that are caught by the framework. They are not designed to work outside the framework.
case class FacetField(facetEntries: Seq[FacetFieldValue], fieldCardinality: Option[Long]) extends Product with Serializable

Contains all of the information relating to a facet in a sophisticated search.
Contains all of the information relating to a facet in a sophisticated search.
facetEntries
An ordered (potentially partial) list of facet entries.
fieldCardinality
Not all potential values for this facet may be included. The fieldCardinality is the count of all possible different values for this facet.
case class FacetFieldValue(id: String, name: Option[String], count: Long) extends Product with Serializable

Information about one particular choice of value for one particular facet.
Information about one particular choice of value for one particular facet.
id
The id or code for this facet value.
name
The display name for this facet value.
count
The number of results for this facet.
sealed case class Fields[T](defaultFields: Set[String], fieldsPermissionsFunction: FieldsFunction, relations: Map[String, ResourceName], reverseRelations: Map[String, ReverseRelation])(implicit format: OFormat[T]) extends Product with Serializable

Contains all the required information related to a resource's fields.
Contains all the required information related to a resource's fields.
T
The type of the resource in the collection.
defaultFields
The default fields that should be included in a response.
fieldsPermissionsFunction
A function that, given a request header, determines if particular fields are to be included in the response. This function can be used to hide particular fields depending on arbitrary information about the request. (e.g. Sensitive fields can be made unavailable in certain contexts. (e.g. CORS, 3rd party requests to APIs, JSONP, etc.) IMPORTANT NOTE: this functionality is not fully implemented yet! WORK IN PROGRESS. DO NOT USE YET!
relations
A map of field name to related resource's name and version pair. This configuration is used to automatically join related resources as requested. For example, if we have an "author" id field that references the "userBasicProfile" v1 resource, and a "post" id field that references a "discoursePost" v1 the map would look like: Map("author" -> ("userBasicProfile", 1), "post" -> ("discoursePost", 1)).
format
The JSON serialization formatter for the resource.

Annotations
@implicitNotFound( ... )
sealed trait FieldsFunction extends (RequestHeader, QueryFields) ⇒ QueryFields
case class FinderReverseRelation(resourceName: ResourceName, finderName: String, arguments: Map[String, String] = Map.empty, description: String = "") extends ReverseRelation with Product with Serializable
case class GetReverseRelation(resourceName: ResourceName, id: String, arguments: Map[String, String] = Map.empty, description: String = "") extends ReverseRelation with Product with Serializable
case class MultiGetReverseRelation(resourceName: ResourceName, ids: String, arguments: Map[String, String] = Map.empty, description: String = "") extends ReverseRelation with Product with Serializable
case class NaptimeActionException(httpCode: Int, errorCode: Option[String], message: Option[String], details: Option[JsValue] = None) extends RuntimeException with Product with Serializable

Throw to break out of a Naptime action body on error.
trait NaptimeModule extends BinderExposer with ScalaModule

Inherit from this trait to bind resources and schema types.
Inherit from this trait to bind resources and schema types.
Naptime builds upon Guice to discover and find all resources in the service, as well as to discover the reverse mappings from high-level class types to their wire representations.
final case class Ok[+T](content: T, related: Map[ResourceName, Related[_, _]] = Map.empty, pagination: Option[ResponsePagination] = None, eTag: Option[ETag] = None) extends RestResponse[T] with Product with Serializable
case class PaginationConfiguration(defaultLimit: Int = 100) extends Product with Serializable

Configure the defaults for pagination.
final case class Redirect(url: String, isTemporary: Boolean) extends RestResponse[Nothing] with Product with Serializable
sealed trait RequestEvidence extends NotNull

Marker trait to try and hide access to the underlying Play request.
Marker trait to try and hide access to the underlying Play request.

Annotations
@implicitNotFound( ... )
trait RequestFields extends AnyRef

Passed to Resources so if there are certain fields that require more work to fetch, they can skip that work if the request does not include it.
Passed to Resources so if there are certain fields that require more work to fetch, they can skip that work if the request does not include it.
Note: the API is intentionally severely constrained to allow for future flexibility and internal changes to the Naptime framework.
trait RequestIncludes extends AnyRef

Passed to Resources so if there are certain related objects that require more work to fetch, they can skip that work if the request does not ask for those related resources.
Passed to Resources so if there are certain related objects that require more work to fetch, they can skip that work if the request does not ask for those related resources.
Note: the API is intentionally severely constrained to allow for future flexibility and internal changes to the Naptime framework.
case class RequestPagination(limit: Int, start: Option[String], isDefault: Boolean) extends Product with Serializable

Calculates the request pagination.
Calculates the request pagination.
TODO: URL-safe base64 encoding
case class ResourceName(topLevelName: String, version: Int, resourcePath: Seq[String] = List.empty) extends Product with Serializable

The structured name + version + path of a resource.
The structured name + version + path of a resource.
topLevelName
The first top level name.
version
The version of the top level resource.
resourcePath
The names of path selectors.
case class ResponsePagination(next: Option[String], total: Option[Long] = None, facets: Option[Map[String, FacetField]] = None) extends Product with Serializable

If there are subsequent pages, include a next 'pointer'.
If there are subsequent pages, include a next 'pointer'. This is opaque to clients.
TODO: consider base64 encoding over the wire for safety.
facets
If present, a map of field name to facet information.
class RestContext[+AuthType, +BodyType] extends AnyRef

All the contextual information about a naptime request.
final case class RestError(error: NaptimeActionException) extends RestResponse[Nothing] with Product with Serializable
sealed abstract class RestResponse[+T] extends AnyRef
trait ReverseRelation extends AnyRef
case class SingleElementFinderReverseRelation(resourceName: ResourceName, finderName: String, arguments: Map[String, String] = Map.empty, description: String = "") extends ReverseRelation with Product with Serializable

Value Members

object ETag
object Errors extends Errors
object FacetField extends Serializable
object FacetFieldValue extends Serializable
object Fields extends Serializable
object FieldsFunction
object NaptimeActionException extends Serializable
object NaptimeModule extends AbstractModule with ScalaModule

Install this singleton module into your service to configure Naptime defaults to ensure a successful boot.
Install this singleton module into your service to configure Naptime defaults to ensure a successful boot.
```
install(NaptimeModule)
```
Note: as of writing this comment, there is no need to install this module in your service for correct operation.
object Ok extends Serializable
object RequestFields
object RequestPagination extends Serializable
object ResourceName extends Serializable
object ResponsePagination extends Serializable
object SchemaUtils

Helpers for working with Courier/Pegasus Schemas.
object Types extends StrictLogging
package access
package actions

package ari

This ari defines the key abstractions for automatic resource inclusion as well as GraphQL.

The system is split up into 3 distinct layers:

+---------------------------------------------------------------------+
|                       Presentation Layer                            |
|           GraphQL            |            Naptime HTTP              |
+------------------------------+--------------------------------------+
|                                                                     |
|                      Inclusion Engine                               |
|                                                                     |
+---------------------------------------------------------------------+
|                        Data fetching                                |
|         Local execution      |           remote execution           |
+=====================================================================+
|                                                                     |
|                   Unmodified Naptime APIs                           |
|                                                                     |
+---------------------------------------------------------------------+

A request enters the system via the presentation layer (typically parsed from the network). The presentation layer constructs a org.coursera.naptime.ari.Request and passes that to engine. The engine performs a number of validations against the schema, and then makes a number of requests to to the Data Fetching layer to assemble all of the (available) data required to construct a response. This is passed back to the presentation layer, which constructs a response to be sent out on the wire.

The API between the presentation layer and the inclusion engine is the org.coursera.naptime.ari.EngineApi

The API between the inclusion engine and the data fetching layer is defined by org.coursera.naptime.ari.FetcherApi.

BEWARE: This code is currently in a high state of flux. Do not depend upon it unless you are prepared for breakages!

package exceptions
package path
package resources
package router2
package schema

package naptime

Type Members

trait DangerousAccessToUnderlyingRequest extends AnyRef

sealed trait ETag extends AnyRef

trait Errors extends AnyRef

case class FacetField(facetEntries: Seq[FacetFieldValue], fieldCardinality: Option[Long]) extends Product with Serializable

case class FacetFieldValue(id: String, name: Option[String], count: Long) extends Product with Serializable

sealed case class Fields[T](defaultFields: Set[String], fieldsPermissionsFunction: FieldsFunction, relations: Map[String, ResourceName], reverseRelations: Map[String, ReverseRelation])(implicit format: OFormat[T]) extends Product with Serializable

sealed trait FieldsFunction extends (RequestHeader, QueryFields) ⇒ QueryFields

case class FinderReverseRelation(resourceName: ResourceName, finderName: String, arguments: Map[String, String] = Map.empty, description: String = "") extends ReverseRelation with Product with Serializable

case class GetReverseRelation(resourceName: ResourceName, id: String, arguments: Map[String, String] = Map.empty, description: String = "") extends ReverseRelation with Product with Serializable

case class MultiGetReverseRelation(resourceName: ResourceName, ids: String, arguments: Map[String, String] = Map.empty, description: String = "") extends ReverseRelation with Product with Serializable

case class NaptimeActionException(httpCode: Int, errorCode: Option[String], message: Option[String], details: Option[JsValue] = None) extends RuntimeException with Product with Serializable

trait NaptimeModule extends BinderExposer with ScalaModule

final case class Ok[+T](content: T, related: Map[ResourceName, Related[_, _]] = Map.empty, pagination: Option[ResponsePagination] = None, eTag: Option[ETag] = None) extends RestResponse[T] with Product with Serializable

case class PaginationConfiguration(defaultLimit: Int = 100) extends Product with Serializable

final case class Redirect(url: String, isTemporary: Boolean) extends RestResponse[Nothing] with Product with Serializable

sealed trait RequestEvidence extends NotNull

trait RequestFields extends AnyRef

trait RequestIncludes extends AnyRef

case class RequestPagination(limit: Int, start: Option[String], isDefault: Boolean) extends Product with Serializable

case class ResourceName(topLevelName: String, version: Int, resourcePath: Seq[String] = List.empty) extends Product with Serializable

case class ResponsePagination(next: Option[String], total: Option[Long] = None, facets: Option[Map[String, FacetField]] = None) extends Product with Serializable

class RestContext[+AuthType, +BodyType] extends AnyRef

final case class RestError(error: NaptimeActionException) extends RestResponse[Nothing] with Product with Serializable

sealed abstract class RestResponse[+T] extends AnyRef

trait ReverseRelation extends AnyRef

case class SingleElementFinderReverseRelation(resourceName: ResourceName, finderName: String, arguments: Map[String, String] = Map.empty, description: String = "") extends ReverseRelation with Product with Serializable

Value Members

object ETag

object Errors extends Errors

object FacetField extends Serializable

object FacetFieldValue extends Serializable

object Fields extends Serializable

object FieldsFunction

object NaptimeActionException extends Serializable

object NaptimeModule extends AbstractModule with ScalaModule

object Ok extends Serializable

object RequestFields

object RequestPagination extends Serializable

object ResourceName extends Serializable

object ResponsePagination extends Serializable

object SchemaUtils

object Types extends StrictLogging

package access

package actions

package ari

package exceptions

package path

package resources

package router2

package schema

Ungrouped