Skip to content

Commit 9b01f9d

Browse files
tomerdtomerd
committed
add collateral (#7)
motivation: min requirements by sswg changes: * add code of conduct, contributors * add docker setup for ci * add linux docs generation and sanity check scripts * add api documentation generation script
1 parent 7cfc052 commit 9b01f9d

23 files changed

+805
-65
lines changed

‎.mailmap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎CODE_OF_CONDUCT.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Code of Conduct
2+
To be a truly great community, SwiftNIOHTTPClient needs to welcome developers from all walks of life,
3+
with different backgrounds, and with a wide range of experience. A diverse and friendly
4+
community will have more great ideas, more unique perspectives, and produce more great
5+
code. We will work diligently to make the SwiftNIOHTTPClient community welcoming to everyone.
6+
7+
To give clarity of what is expected of our members, SwiftNIOHTTPClient has adopted the code of conduct
8+
defined by [contributor-covenant.org](https://www.contributor-covenant.org). This document is used across many open source
9+
communities, and we think it articulates our values well. The full text is copied below:
10+
11+
### Contributor Code of Conduct v1.3
12+
As contributors and maintainers of this project, and in the interest of fostering an open and
13+
welcoming community, we pledge to respect all people who contribute through reporting
14+
issues, posting feature requests, updating documentation, submitting pull requests or patches,
15+
and other activities.
16+
17+
We are committed to making participation in this project a harassment-free experience for
18+
everyone, regardless of level of experience, gender, gender identity and expression, sexual
19+
orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or
20+
nationality.
21+
22+
Examples of unacceptable behavior by participants include:
23+
- The use of sexualized language or imagery
24+
- Personal attacks
25+
- Trolling or insulting/derogatory comments
26+
- Public or private harassment
27+
- Publishing other’s private information, such as physical or electronic addresses, without explicit permission
28+
- Other unethical or unprofessional conduct
29+
30+
Project maintainers have the right and responsibility to remove, edit, or reject comments,
31+
commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of
32+
Conduct, or to ban temporarily or permanently any contributor for other behaviors that they
33+
deem inappropriate, threatening, offensive, or harmful.
34+
35+
By adopting this Code of Conduct, project maintainers commit themselves to fairly and
36+
consistently applying these principles to every aspect of managing this project. Project
37+
maintainers who do not follow or enforce the Code of Conduct may be permanently removed
38+
from the project team.
39+
40+
This code of conduct applies both within project spaces and in public spaces when an
41+
individual is representing the project or its community.
42+
43+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by
44+
contacting a project maintainer at [conduct@swiftserver.group](mailto:conduct@swiftserver.group). All complaints will be reviewed and
45+
investigated and will result in a response that is deemed necessary and appropriate to the
46+
circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter
47+
of an incident.
48+
49+
*This policy is adapted from the Contributor Code of Conduct [version 1.3.0](https://contributor-covenant.org/version/1/3/0/).*
50+
51+
### Reporting
52+
A working group of community members is committed to promptly addressing any [reported issues](mailto:conduct@swiftserver.group).
53+
Working group members are volunteers appointed by the project lead, with a
54+
preference for individuals with varied backgrounds and perspectives. Membership is expected
55+
to change regularly, and may grow or shrink.

‎CONTRIBUTORS.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
For the purpose of tracking copyright, this is the list of individuals and
2+
organizations who have contributed source code to the SwiftNIOHTTPClient.
3+
4+
For employees of an organization/company where the copyright of work done
5+
by employees of that company is held by the company itself, only the company
6+
needs to be listed here.
7+
8+
## COPYRIGHT HOLDERS
9+
10+
- Swift Server Working Group (all contributors with '@apple.com')
11+
12+
### Contributors
13+
14+
- Artem Redkin <aredkin@apple.com>
15+
16+
**Updating this list**
17+
18+
Please do not edit this file manually. It is generated using `./scripts/generate_contributors_list.sh`. If a name is misspelled or appearing multiple times: add an entry in `./.mailmap`

‎Package.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
// swift-tools-version:5.0
22
//===----------------------------------------------------------------------===//
33
//
4-
// This source file is part of the SwiftNIOHTTP open source project
4+
// This source file is part of the SwiftNIOHTTPClient open source project
55
//
6-
// Copyright (c) 2017-2018 Swift Server Working Group and the SwiftNIOHTTP project authors
6+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
77
// Licensed under Apache License v2.0
88
//
99
// See LICENSE.txt for license information
10-
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTP project authors
10+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
1111
//
1212
// SPDX-License-Identifier: Apache-2.0
1313
//

‎Sources/NIOHTTPClient/HTTPCookie.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftNIOHTTP open source project
3+
// This source file is part of the SwiftNIOHTTPClient open source project
44
//
5-
// Copyright (c) 2017-2018 Swift Server Working Group and the SwiftNIOHTTP project authors
5+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTP project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

‎Sources/NIOHTTPClient/HTTPHandler.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftNIOHTTP open source project
3+
// This source file is part of the SwiftNIOHTTPClient open source project
44
//
5-
// Copyright (c) 2017-2018 Swift Server Working Group and the SwiftNIOHTTP project authors
5+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTP project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

‎Sources/NIOHTTPClient/RequestValidation.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftNIOHTTP open source project
3+
// This source file is part of the SwiftNIOHTTPClient open source project
44
//
5-
// Copyright (c) 2017-2018 Swift Server Working Group and the SwiftNIOHTTP project authors
5+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTP project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

‎Sources/NIOHTTPClient/SwiftNIOHTTP.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftNIOHTTP open source project
3+
// This source file is part of the SwiftNIOHTTPClient open source project
44
//
5-
// Copyright (c) 2017-2018 Swift Server Working Group and the SwiftNIOHTTP project authors
5+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTP project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

‎Sources/NIOHTTPClient/Utils.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftNIOHTTP open source project
3+
// This source file is part of the SwiftNIOHTTPClient open source project
44
//
5-
// Copyright (c) 2017-2018 Swift Server Working Group and the SwiftNIOHTTP project authors
5+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTP project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

‎Tests/LinuxMain.swift

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,32 @@
1+
//===----------------------------------------------------------------------===//
2+
//
3+
// This source file is part of the SwiftNIOHTTPClient open source project
4+
//
5+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
6+
// Licensed under Apache License v2.0
7+
//
8+
// See LICENSE.txt for license information
9+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
10+
//
11+
// SPDX-License-Identifier: Apache-2.0
12+
//
13+
//===----------------------------------------------------------------------===//
14+
//
15+
// LinuxMain.swift
16+
//
117
import XCTest
218

3-
import SwiftNIOHTTPTests
19+
///
20+
/// NOTE: This file was generated by generate_linux_tests.rb
21+
///
22+
/// Do NOT edit this file directly as it will be regenerated automatically when needed.
23+
///
424

5-
var tests = [XCTestCaseEntry]()
6-
tests += SwiftNIOHTTPTests.__allTests()
25+
#if os(Linux) || os(FreeBSD)
26+
@testable import NIOHTTPClientTests
727

8-
XCTMain(tests)
28+
XCTMain([
29+
testCase(HTTPCookieTests.allTests),
30+
testCase(SwiftHTTPTests.allTests),
31+
])
32+
#endif

‎Tests/NIOHTTPClientTests/HTTPClientTestUtils.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftNIOHTTP open source project
3+
// This source file is part of the SwiftNIOHTTPClient open source project
44
//
5-
// Copyright (c) 2017-2018 Swift Server Working Group and the SwiftNIOHTTP project authors
5+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTP project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

‎Tests/NIOHTTPClientTests/HTTPCookieTests+XCTest.swift

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
//===----------------------------------------------------------------------===//
2+
//
3+
// This source file is part of the SwiftNIOHTTPClient open source project
4+
//
5+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
6+
// Licensed under Apache License v2.0
7+
//
8+
// See LICENSE.txt for license information
9+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
10+
//
11+
// SPDX-License-Identifier: Apache-2.0
12+
//
13+
//===----------------------------------------------------------------------===//
14+
//
15+
// HTTPCookieTests+XCTest.swift
16+
//
17+
import XCTest
18+
19+
///
20+
/// NOTE: This file was generated by generate_linux_tests.rb
21+
///
22+
/// Do NOT edit this file directly as it will be regenerated automatically when needed.
23+
///
24+
25+
extension HTTPCookieTests {
26+
27+
static var allTests : [(String, (HTTPCookieTests) -> () throws -> Void)] {
28+
return [
29+
("testCookie", testCookie),
30+
("testCookieDefaults", testCookieDefaults),
31+
]
32+
}
33+
}
34+

‎Tests/NIOHTTPClientTests/HTTPCookieTests.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftNIOHTTP open source project
3+
// This source file is part of the SwiftNIOHTTPClient open source project
44
//
5-
// Copyright (c) 2017-2018 Swift Server Working Group and the SwiftNIOHTTP project authors
5+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTP project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

‎Tests/NIOHTTPClientTests/SwiftNIOHTTPTests+XCTest.swift

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
//===----------------------------------------------------------------------===//
2+
//
3+
// This source file is part of the SwiftNIOHTTPClient open source project
4+
//
5+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
6+
// Licensed under Apache License v2.0
7+
//
8+
// See LICENSE.txt for license information
9+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
10+
//
11+
// SPDX-License-Identifier: Apache-2.0
12+
//
13+
//===----------------------------------------------------------------------===//
14+
//
15+
// SwiftNIOHTTPTests+XCTest.swift
16+
//
17+
import XCTest
18+
19+
///
20+
/// NOTE: This file was generated by generate_linux_tests.rb
21+
///
22+
/// Do NOT edit this file directly as it will be regenerated automatically when needed.
23+
///
24+
25+
extension SwiftHTTPTests {
26+
27+
static var allTests : [(String, (SwiftHTTPTests) -> () throws -> Void)] {
28+
return [
29+
("testRequestURI", testRequestURI),
30+
("testHTTPPartsHandler", testHTTPPartsHandler),
31+
("testHTTPPartsHandlerMultiBody", testHTTPPartsHandlerMultiBody),
32+
("testGet", testGet),
33+
("testPost", testPost),
34+
("testGetHttps", testGetHttps),
35+
("testPostHttps", testPostHttps),
36+
("testHttpRedirect", testHttpRedirect),
37+
("testMultipleContentLengthHeaders", testMultipleContentLengthHeaders),
38+
("testStreaming", testStreaming),
39+
("testRemoteClose", testRemoteClose),
40+
("testReadTimeout", testReadTimeout),
41+
("testCancel", testCancel),
42+
]
43+
}
44+
}
45+

‎Tests/NIOHTTPClientTests/SwiftNIOHTTPTests.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
//===----------------------------------------------------------------------===//
22
//
3-
// This source file is part of the SwiftNIOHTTP open source project
3+
// This source file is part of the SwiftNIOHTTPClient open source project
44
//
5-
// Copyright (c) 2017-2018 Swift Server Working Group and the SwiftNIOHTTP project authors
5+
// Copyright (c) 2018-2019 Swift Server Working Group and the SwiftNIOHTTPClient project authors
66
// Licensed under Apache License v2.0
77
//
88
// See LICENSE.txt for license information
9-
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTP project authors
9+
// See CONTRIBUTORS.txt for the list of SwiftNIOHTTPClient project authors
1010
//
1111
// SPDX-License-Identifier: Apache-2.0
1212
//

‎Tests/NIOHTTPClientTests/XCTestManifests.swift

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
 (0)