-
Notifications
You must be signed in to change notification settings - Fork 17
Expand file tree
/
Copy pathmesh.html
More file actions
256 lines (141 loc) · 9.95 KB
/
Copy pathmesh.html
File metadata and controls
256 lines (141 loc) · 9.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title><no title> — codon 0.0.21 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home" alt="Documentation Home"> codon
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../modules.html">codonPython</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">codon</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> »</li>
<li><no title></li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/example_usage/mesh.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<p>Use of the MESH API will generally follow one of a few standard patterns.</p>
<p>Upload file pattern:</p>
<ul class="simple">
<li><p>Check Authentication with the MESH API endpoint</p></li>
<li><p>Send one or more files (chunked if needed)</p></li>
</ul>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">codonPython.mesh</span> <span class="kn">import</span> <span class="n">MESHConnection</span>
<span class="n">mesh_client</span> <span class="o">=</span> <span class="n">MESHConnection</span><span class="p">(</span>
<span class="n">mailbox</span> <span class="o">=</span> <span class="s1">'test'</span>
<span class="n">password</span> <span class="o">=</span> <span class="s1">'test'</span>
<span class="n">api_shared_key</span> <span class="o">=</span> <span class="s1">'test'</span>
<span class="n">cert_loc</span> <span class="o">=</span> <span class="s1">'./certs/test.cert'</span>
<span class="n">key_loc</span> <span class="o">=</span> <span class="s1">'./certs/test.key'</span>
<span class="n">base_ca_loc</span> <span class="o">=</span> <span class="s1">'./certs/test.ca-bundle'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">mesh_client</span><span class="o">.</span><span class="n">check_authentication</span><span class="p">():</span>
<span class="n">mesh_client</span><span class="o">.</span><span class="n">send_file</span><span class="p">(</span><span class="s1">'test_recipient'</span><span class="p">,</span> <span class="s1">'./test/test_20200224_1100.txt.dat'</span><span class="p">,</span> <span class="s1">'test_workflow'</span><span class="p">)</span>
</pre></div>
</div>
<p>Download file pattern:</p>
<ul class="simple">
<li><p>Check Authentication with the MESH API endpoint</p></li>
<li><p>Request a list of files to download from the endpoint</p></li>
<li><p>Download and process each in turn (downloading chunked files if needed)</p></li>
<li><p>After each file has been <em>successfully</em> processed, send acknowledgement to the MESH API for that file</p></li>
<li><p>Repeat as needed until there are no more files which can be processed. Note that the MESH API will return at most 500 message IDs at a time.</p></li>
</ul>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">codonPython.mesh</span> <span class="kn">import</span> <span class="n">MESHConnection</span>
<span class="n">mesh_client</span> <span class="o">=</span> <span class="n">MESHConnection</span><span class="p">(</span>
<span class="n">mailbox</span> <span class="o">=</span> <span class="s1">'test'</span>
<span class="n">password</span> <span class="o">=</span> <span class="s1">'test'</span>
<span class="n">api_shared_key</span> <span class="o">=</span> <span class="s1">'test'</span>
<span class="n">cert_loc</span> <span class="o">=</span> <span class="s1">'./certs/test.cert'</span>
<span class="n">key_loc</span> <span class="o">=</span> <span class="s1">'./certs/test.key'</span>
<span class="n">base_ca_loc</span> <span class="o">=</span> <span class="s1">'./certs/test.ca-bundle'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">mesh_client</span><span class="o">.</span><span class="n">check_authentication</span><span class="p">():</span>
<span class="c1"># To save all messages to a folder</span>
<span class="n">mesh_client</span><span class="o">.</span><span class="n">check_and_download</span><span class="p">(</span><span class="s1">'./inbox'</span><span class="p">)</span>
<span class="c1"># To perform more complex processing on each</span>
<span class="k">for</span> <span class="n">message</span> <span class="ow">in</span> <span class="n">mesh_client</span><span class="o">.</span><span class="n">check_and_download</span><span class="p">():</span>
<span class="n">process</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
<span class="c1"># To perform the flow manually instead of using the check_and_download helper method</span>
<span class="n">errors</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">inbox_messages</span> <span class="o">=</span> <span class="n">mesh_client</span><span class="o">.</span><span class="n">check_inbox</span><span class="p">()</span>
<span class="k">for</span> <span class="n">message_id</span> <span class="ow">in</span> <span class="n">inbox_messages</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">message</span> <span class="o">=</span> <span class="n">mesh_client</span><span class="o">.</span><span class="n">download_message</span><span class="p">(</span><span class="n">message_id</span><span class="p">,</span> <span class="s1">'./inbox'</span><span class="p">)</span>
<span class="n">process</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
<span class="n">mesh_client</span><span class="o">.</span><span class="n">ack_download_message</span><span class="p">(</span><span class="n">message_id</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
</pre></div>
</div>
<p>NB:
The regular MESH client has strict restrictions on filename and type. The API does not have any such restrictions, however it is likely that the system files are being sent to expects files to be in this format.
Unless you know otherwise files should be sent with .dat extension, with filename pattern Organisation_Date_Time.ext.dat where .ext is the original file extension.</p>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright under BSD-3 license
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>