Patch dict (#6)

* Refactor dicts

Refactor scan and chunking interface to handle dict with multiple items
instead of list of dicts.

Author: levlaz

CHANGELOG

@@ -3,6 +3,26 @@ Changelog
 
 Here you can see the full list of changes between each Nightfall release.
 
+Version 0.6.0
+-------------
+
+UNRELEASED
+
+- Update scan and chunking interface to handle dict with multiple items 
+  instead of list of dicts.
+
+.. warning::
+    This is a breaking change compared to version 0.5.0, but all users are 
+    reccomended to upgrade to this version. This version represents an
+    improvement on the previous iteration where instead of handling a list of
+    dicts, we now handle a single dict with mulitple entries. This simplifies
+    the library code and makes the interface much more usable.
+
+    The previous version of the SDK required users to pass in a list of dicts. 
+    We now require users to pass in a single dict with multiple entries. 
+    ``nightfall.scan([{'id': 'string}])`` should now be 
+    ``nightfall.scan({'id': 'string'})``.
+
 Version 0.5.0
 -------------
 

README.md

@@ -25,7 +25,7 @@ nightfall = Nightfall(
     os.getenv('NIGHTFALL_CONDITION_SET')
     )
 
-response = nightfall.scan([{'id': 'test string'}])
+response = nightfall.scan({'id': 'test string'})
 
 print(response)
 ```

docs/_sources/quickstart.rst.txt

@@ -29,7 +29,7 @@ Import Nightfall and start using methods:
         os.getenv('NIGHTFALL_CONDITION_SET')
         )
 
-    response = nightfall.scan([{'id': 'test string'}])
+    response = nightfall.scan({'id': 'test string'})
 
     print(response)    
 

docs/api.html

@@ -209,38 +209,36 @@ <h3>nightfall.api<a class="headerlink" href="#nightfall-api" title="Permalink to
 <dl class="py method">
 <dt class="sig sig-object py" id="nightfall.api.Nightfall.make_payloads">
 <span class="sig-name descname"><span class="pre">make_payloads</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nightfall.api.Nightfall.make_payloads" title="Permalink to this definition">¶</a></dt>
-<dd><p>Turn a list of dicts <code class="docutils literal notranslate"><span class="pre">[{'id':</span> <span class="pre">'string'},]</span></code> into a list of
-acceptable payloads.</p>
+<dd><p>Turn a dict into a list of acceptable payloads.</p>
 <p>Creates chunks based on the <code class="docutils literal notranslate"><span class="pre">MAX_PAYLOAD_SIZE</span></code> and <code class="docutils literal notranslate"><span class="pre">MAX_NUM_ITEMS</span></code>
 constants.</p>
-<p>When the number of items in a list is greater than <code class="docutils literal notranslate"><span class="pre">MAX_NUM_ITEMS</span></code>
-we will split the list into multiple lists. When the total sum of all
-strings in a list is greater than <code class="docutils literal notranslate"><span class="pre">MAX_PAYLOAD_SIZE</span></code>, we will split
-that list into multiple lists.</p>
+<p>When the number of items in a dict is greater than <code class="docutils literal notranslate"><span class="pre">MAX_NUM_ITEMS</span></code>
+or total sum of all strings in a dict is greater than 
+<code class="docutils literal notranslate"><span class="pre">MAX_PAYLOAD_SIZE</span></code>, we will split that dict into multiple dicts.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>data</strong> (<em>list</em>) – list of dicts</p>
+<dd class="field-odd"><p><strong>data</strong> (<em>list</em>) – dict in form of <code class="docutils literal notranslate"><span class="pre">{'id':</span> <span class="pre">'string',}</span></code></p>
 </dd>
 <dt class="field-even">Raises</dt>
 <dd class="field-even"><p><a class="reference internal" href="#nightfall.exceptions.InputError" title="nightfall.exceptions.InputError"><strong>InputError</strong></a> – when individual dictionary item is larger than
 <code class="docutils literal notranslate"><span class="pre">MAX_PAYLOAD_SIZE</span></code></p>
 </dd>
 <dt class="field-odd">Returns</dt>
-<dd class="field-odd"><p>list of list of dicts to scan</p>
+<dd class="field-odd"><p>list of dicts to scan</p>
 </dd>
 </dl>
 </dd></dl>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="nightfall.api.Nightfall.scan">
 <span class="sig-name descname"><span class="pre">scan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#nightfall.api.Nightfall.scan" title="Permalink to this definition">¶</a></dt>
-<dd><p>Scan lists of data with Nightfall.</p>
-<p>This method will convert the list of dicts into chunks if necessary
+<dd><p>Scan data with Nightfall.</p>
+<p>This method will convert a dict into chunks if necessary
 and then makes one or more requests to the Nightfall API to scan the
 data.</p>
 <p>data dicts should be in the following format:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
-    <span class="s2">&quot;id123&quot;</span><span class="p">:</span> <span class="s2">&quot;string_to_scan&quot;</span>
+    <span class="s2">&quot;id123&quot;</span><span class="p">:</span> <span class="s2">&quot;string_to_scan&quot;</span><span class="p">,</span>
 <span class="p">}</span>
 </pre></div>
 </div>
@@ -249,16 +247,16 @@ <h3>nightfall.api<a class="headerlink" href="#nightfall-api" title="Permalink to
 and is not considered sensitive.</p>
 <p>response dicts are in the form of:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
-    <span class="s2">&quot;id123&quot;</span><span class="p">:</span> <span class="p">[{</span><span class="n">nightfall_findings</span><span class="p">},]</span> <span class="ow">or</span> <span class="kc">None</span>
+    <span class="s2">&quot;id123&quot;</span><span class="p">:</span> <span class="p">[{</span><span class="n">nightfall_findings</span><span class="p">},]</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">,</span>
 <span class="p">}</span>
 </pre></div>
 </div>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>data</strong> (<em>list</em>) – list of dicts to scan.</p>
+<dd class="field-odd"><p><strong>data</strong> (<em>dict</em>) – dict to scan.</p>
 </dd>
 <dt class="field-even">Returns</dt>
-<dd class="field-even"><p>list of list of dicts for items in payload.</p>
+<dd class="field-even"><p>dict with findings.</p>
 </dd>
 </dl>
 </dd></dl>

docs/changelog.html

@@ -94,6 +94,7 @@
 </ul>
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#version-0-6-0">Version 0.6.0</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-0-5-0">Version 0.5.0</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-0-4-0">Version 0.4.0</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#version-0-3-0">Version 0.3.0</a></li>
@@ -170,6 +171,26 @@
   <div class="section" id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
 <p>Here you can see the full list of changes between each Nightfall release.</p>
+<div class="section" id="version-0-6-0">
+<h2>Version 0.6.0<a class="headerlink" href="#version-0-6-0" title="Permalink to this headline">¶</a></h2>
+<p>UNRELEASED</p>
+<ul class="simple">
+<li><p>Update scan and chunking interface to handle dict with multiple items
+instead of list of dicts.</p></li>
+</ul>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>This is a breaking change compared to version 0.5.0, but all users are
+reccomended to upgrade to this version. This version represents an
+improvement on the previous iteration where instead of handling a list of
+dicts, we now handle a single dict with mulitple entries. This simplifies
+the library code and makes the interface much more usable.</p>
+<p>The previous version of the SDK required users to pass in a list of dicts.
+We now require users to pass in a single dict with multiple entries.
+<code class="docutils literal notranslate"><span class="pre">nightfall.scan([{'id':</span> <span class="pre">'string}])</span></code> should now be
+<code class="docutils literal notranslate"><span class="pre">nightfall.scan({'id':</span> <span class="pre">'string'})</span></code>.</p>
+</div>
+</div>
 <div class="section" id="version-0-5-0">
 <h2>Version 0.5.0<a class="headerlink" href="#version-0-5-0" title="Permalink to this headline">¶</a></h2>
 <p>Released on July 12, 2021</p>

docs/index.html

@@ -196,6 +196,7 @@ <h2>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-6-0">Version 0.6.0</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-5-0">Version 0.5.0</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-4-0">Version 0.4.0</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-3-0">Version 0.3.0</a></li>

docs/quickstart.html

@@ -191,7 +191,7 @@ <h2>Basic Usage<a class="headerlink" href="#basic-usage" title="Permalink to thi
     <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s1">&#39;NIGHTFALL_CONDITION_SET&#39;</span><span class="p">)</span>
     <span class="p">)</span>
 
-<span class="n">response</span> <span class="o">=</span> <span class="n">nightfall</span><span class="o">.</span><span class="n">scan</span><span class="p">([{</span><span class="s1">&#39;id&#39;</span><span class="p">:</span> <span class="s1">&#39;test string&#39;</span><span class="p">}])</span>
+<span class="n">response</span> <span class="o">=</span> <span class="n">nightfall</span><span class="o">.</span><span class="n">scan</span><span class="p">({</span><span class="s1">&#39;id&#39;</span><span class="p">:</span> <span class="s1">&#39;test string&#39;</span><span class="p">})</span>
 
 <span class="nb">print</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
 </pre></div>

docs/searchindex.js

@@ -29,7 +29,7 @@ Import Nightfall and start using methods:
         os.getenv('NIGHTFALL_CONDITION_SET')
         )
 
-    response = nightfall.scan([{'id': 'test string'}])
+    response = nightfall.scan({'id': 'test string'})
 
     print(response)