sfq 0.0.3__py3-none-any.whl → 0.0.5__py3-none-any.whl

sfq/__init__.py

@@ -5,7 +5,7 @@ import os
 import json
 from urllib.parse import urlparse, quote
 
-logging.basicConfig(level=logging.INFO)
+logging.basicConfig(level=logging.INFO, format='[sfq:%(lineno)d - %(levelname)s] %(message)s')
 
 class SFAuth:
     def __init__(
@@ -108,7 +108,7 @@ class SFAuth:
         """Automatically refresh the token if it has expired or is missing."""
         _token_expiration = self._is_token_expired()
         if self.access_token and not _token_expiration:
-            return
+            return self.access_token
         
         if not self.access_token:
             logging.debug("No access token available. Requesting a new one.")
@@ -123,6 +123,7 @@ class SFAuth:
             logging.debug("Access token refreshed successfully.")
         else:
             logging.error("Failed to refresh access token.")
+        return self.access_token
 
 
     def _is_token_expired(self):
@@ -130,7 +131,7 @@ class SFAuth:
         try:
             return time.time() >= float(self.token_expiration_time)
         except (TypeError, ValueError):
-            return False
+            return True
 
     def query(self, query, tooling=False):
         """Query Salesforce using SOQL or Tooling API, depending on the `tooling` parameter."""

sfq/__main__.py

@@ -0,0 +1,153 @@
+import difflib
+import http.client
+import json
+
+from sfq import SFAuth
+
+from prompt_toolkit import prompt
+from prompt_toolkit.completion import Completer, Completion
+
+def _interactive_shell(sf: SFAuth, dry_run: bool, disable_fuzzy_completion: bool):
+    """Runs an interactive REPL for querying Salesforce data with real-time autocompletion."""
+
+    sobject = None
+    fields = None
+
+    class DynamicSeparatorCompleter(Completer):
+        """Custom completer that adapts to different separators."""
+        
+        def __init__(self, words: list[str], separators: list[str] = [","]):
+            self.words = words
+            self.separators = separators
+
+        def get_completions(self, document, complete_event):
+            text_before_cursor = document.text_before_cursor
+            
+            for separator in self.separators:
+                if separator in text_before_cursor:
+                    last_token = text_before_cursor.split(separator)[-1].strip()
+                    break
+            else:
+                last_token = text_before_cursor.strip()
+
+
+            matches_difflib = difflib.get_close_matches(last_token, self.words, n=20, cutoff=0.6)
+            matches_starting = [word for word in self.words if word.lower().startswith(last_token.lower())]
+
+            if not disable_fuzzy_completion and (len(last_token) > 6 or not(matches_starting)):
+                matches = matches_difflib
+            else:
+                matches = matches_starting
+
+            for word in matches:
+                yield Completion(word, start_position=-len(last_token))
+                
+    def _get_objects(sf: SFAuth):
+        """Retrieve available Salesforce objects."""
+        host = sf.instance_url.split("://")[1].split("/")[0]
+        conn = http.client.HTTPSConnection(host)
+        uri = f"/services/data/{sf.api_version}/sobjects/"
+        token = sf._refresh_token_if_needed()
+        headers = {'Authorization': f'Bearer {token}'}
+        print(f'token: {token}')
+        conn.request("GET", uri, headers=headers)
+        response = conn.getresponse()
+        
+        if response.status != 200:
+            print(f'Error: {response.status} {response.reason}')
+            return []
+        
+        data = json.loads(response.read())
+        return [sobject['name'] for sobject in data['sobjects']]
+
+    def _get_fields(sobject: str, sf: SFAuth):
+        """Retrieve available fields for a given Salesforce object."""
+        host = sf.instance_url.split("://")[1].split("/")[0]
+        conn = http.client.HTTPSConnection(host)
+        uri = f"/services/data/{sf.api_version}/sobjects/{sobject}/describe/"
+        headers = {'Authorization': f'Bearer {sf._refresh_token_if_needed()}'}
+        conn.request("GET", uri, headers=headers)
+        response = conn.getresponse()
+        
+        if response.status != 200:
+            print(f'Error: {response.status} {response.reason}')
+            raise ValueError(f'Unable to fetch fields for sObject "{sobject}": {response.status}, {response.reason}')
+        
+        data = json.loads(response.read())
+        return [f['name'] for f in data['fields']]
+
+    available_objects = _get_objects(sf)
+    
+    object_completer = DynamicSeparatorCompleter(available_objects)
+    while not sobject:
+        sobject = prompt('FROM ', completer=object_completer).strip()
+
+
+    available_fields = _get_fields(sobject, sf)
+    field_completer = DynamicSeparatorCompleter(available_fields, separators=[","])
+    while not fields:
+        fields = prompt('SELECT ', completer=field_completer).strip()
+
+    where_completer = DynamicSeparatorCompleter(available_fields, separators=[" AND ", " OR "])
+    where = prompt("WHERE ", completer=where_completer).strip()
+    where_clause = f"WHERE {where}" if where else ""
+    
+    limit = prompt("LIMIT ", default="200").strip()
+    limit_clause = f"LIMIT {limit}" if limit else ""
+    
+    query = f"SELECT {fields} FROM {sobject} {where_clause} {limit_clause}".replace('  ', ' ')
+    
+    if dry_run:
+        print('\nDry-run, skipping execution...')
+        print(f'\nQuery: {query}\n')
+        return query
+    
+    print('\nExecuting query...\n')
+    data = sf.query(query)
+    print(json.dumps(data, indent=4))
+    print(f'\nQuery: {query}\n')
+    return data
+
+if __name__ == "__main__":
+    import argparse
+    import os
+
+    parser = argparse.ArgumentParser(
+        description='Interactively query Salesforce data with real-time autocompletion.'
+    )
+    parser.add_argument(
+        '-a', '--sfdxAuthUrl', type=str, help='Salesforce auth url', default=os.environ.get('SFDX_AUTH_URL')
+    )
+    parser.add_argument(
+        '--dry-run', action='store_true', help='Print the query without executing it', default=str(os.environ.get('SFQ_DRY_RUN')),
+    )
+    parser.add_argument(
+        '--disable-fuzzy-completion', action='store_true', help='Disable fuzzy completion', default=str(os.environ.get('SFQ_DISABLE_FUZZY_COMPLETION')),
+    )
+    args = parser.parse_args()
+
+    if not args.sfdxAuthUrl:
+        raise ValueError('SFDX_AUTH_URL environment variable is not set nor provided as an argument')
+    
+    try:
+        if args.dry_run.lower() not in ['true', '1']:
+            args.dry_run = False
+    except AttributeError:
+        pass
+
+    try:
+        if args.disable_fuzzy_completion.lower() not in ['true', '1']:
+            args.disable_fuzzy_completion = False
+    except AttributeError:
+        pass
+
+
+    _interactive_shell(
+        SFAuth(
+            instance_url=f"https://{str(args.sfdxAuthUrl).split('@')[1]}",
+            client_id=str(args.sfdxAuthUrl).split('//')[1].split('::')[0],
+            refresh_token=str(args.sfdxAuthUrl).split('::')[1].split('@')[0],
+        ),
+        args.dry_run,
+        args.disable_fuzzy_completion
+    )

{sfq-0.0.3.dist-info → sfq-0.0.5.dist-info}/METADATA

@@ -1,17 +1,20 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.1
 Name: sfq
-Version: 0.0.3
+Version: 0.0.5
 Summary: Python wrapper for the Salesforce's Query API.
 Author-email: David Moruzzi <sfq.pypi@dmoruzi.com>
 Keywords: salesforce,salesforce query
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Requires-Python: >=3.7
+Requires-Dist: prompt-toolkit>=3.0.3
 Description-Content-Type: text/markdown
 
 # sfq (Salesforce Query)
@@ -36,7 +39,25 @@ pip install sfq
 
 ## Usage
 
-### Querying Salesforce Data
+### Interactive Querying 
+
+```powershell
+usage: python -m sfq [-a SFDXAUTHURL] [--dry-run] [--disable-fuzzy-completion]
+
+Interactively query Salesforce data with real-time autocompletion.
+
+options:
+  -h, --help            show this help message and exit
+  -a, --sfdxAuthUrl SFDXAUTHURL
+                        Salesforce auth url
+  --dry-run             Print the query without executing it
+  --disable-fuzzy-completion
+                        Disable fuzzy completion
+```
+
+You can run the `sfq` library in interactive mode by passing the `-a` option with the `SFDX_AUTH_URL` argument or by setting the `SFDX_AUTH_URL` environment variable.
+
+### Library Querying
 
 ```python
 from sfq import SFAuth
@@ -55,7 +76,7 @@ print(sf.query("SELECT Id FROM Account LIMIT 5"))
 print(sf.query("SELECT Id, FullName, Metadata FROM SandboxSettings LIMIT 5", tooling=True))
 ```
 
-### Querying from Bash
+### Bash Querying 
 
 You can easily incorporate this into ad-hoc bash scripts or commands:
 
@@ -128,4 +149,4 @@ To use the `sfq` library, you'll need a **client ID** and **refresh token**. The
 ## Notes
 
 - **Authentication**: Make sure your refresh token is kept secure, as it grants access to your Salesforce instance.
-- **Tooling API**: You can set the `tooling=True` argument in the `query` method to access the Salesforce Tooling API for more advanced metadata queries.
+- **Tooling API**: You can set the `tooling=True` argument in the `query` method to access the Salesforce Tooling API for more advanced metadata queries. This is limited to library usage only.

sfq-0.0.5.dist-info/RECORD

@@ -0,0 +1,6 @@
+sfq/__init__.py,sha256=sIZr8eUzWV9q2PEenbCnu4mRBmv07FC7zjfpcjux_1g,6466
+sfq/__main__.py,sha256=CqwwG2l6ZphmiOSeqQeB7W73hTlGKJRDYtlKLkM7Bps,5779
+sfq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sfq-0.0.5.dist-info/METADATA,sha256=1f9a_TSpoLzcyMbqRrxwVyCqE5vj_WCivEg6uxNiNxQ,5491
+sfq-0.0.5.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
+sfq-0.0.5.dist-info/RECORD,,

{sfq-0.0.3.dist-info → sfq-0.0.5.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.17.1
 Root-Is-Purelib: true
 Tag: py3-none-any

sfq-0.0.3.dist-info/RECORD

@@ -1,5 +0,0 @@
-sfq/__init__.py,sha256=vcAXd4v6uyjzAqOril31LG2WG2n3l6OHxPiYQA63uD4,6361
-sfq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sfq-0.0.3.dist-info/METADATA,sha256=y5Ir5XtomFESBbaktjuWzsA2d0Q40qlMIBXx1igISU4,4685
-sfq-0.0.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sfq-0.0.3.dist-info/RECORD,,