[0-9]+))?$"
36 | )
37 | ILLEGAL_WIN_PATH_CHARS_RE = re.compile(r'[<>:"/\\|?*]')
38 | MIMETYPE_MAP = {
39 | ".xhtml": "application/xhtml+xml",
40 | ".html": "text/html",
41 | ".css": "text/css",
42 | ".png": "image/png",
43 | ".gif": "image/gif",
44 | ".jpeg": "image/jpeg",
45 | ".jpg": "image/jpeg",
46 | ".otf": "font/otf",
47 | ".ttf": "font/ttf",
48 | ".woff": "font/woff",
49 | ".woff2": "font/woff2",
50 | ".eot": "application/vnd.ms-fontobject",
51 | ".svg": "image/svg+xml",
52 | ".ncx": "application/x-dtbncx+xml",
53 | }
54 |
55 |
56 | def guess_mimetype(url: str) -> Optional[str]:
57 | """
58 | Attempt to guess the mimetype for a given url
59 |
60 | :param url:
61 | :return:
62 | """
63 | url_path = Path(url)
64 | mime_type, _ = guess_type(url_path.name, strict=False)
65 | if not mime_type:
66 | mime_type = MIMETYPE_MAP.get(url_path.suffix.lower(), None)
67 | return mime_type
68 |
69 |
70 | def is_windows() -> bool:
71 | """
72 | Returns True if running on Windows.
73 |
74 | :return:
75 | """
76 | return os.name == "nt" or platform.system().lower() == "windows"
77 |
78 |
79 | def plural_or_singular_noun(
80 | value: float, singular_noun: str, plural_noun: str = ""
81 | ) -> str:
82 | """
83 | Returns the appropriate noun based on the value provided.
84 |
85 | :param value:
86 | :param singular_noun:
87 | :param plural_noun:
88 | :return:
89 | """
90 | if not plural_noun:
91 | plural_noun = singular_noun + "s"
92 | return plural_noun if value != 1 else singular_noun
93 |
94 |
95 | def sanitize_path(text: str, sub_text: str = "-", exclude_chars: str = "") -> str:
96 | """
97 | Strips invalid characters from a local file path component.
98 |
99 | :param text:
100 | :param sub_text:
101 | :param exclude_chars:
102 | :return:
103 | """
104 | if not exclude_chars:
105 | exclude_chars = ""
106 | if os.name == "nt" or platform.system().lower() == "windows":
107 | # just replacing `os.sep` is not enough on Windows
108 | # ref https://github.com/ping/odmpy/issues/30
109 | text = ILLEGAL_WIN_PATH_CHARS_RE.sub(sub_text, text)
110 | for c in exclude_chars:
111 | # example, if "-" is in additional_exclude_chars, we can't use "-" as replacement,
112 | # so we'll just remove it
113 | text = text.replace(
114 | c, sub_text if sub_text and sub_text not in exclude_chars else ""
115 | )
116 |
117 | text = text.replace(os.sep, sub_text)
118 | # also strip away non-printable chars just to be safe
119 | return "".join(c for c in text if c.isprintable())
120 |
121 |
122 | def get_element_text(ele: Optional[ET.Element]) -> str:
123 | """
124 | Returns the element text
125 |
126 | :param ele:
127 | :return:
128 | """
129 | if (ele is not None) and ele.text:
130 | return ele.text or ""
131 | return ""
132 |
133 |
134 | def parse_duration_to_milliseconds(text: str) -> int:
135 | """
136 | Converts a duration string into milliseconds
137 |
138 | :param text: A duration string, e.g. "10:15", "10:15.300", "1:10:15"
139 | :return:
140 | """
141 | mobj = TIMESTAMP_RE.match(text)
142 | if not mobj:
143 | raise ValueError(f"Invalid timestamp text: {text}")
144 | hours = int(mobj.group("hr") or 0)
145 | minutes = int(mobj.group("min") or 0)
146 | seconds = int(mobj.group("sec") or 0)
147 | milliseconds = int((mobj.group("ms") or "0").ljust(3, "0"))
148 | return hours * 60 * 60 * 1000 + minutes * 60 * 1000 + seconds * 1000 + milliseconds
149 |
150 |
151 | def parse_duration_to_seconds(text: str) -> int:
152 | """
153 | Converts a duration string into seconds
154 |
155 | :param text: A duration string, e.g. "10:15", "10:15.300", "1:10:15"
156 | :return:
157 | """
158 | return round(parse_duration_to_milliseconds(text) / 1000.0)
159 |
160 |
161 | def mp3_duration_ms(filename: Path) -> int:
162 | # Ref: https://github.com/ping/odmpy/pull/3
163 | # returns the length of the mp3 in ms
164 |
165 | # eyeD3's audio length function:
166 | # audiofile.info.time_secs
167 | # returns incorrect times due to its header computation
168 | # mutagen does not have this issue
169 | audio = MP3(filename)
170 | if not audio.info:
171 | raise ValueError(f"Unable to parse MP3 info from: {filename}")
172 | return int(round(audio.info.length * 1000))
173 |
174 |
175 | # From django
176 | def slugify(value: str, allow_unicode: bool = False) -> str:
177 | """
178 | Convert to ASCII if 'allow_unicode' is False. Convert spaces to hyphens.
179 | Remove characters that aren't alphanumerics, underscores, or hyphens.
180 | Convert to lowercase. Also strip leading and trailing whitespace.
181 | """
182 | if allow_unicode:
183 | value = unicodedata.normalize("NFKC", value)
184 | value = re.sub(r"[^\w\s-]", "", value, flags=re.U).strip().lower()
185 | return re.sub(r"[-\s]+", "-", value, flags=re.U)
186 | value = (
187 | unicodedata.normalize("NFKD", value).encode("ascii", "ignore").decode("ascii")
188 | )
189 | value = re.sub(r"[^\w\s-]", "", value).strip().lower()
190 | return re.sub(r"[-\s]+", "-", value)
191 |
--------------------------------------------------------------------------------
/tests/data/audiobook/odm/media.json:
--------------------------------------------------------------------------------
1 | {"firstCreatorId":411244,"youngAdultEligible":false,"juvenileEligible":false,"visitorEligible":false,"isPreReleaseTitle":false,"isPublicPerformanceAllowed":false,"isPublicDomain":false,"isBundledChild":false,"unitsSold":162,"popularity":908,"subjects":[{"name":"Fiction","id":"26"},{"name":"Science Fiction","id":"80"}],"bisacCodes":["FIC028000","FIC028100"],"bisac":[{"description":"Fiction / Science Fiction / General","code":"FIC028000"},{"description":"Fiction / Science Fiction / Cyberpunk","code":"FIC028100"}],"levels":[],"creators":[{"id":411244,"sortName":"Doctorow, Cory","role":"Author","name":"Cory Doctorow"},{"id":648330,"sortName":"Benson, Amber","role":"Narrator","name":"Amber Benson"}],"languages":[{"name":"English","id":"en"}],"ratings":{"maturityLevel":{"name":"General content","id":"generalcontent"},"naughtyScore":{"name":"General content","id":"GeneralContent"}},"reviewCounts":{"publisherSupplier":0,"premium":1},"publisher":{"name":"Cordoc-Co LLC","id":"250661"},"keywords":[],"sample":{"href":"https://samples.overdrive.com/?crid=0fef5121-bb1f-42a5-b62a-d9fded939d50&.epub-sample.overdrive.com"},"bundledContentChildrenTitleIds":[],"constraints":{"isDisneyEulaRequired":false},"type":{"name":"Audiobook","id":"audiobook"},"covers":{"cover150Wide":{"primaryColor":{"rgb":{"blue":255,"green":15,"red":0},"hex":"#000FFF"},"width":150,"height":200,"href":"https://img1.od-cdn.com/ImageType-150/7552-1/0FE/F51/21/{0FEF5121-BB1F-42A5-B62A-D9FDED939D50}Img150.jpg"},"cover300Wide":{"primaryColor":{"rgb":{"blue":255,"green":13,"red":1},"hex":"#010DFF"},"width":300,"height":400,"href":"https://img1.od-cdn.com/ImageType-400/7552-1/0FE/F51/21/{0FEF5121-BB1F-42A5-B62A-D9FDED939D50}Img400.jpg"},"cover510Wide":{"primaryColor":{"rgb":{"blue":255,"green":13,"red":1},"hex":"#010DFF"},"width":510,"height":680,"href":"https://img1.od-cdn.com/ImageType-100/7552-1/{0FEF5121-BB1F-42A5-B62A-D9FDED939D50}Img100.jpg"}},"formats":[{"isBundleParent":false,"hasAudioSynchronizedText":false,"identifiers":[{"value":"9781664913257","type":"ISBN"}],"rights":[],"bundledContent":[],"sample":{"href":"https://samples.overdrive.com/?crid=0fef5121-bb1f-42a5-b62a-d9fded939d50&.epub-sample.overdrive.com"},"id":"audiobook-overdrive","name":"OverDrive Listen audiobook","onSaleDateUtc":"2020-10-13T04:00:00Z","fileSize":432378560,"fulfillmentType":"bifocal","isbn":"9781664913257","duration":"15:00:47"},{"isBundleParent":false,"hasAudioSynchronizedText":false,"identifiers":[{"value":"9781664913257","type":"ISBN"}],"rights":[],"bundledContent":[],"sample":{"href":"https://excerpts.cdn.overdrive.com/FormatType-425/7552-1/5754614-AttackSurface.mp3"},"id":"audiobook-mp3","name":"MP3 audiobook","partCount":17,"onSaleDateUtc":"2020-10-13T04:00:00Z","fileSize":432437650,"fulfillmentType":"odm","isbn":"9781664913257","duration":"15:07:46"}],"publisherAccount":{"name":"Findaway","id":"38413"},"detailedSeries":{"rank":15,"seriesId":503067,"seriesName":"Little Brother"},"id":"5754614","firstCreatorName":"Cory Doctorow","firstCreatorSortName":"Doctorow, Cory","title":"Attack Surface","sortTitle":"Attack Surface","starRating":3.4,"starRatingCount":47,"edition":"Unabridged","publishDate":"2020-10-13T04:00:00Z","publishDateText":"10/13/2020","estimatedReleaseDate":"2020-10-13T04:00:00Z","isBundleChild":false,"description":"Cory Doctorow's Attack Surface is a standalone novel set in the world of New York Times bestsellers Little Brother and Homeland.
Most days, Masha Maximow was sure she'd chosen the winning side.
In her day job as a counterterrorism wizard for an transnational cybersecurity firm, she made the hacks that allowed repressive regimes to spy on dissidents, and manipulate their every move. The perks were fantastic, and the pay was obscene.
Just for fun, and to piss off her masters, Masha sometimes used her mad skills to help those same troublemakers evade detection, if their cause was just. It was a dangerous game and a hell of a rush. But seriously self-destructive. And unsustainable.
When her targets were strangers in faraway police states, it was easy to compartmentalize, to ignore the collateral damage of murder, rape, and torture. But when it hits close to home, and the hacks and exploits she's devised are directed at her friends and family—including boy wonder Marcus Yallow, her old crush and archrival, and his entourage of naïve idealists—Masha realizes she has to choose.
And whatever choice she makes, someone is going to get hurt.
","fullDescription":"Cory Doctorow's Attack Surface is a standalone novel set in the world of New York Times bestsellers Little Brother and Homeland.
Most days, Masha Maximow was sure she'd chosen the winning side.
In her day job as a counterterrorism wizard for an transnational cybersecurity firm, she made the hacks that allowed repressive regimes to spy on dissidents, and manipulate their every move. The perks were fantastic, and the pay was obscene.
Just for fun, and to piss off her masters, Masha sometimes used her mad skills to help those same troublemakers evade detection, if their cause was just. It was a dangerous game and a hell of a rush. But seriously self-destructive. And unsustainable.
When her targets were strangers in faraway police states, it was easy to compartmentalize, to ignore the collateral damage of murder, rape, and torture. But when it hits close to home, and the hacks and exploits she's devised are directed at her friends and family—including boy wonder Marcus Yallow, her old crush and archrival, and his entourage of naïve idealists—Masha realizes she has to choose.
And whatever choice she makes, someone is going to get hurt.
","shortDescription":"Cory Doctorow's Attack Surface is a standalone novel set in the world of New York Times bestsellers Little Brother and Homeland.
Most days, Masha Maximow was sure she'd chosen the winning side.
In her day job as a counterterrorism wizard for an transnational cybersecurity firm, she made the hacks that allowed repressive regimes to spy on dissidents, and manipulate their every move. The perks were fantastic, and the pay was obscene.
Just for fun, and to piss off her masters, Masha sometimes used her mad skills to help those same troublemakers evade detection, if their cause was just. It was a dangerous game and a hell of a rush. But seriously self-destructive. And unsustainable.
When her targets were strangers in faraway police states, it was easy to compartmentalize, to ignore the collateral damage of murder, rape, and torture. But when it hits close to home, and the hacks and exploits she's devised are directed...","series":"Little Brother","reserveId":"0fef5121-bb1f-42a5-b62a-d9fded939d50"}
--------------------------------------------------------------------------------
/tests/overdrive_tests.py:
--------------------------------------------------------------------------------
1 | import logging
2 |
3 | import requests
4 |
5 | from odmpy.overdrive import OverDriveClient
6 | from tests.base import BaseTestCase
7 |
8 | test_logger = logging.getLogger(__name__)
9 | test_logger.setLevel(logging.WARNING)
10 | client_logger = logging.getLogger(OverDriveClient.__module__)
11 | client_logger.setLevel(logging.WARNING)
12 | requests_logger = logging.getLogger("urllib3")
13 | requests_logger.setLevel(logging.WARNING)
14 | requests_logger.propagate = True
15 |
16 |
17 | class OverDriveClientTests(BaseTestCase):
18 | def setUp(self):
19 | super().setUp()
20 | self.client = OverDriveClient(retry=1)
21 |
22 | def tearDown(self) -> None:
23 | super().tearDown()
24 | self.client.session.close()
25 |
26 | def test_media(self):
27 | item = self.client.media("284716")
28 | for k in (
29 | "id",
30 | "title",
31 | "sortTitle",
32 | "description",
33 | "fullDescription",
34 | "shortDescription",
35 | "publishDate",
36 | "type",
37 | "formats",
38 | "covers",
39 | "languages",
40 | "creators",
41 | "subjects",
42 | "starRating",
43 | "starRatingCount",
44 | "unitsSold",
45 | "popularity",
46 | ):
47 | with self.subTest(key=k):
48 | self.assertIn(k, item, msg=f'"{k}" not found')
49 |
50 | def test_media_bulk(self):
51 | items = self.client.media_bulk(["284716", "5704038"])
52 | self.assertEqual(len(items), 2)
53 | for item in items:
54 | for k in (
55 | "id",
56 | "title",
57 | "sortTitle",
58 | "description",
59 | "fullDescription",
60 | "shortDescription",
61 | "publishDate",
62 | "type",
63 | "formats",
64 | "covers",
65 | "languages",
66 | "creators",
67 | "subjects",
68 | "starRating",
69 | "starRatingCount",
70 | "unitsSold",
71 | "popularity",
72 | ):
73 | with self.subTest(key=k):
74 | self.assertIn(k, item, msg=f'"{k}" not found')
75 |
76 | def test_library(self):
77 | for library_key in ("lapl", "ocpl"):
78 | with self.subTest(library_key=library_key):
79 | library = self.client.library(library_key)
80 | for k in (
81 | "recommendToLibraryEnabled",
82 | "lastModifiedDate",
83 | "allowAnonymousSampling",
84 | "allowDeepSearch",
85 | "isDemo",
86 | "areLuckyDayTitlesAllocated",
87 | "canAddLibrariesInSora",
88 | "isLuckyDayEnabled",
89 | "isLexisNexis",
90 | "isAuroraEnabled",
91 | "isInstantAccessEnabled",
92 | "hasAdvantageAccounts",
93 | "isAutocompleteEnabled",
94 | "allowRecommendToLibrary",
95 | "isConsortium",
96 | "accessId",
97 | "websiteId",
98 | "accounts",
99 | "settings",
100 | "links",
101 | "messages",
102 | "defaultLanguage",
103 | "supportedLanguages",
104 | "formats",
105 | "enabledPlatforms",
106 | "visitableLibraries",
107 | "luckyDayPreferredLendingPeriods",
108 | "visitorsHaveLowerHoldPriority",
109 | "visitorsCanRecommendTitles",
110 | "visitorsCanPlaceHolds",
111 | "isReadingHistoryEnabled",
112 | "parentCRAccessId",
113 | "showcaseTarget",
114 | "type",
115 | "status",
116 | "name",
117 | "fulfillmentId",
118 | "visitorKey",
119 | "preferredKey",
120 | "id",
121 | ):
122 | with self.subTest(key=k):
123 | self.assertIn(k, library, msg=f'"{k}" not found')
124 |
125 | def test_library_media_availability(self):
126 | availability = self.client.library_media_availability("lapl", "1330527")
127 | for k in (
128 | "isAdvantageFiltered",
129 | "youngAdultEligible",
130 | "juvenileEligible",
131 | "visitorEligible",
132 | "isRecommendableToLibrary",
133 | "isHoldable",
134 | "isOwned",
135 | "isFastlane",
136 | "isAvailable",
137 | "formats",
138 | "estimatedWaitDays",
139 | "holdsRatio",
140 | "holdsCount",
141 | "luckyDayOwnedCopies",
142 | "luckyDayAvailableCopies",
143 | "ownedCopies",
144 | "availableCopies",
145 | "availabilityType",
146 | "id",
147 | ):
148 | with self.subTest(key=k):
149 | self.assertIn(k, availability, msg=f'"{k}" not found')
150 |
151 | with self.assertRaises(requests.HTTPError) as context:
152 | self.client.library_media_availability("brooklyn", "2006069")
153 | self.assertEqual(context.exception.response.status_code, 404)
154 |
155 | def test_library_media(self):
156 | media = self.client.library_media("lapl", "7017021")
157 |
158 | for k in (
159 | "id",
160 | "title",
161 | "sortTitle",
162 | "description",
163 | "publishDate",
164 | "type",
165 | "formats",
166 | "covers",
167 | "languages",
168 | "creators",
169 | "subjects",
170 | "isAdvantageFiltered",
171 | "youngAdultEligible",
172 | "juvenileEligible",
173 | "visitorEligible",
174 | "isRecommendableToLibrary",
175 | "isHoldable",
176 | "isOwned",
177 | "isFastlane",
178 | "isAvailable",
179 | "isBundledChild",
180 | ):
181 | with self.subTest(key=k):
182 | self.assertIn(k, media, msg=f'"{k}" not found')
183 |
--------------------------------------------------------------------------------
/odmpy/constants.py:
--------------------------------------------------------------------------------
1 | # Copyright (C) 2021 github.com/ping
2 | #
3 | # This file is part of odmpy.
4 | #
5 | # odmpy is free software: you can redistribute it and/or modify
6 | # it under the terms of the GNU General Public License as published by
7 | # the Free Software Foundation, either version 3 of the License, or
8 | # (at your option) any later version.
9 | #
10 | # odmpy is distributed in the hope that it will be useful,
11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | # GNU General Public License for more details.
14 | #
15 | # You should have received a copy of the GNU General Public License
16 | # along with odmpy. If not, see .
17 | #
18 |
19 | #
20 | # Constants mainly for use with the legacy ODM processing
21 | #
22 |
23 | OMC = "1.2.0"
24 | OS = "10.11.6"
25 | UA = "OverDrive Media Console"
26 | UA_LONG = "OverDrive Media Console/3.7.0.28 iOS/10.3.3"
27 |
28 | PERFORMER_FID = b"TPE3"
29 | LANGUAGE_FID = b"TLAN"
30 |
31 | # Ref: https://github.com/ping/odmpy/issues/19
32 | UNSUPPORTED_PARSER_ENTITIES = {
33 | # https://www.freeformatter.com/html-entities.html#iso88591-characters
34 | "Agrave": "À",
35 | "Aacute": "Á",
36 | "Acirc": "Â",
37 | "Atilde": "Ã",
38 | "Auml": "Ä",
39 | "Aring": "Å",
40 | "AElig": "Æ",
41 | "Ccedil": "Ç",
42 | "Egrave": "È",
43 | "Eacute": "É",
44 | "Ecirc": "Ê",
45 | "Euml": "Ë",
46 | "Igrave": "Ì",
47 | "Iacute": "Í",
48 | "Icirc": "Î",
49 | "Iuml": "Ï",
50 | "ETH": "Ð",
51 | "Ntilde": "Ñ",
52 | "Ograve": "Ò",
53 | "Oacute": "Ó",
54 | "Ocirc": "Ô",
55 | "Otilde": "Õ",
56 | "Ouml": "Ö",
57 | "Oslash": "Ø",
58 | "Ugrave": "Ù",
59 | "Uacute": "Ú",
60 | "Ucirc": "Û",
61 | "Uuml": "Ü",
62 | "Yacute": "Ý",
63 | "THORN": "Þ",
64 | "szlig": "ß",
65 | "agrave": "à",
66 | "aacute": "á",
67 | "acirc": "â",
68 | "atilde": "ã",
69 | "auml": "ä",
70 | "aring": "å",
71 | "aelig": "æ",
72 | "ccedil": "ç",
73 | "egrave": "è",
74 | "eacute": "é",
75 | "ecirc": "ê",
76 | "euml": "ë",
77 | "igrave": "ì",
78 | "iacute": "í",
79 | "icirc": "î",
80 | "iuml": "ï",
81 | "eth": "ð",
82 | "ntilde": "ñ",
83 | "ograve": "ò",
84 | "oacute": "ó",
85 | "ocirc": "ô",
86 | "otilde": "õ",
87 | "ouml": "ö",
88 | "oslash": "ø",
89 | "ugrave": "ù",
90 | "uacute": "ú",
91 | "ucirc": "û",
92 | "uuml": "ü",
93 | "yacute": "ý",
94 | "thorn": "þ",
95 | "yuml": "ÿ",
96 | # https://www.freeformatter.com/html-entities.html#iso88591-symbols
97 | "nbsp": " ",
98 | "iexcl": "¡",
99 | "cent": "¢",
100 | "pound": "£",
101 | "curren": "¤",
102 | "yen": "¥",
103 | "brvbar": "¦",
104 | "sect": "§",
105 | "uml": "¨",
106 | "copy": "©",
107 | "ordf": "ª",
108 | "laquo": "«",
109 | "not": "¬",
110 | "shy": "",
111 | "reg": "®",
112 | "macr": "¯",
113 | "deg": "°",
114 | "plusmn": "±",
115 | "sup2": "²",
116 | "sup3": "³",
117 | "acute": "´",
118 | "micro": "µ",
119 | "para": "¶",
120 | "cedil": "¸",
121 | "sup1": "¹",
122 | "ordm": "º",
123 | "raquo": "»",
124 | "frac14": "¼",
125 | "frac12": "½",
126 | "frac34": "¾",
127 | "iquest": "¿",
128 | "times": "×",
129 | "divide": "÷",
130 | # https://www.freeformatter.com/html-entities.html#math-symbols
131 | "forall": "∀",
132 | "part": "∂",
133 | "exist": "∃",
134 | "empty": "∅",
135 | "nabla": "∇",
136 | "isin": "∈",
137 | "notin": "∉",
138 | "ni": "∋",
139 | "prod": "∏",
140 | "sum": "∑",
141 | "minus": "−",
142 | "lowast": "∗",
143 | "radic": "√",
144 | "prop": "∝",
145 | "infin": "∞",
146 | "ang": "∠",
147 | "and": "∧",
148 | "or": "∨",
149 | "cap": "∩",
150 | "cup": "∪",
151 | "int": "∫",
152 | "there4": "∴",
153 | "sim": "∼",
154 | "cong": "≅",
155 | "asymp": "≈",
156 | "ne": "≠",
157 | "equiv": "≡",
158 | "le": "≤",
159 | "ge": "≥",
160 | "sub": "⊂",
161 | "sup": "⊃",
162 | "nsub": "⊄",
163 | "sube": "⊆",
164 | "supe": "⊇",
165 | "oplus": "⊕",
166 | "otimes": "⊗",
167 | "perp": "⊥",
168 | "sdot": "⋅",
169 | # https://www.freeformatter.com/html-entities.html#greek-letters
170 | "Alpha": "Α",
171 | "Beta": "Β",
172 | "Gamma": "Γ",
173 | "Delta": "Δ",
174 | "Epsilon": "Ε",
175 | "Zeta": "Ζ",
176 | "Eta": "Η",
177 | "Theta": "Θ",
178 | "Iota": "Ι",
179 | "Kappa": "Κ",
180 | "Lambda": "Λ",
181 | "Mu": "Μ",
182 | "Nu": "Ν",
183 | "Xi": "Ξ",
184 | "Omicron": "Ο",
185 | "Pi": "Π",
186 | "Rho": "Ρ",
187 | "Sigma": "Σ",
188 | "Tau": "Τ",
189 | "Upsilon": "Υ",
190 | "Phi": "Φ",
191 | "Chi": "Χ",
192 | "Psi": "Ψ",
193 | "Omega": "Ω",
194 | "alpha": "α",
195 | "beta": "β",
196 | "gamma": "γ",
197 | "delta": "δ",
198 | "epsilon": "ε",
199 | "zeta": "ζ",
200 | "eta": "η",
201 | "theta": "θ",
202 | "iota": "ι",
203 | "kappa": "κ",
204 | "lambda": "λ",
205 | "mu": "μ",
206 | "nu": "ν",
207 | "xi": "ξ",
208 | "omicron": "ο",
209 | "pi": "π",
210 | "rho": "ρ",
211 | "sigmaf": "ς",
212 | "sigma": "σ",
213 | "tau": "τ",
214 | "upsilon": "υ",
215 | "phi": "φ",
216 | "chi": "χ",
217 | "psi": "ψ",
218 | "omega": "ω",
219 | "thetasym": "ϑ",
220 | "upsih": "ϒ",
221 | "piv": "ϖ",
222 | # https://www.freeformatter.com/html-entities.html#misc-html-entities
223 | "OElig": "Œ",
224 | "oelig": "œ",
225 | "Scaron": "Š",
226 | "scaron": "š",
227 | "Yuml": "Ÿ",
228 | "fnof": "ƒ",
229 | "circ": "ˆ",
230 | "tilde": "˜",
231 | "ensp": " ",
232 | "emsp": " ",
233 | "thinsp": " ",
234 | "zwnj": "",
235 | "zwj": "",
236 | "lrm": "",
237 | "rlm": "", # pylint: disable=(bidirectional-unicode
238 | "ndash": "–",
239 | "mdash": "—",
240 | "lsquo": "‘",
241 | "rsquo": "’",
242 | "sbquo": "‚",
243 | "ldquo": "“",
244 | "rdquo": "”",
245 | "bdquo": "„",
246 | "dagger": "†",
247 | "Dagger": "‡",
248 | "bull": "•",
249 | "hellip": "…",
250 | "permil": "‰",
251 | "prime": "′",
252 | "Prime": "″",
253 | "lsaquo": "‹",
254 | "rsaquo": "›",
255 | "oline": "‾",
256 | "euro": "€",
257 | "trade": "™",
258 | "larr": "←",
259 | "uarr": "↑",
260 | "rarr": "→",
261 | "darr": "↓",
262 | "harr": "↔",
263 | "crarr": "↵",
264 | "lceil": "⌈",
265 | "rceil": "⌉",
266 | "lfloor": "⌊",
267 | "rfloor": "⌋",
268 | "loz": "◊",
269 | "spades": "♠",
270 | "clubs": "♣",
271 | "hearts": "♥",
272 | "diams": "♦",
273 | }
274 |
--------------------------------------------------------------------------------
/odmpy/overdrive.py:
--------------------------------------------------------------------------------
1 | # Copyright (C) 2023 github.com/ping
2 | #
3 | # This file is part of odmpy.
4 | #
5 | # odmpy is free software: you can redistribute it and/or modify
6 | # it under the terms of the GNU General Public License as published by
7 | # the Free Software Foundation, either version 3 of the License, or
8 | # (at your option) any later version.
9 | #
10 | # odmpy is distributed in the hope that it will be useful,
11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | # GNU General Public License for more details.
14 | #
15 | # You should have received a copy of the GNU General Public License
16 | # along with odmpy. If not, see .
17 | #
18 |
19 | import logging
20 | from typing import Optional, Dict, List
21 | from urllib.parse import urljoin
22 |
23 | import requests
24 | from requests.adapters import HTTPAdapter, Retry
25 |
26 | #
27 | # Basic skeletal client for the OverDrive Thunder API
28 | #
29 |
30 | USER_AGENT = (
31 | "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_1) AppleWebKit/605.1.15 (KHTML, like Gecko) " # noqa
32 | "Version/14.0.2 Safari/605.1.15"
33 | )
34 | SITE_URL = "https://libbyapp.com"
35 | THUNDER_API_URL = "https://thunder.api.overdrive.com/v2/"
36 | CLIENT_ID = "dewey"
37 |
38 |
39 | class OverDriveClient(object):
40 | """
41 | A really simplified OverDrive Thunder API client
42 | """
43 |
44 | def __init__(self, **kwargs) -> None:
45 | """
46 | Constructor.
47 |
48 | :param kwargs:
49 | - user_agent: User Agent string for requests
50 | - timeout: The timeout interval for a network request. Default 15 (seconds).
51 | - retries: The number of times to retry a network request on failure. Default 0.
52 | """
53 | self.logger = logging.getLogger(__name__)
54 | self.user_agent = kwargs.pop("user_agent", USER_AGENT)
55 | self.timeout = int(kwargs.pop("timeout", 15))
56 | self.retries = int(kwargs.pop("retry", 0))
57 |
58 | session = requests.Session()
59 | adapter = HTTPAdapter(max_retries=Retry(total=self.retries, backoff_factor=0.1))
60 | # noinspection HttpUrlsUsage
61 | for prefix in ("http://", "https://"):
62 | session.mount(prefix, adapter)
63 | self.session = kwargs.pop("session", None) or session
64 |
65 | def default_headers(self) -> Dict:
66 | """
67 | Default http request headers.
68 |
69 | :return:
70 | """
71 | headers = {
72 | "User-Agent": self.user_agent,
73 | "Referer": SITE_URL + "/",
74 | "Origin": SITE_URL,
75 | "Cache-Control": "no-cache",
76 | "Pragma": "no-cache",
77 | }
78 | return headers
79 |
80 | def default_params(self) -> Dict:
81 | """
82 | Default set of GET request parameters.
83 |
84 | :return:
85 | """
86 | params = {"x-client-id": CLIENT_ID}
87 | return params
88 |
89 | def make_request(
90 | self,
91 | endpoint: str,
92 | params: Optional[Dict] = None,
93 | data: Optional[Dict] = None,
94 | headers: Optional[Dict] = None,
95 | method: Optional[str] = None,
96 | ):
97 | """
98 | Sends an API request.
99 |
100 | :param endpoint: Relative path to endpoint
101 | :param params: URL query parameters
102 | :param data: POST data parameters
103 | :param method: HTTP method, e.g. 'PUT'
104 | :param headers: Custom headers
105 | :return: Union[List, Dict, str]
106 | """
107 | endpoint_url = urljoin(THUNDER_API_URL, endpoint)
108 | headers = headers or self.default_headers()
109 | if not method:
110 | # try to set an HTTP method
111 | if data is not None:
112 | method = "POST"
113 | else:
114 | method = "GET"
115 |
116 | req = requests.Request(
117 | method,
118 | endpoint_url,
119 | headers=headers,
120 | params=params,
121 | data=data,
122 | )
123 | res = self.session.send(self.session.prepare_request(req), timeout=self.timeout)
124 | self.logger.debug("body: %s", res.text)
125 | res.raise_for_status()
126 |
127 | if res.headers.get("content-type", "").startswith("application/json"):
128 | return res.json()
129 | return res.text
130 |
131 | def media(self, title_id: str, **kwargs) -> Dict:
132 | """
133 | Retrieve a title.
134 | Title id can also be a reserve id.
135 |
136 | :param title_id: A unique id that identifies the content.
137 | :return:
138 | """
139 | params = self.default_params()
140 | params.update(kwargs)
141 | return self.make_request(f"media/{title_id}", params=params)
142 |
143 | def media_bulk(self, title_ids: List[str], **kwargs) -> List[Dict]:
144 | """
145 | Retrieve a list of titles.
146 |
147 | :param title_ids: The ids passed in this request can be titleIds or reserveIds.
148 | :return:
149 | """
150 | params = self.default_params()
151 | params.update({"titleIds": ",".join(title_ids)})
152 | params.update(kwargs)
153 | return self.make_request("media/bulk", params=params)
154 |
155 | def library(self, library_key: str, **kwargs) -> Dict:
156 | """
157 | Get a library's configuration data.
158 |
159 | :param library_key: A unique key that identifies the library, e.g. lapl
160 | :param kwargs:
161 | :return:
162 | """
163 | params = self.default_params()
164 | params.update(kwargs)
165 | return self.make_request(f"libraries/{library_key}", params=params)
166 |
167 | def library_media(self, library_key: str, title_id: str, **kwargs) -> dict:
168 | """
169 | Get title.
170 |
171 | :param library_key: A unique key that identifies the library
172 | :param title_id:
173 | :return:
174 | """
175 | params = self.default_params()
176 | params.update({"titleIds": title_id})
177 | params.update(kwargs)
178 | return self.make_request(
179 | f"libraries/{library_key}/media/{title_id}", params=params
180 | )
181 |
182 | def library_media_availability(
183 | self, library_key: str, title_id: str, **kwargs
184 | ) -> dict:
185 | """
186 | Get title availability.
187 |
188 | :param library_key: A unique key that identifies the library, e.g. lapl
189 | :param title_id:
190 | :param kwargs:
191 | :return:
192 | """
193 | params = self.default_params()
194 | params.update(kwargs)
195 | return self.make_request(
196 | f"libraries/{library_key}/media/{title_id}/availability", params=params
197 | )
198 |
--------------------------------------------------------------------------------
/tests/data/opf.schema.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
20 |
21 |
22 |