Merge pull request #138 from PagerDuty/v5.3.0-support-numeric-filtering

V5.3.0: Add support for finding based on numeric fields
PagerDuty · Oct 4, 2024 · f414884 · f414884
2 parents f0cdd6a + 5c0858e
commit f414884
Show file tree

Hide file tree

Showing 14 changed files with 41 additions and 17 deletions.
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '5.2.0',
+    VERSION: '5.3.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/changelog.html b/docs/changelog.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Changelog &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
+    <title>Changelog &#8212; PagerDuty Python REST API Sessions 5.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/contributing.html b/docs/contributing.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Contribution Guide &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
+    <title>Contribution Guide &#8212; PagerDuty Python REST API Sessions 5.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
+    <title>Index &#8212; PagerDuty Python REST API Sessions 5.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/index.html b/docs/index.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>PDPYRAS: PagerDuty Python REST API Sessions &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
+    <title>PDPYRAS: PagerDuty Python REST API Sessions &#8212; PagerDuty Python REST API Sessions 5.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/module_reference.html b/docs/module_reference.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>Module Reference &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
+    <title>Module Reference &#8212; PagerDuty Python REST API Sessions 5.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -392,6 +392,15 @@ <h2>API Client Classes<a class="headerlink" href="#api-client-classes" title="Pe
 constrained to those matching the query, and so every result in the
 index will be downloaded and compared against the query up until a
 matching result is found or all results have been checked.</p>
+<p>The comparison between the query and matching results is case-insenitive. When
+determining uniqueness, APIs are mostly case-insensitive, and therefore objects
+with similar characters but differing case can’t even exist. All results (and
+the search query) are for this reason reduced pre-comparison to a common form
+(all-lowercase strings) so that case doesn’t need to match in the query argument
+(which is also interpreted by the API as case-insensitive).</p>
+<p>If said behavior differs for a given API, i.e. the uniqueness constraint on a
+field is case-sensitive, it should still return the correct results because the
+search term sent to the index in the querystring is not lower-cased.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Python Module Index &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
+    <title>Python Module Index &#8212; PagerDuty Python REST API Sessions 5.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/docs/search.html b/docs/search.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
+    <title>Search &#8212; PagerDuty Python REST API Sessions 5.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
 

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/user_guide.html b/docs/user_guide.html
@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
-    <title>User Guide &#8212; PagerDuty Python REST API Sessions 5.2.0 documentation</title>
+    <title>User Guide &#8212; PagerDuty Python REST API Sessions 5.3.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

diff --git a/pdpyras.py b/pdpyras.py
@@ -20,7 +20,7 @@
 from urllib3.exceptions import HTTPError, PoolError
 from requests.exceptions import RequestException
 
-__version__ = '5.2.0'
+__version__ = '5.3.0'
 
 #######################
 ### CLIENT DEFAULTS ###
@@ -1687,6 +1687,17 @@ def find(self, resource, query, attribute='name', params=None) \
         index will be downloaded and compared against the query up until a
         matching result is found or all results have been checked.
 
+        The comparison between the query and matching results is case-insenitive. When
+        determining uniqueness, APIs are mostly case-insensitive, and therefore objects
+        with similar characters but differing case can't even exist. All results (and
+        the search query) are for this reason reduced pre-comparison to a common form
+        (all-lowercase strings) so that case doesn't need to match in the query argument
+        (which is also interpreted by the API as case-insensitive).
+
+        If said behavior differs for a given API, i.e. the uniqueness constraint on a
+        field is case-sensitive, it should still return the correct results because the
+        search term sent to the index in the querystring is not lower-cased.
+
         :param resource:
             The name of the resource endpoint to query, i.e.
             ``escalation_policies``
@@ -1710,8 +1721,7 @@ def find(self, resource, query, attribute='name', params=None) \
         if params is not None:
             query_params.update(params)
         query_params.update({'query':query})
-        # When determining uniqueness, web/the API is largely case-insensitive:
-        simplify = lambda s: s.lower()
+        simplify = lambda s: str(s).lower()
         search_term = simplify(query)
         equiv = lambda s: simplify(s[attribute]) == search_term
         obj_iter = self.iter_all(resource, params=query_params)

diff --git a/setup.py b/setup.py
@@ -1,6 +1,6 @@
 from setuptools import setup
 
-__version__ = '5.2.0'
+__version__ = '5.3.0'
 
 if __name__ == '__main__':
     setup(

diff --git a/test_pdpyras.py b/test_pdpyras.py
@@ -464,15 +464,20 @@ def test_print_debug(self):
     def test_find(self, iter_all):
         sess = pdpyras.APISession('token')
         iter_all.return_value = iter([
-            {'type':'user', 'name': 'Someone Else', 'email':'[email protected]'},
-            {'type':'user', 'name': 'Space Person', 'email':'[email protected] '},
-            {'type':'user', 'name': 'Someone Personson', 'email':'[email protected]'},
+            {'type':'user', 'name': 'Someone Else', 'email':'[email protected]', 'f':1},
+            {'type':'user', 'name': 'Space Person', 'email':'[email protected] ', 'f':2},
+            {'type':'user', 'name': 'Someone Personson', 'email':'[email protected]', 'f':3},
+            {'type':'user', 'name': 'Numeric Fields', 'email': '[email protected]', 'f':5}
         ])
         self.assertEqual(
             'Someone Personson',
             sess.find('users', '[email protected]', attribute='email')['name']
         )
         iter_all.assert_called_with('users', params={'query':'[email protected]'})
+        self.assertEqual(
+            'Numeric Fields',
+            sess.find('users', 5, attribute='f')['name']
+        )
 
     @patch.object(pdpyras.APISession, 'iter_cursor')
     @patch.object(pdpyras.APISession, 'get')