salespyforce 1.4.0.dev1__tar.gz → 1.4.0rc0__tar.gz

{salespyforce-1.4.0.dev1 → salespyforce-1.4.0rc0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: salespyforce
-Version: 1.4.0.dev1
+Version: 1.4.0rc0
 Summary: A Python toolset for performing Salesforce API calls
 License: MIT License
          
@@ -63,7 +63,7 @@ A Python toolset for performing Salesforce API calls
         <td>Latest Beta/RC Release</td>
         <td>
             <a href='https://pypi.org/project/salespyforce/#history'>
-                <img alt="PyPI" src="https://img.shields.io/badge/pypi-1.4.0.dev1-blue">
+                <img alt="PyPI" src="https://img.shields.io/badge/pypi-1.4.0.dev2-blue">
             </a>
         </td>
     </tr>
@@ -151,14 +151,6 @@ The package can be installed via pip using the syntax below.
 pip install salespyforce --upgrade
 ```
 
-You may also clone the repository and install from source using below.
-
-```sh
-git clone git://github.com/jeffshurtliff/salespyforce.git
-cd salespyforce/
-python setup.py install
-```
-
 ## Change Log
 The change log can be found in the [documentation](https://salespyforce.readthedocs.io/en/latest/changelog.html).
 

{salespyforce-1.4.0.dev1 → salespyforce-1.4.0rc0}/README.md

@@ -14,7 +14,7 @@ A Python toolset for performing Salesforce API calls
         <td>Latest Beta/RC Release</td>
         <td>
             <a href='https://pypi.org/project/salespyforce/#history'>
-                <img alt="PyPI" src="https://img.shields.io/badge/pypi-1.4.0.dev1-blue">
+                <img alt="PyPI" src="https://img.shields.io/badge/pypi-1.4.0.dev2-blue">
             </a>
         </td>
     </tr>
@@ -102,14 +102,6 @@ The package can be installed via pip using the syntax below.
 pip install salespyforce --upgrade
 ```
 
-You may also clone the repository and install from source using below.
-
-```sh
-git clone git://github.com/jeffshurtliff/salespyforce.git
-cd salespyforce/
-python setup.py install
-```
-
 ## Change Log
 The change log can be found in the [documentation](https://salespyforce.readthedocs.io/en/latest/changelog.html).
 

{salespyforce-1.4.0.dev1 → salespyforce-1.4.0rc0}/pyproject.toml

@@ -1,33 +1,33 @@
 [project]
 name = "salespyforce"
-version = "1.4.0.dev1"
+version = "1.4.0.rc0"
 description = "A Python toolset for performing Salesforce API calls"
 readme = "README.md"
 requires-python = ">=3.9,<4.0"
 license = { file = "LICENSE" }
 authors = [
-  { name = "Jeff Shurtliff", email = "jeffshurtliff@gmail.com" }
+    { name = "Jeff Shurtliff", email = "jeffshurtliff@gmail.com" }
 ]
 keywords = ["salesforce", "sfdc", "api", "rest", "tooling", "python"]
 
 classifiers = [
-  "Development Status :: 4 - Beta",
-  "Intended Audience :: Developers",
-  "License :: OSI Approved :: MIT License",
-  "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.9",
-  "Programming Language :: Python :: 3.10",
-  "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12",
-  "Programming Language :: Python :: 3.13",
-  "Topic :: Software Development :: Libraries",
-  "Topic :: Internet :: WWW/HTTP"
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Internet :: WWW/HTTP"
 ]
 
 dependencies = [
-  "PyYAML>=6.0.3,<7",
-  "requests>=2.32.5",
+    "PyYAML>=6.0.3,<7",
+    "requests>=2.32.5",
 ]
 
 [project.urls]
@@ -41,7 +41,7 @@ Documentation = "https://salespyforce.readthedocs.io/en/latest/"
 # --------------------------------------------------------------------
 [tool.poetry]
 packages = [
-  { include = "salespyforce", from = "src" }
+    { include = "salespyforce", from = "src" }
 ]
 
 include = ["LICENSE", "README.md"]

{salespyforce-1.4.0.dev1 → salespyforce-1.4.0rc0}/src/salespyforce/api.py

@@ -4,12 +4,13 @@
 :Synopsis:          Defines the basic functions associated with the Salesforce API
 :Created By:        Jeff Shurtliff
 :Last Modified:     Jeff Shurtliff
-:Modified Date:     17 Feb 2023
+:Modified Date:     30 Jan 2026
 """
 
 import requests
 
-from .utils import log_utils
+from . import errors
+from .utils import core_utils, log_utils
 
 # Initialize logging
 logger = log_utils.initialize_logging(__name__)
@@ -19,6 +20,10 @@ def get(sfdc_object, endpoint, params=None, headers=None, timeout=30, show_full_
     """This method performs a GET request against the Salesforce instance.
     (`Reference <https://jereze.com/code/authentification-salesforce-rest-api-python/>`_)
 
+    .. version-changed:: 1.4.0
+       The full URL for the API call is now constructed prior to making the call.
+       The provided URL is also now evaluated to ensure it is a valid Salesforce URL.
+
     :param sfdc_object: The instantiated SalesPyForce object
     :param endpoint: The API endpoint to query
     :type endpoint: str
@@ -40,12 +45,13 @@ def get(sfdc_object, endpoint, params=None, headers=None, timeout=30, show_full_
     default_headers = _get_headers(sfdc_object.access_token)
     headers = default_headers if not headers else headers
 
-    # Make sure the endpoint begins with a slash
-    endpoint = f'/{endpoint}' if not endpoint.startswith('/') else endpoint
+    # Construct the request URL
+    url = _construct_full_query_url(endpoint, sfdc_object.instance_url)
 
     # Perform the API call
-    response = requests.get(f'{sfdc_object.instance_url}{endpoint}', headers=headers, params=params, timeout=timeout)
+    response = requests.get(url, headers=headers, params=params, timeout=timeout)
     if response.status_code >= 300:
+        # TODO: Functionalize this segment and figure out how to improve on the approach somehow
         if show_full_error:
             raise RuntimeError(f'The GET request failed with a {response.status_code} status code.\n'
                                f'{response.text}')
@@ -61,6 +67,10 @@ def api_call_with_payload(sfdc_object, method, endpoint, payload, params=None, h
     """This method performs a POST call against the Salesforce instance.
     (`Reference <https://jereze.com/code/authentification-salesforce-rest-api-python/>`_)
 
+    .. version-changed:: 1.4.0
+       The full URL for the API call is now constructed prior to making the call.
+       The provided URL is also now evaluated to ensure it is a valid Salesforce URL.
+
     :param sfdc_object: The instantiated SalesPyForce object
     :param method: The API method (``post``, ``put``, or ``patch``)
     :type method: str
@@ -86,25 +96,23 @@ def api_call_with_payload(sfdc_object, method, endpoint, payload, params=None, h
     default_headers = _get_headers(sfdc_object.access_token)
     headers = default_headers if not headers else headers
 
-    # Make sure the endpoint begins with a slash
-    endpoint = f'/{endpoint}' if not endpoint.startswith('/') else endpoint
+    # Construct the request URL
+    url = _construct_full_query_url(endpoint, sfdc_object.instance_url)
 
     # Perform the API call
     if method.lower() == 'post':
-        response = requests.post(f'{sfdc_object.instance_url}{endpoint}', json=payload, headers=headers, params=params,
-                                 timeout=timeout)
+        response = requests.post(url, json=payload, headers=headers, params=params, timeout=timeout)
     elif method.lower() == 'patch':
-        response = requests.patch(f'{sfdc_object.instance_url}{endpoint}', json=payload, headers=headers, params=params,
-                                  timeout=timeout)
+        response = requests.patch(url, json=payload, headers=headers, params=params, timeout=timeout)
     elif method.lower() == 'put':
-        response = requests.put(f'{sfdc_object.instance_url}{endpoint}', json=payload, headers=headers, params=params,
-                                timeout=timeout)
+        response = requests.put(url, json=payload, headers=headers, params=params, timeout=timeout)
     else:
-        raise ValueError('The API call method (POST or PATCH OR PUT) must be defined.')
+        raise ValueError('The API call method (POST or PATCH or PUT) must be defined')
 
     # Examine the result
     if response.status_code >= 300:
         if show_full_error:
+            # TODO: Functionalize this segment and figure out how to improve on the approach somehow
             raise RuntimeError(f'The POST request failed with a {response.status_code} status code.\n'
                                f'{response.text}')
         else:
@@ -117,6 +125,49 @@ def api_call_with_payload(sfdc_object, method, endpoint, payload, params=None, h
     return response
 
 
+def delete(sfdc_object, endpoint, params=None, headers=None, timeout=30, show_full_error=True, return_json=True):
+    """This method performs a DELETE request against the Salesforce instance.
+
+    .. version-added:: 1.4.0
+
+    :param sfdc_object: The instantiated SalesPyForce object
+    :param endpoint: The API endpoint to query
+    :type endpoint: str
+    :param params: The query parameters (where applicable)
+    :type params: dict, None
+    :param headers: Specific API headers to use when performing the API call
+    :type headers: dict, None
+    :param timeout: The timeout period in seconds (defaults to ``30``)
+    :type timeout: int, str, None
+    :param show_full_error: Determines if the full error message should be displayed (defaults to ``True``)
+    :type show_full_error: bool
+    :param return_json: Determines if the response should be returned in JSON format (defaults to ``True``)
+    :returns: The API response in JSON format or as a ``requests`` object
+    """
+    # Define the parameters as an empty dictionary if none are provided
+    params = {} if params is None else params
+
+    # Define the headers
+    default_headers = _get_headers(sfdc_object.access_token)
+    headers = default_headers if not headers else headers
+
+    # Construct the request URL
+    url = _construct_full_query_url(endpoint, sfdc_object.instance_url)
+
+    # Perform the API call
+    response = requests.delete(url, headers=headers, params=params, timeout=timeout)
+    if response.status_code >= 300:
+        if show_full_error:
+            # TODO: Functionalize this segment and figure out how to improve on the approach somehow
+            raise RuntimeError(f'The DELETE request failed with a {response.status_code} status code.\n'
+                               f'{response.text}')
+        else:
+            raise RuntimeError(f'The DELETE request failed with a {response.status_code} status code.')
+    if return_json:
+        response = response.json()
+    return response
+
+
 def _get_headers(_access_token, _header_type='default'):
     """This function returns the appropriate HTTP headers to use for different types of API calls."""
     headers = {
@@ -127,3 +178,36 @@ def _get_headers(_access_token, _header_type='default'):
     if _header_type == 'articles':
         headers['accept-language'] = 'en-US'
     return headers
+
+
+def _construct_full_query_url(_endpoint: str, _instance_url: str) -> str:
+    """This function constructs the URL to use in an API call to the Salesforce REST API.
+
+    .. version-added:: 1.4.0
+
+    :param _endpoint: The endpoint provided when calling an API call method or function
+    :type _endpoint: str
+    :param _instance_url: The Salesforce instance URL defined when the core object was instantiated
+    :type _instance_url: str
+    :returns: The fully qualified URL
+    :raises: :py:exc:`TypeError`,
+             :py:exc:`errors.exceptions.InvalidURLError`
+    """
+    # Raise an exception if the endpoint is not a string
+    if not isinstance(_endpoint, str):
+        exc_msg = 'The provided URL must be a string and a valid Salesforce URL'
+        logger.critical(exc_msg)
+        raise TypeError(exc_msg)
+
+    # Construct the URL as needed by prepending the instance URL
+    if _endpoint.startswith('https://'):
+        # Only permit valid Salesforce URLs
+        if not core_utils.is_valid_salesforce_url(_endpoint):
+            raise errors.exceptions.InvalidURLError(url=_endpoint)
+        _url = _endpoint
+    else:
+        _endpoint = f'/{_endpoint}' if not _endpoint.startswith('/') else _endpoint
+        _url = f'{_instance_url}{_endpoint}'
+
+    # Return the constructed URL
+    return _url