Adding a Wildcard URL Matcher

[groomsy]

I am using a Hypermedia API adhering to the Siren specification. Every response should be the same object type. Therefore, I need an any URL wildcard for modelClassesByResourcePath. I have decided to use the ** identifier.

[sodastsai]

Hi @groomsy, so in your case, the modelClassesByResourcePath method would be implemented like

+ (NSDictionary *)modelClassesByResourcePath {
    return @{
        @"statuses/*": [Tweet class],
        @"users/*": [TwitterUser class],
        @"friends/ids.json": [UserIdentifierCollection class],
        @"followers/ids.json": [UserIdentifierCollection class],
        @"**": [AnyOtherModel class],
    };
}

, right?

[groomsy]

@sodastsai It's been a while since I've looked at this, but if memory serves me correctly, I wanted to have a root wildcard for only one model. So any endpoint, one class. I'm not sure if your example would work (I didn't have it in mind when I opened this PR).

[sodastsai]

okay. your original idea would be

+ (NSDictionary *)modelClassesByResourcePath {
    return @{
        @"**": [TheModel class],
    };
}

so, all the response processed by OVCHTTPSessionManager or OVCHTTPRequestOperationManager will be serialized into TheModel objects.

and my comment extends above idea, the ** works like a fallback option when the request doesn't match any of previous resource paths.

I just wanna clarify your idea. :)
If my idea is the same as yours (or could fit your requirements), I'd go to check (and extend if necessary) your PR and then merge back.

[groomsy]

That sounds great. It covers my limited need and makes it more extensible for future implementations. 👍

[stefreak]

A while ago I contributed a very simple change to make this possible without a wildcard matcher: #74

sadly, I didn't really bother to document that behaviour somewhere...

[sodastsai]

Merged by 9130140.

@groomsy: Thanks, 👍

@stefreak: your contribution is great. But groomsy's provides a usage like this:

NSDictionary *modelClassesByPath = @{
    @"test/*": [OVCTestModel class],
    @"test2/**": [OVCAlternativeModel class],
};

and the result would be

URL	Model Class
http://example.com/api/v1/test/whatever42	OVCTestModel
http://example.com/api/v1/test/whatever/42	nil
http://example.com/api/v1/test2/whatever42	OVCAlternativeModel
http://example.com/api/v1/test2/whatever/42	OVCAlternativeModel