Fix #87 -- Add HTTP message sequence diagram (#88)

codingjoe · web-flow · commit 244113045de0 · 2018-10-19T16:42:47.000+02:00
diff --git a/Makefile b/Makefile
@@ -0,0 +1,2 @@
+http-message-flow.svg: http-message-flow.sequence
+	diagrams sequence http-message-flow.sequence http-message-flow.svg
diff --git a/README.rst b/README.rst
@@ -17,6 +17,11 @@ Features
 -  easy integration
 -  works just like the built-in
 
+For the Nerds
+-------------
+
+.. image:: http-message-flow.svg
+
 Installation
 ------------
 
diff --git a/http-message-flow.sequence b/http-message-flow.sequence
@@ -0,0 +1,8 @@
+Client->AWS S3:POST large file
+AWS S3->Client:RESPONSE AWS S3 key
+Client->S3FileMiddleware:POST AWS S3 key
+S3FileMiddleware->AWS S3:GET AWS S3 key
+AWS S3->S3FileMiddleware:RESPONSE large file
+S3FileMiddleware->DjangoView:request incl. large file
+DjangoView->Client:RESPONSE success
+
diff --git a/http-message-flow.svg b/http-message-flow.svg
@@ -0,0 +1 @@
+<svg height="403.75" version="1.1" width="792.09375" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="overflow: hidden; position: relative;"><desc style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">Created with RaphaÃ«l 2.1.4</desc><defs style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"><path stroke-linecap="round" d="M5,0 0,2.5 5,5z" id="raphael-marker-block" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path><marker id="raphael-marker-endblock55-obj41" markerHeight="5" markerWidth="5" orient="auto" refX="2.5" refY="2.5" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#raphael-marker-block" transform="rotate(180 2.5 2.5) scale(1,1)" stroke-width="1.0000" fill="#000000" stroke="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></use></marker><marker id="raphael-marker-endblock55-obj44" markerHeight="5" markerWidth="5" orient="auto" refX="2.5" refY="2.5" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#raphael-marker-block" transform="rotate(180 2.5 2.5) scale(1,1)" stroke-width="1.0000" fill="#000000" stroke="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></use></marker><marker id="raphael-marker-endblock55-obj47" markerHeight="5" markerWidth="5" orient="auto" refX="2.5" refY="2.5" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#raphael-marker-block" transform="rotate(180 2.5 2.5) scale(1,1)" stroke-width="1.0000" fill="#000000" stroke="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></use></marker><marker id="raphael-marker-endblock55-obj50" markerHeight="5" markerWidth="5" orient="auto" refX="2.5" refY="2.5" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#raphael-marker-block" transform="rotate(180 2.5 2.5) scale(1,1)" stroke-width="1.0000" fill="#000000" stroke="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></use></marker><marker id="raphael-marker-endblock55-obj53" markerHeight="5" markerWidth="5" orient="auto" refX="2.5" refY="2.5" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#raphael-marker-block" transform="rotate(180 2.5 2.5) scale(1,1)" stroke-width="1.0000" fill="#000000" stroke="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></use></marker><marker id="raphael-marker-endblock55-obj56" markerHeight="5" markerWidth="5" orient="auto" refX="2.5" refY="2.5" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#raphael-marker-block" transform="rotate(180 2.5 2.5) scale(1,1)" stroke-width="1.0000" fill="#000000" stroke="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></use></marker><marker id="raphael-marker-endblock55-obj59" markerHeight="5" markerWidth="5" orient="auto" refX="2.5" refY="2.5" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"><use xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#raphael-marker-block" transform="rotate(180 2.5 2.5) scale(1,1)" stroke-width="1.0000" fill="#000000" stroke="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></use></marker></defs><rect x="10" y="20" width="77.609375" height="38.21875" rx="0" ry="0" fill="#ffffff" stroke="#000000" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></rect><text x="19.9921875" y="39.109375" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="6" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">Client</tspan></text><rect x="10" y="345.53125" width="77.609375" height="38.21875" rx="0" ry="0" fill="#ffffff" stroke="#000000" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></rect><text x="19.9921875" y="364.640625" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="6" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">Client</tspan></text><path fill="none" stroke="#000000" d="M48.8046875,58.21875L48.8046875,345.53125" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path><rect x="212.421875" y="20" width="77.609375" height="38.21875" rx="0" ry="0" fill="#ffffff" stroke="#000000" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></rect><text x="222.4140625" y="39.109375" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="6" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">AWS S3</tspan></text><rect x="212.421875" y="345.53125" width="77.609375" height="38.21875" rx="0" ry="0" fill="#ffffff" stroke="#000000" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></rect><text x="222.4140625" y="364.640625" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="6" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">AWS S3</tspan></text><path fill="none" stroke="#000000" d="M251.2265625,58.21875L251.2265625,345.53125" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path><rect x="366.8359375" y="20" width="173.625" height="38.21875" rx="0" ry="0" fill="#ffffff" stroke="#000000" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></rect><text x="376.8359375" y="39.109375" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="6" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">S3FileMiddleware</tspan></text><rect x="366.8359375" y="345.53125" width="173.625" height="38.21875" rx="0" ry="0" fill="#ffffff" stroke="#000000" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></rect><text x="376.8359375" y="364.640625" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="6" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">S3FileMiddleware</tspan></text><path fill="none" stroke="#000000" d="M453.6484375,58.21875L453.6484375,345.53125" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path><rect x="646.078125" y="20" width="116.015625" height="38.21875" rx="0" ry="0" fill="#ffffff" stroke="#000000" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></rect><text x="656.0703125" y="39.109375" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="5.890625" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">DjangoView</tspan></text><rect x="646.078125" y="345.53125" width="116.015625" height="38.21875" rx="0" ry="0" fill="#ffffff" stroke="#000000" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></rect><text x="656.0703125" y="364.640625" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="5.890625" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">DjangoView</tspan></text><path fill="none" stroke="#000000" d="M704.0859375,58.21875L704.0859375,345.53125" stroke-width="2" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path><text x="78" y="83.21875" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="5.890625" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">POST large file</tspan></text><path fill="none" stroke="#000000" d="M48.8046875,96.4375C48.8046875,96.4375,215.0515594482422,96.4375,246.2228479385376,96.4375" stroke-width="2" marker-end="url(#raphael-marker-endblock55-obj41)" stroke-dasharray="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path><text x="58.796875" y="121.4375" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="5.890625" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">RESPONSE AWS S3 key</tspan></text><path fill="none" stroke="#000000" d="M251.2265625,134.65625C251.2265625,134.65625,84.97969055175781,134.65625,53.8084020614624,134.65625" stroke-width="2" marker-end="url(#raphael-marker-endblock55-obj44)" stroke-dasharray="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path><text x="179.2109375" y="159.65625" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="5.890625" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">POST AWS S3 key</tspan></text><path fill="none" stroke="#000000" d="M48.8046875,172.875C48.8046875,172.875,402.2192718144506,172.875,448.6394491487217,172.875" stroke-width="2" marker-end="url(#raphael-marker-endblock55-obj47)" stroke-dasharray="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path><text x="285.21875" y="197.875" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="5.890625" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">GET AWS S3 key</tspan></text><path fill="none" stroke="#000000" d="M453.6484375,211.09375C453.6484375,211.09375,287.4015655517578,211.09375,256.2302770614624,211.09375" stroke-width="2" marker-end="url(#raphael-marker-endblock55-obj50)" stroke-dasharray="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path><text x="261.21875" y="236.09375" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="5.890625" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">RESPONSE large file</tspan></text><path fill="none" stroke="#000000" d="M251.2265625,249.3125C251.2265625,249.3125,417.4734344482422,249.3125,448.6447229385376,249.3125" stroke-width="2" marker-end="url(#raphael-marker-endblock55-obj53)" stroke-dasharray="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path><text x="463.6484375" y="274.3125" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="5.890625" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">request incl. large file</tspan></text><path fill="none" stroke="#000000" d="M453.6484375,287.53125C453.6484375,287.53125,663.7866933345795,287.53125,699.083353494294,287.53125" stroke-width="2" marker-end="url(#raphael-marker-endblock55-obj56)" stroke-dasharray="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path><text x="299.6328125" y="312.53125" text-anchor="start" font-family="Andale Mono, monospace" font-size="16px" stroke="none" fill="#000000" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0); text-anchor: start; font-family: &quot;Andale Mono&quot;, monospace; font-size: 16px;"><tspan dy="6" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);">RESPONSE success</tspan></text><path fill="none" stroke="#000000" d="M704.0859375,325.53125C704.0859375,325.53125,114.27416329830885,325.53125,53.79541692020575,325.53125" stroke-width="2" marker-end="url(#raphael-marker-endblock55-obj59)" stroke-dasharray="none" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path></svg>

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+http-message-flow.svg: http-message-flow.sequence`
	`2`	`+ diagrams sequence http-message-flow.sequence http-message-flow.svg`