Skip to content

Commit

Permalink
pls adapt the NINJS outputformatter to provide better references for …
Browse files Browse the repository at this point in the history 
…all renditions [SDCP-723] (#2489)

* udpate renditions settings in NINJS formatter and parser

* fix black

* add new renditions config

* format and populate data based on new config

* reformat code via black

* refactore rendition parsing

* fix pytest

* change type

* minor change and update tests

* fix tests and addressed comment
  • Loading branch information
@devketanpro
devketanpro authored Nov 16, 2023
1 parent cbcb4fc commit cf6dae4
Show file tree
Hide file tree
Showing 5 changed files with 141 additions and 56 deletions.
146 changes: 94 additions & 52 deletions features/ingest.feature
View file
Original file line number Diff line number Diff line change
Expand Up @@ -477,18 +477,29 @@ Feature: Fetch From Ingest
"type":"picture",
"state":"ingested",
"renditions":{
"baseImage":{
"width":1400
},
"thumbnail":{
},
"original":{
"original": {
"poi": {
"y": 1193,
"x": 2128
},
"href": "http://content.reuters.com/auth-server/content/tag_reuters.com_2014_newsml_LYNXMPEA6F0MT_2/tag_reuters.com_2014_binary_LYNXMPEA6F0MT-BASEIMAGE?auth_token=fake_token",
"mimetype": "image/jpeg",
"media": "599e31ec1d41c833e0b8a830",
"width": 3489,
"height": 2296
},
"viewImage":{
"baseImage": {
"poi": {
"y": 478,
"x": 854
},
"href": "http://content.reuters.com/auth-server/content/tag_reuters.com_2014_newsml_LYNXMPEA6F0MT_2/tag_reuters.com_2014_binary_LYNXMPEA6F0MT-BASEIMAGE?auth_token=fake_token",
"mimetype": "image/jpeg",
"media": "599e31ed1d41c833e0b8a840",
"width": 1400,
"height": 921
}
}
}
},
{
"type":"text",
Expand All @@ -497,11 +508,28 @@ Feature: Fetch From Ingest
"featuremedia":{
"state": "ingested",
"renditions":{
"baseImage":{
"width":1400
},
"original":{
}
"original": {
"poi": {
"y": 1193,
"x": 2128
},
"href": "http://content.reuters.com/auth-server/content/tag_reuters.com_2014_newsml_LYNXMPEA6F0MT_2/tag_reuters.com_2014_binary_LYNXMPEA6F0MT-BASEIMAGE?auth_token=fake_token",
"mimetype": "image/jpeg",
"media": "599e31ec1d41c833e0b8a830",
"width": 3489,
"height": 2296
},
"baseImage": {
"poi": {
"y": 478,
"x": 854
},
"href": "http://content.reuters.com/auth-server/content/tag_reuters.com_2014_newsml_LYNXMPEA6F0MT_2/tag_reuters.com_2014_binary_LYNXMPEA6F0MT-BASEIMAGE?auth_token=fake_token",
"mimetype": "image/jpeg",
"media": "599e31ed1d41c833e0b8a840",
"width": 1400,
"height": 921
}
}
}
}
Expand All @@ -514,7 +542,7 @@ Feature: Fetch From Ingest
@provider
Scenario: Ingest ninjs with embedded items
Given empty "ingest"
When we fetch from "ninjs" ingest "ninjs4.json" (mocking with "ninjs4_mock.json")
When we fetch from "ninjs" ingest "ninjs4.json"
And we get "/ingest"
Then we get existing resource
"""
Expand All @@ -524,19 +552,22 @@ Feature: Fetch From Ingest
"type":"picture",
"state":"ingested",
"headline": "Polizeihunde sollen effizienter trainiert werden – Klone sollen die Lösung sein.",
"renditions":{
"baseImage":{
"width":1400
"renditions": {
"original": {
"media": "Polizeihund-China-2.jpg",
"href": "https://img.futurezone.de/img/science/origs216742511/239706555-w1280-h960-q85/Polizeihund-China-2.jpg",
"mimetype": "image\/jpeg",
"height": 853,
"width": 1280
},
"thumbnail":{
},
"original":{
},
"viewImage":{
"baseImage": {
"media": "Polizeihund-China-2.jpg",
"href": "https://img.futurezone.de/img/science/origs216742511/239706555-w1280-h960-q85/Polizeihund-China-2.jpg",
"mimetype": "image\/jpeg",
"height": 853,
"width": 1280
}
}
}
},
{
"type":"picture",
Expand All @@ -549,13 +580,22 @@ Feature: Fetch From Ingest
"associations":{
"featuremedia":{
"state": "ingested",
"renditions":{
"baseImage":{
"width":1400
},
"original":{
}
}
"renditions": {
"original": {
"media": "Polizeihund-China-2.jpg",
"href": "https://img.futurezone.de/img/science/origs216742511/239706555-w1280-h960-q85/Polizeihund-China-2.jpg",
"mimetype": "image\/jpeg",
"height": 853,
"width": 1280
},
"baseImage": {
"media": "Polizeihund-China-2.jpg",
"href": "https://img.futurezone.de/img/science/origs216742511/239706555-w1280-h960-q85/Polizeihund-China-2.jpg",
"mimetype": "image\/jpeg",
"height": 853,
"width": 1280
}
}
}
}
}
Expand Down Expand Up @@ -591,25 +631,27 @@ Feature: Fetch From Ingest
"headline":"German Air Force Museum",
"state":"ingested",
"renditions":{
"baseImage" : {
"width" : 1400,
"height" : 1074,
"mimetype" : "image/jpeg"
},
"thumbnail" : {
"width":156,
"height":120,
"mimetype" : "image/jpeg"
},
"original" : {
"width" : 800,
"height" : 614,
"mimetype" : "image/jpeg"
"baseImage": {
"poi": {
"y": 382,
"x": 784
},
"media": "599faa351d41c8fdc696d904",
"width": 1400,
"height": 934,
"mimetype": "image/jpeg",
"href": "http://localhost:5000/api/upload-raw/599faa351d41c8fdc696d904?_schema=http"
},
"viewImage":{
"width" : 640,
"height" : 491,
"mimetype" : "image/jpeg"
"original": {
"poi": {
"y": 1646,
"x": 3368
},
"media": "599faa331d41c8fdc696d8b4",
"width": 6016,
"height": 4016,
"mimetype": "image/jpeg",
"href": "http://content.reuters.com/auth-server/content/tag_reuters.com_2014_newsml_LYNXMPEA6F0MT_2/tag_reuters.com_2014_binary_LYNXMPEA6F0MT-BASEIMAGE?auth_token=fake_token"
}
}
}
Expand Down
1 change: 1 addition & 0 deletions superdesk/default_settings.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -581,6 +581,7 @@ def local_to_utc_hour(hour):
},
}

NINJS_COMMON_RENDITIONS = list(RENDITIONS["picture"].keys())

#: BCRYPT work factor
BCRYPT_GENSALT_WORK_FACTOR = 12
Expand Down
40 changes: 38 additions & 2 deletions superdesk/io/feed_parsers/ninjs.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ def _transform_from_ninjs(self, ninjs):
associated_item["versioncreated"] = self.datetime(associated_item["versioncreated"])
item["associations"][key] = deepcopy(associated_item)

if ninjs.get("renditions", {}).get("baseImage"):
item["renditions"] = {"baseImage": {"href": ninjs.get("renditions", {}).get("original", {}).get("href")}}
if ninjs.get("renditions"):
item["renditions"] = self.parse_renditions(ninjs["renditions"])

if ninjs.get("located"):
item["dateline"] = {"located": {"city": ninjs.get("located")}}
Expand All @@ -146,6 +146,42 @@ def _transform_from_ninjs(self, ninjs):

return item

def parse_renditions(self, renditions):
rend = {}
for rendition_name, rendition_data in renditions.items():
parsed_rendition = {}

# Parse href
href = rendition_data.get("href", "")
if isinstance(href, str) and href:
parsed_rendition["href"] = href

# Parse width and height
width = rendition_data.get("width", None)
height = rendition_data.get("height", None)
if isinstance(width, int) and isinstance(height, int):
parsed_rendition["width"] = width
parsed_rendition["height"] = height

# Parse mimetype
mimetype = rendition_data.get("mimetype", "")
if isinstance(mimetype, str) and mimetype:
parsed_rendition["mimetype"] = mimetype

# Parse poi
poi = rendition_data.get("poi", {})
if isinstance(poi, dict) and "x" in poi and "y" in poi:
parsed_rendition["poi"] = {"x": poi["x"], "y": poi["y"]}

# Parse media
media = rendition_data.get("media", "")
if isinstance(media, str) and media:
parsed_rendition["media"] = media

if parsed_rendition:
rend[rendition_name] = parsed_rendition
return rend

def _format_qcodes(self, items):
subjects = []
for item in items:
Expand Down
2 changes: 1 addition & 1 deletion superdesk/publish/formatters/ninjs_formatter.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def __init__(self):
self.format_type = "ninjs"
self.can_preview = True
self.can_export = True
self.internal_renditions = ["original"]
self.internal_renditions = app.config.get("NINJS_COMMON_RENDITIONS", []) + ["original"]

def format(self, article, subscriber, codes=None):
try:
Expand Down
8 changes: 7 additions & 1 deletion tests/publish/formatters/ninjs_formatter_test.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,12 @@ def test_picture_formatter(self):
"href": "https://one-api.aap.com.au/api/v3/Assets/20150723001158606583/Original/download",
"mimetype": "image/jpeg",
},
"viewImage": {
"height": 401,
"href": "http://localhost:5000/api/upload/55b032041d41c8d278d21b6f/raw?_schema=http",
"mimetype": "image/jpeg",
"width": 640,
},
},
"headline": "AMAZING PICTURE",
"pubstatus": "usable",
Expand All @@ -203,7 +209,7 @@ def test_picture_formatter(self):
"embargoed": embargoed.isoformat(),
}
self.assertEqual(expected, json.loads(doc))
self.assertNotIn("viewImage", json.loads(doc).get("renditions"))
self.assertIn("viewImage", json.loads(doc).get("renditions"))

def test_composite_formatter(self):
article = {
Expand Down

0 comments on commit cf6dae4

Please sign in to comment.