Skip to content

Commit

Permalink
Version 2.0
Browse files Browse the repository at this point in the history 
* 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.
  • Loading branch information
@michaelbabiy
michaelbabiy authored Dec 21, 2020
2 parents 2d2ed33 + d9ea760 commit 93ecd72
Show file tree
Hide file tree
Showing 204 changed files with 20,824 additions and 4,252 deletions.
162 changes: 126 additions & 36 deletions Documentation/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,21 @@
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>

<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Atom Docs</a> (99% documented)</p>
<p><a href="index.html">Atom Docs</a> (98% documented)</p>
<p class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</header>
<div class="content-wrapper">
Expand All @@ -34,40 +42,13 @@
<a href="Classes/Atom.html">Atom</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/AuthenticationMethod.html">– AuthenticationMethod</a>
<a href="Classes/Service.html">Service</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/AuthorizationEndpoint.html">– AuthorizationEndpoint</a>
<a href="Classes/ServiceConfiguration.html">ServiceConfiguration</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/BaseURL.html">– BaseURL</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/BasicCredential.html">– BasicCredential</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/ClientCredential.html">– ClientCredential</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/HeaderItem.html">– HeaderItem</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/Method.html">– Method</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/Response.html">– Response</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/TokenCredential.html">– TokenCredential</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/URLPath.html">– URLPath</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/Service.html">– Service</a>
</li>
<li class="nav-group-task">
<a href="Classes/Atom/ServiceConfiguration.html">– ServiceConfiguration</a>
<a href="Classes/ServiceConfiguration/Configuration.html">– Configuration</a>
</li>
</ul>
</li>
Expand All @@ -77,6 +58,12 @@
<li class="nav-group-task">
<a href="Enums/AtomError.html">AtomError</a>
</li>
<li class="nav-group-task">
<a href="Enums/AuthenticationMethod.html">AuthenticationMethod</a>
</li>
<li class="nav-group-task">
<a href="Enums/HTTPMethod.html">HTTPMethod</a>
</li>
<li class="nav-group-task">
<a href="Enums/RequestableError.html">RequestableError</a>
</li>
Expand All @@ -86,10 +73,10 @@
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Extensions/Bool.html">Bool</a>
<a href="Extensions/Array.html">Array</a>
</li>
<li class="nav-group-task">
<a href="Extensions/Optional.html">Optional</a>
<a href="Extensions.html#/s:10Foundation4DataV">Data</a>
</li>
<li class="nav-group-task">
<a href="Extensions/URLRequest.html">URLRequest</a>
Expand Down Expand Up @@ -120,11 +107,52 @@
<li class="nav-group-task">
<a href="Protocols/Requestable.html">Requestable</a>
</li>
<li class="nav-group-task">
<a href="Protocols/RequestableItem.html">RequestableItem</a>
</li>
<li class="nav-group-task">
<a href="Protocols/TokenCredentialWritable.html">TokenCredentialWritable</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/AtomResponse.html">AtomResponse</a>
</li>
<li class="nav-group-task">
<a href="Structs/AuthorizationEndpoint.html">AuthorizationEndpoint</a>
</li>
<li class="nav-group-task">
<a href="Structs/BaseURL.html">BaseURL</a>
</li>
<li class="nav-group-task">
<a href="Structs/BaseURL/Scheme.html">– Scheme</a>
</li>
<li class="nav-group-task">
<a href="Structs/BasicCredential.html">BasicCredential</a>
</li>
<li class="nav-group-task">
<a href="Structs/ClientCredential.html">ClientCredential</a>
</li>
<li class="nav-group-task">
<a href="Structs/ClientCredential/GrantType.html">– GrantType</a>
</li>
<li class="nav-group-task">
<a href="Structs/HeaderItem.html">HeaderItem</a>
</li>
<li class="nav-group-task">
<a href="Structs/QueryItem.html">QueryItem</a>
</li>
<li class="nav-group-task">
<a href="Structs/TokenCredential.html">TokenCredential</a>
</li>
<li class="nav-group-task">
<a href="Structs/URLPath.html">URLPath</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
Expand Down Expand Up @@ -158,7 +186,69 @@ <h1>Classes</h1>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Atom</span></code></pre>
<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>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:4Atom7ServiceC"></a>
<a name="//apple_ref/swift/Class/Service" class="dashAnchor"></a>
<a class="token" href="#/s:4Atom7ServiceC">Service</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p><code>Service</code> is a public facing class responsible for managing
<code>URLSession</code> configuration, network calls, and decoding instances of a
data type into internal models.</p>

<p><code>Service</code> is available through the <code><a href="Classes/Atom.html">Atom</a></code> instance only and cannot be
initialized dirrectly. This behavior is intentional to allow for better separation
of responsibilities such as creating a request, network call, and data decoding.</p>

<a href="Classes/Service.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Service</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:4Atom20ServiceConfigurationC"></a>
<a name="//apple_ref/swift/Class/ServiceConfiguration" class="dashAnchor"></a>
<a class="token" href="#/s:4Atom20ServiceConfigurationC">ServiceConfiguration</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Model object representing Service configuration.</p>

<a href="Classes/ServiceConfiguration.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<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>

</div>
</div>
Expand All @@ -170,8 +260,8 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2020-03-18)</p>
<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>
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2020-12-17)</p>
<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>
</section>
</article>
</div>
Expand Down
Loading

0 comments on commit 93ecd72

Please sign in to comment.