sproutvideo-rb 1.4.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ad6ec3d979542688f34704208ee14efe6277ab39
-  data.tar.gz: d4f44469b318a69eff65a48095182a0d693ff6f6
+SHA256:
+  metadata.gz: 8e13ddf68bf70448163cde8c0045b976926a0ed9927ce24b77fe33cd895f146f
+  data.tar.gz: 985a727c9bc400dbe0844496648d659d03c40d44816ee67aecd0c9d088e9b1f3
 SHA512:
-  metadata.gz: c646c646866c5b578e2ed0bb75c1dde52f1c93c93e5dd072630e55554eebb9619cb38196f02113fb5d9e09266570049169113f5dd7bbecf17f348dc34f13a3a5
-  data.tar.gz: fb781161700df5e73725efd22b3fd4539fffc4700ee1c3525946e7fa688ac2a7b9745df0c7da8987ec088537b7240eaa71133ff1436a09de008e75e9e6d0faf0
+  metadata.gz: b31337a738156031080f321fb5642ee55cefea66b3f1db8248d905599d88bbd0e0206e3bfa57df67960f184729ee0fa5e1187aa34b2996e9fcba6e19bfbe98ae
+  data.tar.gz: '050186fd9d93ac3f392297e7ed3ad106126a1b99a713dddd4b135654b36324e7672383edc268ae35f56452742b2a824654ad3ae06d0382007e69f444cdab1b60'

data/Gemfile

@@ -1,11 +1,9 @@
 source "http://rubygems.org"
-
 gem "rest-client"
+gem 'json', '~> 2.3.0'
 gem "multi_json"
 
 group :development do
   gem "rspec", "~> 2.8.0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler"
-  gem "jeweler", "~> 1.8.3"
+  gem "rdoc", "~> 6.3.1"
 end

data/Gemfile.lock

@@ -2,20 +2,23 @@ GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.3)
-    git (1.2.5)
-    jeweler (1.8.3)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.6.5)
-    mime-types (1.19)
-    multi_json (1.0.4)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rest-client (1.6.1)
-      mime-types (>= 1.16)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (2.3.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    multi_json (1.14.1)
+    netrc (0.11.0)
+    rdoc (6.3.1)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -24,14 +27,19 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
-  jeweler (~> 1.8.3)
+  json (~> 2.3.0)
   multi_json
-  rdoc (~> 3.12)
+  rdoc (~> 6.3.1)
   rest-client
   rspec (~> 2.8.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 SproutVideo
+Copyright (c) 2020 SproutVideo
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,4 +1,4 @@
-#SproutVideo
+# SproutVideo
 Use this gem to interact with the [SproutVideo API](http://sproutvideo.com/docs/api.html)
 
 # Getting Started
@@ -22,7 +22,7 @@ ENV['SPROUTVIDEO_API_KEY'] = 'abcd1234'
 # Videos
 The following methods are available: `list`, `create`, `details`, `update`, `upload_poster_frame`,`destroy`.
 
-##list
+## list
 By default the videos listing is paginated with 25 videos per page and sorted by upload date in ascending order.
 You can pass two parameters to control the paging: `page` and `per_page`.
 
@@ -53,14 +53,14 @@ Sproutvideo::Video.list(:state => "processing")
 Values of `privacy` is listed at [Video Privacy](http://sproutvideo.com/docs/api.html#VideoPrivacy) section.
 Values of `state` is listed at [Video States](http://sproutvideo.com/docs/api.html#VideoStates) section.
 
-##details
+## details
 The string passed to details is the ID of a SproutVideo video.
 
 ```ruby
 Sproutvideo::Video.details('abc123')
 ```
 
-##create
+## create
 The most basic upload you can perform is to just pass the path to the video file to the method. The title of the video will default to the name of the file.
 
 ```ruby
@@ -83,6 +83,13 @@ Sproutvideo::Video.create('/path/to/video.mp4',
   :tags => ['ec61', 'abc123'])
 ```
 
+You can also create or add tags on the fly by passing in tag names:
+
+```ruby
+Sproutvideo::Video.create('/path/to/video.mp4',
+  :tag_names => ['Tag One', 'Tag Two'])
+```
+
 You can also specify a webhook url. We'll send an HTTP POST with the video json when the video has finished processing or if there was an error during processing:
 
 ```ruby
@@ -90,14 +97,21 @@ Sproutvideo::Video.create('/path/to/video.mp4',
   :notification_url => 'http://example.com/webhook_url')
 ```
 
-##update
+## update
  The first parameter is the id of the video you wish to edit. The second parameter is a hash of attributes to update on the video.
 
 ```ruby
 Sproutvideo::Video.update('abc123', :title => 'Updated Title')
 ```
 
-## Tags
+## Replace a video
+The first parameter is the id of the video you wish to replace. The second parameter is the local path to the video file.
+
+```ruby
+Sproutvideo::Video.replace('abc123', '/path/to/video.mp4')
+```
+
+## Dealing with tags
 To add a tag to a video, make sure to include all of the tags currently associated with the video. For instance if the video already has tags with the ids "abc" and "123" and you want to add a tag with the id "def" do pass "abc", "123" and "def" to the update method.
 
 ```ruby
@@ -117,25 +131,25 @@ You can remove all of the tags from a video by just passing an empty array as th
 ```ruby
 Sproutvideo::Video.update('abc123', :tags => [])
 ```
-##Upload poster frame
+## Upload poster frame
 You can upload a custom poster frame for a video by calling the upload_poster_frame method. The first parameter is the id of the video for wish you'd like the poster frame to be associated and the second parameter is the path to the image file.
 
 ```ruby
-SproutVideo::Video.upload_poster_frame('abc123', '/path/to/image.jpg')
+Sproutvideo::Video.upload_poster_frame('abc123', '/path/to/image.jpg')
 ```
 
-##destroy
+## destroy
 Pass in the id of the video you wish to delete.
 
 ```ruby
 Sproutvideo::Video.destroy('abc123')
 ```
 
-##Signed Embed Codes
+## Signed Embed Codes
 You can use this convenience method to sign an embed code. It will return the embed code URL which can be used to build an iframe embed code.
 `Sproutvideo::Video.signed_embed_code(video_id, security_token, query_parameters, expiration_time, protocol)`
 
-###Parameters
+### Parameters
 video_id - _String_ (_Required_)
 : The id of the video for which you're generating the signed embed code
 
@@ -151,19 +165,28 @@ expiration_time - _Integer_ (_Optional_)
 protocol - _String_ (_Optional_)
 : `http` or `https`. Defaults to `http`
 
-###Examples
+### Examples
 ```ruby
 Sproutvideo::Video.signed_embed_code('abc123','def456') #sign a base embed code with no other options
 Sproutvideo::Video.signed_embed_code('abc123','def456', {'type' => 'hd'}) #set parameters for the embed code such as changing the default video type to HD
 Sproutvideo::Video.signed_embed_code('abc123','def456', {}, 1368127991) #set a specific expiration time for the signed embed code. (By default the expiration time is set to 5 minutes from the time the signed embed code was generated).
 Sproutvideo::Video.signed_embed_code('abc123','def456', {}, nil, 'https') #Use https instead of http
 ```
+# Upload Tokens
+The following methods are available: `create`
+
+## Create
+```ruby
+Sproutvideo::UploadToken.create
+Sproutvideo::UploadToken.create(:return_url => 'http://example.com')
+Sproutvideo::UploadToken.create(:return_url => 'http://example.com', :seconds_valid => 3600)
+```
 
 # Tags
 The following methods are available: `list`, `create`, `details`, `update`, `destroy`.
 
-##list
-By default the tag listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page. 
+## list
+By default the tag listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
 
 ```ruby
 Sproutvideo::Tag.list
@@ -171,28 +194,70 @@ Sproutvideo::Tag.list(:per_page => 10)
 Sproutvideo::Tag.list(:per_page => 10, :page => 2)
 ```
 
-##create
-    
+## create
+
 ```ruby
 Sproutvideo::Tag.create(:name => 'new tag')
 ```
 
-##update
+## update
 ```ruby
 Sproutvideo::Tag.update('abc123', :name => 'updated tag name')
 ```
 
-##destroy
+## destroy
 Pass in the id of the tag you wish to delete.
 
 ```ruby
 Sproutvideo::Tag.destroy('abc123')
 ```
+# Folders
+The following methods are available: `list`, `create`, `details`, `update`, `destroy`.
+## list
+By default, the folder listing is paginated with 25 folders per page and sorted by `created_at` date in ascending order. You can pass tow parameters to control the paging: `page` and `per_page`. If you do not pass in a `parent_id` only the folders within the root folder will be returned. To get the folders in a specific folder, make sure to pass in that folder's id using the `parent_id` parameter.
+```ruby
+Sproutvideo::Folder.list
+Sproutvideo::Folder.last(:per_page => 10)
+Sproutvideo::Folder.last(:per_page => 10, :page => 2)
+Sproutvideo::Folder.last(:parent_id => 'def456')
+```
+
+## create
+Creating a folder without a `parent_id` will place that folder in the root folder. Passing in a `parent_id` will place the newly created folder in the folder specified by `parent_id`.
+
+```ruby
+# folder is created in the root folder.
+Sproutvideo::Folder.create(:name => 'New Folder')
+
+# folder is created as a child of the folder specified by the id 'def456'
+Sproutvideo::Folder.create(:name => 'New Folder', :parent_id => 'def456')
+```
+
+## details
+```ruby
+Sproutvideo::Folder.details('def456')
+```
+
+## update
+```ruby
+Sproutvideo::Folder.update('def456', :name => 'New Folder Name')
+```
+
+## delete
+By default, when deleting a folder, all of the contents of that folder (videos and folders), will be moved the root folder to prevent unintended data loss. If you wish to actually delete all of the content of a folder, make sure to pass in `delete_all` as true.
+
+```ruby
+# delete the folder and move it's contents to the root folder
+Sproutvideo::Folder.destroy('def456')
+
+# delete the folder and everything in it.
+Sproutvideo::Folder.destroy('def456', :delete_all => true)
+```
 
 # Playlists
 The following methods are available: `list`, `create`, `details`, `update`, `destroy`.
-##list
-By default the playlist listing is paginated with 25 playlists per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page. 
+## list
+By default the playlist listing is paginated with 25 playlists per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
 
 ```ruby
 Sproutvideo::Playlist.list
@@ -200,7 +265,7 @@ Sproutvideo::Playlist.list(:per_page => 10)
 Sproutvideo::Playlist.list(:per_page => 10, :page => 2)
 ```
 
-##create
+## create
 You can add videos to a playlist when creating it by passing in the videos you'd like to add in the videos parameter in the order you'd like them to appear.
 
 ```ruby
@@ -209,7 +274,7 @@ Sproutvideo::Playlist.create(
   :privacy => 2,
   :videos => ['abc123','def456','ghi789'])
 ```
-##update
+## update
 
 ```ruby
 Sproutvideo::Playlist.update('abc123',
@@ -236,7 +301,7 @@ You can remove all of the videos from a playlist by just passing an empty array
 Sproutvideo::Playlist.update('abc123', :videos => [])
 ```
 
-##destroy
+## destroy
 Pass in the id of the playlist you wish to delete.
 
 ```ruby
@@ -257,7 +322,7 @@ Sproutvideo::Login.list(:per_page => 10, :page => 2)
 
 ## create
 Create takes two required parameters, `email` and `password`, which will be used to allow a viewer to login to watch a video if the login has an assocaited `access_grant` for that video.
-    
+
 ```ruby
 Sproutvideo::Login.create(
   :email => 'test@example.com',
@@ -276,7 +341,7 @@ Sproutvideo::Login.details('abc123')
 You can change the password for a login.
 
 ```ruby
-Sproutvideo::Login.update('abc123', 
+Sproutvideo::Login.update('abc123',
   :password => 'newpassword')
 ```
 
@@ -286,6 +351,7 @@ Pass in the id of the login you wish to delete.
 ```ruby
 Sproutvideo::Login.destroy('asdf1234')
 ```
+
 # Access Grants
 The following methods are available: `list`, `create`, `details`, `update`, `destroy`
 
@@ -300,12 +366,26 @@ Sproutvideo::AccessGrant.list(:per_page => 10, :page => 2)
 
 ## create
 Create takes two required parameters, `video_id` and `login_id`, which will be used to allow a viewer to login to watch a video based on the other optional parameters.
-    
+
 ```ruby
 Sproutvideo::AccessGrant.create(
   :video_id => 'abc123',
   :login_id => 'abc123')
 ```
+## bulk_create
+bulk_create takes an array of access grant objects and creates them in a single API call to efficiently create access grants in bulk and reduce the number of API calls needed.
+
+```ruby
+Sproutvideo::AccessGrant.bulk_create([
+  {
+    :video_id => 'abc123',
+    :login_id => 'abc123'
+  },{
+    :video_id => 'def456',
+    :login_id => 'def456'
+  }
+])
+```
 
 ## details
 The string passed to details is the ID of a SproutVideo login.
@@ -319,12 +399,12 @@ Sproutvideo::AccessGrant.details('abc123')
 You can change the optional parameters for an access grant.
 
 ```ruby
-Sproutvideo::AccessGrant.update('abc123', 
+Sproutvideo::AccessGrant.update('abc123',
   :allowed_plays => 20,
   :access_ends_at => DateTime.parse('8/4/2014'))
 ```
 
-## destory
+## destroy
 Pass in the id of the access grant you wish to delete.
 
 ```ruby
@@ -346,7 +426,7 @@ Each method can be called on it's own for overall account data for all time like
 ```ruby
 Sproutvideo::Analytics.play_counts
 Sproutvideo::Analytics.domains
-SproutVideo::Analytics.geo
+Sproutvideo::Analytics.geo
 Sproutvideo::Analytics.video_types
 Sproutvideo::Analytics.playback_types
 Sproutvideo::Analytics.device_types
@@ -355,41 +435,249 @@ Each method can also take an options hash containing a :video_id for retrieving
 ```ruby
 Sproutvideo::Analytics.play_counts(:video_id => 'abc123')
 Sproutvideo::Analytics.domains(:video_id => 'abc123')
-SproutVideo::Analytics.geo(:video_id => 'abc123')
+Sproutvideo::Analytics.geo(:video_id => 'abc123')
 Sproutvideo::Analytics.video_types(:video_id => 'abc123')
 Sproutvideo::Analytics.playback_types(:video_id => 'abc123')
 Sproutvideo::Analytics.device_types(:video_id => 'abc123')
 ```
+The following methods can also take an options hash containing a :live_stream_id for retrieving overall data for a specific live_stream:
+```ruby
+Sproutvideo::Analytics.play_counts(:live_stream_id => 'abc123')
+Sproutvideo::Analytics.domains(:live_stream_id => 'abc123')
+Sproutvideo::Analytics.geo(:live_stream_id => 'abc123')
+Sproutvideo::Analytics.device_types(:live_stream_id => 'abc123')
+```
 Each method can also take an optional :start_date and :end_date to specify a date range for the returned data:
 ```ruby
 Sproutvideo::Analytics.play_counts(:start_date => '2013-01-01')
 Sproutvideo::Analytics.device_types(:video_id => 'abc123', :end_date => '2012-12-31')
 ```
 
-Lastly, the geo method can take an optional :country to retrieve playback data by city within that country
+The geo method can take an optional :country to retrieve playback data by city within that country
 ```ruby
 Sproutvideo::Analytics.geo(:video_id => 'abc123', :country => 'US')
 ```
 
-#Engagement
+## Misc endpoints
+see api docs for more info
+
+```ruby
+Sproutvideo::Analytics.popular_videos
+```
+
+```ruby
+Sproutvideo::Analytics.live_stream_overview('abc123')
+```
+
+# Engagement
 You can grab the total number of seconds of your videos that have been watched like this:
 ```ruby
 Sproutvideo::Analytics.engagement
 ```
 
+and for all livestreams:
+```ruby
+Sproutvideo::Analytics.live_stream_engagement
+```
+
 You can grab engagement for a specific video like so:
 ```ruby
 Sproutvideo::Analytics.engagement(:video_id => 'abc123')
 ```
 
+or for a specific live stream:
+```ruby
+Sproutvideo::Analytics.live_stream_engagement(:live_stream_id => 'abc123')
+```
+
+You can grab playback sessions data for your videos with:
+```ruby
+Sproutvideo::Analytics.engagement_sessions
+```
+
+and for live streams with
+```ruby
+Sproutvideo::Analytics.live_stream_engagement_sessions
+```
+
 Lastly, you can grab every single playback session for a video like this:
 ```ruby
 Sproutvideo::Analytics.engagement_sessions('abc123')
-Sproutvideo::Analytics.engagement_sessions('abc123', :page => 3)
-Sproutvideo::Analytics.engagement_sessions('abc123', :page => 3, :per_page => 40)
+Sproutvideo::Analytics.engagement_sessions('abc123', page: 3)
+Sproutvideo::Analytics.engagement_sessions('abc123', page: 3, :per_page => 40)
+```
+
+and for a live stream:
+```ruby
+Sproutvideo::Analytics.live_stream_engagement_sessions('abc123')
+```
+
+You can also grab engagement sessions for a video for a specific email address like so:
+```ruby
+Sproutvideo::Analytics.engagement_sessions(video_id: 'abc123', vemail: 'test@example.com')
+```
+
+# Account
+The following methods are available: `details`, `update`.
+
+## details
+To get information about your account:
+
+```ruby
+Sproutvideo::Account.details
+```
+
+## update
+To update account settings:
+
+```ruby
+Sproutvideo::Account.update({download_sd: true})
+```
+
+# Subtitles
+The following methods are available: `list`, `create`, `details`, `update`, `destroy`. All requests for a subtitle must be given a `video_id` option indicating the video that you want to access or update the subtitles of.
+
+## list
+By default the subtitle listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
+
+```ruby
+Sproutvideo::Subtitle.list(:video_id => 'abc123')
+Sproutvideo::Subtitle.list(:video_id => 'abc123', :per_page => 10)
+Sproutvideo::Subtitle.list(:video_id => 'abc123', :per_page => 10, :page => 2)
+```
+
+## create
+Create takes three required parameters, `video_id`, `language`, and `content`, which will be to add the newly created subtitle file and associate it with the provided video id.
+
+```ruby
+Sproutvideo::Subtitle.create(
+  :video_id => 'abc123',
+  :language => 'en',
+  :content => 'WEBVTT FILE...')
+```
+
+## details
+pass both the video and the subtitle id.
+
+```ruby
+Sproutvideo::Subtitle.details(:video_id => 'abc123', id: 'fdc432')
+```
+
+## update
+
+You can change the optional parameters for a subtitle.
+
+```ruby
+Sproutvideo::Subtitle.create(
+  :video_id => 'abc123',
+  :language => 'de',
+  :id => 'fdc432')
+```
+
+## destroy
+Pass in the id of the subtitle you wish to delete.
+
+```ruby
+Sproutvideo::Subtitle.destroy(:video_id => 'abc123', id: 'fdc432')
+```
+
+# Calls to Action
+The following methods are available: `list`, `create`, `details`, `update`, `destroy`. All requests for a call to action must be given a `video_id` option indicating the video that you want to access or update the calls to action of.
+
+## list
+By default the call to action listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
+
+```ruby
+Sproutvideo::CallToAction.list(:video_id => 'abc123')
+Sproutvideo::CallToAction.list(:video_id => 'abc123', :per_page => 10)
+Sproutvideo::CallToAction.list(:video_id => 'abc123', :per_page => 10, :page => 2)
+```
+
+## create
+Create takes five required parameters, `video_id`, `text`, `url`, `start_time`, and `end_time`, which will be to add the newly created subtitle file and associate it with the provided video id.
+
+```ruby
+Sproutvideo::CallToAction.create(
+  :video_id => 'abc123',
+  :text => 'join now',
+  :start_time => 1,
+  :end_time => 2,
+  :content => 'https://sproutvideo.com')
+```
+
+## details
+pass both the video and the call to action id.
+
+```ruby
+Sproutvideo::CallToAction.details(:video_id => 'abc123', id: 'fdc432')
+```
+
+## update
+
+You can change the optional parameters for a call to action.
+
+```ruby
+Sproutvideo::CallToAction.create(
+  :video_id => 'abc123',
+  :text => 'get it done!',
+  :id => 'fdc432')
+```
+
+## destroy
+Pass in the id of the call to action you wish to delete.
+
+```ruby
+Sproutvideo::CallToAction.destroy(:video_id => 'abc123', id: 'fdc432')
+```
+
+# Live Streams
+The following methods are available: `list`, `create`, `details`, `update`, `destroy`, and `end_stream`.
+
+## list
+By default the call to action listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
+
+```ruby
+Sproutvideo::LiveStream.list
+Sproutvideo::LiveStream.list(:per_page => 10, :page => 2)
+```
+
+## create
+
+```ruby
+Sproutvideo::LiveStream.create(title: 'hello')
+# with a poster frame
+Sproutvideo::LiveStream.create(title: 'hello', custom_poster_frame: '/path/to/posterframe.jpg')
+```
+
+## details
+
+```ruby
+Sproutvideo::LiveStream.details('abc123')
+```
+
+## update
+You can change the optional parameters
+
+```ruby
+Sproutvideo::LiveStream.update(title: 'get it done!')
+# with a poster frame
+Sproutvideo::LiveStream.update(title: 'hello', custom_poster_frame: '/path/to/posterframe.jpg')
 ```
+
+## destroy
+
+```ruby
+Sproutvideo::LiveStream.destroy('abc123')
+```
+
+## end_stream
+
+```ruby
+Sproutvideo::LiveStream.end_stream('abc123')
+```
+
 # Contributing to sproutvideo-rb
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
@@ -400,5 +688,5 @@ Sproutvideo::Analytics.engagement_sessions('abc123', :page => 3, :per_page => 40
 
 # Copyright
 
-Copyright (c) 2012 SproutVideo. See LICENSE.txt for
+Copyright (c) 2021 SproutVideo. See LICENSE.txt for
 further details.