animoto 1.3.1 → 1.5.0

data/README.md

@@ -23,7 +23,7 @@ Animoto services from a Ruby environment or using the Ruby language.
 <a name="what_is_covered_in_this_document"></a>
 ## What is covered in this document
 
-This document covers the technical details of the Animoto API Ruby client and 
+This document covers the technical details of the Animoto API Ruby client and
 provides a general overview of its use.
 
 This document does not cover the details of the Animoto API itself. For such information please see the [Animoto API documentation][api_docs]
@@ -97,32 +97,32 @@ client and using HTTP callbacks for status updates.
     # Create a new client using our application key and secret
     client = Client.new("application_key", "secret")
 
-    # create a directing and rendering manifest with the video title and 
+    # create a directing and rendering manifest with the video title and
     # producer.  Also include rendering parameters like resolution, framerate,
     # and format.
     manifest = Manifests::DirectingAndRendering.new(
-      :title => "Amazing Title!", 
-      :resolution => "720p", 
-      :framerate => 24, 
+      :title => "Amazing Title!",
+      :resolution => "720p",
+      :framerate => 24,
       :format => 'h264'
     )
-    
+
     # Add some images, text, and footage to our manifest.
     manifest << Assets::Image.new("http://website.com/picture.png")
     manifest << Assets::Image.new("http://website.com/hooray.png", :spotlit => true)
     manifest << Assets::TitleCard.new("Woohoo!", "Hooray for everything!")
     manifest << Assets::Footage.new("http://website.com/movie.mp4", :duration => 3.5)
-    
+
     # Setup the soundtrack.
     manifest << Assets::Song.new("http://website.com/song.mp3", :artist => "Fishy Joe")
-    
-    # Setup to get http callbacks for status notification (see below for 
+
+    # Setup to get http callbacks for status notification (see below for
     # polling example).
     manifest.http_callback_url = "http://mysite.com/animoto_callback"
     manifest.http_callback_format = "json"
 
-    # Send the manifest to the API.  Your app will be notified of 
-    # completion/failure via an HTTP POST to 
+    # Send the manifest to the API.  Your app will be notified of
+    # completion/failure via an HTTP POST to
     # "http://mysite.com/animoto_callback"
     client.direct_and_render!(manifest)
 
@@ -141,29 +141,29 @@ status.
     # Create a directing manifest.  The directing manifest controls the images
     # and other visual elements that will be in our final video.
     manifest = Manifests::Directing.new(:title => "Amazing Title!")
-    
+
     # Add some images, text, and footage to our manifest.
     manifest << Assets::Image.new("http://website.com/picture.png")
     manifest << Assets::Image.new("http://website.com/hooray.png", :spotlit => true)
     manifest << Assets::TitleCard.new("Woohoo!", "Hooray for everything!")
     manifest << Assets::Footage.new("http://website.com/movie.mp4", :duration => 3.5)
-    
+
     # Setup the soundtrack.
     manifest << Assets::Song.new("http://website.com/song.mp3")
 
     # Request a new directing job by sending the API our directing manifest.
     directing_job = client.direct!(manifest)
-    
+
     # Poll the service until the directing job is done.
     while directing_job.pending?
       sleep(30)
       client.reload!(directing_job)
     end
 
-    # If the directing job finished successfully, there will be a "storyboard" 
+    # If the directing job finished successfully, there will be a "storyboard"
     # associated with this job.
     if storyboard = directing_job.storyboard
-    
+
       # Now it's time to render the storyboard into a video.  First we create
       # a rendering manifest.
       manifest = Manifests::Rendering.new(
@@ -172,10 +172,10 @@ status.
         :framerate => 24,
         :format => 'h264'
       )
-      
+
       # Send the manifest to the API.
       rendering_job = client.render!(manifest)
-      
+
       # Poll the service until the rendering job is done
       while rendering_job.pending?
         sleep(30)
@@ -192,7 +192,7 @@ status.
         raise rendering_job.errors.first
       end
     else
-      # Looks like there was a problem. Perhaps one of the assets wasn't 
+      # Looks like there was a problem. Perhaps one of the assets wasn't
       # retrieved or was corrupt...
       raise directing_job.errors.first
     end
@@ -208,17 +208,17 @@ be rendered.
 
     require 'animoto/client'
     include Animoto
-    
+
     client = Client.new("key", "secret")
-    
+
     # Make a directing manifest and direct it as detailed above.
     # Afterwards, we can make a StoryboardBundling manifest and bundle up the
     # storyboard we just made.
-    
+
     storyboard = directing_job.storyboard
     bundling_manifest = Manifests::StoryboardBundling.new(storyboard)
     bundling_job = client.bundle!(bundling_manifest)
-    
+
     # Poll the service until the bundling job is complete.
     # As with all jobs, HTTP callbacks are also supported, but we're just
     # going for a simple example here.
@@ -226,33 +226,33 @@ be rendered.
       sleep(30)
       client.reload!(bundling_job)
     end
-    
+
     # The bundle_url returned points to where you can download the storyboard
     # bundle. Downloading the bundle and archiving it elsewhere is outside the
     # scope of the client's functionality.
     puts bundling_job.bundle_url
-    
+
     # After you have a handle for the storyboard bundle, the original storyboard
     # can be deleted.
     client.delete!(storyboard)
-    
+
 Turning a bundle back into a storyboard is just as simple.
 
     require 'animoto/client'
     include Animoto
-    
+
     client = Client.new("key", "secret")
-    
+
     # Make a storyboard unbundling manifest with the url to your archived storyboard bundle.
-    unbundling_manifest = Manifest::StoryboardUnbundling.new(:bundle_url => "http://your-storage-solution.com/path/to/your/bundle")
+    unbundling_manifest = Manifests::StoryboardUnbundling.new(:bundle_url => "http://your-storage-solution.com/path/to/your/bundle")
     unbundling_job = client.unbundle!(unbundling_manifest)
-    
+
     # Poll the service until unbundling is complete.
     while unbundling_job.pending?
       sleep(30)
       client.reload!(unbundling_job)
     end
-    
+
     # Now you can use the storyboard to render a video.
     rendering_manifest = Manifests::Rendering.new(
       unbundling_job.storyboard,
@@ -261,9 +261,9 @@ Turning a bundle back into a storyboard is just as simple.
       :format => 'h264'
     )
     rendering_job = client.render!(rendering_manifest)
-    
+
     # Now proceed with using your render as detailed above.
-    
+
 
 <a name="how_to_contribute"></a>
 ## How to contribute to this client
@@ -279,21 +279,21 @@ on coding standards, new features, etc.
 
 ## Copyright Information
 
-Copyright © 2010 Animoto Inc. All rights reserved. 
+Copyright © 2010 Animoto Inc. All rights reserved.
 
-Notice – this software is owned by Animoto Inc. (“Animoto”) and is being licensed to you in source code form on the condition that you comply these terms. By continuing to use the software, you are agreeing to be bound by these terms. If you disagree with these terms, you must immediately stop using the software and permanently destroy it, or return it to Animoto. 
+Notice – this software is owned by Animoto Inc. (“Animoto”) and is being licensed to you in source code form on the condition that you comply these terms. By continuing to use the software, you are agreeing to be bound by these terms. If you disagree with these terms, you must immediately stop using the software and permanently destroy it, or return it to Animoto.
 
-Animoto hereby grants to you a limited, personal, worldwide, nontransferable license to copy, execute, compile, reproduce, modify, prepare and have prepared derivative works of the software solely for the Purpose. The “Purpose” shall mean use of the software for accessing the Animoto Application Programming Interface (“API”) in accordance with Animoto’s Terms of Service, and any other terms and conditions applicable to your Animoto user account. 
+Animoto hereby grants to you a limited, personal, worldwide, nontransferable license to copy, execute, compile, reproduce, modify, prepare and have prepared derivative works of the software solely for the Purpose. The “Purpose” shall mean use of the software for accessing the Animoto Application Programming Interface (“API”) in accordance with Animoto’s Terms of Service, and any other terms and conditions applicable to your Animoto user account.
 
-For purposes of clarity, you agree that you have no right to use the software for any other purpose other than the Purpose as defined above. This license does not include the right to distribute, transfer, sell, or otherwise commercialize the software or any portion thereof. 
+For purposes of clarity, you agree that you have no right to use the software for any other purpose other than the Purpose as defined above. This license does not include the right to distribute, transfer, sell, or otherwise commercialize the software or any portion thereof.
 
-To the extent you make any derivative works from software, you hereby grant back to Animoto a worldwide, irrevocable, perpetual, sublicenseable, assignable, royalty-free license to such derivative works, in source and object code form. 
+To the extent you make any derivative works from software, you hereby grant back to Animoto a worldwide, irrevocable, perpetual, sublicenseable, assignable, royalty-free license to such derivative works, in source and object code form.
 
-You agree to include these terms in all copies made of the software, and to not remove or alter the above copyright notice or these terms in such copies. 
+You agree to include these terms in all copies made of the software, and to not remove or alter the above copyright notice or these terms in such copies.
 
-THIS SOFTWARE IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, OR THE WARRANTY OF NON-INFRINGEMENT. 
+THIS SOFTWARE IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, OR THE WARRANTY OF NON-INFRINGEMENT.
 
-IN NO EVENT SHALL ANIMOTO BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY SPECIAL, PUNITIVE, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER, INCLUDING, WITHOUT LIMITATION, THOSE RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ANIMOTO HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OF THIS SOFTWARE. 
+IN NO EVENT SHALL ANIMOTO BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY SPECIAL, PUNITIVE, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER, INCLUDING, WITHOUT LIMITATION, THOSE RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ANIMOTO HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OF THIS SOFTWARE.
 
 You agree to indemnify defend and hold Animoto, its parents, subsidiaries, affiliates, officers and employees, harmless from any liabilities, claims, expenses or demands, including reasonable attorneys’ fees and costs, made by any third party due to or arising out of your use of this software, derivative works created by you, the violation of laws, rules, regulations or these terms, and the infringement of any intellectual property right by your derivative works or by you.
 

data/lib/animoto.rb

@@ -6,6 +6,6 @@ module Animoto
   #
   # @return [String]
   def self.version
-    "1.3.1"
+    "1.5.0"
   end
 end

data/lib/animoto/manifests/directing.rb

@@ -1,3 +1,7 @@
+require 'animoto/styles'
+require 'animoto/postroll'
+require 'animoto/postrolls/custom_footage'
+
 module Animoto
   module Manifests
     class Directing < Animoto::Manifests::Base
@@ -7,10 +11,14 @@ module Animoto
       attr_accessor :title
       
       # The pacing, representing how quickly the visuals elements will be cycled.
-      # Valid values are 'default', 'half', and 'double'.
+      # Valid values are 'very_slow', 'slow', 'moderate', 'fast', 'very_fast' and 'auto'.
+      # Faster songs will naturally cycle through images faster than slower songs. The
+      # 'moderate' pacing is about 4 beats per image. With 'auto', Animoto's cinematic
+      # artificial intelligence will decide what pacing will be best. The default pacing
+      # is 'auto'.
       # @return [String]
       attr_accessor :pacing
-      
+
       # The array of visual objects in this manifest.
       # @return [Array<Assets::Base,Assets::TitleCard>]
       attr_reader   :visuals
@@ -19,23 +27,31 @@ module Animoto
       # @return [Assets::Song]
       attr_reader   :song
       
-      # The 'style' for this video. Currently, the only style available is 'original'.
+      # The 'style' for this video. Available styles are listed in {Animoto::Styles}.
+      # Your partner account might have different styles available from those listed.
       # @return [String]
-      attr_reader   :style
+      attr_accessor :style
+
+      # The 'postroll' for this video. Postrolls are the short video 'outro' segements
+      # that play when the main video is finished.
+      # @return [Animoto::Postroll]
+      attr_reader   :postroll
 
       # Creates a new directing manifest.
       #
-      # @param [Hash] options
+      # @param [Hash{Symbol=>Object}] options
       # @option options [String] :title the title of this project
-      # @option options [String] :pacing ('default') the pacing for this project
+      # @option options [String] :pacing ('auto') the pacing for this project
+      # @option options [String,Animoto::Postroll] :postroll the postroll for this project
       # @option options [String] :http_callback_url a URL to receive a callback when this job is done
       # @option options [String] :http_callback_format the format of the callback
       # @return [Manifests::Directing] the manifest
       def initialize options = {}
         super
         @title      = options[:title]
-        @pacing     = options[:pacing] || 'default'
-        @style      = 'original'
+        @pacing     = options[:pacing]  || 'auto'
+        @style      = options[:style]   || Animoto::Styles::ORIGINAL
+        @postroll   = Animoto::Postroll.new(options[:postroll] || Animoto::Postroll::POWERED_BY_ANIMOTO)
         @visuals    = []
         @song       = nil
       end
@@ -108,6 +124,14 @@ module Animoto
         self
       end
 
+      # Sets the postroll for this project.
+      #
+      # @param [String,Animoto::Postroll] roll a postroll object or the postroll's template name
+      # @return [Animoto::Postroll]
+      def postroll= roll
+        @postroll = Animoto::Postroll.new(roll)
+      end
+
       # Returns a representation of this manifest as a Hash.
       #
       # @return [Hash{String=>Object}] the manifest as a Hash
@@ -116,18 +140,18 @@ module Animoto
         hash = { 'directing_job' => { 'directing_manifest' => {} } }
         job  = hash['directing_job']
         add_callback_information job
-        manifest = job['directing_manifest']
-        manifest['style'] = style
-        manifest['pacing'] = pacing if pacing
-        manifest['title'] = title if title
-        manifest['visuals'] = []
+        manifest              = job['directing_manifest']
+        manifest['style']     = style
+        manifest['pacing']    = pacing if pacing
+        manifest['postroll']  = postroll.to_hash if postroll
+        manifest['title']     = title if title
+        manifest['visuals']   = []
         visuals.each do |visual|
           manifest['visuals'] << visual.to_hash
         end
         manifest['song'] = song.to_hash if song
         hash
       end
-    
     end
   end
-end
+end

data/lib/animoto/manifests/rendering.rb

@@ -18,6 +18,12 @@ module Animoto
       # The storyboard this rendering targets.
       # @return [Resources::Storyboard]
       attr_accessor :storyboard
+
+      # If streaming is set to true, a "live" stream will be made available to watch while the
+      # video is rendering via HTTP Live Streaming. This stream URL will be exposed on the
+      # associated {Resources::Jobs::Rendering rendering job}.
+      # @return [Boolean]
+      attr_writer :streaming
       
       # Creates a new rendering manifest.
       #
@@ -36,8 +42,19 @@ module Animoto
         @resolution = options[:resolution]
         @framerate  = options[:framerate]
         @format     = options[:format]
+        @streaming  = options[:streaming]
+        # We may or may not ever support other streaming formats
+        @streaming_format = "http_live_streaming"
       end
     
+      # Returns true if an HTTP Live Streaming URL will be created for this video while it's
+      # rendering.
+      #
+      # @return [Boolean]
+      def streaming?
+        @streaming
+      end
+
       # Returns a representation of this manifest as a Hash.
       #
       # @return [Hash{String=>Object}] this manifest as a Hash
@@ -52,8 +69,12 @@ module Animoto
         params['resolution'] = resolution
         params['framerate'] = framerate
         params['format'] = format
+        if streaming?
+          params['streaming_parameters'] = {}
+          params['streaming_parameters']['format'] = @streaming_format
+        end
         hash
       end    
     end
   end
-end
+end

data/lib/animoto/postroll.rb

@@ -0,0 +1,34 @@
+module Animoto
+  class Postroll
+    # Constructs a new postroll. If given a Postroll object, returns
+    # it. Otherwise, passes the arguments to the constructor for this
+    # Postroll class.
+    #
+    # @param [Array<Object>] args Postroll objects or constructor params
+    # @return [Animoto::Postroll]
+    def self.new *args
+      args.first.is_a?(self) ? args.first : super
+    end
+
+    # The template name for this postroll.
+    # @return [String]
+    attr_reader :template
+
+    # Creates a new Postroll with the given template name.
+    #
+    # @param [String] template the template name
+    # @return [Animoto::Postroll]
+    def initialize template
+      @template = template
+    end
+
+    # Returns a representation of this postroll as a hash.
+    # @return [Hash{String=>Object}]
+    def to_hash
+      {'template' => @template}
+    end
+
+    POWERED_BY_ANIMOTO = new("powered_by_animoto").freeze
+    WHITE_LABEL        = new("white_label").freeze
+  end
+end

data/lib/animoto/postrolls/custom_footage.rb

@@ -0,0 +1,30 @@
+require 'animoto/postroll'
+
+module Animoto
+  class Postroll
+    class CustomFootage < Animoto::Postroll
+
+      # The URL to a video to insert into this custom footage postroll.
+      # @return [String]
+      attr_accessor :source_url
+
+      # Creates a new postroll with custom footage at the supplied
+      # URL.
+      #
+      # @param [String] source_url a url to a video file to be inserted into
+      #   this custom postroll template
+      # @return [Animoto::Postroll::CustomFootage]
+      def initialize source_url
+        super("custom_footage")
+        @source_url = source_url
+      end
+
+      # Returns a representation of this postroll as a hash.
+      #
+      # @return [Hash{String=>Object}]
+      def to_hash
+        super.merge({'source_url' => source_url})
+      end
+    end
+  end
+end

data/lib/animoto/resources/jobs/directing_and_rendering.rb

@@ -9,7 +9,8 @@ module Animoto
           links = unpack_links(body)
           super.merge({
             :storyboard_url => links['storyboard'],
-            :video_url      => links['video']
+            :video_url      => links['video'],
+            :stream_url     => links['stream']
           })
         end
 
@@ -36,6 +37,13 @@ module Animoto
         # @return [Resources::Video]
         attr_reader :video
 
+        # If available, the URL where the video can be watched 'live' via HTTP Live Streaming.
+        # 
+        # @note this attribute may not be available when this job is created. If you poll the
+        #   job while it's rendering, the URL will appear when the stream is available to view.
+        # @return [String]
+        attr_reader :stream_url
+
         # @return [Jobs::DirectingAndRendering]
         # @see Animoto::Jobs::Base#instantiate
         def instantiate attributes = {}
@@ -43,10 +51,11 @@ module Animoto
           @storyboard     = Animoto::Resources::Storyboard.new(:url => @storyboard_url) if @storyboard_url
           @video_url      = attributes[:video_url]
           @video          = Animoto::Resources::Video.new(:url => @video_url) if @video_url
+          @stream_url     = attributes[:stream_url]
           super
         end
     
       end
     end
   end
-end
+end

data/lib/animoto/resources/jobs/rendering.rb

@@ -9,7 +9,8 @@ module Animoto
           links = unpack_links(body)
           super.merge({
             :storyboard_url => links['storyboard'],
-            :video_url      => links['video']
+            :video_url      => links['video'],
+            :stream_url     => links['stream']
           })
         end
     
@@ -30,6 +31,13 @@ module Animoto
         # @note This URL points to the video *resource* and not the actual video *file*.
         # @return [String]
         attr_reader :video_url
+
+        # If available, the URL where the video can be watched 'live' via HTTP Live Streaming.
+        #
+        # @note this attribute may not be available when the job is first created. If you poll
+        #   the job while it's rendering, the URL will appear when the stream is available to view.
+        # @return [String]
+        attr_reader :stream_url
     
         # @return [Jobs::Rendering]
         # @see Animoto::Jobs::Base#instantiate
@@ -38,10 +46,11 @@ module Animoto
           @storyboard = Animoto::Resources::Storyboard.new(:url => @storyboard_url) if @storyboard_url
           @video_url = attributes[:video_url]
           @video = Animoto::Resources::Video.new(:url => @video_url) if @video_url
+          @stream_url = attributes[:stream_url]
           super
         end
         
       end
     end
   end
-end
+end

data/lib/animoto/resources/video.rb

@@ -18,6 +18,7 @@ module Animoto
           :download_url     => links['file'],
           :storyboard_url   => links['storyboard'],
           :cover_image_url  => links['cover_image'],
+          :stream_url       => links['stream'],
           :format           => params['format'],
           :framerate        => params['framerate'],
           :resolution       => params['resolution']
@@ -36,10 +37,14 @@ module Animoto
       # @return [Resources::Storyboard]
       attr_reader :storyboard
       
-      # In available, the URL to the cover image file.
+      # If available, the URL to the cover image file.
       # @return [String]
       attr_reader :cover_image_url
       
+      # If available, the URL where this video can be watched via HTTP Live Streaming.
+      # @return [String]
+      attr_reader :stream_url
+
       # The format of the video.
       # @return [String]
       attr_reader :format
@@ -57,6 +62,7 @@ module Animoto
       # @param [Hash{Symbol=>Object}] attributes
       # @option attributes [String] :download_url the URL where this video can be downloaded
       # @option attributes [String] :storyboard_url the URL for this video's storyboard
+      # @option attributes [String] :stream_url the URL for this video's HTTP Live Streaming playlist
       # @option attributes [String] :format the format of this video
       # @option attributes [Integer] :framerate the framerate of this video
       # @option attributes [String] :resolution the vertical resolution of this video
@@ -67,6 +73,7 @@ module Animoto
         @storyboard_url = attributes[:storyboard_url]
         @storyboard = Animoto::Resources::Storyboard.new(:url => @storyboard_url) if @storyboard_url
         @cover_image_url = attributes[:cover_image_url]
+        @stream_url = attributes[:stream_url]
         @format = attributes[:format]
         @framerate = attributes[:framerate]
         @resolution = attributes[:resolution]
@@ -75,4 +82,4 @@ module Animoto
 
     end
   end
-end
+end

data/lib/animoto/styles.rb

@@ -0,0 +1,10 @@
+module Animoto
+  module Styles
+    ORIGINAL            = "original"
+    MOTHERS_DAY_2011    = "mothers_day_2011"
+    ELEGANCE            = "elegance_12"
+    VINTAGE             = "vintage"
+    COSMIC_TIDINGS      = "cosmic_tidings"
+    WONDERLAND_OF_SNOW  = "wonderland_of_snow"
+  end
+end

data/spec/animoto/manifests/directing_spec.rb

@@ -11,22 +11,62 @@ describe Animoto::Manifests::Directing do
       manifest(:title => "Funderful Wonderment").title.should == "Funderful Wonderment"
     end
     
-    it "should default to 'default' pacing" do
-      manifest.pacing.should == 'default'
+    it "should default to 'auto' pacing" do
+      manifest.pacing.should == 'auto'
     end
     
     it "should be able to specify the pacing with a :pacing parameter" do
-      manifest(:pacing => 'double').pacing.should == 'double'
+      manifest(:pacing => 'fast').pacing.should == 'fast'
     end
     
     it "should default to 'original' style" do
-      manifest.style.should == 'original'
+      manifest.style.should == Animoto::Styles::ORIGINAL
+    end
+
+    it "should be able to specify the style with a :style parameter" do
+      manifest(:style => Animoto::Styles::VINTAGE).style.should == Animoto::Styles::VINTAGE
+    end
+
+    it "should default to having the 'powered by animoto' postroll" do
+      manifest.postroll.should == Animoto::Postroll::POWERED_BY_ANIMOTO
+    end
+
+    it "should be able to specify the postroll with a :postroll parameter" do
+      manifest(:postroll => Animoto::Postroll::WHITE_LABEL).postroll.should == Animoto::Postroll::WHITE_LABEL
     end
     
-    it "should default to having to visuals" do
+    it "should default to having no visuals" do
       manifest.visuals.should be_empty
     end
   end
+
+  describe "setting the postroll" do
+    before do
+      @manifest = manifest()
+    end
+
+    describe "with a string" do
+      before do
+        @postroll = "fancy"
+        @manifest.postroll = @postroll
+      end
+
+      it "should set the postroll to a new postroll object with the given template" do
+        @manifest.postroll.template.should == @postroll
+      end
+    end
+
+    describe "with another Postroll" do
+      before do
+        @postroll = Animoto::Postroll::CustomFootage.new("http://postrollz.com/postroll.mp4")
+        @manifest.postroll = @postroll
+      end
+
+      it "should set the postroll to the given postroll object" do
+        @manifest.postroll.should eql(@postroll)
+      end
+    end
+  end
   
   describe "adding assets" do
     describe "using the append operator" do
@@ -119,6 +159,11 @@ describe Animoto::Manifests::Directing 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
+
+    it "should have a 'postroll' object in the manifest" do
+      manifest.to_hash['directing_job']['directing_manifest'].should have_key('postroll')
+      manifest.to_hash['directing_job']['directing_manifest']['postroll'].should be_a(Hash)
+    end
     
     describe "when the callback url is set" do
       before do
@@ -170,4 +215,4 @@ describe Animoto::Manifests::Directing do
       end
     end
   end
-end
+end

data/spec/animoto/manifests/rendering_spec.rb

@@ -36,6 +36,10 @@ describe Animoto::Manifests::Rendering do
       manifest.http_callback_url.should == "http://website.com/callback"
       manifest.http_callback_format.should == 'xml'
     end
+
+    it "should take a :streaming parameter to set streaming" do
+      manifest(:streaming => true).streaming?.should be_true
+    end
   end
   
   describe "generating a hash" do
@@ -43,7 +47,7 @@ describe Animoto::Manifests::Rendering do
       @storyboard = Animoto::Resources::Storyboard.new
       @url = "http://platform.animoto.com/storyboards/1"
       @storyboard.instance_variable_set(:@url, @url)
-      manifest(@storyboard, :resolution => "720p", :framerate => 24, :format => 'flv')
+      manifest(@storyboard, :resolution => "720p", :framerate => 24, :format => 'flv', :streaming => true)
     end
     
     it "should have a top-level 'rendering_job' object" do
@@ -82,6 +86,21 @@ describe Animoto::Manifests::Rendering do
       it "should have a 'format' key" do
         @profile['format'].should == manifest.format
       end
+
+      describe "streaming parameters" do
+        before do
+          @streaming_params = manifest.to_hash['rendering_job']['rendering_manifest']['rendering_parameters']['streaming_parameters']
+        end
+
+        it "should be present if streaming is enabled" do
+          @streaming_params.should_not be_nil
+        end
+
+        it "should have a 'format' key with the streaming format" do
+          @streaming_params.should have_key('format')
+          @streaming_params['format'].should == manifest.instance_variable_get(:@streaming_format)
+        end
+      end
     end
     
     describe "when an HTTP callback is set" do
@@ -112,4 +131,4 @@ describe Animoto::Manifests::Rendering do
       end
     end
   end
-end
+end

data/spec/animoto/resources/jobs/directing_and_rendering_spec.rb

@@ -24,7 +24,8 @@ describe Animoto::Resources::Jobs::DirectingAndRendering do
               'state' => 'completed',
               'links' => {
                 'self' => 'http://animoto.com/jobs/directing_and_rendering/1',
-                'video' => 'http://animoto.com/videos/1'
+                'video' => 'http://animoto.com/videos/1',
+                'stream' => 'http://animoto.com/streams/1.m3u8'
               }
             }
           }
@@ -41,5 +42,9 @@ describe Animoto::Resources::Jobs::DirectingAndRendering do
       @job.video.should be_an_instance_of(Animoto::Resources::Video)
       @job.video.url.should == @job.video_url
     end
+
+    it "should set its stream_url from the 'stream' link given" do
+      @job.stream_url.should == 'http://animoto.com/streams/1.m3u8'
+    end
   end  
-end
+end

data/spec/animoto/resources/jobs/rendering_spec.rb

@@ -27,7 +27,8 @@ describe Animoto::Resources::Jobs::Rendering do
               'links' => {
                 'self' => 'http://animoto.com/jobs/rendering/1',
                 'storyboard' => 'http://animoto.com/storyboards/1',
-                'video' => 'http://animoto.com/videos/1'
+                'video' => 'http://animoto.com/videos/1',
+                'stream' => 'http://animoto.com/streams/1.m3u8'
               }
             }
           }
@@ -53,5 +54,9 @@ describe Animoto::Resources::Jobs::Rendering do
       @job.video.should be_an_instance_of(Animoto::Resources::Video)
       @job.video.url.should == @job.video_url
     end
+
+    it "should set its stream url from the 'stream' link given" do
+      @job.stream_url.should == 'http://animoto.com/streams/1.m3u8'
+    end
   end
 end

data/spec/animoto/resources/video_spec.rb

@@ -30,7 +30,8 @@ describe Animoto::Resources::Video do
                 'self' => 'https://platform.animoto.com/videos/1',
                 'file' => 'http://storage.com/videos/1.mp4',
                 'cover_image' => 'http://storage.com/videos/1/cover_image.jpg',
-                'storyboard' => 'https://platform.animoto.com/storyboards/1'
+                'storyboard' => 'https://platform.animoto.com/storyboards/1',
+                'stream' => 'http://animoto.com/streams/1.m3u8'
               }
             }
           }
@@ -51,13 +52,17 @@ describe Animoto::Resources::Video do
       @video.cover_image_url.should == 'http://storage.com/videos/1/cover_image.jpg'
     end
     
-    it "should set its storyboard url from the 'storyboard_url' given" do
+    it "should set its storyboard url from the 'storyboard' link given" do
       @video.storyboard_url.should == 'https://platform.animoto.com/storyboards/1'
     end
     
     it "should set its storyboard from its storyboard url" do
       @video.storyboard.url.should == 'https://platform.animoto.com/storyboards/1'
     end
+
+    it "should set its stream url from the 'stream' link given" do
+      @video.stream_url.should == 'http://animoto.com/streams/1.m3u8'
+    end
     
     it "should set its format from the format given" do
       @video.format.should == 'h264'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: animoto
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
+  hash: 3
+  prerelease: 
   segments: 
   - 1
-  - 3
-  - 1
-  version: 1.3.1
+  - 5
+  - 0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Animoto
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-28 00:00:00 -04:00
-default_executable: 
+date: 2012-01-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -70,6 +69,8 @@ files:
 - ./lib/animoto/manifests/rendering.rb
 - ./lib/animoto/manifests/storyboard_bundling.rb
 - ./lib/animoto/manifests/storyboard_unbundling.rb
+- ./lib/animoto/postroll.rb
+- ./lib/animoto/postrolls/custom_footage.rb
 - ./lib/animoto/resources/base.rb
 - ./lib/animoto/resources/jobs/base.rb
 - ./lib/animoto/resources/jobs/directing.rb
@@ -82,6 +83,7 @@ files:
 - ./lib/animoto/response_parsers/base.rb
 - ./lib/animoto/response_parsers/json_adapter.rb
 - ./lib/animoto/response_parsers/yajl_adapter.rb
+- ./lib/animoto/styles.rb
 - ./lib/animoto/support/content_type.rb
 - ./lib/animoto/support/dynamic_class_loader.rb
 - ./lib/animoto/support/errors.rb
@@ -115,7 +117,6 @@ files:
 - ./spec/animoto/support/standard_envelope_spec.rb
 - ./spec/animoto_spec.rb
 - ./spec/spec_helper.rb
-has_rdoc: true
 homepage: http://animoto.com
 licenses: []
 
@@ -145,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.12
 signing_key: 
 specification_version: 3
 summary: Client for working with the Animoto RESTful HTTP API