Skip to content

Commit

Permalink
Misc org update (#113)
Browse files Browse the repository at this point in the history
* Update github org references

* Update jazzy docs

* Updated package references to kitura project versions

* Update package reference for swift 4.x to Kitura org

* Rename deprecated IndexDistance to Int
  • Loading branch information
dannys42 authored Dec 9, 2020
1 parent 75ba1b9 commit d892f67
Show file tree
Hide file tree
Showing 49 changed files with 1,141 additions and 777 deletions.
6 changes: 3 additions & 3 deletions .jazzy.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module: SwiftSMTP
author: IBM
github_url: https://github.com/IBM-Swift/Swift-SMTP/
author: IBM and Kitura project contributors
github_url: https://github.com/Kitura/Swift-SMTP/

theme: fullwidth
clean: true
Expand All @@ -11,4 +11,4 @@ readme: README.md
skip_undocumented: false
hide_documentation_coverage: false

xcodebuild_arguments: [-project, SwiftSMTP.xcodeproj, -target, SwiftSMTP, LIBRARY_SEARCH_PATHS=.build/debug]
xcodebuild_arguments: []
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ matrix:
env: SWIFT_SNAPSHOT=$SWIFT_DEVELOPMENT_SNAPSHOT

before_install:
- git clone https://github.com/IBM-Swift/Package-Builder.git
- git clone https://github.com/Kitura/Package-Builder.git

script:
- ./Package-Builder/build-package.sh -projectDir $TRAVIS_BUILD_DIR
8 changes: 4 additions & 4 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ let package = Package(
targets: ["SwiftSMTP"]),
],
dependencies: [
.package(url: "https://github.com/IBM-Swift/BlueSocket.git", from: "1.0.0"),
.package(url: "https://github.com/IBM-Swift/BlueSSLService.git", from: "1.0.0"),
.package(url: "https://github.com/IBM-Swift/BlueCryptor.git", from: "1.0.0"),
.package(url: "https://github.com/IBM-Swift/LoggerAPI.git", from: "1.7.0"),
.package(url: "https://github.com/Kitura/BlueSocket.git", from: "1.0.200"),
.package(url: "https://github.com/Kitura/BlueSSLService.git", from: "1.0.200"),
.package(url: "https://github.com/Kitura/BlueCryptor.git", from: "1.0.200"),
.package(url: "https://github.com/Kitura/LoggerAPI.git", from: "1.9.200"),
],
targets: [
.target(
Expand Down
16 changes: 8 additions & 8 deletions [email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ let package = Package(
targets: ["SwiftSMTP"]),
],
dependencies: [
.package(url: "https://github.com/IBM-Swift/BlueSocket.git", from: "1.0.0"),
.package(url: "https://github.com/IBM-Swift/BlueSSLService.git", from: "1.0.0"),
.package(url: "https://github.com/IBM-Swift/BlueCryptor.git", from: "1.0.0"),
.package(url: "https://github.com/IBM-Swift/LoggerAPI.git", from: "1.7.0"),
.package(url: "https://github.com/Kitura/BlueSocket.git", from: "1.0.200"),
.package(url: "https://github.com/Kitura/BlueSSLService.git", from: "1.0.200"),
.package(url: "https://github.com/Kitura/BlueCryptor.git", from: "1.0.200"),
.package(url: "https://github.com/Kitura/LoggerAPI.git", from: "1.9.200"),
],
targets: [
.target(
Expand All @@ -34,10 +34,10 @@ let package = Package(
targets: ["SwiftSMTP"]),
],
dependencies: [
.package(url: "https://github.com/IBM-Swift/BlueSocket.git", from: "0.12.0"),
.package(url: "https://github.com/IBM-Swift/BlueSSLService.git", from: "0.12.0"),
.package(url: "https://github.com/IBM-Swift/BlueCryptor.git", from: "0.8.0"),
.package(url: "https://github.com/IBM-Swift/LoggerAPI.git", from: "1.7.0"),
.package(url: "https://github.com/Kitura/BlueSocket.git", from: "1.0.200"),
.package(url: "https://github.com/Kitura/BlueSSLService.git", from: "1.0.200"),
.package(url: "https://github.com/Kitura/BlueCryptor.git", from: "1.0.200"),
.package(url: "https://github.com/Kitura/LoggerAPI.git", from: "1.9.200"),
],
targets: [
.target(
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Swift-SMTP

![Swift-SMTP bird](https://github.com/IBM-Swift/Swift-SMTP/blob/master/Assets/swift-smtp-bird.png?raw=true)
![Swift-SMTP bird](https://github.com/Kitura/Swift-SMTP/blob/master/Assets/swift-smtp-bird.png?raw=true)

Swift SMTP client.

![Build Status](https://travis-ci.org/IBM-Swift/Swift-SMTP.svg?branch=master)
![Build Status](https://travis-ci.org/Kitura/Swift-SMTP.svg?branch=master)
![macOS](https://img.shields.io/badge/os-macOS-green.svg?style=flat)
![Linux](https://img.shields.io/badge/os-linux-green.svg?style=flat)
![Apache 2](https://img.shields.io/badge/license-Apache2-blue.svg?style=flat)
Expand All @@ -15,7 +15,7 @@ Swift SMTP client.
- Authenticate with CRAM-MD5, LOGIN, PLAIN, or XOAUTH2
- Send emails with local file, HTML, and raw data attachments
- Add custom headers
- [Documentation](https://ibm-swift.github.io/Swift-SMTP/)
- [Documentation](https://kitura.github.io/Swift-SMTP/)

## Swift Version

Expand All @@ -38,7 +38,7 @@ let package = Package(
targets: ["MyProject"]),
],
dependencies: [
.package(url: "https://github.com/IBM-Swift/Swift-SMTP", .upToNextMinor(from: "5.1.0")), // add the dependency
.package(url: "https://github.com/Kitura/Swift-SMTP", .upToNextMinor(from: "5.1.0")), // add the dependency
],
targets: [
.target(
Expand All @@ -55,7 +55,7 @@ After adding the dependency and saving, run `swift package generate-xcodeproj` i

## Migration Guide

Version `5.0.0` brings breaking changes. See the quick migration guide [here](https://github.com/IBM-Swift/Swift-SMTP/blob/master/migration-guide.md).
Version `5.0.0` brings breaking changes. See the quick migration guide [here](https://github.com/Kitura/Swift-SMTP/blob/master/migration-guide.md).

## Usage

Expand Down Expand Up @@ -87,7 +87,7 @@ public init(hostname: String,
timeout: UInt = 10)
```

By default, the `SMTP` struct connects on port `587` and sends mail only if a TLS connection can be established. It also uses a `TLSConfiguration` that uses no backing certificates. View the [docs](https://ibm-swift.github.io/Swift-SMTP/) for more configuration options.
By default, the `SMTP` struct connects on port `587` and sends mail only if a TLS connection can be established. It also uses a `TLSConfiguration` that uses no backing certificates. View the [docs](https://kitura.github.io/Swift-SMTP/) for more configuration options.

### Send email

Expand Down
2 changes: 1 addition & 1 deletion Sources/SwiftSMTP/TLSConfiguration.swift
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import Foundation
import SSLService

/// Configuration for connecting with TLS. For more info, see https://github.com/IBM-Swift/BlueSSLService.
/// Configuration for connecting with TLS. For more info, see https://github.com/Kitura/BlueSSLService.
public struct TLSConfiguration {
private let configuration: SSLService.Configuration

Expand Down
2 changes: 1 addition & 1 deletion Tests/LinuxMain.swift
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ extension MutableCollection {
guard c > 1 else { return }

for (firstUnshuffled, unshuffledCount) in zip(indices, stride(from: c, to: 1, by: -1)) {
let d: IndexDistance = numericCast(random() % numericCast(unshuffledCount))
let d: Int = numericCast(random() % numericCast(unshuffledCount))
guard d != 0 else { continue }
let i = index(firstUnshuffled, offsetBy: d)
self.swapAt(firstUnshuffled, i)
Expand Down
17 changes: 7 additions & 10 deletions docs/Enums.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
</head>
<body>

<a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a>

<a title="Enumerations Reference"></a>

Expand All @@ -32,7 +33,7 @@
</p>

<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/IBM-Swift/Swift-SMTP/">
<a class="header-link" href="https://github.com/Kitura/Swift-SMTP/">
<img class="header-icon" src="img/gh.png"/>
View on GitHub
</a>
Expand Down Expand Up @@ -99,7 +100,7 @@
<article class="main-content">

<section class="section">
<div class="section-content">
<div class="section-content top-matter">
<h1>Enumerations</h1>
<p>The following enumerations are available globally.</p>

Expand Down Expand Up @@ -131,17 +132,13 @@ <h1>Enumerations</h1>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AuthMethod</span><span class="p">:</span> <span class="kt">String</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AuthMethod</span> <span class="p">:</span> <span class="kt">String</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
Expand All @@ -163,7 +160,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SMTPError</span><span class="p">:</span> <span class="kt">Error</span><span class="p">,</span> <span class="kt">CustomStringConvertible</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SMTPError</span> <span class="p">:</span> <span class="kt">Error</span><span class="p">,</span> <span class="kt">CustomStringConvertible</span></code></pre>

</div>
</div>
Expand All @@ -178,8 +175,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external">IBM and Kitura project contributors</a>. All rights reserved. (Last updated: 2020-12-06)</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>
</body>
</div>
Expand Down
47 changes: 18 additions & 29 deletions docs/Enums/AuthMethod.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
</p>

<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/IBM-Swift/Swift-SMTP/">
<a class="header-link" href="https://github.com/Kitura/Swift-SMTP/">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
Expand Down Expand Up @@ -100,11 +100,12 @@
<article class="main-content">

<section class="section">
<div class="section-content">
<div class="section-content top-matter">
<h1>AuthMethod</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AuthMethod</span><span class="p">:</span> <span class="kt">String</span></code></pre>

<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">AuthMethod</span> <span class="p">:</span> <span class="kt">String</span></code></pre>

</div>
</div>
Expand All @@ -120,9 +121,9 @@ <h1>AuthMethod</h1>
<li class="item">
<div>
<code>
<a name="/s:9SwiftSMTP10AuthMethodO7cramMD5A2CmF"></a>
<a name="/s:9SwiftSMTP10AuthMethodO7cramMD5yA2CmF"></a>
<a name="//apple_ref/swift/Element/cramMD5" class="dashAnchor"></a>
<a class="token" href="#/s:9SwiftSMTP10AuthMethodO7cramMD5A2CmF">cramMD5</a>
<a class="token" href="#/s:9SwiftSMTP10AuthMethodO7cramMD5yA2CmF">cramMD5</a>
</code>
</div>
<div class="height-container">
Expand All @@ -137,23 +138,19 @@ <h1>AuthMethod</h1>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">cramMD5</span> <span class="o">=</span> <span class="s">"CRAM-MD5"</span></code></pre>
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">cramMD5</span> <span class="o">=</span> <span class="s">"CRAM-MD5"</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9SwiftSMTP10AuthMethodO5loginA2CmF"></a>
<a name="/s:9SwiftSMTP10AuthMethodO5loginyA2CmF"></a>
<a name="//apple_ref/swift/Element/login" class="dashAnchor"></a>
<a class="token" href="#/s:9SwiftSMTP10AuthMethodO5loginA2CmF">login</a>
<a class="token" href="#/s:9SwiftSMTP10AuthMethodO5loginyA2CmF">login</a>
</code>
</div>
<div class="height-container">
Expand All @@ -168,23 +165,19 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">login</span> <span class="o">=</span> <span class="s">"LOGIN"</span></code></pre>
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">login</span> <span class="o">=</span> <span class="s">"LOGIN"</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9SwiftSMTP10AuthMethodO5plainA2CmF"></a>
<a name="/s:9SwiftSMTP10AuthMethodO5plainyA2CmF"></a>
<a name="//apple_ref/swift/Element/plain" class="dashAnchor"></a>
<a class="token" href="#/s:9SwiftSMTP10AuthMethodO5plainA2CmF">plain</a>
<a class="token" href="#/s:9SwiftSMTP10AuthMethodO5plainyA2CmF">plain</a>
</code>
</div>
<div class="height-container">
Expand All @@ -199,23 +192,19 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">plain</span> <span class="o">=</span> <span class="s">"PLAIN"</span></code></pre>
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">plain</span> <span class="o">=</span> <span class="s">"PLAIN"</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:9SwiftSMTP10AuthMethodO7xoauth2A2CmF"></a>
<a name="/s:9SwiftSMTP10AuthMethodO7xoauth2yA2CmF"></a>
<a name="//apple_ref/swift/Element/xoauth2" class="dashAnchor"></a>
<a class="token" href="#/s:9SwiftSMTP10AuthMethodO7xoauth2A2CmF">xoauth2</a>
<a class="token" href="#/s:9SwiftSMTP10AuthMethodO7xoauth2yA2CmF">xoauth2</a>
</code>
</div>
<div class="height-container">
Expand All @@ -230,7 +219,7 @@ <h4>Declaration</h4>
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="k">case</span> <span class="n">xoauth2</span> <span class="o">=</span> <span class="s">"XOAUTH2"</span></code></pre>
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">xoauth2</span> <span class="o">=</span> <span class="s">"XOAUTH2"</span></code></pre>

</div>
</div>
Expand All @@ -245,8 +234,8 @@ <h4>Declaration</h4>
</article>
</div>
<section class="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">IBM</a>. All rights reserved. (Last updated: 2018-06-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
<p>&copy; 2020 <a class="link" href="" target="_blank" rel="external">IBM and Kitura project contributors</a>. All rights reserved. (Last updated: 2020-12-06)</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>
</body>
</div>
Expand Down
Loading

0 comments on commit d892f67

Please sign in to comment.