Add https proxy support

[ghost]

Hi Scott,

Sorry for the lack of documentation. I have updated the readme.md file with documentation.

reason for the new option:
While being behind a (corporate) proxy I am not able to make direct http requests to browserstack without going through the proxy. In order to achieve this proxy support is desired.

format of the option:

settings {
proxy: "http://host:port"
}

code example:

var client = BrowserStack.createClient({
username: "foo",
password: "p455w0rd!!1",
proxy: "http://myproxy.com:1234"
});

var screenshotClient = BrowserStack.createScreenshotClient({
username: "foo",
password: "p455w0rd!!1",
proxy: "http://myproxy.com:1234"
});

[scottgonzalez]

Thanks. Can you please provide actual documentation for this feature? This requires documenting the reason for the new options, providing the actual format of the option, and providing a legitimate code example (i.e., one that wouldn't cause syntax errors when copied).

[scottgonzalez]

Rename this to just proxy.

[scottgonzalez]

Why is this done in the API layer only?

[kartsims]

This should be copy-pastable code and the parenthesis would throw a syntax exception... I'd suggest replacing it by

proxy: "http://myproxy.com:1234" // proxy configuration is optional

Or even not stating it at all in the docs' examples, I guess it is not such a common use case.

[scottgonzalez]

I'd say the option should be documented, but should not be used in the sample code.

This is similar to the host option in my wordpress module. It's documented in createClient(), but not shown in the usage example.

[kartsims]

Hi Teun,

I did a quick code review (no testing) and left a couple comments. I was wondering if you think this implementation could be adapted to the other APIs ? It seems quite generic so why not use it for Automate and REST APIs ..?

I can help with that if needed 😄

[kartsims]

PR #45 is more up-to-date