daplug-core 1.0.0b5__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- daplug_core/__init__.py +0 -0
- daplug_core/base_adapter.py +39 -0
- daplug_core/dict_merger.py +55 -0
- daplug_core/json_helper.py +19 -0
- daplug_core/logger.py +15 -0
- daplug_core/publisher.py +29 -0
- daplug_core/schema_loader.py +13 -0
- daplug_core/schema_mapper.py +47 -0
- daplug_core/types.py +25 -0
- daplug_core-1.0.0b5.dist-info/METADATA +203 -0
- daplug_core-1.0.0b5.dist-info/RECORD +14 -0
- daplug_core-1.0.0b5.dist-info/WHEEL +5 -0
- daplug_core-1.0.0b5.dist-info/licenses/LICENSE +201 -0
- daplug_core-1.0.0b5.dist-info/top_level.txt +1 -0
daplug_core/__init__.py
ADDED
|
File without changes
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict
|
|
4
|
+
|
|
5
|
+
from . import publisher
|
|
6
|
+
from .types import JSONType, PublisherProtocol, SnsAttributes
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class BaseAdapter:
|
|
10
|
+
|
|
11
|
+
def __init__(self, **kwargs: Any):
|
|
12
|
+
self.publisher: PublisherProtocol = publisher
|
|
13
|
+
self.sns_arn: str | None = kwargs.get("sns_arn")
|
|
14
|
+
self.sns_endpoint: str | None = kwargs.get("sns_endpoint")
|
|
15
|
+
self.sns_defaults: Dict[str, Any] = kwargs.get("sns_attributes", {})
|
|
16
|
+
|
|
17
|
+
def publish(self, db_data: JSONType, **kwargs: Any) -> None:
|
|
18
|
+
call_attributes: Dict[str, Any] = kwargs.get("sns_attributes", {})
|
|
19
|
+
attributes = self.create_format_attributes(call_attributes)
|
|
20
|
+
self.publisher.publish(
|
|
21
|
+
endpoint=self.sns_endpoint,
|
|
22
|
+
arn=self.sns_arn,
|
|
23
|
+
attributes=attributes,
|
|
24
|
+
data=db_data,
|
|
25
|
+
fifo_group_id=kwargs.get("fifo_group_id"),
|
|
26
|
+
fifo_duplication_id=kwargs.get("fifo_duplication_id"),
|
|
27
|
+
)
|
|
28
|
+
|
|
29
|
+
def create_format_attributes(self, call_attributes: Dict[str, Any]) -> SnsAttributes:
|
|
30
|
+
combined: Dict[str, Any] = {**self.sns_defaults, **call_attributes}
|
|
31
|
+
formatted_attributes: SnsAttributes = {}
|
|
32
|
+
for key, value in combined.items():
|
|
33
|
+
if value is not None:
|
|
34
|
+
data_type = "String" if isinstance(value, str) else "Number"
|
|
35
|
+
formatted_attributes[key] = {
|
|
36
|
+
"DataType": data_type,
|
|
37
|
+
"StringValue": value,
|
|
38
|
+
}
|
|
39
|
+
return formatted_attributes
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import copy
|
|
4
|
+
from typing import Any, Dict, List
|
|
5
|
+
|
|
6
|
+
import simplejson as json
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def merge(original_data: Dict[str, Any], new_data: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]:
|
|
10
|
+
updated_data = copy.deepcopy(original_data)
|
|
11
|
+
_walk_dict(updated_data, new_data, **kwargs)
|
|
12
|
+
return updated_data
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def _walk_dict(old_data: Dict[str, Any], new_data: Dict[str, Any], **kwargs: Any) -> None:
|
|
16
|
+
for new_key in new_data.keys():
|
|
17
|
+
if old_data.get(new_key) and isinstance(new_data[new_key], dict):
|
|
18
|
+
_walk_dict(old_data[new_key], new_data[new_key], **kwargs)
|
|
19
|
+
elif isinstance(old_data.get(new_key), list) and isinstance(new_data[new_key], list):
|
|
20
|
+
old_data[new_key] = _merge_lists(
|
|
21
|
+
old_data[new_key], new_data[new_key], kwargs.get("update_list_operation", "add")
|
|
22
|
+
)
|
|
23
|
+
else:
|
|
24
|
+
_merge_dicts(new_key, old_data, new_data, kwargs.get("update_dict_operation", "upsert"))
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
def _merge_dicts(dict_key: str, old_dict: Dict[str, Any], new_dict: Dict[str, Any], update_dict_operation: str = "upsert") -> None:
|
|
28
|
+
if update_dict_operation == "remove":
|
|
29
|
+
old_dict.pop(dict_key, None)
|
|
30
|
+
else:
|
|
31
|
+
old_dict[dict_key] = new_dict[dict_key]
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
def _merge_lists(old_list: List[Any], new_list: List[Any], update_list_operation: str = "add") -> List[Any]:
|
|
35
|
+
if update_list_operation == "remove":
|
|
36
|
+
_remove_item_in_list(old_list, new_list)
|
|
37
|
+
elif update_list_operation == "add":
|
|
38
|
+
_add_unique_item_in_list(old_list, new_list)
|
|
39
|
+
elif update_list_operation == "replace":
|
|
40
|
+
old_list = new_list
|
|
41
|
+
return old_list
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
def _remove_item_in_list(old_list: List[Any], new_list: List[Any]) -> None:
|
|
45
|
+
for old_item in old_list:
|
|
46
|
+
old = sorted(old_item.items()) if isinstance(old_item, dict) else old_item
|
|
47
|
+
new = sorted(new_list[0].items()) if isinstance(new_list[0], dict) else new_list[0]
|
|
48
|
+
if json.dumps(old) == json.dumps(new):
|
|
49
|
+
old_list.remove(old_item)
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
def _add_unique_item_in_list(old_list: List[Any], new_list: List[Any]) -> None:
|
|
53
|
+
for item in new_list:
|
|
54
|
+
if item not in old_list:
|
|
55
|
+
old_list.append(item)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from typing import Any
|
|
4
|
+
|
|
5
|
+
import json
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def try_decode_json(possible_json: Any) -> Any:
|
|
9
|
+
try:
|
|
10
|
+
return json.loads(possible_json)
|
|
11
|
+
except Exception: # pylint: disable=broad-except
|
|
12
|
+
return possible_json
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def try_encode_json(possible_json: Any) -> Any:
|
|
16
|
+
try:
|
|
17
|
+
return json.dumps(possible_json)
|
|
18
|
+
except Exception: # pylint: disable=broad-except
|
|
19
|
+
return possible_json
|
daplug_core/logger.py
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
import os
|
|
4
|
+
from typing import Any, Dict
|
|
5
|
+
|
|
6
|
+
from . import json_helper
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
def log(**kwargs: Any) -> None:
|
|
10
|
+
if os.getenv("RUN_MODE") != "unittest":
|
|
11
|
+
payload: Dict[str, Any] = {
|
|
12
|
+
"level": kwargs.get("level", "INFO"),
|
|
13
|
+
"log": kwargs.get("log", {}),
|
|
14
|
+
}
|
|
15
|
+
print(json_helper.try_encode_json(payload))
|
daplug_core/publisher.py
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict
|
|
4
|
+
|
|
5
|
+
import boto3
|
|
6
|
+
import simplejson as json
|
|
7
|
+
|
|
8
|
+
from . import logger
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def publish(**kwargs: Any) -> None:
|
|
12
|
+
if not kwargs.get("arn") or not kwargs.get("data"):
|
|
13
|
+
return
|
|
14
|
+
try:
|
|
15
|
+
sns_client = boto3.client(
|
|
16
|
+
"sns", region_name=kwargs.get("region"), endpoint_url=kwargs.get("endpoint")
|
|
17
|
+
)
|
|
18
|
+
publish_kwargs: Dict[str, Any] = {
|
|
19
|
+
"TopicArn": kwargs["arn"],
|
|
20
|
+
"Message": json.dumps(kwargs["data"]),
|
|
21
|
+
"MessageAttributes": kwargs.get("attributes", {}),
|
|
22
|
+
}
|
|
23
|
+
if kwargs.get("fifo_group_id"):
|
|
24
|
+
publish_kwargs["MessageGroupId"] = kwargs["fifo_group_id"]
|
|
25
|
+
if kwargs.get("fifo_duplication_id"):
|
|
26
|
+
publish_kwargs["MessageDeduplicationId"] = kwargs["fifo_duplication_id"]
|
|
27
|
+
sns_client.publish(**publish_kwargs)
|
|
28
|
+
except Exception as exc: # pylint: disable=broad-except
|
|
29
|
+
logger.log(level="WARN", log={"error": f"publish_sns_error: {exc}"})
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict
|
|
4
|
+
|
|
5
|
+
import jsonref
|
|
6
|
+
import simplejson as json
|
|
7
|
+
import yaml
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def load_schema(schema_file: str, schema_key: str) -> Dict[str, Any]:
|
|
11
|
+
with open(schema_file, encoding="UTF-8") as openapi:
|
|
12
|
+
api_doc = yaml.load(openapi, Loader=yaml.FullLoader)
|
|
13
|
+
return jsonref.loads(json.dumps(api_doc))["components"]["schemas"][schema_key]
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
from __future__ import annotations
|
|
2
|
+
|
|
3
|
+
from typing import Any, Dict, List
|
|
4
|
+
|
|
5
|
+
from . import schema_loader
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def map_to_schema(data: Dict[str, Any] | None, schema_file: str, schema_key: str) -> Dict[str, Any]:
|
|
9
|
+
model_data: Dict[str, Any] = {}
|
|
10
|
+
model_schema = schema_loader.load_schema(schema_file, schema_key)
|
|
11
|
+
schemas: List[Dict[str, Any]] = model_schema["allOf"] if model_schema.get("allOf") else [model_schema]
|
|
12
|
+
for model in schemas:
|
|
13
|
+
if model.get("type") == "object":
|
|
14
|
+
_populate_model_data(model.get("properties", {}), data, model_data)
|
|
15
|
+
return model_data
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
def _populate_model_data(properties: Dict[str, Any], data: Dict[str, Any] | None, model_data: Dict[str, Any]) -> Dict[str, Any]:
|
|
19
|
+
if data and isinstance(data, dict):
|
|
20
|
+
_populate_model_dict(properties, data, model_data)
|
|
21
|
+
return model_data
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
def _populate_model_dict(properties: Dict[str, Any], data: Dict[str, Any], model_data: Dict[str, Any]) -> None:
|
|
25
|
+
for property_key, property_value in properties.items():
|
|
26
|
+
model_data[property_key] = {}
|
|
27
|
+
if property_value.get("properties"):
|
|
28
|
+
_populate_model_data(
|
|
29
|
+
property_value["properties"], data.get(property_key), model_data[property_key]
|
|
30
|
+
)
|
|
31
|
+
elif property_value.get("items", {}).get("properties"):
|
|
32
|
+
_populate_model_list(model_data, property_key, property_value, data)
|
|
33
|
+
else:
|
|
34
|
+
model_data[property_key] = data.get(property_key)
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
def _populate_model_list(
|
|
38
|
+
model_data: Dict[str, Any], property_key: str, property_value: Dict[str, Any], data: Dict[str, Any]
|
|
39
|
+
) -> None:
|
|
40
|
+
model_data[property_key] = []
|
|
41
|
+
items = data.get(property_key, [])
|
|
42
|
+
for index in range(len(items)): # pylint: disable=consider-using-enumerate
|
|
43
|
+
if data.get(property_key) and isinstance(items, list) and index < len(items):
|
|
44
|
+
pop = _populate_model_data(
|
|
45
|
+
property_value["items"]["properties"], items[index], {}
|
|
46
|
+
)
|
|
47
|
+
model_data[property_key].append(pop)
|
daplug_core/types.py
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"""Shared typing helpers for daplug_core."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from typing import Any, Dict, List, Mapping, MutableMapping, Protocol, TypedDict, Union
|
|
6
|
+
|
|
7
|
+
JSONScalar = Union[str, int, float, bool, None]
|
|
8
|
+
JSONType = Union[JSONScalar, "JSONArray", "JSONObject"]
|
|
9
|
+
JSONArray = List[JSONType]
|
|
10
|
+
JSONObject = Dict[str, JSONType]
|
|
11
|
+
JSONMapping = Mapping[str, JSONScalar]
|
|
12
|
+
MutableJSONMapping = MutableMapping[str, JSONScalar]
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class PublisherProtocol(Protocol):
|
|
16
|
+
def publish(self, **kwargs: Any) -> None: # pragma: no cover - protocol definition.
|
|
17
|
+
...
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
class SnsAttribute(TypedDict):
|
|
21
|
+
DataType: str
|
|
22
|
+
StringValue: Union[str, int, float, bool]
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
SnsAttributes = Dict[str, SnsAttribute]
|
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: daplug-core
|
|
3
|
+
Version: 1.0.0b5
|
|
4
|
+
Summary: Shared schema, merge, and SNS helpers powering daplug adapters.
|
|
5
|
+
Home-page: https://github.com/dual/daplug-core
|
|
6
|
+
Author: Paul Cruse III
|
|
7
|
+
Author-email: paulcruse3@gmail.com
|
|
8
|
+
License: Apache License 2.0
|
|
9
|
+
Project-URL: Homepage, https://github.com/dual/daplug-core
|
|
10
|
+
Project-URL: Documentation, https://github.com/dual/daplug-core#readme
|
|
11
|
+
Project-URL: Source Code, https://github.com/dual/daplug-core
|
|
12
|
+
Project-URL: Bug Reports, https://github.com/dual/daplug-core/issues
|
|
13
|
+
Project-URL: CI/CD, https://circleci.com/gh/dual/daplug-core
|
|
14
|
+
Keywords: daplug,schema,sns,event-driven,database,adapter,python-library
|
|
15
|
+
Platform: any
|
|
16
|
+
Classifier: Development Status :: 3 - Alpha
|
|
17
|
+
Classifier: Environment :: Web Environment
|
|
18
|
+
Classifier: Environment :: Console
|
|
19
|
+
Classifier: Intended Audience :: Developers
|
|
20
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
21
|
+
Classifier: Operating System :: OS Independent
|
|
22
|
+
Classifier: Topic :: Database :: Front-Ends
|
|
23
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
24
|
+
Classifier: Programming Language :: Python
|
|
25
|
+
Classifier: Programming Language :: Python :: 3
|
|
26
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
27
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
28
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
29
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
30
|
+
Requires-Python: >=3.9
|
|
31
|
+
Description-Content-Type: text/markdown
|
|
32
|
+
License-File: LICENSE
|
|
33
|
+
Requires-Dist: boto3>=1.34
|
|
34
|
+
Requires-Dist: jsonref>=0.2
|
|
35
|
+
Requires-Dist: PyYAML>=5.3
|
|
36
|
+
Requires-Dist: simplejson>=3.17
|
|
37
|
+
Dynamic: author
|
|
38
|
+
Dynamic: author-email
|
|
39
|
+
Dynamic: classifier
|
|
40
|
+
Dynamic: description
|
|
41
|
+
Dynamic: description-content-type
|
|
42
|
+
Dynamic: home-page
|
|
43
|
+
Dynamic: keywords
|
|
44
|
+
Dynamic: license
|
|
45
|
+
Dynamic: license-file
|
|
46
|
+
Dynamic: platform
|
|
47
|
+
Dynamic: project-url
|
|
48
|
+
Dynamic: requires-dist
|
|
49
|
+
Dynamic: requires-python
|
|
50
|
+
Dynamic: summary
|
|
51
|
+
|
|
52
|
+
# 🧩 daplug-core (da•plug)
|
|
53
|
+
|
|
54
|
+
> **Shared schema + event plumbing for daplug-* adapters**
|
|
55
|
+
|
|
56
|
+
[](https://circleci.com/gh/dual/daplug-core)
|
|
57
|
+
[](https://sonarcloud.io/summary/new_code?id=dual_daplug-core)
|
|
58
|
+
[](https://sonarcloud.io/summary/new_code?id=dual_daplug-core)
|
|
59
|
+
[](https://sonarcloud.io/summary/new_code?id=dual_daplug-core)
|
|
60
|
+
[](https://www.python.org/downloads/)
|
|
61
|
+
[](https://pypi.org/project/daplug-core/)
|
|
62
|
+
[](LICENSE)
|
|
63
|
+
[](https://github.com/paulcruse3/daplug-core/issues)
|
|
64
|
+
|
|
65
|
+
`daplug-core` is the tiny layer of glue that both `daplug-ddb`, `daplug-cypher`, and future `daplug-*` projects, relied on in their old `common/` directories. It bundles a publisher, logging shim, schema utilities, and merge helpers so the higher-level adapters can stay laser-focused on their respective datastores. This repository is not meant to be a fully fledged adapter on its own—it simply centralizes the primitives the adapters share.
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 🌈 Why this exists
|
|
70
|
+
|
|
71
|
+
- **Single source of truth** – The DynamoDB and Cypher adapters used to carry duplicate copies of the same helpers. `daplug-core` keeps those modules in one place.
|
|
72
|
+
- **Batteries-included SNS publishing** – The base `publisher` encapsulates SNS fan-out, FIFO metadata, and logging so consuming packages can just hand it messages.
|
|
73
|
+
- **Schema-first tooling** – `schema_loader` and `schema_mapper` read OpenAPI/JSON schemas and project payloads to the shapes your adapters expect.
|
|
74
|
+
- **Deterministic merging** – `dict_merger` upgrades nested payloads with configurable list/dict strategies (add, replace, remove) so you can keep optimistic writes tight.
|
|
75
|
+
|
|
76
|
+
If you are migrating `daplug-ddb` or `daplug-cypher`, remove their legacy `common/` folder and import from `daplug_core` instead. Nothing else changes.
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
## 📦 Installation
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
pip install daplug-core
|
|
84
|
+
# or
|
|
85
|
+
pipenv install daplug-core
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
> Not on PyPI yet? Until release, install straight from the repo:
|
|
89
|
+
>
|
|
90
|
+
> ```bash
|
|
91
|
+
> pip install git+https://github.com/paulcruse3/daplug-core.git
|
|
92
|
+
> ```
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## 🔁 How consuming packages use the base
|
|
97
|
+
|
|
98
|
+
1. **Declare the dependency** in the adapter package (e.g. `daplug-ddb`) via Pipfile/pyproject.
|
|
99
|
+
2. **Drop the duplicated modules** (`common/logger.py`, `common/publisher.py`, etc.).
|
|
100
|
+
3. **Import from `daplug_core`** wherever those utilities were previously referenced.
|
|
101
|
+
|
|
102
|
+
```python
|
|
103
|
+
# inside daplug-ddb
|
|
104
|
+
from daplug_core import dict_merger, json_helper, publisher, schema_mapper
|
|
105
|
+
|
|
106
|
+
merged = dict_merger.merge(original, incoming, update_list_operation="replace")
|
|
107
|
+
publisher.publish(arn=sns_arn, data=merged, attributes={"event": "updated"})
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
Because the API surface stayed the same, adapter code typically only needs import-path updates.
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## 🧱 Building blocks
|
|
115
|
+
|
|
116
|
+
| Module | Purpose |
|
|
117
|
+
| ------ | ------- |
|
|
118
|
+
| `base_adapter.BaseAdapter` | Minimal SNS-aware adapter scaffold (used as a mixin by higher-level adapters). |
|
|
119
|
+
| `publisher.publish` | Thin wrapper over `boto3` SNS clients with FIFO group/dedupe support and structured logging. |
|
|
120
|
+
| `logger.log` | Consistent JSON stdout logging that honors `RUN_MODE=unittest`. |
|
|
121
|
+
| `json_helper` | Best-effort `try_encode_json` / `try_decode_json` helpers used by loggers and publishers. |
|
|
122
|
+
| `schema_loader.load_schema` | Loads an OpenAPI/JSON schema and resolves `$ref`s using `jsonref`. |
|
|
123
|
+
| `schema_mapper.map_to_schema` | Recursively projects payloads into schema-shaped dictionaries (supports `allOf` inheritance). |
|
|
124
|
+
| `dict_merger.merge` | Deep merge with per-call list/dict strategies (`add`, `remove`, `replace`, `upsert`). |
|
|
125
|
+
|
|
126
|
+
Mix and match these pieces inside datastore-specific adapters.
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## 🧭 Example: refactoring `daplug-ddb`
|
|
131
|
+
|
|
132
|
+
```python
|
|
133
|
+
# before (inside daplug_ddb/common/publisher.py)
|
|
134
|
+
from . import logger
|
|
135
|
+
import boto3
|
|
136
|
+
|
|
137
|
+
# after
|
|
138
|
+
from daplug_core import publisher
|
|
139
|
+
|
|
140
|
+
publisher.publish(
|
|
141
|
+
arn=self.sns_arn,
|
|
142
|
+
data=payload,
|
|
143
|
+
fifo_group_id=fifo_group,
|
|
144
|
+
fifo_duplication_id=fifo_dedupe,
|
|
145
|
+
attributes={"source": "daplug-ddb"},
|
|
146
|
+
)
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
```python
|
|
150
|
+
# before
|
|
151
|
+
from .common.dict_merger import merge
|
|
152
|
+
|
|
153
|
+
# after
|
|
154
|
+
from daplug_core import dict_merger
|
|
155
|
+
|
|
156
|
+
updated_item = dict_merger.merge(original, patch, update_list_operation="replace")
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
The same pattern applies inside `daplug-cypher` when merging node payloads or formatting SNS events.
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## ⚙️ Local development
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
git clone https://github.com/paulcruse3/daplug-core.git
|
|
167
|
+
cd daplug-core
|
|
168
|
+
pipenv install --dev
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Run tests & coverage
|
|
172
|
+
|
|
173
|
+
```bash
|
|
174
|
+
pipenv run test # pytest tests/
|
|
175
|
+
pipenv run test-cov # pytest --cov=daplug_core --cov-report=term-missing
|
|
176
|
+
pipenv run lint # pylint --fail-under 10 daplug_core
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
### Ship updates downstream
|
|
180
|
+
|
|
181
|
+
1. Bump the version in `setup.py` (and `setup.cfg` if needed).
|
|
182
|
+
2. Publish to PyPI or deliver a git tag.
|
|
183
|
+
3. Update `daplug-ddb` and `daplug-cypher` to depend on the new version.
|
|
184
|
+
4. Remove any residual `common/` references in those repos and re-run their suites.
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
## 🤝 Contributing
|
|
189
|
+
|
|
190
|
+
Pull requests are welcome—especially improvements that make life easier for the DynamoDB and Cypher adapters. If you add a helper here, remember to wire it up in the consuming packages as well.
|
|
191
|
+
|
|
192
|
+
```bash
|
|
193
|
+
git checkout -b feat/better-schema-mapper
|
|
194
|
+
pipenv run test-cov
|
|
195
|
+
pipenv run lint
|
|
196
|
+
git commit -am "feat: better schema mapper"
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
---
|
|
200
|
+
|
|
201
|
+
## 📄 License
|
|
202
|
+
|
|
203
|
+
Apache 2.0 – see [LICENSE](LICENSE).
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
daplug_core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
2
|
+
daplug_core/base_adapter.py,sha256=2w_s6fEsgT4RgVH1lUlQYE7IRmHaSRzMu_RkpeAOCXo,1528
|
|
3
|
+
daplug_core/dict_merger.py,sha256=b7Mc7v_ul8tkct8k-_6Hrk7PRnirqI96oWigoDZbYG4,2177
|
|
4
|
+
daplug_core/json_helper.py,sha256=VpTRzBRqd2qxnFoljyLNAbRK00fUSTuL5Aw4bslM328,438
|
|
5
|
+
daplug_core/logger.py,sha256=PcazH3HbJWi9CZVhs1tMuXO9znqOwWWsh71UoZcqU7c,370
|
|
6
|
+
daplug_core/publisher.py,sha256=wNNj0QYnsTuXHLr5VSl6OjMjt9ldsSplX4iEp0KRO8E,1010
|
|
7
|
+
daplug_core/schema_loader.py,sha256=Gp7Ppb4W-R7NVaQ5_BQKYC0y7wQGbTGSIdWZGwGGt-8,392
|
|
8
|
+
daplug_core/schema_mapper.py,sha256=RC-MW_JyLKvl6a2zGH9lp5y_rK1qmFNyphSJSLHkFGg,2016
|
|
9
|
+
daplug_core/types.py,sha256=P7wLp1g_I7wqyVQ3IoKoQ_0_lkWKipM3LZEfbUsZ3MI,704
|
|
10
|
+
daplug_core-1.0.0b5.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
|
|
11
|
+
daplug_core-1.0.0b5.dist-info/METADATA,sha256=5nhEb0vLi3eURcQByJ7PX7C8rZZIWXSL_H7QNSMFni8,7833
|
|
12
|
+
daplug_core-1.0.0b5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
13
|
+
daplug_core-1.0.0b5.dist-info/top_level.txt,sha256=74N0NktOO_vBCmgjcCOHL5U9I5m8CTabVU1u6Ri953s,12
|
|
14
|
+
daplug_core-1.0.0b5.dist-info/RECORD,,
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
daplug_core
|