Merge pull request #105 from ltctceplrm/master

Add book support using the OpenLibrary API

Author: mProjectsCode

README.md

@@ -107,6 +107,7 @@ Now you select the result you want and the plugin will cast it's magic and creat
 -   games
 -   music releases
 -   wiki articles
+-   books
 
 ### Currently supported APIs:
 
@@ -117,6 +118,8 @@ Now you select the result you want and the plugin will cast it's magic and creat
 | [MusicBrainz](https://musicbrainz.org/)              | MusicBrainz is an API that offers information about music releases.                               | music releases                 | No                                                                           | 50 per second                  | No                 |
 | [Wikipedia](https://en.wikipedia.org/wiki/Main_Page) | The Wikipedia API allows access to all Wikipedia articles.                                        | wiki articles                  | No                                                                           | None                           | No                 |
 | [Steam](https://store.steampowered.com/)             | The Steam API offers information on all steam games.                                              | games                          | No                                                                           | 10000 per day                  | No                 |
+| [Open Library](https://openlibrary.org)                                          | The OpenLibrary API offers metadata for books                                                     | books                          | No                                                                           |         Cover access is rate-limited when not using CoverID or OLID by max 100 requests/IP every 5 minutes. This plugin uses OLID so there shouldn't be a rate limit.                       |          No          |
+
 
 #### Notes
 
@@ -142,6 +145,11 @@ Now you select the result you want and the plugin will cast it's magic and creat
 -   [Steam](https://store.steampowered.com/)
     -   you can find this ID in the URL
         -   e.g. for "Factorio" the URL looks like this `https://store.steampowered.com/app/427520/Factorio/` so the ID is `427520`
+-   [Open Library](https://openlibrary.org)
+    -   The ID you need is the "work" ID and not the "book" ID, it needs to start with `/works/`. You can find this ID in the URL
+        -   e.g. for "Fantastic Mr. Fox" the URL looks like this `https://openlibrary.org/works/OL45804W` so the ID is `/works/OL45804W`
+        -   This URL is located near the top of the page above the title, see `An edition of Fantastic Mr Fox (1970) `
+
 
 ### Problems, unexpected behavior or improvement suggestions?
 

src/api/apis/OpenLibraryAPI.ts

@@ -0,0 +1,90 @@
+import { APIModel } from '../APIModel';
+import { MediaTypeModel } from '../../models/MediaTypeModel';
+import MediaDbPlugin from '../../main';
+import { BookModel } from 'src/models/BookModel';
+import { MediaType } from '../../utils/MediaType';
+
+export class OpenLibraryAPI extends APIModel {
+	plugin: MediaDbPlugin;
+
+	constructor(plugin: MediaDbPlugin) {
+		super();
+
+		this.plugin = plugin;
+		this.apiName = 'OpenLibraryAPI';
+		this.apiDescription = 'A free API for books';
+		this.apiUrl = 'https://openlibrary.org/';
+		this.types = [MediaType.Book];
+}
+
+	async searchByTitle(title: string): Promise<MediaTypeModel[]> {
+		console.log(`MDB | api "${this.apiName}" queried by Title`);
+
+		const searchUrl = `https://openlibrary.org/search.json?title=${encodeURIComponent(title)}`;
+
+		const fetchData = await fetch(searchUrl);
+		console.debug(fetchData);
+		if (fetchData.status !== 200) {
+			throw Error(`MDB | Received status code ${fetchData.status} from an API.`);
+		}
+		const data = await fetchData.json();
+
+		console.debug(data);
+
+		const ret: MediaTypeModel[] = [];
+
+		for (const result of data.docs) {
+				ret.push(
+					new BookModel({
+						title: result.title,
+						englishTitle: result.title_english ?? result.title,
+						year: result.first_publish_year,
+						dataSource: this.apiName,
+						id: result.key,
+					} as BookModel)
+				);
+		}
+
+		return ret;
+	}
+
+	async getById(id: string): Promise<MediaTypeModel> {
+		console.log(`MDB | api "${this.apiName}" queried by ID`);
+
+		const searchUrl = `https://openlibrary.org/search.json?q=key:${encodeURIComponent(id)}`;
+		const fetchData = await fetch(searchUrl);
+		console.debug(fetchData);
+
+		if (fetchData.status !== 200) {
+			throw Error(`MDB | Received status code ${fetchData.status} from an API.`);
+		}
+
+		const data = await fetchData.json();
+		console.debug(data);
+		const result = data.docs[0];
+
+		const model = new BookModel({
+			title: result.title,
+			year: result.first_publish_year,
+			dataSource: this.apiName,
+			url: `https://openlibrary.org` + result.key,
+			id: result.key,
+			englishTitle: result.title_english ?? result.title,
+
+			author: result.author_name ?? 'unknown',
+			pages: result.number_of_pages_median ?? 'unknown',
+			onlineRating: Number.parseFloat(Number(result.ratings_average ?? 0).toFixed(2)),
+			image: `https://covers.openlibrary.org/b/OLID/` + result.cover_edition_key + `-L.jpg` ?? '',
+
+			released: true,
+
+			userData: {
+				read: false,
+				lastRead: '',
+				personalRating: 0,
+			},
+		} as BookModel);
+
+		return model;
+	}
+}

src/main.ts

@@ -10,6 +10,7 @@ import { MusicBrainzAPI } from './api/apis/MusicBrainzAPI';
 import { MEDIA_TYPES, MediaTypeManager } from './utils/MediaTypeManager';
 import { SteamAPI } from './api/apis/SteamAPI';
 import { BoardGameGeekAPI } from './api/apis/BoardGameGeekAPI';
+import { OpenLibraryAPI } from './api/apis/OpenLibraryAPI';
 import { PropertyMapper } from './settings/PropertyMapper';
 import { YAMLConverter } from './utils/YAMLConverter';
 import { MediaDbFolderImportModal } from './modals/MediaDbFolderImportModal';
@@ -36,6 +37,7 @@ export default class MediaDbPlugin extends Plugin {
 		this.apiManager.registerAPI(new MusicBrainzAPI(this));
 		this.apiManager.registerAPI(new SteamAPI(this));
 		this.apiManager.registerAPI(new BoardGameGeekAPI(this));
+		this.apiManager.registerAPI(new OpenLibraryAPI(this));
 		// this.apiManager.registerAPI(new LocGovAPI(this)); // TODO: parse data
 
 		this.mediaTypeManager = new MediaTypeManager();

src/models/BookModel.ts

@@ -0,0 +1,56 @@
+import { MediaTypeModel } from './MediaTypeModel';
+import { mediaDbTag, migrateObject } from '../utils/Utils';
+import { MediaType } from '../utils/MediaType';
+
+export class BookModel extends MediaTypeModel {
+	author: string;
+	pages: number;
+	image: string;
+	onlineRating: number;
+	english_title: string;
+
+	released: boolean;
+
+	userData: {
+		read: boolean;
+		lastRead: string;
+		personalRating: number;
+	};
+
+	constructor(obj: any = {}) {
+		super();
+
+		this.author = undefined;
+		this.pages = undefined;
+		this.image = undefined;
+		this.onlineRating = undefined;
+
+		this.released = undefined;
+
+		this.userData = {
+			read: undefined,
+			lastRead: undefined,
+			personalRating: undefined,
+		};
+
+		migrateObject(this, obj, this);
+
+		if (!obj.hasOwnProperty('userData')) {
+			migrateObject(this.userData, obj, this.userData);
+		}
+
+		this.type = this.getMediaType();
+	}
+
+	getTags(): string[] {
+		return [mediaDbTag, 'book'];
+	}
+
+	getMediaType(): MediaType {
+		return MediaType.Book;
+	}
+
+	getSummary(): string {
+		return this.englishTitle + ' (' + this.year + ')';
+	}
+}

src/settings/Settings.ts

@@ -22,27 +22,31 @@ export interface MediaDbPluginSettings {
 	wikiTemplate: string;
 	musicReleaseTemplate: string;
 	boardgameTemplate: string;
+	bookTemplate: string;
 
 	movieFileNameTemplate: string;
 	seriesFileNameTemplate: string;
 	gameFileNameTemplate: string;
 	wikiFileNameTemplate: string;
 	musicReleaseFileNameTemplate: string;
 	boardgameFileNameTemplate: string;
+	bookFileNameTemplate: string;
 
 	moviePropertyConversionRules: string;
 	seriesPropertyConversionRules: string;
 	gamePropertyConversionRules: string;
 	wikiPropertyConversionRules: string;
 	musicReleasePropertyConversionRules: string;
 	boardgamePropertyConversionRules: string;
+	bookPropertyConversionRules: string;
 
 	movieFolder: string;
 	seriesFolder: string;
 	gameFolder: string;
 	wikiFolder: string;
 	musicReleaseFolder: string;
 	boardgameFolder: string;
+	bookFolder: string;
 
 	propertyMappingModels: PropertyMappingModel[];
 }
@@ -60,27 +64,31 @@ const DEFAULT_SETTINGS: MediaDbPluginSettings = {
 	wikiTemplate: '',
 	musicReleaseTemplate: '',
 	boardgameTemplate: '',
+	bookTemplate: '',
 
 	movieFileNameTemplate: '{{ title }} ({{ year }})',
 	seriesFileNameTemplate: '{{ title }} ({{ year }})',
 	gameFileNameTemplate: '{{ title }} ({{ year }})',
 	wikiFileNameTemplate: '{{ title }}',
 	musicReleaseFileNameTemplate: '{{ title }} (by {{ ENUM:artists }} - {{ year }})',
 	boardgameFileNameTemplate: '{{ title }} ({{ year }})',
+	bookFileNameTemplate: '{{ title }} ({{ year }})',
 
 	moviePropertyConversionRules: '',
 	seriesPropertyConversionRules: '',
 	gamePropertyConversionRules: '',
 	wikiPropertyConversionRules: '',
 	musicReleasePropertyConversionRules: '',
 	boardgamePropertyConversionRules: '',
+	bookPropertyConversionRules: '',
 
 	movieFolder: 'Media DB/movies',
 	seriesFolder: 'Media DB/series',
 	gameFolder: 'Media DB/games',
 	wikiFolder: 'Media DB/wiki',
 	musicReleaseFolder: 'Media DB/music',
 	boardgameFolder: 'Media DB/boardgames',
+	bookFolder: 'Media DB/books',
 
 	propertyMappingModels: [],
 };
@@ -194,7 +202,7 @@ export class MediaDbSettingTab extends PluginSettingTab {
 		// region new file location
 		new Setting(containerEl)
 			.setName('Movie Folder')
-			.setDesc('Where newly imported movies should be places.')
+			.setDesc('Where newly imported movies should be placed.')
 			.addSearch(cb => {
 				new FolderSuggest(this.app, cb.inputEl);
 				cb.setPlaceholder(DEFAULT_SETTINGS.movieFolder)
@@ -207,7 +215,7 @@ export class MediaDbSettingTab extends PluginSettingTab {
 
 		new Setting(containerEl)
 			.setName('Series Folder')
-			.setDesc('Where newly imported series should be places.')
+			.setDesc('Where newly imported series should be placed.')
 			.addSearch(cb => {
 				new FolderSuggest(this.app, cb.inputEl);
 				cb.setPlaceholder(DEFAULT_SETTINGS.seriesFolder)
@@ -220,7 +228,7 @@ export class MediaDbSettingTab extends PluginSettingTab {
 
 		new Setting(containerEl)
 			.setName('Game Folder')
-			.setDesc('Where newly imported games should be places.')
+			.setDesc('Where newly imported games should be placed.')
 			.addSearch(cb => {
 				new FolderSuggest(this.app, cb.inputEl);
 				cb.setPlaceholder(DEFAULT_SETTINGS.gameFolder)
@@ -233,7 +241,7 @@ export class MediaDbSettingTab extends PluginSettingTab {
 
 		new Setting(containerEl)
 			.setName('Wiki Folder')
-			.setDesc('Where newly imported wiki articles should be places.')
+			.setDesc('Where newly imported wiki articles should be placed.')
 			.addSearch(cb => {
 				new FolderSuggest(this.app, cb.inputEl);
 				cb.setPlaceholder(DEFAULT_SETTINGS.wikiFolder)
@@ -246,7 +254,7 @@ export class MediaDbSettingTab extends PluginSettingTab {
 
 		new Setting(containerEl)
 			.setName('Music Folder')
-			.setDesc('Where newly imported music should be places.')
+			.setDesc('Where newly imported music should be placed.')
 			.addSearch(cb => {
 				new FolderSuggest(this.app, cb.inputEl);
 				cb.setPlaceholder(DEFAULT_SETTINGS.musicReleaseFolder)
@@ -269,6 +277,18 @@ export class MediaDbSettingTab extends PluginSettingTab {
 						this.plugin.saveSettings();
 					});
 			});
+		new Setting(containerEl)
+			.setName('Book Folder')
+			.setDesc('Where newly imported books should be placed.')
+			.addSearch(cb => {
+				new FolderSuggest(this.app, cb.inputEl);
+				cb.setPlaceholder(DEFAULT_SETTINGS.bookFolder)
+					.setValue(this.plugin.settings.bookFolder)
+					.onChange(data => {
+						this.plugin.settings.bookFolder = data;
+						this.plugin.saveSettings();
+					});
+			});
 		// endregion
 
 		containerEl.createEl('h3', { text: 'Template Settings' });
@@ -350,6 +370,19 @@ export class MediaDbSettingTab extends PluginSettingTab {
 						this.plugin.saveSettings();
 					});
 			});
+
+		new Setting(containerEl)
+			.setName('Book template')
+			.setDesc('Template file to be used when creating a new note for a book.')
+			.addSearch(cb => {
+				new FileSuggest(this.app, cb.inputEl);
+				cb.setPlaceholder('Example: bookTemplate.md')
+					.setValue(this.plugin.settings.bookTemplate)
+					.onChange(data => {
+						this.plugin.settings.bookTemplate = data;
+						this.plugin.saveSettings();
+					});
+			});
 		// endregion
 
 		containerEl.createEl('h3', { text: 'File Name Settings' });
@@ -425,6 +458,18 @@ export class MediaDbSettingTab extends PluginSettingTab {
 						this.plugin.saveSettings();
 					});
 			});
+
+		new Setting(containerEl)
+			.setName('Book file name template')
+			.setDesc('Template for the file name used when creating a new note for a book.')
+			.addText(cb => {
+				cb.setPlaceholder(`Example: ${DEFAULT_SETTINGS.bookFileNameTemplate}`)
+					.setValue(this.plugin.settings.bookFileNameTemplate)
+					.onChange(data => {
+						this.plugin.settings.bookFileNameTemplate = data;
+						this.plugin.saveSettings();
+					});
+			});
 		// endregion
 
 		// region Property Mappings

src/utils/MediaType.ts

@@ -5,4 +5,5 @@ export enum MediaType {
 	MusicRelease = 'musicRelease',
 	Wiki = 'wiki',
 	BoardGame = 'boardgame',
+	Book = 'book',
 }