daplug-core 1.0.0b3__tar.gz

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.
@@ -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,203 @@
1
+ Metadata-Version: 2.4
2
+ Name: daplug-core
3
+ Version: 1.0.0b3
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
+ [![CircleCI](https://circleci.com/gh/dual/daplug-ddb.svg?style=shield)](https://circleci.com/gh/dual/daplug-core)
57
+ [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-core&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dual_daplug-core)
58
+ [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-core&metric=bugs)](https://sonarcloud.io/summary/new_code?id=dual_daplug-core)
59
+ [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-core&metric=coverage)](https://sonarcloud.io/summary/new_code?id=dual_daplug-core)
60
+ [![Python](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/downloads/)
61
+ [![PyPI package](https://img.shields.io/pypi/v/daplug-core?color=blue&label=pypi%20package)](https://pypi.org/project/daplug-core/)
62
+ [![License](https://img.shields.io/badge/license-apache%202.0-blue)](LICENSE)
63
+ [![Contributions](https://img.shields.io/badge/contributions-welcome-blue)](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,152 @@
1
+ # 🧩 daplug-core (da•plug)
2
+
3
+ > **Shared schema + event plumbing for daplug-* adapters**
4
+
5
+ [![CircleCI](https://circleci.com/gh/dual/daplug-ddb.svg?style=shield)](https://circleci.com/gh/dual/daplug-core)
6
+ [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-core&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dual_daplug-core)
7
+ [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-core&metric=bugs)](https://sonarcloud.io/summary/new_code?id=dual_daplug-core)
8
+ [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=dual_daplug-core&metric=coverage)](https://sonarcloud.io/summary/new_code?id=dual_daplug-core)
9
+ [![Python](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/downloads/)
10
+ [![PyPI package](https://img.shields.io/pypi/v/daplug-core?color=blue&label=pypi%20package)](https://pypi.org/project/daplug-core/)
11
+ [![License](https://img.shields.io/badge/license-apache%202.0-blue)](LICENSE)
12
+ [![Contributions](https://img.shields.io/badge/contributions-welcome-blue)](https://github.com/paulcruse3/daplug-core/issues)
13
+
14
+ `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.
15
+
16
+ ---
17
+
18
+ ## 🌈 Why this exists
19
+
20
+ - **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.
21
+ - **Batteries-included SNS publishing** – The base `publisher` encapsulates SNS fan-out, FIFO metadata, and logging so consuming packages can just hand it messages.
22
+ - **Schema-first tooling** – `schema_loader` and `schema_mapper` read OpenAPI/JSON schemas and project payloads to the shapes your adapters expect.
23
+ - **Deterministic merging** – `dict_merger` upgrades nested payloads with configurable list/dict strategies (add, replace, remove) so you can keep optimistic writes tight.
24
+
25
+ If you are migrating `daplug-ddb` or `daplug-cypher`, remove their legacy `common/` folder and import from `daplug_core` instead. Nothing else changes.
26
+
27
+ ---
28
+
29
+ ## 📦 Installation
30
+
31
+ ```bash
32
+ pip install daplug-core
33
+ # or
34
+ pipenv install daplug-core
35
+ ```
36
+
37
+ > Not on PyPI yet? Until release, install straight from the repo:
38
+ >
39
+ > ```bash
40
+ > pip install git+https://github.com/paulcruse3/daplug-core.git
41
+ > ```
42
+
43
+ ---
44
+
45
+ ## 🔁 How consuming packages use the base
46
+
47
+ 1. **Declare the dependency** in the adapter package (e.g. `daplug-ddb`) via Pipfile/pyproject.
48
+ 2. **Drop the duplicated modules** (`common/logger.py`, `common/publisher.py`, etc.).
49
+ 3. **Import from `daplug_core`** wherever those utilities were previously referenced.
50
+
51
+ ```python
52
+ # inside daplug-ddb
53
+ from daplug_core import dict_merger, json_helper, publisher, schema_mapper
54
+
55
+ merged = dict_merger.merge(original, incoming, update_list_operation="replace")
56
+ publisher.publish(arn=sns_arn, data=merged, attributes={"event": "updated"})
57
+ ```
58
+
59
+ Because the API surface stayed the same, adapter code typically only needs import-path updates.
60
+
61
+ ---
62
+
63
+ ## 🧱 Building blocks
64
+
65
+ | Module | Purpose |
66
+ | ------ | ------- |
67
+ | `base_adapter.BaseAdapter` | Minimal SNS-aware adapter scaffold (used as a mixin by higher-level adapters). |
68
+ | `publisher.publish` | Thin wrapper over `boto3` SNS clients with FIFO group/dedupe support and structured logging. |
69
+ | `logger.log` | Consistent JSON stdout logging that honors `RUN_MODE=unittest`. |
70
+ | `json_helper` | Best-effort `try_encode_json` / `try_decode_json` helpers used by loggers and publishers. |
71
+ | `schema_loader.load_schema` | Loads an OpenAPI/JSON schema and resolves `$ref`s using `jsonref`. |
72
+ | `schema_mapper.map_to_schema` | Recursively projects payloads into schema-shaped dictionaries (supports `allOf` inheritance). |
73
+ | `dict_merger.merge` | Deep merge with per-call list/dict strategies (`add`, `remove`, `replace`, `upsert`). |
74
+
75
+ Mix and match these pieces inside datastore-specific adapters.
76
+
77
+ ---
78
+
79
+ ## 🧭 Example: refactoring `daplug-ddb`
80
+
81
+ ```python
82
+ # before (inside daplug_ddb/common/publisher.py)
83
+ from . import logger
84
+ import boto3
85
+
86
+ # after
87
+ from daplug_core import publisher
88
+
89
+ publisher.publish(
90
+ arn=self.sns_arn,
91
+ data=payload,
92
+ fifo_group_id=fifo_group,
93
+ fifo_duplication_id=fifo_dedupe,
94
+ attributes={"source": "daplug-ddb"},
95
+ )
96
+ ```
97
+
98
+ ```python
99
+ # before
100
+ from .common.dict_merger import merge
101
+
102
+ # after
103
+ from daplug_core import dict_merger
104
+
105
+ updated_item = dict_merger.merge(original, patch, update_list_operation="replace")
106
+ ```
107
+
108
+ The same pattern applies inside `daplug-cypher` when merging node payloads or formatting SNS events.
109
+
110
+ ---
111
+
112
+ ## ⚙️ Local development
113
+
114
+ ```bash
115
+ git clone https://github.com/paulcruse3/daplug-core.git
116
+ cd daplug-core
117
+ pipenv install --dev
118
+ ```
119
+
120
+ ### Run tests & coverage
121
+
122
+ ```bash
123
+ pipenv run test # pytest tests/
124
+ pipenv run test-cov # pytest --cov=daplug_core --cov-report=term-missing
125
+ pipenv run lint # pylint --fail-under 10 daplug_core
126
+ ```
127
+
128
+ ### Ship updates downstream
129
+
130
+ 1. Bump the version in `setup.py` (and `setup.cfg` if needed).
131
+ 2. Publish to PyPI or deliver a git tag.
132
+ 3. Update `daplug-ddb` and `daplug-cypher` to depend on the new version.
133
+ 4. Remove any residual `common/` references in those repos and re-run their suites.
134
+
135
+ ---
136
+
137
+ ## 🤝 Contributing
138
+
139
+ 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.
140
+
141
+ ```bash
142
+ git checkout -b feat/better-schema-mapper
143
+ pipenv run test-cov
144
+ pipenv run lint
145
+ git commit -am "feat: better schema mapper"
146
+ ```
147
+
148
+ ---
149
+
150
+ ## 📄 License
151
+
152
+ Apache 2.0 – see [LICENSE](LICENSE).
File without changes
@@ -0,0 +1,33 @@
1
+ from . import publisher
2
+
3
+
4
+ class BaseAdapter:
5
+
6
+ def __init__(self, **kwargs):
7
+ self.publisher = publisher
8
+ self.sns_arn = kwargs.get("sns_arn")
9
+ self.sns_endpoint = kwargs.get("sns_endpoint")
10
+ self.sns_defaults = kwargs.get("sns_attributes", {})
11
+
12
+ def publish(self, db_operation, db_data, **kwargs):
13
+ attributes = self.create_format_attributes(db_operation, kwargs.get("sns_attributes", {}))
14
+ self.publisher.publish(
15
+ endpoint=self.sns_endpoint,
16
+ arn=self.sns_arn,
17
+ attributes=attributes,
18
+ data=db_data,
19
+ fifo_group_id=kwargs.get("fifo_group_id"),
20
+ fifo_duplication_id=kwargs.get("fifo_duplication_id"),
21
+ )
22
+
23
+ def create_format_attributes(self, operation, call_attributes):
24
+ combined = {**self.sns_defaults, **call_attributes, **{"operation": operation}}
25
+ formatted_attributes = {}
26
+ for key, value in combined.items():
27
+ if value is not None:
28
+ data_type = "String" if isinstance(value, str) else "Number"
29
+ formatted_attributes[key] = {
30
+ "DataType": data_type,
31
+ "StringValue": value,
32
+ }
33
+ return formatted_attributes
@@ -0,0 +1,52 @@
1
+ import copy
2
+
3
+ import simplejson as json
4
+
5
+
6
+ def merge(original_data, new_data, **kwargs):
7
+ updated_data = copy.deepcopy(original_data)
8
+ _walk_dict(updated_data, new_data, **kwargs)
9
+ return updated_data
10
+
11
+
12
+ def _walk_dict(old_data, new_data, **kwargs):
13
+ for new_key in new_data.keys():
14
+ if old_data.get(new_key) and isinstance(new_data[new_key], dict):
15
+ _walk_dict(old_data[new_key], new_data[new_key], **kwargs)
16
+ elif isinstance(old_data.get(new_key), list) and isinstance(new_data[new_key], list):
17
+ old_data[new_key] = _merge_lists(
18
+ old_data[new_key], new_data[new_key], kwargs.get("update_list_operation", "add")
19
+ )
20
+ else:
21
+ _merge_dicts(new_key, old_data, new_data, kwargs.get("update_dict_operation", "upsert"))
22
+
23
+
24
+ def _merge_dicts(dict_key, old_dict, new_dict, update_dict_operation="upsert"):
25
+ if update_dict_operation == "remove":
26
+ old_dict.pop(dict_key, None)
27
+ else:
28
+ old_dict[dict_key] = new_dict[dict_key]
29
+
30
+
31
+ def _merge_lists(old_list, new_list, update_list_operation="add"):
32
+ if update_list_operation == "remove":
33
+ _remove_item_in_list(old_list, new_list)
34
+ elif update_list_operation == "add":
35
+ _add_unique_item_in_list(old_list, new_list)
36
+ elif update_list_operation == "replace":
37
+ old_list = new_list
38
+ return old_list
39
+
40
+
41
+ def _remove_item_in_list(old_list, new_list):
42
+ for old_item in old_list:
43
+ old = sorted(old_item.items()) if isinstance(old_item, dict) else old_item
44
+ new = sorted(new_list[0].items()) if isinstance(new_list[0], dict) else new_list[0]
45
+ if json.dumps(old) == json.dumps(new):
46
+ old_list.remove(old_item)
47
+
48
+
49
+ def _add_unique_item_in_list(old_list, new_list):
50
+ for item in new_list:
51
+ if item not in old_list:
52
+ old_list.append(item)
@@ -0,0 +1,15 @@
1
+ import json
2
+
3
+
4
+ def try_decode_json(possible_json):
5
+ try:
6
+ return json.loads(possible_json)
7
+ except Exception: # pylint: disable=broad-except
8
+ return possible_json
9
+
10
+
11
+ def try_encode_json(possible_json):
12
+ try:
13
+ return json.dumps(possible_json)
14
+ except Exception: # pylint: disable=broad-except
15
+ return possible_json
@@ -0,0 +1,12 @@
1
+ import os
2
+
3
+ from . import json_helper
4
+
5
+
6
+ def log(**kwargs):
7
+ if os.getenv("RUN_MODE") != "unittest":
8
+ payload = {
9
+ "level": kwargs.get("level", "INFO"),
10
+ "log": kwargs.get("log", {}),
11
+ }
12
+ print(json_helper.try_encode_json(payload))