django-chelseru 1.0.1__tar.gz → 1.0.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 (39) hide show
  1. django_chelseru-1.0.3/MANIFEST.in +1 -0
  2. django_chelseru-1.0.3/PKG-INFO +315 -0
  3. django_chelseru-1.0.3/README.md +56 -0
  4. django_chelseru-1.0.3/README_PA.md +276 -0
  5. django_chelseru-1.0.3/django_chelseru.egg-info/PKG-INFO +315 -0
  6. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/django_chelseru.egg-info/SOURCES.txt +6 -0
  7. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/admin.py +7 -2
  8. django_chelseru-1.0.3/drfchelseru/consumers.py +82 -0
  9. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/middlewares.py +37 -1
  10. django_chelseru-1.0.3/drfchelseru/migrations/0004_rename_message_message_sms.py +17 -0
  11. django_chelseru-1.0.3/drfchelseru/migrations/0005_rename_message_sms_messagesms_chatroom_messagechat.py +37 -0
  12. django_chelseru-1.0.3/drfchelseru/migrations/0006_alter_chatroom_user_1_alter_chatroom_user_2_and_more.py +36 -0
  13. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/models.py +25 -2
  14. django_chelseru-1.0.3/drfchelseru/routing.py +6 -0
  15. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/serializers.py +23 -3
  16. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/services.py +2 -2
  17. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/settings.py +33 -20
  18. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/urls.py +8 -3
  19. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/views.py +55 -3
  20. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/setup.py +3 -3
  21. django_chelseru-1.0.1/MANIFEST.in +0 -1
  22. django_chelseru-1.0.1/PKG-INFO +0 -58
  23. django_chelseru-1.0.1/README.md +0 -19
  24. django_chelseru-1.0.1/django_chelseru.egg-info/PKG-INFO +0 -58
  25. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/LICENSE +0 -0
  26. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/django_chelseru.egg-info/dependency_links.txt +0 -0
  27. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/django_chelseru.egg-info/requires.txt +0 -0
  28. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/django_chelseru.egg-info/top_level.txt +0 -0
  29. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/__init__.py +0 -0
  30. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/apps.py +0 -0
  31. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/migrations/0001_initial.py +0 -0
  32. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/migrations/0002_otpcode_session_user.py +0 -0
  33. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/migrations/0003_rename_mobile_otpcode_mobile_number.py +0 -0
  34. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/migrations/__init__.py +0 -0
  35. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/signals.py +0 -0
  36. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/tests.py +0 -0
  37. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/drfchelseru/validators.py +0 -0
  38. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/pyproject.toml +0 -0
  39. {django_chelseru-1.0.1 → django_chelseru-1.0.3}/setup.cfg +0 -0
@@ -0,0 +1 @@
1
+ include README_PA.md
@@ -0,0 +1,315 @@
1
+ Metadata-Version: 2.4
2
+ Name: django-chelseru
3
+ Version: 1.0.3
4
+ Summary: Authentication system, online and real-time chat, SMS system for Iranian SMS services.
5
+ Home-page: https://pipdjango.chelseru.com
6
+ Author: Sobhan Bahman|Rashnu
7
+ Author-email: bahmanrashnu@gmail.com
8
+ Project-URL: Documentation, https://github.com/Chelseru/django-chelseru-lour/
9
+ Project-URL: Telegram Group, https://t.me/bahmanpy
10
+ Project-URL: Telegram Channel, https://t.me/ChelseruCom
11
+ Keywords: djangochelseruchat djangochat drfchat online-chat online real-time chat iran chelseru lor lur bahman rashnu lour sms djangoauth auth ywt otpauth otp authentication djangootp djangoiransms iransms djangosms djangokavenegar djangomelipayamak sobhan چت سبحان بهمن رشنو چلسرو جنگو پایتون لر لور آنلاین ریل تایم
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Framework :: Django
14
+ Classifier: License :: OSI Approved :: MIT License
15
+ Classifier: Operating System :: OS Independent
16
+ Requires-Python: >=3.11
17
+ Description-Content-Type: text/markdown
18
+ License-File: LICENSE
19
+ Requires-Dist: Django>=5.1.6
20
+ Requires-Dist: djangorestframework==3.15.2
21
+ Requires-Dist: djangorestframework_simplejwt==5.5.0
22
+ Requires-Dist: channels==4.2.2
23
+ Requires-Dist: channels_redis==4.2.1
24
+ Requires-Dist: daphne==4.1.2
25
+ Requires-Dist: zeep==4.3.1
26
+ Requires-Dist: user-agents==2.2.0
27
+ Dynamic: author
28
+ Dynamic: author-email
29
+ Dynamic: classifier
30
+ Dynamic: description
31
+ Dynamic: description-content-type
32
+ Dynamic: home-page
33
+ Dynamic: keywords
34
+ Dynamic: license-file
35
+ Dynamic: project-url
36
+ Dynamic: requires-dist
37
+ Dynamic: requires-python
38
+ Dynamic: summary
39
+
40
+ django-chelseru
41
+ یک بسته جنگویی برای گپ‌زنی همزمان، راستی‌آزمایی پیامکی و فرستادن پیامک با یاری‌دهنده‌های ایرانی.
42
+
43
+ نویسنده
44
+ Sobhan Bahman Rashnu
45
+
46
+ 🚀 ویژگی‌ها
47
+ 📱 راستی‌آزمایی پیامکی (رمز یک‌بارمصرف): راستی‌آزمایی امن کاربران با یاری‌گیری از رمزهای یک‌بارمصرف که از راه پیامک فرستاده می‌شوند.
48
+
49
+ 💬 گپ‌زنی همزمان: کارکرد پیام‌رسانی همزمان بر پایه WebSocket.
50
+
51
+ ✉️ سامانه‌های پیامکی: فرستادن پیامک از راه یاری‌دهنده‌های نامور پیامکی ایرانی.
52
+
53
+ ⚙️ نصب
54
+ بسته را با یاری‌گیری از pip نصب کنید:
55
+
56
+ pip install django-chelseru
57
+
58
+ 'drfchelseru' را به INSTALLED_APPS در پرونده settings.py خود بیفزایید:
59
+
60
+ INSTALLED_APPS = [
61
+ ...
62
+ 'drfchelseru',
63
+ 'rest_framework',
64
+ 'rest_framework_simplejwt',
65
+ ...
66
+ ]
67
+
68
+ 🛠️ پیکربندی
69
+ برای پیکربندی بسته، واژه‌نامه DJANGO_CHELSERU را به پرونده settings.py خود بیفزایید. این واژه‌نامه به شما پروانه می‌دهد تا چیدمان‌های راستی‌آزمایی و پیامک را خودساخته نمایید.
70
+
71
+ # settings.py
72
+
73
+ DJANGO_CHELSERU = {
74
+ 'AUTH': {
75
+ 'AUTH_METHOD' : 'OTP', # روش‌های پشتیبانی شده: OTP, PASSWD
76
+ 'AUTH_SERVICE' : 'rest_framework_simplejwt', # سرویس‌های پشتیبانی شده: rest_framework_simplejwt
77
+ 'OPTIONS': {
78
+ 'OTP_LENGTH' : 8, # پیش‌فرض: 8
79
+ 'OTP_EXPIRE_PER_MINUTES': 4, # پیش‌فرض: 4
80
+ 'OTP_SMS_TEMPLATE_ID' : 1, # شناسه قالب پیامکی برای رمز یک‌بارمصرف
81
+ }
82
+ },
83
+ 'SMS': {
84
+ 'SMS_SERVICE': 'PARSIAN_WEBCO_IR', # یاری‌دهنده‌های پشتیبانی شده: PARSIAN_WEBCO_IR, MELI_PAYAMAK_COM, KAVENEGAR_COM
85
+ 'SETTINGS': {
86
+ 'PARSIAN_WEBCO_IR_API_KEY' : '',
87
+ 'MELI_PAYAMAK_COM_USERNAME' : '',
88
+ 'MELI_PAYAMAK_COM_PASSWORD' : '',
89
+ 'MELI_PAYAMAK_COM_FROM' : '',
90
+ 'KAVENEGAR_COM_API_KEY' : 'YOUR_KAVENEGAR_API_KEY',
91
+ 'KAVENEGAR_COM_FROM' : 'YOUR_KAVENEGAR_FROM_NUMBER',
92
+ },
93
+ 'TEMPLATES': {
94
+ 'T1': 1,
95
+ 'T2': 2,
96
+ ...
97
+ }
98
+ }
99
+ }
100
+
101
+ AUTH_METHOD: روش راستی‌آزمایی را روشن می‌سازد. برای راستی‌آزمایی پیامکی، از 'OTP' بهره بگیرید.
102
+
103
+ OTP_LENGTH: درازای رمز یک‌بارمصرف.
104
+
105
+ OTP_EXPIRE_PER_MINUTES: زمان پایان‌یافتن رمز یک‌بارمصرف بر پایه دقیقه.
106
+
107
+ OTP_SMS_TEMPLATE_ID: شناسه قالب پیامکی که برای فرستادن رمز یک‌بارمصرف بهره گرفته می‌شود.
108
+
109
+ SMS_SERVICE: یاری‌دهنده پیامکی دلخواه خود را برگزینید.
110
+
111
+ SETTINGS: آگاهی‌های نیاز برای یاری‌دهنده پیامکی برگزیده‌تان را فراهم آورید.
112
+
113
+ TEMPLATES: شناسه‌های قالب پیامکی خود را روشن سازید.
114
+
115
+ 🔌 نقطه‌های پایانی
116
+ برای به کارگیری کارکردهای این بسته، URLهای زیر را به پرونده urls.py خود بیفزایید.
117
+
118
+ # urls.py
119
+
120
+ from django.urls import path, include
121
+
122
+ urlpatterns = [
123
+ ...
124
+ path('api/', include('drfchelseru.urls')),
125
+ ...
126
+ ]
127
+
128
+ این بسته نقطه‌های پایانی API زیر را فراهم می‌آورد:
129
+
130
+ نقطه‌ پایانی
131
+
132
+ شرح
133
+
134
+ روش
135
+
136
+ /api/otp/send/
137
+
138
+ یک رمز یک‌بارمصرف به شماره همراه گفته‌شده می‌فرستد.
139
+
140
+ POST
141
+
142
+ /api/authenticate/
143
+
144
+ کاربری را با رمز یک‌بارمصرف دریافت‌شده، راستی‌آزمایی می‌کند.
145
+
146
+ POST
147
+
148
+ /api/sessions/
149
+
150
+ نشست‌های فعال کاربر را فهرست کرده و درایوری می‌کند.
151
+
152
+ GET
153
+
154
+ /api/message/send/
155
+
156
+ یک پیامک با یاری‌دهنده پیکربندی‌شده می‌فرستد.
157
+
158
+ POST
159
+
160
+ به کارگیری نقطه‌های پایانی
161
+ 1. فرستادن رمز یک‌بارمصرف (/api/otp/send/)
162
+ روش: POST شرح: یک رمز یک‌بارمصرف به شماره همراه کاربر می‌فرستد.
163
+
164
+ داده‌نماهای نیاز:
165
+
166
+ داده‌نما
167
+
168
+ گونه
169
+
170
+ شرح
171
+
172
+ نمونه
173
+
174
+ mobile_number
175
+
176
+ str
177
+
178
+ شماره همراه کاربر.
179
+
180
+ 09121234567
181
+
182
+ پاسخ‌ها:
183
+
184
+ HTTP 200 OK: رمز یک‌بارمصرف با کامیابی فرستاده شد.
185
+
186
+ {"details": "The OTP code was sent correctly."}
187
+
188
+ HTTP 400 BAD REQUEST: ساختار نادرست mobile_number.
189
+
190
+ HTTP 409 CONFLICT: یک رمز یک‌بارمصرف پیش‌تر فرستاده شده و هنوز روایی دارد.
191
+
192
+ {"details": "An OTP code has already been sent. Please wait X seconds before trying again."}
193
+
194
+ HTTP 500 INTERNAL SERVER ERROR: یک دشواری در کارگذار پیش آمده است.
195
+
196
+ 2. راستی‌آزمایی (/api/authenticate/)
197
+ روش: POST شرح: کاربر را با رمز یک‌بارمصرف فراهم شده، راستی‌آزمایی می‌کند. اگر با کامیابی انجام شود، توکن‌های JWT (access و refresh) را بازمی‌گرداند.
198
+
199
+ داده‌نماهای نیاز:
200
+
201
+ داده‌نما
202
+
203
+ گونه
204
+
205
+ شرح
206
+
207
+ نمونه
208
+
209
+ mobile_number
210
+
211
+ str
212
+
213
+ شماره همراه کاربر.
214
+
215
+ 09121234567
216
+
217
+ code
218
+
219
+ str
220
+
221
+ رمز یک‌بارمصرف دریافت شده از راه پیامک.
222
+
223
+ 12345678
224
+
225
+ group
226
+
227
+ int
228
+
229
+ اختیاری: یک شناسه دسته برای کاربر.
230
+
231
+ 1
232
+
233
+ پاسخ‌ها:
234
+
235
+ HTTP 200 OK: راستی‌آزمایی با کامیابی انجام شد.
236
+
237
+ {
238
+ "access": "...",
239
+ "refresh": "..."
240
+ }
241
+
242
+ HTTP 401 UNAUTHORIZED: رمز یک‌بارمصرف ناروا یا پایان‌یافته.
243
+
244
+ {"error": "The code sent to this mobile number was not found."}
245
+
246
+ HTTP 400 BAD REQUEST: داده‌نماهای نیاز ناپیدا یا ساختار نادرست.
247
+
248
+ HTTP 500 INTERNAL SERVER ERROR: یک دشواری در کارگذار پیش آمده است.
249
+
250
+ 3. فرستادن پیامک (/api/message/send/)
251
+ روش: POST شرح: یک پیامک خودساخته را با یاری‌دهنده پیکربندی‌شده می‌فرستد.
252
+
253
+ داده‌نماهای نیاز:
254
+
255
+ داده‌نما
256
+
257
+ گونه
258
+
259
+ شرح
260
+
261
+ نمونه
262
+
263
+ mobile_number
264
+
265
+ str
266
+
267
+ شماره همراه گیرنده.
268
+
269
+ 09121234567
270
+
271
+ message_text
272
+
273
+ str
274
+
275
+ نوشتار پیام. (بیشینه ۲۹۰ نویسه)
276
+
277
+ Hello, World!
278
+
279
+ template_id
280
+
281
+ int
282
+
283
+ برای برخی یاری‌دهنده‌ها (برای نمونه پارسیان) نیاز است.
284
+
285
+ 1
286
+
287
+ پاسخ‌ها:
288
+
289
+ HTTP 200 OK: پیام با کامیابی فرستاده شد.
290
+
291
+ {"details": "The Message was sent correctly."}
292
+
293
+ HTTP 400 BAD REQUEST: دشواری‌های درست‌سنجی برای داده‌نماها.
294
+
295
+ HTTP 401 UNAUTHORIZED: راستی‌آزمایی انجام نشد.
296
+
297
+ HTTP 500 INTERNAL SERVER ERROR: یک دشواری در کارگذار پیش آمده است.
298
+
299
+ HTTP 502 BAD GATEWAY: یاری‌دهنده پیامکی یک دشواری را بازگرداند.
300
+
301
+ 4. فهرست نشست‌ها (/api/sessions/)
302
+ روش: GET شرح: همه نشست‌های فعال کاربران را فهرست می‌کند. نیاز به راستی‌آزمایی (IsAuthenticated) دارد.
303
+
304
+ سربرگ‌های نیاز:
305
+
306
+ سربرگ
307
+
308
+ ارزش
309
+
310
+ Authorization
311
+
312
+ Bearer <your_access_token>
313
+
314
+ 💡 مدل‌ها
315
+ این بسته یک مدل Session برای درایوری نشست‌های فعال کاربران دارد. می‌توانید به این نشست‌ها از راه نقطه‌ پایانی /api/sessions/ دسترسی یافته و آنها را درایوری کنید.
@@ -0,0 +1,56 @@
1
+ django-chelseruA Django package for real-time chat, SMS authentication, and sending SMS messages with Iranian providers.AuthorSobhan Bahman Rashnu🚀 Features📱 SMS Authentication (OTP): Secure user authentication using one-time passwords sent via SMS.💬 Real-time Chat: WebSocket-based real-time messaging functionality.✉️ SMS Services: Send SMS messages through popular Iranian SMS providers.⚙️ InstallationInstall the package using pip:pip install django-chelseru
2
+ Add 'drfchelseru' to your INSTALLED_APPS in settings.py:INSTALLED_APPS = [
3
+ ...
4
+ 'channels',
5
+ 'rest_framework',
6
+ 'rest_framework_simplejwt',
7
+ 'drfchelseru',
8
+ ...
9
+ ]
10
+ 🛠️ ConfigurationTo configure the package, add the DJANGO_CHELSERU dictionary to your settings.py file. This dictionary allows you to customize authentication and SMS settings.# settings.py
11
+
12
+ DJANGO_CHELSERU = {
13
+ 'AUTH': {
14
+ 'AUTH_METHOD' : 'OTP', # Supported methods: OTP, PASSWD
15
+ 'AUTH_SERVICE' : 'rest_framework_simplejwt', # Supported services: rest_framework_simplejwt
16
+ 'OPTIONS': {
17
+ 'OTP_LENGTH' : 8, # Default: 8
18
+ 'OTP_EXPIRE_PER_MINUTES': 4, # Default: 4
19
+ 'OTP_SMS_TEMPLATE_ID' : 1, # SMS template ID for OTP
20
+ }
21
+ },
22
+ 'SMS': {
23
+ 'SMS_SERVICE': 'PARSIAN_WEBCO_IR', # Supported providers: PARSIAN_WEBCO_IR, MELI_PAYAMAK_COM, KAVENEGAR_COM
24
+ 'SETTINGS': {
25
+ 'PARSIAN_WEBCO_IR_API_KEY' : 'YOUR_PARSIAN_WEBCO_API_KEY',
26
+ 'MELI_PAYAMAK_COM_USERNAME' : 'YOUR_MELI_PAYAMAK_USERNAME',
27
+ 'MELI_PAYAMAK_COM_PASSWORD' : 'YOUR_MELI_PAYAMAK_PASSWORD',
28
+ 'MELI_PAYAMAK_COM_FROM' : 'YOUR_MELI_PAYAMAK_FROM_NUMBER',
29
+ 'KAVENEGAR_COM_API_KEY' : 'YOUR_KAVENEGAR_API_KEY',
30
+ 'KAVENEGAR_COM_FROM' : 'YOUR_KAVENEGAR_FROM_NUMBER',
31
+ },
32
+ 'TEMPLATES': {
33
+ 'T1': 1,
34
+ 'T2': 2,
35
+ ...
36
+ }
37
+ }
38
+ }
39
+ AUTH_METHOD: Specifies the authentication method. Use 'OTP' for SMS-based authentication.OTP_LENGTH: The length of the one-time password.OTP_EXPIRE_PER_MINUTES: The expiration time for the OTP in minutes.OTP_SMS_TEMPLATE_ID: The template ID of the SMS message used for sending the OTP.SMS_SERVICE: Select your desired SMS provider.SETTINGS: Provide the necessary credentials for your chosen SMS provider.TEMPLATES: Define your SMS template IDs.🔌 EndpointsAdd the following URLs to your urls.py file to use the package's functionality.# urls.py
40
+
41
+ from django.urls import path, include
42
+
43
+ urlpatterns = [
44
+ ...
45
+ path('api/', include('drfchelseru.urls')),
46
+ ...
47
+ ]
48
+ The package provides the following API endpoints:EndpointDescriptionMethod/api/otp/send/Sends an OTP to the specified phone number.POST/api/authenticate/Authenticates a user with the received OTP.POST/api/sessions/Lists and manages active user sessions.GET/api/message/send/Sends an SMS message using the configured provider.POSTEndpoint Usage1. OTP Code Sending (/api/otp/send/)Method: POSTDescription: Sends a one-time password to the user's mobile number.Required Parameters:ParameterTypeDescriptionExamplemobile_numberstrThe user's mobile number.09121234567Responses:HTTP 200 OK: OTP code sent successfully.{"details": "The OTP code was sent correctly."}
49
+ HTTP 400 BAD REQUEST: Invalid mobile_number format.HTTP 409 CONFLICT: An OTP has already been sent and is still valid.{"details": "An OTP code has already been sent. Please wait X seconds before trying again."}
50
+ HTTP 500 INTERNAL SERVER ERROR: An issue occurred on the server.2. Authentication (/api/authenticate/)Method: POSTDescription: Authenticates the user with the provided OTP. On success, it returns JWT tokens (access and refresh).Required Parameters:ParameterTypeDescriptionExamplemobile_numberstrThe user's mobile number.09121234567codestrThe OTP received via SMS.12345678groupintOptional: A group identifier for the user.1Responses:HTTP 200 OK: Authentication successful.{
51
+ "access": "...",
52
+ "refresh": "..."
53
+ }
54
+ HTTP 401 UNAUTHORIZED: Invalid or expired OTP code.{"error": "The code sent to this mobile number was not found."}
55
+ HTTP 400 BAD REQUEST: Missing required parameters or invalid format.HTTP 500 INTERNAL SERVER ERROR: An issue occurred on the server.3. Message Sending (/api/message/send/)Method: POSTDescription: Sends a custom SMS message using the configured provider.Required Parameters:ParameterTypeDescriptionExamplemobile_numberstrThe recipient's mobile number.09121234567message_textstrThe text of the message. (Max 290 chars)Hello, World!template_idintRequired for some providers (e.g., Parsian).1Responses:HTTP 200 OK: Message sent successfully.{"details": "The Message was sent correctly."}
56
+ HTTP 400 BAD REQUEST: Validation errors for parameters.HTTP 401 UNAUTHORIZED: Authentication failed.HTTP 500 INTERNAL SERVER ERROR: An issue occurred on the server.HTTP 502 BAD GATEWAY: SMS provider returned an error.4. Session List (/api/sessions/)Method: GETDescription: Lists all active user sessions. Requires authentication (IsAuthenticated).Required Headers:HeaderValueAuthorizationBearer <your_access_token>💡 ModelsThis package includes a Session model for managing active user sessions. You can access and manage these sessions through the /api/sessions/ endpoint.
@@ -0,0 +1,276 @@
1
+ django-chelseru
2
+ یک بسته جنگویی برای گپ‌زنی همزمان، راستی‌آزمایی پیامکی و فرستادن پیامک با یاری‌دهنده‌های ایرانی.
3
+
4
+ نویسنده
5
+ Sobhan Bahman Rashnu
6
+
7
+ 🚀 ویژگی‌ها
8
+ 📱 راستی‌آزمایی پیامکی (رمز یک‌بارمصرف): راستی‌آزمایی امن کاربران با یاری‌گیری از رمزهای یک‌بارمصرف که از راه پیامک فرستاده می‌شوند.
9
+
10
+ 💬 گپ‌زنی همزمان: کارکرد پیام‌رسانی همزمان بر پایه WebSocket.
11
+
12
+ ✉️ سامانه‌های پیامکی: فرستادن پیامک از راه یاری‌دهنده‌های نامور پیامکی ایرانی.
13
+
14
+ ⚙️ نصب
15
+ بسته را با یاری‌گیری از pip نصب کنید:
16
+
17
+ pip install django-chelseru
18
+
19
+ 'drfchelseru' را به INSTALLED_APPS در پرونده settings.py خود بیفزایید:
20
+
21
+ INSTALLED_APPS = [
22
+ ...
23
+ 'drfchelseru',
24
+ 'rest_framework',
25
+ 'rest_framework_simplejwt',
26
+ ...
27
+ ]
28
+
29
+ 🛠️ پیکربندی
30
+ برای پیکربندی بسته، واژه‌نامه DJANGO_CHELSERU را به پرونده settings.py خود بیفزایید. این واژه‌نامه به شما پروانه می‌دهد تا چیدمان‌های راستی‌آزمایی و پیامک را خودساخته نمایید.
31
+
32
+ # settings.py
33
+
34
+ DJANGO_CHELSERU = {
35
+ 'AUTH': {
36
+ 'AUTH_METHOD' : 'OTP', # روش‌های پشتیبانی شده: OTP, PASSWD
37
+ 'AUTH_SERVICE' : 'rest_framework_simplejwt', # سرویس‌های پشتیبانی شده: rest_framework_simplejwt
38
+ 'OPTIONS': {
39
+ 'OTP_LENGTH' : 8, # پیش‌فرض: 8
40
+ 'OTP_EXPIRE_PER_MINUTES': 4, # پیش‌فرض: 4
41
+ 'OTP_SMS_TEMPLATE_ID' : 1, # شناسه قالب پیامکی برای رمز یک‌بارمصرف
42
+ }
43
+ },
44
+ 'SMS': {
45
+ 'SMS_SERVICE': 'PARSIAN_WEBCO_IR', # یاری‌دهنده‌های پشتیبانی شده: PARSIAN_WEBCO_IR, MELI_PAYAMAK_COM, KAVENEGAR_COM
46
+ 'SETTINGS': {
47
+ 'PARSIAN_WEBCO_IR_API_KEY' : '',
48
+ 'MELI_PAYAMAK_COM_USERNAME' : '',
49
+ 'MELI_PAYAMAK_COM_PASSWORD' : '',
50
+ 'MELI_PAYAMAK_COM_FROM' : '',
51
+ 'KAVENEGAR_COM_API_KEY' : 'YOUR_KAVENEGAR_API_KEY',
52
+ 'KAVENEGAR_COM_FROM' : 'YOUR_KAVENEGAR_FROM_NUMBER',
53
+ },
54
+ 'TEMPLATES': {
55
+ 'T1': 1,
56
+ 'T2': 2,
57
+ ...
58
+ }
59
+ }
60
+ }
61
+
62
+ AUTH_METHOD: روش راستی‌آزمایی را روشن می‌سازد. برای راستی‌آزمایی پیامکی، از 'OTP' بهره بگیرید.
63
+
64
+ OTP_LENGTH: درازای رمز یک‌بارمصرف.
65
+
66
+ OTP_EXPIRE_PER_MINUTES: زمان پایان‌یافتن رمز یک‌بارمصرف بر پایه دقیقه.
67
+
68
+ OTP_SMS_TEMPLATE_ID: شناسه قالب پیامکی که برای فرستادن رمز یک‌بارمصرف بهره گرفته می‌شود.
69
+
70
+ SMS_SERVICE: یاری‌دهنده پیامکی دلخواه خود را برگزینید.
71
+
72
+ SETTINGS: آگاهی‌های نیاز برای یاری‌دهنده پیامکی برگزیده‌تان را فراهم آورید.
73
+
74
+ TEMPLATES: شناسه‌های قالب پیامکی خود را روشن سازید.
75
+
76
+ 🔌 نقطه‌های پایانی
77
+ برای به کارگیری کارکردهای این بسته، URLهای زیر را به پرونده urls.py خود بیفزایید.
78
+
79
+ # urls.py
80
+
81
+ from django.urls import path, include
82
+
83
+ urlpatterns = [
84
+ ...
85
+ path('api/', include('drfchelseru.urls')),
86
+ ...
87
+ ]
88
+
89
+ این بسته نقطه‌های پایانی API زیر را فراهم می‌آورد:
90
+
91
+ نقطه‌ پایانی
92
+
93
+ شرح
94
+
95
+ روش
96
+
97
+ /api/otp/send/
98
+
99
+ یک رمز یک‌بارمصرف به شماره همراه گفته‌شده می‌فرستد.
100
+
101
+ POST
102
+
103
+ /api/authenticate/
104
+
105
+ کاربری را با رمز یک‌بارمصرف دریافت‌شده، راستی‌آزمایی می‌کند.
106
+
107
+ POST
108
+
109
+ /api/sessions/
110
+
111
+ نشست‌های فعال کاربر را فهرست کرده و درایوری می‌کند.
112
+
113
+ GET
114
+
115
+ /api/message/send/
116
+
117
+ یک پیامک با یاری‌دهنده پیکربندی‌شده می‌فرستد.
118
+
119
+ POST
120
+
121
+ به کارگیری نقطه‌های پایانی
122
+ 1. فرستادن رمز یک‌بارمصرف (/api/otp/send/)
123
+ روش: POST شرح: یک رمز یک‌بارمصرف به شماره همراه کاربر می‌فرستد.
124
+
125
+ داده‌نماهای نیاز:
126
+
127
+ داده‌نما
128
+
129
+ گونه
130
+
131
+ شرح
132
+
133
+ نمونه
134
+
135
+ mobile_number
136
+
137
+ str
138
+
139
+ شماره همراه کاربر.
140
+
141
+ 09121234567
142
+
143
+ پاسخ‌ها:
144
+
145
+ HTTP 200 OK: رمز یک‌بارمصرف با کامیابی فرستاده شد.
146
+
147
+ {"details": "The OTP code was sent correctly."}
148
+
149
+ HTTP 400 BAD REQUEST: ساختار نادرست mobile_number.
150
+
151
+ HTTP 409 CONFLICT: یک رمز یک‌بارمصرف پیش‌تر فرستاده شده و هنوز روایی دارد.
152
+
153
+ {"details": "An OTP code has already been sent. Please wait X seconds before trying again."}
154
+
155
+ HTTP 500 INTERNAL SERVER ERROR: یک دشواری در کارگذار پیش آمده است.
156
+
157
+ 2. راستی‌آزمایی (/api/authenticate/)
158
+ روش: POST شرح: کاربر را با رمز یک‌بارمصرف فراهم شده، راستی‌آزمایی می‌کند. اگر با کامیابی انجام شود، توکن‌های JWT (access و refresh) را بازمی‌گرداند.
159
+
160
+ داده‌نماهای نیاز:
161
+
162
+ داده‌نما
163
+
164
+ گونه
165
+
166
+ شرح
167
+
168
+ نمونه
169
+
170
+ mobile_number
171
+
172
+ str
173
+
174
+ شماره همراه کاربر.
175
+
176
+ 09121234567
177
+
178
+ code
179
+
180
+ str
181
+
182
+ رمز یک‌بارمصرف دریافت شده از راه پیامک.
183
+
184
+ 12345678
185
+
186
+ group
187
+
188
+ int
189
+
190
+ اختیاری: یک شناسه دسته برای کاربر.
191
+
192
+ 1
193
+
194
+ پاسخ‌ها:
195
+
196
+ HTTP 200 OK: راستی‌آزمایی با کامیابی انجام شد.
197
+
198
+ {
199
+ "access": "...",
200
+ "refresh": "..."
201
+ }
202
+
203
+ HTTP 401 UNAUTHORIZED: رمز یک‌بارمصرف ناروا یا پایان‌یافته.
204
+
205
+ {"error": "The code sent to this mobile number was not found."}
206
+
207
+ HTTP 400 BAD REQUEST: داده‌نماهای نیاز ناپیدا یا ساختار نادرست.
208
+
209
+ HTTP 500 INTERNAL SERVER ERROR: یک دشواری در کارگذار پیش آمده است.
210
+
211
+ 3. فرستادن پیامک (/api/message/send/)
212
+ روش: POST شرح: یک پیامک خودساخته را با یاری‌دهنده پیکربندی‌شده می‌فرستد.
213
+
214
+ داده‌نماهای نیاز:
215
+
216
+ داده‌نما
217
+
218
+ گونه
219
+
220
+ شرح
221
+
222
+ نمونه
223
+
224
+ mobile_number
225
+
226
+ str
227
+
228
+ شماره همراه گیرنده.
229
+
230
+ 09121234567
231
+
232
+ message_text
233
+
234
+ str
235
+
236
+ نوشتار پیام. (بیشینه ۲۹۰ نویسه)
237
+
238
+ Hello, World!
239
+
240
+ template_id
241
+
242
+ int
243
+
244
+ برای برخی یاری‌دهنده‌ها (برای نمونه پارسیان) نیاز است.
245
+
246
+ 1
247
+
248
+ پاسخ‌ها:
249
+
250
+ HTTP 200 OK: پیام با کامیابی فرستاده شد.
251
+
252
+ {"details": "The Message was sent correctly."}
253
+
254
+ HTTP 400 BAD REQUEST: دشواری‌های درست‌سنجی برای داده‌نماها.
255
+
256
+ HTTP 401 UNAUTHORIZED: راستی‌آزمایی انجام نشد.
257
+
258
+ HTTP 500 INTERNAL SERVER ERROR: یک دشواری در کارگذار پیش آمده است.
259
+
260
+ HTTP 502 BAD GATEWAY: یاری‌دهنده پیامکی یک دشواری را بازگرداند.
261
+
262
+ 4. فهرست نشست‌ها (/api/sessions/)
263
+ روش: GET شرح: همه نشست‌های فعال کاربران را فهرست می‌کند. نیاز به راستی‌آزمایی (IsAuthenticated) دارد.
264
+
265
+ سربرگ‌های نیاز:
266
+
267
+ سربرگ
268
+
269
+ ارزش
270
+
271
+ Authorization
272
+
273
+ Bearer <your_access_token>
274
+
275
+ 💡 مدل‌ها
276
+ این بسته یک مدل Session برای درایوری نشست‌های فعال کاربران دارد. می‌توانید به این نشست‌ها از راه نقطه‌ پایانی /api/sessions/ دسترسی یافته و آنها را درایوری کنید.