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

"""
Tests for JSON-LD AggregateRating type (Schema.org)

Tests the extraction and parsing of AggregateRating structured data following TDD approach.
AggregateRating represents the average rating from multiple reviews/ratings.
"""

import meta_oxide
import pytest


class TestAggregateRatingBasic:
    """Test basic AggregateRating extraction"""

    def test_aggregaterating_basic(self):
        """Test minimal rating with ratingValue"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "AggregateRating",
                "ratingValue": 4.5
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "AggregateRating"
        assert objects[0]["ratingValue"] == 4.5

    def test_aggregaterating_with_bounds(self):
        """Test rating with bestRating and worstRating"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "AggregateRating",
                "ratingValue": 4.2,
                "bestRating": 5,
                "worstRating": 1
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "AggregateRating"
        assert objects[0]["ratingValue"] == 4.2
        assert objects[0]["bestRating"] == 5.0
        assert objects[0]["worstRating"] == 1.0

    def test_aggregaterating_with_counts(self):
        """Test rating with ratingCount and reviewCount"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "AggregateRating",
                "ratingValue": 4.8,
                "ratingCount": 156,
                "reviewCount": 89
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "AggregateRating"
        assert objects[0]["ratingValue"] == 4.8
        assert objects[0]["ratingCount"] == 156
        assert objects[0]["reviewCount"] == 89

    def test_aggregaterating_with_item(self):
        """Test rating with itemReviewed product"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "AggregateRating",
                "ratingValue": 4.7,
                "itemReviewed": {
                    "@type": "Product",
                    "name": "Wireless Headphones",
                    "brand": "AudioTech"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "AggregateRating"
        assert objects[0]["ratingValue"] == 4.7
        assert "itemReviewed" in objects[0]
        assert objects[0]["itemReviewed"]["@type"] == "Product"
        assert objects[0]["itemReviewed"]["name"] == "Wireless Headphones"

    def test_aggregaterating_complete(self):
        """Test rating with all fields"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "AggregateRating",
                "ratingValue": 4.6,
                "bestRating": 5,
                "worstRating": 1,
                "ratingCount": 245,
                "reviewCount": 187,
                "itemReviewed": {
                    "@type": "Product",
                    "name": "Premium Laptop",
                    "brand": "TechBrand",
                    "sku": "LAPTOP-2024"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "AggregateRating"
        assert objects[0]["ratingValue"] == 4.6
        assert objects[0]["bestRating"] == 5.0
        assert objects[0]["worstRating"] == 1.0
        assert objects[0]["ratingCount"] == 245
        assert objects[0]["reviewCount"] == 187
        assert "itemReviewed" in objects[0]
        assert objects[0]["itemReviewed"]["@type"] == "Product"


class TestAggregateRatingRealWorld:
    """Test realistic AggregateRating scenarios"""

    def test_product_rating(self):
        """Test realistic product rating example"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Product",
                "name": "Smart TV 55 inch",
                "description": "4K Ultra HD Smart Television",
                "brand": "Samsung",
                "sku": "TV-55-4K-2024",
                "aggregateRating": {
                    "@type": "AggregateRating",
                    "ratingValue": 4.5,
                    "bestRating": 5,
                    "worstRating": 1,
                    "ratingCount": 892,
                    "reviewCount": 456
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Product"
        assert objects[0]["name"] == "Smart TV 55 inch"
        assert "aggregateRating" in objects[0]
        rating = objects[0]["aggregateRating"]
        assert rating["@type"] == "AggregateRating"
        assert rating["ratingValue"] == 4.5
        assert rating["ratingCount"] == 892
        assert rating["reviewCount"] == 456

    def test_restaurant_rating(self):
        """Test restaurant rating example"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Restaurant",
                "name": "The Golden Spoon",
                "address": {
                    "@type": "PostalAddress",
                    "streetAddress": "123 Main St",
                    "addressLocality": "New York",
                    "postalCode": 10001
                },
                "aggregateRating": {
                    "@type": "AggregateRating",
                    "ratingValue": 4.8,
                    "bestRating": 5,
                    "ratingCount": 327,
                    "reviewCount": 215
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "Restaurant"
        assert objects[0]["name"] == "The Golden Spoon"
        assert "aggregateRating" in objects[0]
        rating = objects[0]["aggregateRating"]
        assert rating["@type"] == "AggregateRating"
        assert rating["ratingValue"] == 4.8
        assert rating["ratingCount"] == 327


class TestAggregateRatingEdgeCases:
    """Test edge cases for AggregateRating"""

    def test_aggregaterating_empty(self):
        """Test empty AggregateRating"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "AggregateRating"
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

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

    def test_aggregaterating_integer_rating(self):
        """Test rating with integer values"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "AggregateRating",
                "ratingValue": 4,
                "bestRating": 5,
                "ratingCount": 100
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "AggregateRating"
        assert objects[0]["ratingValue"] == 4.0
        assert objects[0]["bestRating"] == 5.0
        assert objects[0]["ratingCount"] == 100

    def test_aggregaterating_null_values(self):
        """Test rating with null values"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "AggregateRating",
                "ratingValue": 4.5,
                "bestRating": null,
                "worstRating": null
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "AggregateRating"
        assert objects[0]["ratingValue"] == 4.5

    def test_aggregaterating_decimal_precision(self):
        """Test rating with high decimal precision"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "AggregateRating",
                "ratingValue": 4.687,
                "bestRating": 5.0
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "AggregateRating"
        # Allow for floating point comparison
        assert abs(objects[0]["ratingValue"] - 4.687) < 0.001


class TestAggregateRatingIntegration:
    """Test AggregateRating integration with extract_all"""

    def test_extract_all_includes_aggregaterating(self):
        """Test that extract_all() includes AggregateRating"""
        html = """
        <html>
        <head>
            <title>Product Review Page</title>
            <meta property="og:title" content="Best Product Reviews">
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "Product",
                "name": "Test Product",
                "aggregateRating": {
                    "@type": "AggregateRating",
                    "ratingValue": 4.5,
                    "ratingCount": 100
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        data = meta_oxide.extract_all(html)

        # Should have meta tags
        assert "meta" in data
        assert data["meta"]["title"] == "Product Review Page"

        # Should have JSON-LD with Product and AggregateRating
        assert "jsonld" in data
        assert len(data["jsonld"]) == 1
        assert data["jsonld"][0]["@type"] == "Product"
        assert "aggregateRating" in data["jsonld"][0]
        assert data["jsonld"][0]["aggregateRating"]["@type"] == "AggregateRating"
        assert data["jsonld"][0]["aggregateRating"]["ratingValue"] == 4.5

    def test_multiple_ratings_in_graph(self):
        """Test multiple items with ratings in @graph"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@graph": [
                    {
                        "@type": "Product",
                        "name": "Product A",
                        "aggregateRating": {
                            "@type": "AggregateRating",
                            "ratingValue": 4.5
                        }
                    },
                    {
                        "@type": "LocalBusiness",
                        "name": "Business B",
                        "aggregateRating": {
                            "@type": "AggregateRating",
                            "ratingValue": 4.8
                        }
                    }
                ]
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 2
        assert objects[0]["@type"] == "Product"
        assert "aggregateRating" in objects[0]
        assert objects[0]["aggregateRating"]["ratingValue"] == 4.5

        assert objects[1]["@type"] == "LocalBusiness"
        assert "aggregateRating" in objects[1]
        assert objects[1]["aggregateRating"]["ratingValue"] == 4.8

    def test_aggregaterating_with_organization(self):
        """Test AggregateRating with Organization itemReviewed"""
        html = """
        <html>
        <head>
            <script type="application/ld+json">
            {
                "@context": "https://schema.org",
                "@type": "AggregateRating",
                "ratingValue": 4.3,
                "ratingCount": 521,
                "itemReviewed": {
                    "@type": "Organization",
                    "name": "Acme Corporation",
                    "url": "https://acme.example.com"
                }
            }
            </script>
        </head>
        <body></body>
        </html>
        """

        objects = meta_oxide.extract_jsonld(html)

        assert len(objects) == 1
        assert objects[0]["@type"] == "AggregateRating"
        assert objects[0]["ratingValue"] == 4.3
        assert objects[0]["itemReviewed"]["@type"] == "Organization"
        assert objects[0]["itemReviewed"]["name"] == "Acme Corporation"


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