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

Allow http_build_query() override #66

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

battis
Copy link

@battis battis commented Aug 17, 2015

This seems like the kind of thing that one should never want to do. Unless... you're dealing with a RESTful API that doesn't seem to understand URL parameters that contain numeric indices for the base array. For example:

Instructure Canvas is expecting URL parameters for arrays that do not include numerical indices:

http://canvas-instance.instructure.com/api/v1/courses/123/sections?include[]=students&include[]=enrollments

At the same time http_build_query() is trying to build legal URL parameters, which require that at least the base URL be indexed, resulting in shenanigans like this:

http://canvas-instance.instructure.com/api/v1/courses/123/sections?include%5B0%5D=students&include%5B1%5D=enrollments

Adding in an override-able Pest::http_build_query() method allows for child classes to make necessary tweaks to the URL parameters before sending them to the API. For example:

class CanvasPest extends Pest {

  /* ... */

  protected function http_build_query($data) {
    return preg_replace('/%5B\d+%5B/simU', '[]', http_build_query($data));
  }

  /* ... */

}

This seems like the kind of thing that one should never want to do. Unless... you're dealing with a RESTful API that doesn't seem to understand URL parameters that contain numeric indices for the base array. [For example](smtech/canvaspest#3):

Instructure Canvas is expecting URL parameters for arrays that do not include numerical indices:

```
http://canvas-instance.instructure.com/api/v1/courses/123/sections?include[]=students&include[]=enrollments
```

At the same time [`http_build_query()`](https://github.com/smtech/canvaspest/blob/9110d69f756ff49e8da687381eaee52a767c0389/CanvasPest.php#L108) is trying to build legal URL parameters, which require that at least the base URL be indexed, resulting in shenanigans like this:

```
http://canvas-instance.instructure.com/api/v1/courses/123/sections?include%5B0%5D=students&include%5B1%5D=enrollments
```

It appears, at least, that Canvas tolerates URL-encoded arrays, but not the indices, so a request like this would work, allowing the result of `http_build_query()` to be post-processed [as described here](http://php.net/manual/en/function.http-build-query.php#111819):

```
http://canvas-instance.instructure.com/api/v1/courses/123/sections?include%5B%5D=students&include%5B%5D=enrollments
```
battis pushed a commit to battis/pest that referenced this pull request Aug 17, 2015
To allow the use of this repository without conflicts until/unless [the pull request](educoder#66) is merged into the main repository.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant