brecht-vde / soundforest Goto Github PK

Description

A user should be able to see a list of already exported playlists

Technical Requirements

Prerequisites

• AZ Table Storage is setup

API Tech

• Azure Functions (HTTP trigger)

API Specification

Endpoint
/api/playlists

Method
GET

Response Codes

• 200: query returned results
• 404: query did not return results
• 401: authorization header missing or invalid
• 500: any unexpected server side error

Response format

{
	"total": 3,
	"results": [
		...,
		{
			"identifier": "tt1234567",
			"title": "Some cool movie",
                        "playlistTitle": "Some playlist title",
                        "playlistUri": "http://spotify.com/someplaylist"
		},
		...
	]
}

Example
/api/playlists

Acceptance Criteria

• The API endpoint is available and complies with the API specification (https://www.notion.so/API-Specifications-2721e795a59740ef9cb1ceea915bc678).

Description

A user should be able to a list of exports they've requested

Technical Requirements

Prerequisites

• AZ Table Storage is provisioned
• AZ Service Bus is provisioned
• Spotify API is properly linked via M2M auth

API Tech

• Azure Functions (HTTP trigger)
• Azure Functions (Service Bus trigger)

API Specification

Endpoint
/api/exports

Response Codes

• 200: return results
• 404: no results found
• 401: authorization header missing or invalid
• 500: any unexpected server side error

Response format

{
	"total": 3,
	"results": [
		...,
		{
			"identifier": "tt1234567",
			"title": "Some cool movie",
                        "url": "http://spotify.com/someplaylist",
                        "status": "completed|pending|inprogress|failed",
                        "reason": "Any error or status message"
		},
		...
	]
}

Example
/api/exports

Acceptance Criteria

• The API endpoint is available and complies with the API specification (https://www.notion.so/API-Specifications-2721e795a59740ef9cb1ceea915bc678).

Description

A user must be able to login to the web application using their Spotify account.
A user must be able to logout of the web application

• Spotiwood.Integrations.Omdb project should just return raw response, without mapping yet
• Dto's should be removed, okay to just map directly to domain classes (in infra project)
• Used PagedCollection directly

Description

API project will consist of multiple Azure Functions projects, to mimic the "API Management" feature on Azure, we can use nginx to create a reverse proxy, so all azure functions are externally available through the same address, despite running on different addresses internally.

Acceptance Criteria

All API functions are available through a single address.

• Spotiwood.Api.SearchDetails project should be merged with Spotiwood.Api.Search
• Spotiwood.Api.SearchDetails.UnitTests project should be merged with Spotiwood.Api.Search.UnitTests

Currently UI project uses a NotFound record to indicate a playlist was not found.
Instead of calling the playlistdetails endpoint and parsing the status code, there should just be a playlistexists endpoint with a valid response structure to indicate if a record exists.

Description

Projects should be containerized, to more easily run specific parts or orchestrate the whole thing on a local environment

Acceptance Criteria

Each project can be built as a container or ran via e.g. docker compose

• BaseClient Constructor guards need to be refactored using fixture or other
• Duplicate mapping should be removed, map directly to domain classes instead (this mapping happens in infra project)
• Add proper mappers
• Properly namespace CosmosQueryBuilder etc.

• Refactor component & page layouts (what's truly reusable and what isn't)
• Make app mobile friendly
• Revise messaging events & framework
• Add state management
• Make proper api integration client

Description

The API must be protected, so only authorized users can make requests. This should be done via a JWT token in the Authorization header of each request.

Technical Requirements

An Auth0 account must be setup, JWT tokens will be validated against the Auth0 instances.

Acceptance Criteria

When a user makes a request to the API they must:

• Receive 401 Unauthorized in case the JWT token is invalid or missing
• Receive a success code response in case the user provided a valid JWT token

Description

A user should be able to fetch more details of a movie or series via its identifier.

Technical Requirements

Prerequisites

• OMDb account must be setup
• OMDb account api key must be protected
• OMDb should only be used in the back end system

API Tech

• Azure Functions (HTTP trigger)

API Specification

Endpoint
/api/search/{someid}

Response Codes

• 200: query returned results
• 400: invalid query parameters
• 404: query did not return results
• 401: authorization header missing or invalid
• 500: any unexpected server side error

Response format

* = optional field

{
	"identifier": "tt1234567",
	"type": "movie|series",
	"title": "Some movie or series",
	"plot*": "Some movie or series plot",
	"poster*": "Image which belongs to a movie or series",
	"seasons*": 7,
	"year": 2010,
	"endYear*": 2020,
	"actors*": ["name1", "name2", "name3"],
	"genres*": ["name1", "name2", "name3"]
}

Example
/api/search/{identifier}

Acceptance Criteria

• The API endpoint is available and complies with the API specification (https://www.notion.so/API-Specifications-2721e795a59740ef9cb1ceea915bc678).

Description

A user should be able to see a list of all exported playlists that are available

Description

• A user should be able to see for which titles they requested a playlist
• A user should be able to see the status of the export job

Description

OMDb API is limited to 1000 requests per day, to decrease amount of calls, the requests to the search & details API should be cached.

Technical Requirements

• Memory cache should be added

Acceptance Criteria

• Search & details are cached in memory

• Move messages to constants class or resource
• Add unit tests for DI for pipeline behaviors
• Refactor serialization (setting default export settings)
• Change status from string to enum

Description

A user should be able to search a movie or series via some key words and browse the results (if any).

Technical Requirements

Prerequisites

• OMDb account must be setup
• OMDb account api key must be protected
• OMDb should only be used in the back end system

API Tech

• Azure Functions (HTTP trigger)

API Specification

Endpoint
/api/search

Query parameters
q

Response Codes

• 200: query returned results
• 400: invalid query parameters
• 404: query did not return results
• 401: authorization header missing or invalid
• 500: any unexpected server side error

Response format

{
	"total": 3,
	"results": [
		...,
		{
			"identifier": "tt1234567",
			"type": "movie|series",
			"title": "Some cool movie"
		},
		...
	]
}

Example
/api/search?q={keywords}

Acceptance Criteria

• The API endpoint is available and complies with the API specification

Description

A user should be able to see a single exported playlist when a movie/series identifier is requested

Technical Requirements

Prerequisites

• AZ Table Storage is setup

API Tech

• Azure Functions (HTTP trigger)

API Specification

Endpoint
/api/playlists/{someid}

Method
GET

Response Codes

• 200: query returned results
• 400: invalid request data
• 404: query did not return results
• 401: authorization header missing or invalid
• 500: any unexpected server side error

Response format

{
	"identifier": "tt1234567",
	"title": "Some cool movie",
	"playlistTitle": "Some playlist title",
	"playlistUri": "http://spotify.com/someplaylist"
}

Example
/api/playlists/tt1234567

Acceptance Criteria

• The API endpoint is available and complies with the API specification (https://www.notion.so/API-Specifications-2721e795a59740ef9cb1ceea915bc678)

Description

When a user requests an export via the API endpoint a job should be scheduled through a message queue.
A service should pick up this job from the queue and asynchronously prepare the playlist.

Technical Requirements

• AZ Service Bus is provisioned
• AZ Table Storage is provisioned
• Spotify API is setup and linked for M2M auth

Acceptance Requirements

• A playlist job can be executed
• Happy flow from pending to completed status

Description

A user must be able to navigate to a search page, in which they can enter search terms, see an overview of the results and being able to click through to the detail of a search result.