Https stream

CHANGELOG.md

@@ -4,6 +4,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [1.1.0] - 2016-05-16
+### Added
+SSL support for streaming. Requires the SSL module, which was backported in
+Python v2.7.9, via chunked_requests submodule.
+
 ## [1.9.11] - 2016-05-02
 ### Added
 - The FigureFactory can now create scatter plot matrices with `.create_scatterplotmatrix`. Check it out with:

plotly/plotly/plotly.py

@@ -27,6 +27,7 @@
 import six.moves
 
 from requests.auth import HTTPBasicAuth
+from urlparse import urlparse
 
 from plotly import exceptions, tools, utils, version, files
 from plotly.plotly import chunked_requests
@@ -439,6 +440,9 @@ class Stream:
 
     """
 
+    HTTP_PORT = 80
+    HTTPS_PORT = 443
+
     @utils.template_doc(**tools.get_config_file())
     def __init__(self, stream_id):
         """
@@ -454,6 +458,29 @@ def __init__(self, stream_id):
         self.connected = False
         self._stream = None
 
+    def get_streaming_specs(self):
+        """
+        Returns the streaming server, port, ssl_enabled flag, and headers.
+
+        """
+        streaming_url = get_config()['plotly_streaming_domain']
+        ssl_enabled = 'https' in streaming_url
+        port = self.HTTPS_PORT if ssl_enabled else self.HTTP_PORT
+
+        # If no scheme (https/https) is included in the streaming_url, the
+        # host will be None. Use streaming_url in this case.
+        host = urlparse(streaming_url).hostname or streaming_url
+
+        headers = {'Host': host, 'plotly-streamtoken': self.stream_id}
+        streaming_specs = {
+            'server': host,
+            'port': port,
+            'ssl_enabled': ssl_enabled,
+            'headers': headers
+        }
+
+        return streaming_specs
+
     def heartbeat(self, reconnect_on=(200, '', 408)):
         """
         Keep stream alive. Streams will close after ~1 min of inactivity.
@@ -481,10 +508,8 @@ def open(self):
         https://plot.ly/python/streaming/
 
         """
-        streaming_url = get_config()['plotly_streaming_domain']
-        self._stream = chunked_requests.Stream(
-            streaming_url, 80, {'Host': streaming_url,
-                                'plotly-streamtoken': self.stream_id})
+        streaming_specs = self.get_streaming_specs()
+        self._stream = chunked_requests.Stream(**streaming_specs)
 
     def write(self, trace, layout=None, validate=True,
               reconnect_on=(200, '', 408)):

plotly/tests/test_core/test_stream/test_stream.py

@@ -10,7 +10,7 @@
 import time
 
 from nose.plugins.attrib import attr
-from nose.tools import raises
+from nose.tools import raises, eq_
 
 import plotly.plotly as py
 from plotly.graph_objs import (Layout, Scatter, Stream)
@@ -123,3 +123,63 @@ def test_stream_unstreamable():
     my_stream.open()
     my_stream.write(Scatter(x=1, y=10, name='nope'))
     my_stream.close()
+
+
+def test_stream_no_scheme():
+
+    # If no scheme is used in the plotly_streaming_domain, port 80
+    # should be used for streaming and ssl_enabled should be False
+
+    py.sign_in(un, ak, **{'plotly_streaming_domain': 'stream.plot.ly'})
+    my_stream = py.Stream(tk)
+    expected_streaming_specs = {
+        'server': 'stream.plot.ly',
+        'port': 80,
+        'ssl_enabled': False,
+        'headers': {
+            'Host': 'stream.plot.ly',
+            'plotly-streamtoken': tk
+        }
+    }
+    actual_streaming_specs = my_stream.get_streaming_specs()
+    eq_(expected_streaming_specs, actual_streaming_specs)
+
+
+def test_stream_http():
+
+    # If the http scheme is used in the plotly_streaming_domain, port 80
+    # should be used for streaming and ssl_enabled should be False
+
+    py.sign_in(un, ak, **{'plotly_streaming_domain': 'http://stream.plot.ly'})
+    my_stream = py.Stream(tk)
+    expected_streaming_specs = {
+        'server': 'stream.plot.ly',
+        'port': 80,
+        'ssl_enabled': False,
+        'headers': {
+            'Host': 'stream.plot.ly',
+            'plotly-streamtoken': tk
+        }
+    }
+    actual_streaming_specs = my_stream.get_streaming_specs()
+    eq_(expected_streaming_specs, actual_streaming_specs)
+
+
+def test_stream_https():
+
+    # If the https scheme is used in the plotly_streaming_domain, port 443
+    # should be used for streaming and ssl_enabled should be True
+
+    py.sign_in(un, ak, **{'plotly_streaming_domain': 'https://stream.plot.ly'})
+    my_stream = py.Stream(tk)
+    expected_streaming_specs = {
+        'server': 'stream.plot.ly',
+        'port': 443,
+        'ssl_enabled': True,
+        'headers': {
+            'Host': 'stream.plot.ly',
+            'plotly-streamtoken': tk
+        }
+    }
+    actual_streaming_specs = my_stream.get_streaming_specs()
+    eq_(expected_streaming_specs, actual_streaming_specs)

plotly/version.py

@@ -1,2 +1,2 @@
-__version__ = '1.9.11'
+__version__ = '1.10.0'