three_sixty 1.0.0

data/spec/asset_spec.rb

@@ -0,0 +1,197 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module Sorenson
+  module ThreeSixty
+    describe Asset, '#initialize' do
+      before do
+        data = {
+          'presetXml'         => 'some xml data',
+          'encodeDate'        => '2009-04-09',
+          'frameRate'         => '300',
+          'height'            => '450',
+          'dateLastModified'  => '2009-04-10',
+          'videoBitrateMode'  => 'mode',
+          'mediaType'         => 'video',
+          'id'                => 'my_asset_id',
+          'accountId'         => 'account_id',
+          'numberOfViews'     => '50',
+          'application'       => 'an application',
+          'audioCodec'        => 'audio_codec',
+          'permalinkLocation' => 'http://example.com/test',
+          'status'            => 'Live',
+          'description'       => 'some text',
+          'videoDuration'     => '3000',
+          'abstractFileId'    => 'abstract_id',
+          'versionId'         => 'versionId',
+          'dateRetrieved'     => '2009-04-15',
+          'audioDataRate'     => '400',
+          'audioBitrateMode'  => 'some_bitrate_mode',
+          'videoCodec'        => 'video_codec',
+          'displayName'       => 'a descriptive name',
+          'name'              => 'file.flv',
+          'videoDataRate'     => '4000',
+          'authorId'          => 'author_id',
+          'width'             => '430',
+          'fileSize'          => '401203',
+          'thumbnail'         => {'httpLocation' => 'http://somewhere.com/thumbnail'},
+          'filters'           => [{'filterDescription' => 'a filter description'}]
+        }
+        @asset = mock_asset(data)
+      end
+      
+      it 'should set presetXml' do
+        @asset.presetXml.should == 'some xml data'
+      end
+
+      it 'should set encodeDate' do
+        @asset.encodeDate.should == '2009-04-09'
+      end
+
+      it 'should set frameRate' do
+        @asset.frameRate.should == '300'
+      end
+
+      it 'should set height' do
+        @asset.height.should == '450'
+      end
+
+      it 'should set dateLastModified' do
+        @asset.dateLastModified.should == '2009-04-10'
+      end
+      
+      it 'should set videoBitrateMode' do
+        @asset.videoBitrateMode.should == 'mode'
+      end
+      
+      it 'should set mediaType' do
+        @asset.mediaType.should == 'video'
+      end
+      
+      it 'should set id' do
+        @asset.id.should == 'my_asset_id'
+      end
+
+      it 'should set accountId' do
+        @asset.accountId.should == 'account_id'
+      end
+
+      it 'should set numberOfViews' do
+        @asset.numberOfViews.should == '50'
+      end
+
+      it 'should set application' do
+        @asset.application.should == 'an application'
+      end
+
+      it 'should set audioCodec' do
+        @asset.audioCodec.should == 'audio_codec'
+      end
+
+      it 'should set permalinkLocation' do
+        @asset.permalinkLocation.should == 'http://example.com/test'
+      end
+
+      it 'should set status' do
+        @asset.status.should == 'Live'
+      end
+
+      it 'should set description' do
+        @asset.description.should == 'some text'
+      end
+
+      it 'should set videoDuration' do
+        @asset.videoDuration.should == '3000'
+      end
+
+      it 'should set abstractFileId' do
+        @asset.abstractFileId.should == 'abstract_id'
+      end
+
+      it 'should set versionId' do
+        @asset.versionId.should == 'versionId'
+      end
+
+      it 'should set dateRetrieved' do
+        @asset.dateRetrieved.should == '2009-04-15'
+      end
+
+      it 'should set audioDataRate' do
+        @asset.audioDataRate.should == '400'
+      end
+
+      it 'should set audioBitrateMode' do
+        @asset.audioBitrateMode.should == 'some_bitrate_mode'
+      end
+
+      it 'should set videoCodec' do
+        @asset.videoCodec.should == 'video_codec'
+      end
+
+      it 'should set displayName' do
+        @asset.displayName.should == 'a descriptive name'
+      end
+
+      it 'should set name' do
+        @asset.name.should == 'file.flv'
+      end
+
+      it 'should set videoDataRate' do
+        @asset.videoDataRate.should == '4000'
+      end
+
+      it 'should set authorId' do
+        @asset.authorId.should == 'author_id'
+      end
+
+      it 'should set width' do
+        @asset.width.should == '430'
+      end
+
+      it 'should set fileSize' do
+        @asset.fileSize.should == '401203'
+      end
+
+      it 'should set thumbnail' do
+        @asset.thumbnailImageUrl.should == 'http://somewhere.com/thumbnail'
+      end
+
+    end
+    
+    describe Asset, '.find' do
+      
+      before do
+        @account = mock_account
+        @mock_asset = mock('Account')
+        Asset.stub!(:new).with(@account, {'height' => '400'}).and_return(@mock_asset)
+      end
+      
+      it 'should fetch the assets for an account' do
+        Asset.should_receive(:post_to).with("/api/getMediaList?offset=&quantity=&accountId=#{@account.id}&sessionId=#{@account.sessionId}&status=Live&sort=uploadDate").and_return({'mediaList' => [{'height' => '400'}]})
+        Asset.find(@account).should include(@mock_asset)
+      end
+      
+      it 'should fetch the assets for an account with an offset' do        Asset.should_receive(:post_to).with("/api/getMediaList?offset=5&quantity=&accountId=#{@account.id}&sessionId=#{@account.sessionId}&status=Live&sort=uploadDate").and_return({'mediaList' => [{'height' => '400'}]})
+        Asset.find(@account, 5).should include(@mock_asset)
+      end
+
+      it 'should fetch the assets for an account with an offset and a quantity' do
+Asset.should_receive(:post_to).with("/api/getMediaList?offset=5&quantity=10&accountId=#{@account.id}&sessionId=#{@account.sessionId}&status=Live&sort=uploadDate").and_return({'mediaList' => [{'height' => '400'}]})
+        Asset.find(@account, 5, 10).should include(@mock_asset)
+      end
+    end
+    
+    describe Asset, '#get_embed_codes' do
+      
+      it 'should return a list of embed codes' do
+        asset = mock_asset
+        asset.should_receive(:post_to).with("/api/getAllEmbedcodes?vguid=#{asset.id}&sessionId=#{asset.account.sessionId}").and_return({'embedList' => ['<object width="450" height="320">']})
+        
+        asset.send(:get_embed_codes)
+        asset.embedList.should include('450x320 - Widescreen')
+      end
+      
+      
+    end
+
+  end
+end

data/spec/base_spec.rb

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module Sorenson
+  module ThreeSixty
+    describe Base, '.post_to' do
+      before do
+        @url = '/apiTest'
+        @json = '{"json": "data"}'
+        Base.stub!(:host).and_return('sometest.com')
+        Base.stub!(:protocol).and_return('http://')
+        @host = 'http://sometest.com'
+        RestClient.stub!(:post).with(@host + @url, {}).and_return(@json)
+      end
+
+      it 'should post to a url using RestClient' do
+        RestClient.should_receive(:post).with(@host + @url, {}).and_return(@json)
+        Base.post_to(@url)
+      end
+
+      it 'should raise an InvalidServerResponse' do
+        RestClient.should_receive(:post).with(@host + @url, {}).and_return('bogus data')
+        lambda { Base.post_to(@url) }.should raise_error(InvalidServerResponse)
+      end
+
+      it 'should parse JSON and return a hash' do
+        Base.post_to(@url).should == {'json' => 'data'}
+      end
+
+    end
+
+    describe Base, '.protocol' do
+  
+      it 'should return http:// if @@use_ssl is set to false' do
+        Base.use_ssl = false
+        Base.protocol.should == 'http://'
+      end
+
+      it 'should return http:// if @@use_ssl is set to true' do
+        Base.use_ssl = true
+        Base.protocol.should == 'https://'
+      end
+
+    end
+
+    describe Base, '.use_ssl?' do
+  
+      it 'should return false if @@use_ssl is set to false' do
+        Base.use_ssl = false
+        Base.use_ssl?.should be_false
+      end
+
+      it 'should return true if @@use_ssl is set to true' do
+        Base.use_ssl = true
+        Base.use_ssl?.should be_true
+      end
+
+  
+    end
+
+    describe Base, ".host" do
+      
+      before do
+        @filename = '/var/tmp/360host'
+      end
+  
+      it 'should return 360.sorensonmedia.com if no override file exists' do
+        File.should_receive(:exist?).with(@filename).and_return(false)
+        Base.host.should == '360.sorensonmedia.com'
+      end
+  
+      it 'should fetch the url of the environment set in the override file if it exists' do
+        File.should_receive(:exist?).with(@filename).and_return(true)
+        File.should_receive(:read).with(@filename).and_return("test\nbogus data")
+        RestClient.should_receive(:get).with("http://www.sorensonmedia.com/internal/apis/360Env.php?env=test").and_return("test.example.com\n")
+        Base.host.should == 'test.example.com'
+      end
+  
+    end
+    
+    describe Base, ".token_for" do
+      
+      it 'should create a SHA1 hash based on the username and a salt string' do
+        username = 'ausernamestring'
+        token = Digest::SHA1.hexdigest(Base::TOKEN_SALT + username)
+        Base.token_for(username).should == token
+      end
+
+    end
+  end
+end

data/spec/format_constraint_spec.rb

@@ -0,0 +1,134 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module Sorenson
+  module ThreeSixty
+
+    describe FormatConstraint, '#initialize' do
+      
+      before do
+        data = {
+          'id'                        => 'my_id',
+          'name'                      => 'a name',
+          'displayName'               => 'some format',
+          'defaultVideoDuration'      => 1.2,
+          'maxVideoDuration'          => 10,
+          'defaultFrameRate'          => 400,
+          'maxFrameRate'              => 1000,
+          'maxWidth'                  => 1200,
+          'defaultWidth'              => 50,
+          'ratePlanId'                => 'base plan',
+          'maxHeight'                 => 400,
+          'defaultHeight'             => 250,
+          'defaultAudioDataRate'      => 120,
+          'maxAudioDataRate'          => 250,
+          'dateRetrieved'             => '2009-04-15',
+          'defaultVideoDataRate'      => 30,
+          'maxVideoDataRate'          => 1200,
+          'thumbnailGenerationMethod' => 'thumbnail generation method',
+          'defaultAudioCodec'         => 'audio codec',
+          'defaultVideoCodec'         => 'video codec',
+          'audioBitRateMode'          => 'a bit rate mode',
+          'videoBitRateMode'          => 'v bit rate mode',
+          'mediaType'                 => 'media type'
+        }
+
+        @rate_plan = RatePlan.new({})
+        @format_contraint = FormatConstraint.new(@rate_plan, data)
+      end
+      
+      it 'should set ratePlan' do
+        @format_contraint.ratePlan.should == @rate_plan
+      end
+
+      it 'should set name' do
+        @format_contraint.name.should == 'a name'
+      end
+
+      it 'should set displayName' do
+        @format_contraint.displayName.should == 'some format'
+      end
+      
+      it 'should set defaultVideoDuration' do
+        @format_contraint.defaultVideoDuration.should == 1.2
+      end
+
+      it 'should set maxVideoDuration' do
+        @format_contraint.maxVideoDuration.should == 10
+      end
+
+      it 'should set defaultFrameRate' do
+        @format_contraint.defaultFrameRate.should == 400
+      end
+
+      it 'should set maxFrameRate' do
+        @format_contraint.maxFrameRate.should == 1000
+      end
+
+      it 'should set maxWidth' do
+        @format_contraint.maxWidth.should == 1200
+      end
+
+      it 'should set defaultWidth' do
+        @format_contraint.defaultWidth.should == 50
+      end
+
+      it 'should set ratePlanId' do
+        @format_contraint.ratePlanId.should == 'base plan'
+      end
+
+      it 'should set maxHeight' do
+        @format_contraint.maxHeight.should == 400
+      end
+
+      it 'should set defaultHeight' do
+        @format_contraint.defaultHeight.should == 250
+      end
+
+      it 'should set defaultAudioDataRate' do
+        @format_contraint.defaultAudioDataRate.should == 120
+      end
+
+      it 'should set maxAudioDataRate' do
+        @format_contraint.maxAudioDataRate.should == 250
+      end
+
+      it 'should set dateRetrieved' do
+        @format_contraint.dateRetrieved.should == '2009-04-15'
+      end
+
+      it 'should set defaultVideoDataRate' do
+        @format_contraint.defaultVideoDataRate.should == 30
+      end
+
+      it 'should set maxVideoDataRate' do
+        @format_contraint.maxVideoDataRate.should == 1200
+      end
+
+      it 'should set thumbnailGenerationMethod' do
+        @format_contraint.thumbnailGenerationMethod.should == 'thumbnail generation method'
+      end
+
+      it 'should set defaultAudioCodec' do
+        @format_contraint.defaultAudioCodec.should == 'audio codec'
+      end
+
+      it 'should set defaultVideoCodec' do
+        @format_contraint.defaultVideoCodec.should == 'video codec'
+      end
+
+      it 'should set audioBitRateMode' do
+        @format_contraint.audioBitRateMode.should == 'a bit rate mode'
+      end
+
+      it 'should set videoBitRateMode' do
+        @format_contraint.videoBitRateMode.should == 'v bit rate mode'
+      end
+
+      it 'should set mediaType' do
+        @format_contraint.mediaType.should == 'media type'
+      end
+
+    end
+
+  end
+end

data/spec/rate_plan_spec.rb

@@ -0,0 +1,148 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module Sorenson
+  module ThreeSixty
+    describe RatePlan, '.getBaseRatePlans' do
+      
+      it 'should fetch the public rate plans from the server and return an array of rate plans' do
+        RatePlan.should_receive(:post_to).with('/api/getBaseRatePlans').and_return('baseRatePlans' => [{'id' => '42', 'displayName' => 'fake rate plan'}, {'id' => '24', 'displayName' => 'another fake rate plan'}])
+        results = RatePlan.getBaseRatePlans
+        results.first.id.should == '42'
+        results[1].displayName.should == 'another fake rate plan'
+        results.length.should == 2
+      end
+      
+    end
+
+    describe RatePlan, '.getAllRatePlans' do
+      
+      it 'should fetch all the rate plans from the server and return an array of rate plans' do
+        RatePlan.should_receive(:post_to).with("/api/getAllRatePlans").and_return('allRatePlans' => [{'id' => '42', 'displayName' => 'fake rate plan'}, {'id' => '24', 'displayName' => 'another fake rate plan'}])
+        results = RatePlan.getAllRatePlans
+        results.first.id.should == '42'
+        results[1].displayName.should == 'another fake rate plan'
+        results.length.should == 2
+      end
+      
+    end
+    
+    
+    describe RatePlan, '.getRatePlan' do
+      
+      it 'should fetch all the rate plans from the server and return an array of rate plans' do
+        id = 'rate_plan_id'
+        RatePlan.should_receive(:post_to).with("/api/getRatePlan?ratePlanId=#{id}").and_return('ratePlanData' => {'id' => '42', 'displayName' => 'fake rate plan'})
+        results = RatePlan.getRatePlan(id)
+        results.id.should == '42'
+        results.displayName.should == 'fake rate plan'
+      end
+      
+    end
+    
+    describe RatePlan, '#initialize' do
+      before do
+        data = {
+          'id'                      => 'my_id',
+          'displayName'             => 'some rate plan',
+          'ratePlanType'            => 'rate plan type',
+          'maxThumbnailsPerVideo'   => 10,
+          'setupCost'               => 400,
+          'monthlyCost'             => 100,
+          'annualCost'              => 1200,
+          'allowedStreams'          => 50,
+          'basePlan'                => 'base plan',
+          'dateLastModified'        => '2009-04-10',
+          'dateRetrieved'           => '2009-04-15',
+          'streamingOverageAllowed' => false,
+          'storageOverageAllowed'   => true,
+          'allowedStreamingMBytes'  => 5000,
+          'allowedStorageMBytes'    => 1240000,
+          'allowedSourceMediaTypes' => ['media', 'type'],
+          'allowedOutputMediaTypes' => ['output', 'types'],
+          'formatConstraints'       => ['a fake format constraint'],
+          'sorensonSku'             => 'a sku'
+        }
+
+        FormatConstraint.stub!(:new).and_return('a fake format constraint')
+        @rate_plan = RatePlan.new(data)
+      end
+      
+      it 'should set id' do
+        @rate_plan.id.should == 'my_id'
+      end
+    
+      it 'should set displayName' do
+        @rate_plan.displayName.should == 'some rate plan'
+      end
+      
+      it 'should set ratePlanType' do
+        @rate_plan.ratePlanType.should == 'rate plan type'
+      end
+      
+      it 'should set maxThumbnailsPerVideo' do
+        @rate_plan.maxThumbnailsPerVideo.should == 10
+      end
+
+      it 'should set setupCost' do
+        @rate_plan.setupCost.should == 400
+      end
+
+      it 'should set monthlyCost' do
+        @rate_plan.monthlyCost.should == 100
+      end
+
+      it 'should set annualCost' do
+        @rate_plan.annualCost.should == 1200
+      end
+    
+      it 'should set allowedStreams' do
+        @rate_plan.allowedStreams.should == 50
+      end
+    
+      it 'should set basePlan' do
+        @rate_plan.basePlan.should == 'base plan'
+      end
+    
+      it 'should set dateLastModified' do
+        @rate_plan.dateLastModified.should == '2009-04-10'
+      end
+    
+      it 'should set dateRetrieved' do
+        @rate_plan.dateRetrieved.should == '2009-04-15'
+      end
+
+      it 'should set streamingOverageAllowed' do
+        @rate_plan.streamingOverageAllowed.should be_false
+      end
+
+      it 'should set storageOverageAllowed' do
+        @rate_plan.storageOverageAllowed.should be_true
+      end
+
+      it 'should set allowedStreamingMBytes' do
+        @rate_plan.allowedStreamingMBytes.should == 5000
+      end
+
+      it 'should set allowedStorageMBytes' do
+        @rate_plan.allowedStorageMBytes.should == 1240000
+      end
+
+      it 'should set allowedSourceMediaTypes' do
+        @rate_plan.allowedSourceMediaTypes.should include('media', 'type')
+      end
+
+      it 'should set allowedOutputMediaTypes' do
+        @rate_plan.allowedOutputMediaTypes.should include('output', 'types')
+      end
+
+      it 'should set sorensonSku' do
+        @rate_plan.sorensonSku.should == 'a sku'
+      end
+      
+      it 'should create an array of formatConstraints' do
+        @rate_plan.formatConstraints.should include('a fake format constraint')
+      end
+
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+ 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'lib/sorenson/threesixty'
+
+def mock_account(options = {})
+  Sorenson::ThreeSixty::Account.stub!(:post_to).with("/api/getMediaListSummary?accountId=my_id&sessionId=session_id").and_return({'totalMediaCount' => 10})
+  Sorenson::ThreeSixty::RatePlan.stub!(:new).with('a rate plan').and_return('a rate plan')
+  Sorenson::ThreeSixty::Account.new({'sessionId' => 'session_id', 'account' => {'id' => 'my_id'}}.merge(options))
+end
+
+def mock_asset(options = {})
+  account = mock_account
+    Sorenson::ThreeSixty::Asset.stub!(:post_to).with("/api/getAllEmbedcodes?vguid=my_asset_id&sessionId=#{account.sessionId}").and_return({'embedList' => []})
+  Sorenson::ThreeSixty::Asset.new(account, {'id' => 'my_asset_id'}.merge(options))
+end