Moya: How to return a stub from an Endpoint?

Created on 12 Aug 2017 · 18Comments · Source: Moya/Moya

I want to use a custom response when comming from UITests for a specific path.
So basically, when calling a path like "endPointThatShouldReturnAStub404" i want to return 404 and a sampleResponse. Otherwise i want to return regular stubs as you can see here (MoyaProvider<ApiProvider>(stubClosure: MoyaProvider.immediatelyStub)).
So when im passing an argument "CUSTOM_STUB" i want to stub reponses depending on the target.path. How can i do this?

    static func setProvider() -> MoyaProvider<ApiProvider> {
        var provider: MoyaProvider<TWApiProvider> = MoyaProvider<ApiProvider>(stubClosure: MoyaProvider.immediatelyStub)
        if ProcessInfo().arguments.contains("CUSTOM_STUB") {
            let endpointClosure = { (target: ApiProvider) -> Endpoint<ApiProvider> in
                switch target.path {
                case "endPointThatShouldReturnAStub404":
                    return Endpoint<ApiProvider>(url: url(route: target), sampleResponseClosure: {.networkResponse(404, target.sampleData)}, method: target.method, parameters: target.parameters)
                default:  ///endPointThatShouldReturnARegularStub
                    return Endpoint<ApiProvider>(url: url(route: target), sampleResponseClosure: {.networkResponse(200, target.sampleData)}, method: target.method, parameters: target.parameters)
                }
            }
  //  **The problem is here cause im adding a default endpointClosure**
            provider = MoyaProvider<TWApiProvider>(endpointClosure: endpointClosure)
        }
        return provider
    }

question

Source

ivangodfather

Most helpful comment

@ivangodfather The stubClosure argument for the MoyaProvider initializer is a closure that takes in a TargetType and returns StubBehavior. You can pass it a custom closure that switches on the cases of the target and returns the respective stub behavior that you'd like. Is this what you were looking for?

Example:

let stubClosure = { (target: TargetType) -> Moya.StubBehavior in 
    switch target.path {
    case "endPointThatShouldReturnAStub404":
        return .immediate
    default:
        return .never
    }
}

SD10 on 12 Aug 2017

👍4

All 18 comments

Example:

let stubClosure = { (target: TargetType) -> Moya.StubBehavior in 
    switch target.path {
    case "endPointThatShouldReturnAStub404":
        return .immediate
    default:
        return .never
    }
}

SD10 on 12 Aug 2017

👍4

Not exactly.
I want also for the default case continue stubbing. And for "endPointThatShouldReturnAStub404" return a custom stub.

So imagine this situation, you have all your endpoints stubbed and no other requeriment.
You can have something like: var provider: MoyaProvider<TWApiProvider> = MoyaProvider<ApiProvider>(stubClosure: MoyaProvider.immediatelyStub)
This is ok since stubs all your requests with a 200 with a json from sampleData.
Now imagine you want to do a test for a specific endpoint that relies that other still stubbed as before but for this endPoint you want to return a 404 and another json.

So in other words:

let stubClosure = { (target: TargetType) -> Moya.StubBehavior in 
    switch target.path {
    case "endPointThatShouldReturnAStub404":
        return // i want to return a custom stub like 404 and specific json
    default:
        return .immediate
    }
}