markaphillips / movie-api Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 3.24 MB

GraphQL wrapper around the Movie DB API

Home Page: https://eu-movie-api.herokuapp.com/

JavaScript 99.55% Dockerfile 0.45%

apollo-server circle-ci graphql javascript jest docker mongodb

movie-api's Introduction

Movie API

Introduction

GraphQL wrapper for the The Movie Database API.

CI/CD using Circle CI

Deployed to Heroku at https://eu-movie-api.herokuapp.com/

Installation

In project root run the following:

echo API_KEY={API_KEY} > .env

Replacing {API_KEY} with a valid api key created at the Movie Database API

echo DB_PWD={DB_PWD} >> .env

Replacing {DB_PWD} with the password created for user dbUser on MongoDB Atlas Account

Run npm i

Run & Build Locally

Run npm start

Browse to GraphQL Playground running locally and test by running the following queries exposed below.

Any changes to the code using this method force a rebuild

Run & Build with Docker

Ensure Docker is installed locally.

For MacOS review the following documentation

Run npm run start:docker

Browse to GraphQL Playground running locally

GraphQL Queries

Get Trending Movies

 query {
    trending (imageSize: "w154", period: week) {
      id
      title
      overview
      voteAverage
      popularity
      voteCount
      releaseDate
      originalLanguage
      images {
        poster
        backDrop
      }
    }
  }

period is optional and defaults to day Options are day|week

Get Popular Movies

 query {
    popular(imageSize: "w154") {
      id
      title
      overview
      voteAverage
      popularity
      voteCount
      releaseDate
      originalLanguage
      images {
        poster
        backDrop
      }
    }
  }

Get Image Configuration

query {
    imageConfiguration {
      baseUrl
      imageSizes
    }
  }

Search Movies

query {
  search(filter:{ searchText:"sharknado"}, page:1) {
    totalCount
    page
    noOfPages
    edges {
      node {
        id
        title
        overview
        voteAverage
        popularity
        voteCount
        releaseDate
        originalLanguage
        images {
          poster
          backDrop
        }
      }
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
    }
  }
}

Get a Movie By Id

 query {
    movie(id: 545609, showCast: $showCast, creditsLimit:$creditsLimit) {
      id
      title
      overview
      voteAverage
      popularity
      voteCount
      releaseDate
      originalLanguage
      runTime
      images {
        poster
        backDrop
      }
      genres {
        id
        name
      }
      homePage,
      similar {
        id
        title
      }
      recommended {
        id
        title
      }
      certifications {
        countryCode
        certification
      }
      credits {
        crew {
          id
          name
          job
        }
        cast @include(if: $showCast) {
          id
          character
          person {
            id
            name
            imageUrl
          }
        }
    }
  }

creditslimit restricts the limit for cast and crew members returned. Currently defaults to 100.

showCast defines if cast should be returned in the query.

Get a Person By Id

query{
  person(imageSize: "w154", id: 10990) {
    id
    name
    biography
    birthDate
    deathDate
    age
    imageUrl
    placeOfBirth
    credits {
      id
      character
      movie {
        title
        overview
        voteAverage
        popularity
        voteCount
        releaseDate
        originalLanguage
        images {
          poster
          backDrop
        }
      }
    }
  }
}

Recommended and similar movies can contain an array of Movie objects.

The above search pagination is a hybrid based on standard relay cursor pagination and limitations in the current MovieDB REST API.

The MovieDB REST API has a fixed page size of 20 records and requires a page number to be passed as part of the query. This therefore restricts the implementation of a pure cursor based pagination in relation to performance.

Notes

imageSize parameter can be obtained by querying the imageConfiguration end point and selecting an entry from the imageSizes property.

If no imageSizes argument is passed this defaults to original

Setting up Circle CI

Add the following Environment Variables to movie api project settings:

API_KEY - MovieDb API Key
HEROKU_API_KEY - Heroku API Key
HEROKU_APP_NAME - eu-movie-api

Add additional SSH Key for github

Hostname: github.com
Private key: see details below on how to create this

SSH Keys

As part of deployment via Circle CI need to create a ssh key to push changes to github

ssh-keygen -m PEM -t rsa -C "[email protected]"

Press enter for each option (no passphrase required as this will encrypt the key)

A key is generated in the following file id_rsa.pub (public) and id_rsa (private)

Run ls -al ~/.ssh to see all keys created

Copy key to clipboard pbcopy < ~/.ssh/id_rsa.pub

Public key needs to be added to gitHub

Copy key to clipboard pbcopy < ~/.ssh/id_rsa

Private key needs to be added to Circle Ci

Scheduler

A scheduler is run on a daily basis to store the current featured movie. The following task is run at midnight using the Heroku Scheduler add-on.

npm run tasks

movie-api's People

Contributors

Watchers

movie-api's Issues

Expose Person information via API

Person Object

https://developers.themoviedb.org/3/people/get-person-details

FIelds to be defined

Expose Person Movie Credit from API

Movie Credits

https://developers.themoviedb.org/3/people/get-person-movie-credits

Add simple search query for movies in GraphQL

see https://developers.themoviedb.org/3/search/search-movies

Create Dockerhub account and create repo for pushing images on release builds

https://hub.docker.com/repository/docker/moviewatch/app

need to store tags for both api and ui as only 1 private repository

Add unit test framework to API and add review test strategies

Ensure at least one test is added which is displayed on the build
Add XML output to build to improve display of tests
Use Jest as test framework

Add Age to Person

calculated from DOB if no DOB listed - return null
if date of death listed - age should be based on this date

Review how to obtain current featured movie from Mongo DB and implement

Create API for Featured - which initially can return the current featured movie for the day - this can be extended to return all featured movies

Add Certifications / release date and country to Movies

https://developers.themoviedb.org/3/movies/get-movie-release-dates

Refactor pagination to be cursor based

see https://blog.reactioncommerce.com/how-to-implement-graphql-pagination-and-sorting/

Due to limitations on Movie API will need to make initial call to obtain:

total_pages and total_results

Enhance movie view to include additional fields (tbd)

API to return additional fields for display on movie view

Add Recommended Films to Movie API as an optional field

https://developers.themoviedb.org/3/movies/get-movie-recommendations

This will be used to replace the "Similar" movies display on the UI

Add additional property for the backdrop path to API

Refactor API to return two images as follows:

images : {
poster: ''
backdrop: ''
}

imageUrl remain as is (deprecate)
Backdrop is always original size

"backdrop_path": is in original MovieDB API

Deprecate imageUrl field on movie API

Once image urls updated on UI to use images : { poster, backDrop }

Improve Circle ci workflow

Git Tag a deployment after Docker build and deploy is completed - finding that errors can occur in the Docker build and the release is tagged
Review [ci skip] to see if there are other method to prevent a build showing up in circle - i.e not run - showing Tag is useful but not the following : Release version 1.0.5 [ci skip]
There is an issue when PRs are run concurrently - version no and tags are reused which causes an error - review how this can be improved

API - Include Limit on Cast Member API call

Allow UI to pass a limit or restrict no of Cast Members using another filter if available

see issue above on carousel

Add mongoDB to be able to store additional data outside of MovieDB

mongoDb Atlas - initial prerequisite to build a simple mutation in GraphQL that stores the featured Movie to allow for a history

Can use mongoDb timestamp to stored history - and the movieId

at the beginning of every day a cron job is run that updates the history collection in mongoDB with the above data

Fix issues for release date and image

Both these cases may return null

Release date should be nullable
If image returns null need to handle this case