Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update package reference to community versions; update domain to kitura.dev #86

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .jazzy.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module: SwiftyRequest
author: IBM
github_url: https://github.com/IBM-Swift/SwiftyRequest
github_url: https://github.com/Kitura/SwiftyRequest

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

xcodebuild_arguments: [-project, SwiftyRequest.xcodeproj, -target, SwiftyRequest, LIBRARY_SEARCH_PATHS=.build/debug]
xcodebuild_arguments: [-project, SwiftyRequest.xcodeproj, -target, SwiftyRequest, LIBRARY_SEARCH_PATHS=.build/debug]
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,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
6 changes: 3 additions & 3 deletions Package.swift
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// swift-tools-version:5.0
// The swift-tools-version declares the minimum version of Swift required to build this package.
/*
* Copyright IBM Corporation 2017-2019
* Copyright IBM Corporation and the Kitura project authors 2017-2020
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -27,8 +27,8 @@ let package = Package(
)
],
dependencies: [
.package(url: "https://github.com/IBM-Swift/CircuitBreaker.git", from: "5.0.0"),
.package(url: "https://github.com/IBM-Swift/LoggerAPI.git", from: "1.8.0"),
.package(url: "https://github.com/Kitura/CircuitBreaker.git", from: "5.0.200"),
.package(url: "https://github.com/Kitura/LoggerAPI.git", from: "1.9.200"),
.package(url: "https://github.com/swift-server/async-http-client.git", from: "1.0.0"),
],
targets: [
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<p align="center">
<a href="http://kitura.io/">
<img src="https://raw.githubusercontent.com/IBM-Swift/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
<a href="http://kitura.dev/">
<img src="https://raw.githubusercontent.com/Kitura/Kitura/master/Sources/Kitura/resources/kitura-bird.svg?sanitize=true" height="100" alt="Kitura">
</a>
</p>

<p align="center">
<a href="https://ibm-swift.github.io/SwiftyRequest/index.html">
<img src="https://img.shields.io/badge/apidoc-SwiftyRequest-1FBCE4.svg?style=flat" alt="APIDoc">
</a>
<a href="https://travis-ci.org/IBM-Swift/SwiftyRequest">
<img src="https://travis-ci.org/IBM-Swift/SwiftyRequest.svg?branch=master" alt="Build Status - Master">
<a href="https://travis-ci.org/Kitura/SwiftyRequest">
<img src="https://travis-ci.org/Kitura/SwiftyRequest.svg?branch=master" alt="Build Status - Master">
</a>
<img src="https://img.shields.io/badge/os-macOS-green.svg?style=flat" alt="macOS">
<img src="https://img.shields.io/badge/os-linux-green.svg?style=flat" alt="Linux">
Expand Down Expand Up @@ -37,7 +37,7 @@ The latest release of SwiftyRequest is built upon the Swift-NIO based [`async-ht
- Several response methods (e.g. Data, Object, Array, String, etc.) to eliminate boilerplate code in your application.
- Direct retrieval of `Codable` types.
- JSON encoding and decoding.
- Integration with the [CircuitBreaker](https://github.com/IBM-Swift/CircuitBreaker) library.
- Integration with the [CircuitBreaker](https://github.com/Kitura/CircuitBreaker) library.
- Authentication tokens.
- Client Certificate support (2-way SSL).
- Multipart form data.
Expand All @@ -53,10 +53,10 @@ To leverage the `SwiftyRequest` package in your Swift application, you should sp

### Add dependencies

Add `SwiftyRequest` to the dependencies within your application's `Package.swift` file. Substitute `"x.x.x"` with the latest `SwiftyRequest` [release](https://github.com/IBM-Swift/SwiftyRequest/releases).
Add `SwiftyRequest` to the dependencies within your application's `Package.swift` file. Substitute `"x.x.x"` with the latest `SwiftyRequest` [release](https://github.com/Kitura/SwiftyRequest/releases).

```swift
.package(url: "https://github.com/IBM-Swift/SwiftyRequest.git", from: "x.x.x")
.package(url: "https://github.com/Kitura/SwiftyRequest.git", from: "x.x.x")
```
Add `SwiftyRequest` to your target's dependencies:

Expand Down Expand Up @@ -132,7 +132,7 @@ request.responseData(queryItems: [URLQueryItem(name: "hour", value: "9")]) { res

## CircuitBreaker Integration

`SwiftyRequest` has built-in functionality for leveraging the [CircuitBreaker](https://github.com/IBM-Swift/CircuitBreaker) library to increase your application's stability. To make use of this functionality, assign a `CircuitParameters` object to the `circuitParameters` property. This object will include a reference to a fallback function that will be invoked when the circuit is failing fast.
`SwiftyRequest` has built-in functionality for leveraging the [CircuitBreaker](https://github.com/Kitura/CircuitBreaker) library to increase your application's stability. To make use of this functionality, assign a `CircuitParameters` object to the `circuitParameters` property. This object will include a reference to a fallback function that will be invoked when the circuit is failing fast.

### Fallback
Here is an example of a fallback closure:
Expand Down Expand Up @@ -221,4 +221,4 @@ We love to talk server-side Swift, and Kitura. Join our [Slack](http://swift-at-

## License

This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/IBM-Swift/SwiftyRequest/blob/master/LICENSE).
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/Kitura/SwiftyRequest/blob/master/LICENSE).
8 changes: 4 additions & 4 deletions TestServer/Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ let package = Package(
name: "TestServer",
dependencies: [
// Dependencies declare other packages that this package depends on.
.package(url: "https://github.com/IBM-Swift/Kitura.git", from: "2.6.0"),
.package(url: "https://github.com/IBM-Swift/FileKit.git", .upToNextMinor(from: "0.0.0")),
.package(url: "https://github.com/IBM-Swift/HeliumLogger.git", from: "1.8.0"),
.package(url: "https://github.com/IBM-Swift/Swift-JWT.git", from: "3.1.0"),
.package(url: "https://github.com/Kitura/Kitura.git", from: "2.9.200"),
.package(url: "https://github.com/Kitura/FileKit.git", .upToNextMinor(from: "0.0.200")),
.package(url: "https://github.com/Kitura/HeliumLogger.git", from: "1.9.200"),
.package(url: "https://github.com/Kitura/Swift-JWT.git", from: "3.6.200"),
],
targets: [
// Targets are the basic building blocks of a package. A target can define a module or a test suite.
Expand Down