tonykaralis / tmdbeasy Goto Github PK

Public API needs some refactoring.

Main priority is improving the developer experience and simplifying the code.

Unit testing is essential

Remove the need for each API to know about the apikey internals.

1. the user should be able to globally set the api key via TmdbEasyOptions
2. User should be able to override this and provide a user specific key per request

Both options are necessary. The api for this needs to be clean and simple to use.

@PoLaKoSz linking you as a reference as you were heavily requesting for option 2. Both will be addressed in #17

When querying the MovieApi for a ChangeList one of the nested properties does not return a consistent value which results in the json deserialization to fail.

List<Change> result = await apiUnderTest.GetChangesAsync(id, "30/05/2019", "20/05/2019", apiKey: _userApiKey);

    public class Change
    {
        public string Key { get; set; }
        public List<Item> Items { get; set; }
    }

    public class Item
    {
        public string Id { get; set; }
        public string Action { get; set; }
        public string Time { get; set; }
        public string Iso_639_1 { get; set; }
        public string Value { get; set; }      // offending properties
        public string Original_value { get; set; }     // offending properties
    }

The Value and Original_value can take the following shape within the raw JSON. There may be more, but these are the ones encountered so far.

"value": {
        "iso_3166_1": "NL",
        "iso_639_1": "",
          "release_date": "2004-08-04",
          "certification": "16",
          "type": 5,
          "note": "DVD"
}

or

"value": {
        "backdrop": {
           "file_path": "/aEdy9BNNdg6qwjyHIbVTflZDFb2.jpg"
         }
    }

or

"value": "Комиксовият герой е с чисто нов, вече с черен костюм, който напълно отгов",

• GetAlternativeNames
• GetImages

There should be ways of provided the language parameter for queries that support it.

1. Via the method parameter, for individual requests that would differ by user
2. Globally via the TmdbEasyOptions

Should be easy for the user to opt in to either or both.

@PoLaKoSz as a reminder this was your request

The data is being returned from the request but not deserialized into the AlternativeTitlesClass.

Reproduce with tvId = 1399.

Where: TelevisionApiTest -> GetAlternativeTitlesAsync_ValidId_ReturnsValidResult

What the title says..

API used needs to be upgraded to TMDBs v4.

The changes required for this might not be part of v1, this is more of a scoping task. However if I have time I will attempt to add support for v4.

Ideal would be to maintain support for v3 as well as v4 and give users the option to configure which version to use via a simple switch. the rest of the api should be identical.

There is an extra slash (/) character in the line 16 of the ConfigApi.cs file which leads to an exception: "Movie Id does not exist".

The code is as follows:
var content = await CallApiAsync($"{Url}configuration/?api_key={ApiKey}").ConfigureAwait(false)

Should be corrected to:
var content = await CallApiAsync($"{Url}configuration?api_key={ApiKey}").ConfigureAwait(false);

Currently happens with TvContentRating and MovieChangeList

In TMDb v3 the search/person endpoint response different from the search/movies so the response can not be Task<MovieList>.

Looking to refresh this lib, improve developer experience and put some effort into making it play nicely with ASP.NET Core.

Roadmap:
Add support for asp.net core dependency injection
Refactor to clean SOLID standards
Address any async issues
Refactor internals
Improve developer experience
Update readme, add docs if necessary
Extend library to include more endpoints
Potentially move to v4 of TMDB
Heads up to any users that v1 will most likely include some major breaking changes

See project for details https://github.com/tonykaralis/TMdbEasy/projects/1

1. Key passed in via constructor -> needs to change to some config
2. Give users ability to register serviced with DI (refactors classes and interfaces)
3. Provide a default .UseTmDbEasy() Extension method for use in startup