danstis/plex-sync

Plex-Sync is a synchronisation tool for Plex. It syncs media and watched status between a remote and a local plex server.

plex-sync's Issues

Update readme to include DB changes

The readme needs an update based on the move to a DB to store the settings.

Add Changelog

Allow selection of more than 1 Remote Plex server

Add ability to clear cached token

Add the ability to clear the cached token

Acceptance Criteria:

What are the minimum requirements to close this issue?

• Web interface exposes a method of clearing the cached token

Update readme

Add usage instructions to the Readme

Feature Request:

The readme file should provide configuration instructions.

Acceptance Criteria:

• Readme file describes the requirements to run the tool.
• Instructions are tested to be working.

Add logging to web interface

The logging information should be presented via the web interface

Move settings into DB

Once a Database has been implemented, all settings should be stored in the DB.

Modify the format of the selected shows on the index page

The listing of shows should be updated to provide additional details. Ideally a list of shows with thumbnail images on the left and details on the right.

Sync watched status from local server to remote

As a user,
I want the product to sync the shows that I have watched locally to the remote server

Update errors to return to main

All errors in functions/methods should be returned to main to be handled.

Move token file to .cache folder

Feature Request:

Relocate the token file to the .\config folder, as this is a cache item.

Acceptance Criteria:

What are the minimum requirements to close this issue?

• token file is moved to the cache folder.
• All references are updated.

Add web interface for management

Feature Request:

Create a web interface to allow for management of the application.

Acceptance Criteria:

What are the minimum requirements to close this issue?

• Web Interface is served locally on a user defined port
• User is able to generate a new Auth token by entering credentials into web interface

Add information to executable

Add some publishing info to the EXE properties.

Enable the selection of TV shows to sync via the webinterface

The web interface should provide a list of shows on the remote server, to enable the user to select which shows they would like to sync

Acceptance Criteria:

What are the minimum requirements to close this issue?

• Web interface shows list of shows.
• User is able to select the shows that should be synced.
  • The selection of items should be done via a lookup on the local/remote server.
  • When the user is presented with the media details, the metadata of the media should be presented (resolution, bitrate, size, audio, extra streams/subtitle info, etc...)

Error getting new token: unable to create token file

Bug Report:

Bug summary

When attempting to generate a token from a clean install the following error is shown:
Error getting new token: unable to create token file

Reproduction Steps

1. Unzip Plex-Sync.zip into a directory.
2. Start main.exe
3. Attempt to generate a new token from Settigs -> Generate Token.
4. Error is displayed in Web UI.

Desired Behaviour

Token file should be created.

Move settings to WebUI

All settings should be managed within the WebUI.

Sync Movies

Sync media from remote server to local path

As a user,
I want media that is contained in a remote Plex server to be synced to my local machine

Add startup version reporting

On startup the console should display the version of the app.

Update WebUI home page to list shows in responsive manner for mobile

Feature Request:

The WebUI listing of shows is currntly not responsive. When viewed on mobile it can be rather large.
The show listing should be updated to use a grid format and be responsive for mobile.

Acceptance Criteria:

What are the minimum requirements to close this issue?

• Listing displays on mobile devices correctly.
• Listing displays on desktop devices correctly.

Remove unused tvsection from main

Move full version number into the settings page

The settings page should contain the full version of the app.
Related to Issue #55 that removes the full version from the header.

Test ticket from Code Climate

Watched Status not syncing

Bug Report:

Bug summary

Shows that have been watched do not always sync watched status.

Add error handling to GetToken method

Currently nothing happens with errors encountered on the GetToken method.

Sort selected shows on Home page

Bug Report:

Bug summary

Selected shows on the Home page are not sorted.

Desired Behavior

Should be sorted alphabetically.

Acceptance Criteria:

What are the minimum requirements to close this issue?

• Sort the selected shows alphabetically.

Remove _template.html from release

Cached images refresh on every sync

Images are being refreshed on every sync, rather than adhering to the cache expiry setting.

Add handling to MyPlex token request for incorrect user details

Potentially respond to response codes that are not 201.

When token is missing print to stdout as well as file

Partly watched items are marked as watched on remote server

Bug Report:

Bug summary

Partly watched items are marked as watched on remote server.

Reproduction Steps

1. For a show that is selected for sync, start watching an episode on the local server.
2. Wait for a sync cycle.
3. Check the remote server (or system logs) to see that the episode is marked as watched.

Desired Behaviour

The episode should not be marked as watched until the show is completely watched (using the same logic as plex does on watched episodes).

Add logging to file

The logs should be directed to one or more log files

Request MyPlex token

Use the credentials supplied to request a real token from MyPlex.

Auto versioning on build

Update version to increment automatically with semantic versioning on every build.

Sync TV Shows

The application should sync TV shows from the remote server to the local server.

This should be configurable with the following settings:

• Sync only unwatched episodes, or all episodes
• Sync a limited number of episodes ahead of the latest episode that is currently marked watched
• Should be able to remove media once it has been marked as watched

Acceptance criteria:

• Media is synced to a user selected directory
• The folder structure of the directory mirrors the server folder structure
• Setting defined to control the number of episodes to sync
• Setting defined to control sync of unwatched items only
• Setting defined to control if the server syncs ahead from last watched item
• Setting defined to control if the app removes watched media

Add icon to executable

Move Selected content to DB

Once a Database has been implemented, the selected content (shows/movies) should be moved into the DB.
This will remove the shows.txt files etc.

When a token request fails the app should exit

Bug Report:

Bug summary

If Plex-Sync fails to get a token from MyPlex, then the app still attempts to perform actions.

Reproduction Steps

1. Open app without a cached token
2. Enter incorrect details to request token
3. Application will still attempt to perform sync tasks, even though it knows that is has no token

Desired Behavior

Application should panic and exit

Move tvshows.txt file to config folder

Feature Request:

Relocate the tvshows.txt file to the .\config folder, as this is a configuration item.

Acceptance Criteria:

What are the minimum requirements to close this issue?

• tvshows.txt file is moved to the config folder.
• All references are updated.

Ignore pre-release tags on header of web interface

The header of the WebUI should have a version number excluding the pre-release tags.
For example: v1.2.3

Display an image placeholder for missing show thumbnails

Shows with missing thumbnails should display an image of some sort, rather than the broken image.

HTTPS setting does not work

The HTTPS checkbox on the settings page needs to be updated so that it correctly stores and displays the data from the Database.

Sync the View Offset attribute to remote server

Feature Request:

For partly watched media, the "viewOffset" (and potentially the "lastViewedAt") attributes should be synced as part of the watched status sync.

Acceptance Criteria:

• For media that is partially watched, the viewOffset attribute is synced from the local server to the remote server.

Replace show titles on homepage with images from Plex

Rather than having the show titles listed on the home page, get the show image from plex and display it on the homepage in a grid.
The show titles should also be listed to ensure missing artwork does not impact users.

Refresh selected shows each time home page is loaded

Make windows binary run without smart-screen stopping it

TV Shows with spaces in the name cause issues with sync

Bug Report:

Bug summary

TV Shows with spaces in the name cause issues with sync

Acceptance Criteria:

App should url encode the string before sending it to be searched.

Add additional test to cover the missing sections in MyPlex

Make error messages more meaningful

Some error message, like "could not find episode in array" should be replaced with more meaningful descriptions of the error.