Skip to content

Commit 3befc82

Browse files
ltctceplrmltctceplrm
committed
Added comic book support
- Created a new model for comic books - Added comic vine support
1 parent 9a81d70 commit 3befc82

File tree

5 files changed

+174
-0
lines changed

5 files changed

+174
-0
lines changed

‎src/api/apis/ComicVineAPI.ts‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
import { requestUrl } from 'obsidian';
2+
import { ComicBookModel } from 'src/models/ComicBookModel';
3+
import type MediaDbPlugin from '../../main';
4+
import type { MediaTypeModel } from '../../models/MediaTypeModel';
5+
import { MediaType } from '../../utils/MediaType';
6+
import { APIModel } from '../APIModel';
7+
8+
export class ComicVineAPI extends APIModel {
9+
plugin: MediaDbPlugin;
10+
11+
constructor(plugin: MediaDbPlugin) {
12+
super();
13+
14+
this.plugin = plugin;
15+
this.apiName = 'ComicVineAPI';
16+
this.apiDescription = 'A free API for comic books.';
17+
this.apiUrl = 'https://comicvine.gamespot.com/api';
18+
this.types = [MediaType.ComicBook];
19+
}
20+
21+
async searchByTitle(title: string): Promise<MediaTypeModel[]> {
22+
console.log(`MDB | api "${this.apiName}" queried by Title`);
23+
24+
const searchUrl = `${this.apiUrl}/search/?api_key=${this.plugin.settings.ComicVineKey}&format=json&resources=volume&query=${encodeURIComponent(title)}`;
25+
const fetchData = await requestUrl({
26+
url: searchUrl,
27+
});
28+
// console.debug(fetchData);
29+
if (fetchData.status !== 200) {
30+
throw Error(`MDB | Received status code ${fetchData.status} from ${this.apiName}.`);
31+
}
32+
33+
const data = await fetchData.json;
34+
// console.debug(data);
35+
const ret: MediaTypeModel[] = [];
36+
for (const result of data.results) {
37+
ret.push(
38+
new ComicBookModel({
39+
title: result.name,
40+
englishTitle: result.name,
41+
year: result.start_year,
42+
dataSource: this.apiName,
43+
id: result.id,
44+
publisher: result.publisher.name ?? 'unknown',
45+
}),
46+
);
47+
}
48+
49+
return ret;
50+
}
51+
52+
async getById(id: string): Promise<MediaTypeModel> {
53+
console.log(`MDB | api "${this.apiName}" queried by ID`);
54+
55+
const searchUrl = `${this.apiUrl}/volume/4050-${encodeURIComponent(id)}/?api_key=${this.plugin.settings.ComicVineKey}&format=json`;
56+
const fetchData = await requestUrl({
57+
url: searchUrl,
58+
});
59+
60+
console.debug(fetchData);
61+
62+
if (fetchData.status !== 200) {
63+
throw Error(`MDB | Received status code ${fetchData.status} from ${this.apiName}.`);
64+
}
65+
66+
const data = await fetchData.json;
67+
// console.debug(data);
68+
const result = data.results;
69+
70+
return new ComicBookModel({
71+
type: MediaType.ComicBook,
72+
title: result.name,
73+
plot: result.deck,
74+
year: result.start_year ?? '',
75+
dataSource: this.apiName,
76+
url: result.site_detail_url,
77+
id: result.id,
78+
79+
creators: result.people?.map((x: any) => x.name) ?? [],
80+
issues: result.count_of_issues,
81+
onlineRating: result.score ?? 0,
82+
image: result.image?.original_url ?? '',
83+
84+
released: true,
85+
publisher: result.publisher.name ?? '',
86+
publishedFrom: result.start_year ?? 'unknown',
87+
publishedTo: 'unknown',
88+
status: result.status,
89+
90+
userData: {
91+
read: false,
92+
lastRead: '',
93+
personalRating: 0,
94+
},
95+
});
96+
}
97+
}

‎src/main.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import { OMDbAPI } from './api/apis/OMDbAPI';
1111
import { OpenLibraryAPI } from './api/apis/OpenLibraryAPI';
1212
import { SteamAPI } from './api/apis/SteamAPI';
1313
import { WikipediaAPI } from './api/apis/WikipediaAPI';
14+
import { ComicVineAPI } from './api/apis/ComicVineAPI';
1415
import { MediaDbFolderImportModal } from './modals/MediaDbFolderImportModal';
1516
import type { MediaTypeModel } from './models/MediaTypeModel';
1617
import { PropertyMapper } from './settings/PropertyMapper';
@@ -53,6 +54,7 @@ export default class MediaDbPlugin extends Plugin {
5354
this.apiManager.registerAPI(new SteamAPI(this));
5455
this.apiManager.registerAPI(new BoardGameGeekAPI(this));
5556
this.apiManager.registerAPI(new OpenLibraryAPI(this));
57+
this.apiManager.registerAPI(new ComicVineAPI(this));
5658
this.apiManager.registerAPI(new MobyGamesAPI(this));
5759
this.apiManager.registerAPI(new GiantBombAPI(this));
5860
// this.apiManager.registerAPI(new LocGovAPI(this)); // TODO: parse data

‎src/models/ComicBookModel.ts‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
import { MediaType } from '../utils/MediaType';
2+
import type { ModelToData } from '../utils/Utils';
3+
import { mediaDbTag, migrateObject } from '../utils/Utils';
4+
import { MediaTypeModel } from './MediaTypeModel';
5+
6+
export type ComicBookData = ModelToData<ComicBookModel>;
7+
8+
export class ComicBookModel extends MediaTypeModel {
9+
creators: string[];
10+
publisher: string;
11+
plot: string;
12+
issues: number;
13+
image: string;
14+
onlineRating: number;
15+
status: string;
16+
released: boolean;
17+
publishedFrom: string;
18+
publishedTo: string;
19+
20+
userData: {
21+
read: boolean;
22+
lastRead: string;
23+
personalRating: number;
24+
};
25+
26+
constructor(obj: ComicBookData) {
27+
super();
28+
29+
this.creators = [];
30+
this.publisher = '';
31+
this.plot = '';
32+
this.issues = 0;
33+
this.image = '';
34+
this.onlineRating = 0;
35+
36+
this.released = false;
37+
this.status = '';
38+
this.publishedFrom = '';
39+
this.publishedTo = '';
40+
41+
this.userData = {
42+
read: false,
43+
lastRead: '',
44+
personalRating: 0,
45+
};
46+
47+
migrateObject(this, obj, this);
48+
49+
if (!obj.hasOwnProperty('userData')) {
50+
migrateObject(this.userData, obj, this.userData);
51+
}
52+
53+
this.type = this.getMediaType();
54+
}
55+
56+
getTags(): string[] {
57+
return [mediaDbTag, 'comicbook'];
58+
}
59+
60+
getMediaType(): MediaType {
61+
return MediaType.ComicBook;
62+
}
63+
64+
getSummary(): string {
65+
return this.englishTitle + ' (' + this.year + ') - ' + this.publisher;
66+
}
67+
}

‎src/utils/MediaType.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ export enum MediaType {
77
Wiki = 'wiki',
88
BoardGame = 'boardgame',
99
Book = 'book',
10+
ComicBook = 'comicBook',
1011
}

‎src/utils/MediaTypeManager.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { BoardGameModel } from '../models/BoardGameModel';
44
import { BookModel } from '../models/BookModel';
55
import { GameModel } from '../models/GameModel';
66
import { MangaModel } from '../models/MangaModel';
7+
import { ComicBookModel } from '../models/ComicBookModel';
78
import type { MediaTypeModel } from '../models/MediaTypeModel';
89
import { MovieModel } from '../models/MovieModel';
910
import { MusicReleaseModel } from '../models/MusicReleaseModel';
@@ -22,6 +23,7 @@ export const MEDIA_TYPES: MediaType[] = [
2223
MediaType.MusicRelease,
2324
MediaType.BoardGame,
2425
MediaType.Book,
26+
MediaType.ComicBook,
2527
];
2628

2729
export class MediaTypeManager {
@@ -45,6 +47,7 @@ export class MediaTypeManager {
4547
this.mediaFileNameTemplateMap.set(MediaType.MusicRelease, settings.musicReleaseFileNameTemplate);
4648
this.mediaFileNameTemplateMap.set(MediaType.BoardGame, settings.boardgameFileNameTemplate);
4749
this.mediaFileNameTemplateMap.set(MediaType.Book, settings.bookFileNameTemplate);
50+
this.mediaFileNameTemplateMap.set(MediaType.ComicBook, settings.bookFileNameTemplate);
4851

4952
this.mediaTemplateMap = new Map<MediaType, string>();
5053
this.mediaTemplateMap.set(MediaType.Movie, settings.movieTemplate);
@@ -55,6 +58,7 @@ export class MediaTypeManager {
5558
this.mediaTemplateMap.set(MediaType.MusicRelease, settings.musicReleaseTemplate);
5659
this.mediaTemplateMap.set(MediaType.BoardGame, settings.boardgameTemplate);
5760
this.mediaTemplateMap.set(MediaType.Book, settings.bookTemplate);
61+
this.mediaTemplateMap.set(MediaType.ComicBook, settings.bookTemplate);
5862
}
5963

6064
updateFolders(settings: MediaDbPluginSettings): void {
@@ -67,6 +71,7 @@ export class MediaTypeManager {
6771
this.mediaFolderMap.set(MediaType.MusicRelease, settings.musicReleaseFolder);
6872
this.mediaFolderMap.set(MediaType.BoardGame, settings.boardgameFolder);
6973
this.mediaFolderMap.set(MediaType.Book, settings.bookFolder);
74+
this.mediaFolderMap.set(MediaType.ComicBook, settings.bookFolder);
7075
}
7176

7277
getFileName(mediaTypeModel: MediaTypeModel): string {
@@ -144,6 +149,8 @@ export class MediaTypeManager {
144149
return new BoardGameModel(obj);
145150
} else if (mediaType === MediaType.Book) {
146151
return new BookModel(obj);
152+
} else if (mediaType === MediaType.ComicBook) {
153+
return new ComicBookModel(obj);
147154
}
148155

149156
throw new Error(`Unknown media type: ${mediaType}`);

0 commit comments

Comments
 (0)