New: (Cardigann) Paging Support - v9

[Qstick]

Database Migration

NO

Description

• Add PageSize to Cardigann Search block - this is used to calculate proper paging based on offset and limit passed into API.
• Add ability to use {{ .Query.Page }} and {{ .PageSize }} in yml, this page is auto calculated based on the offset and limit passed to Prowlarr and the page size defined in the YML
• Cleanup some paging logic to simplify some code

This should handle all paging scenarios

Examples
Indexer Page Size: 100 - User Search: Offset 100, Limit 100 - We should get page 2
Indexer Page Size: 100 - User Search: Offset 50, Limit 100 - We should pull page 1 and 2 and return correct items
Indexer Page Size: 100 - User Search: Offset 0, Limit 200 - We should pull page 1 and 2 and return all
Indexer Page Size: 100 - User Search: Offset 120, Limit 40 - We should get page 2 and return the correct results
Indexer Page Size 20 - User Search: Offset 40, Limit 100 - We should get and return pages 3,4,5,6,7

Todos

• Tests
• Wiki Updates

Fixes #379
Fixes #1470

[Qstick]

Example indexer change to Blu

search:
  pageSize: 100
  firstPageNumber: 1
  paths:
    # https://hdinnovations.github.io/UNIT3D-Community-Edition-Docs/api_endpoints.html
    # https://github.com/HDInnovations/UNIT3D-Community-Edition/blob/master/app/Http/Controllers/API/TorrentController.php
    - path: "/api/torrents/filter"
      response:
        type: json

  inputs:
  # if we have an id based search, add Season and Episode as query in name for UNIT3D < v6.  Else pass S/E Params for UNIT3D >= v6
    api_token: "{{ .Config.apikey }}"
    name: "{{ .Keywords }}"
    $raw: "{{ if .Query.Season }}&seasonNumber={{ .Query.Season }}{{ else }}{{ end }}{{ if .Query.Ep }}&episodeNumber={{ .Query.Ep }}{{ else }}{{ end }}{{ if .Query.TMDBID }}&tmdbId={{ .Query.TMDBID }}{{ else }}{{ end }}{{ if .Query.IMDBIDShort }}&imdbId={{ .Query.IMDBIDShort }}{{ else }}{{ end }}{{ if  .Query.TVDBID }}&tvdbId={{ .Query.TVDBID }}{{ else }}{{ end }}{{ range .Categories }}&categories[]={{.}}{{end}}{{ if .Config.freeleech }}&free[]=100{{ else }}{{ end }}"
    sortField: "{{ .Config.sort }}"
    sortDirection: "{{ .Config.type }}"
    perPage: "{{ .PageSize }}"
    page: "{{ .Query.Page }}"

[Qstick]

@ilike2burnthing Thoughts? This expands on what you were doing with a POF to full paging support for Cardigann.

b42bf2c is the relevant commit

[ilike2burnthing]

Looks good, and firstPageNumber seems like a smart addition.

[sonarcloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
5 Code Smells

3.8% Coverage
33.6% Duplication