Release 0.3.1b0

Author: carlobortolan

README.md

@@ -1,6 +1,6 @@
-# Embloy Node
+# Embloy Python
 
-Embloy's Node SDK for interacting with your Embloy integration.
+Embloy's Python SDK for interacting with your Embloy integration.
 
 ## Usage
 
@@ -16,29 +16,21 @@ 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>=0.2.0
+embloy_sdk>=0.3.1b
 ```
 
 Integrate it in your service:
 
 ```Python
-// In your application or script
-from embloy_sdk import EmbloyClient
+# In your application or script
+from embloy_sdk import EmbloyClient, EmbloySession
 
 # Replace with your actual values
 client_token = 'your_client_token'
-session = {
-    'mode': 'job',
-    'success_url': 'your_success_url',
-    'cancel_url': 'your_cancel_url',
-    'job_slug': 'your_job_slug'
-}
-
-# Create an instance of the EmbloyClient
-embloy_client = EmbloyClient(client_token, session)
+session = EmbloySession("job", "your_job_slug", "your_success_url", "your_cancel_url")
 
 # Make a request to the Embloy API
-redirect_url = embloy_client.make_request()
+redirect_url = EmbloyClient(client_token, session).make_request()
 ```
 
 ## Publish Package

embloy_sdk/embloy_client.py

@@ -1,34 +1,82 @@
 import requests
-import json
 
 class EmbloyClient:
-    def __init__(self, client_token, session, base_url='https://api.embloy.com', api_version='api/v0'):
+    """
+    A class used to represent a client for the Embloy API.
+
+    Attributes
+    ----------
+    client_token : str
+        The client token for the API.
+    session : EmbloySession
+        The session associated with the client.
+    api_url : str
+        The URL for the API.
+    base_url : str
+        The base URL for the API.
+    api_version : str
+        The version of the API.
+
+    Methods
+    -------
+    get_form_data_and_headers()
+        Returns the form data and headers for a request.
+    make_request()
+        Makes a request to the API and returns a URL with the request token.
+    """
+    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')
         self.client_token = client_token
         self.session = session
+        self.api_url = api_url
         self.base_url = base_url
         self.api_version = api_version
 
-    def make_request(self):
-        url = f'{self.base_url}/{self.api_version}/sdk/request/auth/token'
-        headers = {'client_token': self.client_token}
+    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.
+        """
         data = {
-            'mode': self.session.get('mode', 'job'),
-            'success_url': self.session.get('success_url', ''),
-            'cancel_url': self.session.get('cancel_url', ''),
-            'job_slug': self.session.get('job_slug', '')
+            'mode': self.session.mode,
+            'job_slug': self.session.job_slug,
+            'success_url': self.session.success_url,
+            'cancel_url': self.session.cancel_url,
         }
 
-        try:
-            response = requests.post(url, headers=headers, data=data)
-            response.raise_for_status()  # Raise an HTTPError for bad responses (4xx or 5xx)
-            return self.handle_response(response)
-        except requests.exceptions.RequestException as e:
-            raise Exception(f"Error making request: {str(e)}")
+        headers = {
+            'client_token': self.client_token,
+            'User-Agent': 'embloy-sdk/0.3.1b (Python; Server)',
+            'Content-Type': 'application/json',
+        }
 
-    def handle_response(self, response):
-        if response.status_code == 200:
-            request_token = json.loads(response.text)['request_token']
-            return f"@{self.base_url}/sdk/apply?token={request_token}"
-        else:
-            raise Exception(f"Error making request: {response.text}")
+        return data, headers
 
+    def make_request(self):
+        """
+        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.
+
+        Raises
+        ------
+        requests.exceptions.RequestException
+            If the request fails for any reason.
+        """
+        data, headers = self.get_form_data_and_headers()
+
+        try:
+            response = requests.post(f'{self.api_url}/{self.api_version}/sdk/request/auth/token', json=data, headers=headers)
+            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:
+            raise e

setup.py

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