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.

Sign up for GitHub

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

Jump to bottom

change: improve read me #124

Merged
merged 2 commits into from
Aug 2, 2022
Merged

change: improve read me #124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9de0393
change: improve read me
stavares843 Aug 1, 2022
dad1967
Merge branch 'master' into change-read-me
stavares843 Aug 1, 2022
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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ let sessionManager = Alamofire.Session(configuration: configuration)

### Register Mocks
##### Create your mocked data
It's recommend to create a class with all your mocked data accessible. An example of this can be found in the unit tests of this project:
It's recommended to create a class with all your mocked data accessible. An example of this can be found in the unit tests of this project:

```swift
public final class MockedData {
Expand Down Expand Up @@ -151,7 +151,7 @@ URLSession.shared.dataTask(with: exampleURL) { (data, response, error) in
```

##### Custom DataType
In addition to the already build in static `DataType` implementations it is possible to create custom ones which will be used as the value to the `Content-Type` header key.
In addition to the already build in static `DataType` implementations it is possible to create custom ones that will be used as the value to the `Content-Type` header key.

```swift
let xmlURL = URL(string: "https://www.wetransfer.com/sample-xml.xml")!
Expand All @@ -167,7 +167,7 @@ URLSession.shared.dataTask(with: xmlURL) { (data, response, error) in


##### Delayed responses
Sometimes you want to test if cancellation of requests is working. In that case, the mocked request should not finish immediately and you need an delay. This can be added easily:
Sometimes you want to test if the cancellation of requests is working. In that case, the mocked request should not finish immediately and you need a delay. This can be added easily:

```swift
let exampleURL = URL(string: "https://www.wetransfer.com/api/endpoint")!
Expand All @@ -181,14 +181,14 @@ mock.register()
```

##### Redirect responses
Sometimes you want to mock short URLs or other redirect URLs. This is possible by saving the response and mock the redirect location, which can be found inside the response:
Sometimes you want to mock short URLs or other redirect URLs. This is possible by saving the response and mocking the redirect location, which can be found inside the response:

```
Date: Tue, 10 Oct 2017 07:28:33 GMT
Location: https://wetransfer.com/redirect
```

By creating a mock for the short URL and the redirect URL, you can mock redirect and test this behaviour:
By creating a mock for the short URL and the redirect URL, you can mock redirect and test this behavior:

```swift
let urlWhichRedirects: URL = URL(string: "https://we.tl/redirect")!
Expand All @@ -197,14 +197,14 @@ Mock(url: URL(string: "https://wetransfer.com/redirect")!, dataType: .json, stat
```

##### Ignoring URLs
As the Mocker catches all URLs by default when registered, you might end up with a `fatalError` thrown in cases you don't need a mocked request. In that case you can ignore the URL:
As the Mocker catches all URLs by default when registered, you might end up with a `fatalError` thrown in cases you don't need a mocked request. In that case, you can ignore the URL:

```swift
let ignoredURL = URL(string: "www.wetransfer.com")!
Mocker.ignore(ignoredURL)
```

However if you need the Mocker to catch only mocked URLs and ignore every other URL, you can set the `mode` attribute to `.optin`.
However, if you need the Mocker to catch only mocked URLs and ignore every other URL, you can set the `mode` attribute to `.optin`.

```swift
Mocker.mode = .optin
Expand Down