Skip to content

Commit

Permalink
Merge pull request #9 from notificationapi-com/VQxuDBbW/1559-identify…
Browse files Browse the repository at this point in the history 
…-userpref-functions-in-back-end-sdks

Add identify_user
  • Loading branch information
@sahandseifi
sahandseifi authored Nov 13, 2023
2 parents fa3ae2c + 098f5b3 commit ccd8031
Show file tree
Hide file tree
Showing 5 changed files with 256 additions and 8 deletions.
2 changes: 1 addition & 1 deletion notificationapi_python_server_sdk/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

__author__ = """Sahand Seifi"""
__email__ = "[email protected]"
__version__ = "0.1.7"
__version__ = "0.2.0"
28 changes: 23 additions & 5 deletions notificationapi_python_server_sdk/notificationapi.py
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import requests
import logging

import hashlib
import base64
import urllib.parse
__client_id = ""
__client_secret = ""

Expand All @@ -18,14 +20,19 @@ def init(client_id, client_secret):
__client_secret = client_secret


def request(method, uri, data=None):
def request(method, uri, data=None, custom_auth=None):
api_url = "https://api.notificationapi.com/" + __client_id + "/" + uri

headers = {}
if custom_auth:
headers['Authorization'] = custom_auth
else:
headers['Authorization'] = 'Basic ' + base64.b64encode(f'{__client_id}:{__client_secret}'.encode()).decode()

response = requests.request(
method,
api_url,
auth=requests.auth.HTTPBasicAuth(
username=__client_id, password=__client_secret
),
headers=headers,
json=data,
)
if response.status_code == 202:
Expand Down Expand Up @@ -69,3 +76,14 @@ def set_user_preferences(params):
"user_preferences/%s" % (params["userId"]),
params["userPreferences"],
)


def identify_user(params):
user_id = params.pop('id')

hashed_user_id = hashlib.sha256((__client_secret + user_id).encode()).digest()
hashed_user_id_base64 = base64.b64encode(hashed_user_id).decode()

custom_auth = 'Basic ' + base64.b64encode(f'{__client_id}:{user_id}:{hashed_user_id_base64}'.encode()).decode()

request('POST', f'users/{urllib.parse.quote(user_id)}', params, custom_auth)
2 changes: 1 addition & 1 deletion setup.cfg
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.1.7
current_version = 0.2.0
commit = True
tag = True

Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,6 @@
test_suite="tests",
tests_require=test_requirements,
url="https://github.com/notificationapi-com/notificationapi_python_server_sdk",
version="0.1.7",
version="0.2.0",
zip_safe=False,
)
230 changes: 230 additions & 0 deletions tests/test_notificationapi_identify_user.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,230 @@
#!/usr/bin/env python

"""Tests for `notificationapi_python_server_sdk` package."""

import pytest
import hashlib
import base64
import urllib.parse
from notificationapi_python_server_sdk import (
notificationapi,
)

client_id = "client_id"
client_secret = "client_secret"
user_id = "userId"


api_paths = {
"identify_user": f"https://api.notificationapi.com/{client_id}/users/{urllib.parse.quote(user_id)}",
}


@pytest.mark.parametrize(
"func,params",
[
(
"identify_user",
{
"id": user_id,
"email": "[email protected]",
"number": "+15005550006",
"pushTokens": [
{
"type": "FCM",
"token": "samplePushToken",
"device": {
"app_id": "sample_app_id",
"ad_id": "sample_ad_id",
"device_id": "sample_device_id",
"platform": "sample_platform",
"manufacturer": "sample_manufacturer",
"model": "sample_model"
}
}
],
"webPushTokens": [
{
"sub": {
"endpoint": "sample_endpoint",
"keys": {
"p256dh": "sample_p256dh",
"auth": "sample_auth"
}
}
}
]},
),
],
)
def test_makes_one_POST_api_call(requests_mock, func, params):
requests_mock.post(api_paths[func])
notificationapi.init(client_id, client_secret)
getattr(notificationapi, func)(params)
assert requests_mock.call_count == 1


@pytest.mark.parametrize(
"func,params",
[
(
"identify_user",
{
"id": user_id,
"email": "[email protected]",
"number": "+15005550006",
"pushTokens": [
{
"type": "FCM",
"token": "samplePushToken",
"device": {
"app_id": "sample_app_id",
"ad_id": "sample_ad_id",
"device_id": "sample_device_id",
"platform": "sample_platform",
"manufacturer": "sample_manufacturer",
"model": "sample_model"
}
}
],
"webPushTokens": [
{
"sub": {
"endpoint": "sample_endpoint",
"keys": {
"p256dh": "sample_p256dh",
"auth": "sample_auth"
}
}
}
]},
),
],
)
def test_uses_custom_authorization(requests_mock, func, params):
requests_mock.post(api_paths[func])
hashed_user_id = hashlib.sha256((client_secret + user_id).encode()).digest()
hashed_user_id_base64 = base64.b64encode(hashed_user_id).decode()

# Create custom authorization header
custom_auth = 'Basic ' + base64.b64encode(f'{client_id}:{user_id}:{hashed_user_id_base64}'.encode()).decode()
notificationapi.init(client_id, client_secret)
getattr(notificationapi, func)(params)
assert "Authorization" in requests_mock.last_request.headers
assert requests_mock.last_request.headers["Authorization"] == custom_auth


@pytest.mark.parametrize(
"func,params",
[
(
"identify_user",
{
"id": user_id,
"email": "[email protected]",
"number": "+15005550006",
"pushTokens": [
{
"type": "FCM",
"token": "samplePushToken",
"device": {
"app_id": "sample_app_id",
"ad_id": "sample_ad_id",
"device_id": "sample_device_id",
"platform": "sample_platform",
"manufacturer": "sample_manufacturer",
"model": "sample_model"
}
}
],
"webPushTokens": [
{
"sub": {
"endpoint": "sample_endpoint",
"keys": {
"p256dh": "sample_p256dh",
"auth": "sample_auth"
}
}
}
]},
),
],
)
def test_passes_data_as_json_body(requests_mock, func, params):
requests_mock.post(api_paths[func])
notificationapi.init(client_id, client_secret)
getattr(notificationapi, func)(params)
sent_data = requests_mock.last_request.json()
assert sent_data == {
"email": "[email protected]",
"number": "+15005550006",
"pushTokens": [
{
"type": "FCM",
"token": "samplePushToken",
"device": {
"app_id": "sample_app_id",
"ad_id": "sample_ad_id",
"device_id": "sample_device_id",
"platform": "sample_platform",
"manufacturer": "sample_manufacturer",
"model": "sample_model"
}
}
],
"webPushTokens": [
{
"sub": {
"endpoint": "sample_endpoint",
"keys": {
"p256dh": "sample_p256dh",
"auth": "sample_auth"
}
}
}
]}


@pytest.mark.parametrize(
"func,params",
[
(
"identify_user",
{
"id": user_id,
"email": "[email protected]",
"number": "+15005550006",
"pushTokens": [
{
"type": "FCM",
"token": "samplePushToken",
"device": {
"app_id": "sample_app_id",
"ad_id": "sample_ad_id",
"device_id": "sample_device_id",
"platform": "sample_platform",
"manufacturer": "sample_manufacturer",
"model": "sample_model"
}
}
],
"webPushTokens": [
{
"sub": {
"endpoint": "sample_endpoint",
"keys": {
"p256dh": "sample_p256dh",
"auth": "sample_auth"
}
}
}
]},
),
],
)
def test_logs_and_throws_on_500(requests_mock, caplog, func, params):
requests_mock.post(api_paths[func], status_code=500, text="big oof 500")
notificationapi.init(client_id, client_secret)
getattr(notificationapi, func)(params)
assert "NotificationAPI request failed. Response: big oof 500" in caplog.text

0 comments on commit ccd8031

Please sign in to comment.