sproutvideo-rb 1.6.0 → 1.9.0

data/lib/sproutvideo/analytics.rb

@@ -1,73 +1,97 @@
 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.download_counts(options ={})
+      url = build_path("/stats/downloads", 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.engagement_sessions(video_id, options={})
-      url = "/stats/engagement/#{video_id}/sessions"
+    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.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.popular_downloads(options={})
+      get('/stats/popular_downloads', 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,11 +40,11 @@ module Sproutvideo
           resp = e.response
         end
       end
-      
+
       Response.new(resp)
     end
 
-    def self.get(path, options={})
+    def self.get(path, options = {})
       begin
         resp = RestClient.get(
           "#{base_url}#{path}",
@@ -59,7 +55,7 @@ module Sproutvideo
       Response.new(resp)
     end
 
-    def self.put(path, options={})
+    def self.put(path, options = {})
       body = MultiJson.encode(options.dup)
       begin
         resp = RestClient.put(
@@ -72,15 +68,15 @@ module Sproutvideo
       Response.new(resp)
     end
 
-    def self.delete(path, options={})
+    def self.delete(path, options = {})
       begin
         resp = RestClient.delete(
           "#{base_url}#{path}",
-          {'SproutVideo-Api-Key' => api_key})
+          {'SproutVideo-Api-Key' => api_key, :params => options.dup})
       rescue => e
         resp = e.response
       end
       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

data/lib/sproutvideo/version.rb

@@ -1,3 +1,3 @@
 module Sproutvideo
-	VERSION = "1.6.0"
+	VERSION = "1.9.0"
 end

data/lib/sproutvideo/video.rb

@@ -2,11 +2,11 @@ module Sproutvideo
   class Video < Resource
 
     def self.create(file_path='', options={})
-      upload("/videos", file_path, options)
+      upload("/videos", file_path, options, :source_video)
     end
 
     def self.replace(video_id, file_path='')
-      upload("/videos/#{video_id}/replace", file_path)
+      upload("/videos/#{video_id}/replace", file_path, {}, :source_video)
     end
 
     def self.list(options={})
@@ -27,7 +27,7 @@ module Sproutvideo
     end
 
     def self.upload_poster_frame(video_id, file_path='')
-      upload("/videos/#{video_id}", file_path, {:method => :PUT})
+      upload("/videos/#{video_id}", file_path, {:method => :PUT}, :custom_poster_frame)
     end
 
     def self.destroy(video_id, options={})
@@ -55,12 +55,11 @@ module Sproutvideo
 
       string_to_sign << "#{url_params}"
 
-      digest = OpenSSL::Digest::Digest.new('sha1')
+      digest = OpenSSL::Digest.new('sha1')
       b64_hmac = [OpenSSL::HMAC.digest(digest, Sproutvideo.api_key, string_to_sign)].pack("m").strip
       signature = CGI.escape(b64_hmac)
 
       "#{protocol}://#{host}#{path}?signature=#{signature}#{actual_url_params}"
     end
-
   end
 end

data/lib/sproutvideo.rb

@@ -1,15 +1,19 @@
 require 'multi_json'
 require 'rest_client'
 
-require 'sproutvideo/version.rb'
-require 'sproutvideo/sproutvideo.rb'
-require 'sproutvideo/response.rb'
-require 'sproutvideo/resource.rb'
-require 'sproutvideo/video.rb'
-require 'sproutvideo/tag.rb'
-require 'sproutvideo/playlist.rb'
-require 'sproutvideo/login.rb'
-require 'sproutvideo/access_grant.rb'
-require 'sproutvideo/analytics.rb'
-require 'sproutvideo/upload_token.rb'
-require 'sproutvideo/account.rb'
+require_relative 'sproutvideo/version.rb'
+require_relative 'sproutvideo/sproutvideo.rb'
+require_relative 'sproutvideo/response.rb'
+require_relative 'sproutvideo/resource.rb'
+require_relative 'sproutvideo/video.rb'
+require_relative 'sproutvideo/tag.rb'
+require_relative 'sproutvideo/playlist.rb'
+require_relative 'sproutvideo/login.rb'
+require_relative 'sproutvideo/access_grant.rb'
+require_relative 'sproutvideo/analytics.rb'
+require_relative 'sproutvideo/upload_token.rb'
+require_relative 'sproutvideo/account.rb'
+require_relative 'sproutvideo/folder.rb'
+require_relative 'sproutvideo/subtitle.rb'
+require_relative 'sproutvideo/call_to_action.rb'
+require_relative 'sproutvideo/live_stream.rb'

data/spec/sproutvideo/access_grant_spec.rb

@@ -13,7 +13,7 @@ describe Sproutvideo::AccessGrant do
 		end
 
 		it "should POST the correct url and return a response" do
-			data = {:email => 'test@example.com', :password => 'password'}
+			data = {:video_id => 'video_id', :login_d => 'login_id'}
 			RestClient.should_receive(:post).with(
 				@url,
 				MultiJson.encode(data),
@@ -71,7 +71,7 @@ describe Sproutvideo::AccessGrant do
 		end
 
 		it "should PUT the correct url and return a response" do
-			data = {:password => 'new password'}
+			data = {:allowed_plays => 10}
 
 			RestClient.should_receive(:put).with(
 				@url,
@@ -91,9 +91,20 @@ describe Sproutvideo::AccessGrant do
 		it "should DELETE the correct url and return a response" do
 			RestClient.should_receive(:delete).with(
 				@url,
-				{'SproutVideo-Api-Key' => @api_key}).and_return(@msg)
+				{'SproutVideo-Api-Key' => @api_key, :params=> {}}).and_return(@msg)
 			Sproutvideo::AccessGrant.destroy(@access_grant_id).class.should == Sproutvideo::Response
 		end
 	end
 
+	describe "#bulk_create" do
+		it "should POST the correct url and return a response" do
+			data = [{:video_id => 'video_id', :login_id => 'login_id_1'}, {:video_id => 'video_id', :login_id => 'login_id_2'}]
+			RestClient.should_receive(:post).with(
+				"#{Sproutvideo.base_url}/access_grants/bulk",
+				MultiJson.encode(data),
+				{'SproutVideo-Api-Key' => @api_key}).and_return(@msg)
+			Sproutvideo::AccessGrant.bulk_create(data).class.should == Sproutvideo::Response
+		end
+	end
+
 end