sharedkernel 2.2.1__tar.gz → 2.2.3__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.
Files changed (38) hide show
  1. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/PKG-INFO +6 -1
  2. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/README.md +5 -0
  3. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/setup.py +2 -2
  4. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/database/__init__.py +2 -1
  5. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/database/mongo_generic_audit_repository.py +40 -0
  6. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/database/mongo_generic_repository.py +51 -18
  7. sharedkernel-2.2.3/sharedkernel/database/pagination_response_dto.py +16 -0
  8. sharedkernel-2.2.3/sharedkernel/enum/sort_order.py +6 -0
  9. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel.egg-info/PKG-INFO +6 -1
  10. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel.egg-info/SOURCES.txt +2 -0
  11. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/setup.cfg +0 -0
  12. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/common.py +0 -0
  13. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/data_format_converter.py +0 -0
  14. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/database/audit_model.py +0 -0
  15. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/date_converter.py +0 -0
  16. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/diff_utils.py +0 -0
  17. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/enum/__init__.py +0 -0
  18. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/enum/error_code.py +0 -0
  19. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/exception/__init__.py +0 -0
  20. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/exception/exception.py +0 -0
  21. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/exception/exception_handlers.py +0 -0
  22. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/jwt_service.py +0 -0
  23. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/normalizer/__init__.py +0 -0
  24. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/normalizer/number_normalizer.py +0 -0
  25. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/normalizer/phone_number_normalizer.py +0 -0
  26. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/normalizer/string_normalizer.py +0 -0
  27. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/objects/__init__.py +0 -0
  28. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/objects/base_document.py +0 -0
  29. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/objects/json_string_model.py +0 -0
  30. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/objects/jwt_model.py +0 -0
  31. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/objects/result.py +0 -0
  32. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/objects/user_info.py +0 -0
  33. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/regex_masking.py +0 -0
  34. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/s3_uploader.py +0 -0
  35. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel/string_extentions.py +0 -0
  36. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel.egg-info/dependency_links.txt +0 -0
  37. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel.egg-info/requires.txt +0 -0
  38. {sharedkernel-2.2.1 → sharedkernel-2.2.3}/sharedkernel.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sharedkernel
3
- Version: 2.2.1
3
+ Version: 2.2.3
4
4
  Summary: sharekernel is a shared package between all python projects
5
5
  Author: Smilinno
6
6
  Description-Content-Type: text/markdown
@@ -29,6 +29,11 @@ Dynamic: summary
29
29
  this is a shared kernel package
30
30
 
31
31
  # Change Log
32
+ ### Version 2.2.3
33
+ - add paginate to mongo repository
34
+ ### Version 2.2.2
35
+ - update on audit logging queries
36
+ - added is_audit to update_one parameters
32
37
  ### Version 2.2.1
33
38
  - fixbug requirements
34
39
  ### Version 2.2.0
@@ -2,6 +2,11 @@
2
2
  this is a shared kernel package
3
3
 
4
4
  # Change Log
5
+ ### Version 2.2.3
6
+ - add paginate to mongo repository
7
+ ### Version 2.2.2
8
+ - update on audit logging queries
9
+ - added is_audit to update_one parameters
5
10
  ### Version 2.2.1
6
11
  - fixbug requirements
7
12
  ### Version 2.2.0
@@ -34,10 +34,10 @@ setup(
34
34
  "mammoth",
35
35
  "markdown",
36
36
  "beautifulsoup4",
37
- "deepdiff"
37
+ "deepdiff",
38
38
  ],
39
39
  # *strongly* suggested for sharing
40
- version="2.2.1",
40
+ version="2.2.3",
41
41
  description="sharekernel is a shared package between all python projects",
42
42
  long_description=long_description,
43
43
  long_description_content_type="text/markdown",
@@ -1,3 +1,4 @@
1
1
  from .mongo_generic_repository import MongoGenericRepository
2
2
  from .mongo_generic_audit_repository import MongoGenericAuditRepository
3
- from .audit_model import AuditLog, AuditOperation
3
+ from .audit_model import AuditLog, AuditOperation
4
+ from .pagination_response_dto import PaginationResponseDto
@@ -4,6 +4,7 @@ from pymongo import MongoClient
4
4
  from pydantic.v1 import BaseModel
5
5
 
6
6
  from sharedkernel.database.audit_model import AuditLog
7
+ from sharedkernel.enum.sort_order import SortOrder
7
8
 
8
9
  T = TypeVar("T", bound=BaseModel)
9
10
 
@@ -35,7 +36,13 @@ class MongoGenericAuditRepository():
35
36
  operation: str | None = None,
36
37
  collection_name: str | None = None,
37
38
  field_name: str | None = None,
39
+ page_number=1,
40
+ page_size=10,
41
+ sort_order: SortOrder = SortOrder.Descending,
38
42
  ) -> List[AuditLog]:
43
+ sort_order = -1 if sort_order == SortOrder.Descending else 1
44
+
45
+ skip_count = (page_number - 1) * page_size
39
46
 
40
47
  query = {}
41
48
 
@@ -52,6 +59,39 @@ class MongoGenericAuditRepository():
52
59
  {f"modified.{field_name}": {"$exists": True}},
53
60
  ]
54
61
 
62
+ results = self.collection.find(query).sort("_id", sort_order).skip(skip_count).limit(page_size)
63
+ return [self._map_to_model(bot) for bot in results]
64
+
65
+ def find_by_value(
66
+ self,
67
+ field_name: str,
68
+ field_value: str,
69
+ document_id: str | None = None,
70
+ operation: str | None = None,
71
+ collection_name: str | None = None,
72
+ find_in_originals: bool | None = False,
73
+ find_in_modifies: bool | None = False,
74
+ ) -> list[AuditLog]:
75
+
76
+ query = {}
77
+
78
+ if document_id:
79
+ query["document_id"] = document_id
80
+ if operation:
81
+ query["operation"] = operation
82
+ if collection_name:
83
+ query["collection_name"] = collection_name
84
+
85
+ if find_in_originals and find_in_modifies:
86
+ query["$or"] = [
87
+ {f"original.{field_name}": field_value},
88
+ {f"modified.{field_name}": field_value},
89
+ ]
90
+ elif find_in_originals:
91
+ query[f"original.{field_name}"] = field_value
92
+ elif find_in_modifies:
93
+ query[f"modified.{field_name}"] = field_value
94
+
55
95
  results = self.collection.find(query)
56
96
  return [self._map_to_model(bot) for bot in results]
57
97
 
@@ -1,8 +1,10 @@
1
1
  from bson import ObjectId
2
2
  from typing import Generic, TypeVar, List, Type
3
+ from math import ceil
4
+ from contextlib import suppress
5
+
3
6
  from pydantic.v1 import BaseModel
4
7
  from pymongo import MongoClient, ReturnDocument
5
- from contextlib import suppress
6
8
 
7
9
  from sharedkernel.objects.user_info import current_user_info
8
10
  from sharedkernel.string_extentions import camel_to_snake
@@ -13,6 +15,7 @@ from sharedkernel.database.audit_model import (
13
15
  AuditOperation
14
16
  )
15
17
  from sharedkernel.diff_utils import generate_clean_diff
18
+ from sharedkernel.database.pagination_response_dto import PaginationResponseDto
16
19
 
17
20
  T = TypeVar("T", bound=BaseModel)
18
21
 
@@ -79,7 +82,7 @@ class MongoGenericRepository(Generic[T]):
79
82
 
80
83
  return [str(id_) for id_ in result.inserted_ids]
81
84
 
82
- def update_one(self, id: str, data: T) -> int:
85
+ def update_one(self, id: str, data: T, is_audit = True) -> int:
83
86
  delattr(data, "id")
84
87
 
85
88
  query = {"_id": ObjectId(id)}
@@ -89,24 +92,25 @@ class MongoGenericRepository(Generic[T]):
89
92
  return_document=ReturnDocument.BEFORE
90
93
  )
91
94
 
92
- before_model = self.model(**before_dict)
93
-
94
95
  # For Audit log
95
- with suppress(Exception):
96
- diff_data = generate_clean_diff(before_model, data)
97
- old_data, new_data = diff_data["original"], diff_data["modified"]
98
-
99
- if isinstance(data, BaseAuditDocument) and new_data:
100
- document = AuditLog(
101
- user_id=current_user_info.get().nameid,
102
- collection_name=self.__collection_name,
103
- document_id=id,
104
- operation=AuditOperation.UPDATE,
105
- original=old_data,
106
- modified=new_data,
107
- )
96
+ if isinstance(data, BaseAuditDocument) and is_audit:
97
+ with suppress(Exception):
98
+ before_model = self.model(**before_dict)
108
99
 
109
- self.audit_collection.insert_one(document)
100
+ diff_data = generate_clean_diff(before_model, data)
101
+ old_data, new_data = diff_data["original"], diff_data["modified"]
102
+
103
+ if new_data:
104
+ document = AuditLog(
105
+ user_id=current_user_info.get().nameid,
106
+ collection_name=self.__collection_name,
107
+ document_id=id,
108
+ operation=AuditOperation.UPDATE,
109
+ original=old_data,
110
+ modified=new_data,
111
+ )
112
+
113
+ self.audit_collection.insert_one(document)
110
114
 
111
115
  return 1
112
116
 
@@ -120,3 +124,32 @@ class MongoGenericRepository(Generic[T]):
120
124
  query = {"is_deleted": False}
121
125
  result = self.collection.find(query).skip(skip_count).limit(page_size)
122
126
  return [self._map_to_model(doc) for doc in result]
127
+
128
+ def paginate(
129
+ self,
130
+ query: dict,
131
+ page_number: int,
132
+ page_size: int,
133
+ sort_field: str = "_id",
134
+ sort_order: int = -1,
135
+ ) -> PaginationResponseDto:
136
+
137
+ skip_count = (page_number - 1) * page_size
138
+ total_items = self.collection.count_documents(query)
139
+
140
+ cursor = (
141
+ self.collection.find(query)
142
+ .sort(sort_field, sort_order)
143
+ .skip(skip_count)
144
+ .limit(page_size)
145
+ )
146
+
147
+ return PaginationResponseDto(
148
+ data=[self._map_to_model(doc) for doc in cursor],
149
+ total_items=total_items,
150
+ page_size=page_size,
151
+ current_page=page_number,
152
+ total_pages=ceil(total_items / page_size) if page_size else 1,
153
+ has_next=(page_number * page_size) < total_items,
154
+ has_prev=page_number > 1,
155
+ )
@@ -0,0 +1,16 @@
1
+ from typing import List, TypeVar, Generic
2
+
3
+ from pydantic import BaseModel
4
+ # from pydantic.generics import GenericModel
5
+
6
+ T = TypeVar("T", bound=BaseModel)
7
+
8
+ class PaginationResponseDto(BaseModel, Generic[T]):
9
+ data: List[T]
10
+ total_items: int
11
+ page_size: int
12
+ current_page: int
13
+ total_pages: int
14
+ has_next: bool
15
+ has_prev: bool
16
+
@@ -0,0 +1,6 @@
1
+ from enum import Enum
2
+
3
+
4
+ class SortOrder(str, Enum):
5
+ Descending = "desc"
6
+ Ascending = "asc"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sharedkernel
3
- Version: 2.2.1
3
+ Version: 2.2.3
4
4
  Summary: sharekernel is a shared package between all python projects
5
5
  Author: Smilinno
6
6
  Description-Content-Type: text/markdown
@@ -29,6 +29,11 @@ Dynamic: summary
29
29
  this is a shared kernel package
30
30
 
31
31
  # Change Log
32
+ ### Version 2.2.3
33
+ - add paginate to mongo repository
34
+ ### Version 2.2.2
35
+ - update on audit logging queries
36
+ - added is_audit to update_one parameters
32
37
  ### Version 2.2.1
33
38
  - fixbug requirements
34
39
  ### Version 2.2.0
@@ -17,8 +17,10 @@ sharedkernel/database/__init__.py
17
17
  sharedkernel/database/audit_model.py
18
18
  sharedkernel/database/mongo_generic_audit_repository.py
19
19
  sharedkernel/database/mongo_generic_repository.py
20
+ sharedkernel/database/pagination_response_dto.py
20
21
  sharedkernel/enum/__init__.py
21
22
  sharedkernel/enum/error_code.py
23
+ sharedkernel/enum/sort_order.py
22
24
  sharedkernel/exception/__init__.py
23
25
  sharedkernel/exception/exception.py
24
26
  sharedkernel/exception/exception_handlers.py
File without changes