refactor: unify controller responses (#101)

* Remove status, use the HTTP status code included in Flask.Response object * Update doc
tripledes · Dec 27, 2019 · 5aeb030 · 5aeb030
1 parent c2c70b6
commit 5aeb030
Show file tree

Hide file tree

Showing 9 changed files with 100 additions and 85 deletions.
diff --git a/doc/build/doctrees/application.doctree b/doc/build/doctrees/application.doctree
diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle
diff --git a/doc/build/doctrees/infrastructure.doctree b/doc/build/doctrees/infrastructure.doctree
diff --git a/doc/build/html/application.html b/doc/build/html/application.html
@@ -360,14 +360,11 @@ <h2>Raid<a class="headerlink" href="#raid" title="Permalink to this headline">¶
 </dl>
 <dl class="method">
 <dt id="thesheriff.application.raid.end_raid.EndRaid.execute">
-<code class="sig-name descname">execute</code><span class="sig-paren">(</span><em class="sig-param">raid_id: int</em>, <em class="sig-param">raid_score: float</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.raid.end_raid.EndRaid.execute" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname">execute</code><span class="sig-paren">(</span><em class="sig-param">request: thesheriff.application.raid.request.end_raid_request.EndRaidRequest</em><span class="sig-paren">)</span><a class="headerlink" href="#thesheriff.application.raid.end_raid.EndRaid.execute" title="Permalink to this definition">¶</a></dt>
 <dd><p>execute is the actual action of the End a Raid use case.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>raid_id</strong> (<em>Integer</em>) – ID of the Raid to be end.</p></li>
-<li><p><strong>raid_score</strong> (<em>Float</em>) – Score assigned to the Raid.</p></li>
-</ul>
+<dd class="field-odd"><p><strong>request</strong> (<em>EndRaidRequest</em>) – Request holding the Raid details to be ended.</p>
 </dd>
 <dt class="field-even">Returns</dt>
 <dd class="field-even"><p>Message with scores.</p>

diff --git a/doc/build/html/infrastructure.html b/doc/build/html/infrastructure.html
@@ -68,7 +68,7 @@ <h3>thesheriff.infrastructure.controllers.gang_controller<a class="headerlink" h
 </div>
 <p><strong>Response Example:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
-    <span class="nt">&quot;status&quot;</span><span class="p">:</span> <span class="mi">200</span><span class="p">,</span>
+    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Success&quot;</span><span class="p">,</span>
     <span class="nt">&quot;gangs&quot;</span><span class="p">:</span> <span class="p">{</span>
         <span class="nt">&quot;gang1&quot;</span><span class="p">:</span> <span class="p">{},</span>
         <span class="nt">&quot;gang2&quot;</span><span class="p">:</span> <span class="p">{}</span>
@@ -86,8 +86,8 @@ <h3>thesheriff.infrastructure.controllers.gang_controller<a class="headerlink" h
 </div>
 <p><strong>Response Example:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
-    <span class="nt">&quot;status&quot;</span><span class="p">:</span> <span class="mi">201</span><span class="p">,</span>
-    <span class="nt">&quot;gang&quot;</span><span class="p">:</span> <span class="p">{}</span>
+  <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Gang successfully created&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;gang&quot;</span><span class="p">:</span> <span class="p">{}</span>
 <span class="p">}</span>
 </pre></div>
 </div>
@@ -101,8 +101,7 @@ <h3>thesheriff.infrastructure.controllers.gang_controller<a class="headerlink" h
 </div>
 <p><strong>Response Example:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
-    <span class="nt">&quot;status&quot;</span><span class="p">:</span> <span class="mi">204</span><span class="p">,</span>
-    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Gang updated&quot;</span>
+    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Joined Gang successfully&quot;</span>
 <span class="p">}</span>
 </pre></div>
 </div>
@@ -145,8 +144,12 @@ <h3>thesheriff.infrastructure.controllers.outlaw_controller<a class="headerlink"
 </div>
 <p><strong>Response Example:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
-    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Outlaw added successfully&quot;</span><span class="p">,</span>
-    <span class="nt">&quot;status&quot;</span><span class="p">:</span> <span class="mi">201</span>
+    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Outlaw created successfully&quot;</span><span class="p">,</span>
+    <span class="nt">&quot;outlaw&quot;</span><span class="p">:</span> <span class="p">{</span>
+        <span class="nt">&quot;id&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+        <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;outlaw 1&quot;</span><span class="p">,</span>
+        <span class="nt">&quot;email&quot;</span><span class="p">:</span> <span class="s2">&quot;outlaw1@domain.net&quot;</span>
+    <span class="p">}</span>
 <span class="p">}</span>
 </pre></div>
 </div>
@@ -158,11 +161,19 @@ <h3>thesheriff.infrastructure.controllers.outlaw_controller<a class="headerlink"
 </div>
 <p><strong>Response Example:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
-    <span class="nt">&quot;status&quot;</span><span class="p">:</span> <span class="mi">200</span><span class="p">,</span>
-    <span class="nt">&quot;friends&quot;</span><span class="p">:</span> <span class="p">{</span>
-        <span class="nt">&quot;friend1&quot;</span><span class="p">:</span> <span class="p">{},</span>
-        <span class="nt">&quot;friend2&quot;</span><span class="p">:</span> <span class="p">{}</span>
-    <span class="p">}</span>
+    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Success&quot;</span><span class="p">,</span>
+    <span class="nt">&quot;friends&quot;</span><span class="p">:</span> <span class="p">[</span>
+        <span class="p">{</span>
+            <span class="nt">&quot;id&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+            <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;Outlaw1&quot;</span><span class="p">,</span>
+            <span class="nt">&quot;email&quot;</span><span class="p">:</span> <span class="s2">&quot;outlaw1@domain.net&quot;</span>
+        <span class="p">},</span>
+        <span class="p">{</span>
+            <span class="nt">&quot;id&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+            <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;Outlaw2&quot;</span><span class="p">,</span>
+            <span class="nt">&quot;email&quot;</span><span class="p">:</span> <span class="s2">&quot;outlaw2@domain.net&quot;</span>
+       <span class="p">}</span>
+    <span class="p">]</span>
 <span class="p">}</span>
 </pre></div>
 </div>
@@ -174,11 +185,11 @@ <h3>thesheriff.infrastructure.controllers.outlaw_controller<a class="headerlink"
 </div>
 <p><strong>Response Example:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
-    <span class="nt">&quot;status&quot;</span><span class="p">:</span> <span class="mi">200</span><span class="p">,</span>
-    <span class="nt">&quot;gangs&quot;</span><span class="p">:</span> <span class="p">{</span>
-        <span class="nt">&quot;gang1&quot;</span><span class="p">:</span> <span class="p">{},</span>
-        <span class="nt">&quot;gang2&quot;</span><span class="p">:</span> <span class="p">{}</span>
-    <span class="p">}</span>
+    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Success&quot;</span><span class="p">,</span>
+    <span class="nt">&quot;gangs&quot;</span><span class="p">:</span> <span class="p">[</span>
+        <span class="p">{</span><span class="nt">&quot;id&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;The Band 1&quot;</span><span class="p">},</span>
+        <span class="p">{</span><span class="nt">&quot;id&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;The Band 2&quot;</span><span class="p">}</span>
+    <span class="p">]</span>
 <span class="p">}</span>
 </pre></div>
 </div>
@@ -192,8 +203,7 @@ <h3>thesheriff.infrastructure.controllers.outlaw_controller<a class="headerlink"
 </div>
 <p><strong>Response Example:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
-    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Invitation sent&quot;</span><span class="p">,</span>
-    <span class="nt">&quot;status&quot;</span><span class="p">:</span> <span class="mi">201</span>
+    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Invitation sent successfully&quot;</span>
 <span class="p">}</span>
 </pre></div>
 </div>
@@ -234,8 +244,8 @@ <h3>thesheriff.infrastructure.controllers.raid_controller<a class="headerlink" h
 </div>
 <p><strong>Response Example:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
-    <span class="nt">&quot;status&quot;</span><span class="p">:</span> <span class="mi">201</span><span class="p">,</span>
-    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Raid added successfully&quot;</span>
+    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Raid created successfully&quot;</span><span class="p">,</span>
+    <span class="nt">&quot;raid&quot;</span><span class="p">:</span> <span class="p">{}</span>
 <span class="p">}</span>
 </pre></div>
 </div>
@@ -249,8 +259,7 @@ <h3>thesheriff.infrastructure.controllers.raid_controller<a class="headerlink" h
 </div>
 <p><strong>Response Example:</strong></p>
 <div class="highlight-json notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
-    <span class="nt">&quot;status&quot;</span><span class="p">:</span> <span class="mi">204</span><span class="p">,</span>
-    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;raid rated successfully&quot;</span>
+    <span class="nt">&quot;message&quot;</span><span class="p">:</span> <span class="s2">&quot;Raid rated successfully&quot;</span>
 <span class="p">}</span>
 </pre></div>
 </div>