animoto 0.0.0.alpha0

data/spec/animoto/directing_manifest_spec.rb

@@ -0,0 +1,186 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Animoto::DirectingManifest do
+
+  def manifest options = {}
+    @manifest ||= Animoto::DirectingManifest.new(options)
+  end
+  
+  describe "initializing" do
+    it "should specify the title of the manifest as the first argument" do
+      manifest(:title => "Funderful Wonderment").title.should == "Funderful Wonderment"
+    end
+    
+    it "should default to 'default' pacing" do
+      manifest.pacing.should == 'default'
+    end
+    
+    it "should be able to specify the pacing with a :pacing parameter" do
+      manifest(:pacing => 'double').pacing.should == 'double'
+    end
+    
+    it "should default to 'original' style" do
+      manifest.style.should == 'original'
+    end
+    
+    it "should default to no producer" do
+      manifest.producer.should be_nil
+    end
+    
+    it "should be able to specify the producer with a :producer parameter" do
+      manifest(:producer => "Senor Spielbergo").producer.should == "Senor Spielbergo"
+    end
+    
+    it "should default to having to visuals" do
+      manifest.visuals.should be_empty
+    end
+  end
+  
+  describe "adding assets" do
+    describe "using the append operator" do
+      before do
+        @title_card = Animoto::TitleCard.new "woohoo!"
+      end
+      
+      it "should add the asset to this manifest's visuals" do
+        manifest << @title_card
+        manifest.visuals.should include(@title_card)
+      end
+      
+      it "should raise an error if the object being added isn't a visual" do
+        lambda { manifest << "beef hearts" }.should raise_error
+      end
+    end
+    
+    describe "using a convenience method" do
+      it "should append the asset to this manifest's visuals" do
+        manifest.add_title_card("woohoo!")
+        vis = manifest.visuals.last
+        vis.should be_an_instance_of(Animoto::TitleCard)
+        vis.title.should == "woohoo!"
+      end
+      
+      it "should send the parameters to the asset initializer" do
+        manifest.add_title_card("woohoo!", "everything is great!")
+        vis = manifest.visuals.last
+        vis.title.should == "woohoo!"
+        vis.subtitle.should == "everything is great!"
+      end
+    end
+  end
+  
+  describe "adding a song" do
+    it "should use the append operator" do
+      song = Animoto::Song.new "http://song.org/song.mp3"
+      manifest << song
+      manifest.song.should == song
+    end
+    
+    it "should use the add_song method" do
+      song = manifest.add_song("http://song.org/song.mp3")
+      manifest.song.should == song
+    end
+    
+    it "should replace an existing song" do
+      song = Animoto::Song.new "http://song.org/song.mp3"
+      song2 = Animoto::Song.new "http://song.org/song2.mp3"
+      manifest << song
+      manifest << song2
+      manifest.song.should == song2
+    end
+  end
+  
+  describe "generating a hash" do
+    before do
+      manifest(:title => 'Funderful Wonderment', :producer => 'Senor Spielbergo', :pacing => 'double')
+      @image = manifest.add_image 'http://website.com/image.png'
+      @title_card = manifest.add_title_card 'woohoo', 'this is awesome'
+      @footage = manifest.add_footage 'http://website.com/movie.mp4'
+      @song_obj = manifest.add_song 'http://website.com/song.mp3'
+    end
+    
+    it "should have top-level 'directing_job' object" do
+      manifest.to_hash.should have_key('directing_job')
+      manifest.to_hash['directing_job'].should be_a(Hash)
+    end
+    
+    it "should have a 'directing_manifest' object within the 'directing_job'" do
+      manifest.to_hash['directing_job'].should have_key('directing_manifest')
+      manifest.to_hash['directing_job']['directing_manifest'].should be_a(Hash)
+    end
+    
+    it "should have a 'style' key in the manifest" do
+      manifest.to_hash['directing_job']['directing_manifest'].should have_key('style')
+      manifest.to_hash['directing_job']['directing_manifest']['style'].should == manifest.style
+    end
+    
+    it "should have a 'pacing' key in the manifest" do
+      manifest.to_hash['directing_job']['directing_manifest'].should have_key('pacing')
+      manifest.to_hash['directing_job']['directing_manifest']['pacing'].should == manifest.pacing
+    end
+    
+    it "should have a 'producer_name' key in the manifest" do
+      manifest.to_hash['directing_job']['directing_manifest'].should have_key('producer_name')
+      manifest.to_hash['directing_job']['directing_manifest']['producer_name'].should == manifest.producer
+    end
+    
+    it "should have a 'visuals' key in the manifest" do
+      manifest.to_hash['directing_job']['directing_manifest'].should have_key('visuals')
+    end
+    
+    it "should have a 'song' object in the manifest" do
+      manifest.to_hash['directing_job']['directing_manifest'].should have_key('song')
+      manifest.to_hash['directing_job']['directing_manifest']['song'].should be_a(Hash)
+    end
+    
+    describe "when the callback url is set" do
+      before do
+        manifest.http_callback_url = 'http://website.com/callback'        
+      end
+
+      describe "but the callback format isn't" do
+        it "should raise an error" do
+          lambda { manifest.to_hash }.should raise_error(ArgumentError)
+        end
+      end
+      
+      describe "as well as the format" do
+        before do
+          manifest.http_callback_format = 'xml'
+        end
+        
+        it "should have the HTTP callback URL in the job" do
+          manifest.to_hash['directing_job'].should have_key('http_callback')
+          manifest.to_hash['directing_job']['http_callback'].should == manifest.http_callback_url
+        end
+
+        it "should have the HTTP callback format in the job" do
+          manifest.to_hash['directing_job'].should have_key('http_callback_format')
+          manifest.to_hash['directing_job']['http_callback_format'].should == manifest.http_callback_format
+        end
+      end
+    end
+    
+    describe "visuals array" do
+      before do
+        @visuals = manifest.to_hash['directing_job']['directing_manifest']['visuals']
+      end
+      
+      it "should have the visuals in the order they were added" do
+        @visuals[0].should == @image.to_hash
+        @visuals[1].should == @title_card.to_hash
+        @visuals[2].should == @footage.to_hash
+      end
+    end
+    
+    describe "song" do
+      before do
+        @song = manifest.to_hash['directing_job']['directing_manifest']['song']
+      end
+      
+      it "should have info about the song" do
+        @song.should == @song_obj.to_hash
+      end
+    end
+  end
+end

data/spec/animoto/footage_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Animoto::Footage do
+  
+  it "should be a visual" do
+    Animoto::Footage.should include(Animoto::Visual)
+  end
+  
+  describe "#to_hash" do
+    before do
+      @footage = Animoto::Footage.new 'http://website.com/movie.mp4'
+    end
+    
+    it "should have a 'source_url' key with the url" do
+      @footage.to_hash.should have_key('source_url')
+      @footage.to_hash['source_url'].should == @footage.source_url
+    end
+    
+    it "should not have a 'spotlit' key" do
+      @footage.to_hash.should_not have_key('spotlit')
+    end
+    
+    describe "if audio mixing is turned on" do
+      before do
+        @footage.audio_mix = true
+      end
+      
+      it "should have an 'audio_mix' key telling how to mix" do
+        @footage.to_hash.should have_key('audio_mix')
+        @footage.to_hash['audio_mix'].should == 'MIX'
+      end
+    end
+    
+    describe "if using a different start time" do
+      before do
+        @footage.start_time = 10.5
+      end
+      
+      it "should have a 'start_time' key with the starting time" do
+        @footage.to_hash.should have_key('start_time')
+        @footage.to_hash['start_time'].should == @footage.start_time
+      end
+    end
+    
+    describe "if a duration was specified" do
+      before do
+        @footage.duration = 300
+      end
+      
+      it "should have a 'duration' key with the duration" do
+        @footage.to_hash.should have_key('duration')
+        @footage.to_hash['duration'].should == @footage.duration
+      end
+    end
+  end
+end

data/spec/animoto/image_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Animoto::Image do
+  
+  it "should be a visual" do
+    Animoto::Image.should include(Animoto::Visual)
+  end
+  
+  describe "#to_hash" do
+    before do
+      @image = Animoto::Image.new 'http://website.com/image.png'
+    end
+    
+    it "should have a 'source_url' key with the url" do
+      @image.to_hash.should have_key('source_url')
+      @image.to_hash['source_url'].should == @image.source_url
+    end
+    
+    describe "if rotated" do
+      before do
+        @image.rotation = 2
+      end
+      
+      it "should have a 'rotation' key with the EXIF rotation value" do
+        @image.to_hash.should have_key('rotation')
+        @image.to_hash['rotation'].should == @image.rotation
+      end
+    end
+    
+    describe "if spotlit" do
+      before do
+        @image.spotlit = true
+      end
+      
+      it "should have a 'spotlit' key telling whether or not this image is spotlit" do
+        @image.to_hash.should have_key('spotlit')
+        @image.to_hash['spotlit'].should == @image.spotlit?
+      end
+    end
+  end
+end

data/spec/animoto/job_spec.rb

@@ -0,0 +1,128 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Animoto::Job do
+  
+  describe "initialization" do
+    before do
+      @body = {
+        'response' => {
+          'status' => {
+            'code' => 200
+          },
+          'payload' => {
+            'job' => {
+              'state' => 'initial',
+              'links' => {
+                'self' => "http://animoto.com/jobs/1"
+              }
+            }
+          }
+        }
+      }
+      @job = Animoto::Job.load @body
+    end
+    
+    it "should set its state from the job state given" do
+      @job.state.should == 'initial'
+    end
+    
+    it "should set its url from the 'self' link given" do
+      @job.url.should == 'http://animoto.com/jobs/1'
+    end
+  end
+  
+  describe "when there are errors" do
+    before do
+      @body = {
+        'response' => {
+          'status' => {
+            'code' => 400,
+            'errors' => [
+              {
+                'code' => 'FORMAT',
+                'description' => 'There is an item in the request that is incorrectly formatted'
+              }
+            ]
+          },
+          'payload' => {
+            'job' => {
+              'state' => 'failed',
+              'links' => {
+                'self' => 'http://animoto.com/jobs/1'
+              }
+            }
+          }
+        }
+      }
+      @job = Animoto::Job.load @body
+    end
+    
+    it "should have 'failed' state" do
+      @job.state.should == 'failed'
+    end
+    
+    it "should have non-empty errors" do
+      @job.errors.should_not be_empty
+    end
+    
+    it "should wrap the errors in error objects" do
+      @job.errors.first.should be_an_instance_of(Animoto::Error)
+    end
+  end
+  
+  describe "returning state" do
+    before do
+      @job = Animoto::Job.load 'response'=>{'status'=>{'code'=>200},'payload'=>{'job'=>{'state'=>'initial','links'=>{'self'=>'http://animoto.com/jobs/1'}}}}
+    end
+    
+    describe "when 'initial'" do
+      it "should not be failed" do
+        @job.should_not be_failed
+      end
+      
+      it "should not be completed" do
+        @job.should_not be_completed
+      end
+      
+      it "should be pending" do
+        @job.should be_pending
+      end
+    end
+    
+    describe "when 'failed'" do
+      before do
+        @job.instance_variable_set :@state, 'failed'
+      end
+      
+      it "should be failed" do
+        @job.should be_failed
+      end
+      
+      it "should not be completed" do
+        @job.should_not be_completed
+      end
+      
+      it "should not be pending" do
+        @job.should_not be_pending
+      end
+    end
+    
+    describe "when 'completed'" do
+      before do
+        @job.instance_variable_set :@state, 'completed'
+      end
+      
+      it "should not be failed" do
+        @job.should_not be_failed
+      end
+      
+      it "should be completed" do
+        @job.should be_completed
+      end
+      
+      it "should not be pending" do
+        @job.should_not be_pending
+      end
+    end
+  end
+end

data/spec/animoto/rendering_job_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Animoto::RenderingJob do
+  
+  it "should have endpoint /jobs/rendering" do
+    Animoto::RenderingJob.endpoint.should == '/jobs/rendering'
+  end
+  
+  it "should have content type 'application/vnd.animoto.rendering_job'" do
+    Animoto::RenderingJob.content_type.should == 'rendering_job'
+  end
+  
+  it "should have payload key 'rendering_job'" do
+    Animoto::RenderingJob.payload_key.should == 'rendering_job'
+  end
+  
+  describe "loading from a response body" do
+    before do
+      @body = {
+        'response' => {
+          'status' => {
+            'code' => 200
+          },
+          'payload' => {
+            'rendering_job' => {
+              'state' => 'completed',
+              'links' => {
+                'self' => 'http://animoto.com/jobs/rendering/1',
+                'storyboard' => 'http://animoto.com/storyboards/1',
+                'video' => 'http://animoto.com/videos/1'
+              }
+            }
+          }
+        }
+      }
+      @job = Animoto::RenderingJob.load @body
+    end
+    
+    it "should set the storyboard url from the body" do
+      @job.storyboard_url.should == "http://animoto.com/storyboards/1"
+    end
+    
+    it "should set the video url from the body" do
+      @job.video_url.should == "http://animoto.com/videos/1"
+    end
+    
+    it "should create a storyboard from the storyboard url" do
+      @job.storyboard.should be_an_instance_of(Animoto::Storyboard)
+      @job.storyboard.url.should == @job.storyboard_url
+    end
+    
+    it "should create a video from the video url" do
+      @job.video.should be_an_instance_of(Animoto::Video)
+      @job.video.url.should == @job.video_url
+    end
+  end
+end

data/spec/animoto/rendering_manifest_spec.rb

@@ -0,0 +1,115 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Animoto::RenderingManifest do
+  
+  def manifest *args
+    @manifest ||= begin
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      @storyboard = args[0] || Animoto::Storyboard.new
+      Animoto::RenderingManifest.new @storyboard, options
+    end
+  end
+  
+  describe "initialization" do
+    before do
+      @storyboard = Animoto::Storyboard.new
+    end
+    
+    it "should take a storyboard as the first argument" do
+      Animoto::RenderingManifest.new(@storyboard).storyboard = @storyboard
+    end
+    
+    it "should take a :resolution parameter to set the resolution" do
+      manifest(:resolution => "720p").resolution.should == "720p"
+    end
+    
+    it "should take a :framerate parameter to set the framerate" do
+      manifest(:framerate => 24).framerate.should == 24
+    end
+    
+    it "should take a :format parameter to set the format" do
+      manifest(:format => 'flv').format.should == 'flv'
+    end
+    
+    it "should take :http_callback_url and :http_callback_format parameters to set the callback" do
+      manifest(:http_callback_url => "http://website.com/callback", :http_callback_format => 'xml')
+      manifest.http_callback_url.should == "http://website.com/callback"
+      manifest.http_callback_format.should == 'xml'
+    end
+  end
+  
+  describe "generating a hash" do
+    before do
+      @storyboard = Animoto::Storyboard.new
+      @url = "http://animoto.com/storyboards/1"
+      @storyboard.instance_variable_set(:@url, @url)
+      manifest(@storyboard, :resolution => "720p", :framerate => 24, :format => 'flv')
+    end
+    
+    it "should have a top-level 'rendering_job' object" do
+      manifest.to_hash.should have_key('rendering_job')
+      manifest.to_hash['rendering_job'].should be_a(Hash)
+    end
+    
+    it "should have a 'rendering_manifest' object in the 'rendering_job'" do
+      manifest.to_hash['rendering_job'].should have_key('rendering_manifest')
+      manifest.to_hash['rendering_job']['rendering_manifest'].should be_a(Hash)
+    end
+    
+    it "should have a 'storyboard_url' key in the manifest" do
+      manifest.to_hash['rendering_job']['rendering_manifest'].should have_key('storyboard_url')
+      manifest.to_hash['rendering_job']['rendering_manifest']['storyboard_url'].should == @storyboard.url
+    end
+    
+    it "should have a 'rendering_profile' object in the manifest" do
+      manifest.to_hash['rendering_job']['rendering_manifest'].should have_key('rendering_profile')
+      manifest.to_hash['rendering_job']['rendering_manifest']['rendering_profile'].should be_a(Hash)
+    end
+    
+    describe "rendering profile" do
+      before do
+        @profile = manifest.to_hash['rendering_job']['rendering_manifest']['rendering_profile']
+      end
+      
+      it "should have a 'vertical_resolution' key" do
+        @profile['vertical_resolution'].should == manifest.resolution
+      end
+      
+      it "should have a 'framerate' key" do
+        @profile['framerate'].should == manifest.framerate
+      end
+      
+      it "should have a 'format' key" do
+        @profile['format'].should == manifest.format
+      end
+    end
+    
+    describe "when an HTTP callback is set" do
+      before do
+        manifest.http_callback_url = "http://website.com/callback"
+      end
+      
+      describe "but a format isn't" do
+        it "should raise an error" do
+          lambda { manifest.to_hash }.should raise_error(ArgumentError)
+        end
+      end
+      
+      describe "as well as the format" do
+        before do
+          manifest.http_callback_format = 'xml'
+        end
+        
+        it "should have the HTTP callback URL in the job" do
+          manifest.to_hash['rendering_job'].should have_key('http_callback')
+          manifest.to_hash['rendering_job']['http_callback'].should == manifest.http_callback_url
+        end
+        
+        it "should have the HTTP callback format in the job" do
+          manifest.to_hash['rendering_job'].should have_key('http_callback_format')
+          manifest.to_hash['rendering_job']['http_callback_format'].should == manifest.http_callback_format
+        end
+      end
+    end
+  end
+end

data/spec/animoto/resource_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Animoto::Resource do
+  
+  def define_thing options = {}
+    Object.__send__ :remove_const, :Thing if defined?(Thing)
+    Object.__send__ :const_set, :Thing, Class.new(Animoto::Resource)
+    options.each { |k,v| Thing.__send__(k, v) }
+  end
+
+  describe "inferring the content type" do
+    it "should be the underscored, lowercase version of the base class name" do
+      class Animoto::ThisIsALongAndStupidName < Animoto::Resource; end
+      Animoto::ThisIsALongAndStupidName.content_type.should == 'this_is_a_long_and_stupid_name'
+    end
+  end
+
+  describe "identity mapping" do
+    before do
+      @url = "https://api.animoto.com/videos/1"
+      @video = Animoto::Video.new :url => @url
+      @body = {
+        'response' => {
+          'status' => { 'code' => 200 },
+          'payload' => {
+            'video' => {
+              'links' => {
+                'download' => "http://animoto.com/videos/1",
+                'storyboard' => "https://api.animoto.com/storyboards/1",
+                'self' => @url
+              },
+              'metadata' => {
+                'duration' => 300,
+                'format' => 'h264',
+                'framerate' => 30,
+                'vertical_resolution' => "720p"
+              }
+            }
+          }
+        }
+      }
+    end
+    
+    it "should ensure that two instances instantiated with the same unique identifier will both be the same object" do
+      @video.should equal(Animoto::Video.load(@body))
+    end
+    
+    it "should update the original instance with the initialization parameters of the new one" do
+      @video.duration.should be_nil
+      video = Animoto::Video.load(@body)
+      video.duration.should == 300
+      @video.duration.should == 300
+    end
+  end
+end

data/spec/animoto/song_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe Animoto::Song do
+  
+  describe "#to_hash" do
+    before do
+      @song = Animoto::Song.new 'http://website.com/song.mp3'
+    end
+    
+    it "should have a 'source_url' key with the url" do
+      @song.to_hash.should have_key('source_url')
+      @song.to_hash['source_url'].should == @song.source_url
+    end
+    
+    describe "if a start time was specified" do
+      before do
+        @song.start_time = 30.2
+      end
+      
+      it "should have a 'start_time' key with the start time" do
+        @song.to_hash.should have_key('start_time')
+        @song.to_hash['start_time'].should == @song.start_time
+      end
+    end
+    
+    describe "if a duration was specified" do
+      before do
+        @song.duration = 300
+      end
+      
+      it "should have a 'duration' key with the duration" do
+        @song.to_hash.should have_key('duration')
+        @song.to_hash['duration'].should == @song.duration
+      end
+    end
+    
+    describe "if a title and/or artist was specified" do
+      before do
+        @song.title = "Antarctican Drinking Song"
+        @song.artist = "Gwar"
+      end
+      
+      it "should have an 'artist' key with the artist" do
+        @song.to_hash.should have_key('artist')
+        @song.to_hash['artist'].should == @song.artist
+      end
+      
+      it "should have a 'title' key with the title" do
+        @song.to_hash.should have_key('title')
+        @song.to_hash['title'].should == @song.title
+      end
+    end
+  end
+end