sproutvideo-rb 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01c75acda409b9a3a9890c2bd9a4a050bd1d592686521a1390e1727b0572bb1c
-  data.tar.gz: 2d003362ec7390b3f49a6c60850daa1dc0a4b8b60899624b4db1f658f1929cd4
+  metadata.gz: 8e13ddf68bf70448163cde8c0045b976926a0ed9927ce24b77fe33cd895f146f
+  data.tar.gz: 985a727c9bc400dbe0844496648d659d03c40d44816ee67aecd0c9d088e9b1f3
 SHA512:
-  metadata.gz: c32f913ec550dfd97e2b5c6ecb2f3a1eb97369d3591450dbca5b241d35994291abe29f8b64fba751d8da40e1001bb1609859f5f9e57a6c1e4a0e59f3ab0cef0c
-  data.tar.gz: 7b5964b53f2622c9a8754f4baedb7a83ea84807441cbe83cd5e0dc862ea0efa2807b5807b23b385b2a75fafebd4afb711758fd78728afe0b039e9a3877942486
+  metadata.gz: b31337a738156031080f321fb5642ee55cefea66b3f1db8248d905599d88bbd0e0206e3bfa57df67960f184729ee0fa5e1187aa34b2996e9fcba6e19bfbe98ae
+  data.tar.gz: '050186fd9d93ac3f392297e7ed3ad106126a1b99a713dddd4b135654b36324e7672383edc268ae35f56452742b2a824654ad3ae06d0382007e69f444cdab1b60'

data/Gemfile

@@ -1,10 +1,9 @@
 source "http://rubygems.org"
-
-gem "rest-client", '~> 1.8.0'
-gem 'json', '~> 1.8.6'
+gem "rest-client"
+gem 'json', '~> 2.3.0'
 gem "multi_json"
 
 group :development do
   gem "rspec", "~> 2.8.0"
-  gem "rdoc", "~> 3.12.1"
+  gem "rdoc", "~> 6.3.1"
 end

data/Gemfile.lock

@@ -4,18 +4,21 @@ GEM
     diff-lcs (1.1.3)
     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 (1.8.6)
-    mime-types (2.99.3)
+    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 (3.12.2)
-      json (~> 1.4)
-    rest-client (1.8.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, < 3.0)
-      netrc (~> 0.7)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -26,16 +29,16 @@ GEM
     rspec-mocks (2.8.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.7.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  json (~> 1.8.6)
+  json (~> 2.3.0)
   multi_json
-  rdoc (~> 3.12.1)
-  rest-client (~> 1.8.0)
+  rdoc (~> 6.3.1)
+  rest-client
   rspec (~> 2.8.0)
 
 BUNDLED WITH

data/README.markdown

@@ -135,7 +135,7 @@ Sproutvideo::Video.update('abc123', :tags => [])
 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
@@ -248,10 +248,10 @@ By default, when deleting a folder, all of the contents of that folder (videos a
 
 ```ruby
 # delete the folder and move it's contents to the root folder
-Sproutvideo::Folder.delete('def456')
+Sproutvideo::Folder.destroy('def456')
 
 # delete the folder and everything in it.
-Sproutvideo::Folder.delete('def456', :delete_all => true)
+Sproutvideo::Folder.destroy('def456', :delete_all => true)
 ```
 
 # Playlists
@@ -351,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`
 
@@ -425,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
@@ -434,43 +435,86 @@ 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')
 ```
 
+## 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('abc123', :vemail => 'test@example.com')
+Sproutvideo::Analytics.engagement_sessions(video_id: 'abc123', vemail: 'test@example.com')
 ```
 
 # Account
@@ -490,6 +534,148 @@ To update account settings:
 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.
@@ -502,5 +688,5 @@ Sproutvideo::Account.update({download_sd: true})
 
 # Copyright
 
-Copyright (c) 2016 SproutVideo. See LICENSE.txt for
+Copyright (c) 2021 SproutVideo. See LICENSE.txt for
 further details.

data/lib/sproutvideo/access_grant.rb

@@ -26,8 +26,8 @@ module Sproutvideo
 			delete("/access_grants/#{access_grant_id}", options)
 		end
 
-		def self.bulk_create(access_grants, options={})
-			post("/access_grants/bulk", options)
+		def self.bulk_create(access_grants)
+			post("/access_grants/bulk", access_grants)
 		end
 
 	end

data/lib/sproutvideo/analytics.rb

@@ -1,73 +1,88 @@
 module Sproutvideo
   class Analytics < Resource
-    
     def self.play_counts(options={})
-      url = "/stats/counts"
-      if options.include?(:video_id)
-        video_id = options.delete(:video_id)
-        url += "/#{video_id}"
-      end
+      url = build_path("/stats/counts", options)
       get(url, options)
     end
 
     def self.domains(options={})
-      url = "/stats/domains"
-      if options.include?(:video_id)
-        video_id = options.delete(:video_id)
-        url += "/#{video_id}"
-      end
+      url = build_path("/stats/domains", options)
       get(url, options)
     end
 
     def self.geo(options={})
-      url = "/stats/geo"
-      if options.include?(:video_id)
-        video_id = options.delete(:video_id)
-        url += "/#{video_id}"
-      end
+      url = build_path("/stats/geo", options)
       get(url, options)
     end
 
     def self.video_types(options={})
-      url = "/stats/video_types"
-      if options.include?(:video_id)
-        video_id = options.delete(:video_id)
-        url += "/#{video_id}"
-      end
+      url = build_path("/stats/video_types", options)
       get(url, options)
     end
 
     def self.playback_types(options={})
-      url = "/stats/playback_types"
-      if options.include?(:video_id)
-        video_id = options.delete(:video_id)
-        url += "/#{video_id}"
-      end
+      url = build_path("/stats/playback_types", options)
       get(url, options)
     end
 
     def self.device_types(options={})
-      url = "/stats/device_types"
-      if options.include?(:video_id)
-        video_id = options.delete(:video_id)
-        url += "/#{video_id}"
-      end
+      url = build_path("/stats/device_types", options)
       get(url, options)
     end
 
     def self.engagement(options={})
-      url = "/stats/engagement"
-      if options.include?(:video_id)
-        video_id = options.delete(:video_id)
-        url += "/#{video_id}"
+      url = build_path("/stats/engagement", options)
+      get(url, options)
+    end
+
+    def self.engagement_sessions(video_id=nil, options={})
+      if video_id.nil?
+        url = "/stats/engagement/sessions"
+      else
+        url = "/stats/engagement/#{video_id}/sessions"
+      end
+      get(url, options)
+    end
+
+    def self.live_stream_engagement(options={})
+      if options.include?(:live_stream_id)
+        url = build_path("/stats/engagement", options)
+      else
+        url = "/stats/live_streams/engagement"
       end
       get(url, options)
     end
 
-    def self.engagement_sessions(video_id, options={})
-      url = "/stats/engagement/#{video_id}/sessions"
+    def self.live_stream_engagement_sessions(live_stream_id=nil, options={})
+      if live_stream_id.nil?
+        url = "/stats/live_streams/engagement/sessions"
+      else
+        url = "/stats/live_streams/#{live_stream_id}/engagement/sessions"
+      end
       get(url, options)
     end
 
+    def self.popular_videos(options={})
+      get("/stats/popular_videos", options)
+    end
+
+    def self.live_stream_overview(live_stream_id, options={})
+      get("/stats/live_streams/#{live_stream_id}/overview", options)
+    end
+
+    private
+
+    def self.build_path(path, options)
+      if options.include?(:video_id)
+        video_id = options.delete(:video_id)
+        path += "/#{video_id}"
+      end
+      if options.include?(:live_stream_id)
+        video_id = options.delete(:live_stream_id)
+        resource = path.split('/').last
+        path = "/stats/live_streams/#{video_id}/#{resource}"
+      end
+      path
+    end
   end
-end
+end

data/lib/sproutvideo/call_to_action.rb

@@ -0,0 +1,39 @@
+module Sproutvideo
+  class CallToAction < Resource
+    def self.create(options = {})
+      post(build_url(options), options)
+    end
+    
+    def self.list(options = {})
+      url = build_url(options)
+      params = {
+        :page => options.delete(:page) || 1,
+        :per_page => options.delete(:per_page) || 25
+      }
+      params = params.merge(options)
+      get(url, params)
+    end
+
+    def self.details(options = {})
+      get("#{build_url(options)}/#{options[:id]}", options)
+    end
+
+    def self.update(options = {})
+      put("#{build_url(options)}/#{options[:id]}", options)
+    end
+
+    def self.destroy(options = {})
+      delete("#{build_url(options)}/#{options[:id]}", options)
+    end
+    
+    private
+
+    def self.build_url(options)
+      if !options.include?(:video_id)
+        STDERR.puts "The video_id option is required for this endpoint."
+      end
+      video_id = options.delete(:video_id)
+      "/videos/#{video_id}/calls_to_action"
+    end
+  end
+end

data/lib/sproutvideo/folder.rb

@@ -0,0 +1,28 @@
+module Sproutvideo
+  class Folder < Resource
+    def self.create(options = {})
+      post('/folders', options)
+    end
+
+    def self.list(options={})
+      params = {
+        :page => options.delete(:page) || 1,
+        :per_page => options.delete(:per_page) || 25
+      }
+      params = params.merge(options)
+      get('/folders', params)
+    end
+
+    def self.details(folder_id, options = {})
+      get("/folders/#{folder_id}", options)
+    end
+
+    def self.update(folder_id, options = {})
+      put("/folders/#{folder_id}", options)
+    end
+
+    def self.destroy(folder_id, options = {})
+      delete("/folders/#{folder_id}", options)
+    end
+  end
+end

data/lib/sproutvideo/live_stream.rb

@@ -0,0 +1,43 @@
+module Sproutvideo
+  class LiveStream < Resource
+
+    def self.create(options={})
+      if options.include?(:custom_poster_frame)
+        poster_frame = options.delete(:custom_poster_frame)
+        upload("/live_streams", poster_frame, options, :custom_poster_frame)
+      else
+        post("/live_streams", options)
+      end
+    end
+
+    def self.list(options={})
+      params = {
+        :page => options.delete(:page) || 1,
+        :per_page => options.delete(:per_page) || 25
+      }
+      params = params.merge(options)
+      get("/live_streams", params)
+    end
+
+    def self.details(live_stream_id, options={})
+      get("/live_streams/#{live_stream_id}", options)
+    end
+
+    def self.update(live_stream_id, options={})
+      if options.include?(:custom_poster_frame)
+        poster_frame = options.delete(:custom_poster_frame)
+        upload("/live_streams/#{live_stream_id}", poster_frame, options.merge({method: :PUT}), :custom_poster_frame)
+      else
+        put("/live_streams/#{live_stream_id}", options)
+      end
+    end
+
+    def self.destroy(live_stream_id, options={})
+      delete("/live_streams/#{live_stream_id}", options)
+    end
+
+    def self.end_stream(live_stream_id, options={})
+      put("/live_streams/#{live_stream_id}/end_stream", options)
+    end
+  end
+end

data/lib/sproutvideo/resource.rb

@@ -20,18 +20,14 @@ module Sproutvideo
       Response.new(resp)
     end
 
-    def self.upload(path, file_path, options = {})
+    def self.upload(path, file_path, options = {}, field_name)
       resp = nil
-      
+
       method = options.delete(:method) == :PUT ? :PUT : :POST
 
       File.open(file_path) do |file|
-        
-        if method == :POST
-          body = {:source_video => file}.merge(options.dup)
-        else
-          body = {:custom_poster_frame => file}
-        end
+
+        body = { field_name => file }.merge(options.dup)
 
         begin
           resp = RestClient.send(
@@ -44,7 +40,7 @@ module Sproutvideo
           resp = e.response
         end
       end
-      
+
       Response.new(resp)
     end
 
@@ -83,4 +79,4 @@ module Sproutvideo
       Response.new(resp)
     end
   end
-end
+end

data/lib/sproutvideo/subtitle.rb

@@ -0,0 +1,39 @@
+module Sproutvideo
+  class Subtitle < Resource
+    def self.create(options = {})
+      post(build_url(options), options)
+    end
+    
+    def self.list(options = {})
+      url = build_url(options)
+      params = {
+        :page => options.delete(:page) || 1,
+        :per_page => options.delete(:per_page) || 25
+      }
+      params = params.merge(options)
+      get(url, params)
+    end
+
+    def self.details(options = {})
+      get("#{build_url(options)}/#{options[:id]}", options)
+    end
+
+    def self.update(options = {})
+      put("#{build_url(options)}/#{options[:id]}", options)
+    end
+
+    def self.destroy(options = {})
+      delete("#{build_url(options)}/#{options[:id]}", options)
+    end
+    
+    private
+
+    def self.build_url(options)
+      if !options.include?(:video_id)
+        STDERR.puts "The video_id option is required for this endpoint."
+      end
+      video_id = options.delete(:video_id)
+      "/videos/#{video_id}/subtitles"
+    end
+  end
+end