Merge pull request #39 from greedo/upload_texttracks

Upload texttracks

Author: sclm

README.md

@@ -93,7 +93,7 @@ video_uri = v.upload('your-filename.mp4')
 
 Once you have an authenticated instance of the `VimeoClient` class, you can also replace the source file of an existing video.
 
-```
+```python
 video_uri = v.replace(
     video_uri='video_uri', 
     filename='your-filename.mp4',
@@ -114,6 +114,18 @@ v.upload_picture('/videos/12345', 'your-image.jpg', activate=True)
 
 Note:  This will make it the active picture for all users this way.  The `activate` keyword argument defaults to `False`, so without it you will need to activate the picture yourself.
 
+### Uploading a text track
+
+Once you have an authenticated instance of the `VimeoClient` class, uploading a text track requires the video uri of the video the text track will be added to, text track type, text track language, and text track filename.
+
+```python
+v = vimeo.VimeoClient(
+    key=YOUR_API_TOKEN,
+    secret=YOUR_TOKEN_SECRET)
+
+v.upload_texttrack('/videos/12345', 'captions', 'en-US', 'your-texttrack.vtt')
+```
+
 # Legacy Python Library
 
 An earlier version of this library used a more complicated ORM syntax.  This library is still available from this github repo via the [orm-tornado](https://github.com/vimeo/vimeo.py/releases/tag/orm-tornado) tag.

vimeo/upload.py

@@ -123,7 +123,33 @@ def upload_picture(self, obj, filename, activate=False):
 
         return picture
 
+class UploadTexttrackMixin(object):
+    """Functionality for uploading a texttrack to Vimeo for a video.
+    """
+    TEXTTRACK_ENDPOINT = '{video_uri}/texttracks'
+
+    def upload_texttrack(self, video_uri, track_type, language, filename):
+        """Upload the texttrack at the given uri with the named source file."""
+        uri = self.TEXTTRACK_ENDPOINT.format(video_uri=video_uri)
+        name = filename.split('/')[-1]
+
+        texttrack = self.post(uri,
+                              data={'type': track_type,
+                                    'language': language,
+                                    'name': name})
+
+        assert texttrack.status_code == 201, \
+            "Failed to create a new texttrack with Vimeo."
+
+        texttrack = texttrack.json()
+
+        with open(filename) as f:
+            upload_resp = self.put(texttrack['link'], data=f)
+        assert upload_resp.status_code == 200, "Failed uploading"
+
+        return texttrack
+
 
-class UploadMixin(UploadVideoMixin, UploadPictureMixin):
+class UploadMixin(UploadVideoMixin, UploadPictureMixin, UploadTexttrackMixin):
     """Handle uploading to the Vimeo API."""
     pass