meta_oxide 0.1.1

Universal metadata extraction library supporting 13 formats (HTML Meta, Open Graph, Twitter Cards, JSON-LD, Microdata, Microformats, RDFa, Dublin Core, Web App Manifest, oEmbed, rel-links, Images, SEO) with 7 language bindings
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
"""
Tests for JSON-LD Review type (Schema.org)

Tests the extraction and parsing of Review structured data following TDD approach.
"""

import meta_oxide
import pytest


class TestReviewBasic:
    """Test basic Review extraction"""

    def test_review_basic(self):
        """Test minimal review with reviewBody"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "reviewBody": "This is a great product! Highly recommend it to everyone."
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"
        assert (
            objects[0]["reviewBody"] == "This is a great product! Highly recommend it to everyone."
        )

    def test_review_with_rating(self):
        """Test review with reviewRating object"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "reviewBody": "Excellent quality and fast shipping.",
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": "5",
                    "bestRating": "5"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"
        assert objects[0]["reviewBody"] == "Excellent quality and fast shipping."
        assert "reviewRating" in objects[0]

    def test_review_with_item(self):
        """Test review with itemReviewed product/service"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "reviewBody": "Amazing headphones with great sound quality.",
                "itemReviewed": {
                    "@type": "Product",
                    "name": "Wireless Headphones XM5",
                    "brand": "Sony"
                },
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": "4.5"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"
        assert "itemReviewed" in objects[0]
        assert "reviewRating" in objects[0]

    def test_review_with_author(self):
        """Test review with author Person object"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "reviewBody": "Great service and friendly staff.",
                "author": {
                    "@type": "Person",
                    "name": "Jane Doe"
                },
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": "5"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"
        assert "author" in objects[0]

    def test_review_complete(self):
        """Test review with all fields"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "name": "Excellent Product Review",
                "reviewBody": "I've been using this product for three months now and it exceeded all my expectations. The build quality is outstanding, performance is top-notch, and customer service was excellent.",
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": "5",
                    "bestRating": "5",
                    "worstRating": "1"
                },
                "itemReviewed": {
                    "@type": "Product",
                    "name": "Premium Laptop Pro",
                    "brand": {
                        "@type": "Brand",
                        "name": "TechBrand"
                    },
                    "sku": "LAPTOP-PRO-2024"
                },
                "author": {
                    "@type": "Person",
                    "name": "John Smith",
                    "url": "https://example.com/users/johnsmith"
                },
                "datePublished": "2024-01-15",
                "publisher": {
                    "@type": "Organization",
                    "name": "Review Site Inc",
                    "url": "https://reviews.example.com"
                },
                "url": "https://reviews.example.com/laptop-pro-review"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"
        assert objects[0]["name"] == "Excellent Product Review"
        assert "reviewBody" in objects[0]
        assert "reviewRating" in objects[0]
        assert "itemReviewed" in objects[0]
        assert "author" in objects[0]
        assert objects[0]["datePublished"] == "2024-01-15"
        assert "publisher" in objects[0]
        assert objects[0]["url"] == "https://reviews.example.com/laptop-pro-review"


class TestReviewVariations:
    """Test various Review variations"""

    def test_review_of_service(self):
        """Test review of a service (not product)"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "reviewBody": "Excellent plumbing service, very professional.",
                "itemReviewed": {
                    "@type": "Service",
                    "name": "Emergency Plumbing",
                    "provider": {
                        "@type": "Organization",
                        "name": "ABC Plumbers"
                    }
                },
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": "5"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"
        assert "itemReviewed" in objects[0]

    def test_review_with_organization_author(self):
        """Test review with Organization as author"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "reviewBody": "After thorough testing by our lab, this product meets all standards.",
                "author": {
                    "@type": "Organization",
                    "name": "Tech Review Labs",
                    "url": "https://techlabs.example.com"
                },
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": "4.5"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"
        assert "author" in objects[0]

    def test_review_with_date_formats(self):
        """Test review with different date formats"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "reviewBody": "Good product overall.",
                "datePublished": "2024-01-15T10:30:00Z",
                "reviewRating": {
                    "@type": "Rating",
                    "ratingValue": "4"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"
        assert objects[0]["datePublished"] == "2024-01-15T10:30:00Z"

    def test_review_minimal_with_name_only(self):
        """Test review with just name field"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "name": "Quick Review"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"
        assert objects[0]["name"] == "Quick Review"


class TestReviewIntegration:
    """Test Review integration with other types"""

    def test_review_in_product(self):
        """Test Review as part of Product"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Product",
                "name": "Smart Watch Pro",
                "review": {
                    "@type": "Review",
                    "reviewBody": "Best smartwatch I've ever used!",
                    "reviewRating": {
                        "@type": "Rating",
                        "ratingValue": "5"
                    },
                    "author": {
                        "@type": "Person",
                        "name": "Alex Johnson"
                    }
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Product"
        assert "review" in objects[0]

    def test_multiple_reviews(self):
        """Test multiple separate Review objects"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "reviewBody": "First review text",
                "author": {
                    "@type": "Person",
                    "name": "User One"
                }
            }
            </script>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "reviewBody": "Second review text",
                "author": {
                    "@type": "Person",
                    "name": "User Two"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 2
        assert objects[0]["@type"] == "Review"
        assert objects[1]["@type"] == "Review"

    def test_review_in_graph(self):
        """Test Review in @graph array"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@graph": [
                    {
                        "@type": "Product",
                        "name": "Test Product"
                    },
                    {
                        "@type": "Review",
                        "reviewBody": "Great product!",
                        "reviewRating": {
                            "@type": "Rating",
                            "ratingValue": "5"
                        }
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 2
        assert objects[0]["@type"] == "Product"
        assert objects[1]["@type"] == "Review"


class TestReviewEdgeCases:
    """Test edge cases for Review"""

    def test_review_empty_fields(self):
        """Test review with empty optional fields"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"

    def test_review_with_null_values(self):
        """Test review with explicit null values"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "reviewBody": "Good product",
                "name": null,
                "url": null
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"
        assert objects[0]["reviewBody"] == "Good product"

    def test_review_unicode_content(self):
        """Test review with Unicode characters"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Review",
                "name": "素晴らしい製品レビュー",
                "reviewBody": "この製品は素晴らしいです!",
                "author": {
                    "@type": "Person",
                    "name": "田中太郎"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Review"
        assert objects[0]["name"] == "素晴らしい製品レビュー"
        assert objects[0]["reviewBody"] == "この製品は素晴らしいです!"


if __name__ == "__main__":
    pytest.main([__file__, "-v"])