Skip to content

feat: added logs to the api client and factors api #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: added logs to the api client and factors api #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions okta/FactorsClient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from __future__ import unicode_literals
import rollbar

from okta.framework.ApiClient import ApiClient
from okta.framework.Utils import Utils
Expand Down Expand Up @@ -48,6 +49,17 @@ def get_available_questions(self, user_id):
return Utils.deserialize(response.text, Question)

def enroll_factor(self, user_id, factor_enroll_request, update_phone=None, activate=False):
rollbar.report_message(
message="Enroll Factor function start",
level='info',
extra_data={
'instance': str(self),
'user_id': str(user_id),
'factor_enroll_request': str(factor_enroll_request),
'update_phone': str(update_phone),
'activate': str(activate),
}
)
"""Enroll a user into a factor

:param user_id: target user id
Expand Down Expand Up @@ -83,6 +95,16 @@ def get_factor(self, user_id, user_factor_id):
return Utils.deserialize(response.text, Factor)

def update_factor(self, user_id, user_factor_id, factor_enroll_request):
rollbar.report_message(
message="Update Factor function start",
level='info',
extra_data={
'instance': str(self),
'user_id': str(user_id),
'factor_enroll_request': str(factor_enroll_request),
'user_factor_id': str(user_factor_id),
}
)
"""Update an enrolled factor

:param user_id: target user id
Expand Down
74 changes: 74 additions & 0 deletions okta/framework/ApiClient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,40 +43,114 @@ def __init__(self, *args, **kwargs):
self.headers.update(kwargs['headers'])

def get(self, url, params=None, attempts=0):
rollbar.report_message(
message="ApiClient get function start",
level='info',
extra_data={
'instance': str(self),
'url': str(url),
'params': str(params),
'attempts': str(attempts),
}
)
params_str = self.__dict_to_query_params(params)
resp = requests.get(url + params_str, headers=self.headers)
attempts += 1
rollbar.report_message(
message="ApiClient get function check response if it is fine (200)",
level='debug',
extra_data={
'resp_code': str(resp),
'attempts': str(attempts),
}
)
if self.__check_response(resp, attempts):
return resp
else:
return self.get(url, params, attempts)

def put(self, url, data=None, params=None, attempts=0):
rollbar.report_message(
message="ApiClient put function start",
level='info',
extra_data={
'instance': str(self),
'url': str(url),
'data': str(data),
'params': str(params),
'attempts': str(attempts),
}
)
if data:
data = json.dumps(data, cls=Serializer)
params_str = self.__dict_to_query_params(params)
resp = requests.put(url + params_str, data=data, headers=self.headers)
attempts += 1
rollbar.report_message(
message="ApiClient put function check response if it is fine (200)",
level='debug',
extra_data={
'resp_code': str(resp),
'attempts': str(attempts),
}
)
if self.__check_response(resp, attempts):
return resp
else:
return self.put(url, data, params, attempts)

def post(self, url, data=None, params=None, attempts=0):
rollbar.report_message(
message="ApiClient post function start",
level='info',
extra_data={
'instance': str(self),
'url': str(url),
'data': str(data),
'params': str(params),
'attempts': str(attempts),
}
)
if data:
data = json.dumps(data, cls=Serializer, separators=(',', ':'))
params_str = self.__dict_to_query_params(params)
resp = requests.post(url + params_str, data=data, headers=self.headers)
attempts += 1
rollbar.report_message(
message="ApiClient post function check response if it is fine (200)",
level='debug',
extra_data={
'resp_code': str(resp),
'attempts': str(attempts),
}
)
if self.__check_response(resp, attempts):
return resp
else:
return self.post(url, data, params, attempts)

def delete(self, url, params=None, attempts=0):
rollbar.report_message(
message="ApiClient delete function start",
level='info',
extra_data={
'instance': str(self),
'url': str(url),
'params': str(params),
'attempts': str(attempts),
}
)
params_str = self.__dict_to_query_params(params)
resp = requests.delete(url + params_str, headers=self.headers)
attempts += 1
rollbar.report_message(
message="ApiClient delete function check response if it is fine (200)",
level='debug',
extra_data={
'resp_code': str(resp),
'attempts': str(attempts),
}
)
if self.__check_response(resp, attempts):
return resp
else:
Expand Down
3 changes: 2 additions & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
install_requires=[
'requests>=2.5.3',
'python-dateutil>=2.4.2',
'six>=1.9.0'
'six>=1.9.0',
'rollbar==0.16.3'
]
)