feat: rename fields in the JSON response for more coherence

BREAKING CHANGE: the fields "details" and "ephemerides" have been switched.

Author: Jérôme Deuchnord

kosmorrolib/dumper.py

@@ -39,6 +39,7 @@ def to_string(self):
 class JsonDumper(Dumper):
     def to_string(self):
         self.ephemeris['events'] = self.events
+        self.ephemeris['ephemerides'] = self.ephemeris.pop('details')
         return json.dumps(self.ephemeris,
                           default=self._json_default,
                           indent=4)
@@ -54,6 +55,8 @@ def _json_default(obj):
         if isinstance(obj, Object):
             obj = obj.__dict__
             obj.pop('skyfield_name')
+            obj['object'] = obj.pop('name')
+            obj['details'] = obj.pop('ephemerides')
             return obj
         if isinstance(obj, AsterEphemerides):
             return obj.__dict__

test/dumper.py

@@ -18,23 +18,23 @@ def test_json_dumper_returns_correct_json(self):
                          '        "phase": "FULL_MOON",\n'
                          '        "date": "2019-10-14T00:00:00Z"\n'
                          '    },\n'
-                         '    "details": [\n'
-                         '        {\n'
-                         '            "name": "Mars",\n'
-                         '            "ephemerides": {\n'
-                         '                "rise_time": null,\n'
-                         '                "culmination_time": null,\n'
-                         '                "set_time": null\n'
-                         '            }\n'
-                         '        }\n'
-                         '    ],\n'
                          '    "events": [\n'
                          '        {\n'
                          '            "event_type": "OPPOSITION",\n'
                          '            "object": "Mars",\n'
                          '            "start_time": "2018-07-27T05:12:00Z",\n'
                          '            "end_time": null\n'
                          '        }\n'
+                         '    ],\n'
+                         '    "ephemerides": [\n'
+                         '        {\n'
+                         '            "object": "Mars",\n'
+                         '            "details": {\n'
+                         '                "rise_time": null,\n'
+                         '                "culmination_time": null,\n'
+                         '                "set_time": null\n'
+                         '            }\n'
+                         '        }\n'
                          '    ]\n'
                          '}', JsonDumper(data,
                                          [Event('OPPOSITION', Planet('Mars', 'MARS'),