fixup! Add endpoint option

Author: surminus

ably/realtime/realtime.py

@@ -48,10 +48,14 @@ def __init__(self, key: Optional[str] = None, loop: Optional[asyncio.AbstractEve
             You can set this to false and explicitly connect to Ably using the
             connect() method. The default is true.
         **kwargs: client options
+            endpoint: str
+                Endpoint specifies either a routing policy name or fully qualified domain name to connect to Ably.
             realtime_host: str
+                Deprecated: this property is deprecated and will be removed in a future version.
                 Enables a non-default Ably host to be specified for realtime connections.
                 For development environments only. The default value is realtime.ably.io.
             environment: str
+                Deprecated: this property is deprecated and will be removed in a future version.
                 Enables a custom environment to be used with the Ably service. Defaults to `production`
             realtime_request_timeout: float
                 Timeout (in milliseconds) for the wait of acknowledgement for operations performed via a realtime

ably/rest/rest.py

@@ -33,8 +33,14 @@ def __init__(self, key: Optional[str] = None, token: Optional[str] = None,
 
           **Optional Parameters**
           - `client_id`: Undocumented
-          - `rest_host`: The host to connect to. Defaults to rest.ably.io
-          - `environment`: The environment to use. Defaults to 'production'
+          - `endpoint`: Endpoint specifies either a routing policy name or
+            fully qualified domain name to connect to Ably.
+          - `rest_host`: Deprecated: this property is deprecated and will
+            be removed in a future version. The host to connect to.
+            Defaults to rest.ably.io
+          - `environment`: Deprecated: this property is deprecated and
+            will be removed in a future version. The environment to use.
+            Defaults to 'production'
           - `port`: The port to connect to. Defaults to 80
           - `tls_port`: The tls_port to connect to. Defaults to 443
           - `tls`: Specifies whether the client should use TLS. Defaults

ably/transport/defaults.py

@@ -51,13 +51,13 @@ def get_hostname(endpoint):
         if endpoint.startswith("nonprod:"):
             return endpoint[len("nonprod:"):] + ".realtime.ably-nonprod.net"
 
-        if endpoint == "main":
-            return "main.realtime.ably.net"
-
         return endpoint + ".realtime.ably.net"
 
     @staticmethod
     def get_fallback_hosts(endpoint="main"):
+        if "." in endpoint or "::" in endpoint or "localhost" in endpoint:
+            return []
+
         if endpoint.startswith("nonprod:"):
             root = endpoint.replace("nonprod:", "")
             return [

ably/types/options.py

@@ -19,6 +19,10 @@ def __init__(self, client_id=None, log_level=0, tls=True, rest_host=None, realti
 
         super().__init__(**kwargs)
 
+        if endpoint is not None:
+            if environment is not None or rest_host is not None or realtime_host is not None:
+                raise ValueError('endpoint is incompatible with any of environment, rest_host or realtime_host')
+
         # TODO check these defaults
         if fallback_retry_timeout is None:
             fallback_retry_timeout = Defaults.fallback_retry_timeout
@@ -43,16 +47,10 @@ def __init__(self, client_id=None, log_level=0, tls=True, rest_host=None, realti
         if environment is not None and realtime_host is not None:
             raise ValueError('specify realtime_host or environment, not both')
 
-        if environment is not None and endpoint is not None:
-            raise ValueError('specify endpoint or environment, not both')
-
         if idempotent_rest_publishing is None:
             from ably import api_version
             idempotent_rest_publishing = api_version >= '1.2'
 
-        if environment == "production":
-            endpoint = Defaults.endpoint
-
         if environment is not None and endpoint is None:
             endpoint = environment
 
@@ -287,7 +285,7 @@ def __get_rest_hosts(self):
         # Fallback hosts
         fallback_hosts = self.fallback_hosts
         if fallback_hosts is None:
-            if self.rest_host:
+            if self.rest_host is not None:
                 fallback_hosts = []
             else:
                 fallback_hosts = Defaults.get_fallback_hosts(self.endpoint)

test/ably/rest/restinit_test.py

@@ -73,8 +73,8 @@ def test_rest_host_and_environment(self):
         ably = AblyRest(token='foo', rest_host="some.other.host")
         assert "some.other.host" == ably.options.rest_host, "Unexpected host mismatch"
 
-        # environment: production
-        ably = AblyRest(token='foo', environment="production")
+        # environment: main
+        ably = AblyRest(token='foo', environment="main")
         host = ably.options.get_rest_host()
         assert "main.realtime.ably.net" == host, "Unexpected host mismatch %s" % host
 

test/unit/options_test.py

@@ -0,0 +1,62 @@
+import pytest
+
+from ably.types.options import Options
+
+
+def test_options_should_fail_early_with_incompatible_client_options():
+    with pytest.raises(ValueError):
+        Options(endpoint="foo", environment="foo")
+
+    with pytest.raises(ValueError):
+        Options(endpoint="foo", rest_host="foo")
+
+    with pytest.raises(ValueError):
+        Options(endpoint="foo", realtime_host="foo")
+
+
+
+# REC1a
+def test_options_should_return_the_default_hostnames():
+    opts = Options()
+    assert opts.get_realtime_host() == "main.realtime.ably.net"
+    assert "main.a.fallback.ably-realtime.com" in opts.get_fallback_realtime_hosts()
+
+
+# REC1b4
+def test_options_should_return_the_correct_routing_policy_hostnames():
+    opts = Options(endpoint="foo")
+    assert opts.get_realtime_host() == "foo.realtime.ably.net"
+    assert "foo.a.fallback.ably-realtime.com" in opts.get_fallback_realtime_hosts()
+
+
+# REC1b3
+def test_options_should_return_the_correct_nonprod_routing_policy_hostnames():
+    opts = Options(endpoint="nonprod:foo")
+    assert opts.get_realtime_host() == "foo.realtime.ably-nonprod.net"
+    assert "foo.a.fallback.ably-realtime-nonprod.com" in opts.get_fallback_realtime_hosts()
+
+
+# REC1b2
+def test_options_should_return_the_correct_fqdn_hostnames():
+    opts = Options(endpoint="foo.com")
+    assert opts.get_realtime_host() == "foo.com"
+    assert not opts.get_fallback_realtime_hosts()
+
+
+# REC1b2
+def test_options_should_return_an_ipv4_address():
+    opts = Options(endpoint="127.0.0.1")
+    assert opts.get_realtime_host() == "127.0.0.1"
+    assert not opts.get_fallback_realtime_hosts()
+
+
+# REC1b2
+def test_options_should_return_an_ipv6_address():
+    opts = Options(endpoint="::1")
+    assert opts.get_realtime_host() == "::1"
+
+
+# REC1b2
+def test_options_should_return_localhost():
+    opts = Options(endpoint="localhost")
+    assert opts.get_realtime_host() == "localhost"