https://github.com/oguzal/lordoftheringsapi

A C# client for the Lord of the Rings API
https://github.com/oguzal/lordoftheringsapi

csharp lotr restsharp

Last synced: 9 days ago
JSON representation

A C# client for the Lord of the Rings API

• Host: GitHub
• URL: https://github.com/oguzal/lordoftheringsapi
• Owner: oguzal
• License: gpl-3.0
• Created: 2023-10-30T01:17:55.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-23T19:40:41.000Z (about 2 months ago)
• Last Synced: 2024-11-23T20:19:50.644Z (about 2 months ago)
• Topics: csharp, lotr, restsharp
• Language: C#
• Homepage:
• Size: 23.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lord of the Rings C# SDK Using RestSharp Library

This C# SDK  allows to consume Lord of the Rings API endpoints easily, which are  available on https://the-one-api.dev/documentation. The current implementation supports retrieving of Movie and Quote

objects as collection or  individually,  the results are converted to type safe C# models listed under Model folder. 

Some form of filtering is also supported as described below. 

 In this version the below endpoints are implemented:

| Endpoint | Description| Corresponding SDK Method| 

-----------|------------|-------------------------|

|/quote         | List of all movie quotes  | `public async Task> GetQuotes(List filters) `|                         |

|/quote/{id}    | Request one specific movie quote | `public async Task GetQuote(string Id)`        |        

|/movie         | List of all movies, including the "The Lord of the Rings" and the "The Hobbit" trilogies |  ` public async Task> GetQuotesByMovieId(string Id, List filters, int? page = null, int? offset = null, int? limit = null) `|

|/movie/{id}    | Request one specific movie | `public async Task GetMovie(string Id)`              | 

|/movie/{id}/quote | Request all movie quotes for one specific movie (only working for the LotR trilogy) |  ` public async Task> GetQuotes(List filters, int? page=null, int? offset=null, int? limit = null)  ` |

The SDK targets .Net Standard 2.0 which supports below .Net implementations:

| .NET implementation |	Version support|

|----------------------|--------------------|

|.NET and .NET Core |	2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0|

|.NET Framework    |	4.6.1 2, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1|

 https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0

For the endpoints that takes `List` as parameter, you can create the filters as below:



  public async Task GetMoviesShorterThan200MinsAnd95PlusRottenTomatoesTest()

  {

      var filters = new List``();

      filters.Add(new Filter("200", Filter.Operator.LessThan, "runtimeInMinutes"));

      filters.Add(new Filter("92", Filter.Operator.GreaterThan, "rottenTomatoesScore"));

      var movies = await sdk.GetMovies(filters);

      ..

  }

  

  The SDK is created using Visual Studio 2022. The solution file is  LotrSDK/LotrSDK.sln which opens both the SDK project(a class library named as "LotrSDK") and Integration Test Project("LotrSDKTests").

## Instructions:

1. Create an account on  https://the-one-api.dev/sign-up 

2. Clone this repo in your pc

3. Open the solution file (Preferably with Visual Studio) 

4. Add your bearer token on  line 81 in the .runsettings file under LotrSDKTests project

5. Run Unit tests

## TODO LIST: 

1. Only 5 endpoints are covered so far

2. More Tests need to be added