sproutvideo-rb 1.2.1 → 1.3.0

data/README.markdown

@@ -103,6 +103,16 @@ Pass in the id of the video you wish to delete.
 ```ruby
 Sproutvideo::Video.delete('abc123')
 ```
+
+##Signed Embed Codes
+You can use this convenince method to sign an embed code
+```ruby
+Sproutvideo::Video.signed_embed_code('abc123') #sign a base embed code with no other options
+Sproutvideo::Video.signed_embed_code('abc123', {'type' => 'hd'}) #set parameters for the embed code such as changing the default video type to HD
+Sproutvideo::Video.signed_embed_code('abc123', {}, 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', {}, nil, 'https') #Use https instead of http
+```
+
 # Tags
 The following methods are available: `list`, `create`, `details`, `update`, `delete`.
 
@@ -345,5 +355,4 @@ Sproutvideo::Analytics.engagement_sessions('abc123', :page => 3, :per_page => 40
 # Copyright
 
 Copyright (c) 2012 SproutVideo. See LICENSE.txt for
-further details.
-
+further details.

data/lib/sproutvideo/version.rb

@@ -1,3 +1,3 @@
 module Sproutvideo
-	VERSION = "1.2.1"
+	VERSION = "1.3.0"
 end

data/lib/sproutvideo/video.rb

@@ -25,5 +25,38 @@ module Sproutvideo
     def self.destroy(video_id, options={})
       delete("/videos/#{video_id}", options)
     end
+
+    def self.signed_embed_code(video_id, params={}, expires=nil, protocol='http')
+      #get video
+      resp = get("/videos/#{video_id}")
+      token = resp.body[:security_token]
+      
+      host = 'videos.sproutvideo.com'
+      path = "/embed/#{video_id}/#{token}"
+      string_to_sign = "GET\n"
+      string_to_sign << "#{host}\n"
+      string_to_sign << "#{path}\n"
+      
+      expires = Time.now.to_i + 300 unless expires
+
+      params = params.merge('expires' => expires)
+
+      url_params = ""
+      actual_url_params = ""
+      params.sort_by{|k,_|k}.each do |key, value|
+          value = value.to_s.strip
+          url_params << "&#{key}=#{CGI::unescape(value)}"
+          actual_url_params << "&#{key}=#{value}"
+      end
+
+      string_to_sign << "#{url_params}"
+
+      digest = OpenSSL::Digest::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/spec/sproutvideo/video_spec.rb

@@ -111,4 +111,48 @@ describe Sproutvideo::Video do
 		end
 	end
 
+	describe "#signed_embed_code" do
+		before(:each) do
+			@video_id = 1
+			@url = "#{Sproutvideo.base_url}/videos/#{@video_id}"
+			@msg = mock(:code => 200, :to_s => '{"security_token":"abc123"}')
+			@digest = OpenSSL::Digest::Digest.new('sha1')
+			OpenSSL::Digest::Digest.stub!(:new).and_return(@digest)
+			time = Time.now
+			Time.stub!(:now).and_return(time)
+			@expires_time = time.to_i+300
+			string_to_sign = "GET\nvideos.sproutvideo.com\n/embed/1/abc123\n&expires=#{@expires_time}"
+			@signature = CGI::escape([OpenSSL::HMAC.digest(@digest, @api_key, string_to_sign)].pack("m").strip)
+			RestClient.stub!(:get).and_return(@msg)
+		end
+
+		it "should get the video" do
+			RestClient.should_receive(:get).with(
+				@url,
+				{'SproutVideo-Api-Key' => @api_key, :params => {}}).and_return(@msg)
+			Sproutvideo::Video.signed_embed_code(@video_id)
+		end
+		
+		it "should sign the embed code" do
+			Sproutvideo::Video.signed_embed_code(@video_id).should == "http://videos.sproutvideo.com/embed/1/abc123?signature=#{@signature}&expires=#{@expires_time}"
+		end
+
+		it "should set the expires time if passed in" do
+			expires_time = 1368127991
+			string_to_sign = "GET\nvideos.sproutvideo.com\n/embed/1/abc123\n&expires=#{expires_time}"
+			signature = CGI::escape([OpenSSL::HMAC.digest(@digest, @api_key, string_to_sign)].pack("m").strip)
+			Sproutvideo::Video.signed_embed_code(@video_id, {}, 1368127991).should == "http://videos.sproutvideo.com/embed/1/abc123?signature=#{signature}&expires=#{expires_time}"
+		end
+
+		it "should use the protocol that's passed in" do
+			Sproutvideo::Video.signed_embed_code(@video_id, {}, nil, 'https').should == "https://videos.sproutvideo.com/embed/1/abc123?signature=#{@signature}&expires=#{@expires_time}"
+		end
+
+		it "should sign other parameters too!" do
+			string_to_sign = "GET\nvideos.sproutvideo.com\n/embed/1/abc123\n&expires=#{@expires_time}&type=hd"
+			@signature = CGI::escape([OpenSSL::HMAC.digest(@digest, @api_key, string_to_sign)].pack("m").strip)
+			Sproutvideo::Video.signed_embed_code(@video_id, {'type' => 'hd'}).should == "http://videos.sproutvideo.com/embed/1/abc123?signature=#{@signature}&expires=#{@expires_time}&type=hd"
+		end
+	end
+
 end

data/sproutvideo-rb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "sproutvideo-rb"
-  s.version = "1.2.1"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["SproutVideo"]
-  s.date = "2013-01-24"
+  s.date = "2013-05-08"
   s.description = "SproutVideo API Client"
   s.email = "support@sproutvideo.com"
   s.extra_rdoc_files = [
@@ -49,7 +49,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/sproutvideo/sproutvideo-rb"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.25"
   s.summary = "SproutVideo API Client"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sproutvideo-rb
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 1
-  - 2
-  - 1
-  version: 1.2.1
+  - 3
+  - 0
+  version: 1.3.0
 platform: ruby
 authors: 
 - SproutVideo
@@ -15,9 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-01-24 00:00:00 Z
+date: 2013-05-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -27,11 +29,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
   type: :runtime
-  name: rest-client
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -41,11 +43,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
   type: :runtime
-  name: multi_json
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -57,11 +59,11 @@ dependencies:
         - 8
         - 0
         version: 2.8.0
-  prerelease: false
   type: :development
-  name: rspec
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -72,11 +74,11 @@ dependencies:
         - 3
         - 12
         version: "3.12"
-  prerelease: false
   type: :development
-  name: rdoc
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -88,11 +90,11 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  prerelease: false
   type: :development
-  name: bundler
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -104,11 +106,11 @@ dependencies:
         - 8
         - 3
         version: 1.8.3
-  prerelease: false
   type: :development
-  name: jeweler
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -118,9 +120,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  prerelease: false
   type: :development
-  name: rcov
   version_requirements: *id007
 description: SproutVideo API Client
 email: support@sproutvideo.com
@@ -189,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: SproutVideo API Client