Skip to content

Commit 0166688

Browse files
mbarnachmbarnach
authored
Merge pull request #98 from dannys42-contrib/MISC-org_update
Misc org update
2 parents 77c141b + 6f1424c commit 0166688

Some content is hidden

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

53 files changed

+876
-692
lines changed

‎.jazzy.yaml‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
module: SwiftJWT
2-
author: IBM
3-
github_url: https://github.com/IBM-Swift/Swift-JWT/
2+
author: IBM & Kitura Project Contributors
3+
github_url: https://github.com/Kitura/Swift-JWT/
44

55
theme: fullwidth
66
clean: true
@@ -10,5 +10,3 @@ readme: README.md
1010

1111
skip_undocumented: false
1212
hide_documentation_coverage: false
13-
14-
xcodebuild_arguments: [-project, SwiftJWT.xcodeproj, -target, SwiftJWT, LIBRARY_SEARCH_PATHS=.build/debug]

‎.travis.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ matrix:
6666
env: SWIFT_SNAPSHOT=$SWIFT_DEVELOPMENT_SNAPSHOT
6767

6868
before_install:
69-
- git clone https://github.com/IBM-Swift/Package-Builder.git
69+
- git clone https://github.com/Kitura/Package-Builder.git
7070

7171
script:
7272
- ./Package-Builder/build-package.sh -projectDir $TRAVIS_BUILD_DIR

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
<p align="center">
22
<a href="http://kitura.io/">
3-
<img src="https://raw.githubusercontent.com/IBM-Swift/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
3+
<img src="https://raw.githubusercontent.com/Kitura/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
44
</a>
55
</p>
66

77

88
<p align="center">
9-
<a href="https://ibm-swift.github.io/Swift-JWT/index.html">
9+
<a href="https://kitura.github.io/Swift-JWT/index.html">
1010
<img src="https://img.shields.io/badge/apidoc-SwiftJWT-1FBCE4.svg?style=flat" alt="APIDoc">
1111
</a>
12-
<a href="https://travis-ci.org/IBM-Swift/Swift-JWT">
13-
<img src="https://travis-ci.org/IBM-Swift/Swift-JWT.svg?branch=master" alt="Build Status - Master">
12+
<a href="https://travis-ci.org/Kitura/Swift-JWT">
13+
<img src="https://travis-ci.org/Kitura/Swift-JWT.svg?branch=master" alt="Build Status - Master">
1414
</a>
1515
<img src="https://img.shields.io/badge/os-macOS-green.svg?style=flat" alt="macOS">
1616
<img src="https://img.shields.io/badge/os-linux-green.svg?style=flat" alt="Linux">
@@ -36,9 +36,9 @@ The latest version of Swift-JWT requires **Swift 4.0** or later. You can downloa
3636
### Swift Package Manager
3737

3838
#### Add dependencies
39-
Add the `Swift-JWT` package to the dependencies within your application’s `Package.swift` file. Substitute `"x.x.x"` with the latest `Swift-JWT` [release](https://github.com/IBM-Swift/Swift-JWT/releases).
39+
Add the `Swift-JWT` package to the dependencies within your application’s `Package.swift` file. Substitute `"x.x.x"` with the latest `Swift-JWT` [release](https://github.com/Kitura/Swift-JWT/releases).
4040
```swift
41-
.package(url: "https://github.com/IBM-Swift/Swift-JWT.git", from: "x.x.x")
41+
.package(url: "https://github.com/Kitura/Swift-JWT.git", from: "x.x.x")
4242
```
4343
Add `SwiftJWT` to your target's dependencies:
4444
```swift
@@ -126,7 +126,7 @@ let publicKeyPath = URL(fileURLWithPath: getAbsolutePath(relativePath: "/path/to
126126
let publicKey: Data = try Data(contentsOf: publicKeyPath, options: .alwaysMapped)
127127
```
128128

129-
For details on creating elliptic curve public and private keys, view the [BlueECC README.txt](https://github.com/IBM-Swift/BlueECC).
129+
For details on creating elliptic curve public and private keys, view the [BlueECC README.txt](https://github.com/Kitura/BlueECC).
130130

131131
#### Sign a JWT using a JWTSigner
132132

@@ -225,7 +225,7 @@ The JWTEncoder and JWTDecoder classes encode and decode JWT Strings using the sa
225225
let jwt = try jwtDecoder.decode(JWT<MyClaims>.self, fromString: jwtString)
226226
```
227227

228-
Because JWTEncoder and JWTDecoder conform to [KituraContract's](https://github.com/IBM-Swift/KituraContracts/blob/master/Sources/KituraContracts/Contracts.swift) BodyEncoder and BodyDecoder protocols, they can be used as a [custom coder](https://developer.ibm.com/swift/2018/09/01/kitura-custom-encoders-and-decoders/) in Codable routes for sending and receiving JWTs:
228+
Because JWTEncoder and JWTDecoder conform to [KituraContract's](https://github.com/Kitura/KituraContracts/blob/master/Sources/KituraContracts/Contracts.swift) BodyEncoder and BodyDecoder protocols, they can be used as a [custom coder](https://developer.ibm.com/swift/2018/09/01/kitura-custom-encoders-and-decoders/) in Codable routes for sending and receiving JWTs:
229229

230230
```swift
231231
router.encoders[MediaType(type: .application, subType: "jwt")] = { return jwtEncoder }
@@ -235,11 +235,11 @@ Because JWTEncoder and JWTDecoder conform to [KituraContract's](https://github.c
235235
This allows for the use of JWT's in information exchange. By sending and receiving JWT's you can ensure the sending is who they say they are and verify the content hasn't been tampered with.
236236

237237
## API Documentation
238-
For more information visit our [API reference](https://ibm-swift.github.io/Swift-JWT/index.html).
238+
For more information visit our [API reference](https://kitura.github.io/Swift-JWT/index.html).
239239

240240
## Community
241241

242242
We love to talk server-side Swift, and Kitura. Join our [Slack](http://swift-at-ibm-slack.mybluemix.net/) to meet the team!
243243

244244
## License
245-
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/IBM-Swift/Swift-JWT/blob/master/LICENSE).
245+
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/Kitura/Swift-JWT/blob/master/LICENSE).

‎docs/Classes.html‎

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="index.html">
24-
SwiftJWT Docs
24+
SwiftJWT 3.6.200 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -33,7 +33,7 @@
3333
</p>
3434

3535
<p class="header-col header-col--secondary">
36-
<a class="header-link" href="https://github.com/IBM-Swift/Swift-JWT/">
36+
<a class="header-link" href="https://github.com/Kitura/Swift-JWT/">
3737
<img class="header-icon" src="img/gh.png"/>
3838
View on GitHub
3939
</a>
@@ -109,7 +109,7 @@
109109
<article class="main-content">
110110

111111
<section class="section">
112-
<div class="section-content">
112+
<div class="section-content top-matter">
113113
<h1>Classes</h1>
114114
<p>The following classes are available globally.</p>
115115

@@ -148,10 +148,6 @@ <h4>Declaration</h4>
148148
</section>
149149
</div>
150150
</li>
151-
</ul>
152-
</div>
153-
<div class="task-group">
154-
<ul class="item-container">
155151
<li class="item">
156152
<div>
157153
<code>
@@ -180,10 +176,6 @@ <h4>Declaration</h4>
180176
</section>
181177
</div>
182178
</li>
183-
</ul>
184-
</div>
185-
<div class="task-group">
186-
<ul class="item-container">
187179
<li class="item">
188180
<div>
189181
<code>
@@ -218,9 +210,11 @@ <h4>Declaration</h4>
218210
<div class="task-name-container">
219211
<a name="/JWTEncoder"></a>
220212
<a name="//apple_ref/swift/Section/JWTEncoder" class="dashAnchor"></a>
221-
<a href="#/JWTEncoder">
222-
<h3 class="section-name">JWTEncoder</h3>
223-
</a>
213+
<div class="section-name-container">
214+
<a class="section-name-link" href="#/JWTEncoder"></a>
215+
<h3 class="section-name"><p>JWTEncoder</p>
216+
</h3>
217+
</div>
224218
</div>
225219
<ul class="item-container">
226220
<li class="item">
@@ -270,9 +264,11 @@ <h4>Declaration</h4>
270264
<div class="task-name-container">
271265
<a name="/JWTDecoder"></a>
272266
<a name="//apple_ref/swift/Section/JWTDecoder" class="dashAnchor"></a>
273-
<a href="#/JWTDecoder">
274-
<h3 class="section-name">JWTDecoder</h3>
275-
</a>
267+
<div class="section-name-container">
268+
<a class="section-name-link" href="#/JWTDecoder"></a>
269+
<h3 class="section-name"><p>JWTDecoder</p>
270+
</h3>
271+
</div>
276272
</div>
277273
<ul class="item-container">
278274
<li class="item">
@@ -323,8 +319,8 @@ <h4>Declaration</h4>
323319
</article>
324320
</div>
325321
<section class="footer">
326-
<p>&copy; 2019 <a class="link" href="https://github.com/IBM-Swift/Swift-JWT" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-09-25)</p>
327-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
322+
<p>&copy; 2020 <a class="link" href="https://github.com/Kitura/Swift-JWT" target="_blank" rel="external">IBM &amp; Kitura Project Contributors</a>. All rights reserved. (Last updated: 2020-11-25)</p>
323+
<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>
328324
</section>
329325
</body>
330326
</div>

‎docs/Classes/ClaimsMicroProfile.html‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
SwiftJWT Docs
24+
SwiftJWT 3.6.200 Docs
2525
</a>
2626
(100% documented)
2727
</p>
@@ -33,7 +33,7 @@
3333
</p>
3434

3535
<p class="header-col header-col--secondary">
36-
<a class="header-link" href="https://github.com/IBM-Swift/Swift-JWT/">
36+
<a class="header-link" href="https://github.com/Kitura/Swift-JWT/">
3737
<img class="header-icon" src="../img/gh.png"/>
3838
View on GitHub
3939
</a>
@@ -109,10 +109,11 @@
109109
<article class="main-content">
110110

111111
<section class="section">
112-
<div class="section-content">
112+
<div class="section-content top-matter">
113113
<h1>ClaimsMicroProfile</h1>
114114
<div class="declaration">
115115
<div class="language">
116+
116117
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ClaimsMicroProfile</span> <span class="p">:</span> <span class="kt"><a href="../Protocols/Claims.html">Claims</a></span></code></pre>
117118

118119
</div>
@@ -131,7 +132,7 @@ <h1>ClaimsMicroProfile</h1>
131132
<code>
132133
<a name="/s:8SwiftJWT18ClaimsMicroProfileC3iss3sub3exp3iat3jti3upn6groupsACSS_SS10Foundation4DateVAMS2SSaySSGtcfc"></a>
133134
<a name="//apple_ref/swift/Method/init(iss:sub:exp:iat:jti:upn:groups:)" class="dashAnchor"></a>
134-
<a class="token" href="#/s:8SwiftJWT18ClaimsMicroProfileC3iss3sub3exp3iat3jti3upn6groupsACSS_SS10Foundation4DateVAMS2SSaySSGtcfc">init(iss:sub:exp:iat:jti:upn:groups:)</a>
135+
<a class="token" href="#/s:8SwiftJWT18ClaimsMicroProfileC3iss3sub3exp3iat3jti3upn6groupsACSS_SS10Foundation4DateVAMS2SSaySSGtcfc">init(iss:<wbr>sub:<wbr>exp:<wbr>iat:<wbr>jti:<wbr>upn:<wbr>groups:<wbr>)</a>
135136
</code>
136137
</div>
137138
<div class="height-container">
@@ -282,7 +283,7 @@ <h4>Declaration</h4>
282283
<section class="section">
283284
<div class="pointer"></div>
284285
<div class="abstract">
285-
<p>The <q>jti</q> (JWT ID) claim provides a unique identifier for the JWT.
286+
<p>The &ldquo;jti&rdquo; (JWT ID) claim provides a unique identifier for the JWT.
286287
The identifier value MUST be assigned in a manner that ensures that
287288
there is a negligible probability that the same value will be
288289
accidentally assigned to a different data object.</p>
@@ -312,7 +313,7 @@ <h4>Declaration</h4>
312313
<section class="section">
313314
<div class="pointer"></div>
314315
<div class="abstract">
315-
<p>This MP-JWT custom claim is the user principal name in the java.security.Principal interface, and is the caller principal name in javax.security.enterprise.identitystore.IdentityStore. If this claim is missing, fallback to the <q>preferred_username</q>, should be attempted, and if that claim is missing, fallback to the <q>sub</q> claim should be used.</p>
316+
<p>This MP-JWT custom claim is the user principal name in the java.security.Principal interface, and is the caller principal name in javax.security.enterprise.identitystore.IdentityStore. If this claim is missing, fallback to the &ldquo;preferred_username&rdquo;, should be attempted, and if that claim is missing, fallback to the &ldquo;sub&rdquo; claim should be used.</p>
316317

317318
</div>
318319
<div class="declaration">
@@ -388,8 +389,8 @@ <h4>Declaration</h4>
388389
</article>
389390
</div>
390391
<section class="footer">
391-
<p>&copy; 2019 <a class="link" href="https://github.com/IBM-Swift/Swift-JWT" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2019-09-25)</p>
392-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
392+
<p>&copy; 2020 <a class="link" href="https://github.com/Kitura/Swift-JWT" target="_blank" rel="external">IBM &amp; Kitura Project Contributors</a>. All rights reserved. (Last updated: 2020-11-25)</p>
393+
<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>
393394
</section>
394395
</body>
395396
</div>

0 commit comments

Comments
 (0)