Skip to content

Commit 93ecd72

Browse files
michaelbabiymichaelbabiy
authored
Version 2.0
* Add Combine support. * Introduce `RequestableItem`. * Introduce `HeaderItem` and `QueryItem` types. Conform and implement `ExpressibleByDictionaryLiteral` for cleaner `Requestable` conformance. * Move Atom's nested types to be their own (resolve nesting issues with SPM, etc). * Remove Carthage support (sorry). Please use SPM. * Update Example to use SwiftUI. * Update UNIT tests. * Update documentation.
2 parents 2d2ed33 + d9ea760 commit 93ecd72

File tree

204 files changed

+20824
-4252
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

204 files changed

+20824
-4252
lines changed

‎Documentation/Classes.html‎

Lines changed: 126 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,21 @@
88
<script src="js/jquery.min.js" defer></script>
99
<script src="js/jazzy.js" defer></script>
1010

11+
<script src="js/lunr.min.js" defer></script>
12+
<script src="js/typeahead.jquery.js" defer></script>
13+
<script src="js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
1417
<a title="Classes Reference"></a>
1518
<header>
1619
<div class="content-wrapper">
17-
<p><a href="index.html">Atom Docs</a> (99% documented)</p>
20+
<p><a href="index.html">Atom Docs</a> (98% documented)</p>
21+
<p class="header-right">
22+
<form role="search" action="search.json">
23+
<input type="text" placeholder="Search documentation" data-typeahead>
24+
</form>
25+
</p>
1826
</div>
1927
</header>
2028
<div class="content-wrapper">
@@ -34,40 +42,13 @@
3442
<a href="Classes/Atom.html">Atom</a>
3543
</li>
3644
<li class="nav-group-task">
37-
<a href="Classes/Atom/AuthenticationMethod.html">– AuthenticationMethod</a>
45+
<a href="Classes/Service.html">Service</a>
3846
</li>
3947
<li class="nav-group-task">
40-
<a href="Classes/Atom/AuthorizationEndpoint.html">– AuthorizationEndpoint</a>
48+
<a href="Classes/ServiceConfiguration.html">ServiceConfiguration</a>
4149
</li>
4250
<li class="nav-group-task">
43-
<a href="Classes/Atom/BaseURL.html">– BaseURL</a>
44-
</li>
45-
<li class="nav-group-task">
46-
<a href="Classes/Atom/BasicCredential.html">– BasicCredential</a>
47-
</li>
48-
<li class="nav-group-task">
49-
<a href="Classes/Atom/ClientCredential.html">– ClientCredential</a>
50-
</li>
51-
<li class="nav-group-task">
52-
<a href="Classes/Atom/HeaderItem.html">– HeaderItem</a>
53-
</li>
54-
<li class="nav-group-task">
55-
<a href="Classes/Atom/Method.html">– Method</a>
56-
</li>
57-
<li class="nav-group-task">
58-
<a href="Classes/Atom/Response.html">– Response</a>
59-
</li>
60-
<li class="nav-group-task">
61-
<a href="Classes/Atom/TokenCredential.html">– TokenCredential</a>
62-
</li>
63-
<li class="nav-group-task">
64-
<a href="Classes/Atom/URLPath.html">– URLPath</a>
65-
</li>
66-
<li class="nav-group-task">
67-
<a href="Classes/Atom/Service.html">– Service</a>
68-
</li>
69-
<li class="nav-group-task">
70-
<a href="Classes/Atom/ServiceConfiguration.html">– ServiceConfiguration</a>
51+
<a href="Classes/ServiceConfiguration/Configuration.html">– Configuration</a>
7152
</li>
7253
</ul>
7354
</li>
@@ -77,6 +58,12 @@
7758
<li class="nav-group-task">
7859
<a href="Enums/AtomError.html">AtomError</a>
7960
</li>
61+
<li class="nav-group-task">
62+
<a href="Enums/AuthenticationMethod.html">AuthenticationMethod</a>
63+
</li>
64+
<li class="nav-group-task">
65+
<a href="Enums/HTTPMethod.html">HTTPMethod</a>
66+
</li>
8067
<li class="nav-group-task">
8168
<a href="Enums/RequestableError.html">RequestableError</a>
8269
</li>
@@ -86,10 +73,10 @@
8673
<a href="Extensions.html">Extensions</a>
8774
<ul class="nav-group-tasks">
8875
<li class="nav-group-task">
89-
<a href="Extensions/Bool.html">Bool</a>
76+
<a href="Extensions/Array.html">Array</a>
9077
</li>
9178
<li class="nav-group-task">
92-
<a href="Extensions/Optional.html">Optional</a>
79+
<a href="Extensions.html#/s:10Foundation4DataV">Data</a>
9380
</li>
9481
<li class="nav-group-task">
9582
<a href="Extensions/URLRequest.html">URLRequest</a>
@@ -120,11 +107,52 @@
120107
<li class="nav-group-task">
121108
<a href="Protocols/Requestable.html">Requestable</a>
122109
</li>
110+
<li class="nav-group-task">
111+
<a href="Protocols/RequestableItem.html">RequestableItem</a>
112+
</li>
123113
<li class="nav-group-task">
124114
<a href="Protocols/TokenCredentialWritable.html">TokenCredentialWritable</a>
125115
</li>
126116
</ul>
127117
</li>
118+
<li class="nav-group-name">
119+
<a href="Structs.html">Structures</a>
120+
<ul class="nav-group-tasks">
121+
<li class="nav-group-task">
122+
<a href="Structs/AtomResponse.html">AtomResponse</a>
123+
</li>
124+
<li class="nav-group-task">
125+
<a href="Structs/AuthorizationEndpoint.html">AuthorizationEndpoint</a>
126+
</li>
127+
<li class="nav-group-task">
128+
<a href="Structs/BaseURL.html">BaseURL</a>
129+
</li>
130+
<li class="nav-group-task">
131+
<a href="Structs/BaseURL/Scheme.html">– Scheme</a>
132+
</li>
133+
<li class="nav-group-task">
134+
<a href="Structs/BasicCredential.html">BasicCredential</a>
135+
</li>
136+
<li class="nav-group-task">
137+
<a href="Structs/ClientCredential.html">ClientCredential</a>
138+
</li>
139+
<li class="nav-group-task">
140+
<a href="Structs/ClientCredential/GrantType.html">– GrantType</a>
141+
</li>
142+
<li class="nav-group-task">
143+
<a href="Structs/HeaderItem.html">HeaderItem</a>
144+
</li>
145+
<li class="nav-group-task">
146+
<a href="Structs/QueryItem.html">QueryItem</a>
147+
</li>
148+
<li class="nav-group-task">
149+
<a href="Structs/TokenCredential.html">TokenCredential</a>
150+
</li>
151+
<li class="nav-group-task">
152+
<a href="Structs/URLPath.html">URLPath</a>
153+
</li>
154+
</ul>
155+
</li>
128156
</ul>
129157
</nav>
130158
<article class="main-content">
@@ -158,7 +186,69 @@ <h1>Classes</h1>
158186
<h4>Declaration</h4>
159187
<div class="language">
160188
<p class="aside-title">Swift</p>
161-
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Atom</span></code></pre>
189+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Atom</span></code></pre>
190+
191+
</div>
192+
</div>
193+
</section>
194+
</div>
195+
</li>
196+
<li class="item">
197+
<div>
198+
<code>
199+
<a name="/s:4Atom7ServiceC"></a>
200+
<a name="//apple_ref/swift/Class/Service" class="dashAnchor"></a>
201+
<a class="token" href="#/s:4Atom7ServiceC">Service</a>
202+
</code>
203+
</div>
204+
<div class="height-container">
205+
<div class="pointer-container"></div>
206+
<section class="section">
207+
<div class="pointer"></div>
208+
<div class="abstract">
209+
<p><code>Service</code> is a public facing class responsible for managing
210+
<code>URLSession</code> configuration, network calls, and decoding instances of a
211+
data type into internal models.</p>
212+
213+
<p><code>Service</code> is available through the <code><a href="Classes/Atom.html">Atom</a></code> instance only and cannot be
214+
initialized dirrectly. This behavior is intentional to allow for better separation
215+
of responsibilities such as creating a request, network call, and data decoding.</p>
216+
217+
<a href="Classes/Service.html" class="slightly-smaller">See more</a>
218+
</div>
219+
<div class="declaration">
220+
<h4>Declaration</h4>
221+
<div class="language">
222+
<p class="aside-title">Swift</p>
223+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Service</span></code></pre>
224+
225+
</div>
226+
</div>
227+
</section>
228+
</div>
229+
</li>
230+
<li class="item">
231+
<div>
232+
<code>
233+
<a name="/s:4Atom20ServiceConfigurationC"></a>
234+
<a name="//apple_ref/swift/Class/ServiceConfiguration" class="dashAnchor"></a>
235+
<a class="token" href="#/s:4Atom20ServiceConfigurationC">ServiceConfiguration</a>
236+
</code>
237+
</div>
238+
<div class="height-container">
239+
<div class="pointer-container"></div>
240+
<section class="section">
241+
<div class="pointer"></div>
242+
<div class="abstract">
243+
<p>Model object representing Service configuration.</p>
244+
245+
<a href="Classes/ServiceConfiguration.html" class="slightly-smaller">See more</a>
246+
</div>
247+
<div class="declaration">
248+
<h4>Declaration</h4>
249+
<div class="language">
250+
<p class="aside-title">Swift</p>
251+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">ServiceConfiguration</span></code></pre>
162252

163253
</div>
164254
</div>
@@ -170,8 +260,8 @@ <h4>Declaration</h4>
170260
</section>
171261
</section>
172262
<section id="footer">
173-
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2020-03-18)</p>
174-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
263+
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2020-12-17)</p>
264+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
175265
</section>
176266
</article>
177267
</div>

0 commit comments

Comments
 (0)