Release 0.3.23b0

Author: carlobortolan

README.md

@@ -16,7 +16,7 @@ or in your requirements.txt
 # Find the version you want to pin:
 # https://pypi.org/project/embloy-sdk/#history
 # Specify that version in your requirements.txt file
-embloy_sdk>=0.3.1b
+embloy_sdk>=0.3.23b
 ```
 
 Integrate it in your service:
@@ -33,8 +33,14 @@ session = EmbloySession("job", "your_job_slug", "your_success_url", "your_cancel
 redirect_url = EmbloyClient(client_token, session).make_request()
 ```
 
+## Run the tests
+```Bash
+python -m unittest tests/test_embloy_client.py
+```
+
 ## Publish Package
 ```Bash
+
 python setup.py sdist bdist_wheel
 
 twine upload dist/*

embloy_sdk/__init__.py

@@ -1 +1,2 @@
-from .embloy_client import EmbloyClient
+from .embloy_client import EmbloyClient
+from .embloy_session import EmbloySession, SessionOptions

embloy_sdk/embloy_client.py

@@ -1,4 +1,6 @@
 import requests
+from .embloy_session import EmbloySession
+import json
 
 class EmbloyClient:
     """
@@ -26,57 +28,65 @@ class EmbloyClient:
     """
     def __init__(self, client_token, session, api_url='https://api.embloy.com', base_url='https://embloy.com', api_version='api/v0'):
         if not isinstance(client_token, str):
-            raise ValueError('clientToken must be a string')
+            raise ValueError('client_token must be a string')
+        if not isinstance(session, EmbloySession):
+            raise ValueError('session must be an instance of EmbloySession')
         self.client_token = client_token
         self.session = session
         self.api_url = api_url
         self.base_url = base_url
         self.api_version = api_version
 
-    def get_form_data_and_headers(self):
-        """
-        Returns the form data and headers for a request.
-
-        Returns
-        -------
-        tuple
-            A tuple containing the form data and headers.
-        """
+    def form_request(self):
         data = {
             'mode': self.session.mode,
             'job_slug': self.session.job_slug,
-            'success_url': self.session.success_url,
-            'cancel_url': self.session.cancel_url,
         }
 
+        if self.session.success_url is not None:
+            data['success_url'] = self.session.success_url
+
+        if self.session.cancel_url is not None:
+            data['cancel_url'] = self.session.cancel_url
+
         headers = {
             'client_token': self.client_token,
-            'User-Agent': 'embloy-sdk/0.3.1b (Python; Server)',
             'Content-Type': 'application/json',
+            'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:122.0) Gecko/20100101 Firefox/122.0',
         }
 
         return data, headers
 
-    def make_request(self):
-        """
-        Makes a request to the API and returns a URL with the request token.
+    """
+    Makes a request to the API and returns a URL with the request token.
+
+    Returns
+    -------
+    str
+        A URL with the request token for the application session.
 
-        Returns
-        -------
-        str
-            A URL with the request token for the application session.
+    Raises
+    ------
+    requests.exceptions.RequestException
+        If the request fails for any reason.
+    """
+    def make_request(self):
+        data, headers = self.form_request()
 
-        Raises
-        ------
-        requests.exceptions.RequestException
-            If the request fails for any reason.
-        """
-        data, headers = self.get_form_data_and_headers()
+        url = f"{self.api_url}/{self.api_version}/sdk/request/auth/token"
 
         try:
-            response = requests.post(f'{self.api_url}/{self.api_version}/sdk/request/auth/token', json=data, headers=headers)
+            response = requests.request("POST", url, headers=headers, data=json.dumps(data))
+
             response.raise_for_status()
             request_token = response.json()['request_token']
             return f"{self.base_url}/sdk/apply?request_token={request_token}"
         except requests.exceptions.RequestException as e:
+            debug_info = {
+                'client_token': self.client_token,
+                'error': str(e),
+                'request_headers': headers,
+                'response_headers': dict(response.headers),
+            }
+            print('Debug Info:', debug_info)
             raise e

embloy_sdk/embloy_session.py

@@ -0,0 +1,52 @@
+class EmbloySession:
+    """
+    A class used to represent a session for the Embloy API.
+
+    Attributes
+    ----------
+    mode : str
+        The mode of the session.
+    job_slug : str
+        The job slug for the session.
+    success_url : str
+        The success URL for the session.
+    cancel_url : str
+        The cancel URL for the session.
+
+    Methods
+    -------
+    __init__(mode, job_slug, success_url, cancel_url)
+        Initializes the EmbloySession.
+    """
+
+class SessionOptions:
+    def __init__(self, success_url=None, cancel_url=None, **kwargs):
+        self.success_url = success_url
+        self.cancel_url = cancel_url
+        self.__dict__.update(kwargs)
+
+class EmbloySession:
+    def __init__(self, mode, job_slug, options=SessionOptions()):
+        """
+        Initializes the EmbloySession.
+
+        Parameters
+        ----------
+        mode : str
+            The mode of the session.
+        job_slug : str
+            The job slug for the session.
+        success_url : str, optional
+            The success URL for the session.
+        cancel_url : str, optional
+            The cancel URL for the session.
+        """
+        if not mode:
+            raise ValueError("mode is required")
+        if not job_slug:
+            raise ValueError("job_slug is required")
+
+        self.mode = mode
+        self.job_slug = job_slug
+        self.success_url = options.success_url
+        self.cancel_url = options.cancel_url

package-lock.json

@@ -3,7 +3,7 @@
 
 setup(
     name='embloy_sdk',
-    version='0.3.1b',
+    version='0.3.23b',
     packages=find_packages(),
     install_requires=[
         'requests',

setup.py

@@ -0,0 +1,28 @@
+import unittest
+import json
+from unittest.mock import patch, Mock
+from embloy_sdk import EmbloyClient, EmbloySession
+
+class TestEmbloyClient(unittest.TestCase):
+    @patch('requests.request')
+    def test_make_request(self, mock_request):
+        mock_response = Mock()
+        mock_response.raise_for_status.return_value = None
+        mock_response.json.return_value = {'request_token': 'test_token'}
+        mock_request.return_value = mock_response
+
+        session = EmbloySession('test_mode', 'test_job_slug')
+        client = EmbloyClient('test_token', session)
+
+        result = client.make_request()
+
+        self.assertEqual(result, 'https://embloy.com/sdk/apply?request_token=test_token')
+        mock_request.assert_called_once_with(
+            "POST",
+            'https://api.embloy.com/api/v0/sdk/request/auth/token',
+            headers={'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:122.0) Gecko/20100101 Firefox/122.0', 'client_token': 'test_token', 'Content-Type': 'application/json'},
+            data=json.dumps({'mode': 'test_mode', 'job_slug': 'test_job_slug'})
+        )
+
+if __name__ == '__main__':
+    unittest.main()