animoto 1.2.0 → 1.3.0

data/lib/animoto.rb

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

data/lib/animoto/assets/base.rb

@@ -11,6 +11,7 @@ module Animoto
       # Creates a new asset.
       #
       # @param [String] source the URL of this asset
+      # @param [Hash{Symbol=>Object}] options
       # @return [Assets::Base] the asset
       def initialize source, options = {}
         @source = source
@@ -21,7 +22,7 @@ module Animoto
       #
       # @return [Hash{String=>Object}] this asset as a Hash
       def to_hash
-        { 'source_url' => @source }
+        { 'source_url' => @source, 'type' => self.class.name.split('::').last.underscore }
       end
 
     end

data/lib/animoto/assets/footage.rb

@@ -1,9 +1,6 @@
 module Animoto
   module Assets
     class Footage < Animoto::Assets::Base
-      include Support::Visual
-      include Support::Coverable
-      
       # Whether or not to mix the audio of this footage with the video's soundtrack.
       # @return [Boolean]
       attr_accessor :audio_mix
@@ -17,16 +14,51 @@ module Animoto
       # @return [Float]
       attr_accessor :duration
     
+      # The number of clockwise 90-degree rotations that should be applied to this video.
+      # @return [Integer]
+      attr_accessor :rotation
+      
+      # Whether or not this footage is the cover of the video. If this piece of footage is
+      # the video's cover, the cover image will be generated from a frame in this footage.
+      # @return [Boolean]
+      attr_writer :cover
+      
+      # Returns whether or not this footage is marked as the cover.
+      # @return [Boolean]
+      def cover?
+        @cover
+      end
+
+      # Creates a new Footage object.
+      #
+      # @param [String] source the source URL of this footage
+      # @param [Hash{Symbol=>Object}] options
+      # @option options [Boolean] :audio_mix whether or not to mix the audio from this footage with the soundtrack of the video
+      # @option options [Float] :start_time the offset in seconds from the beginning of where to start playing this footage
+      # @option options [Float] :duration the length in seconds to play this footage
+      # @option options [Integer] :rotation the number of clockwise 90-degree rotations to apply to this footage
+      # @option options [Boolean] :cover whether or not to generate the cover of this video from this footage
+      # @return [Assets::Footage] the Footage object
+      def initialize source, options = {}
+        super
+        @audio_mix  = options[:audio_mix]
+        @start_time = options[:start_time]
+        @duration   = options[:duration]
+        @rotation   = options[:rotation]
+        @cover      = options[:cover]
+      end
+
       # Returns a representation of this Footage as a Hash.
       #
       # @return [Hash{String=>Object}] this asset as a Hash
-      # @see Animoto::Support::Visual#to_hash
       # @see Animoto::Assets::Base#to_hash
       def to_hash
         hash = super
         hash['audio_mix'] = 'MIX' if audio_mix
         hash['start_time'] = start_time if start_time
         hash['duration'] = duration if duration
+        hash['rotation'] = rotation if rotation
+        hash['cover'] = cover? unless @cover.nil?
         hash 
       end
     end

data/lib/animoto/assets/image.rb

@@ -1,17 +1,50 @@
 module Animoto
   module Assets
     class Image < Animoto::Assets::Base
-      include Support::Visual
-      include Support::Coverable
-
-      # The EXIF rotation value for how this image should be rotated in the video.
+      # The number of clockwise 90-degree rotations that should be applied to this image.
       # @return [Integer]
       attr_accessor :rotation
-    
+      
+      # Whether or not this image is spotlit. Spotlighting a visual tells to director to add
+      # more emphasis to this visual when directing.
+      # @return [Boolean]
+      attr_writer :spotlit
+      
+      # Returns whether or not this image is spotlit.
+      # @return [Boolean]
+      def spotlit?
+        @spotlit
+      end
+      
+      # Whether or not this image is the cover of the video. If this image is the video's cover,
+      # the cover image will be generated using this image.
+      # @return [Boolean]
+      attr_writer :cover
+      
+      # Returns whether or not this footage is marked as the cover.
+      # @return [Boolean]
+      def cover?
+        @cover
+      end
+
+      # Creates a new Image object.
+      #
+      # @param [String] source the source URL of this image
+      # @param [Hash{Symbol=>Object}] options
+      # @option options [Integer] :rotation the number of clockwise 90-degree rotations to apply to this image
+      # @option options [Boolean] :spotlit whether or not to spotlight this image
+      # @option options [Boolean] :cover whether or not to generate the cover of this video from this image
+      # @return [Assets::Image] the Image object
+      def initialize source, options = {}
+        super
+        @rotation = options[:rotation]
+        @spotlit  = options[:spotlit]
+        @cover    = options[:cover]
+      end
+      
       # Returns a representation of this Image as a Hash.
       #
       # @return [Hash{String=>Object}] this asset as a Hash
-      # @see Animoto::Support::Visual#to_hash
       # @see Animoto::Assets::Base#to_hash
       def to_hash
         hash = super

data/lib/animoto/assets/song.rb

@@ -10,6 +10,33 @@ module Animoto
       # The duration in seconds of how long this song should play.
       # @return [Float]
       attr_accessor :duration
+
+      # The title of this song. Defaults to the title read from the metadata of
+      # the source file.
+      # @return [String]
+      attr_accessor :title
+      
+      # The artist of this song. Default to the title read from the metadata of
+      # the source file.
+      # @return [String]
+      attr_accessor :artist
+
+      # Creates a new Song object.
+      #
+      # @param [String] source the source URL of this song
+      # @param [Hash{Symbol=>Object}] options
+      # @option options [Float] :start_time the time offset in seconds from the beginning of where to start playing this song
+      # @option options [Float] :duration the length in seconds of how long to play this song
+      # @option options [String] :title the title of this song. Defaults to being read from the song file's metadata
+      # @option options [String] :artist the artist of this song. Defaults to being read from the song file's metadata
+      # @return [Assets::Song] the Song object
+      def initialize source, options = {}
+        super
+        @start_time = options[:start_time]
+        @duration   = options[:duration]
+        @title      = options[:title]
+        @artist     = options[:artist]
+      end
     
       # Returns a representation of this Song as a Hash.
       #
@@ -19,6 +46,8 @@ module Animoto
         hash = super
         hash['start_time'] = start_time if start_time
         hash['duration'] = duration if duration
+        hash['title'] = title if title
+        hash['artist'] = artist if artist
         hash
       end
     

data/lib/animoto/assets/title_card.rb

@@ -1,8 +1,6 @@
 module Animoto
   module Assets
     class TitleCard
-      include Support::Visual
-      
       # The main text of this title card.
       # @return [String]
       attr_accessor :title
@@ -11,20 +9,34 @@ module Animoto
       # @return [String]
       attr_accessor :subtitle
     
+      # Whether or not this image is spotlit. Spotlighting a visual tells to director to add
+      # more emphasis to this visual when directing.
+      # @return [Boolean]
+      attr_writer :spotlit
+      
+      # Returns whether or not this image is spotlit.
+      # @return [Boolean]
+      def spotlit?
+        @spotlit
+      end
+      
       # Creates a new TitleCard.
       #
       # @param [String] title the main text
       # @param [String] subtitle the secondary text
-      def initialize title, subtitle = nil
+      # @param [Hash{Symbol=>Object}] options
+      # @option options [Boolean] :spotlit whether or not to spotlight this title card
+      # @return [Assets::TitleCard] the TitleCard object
+      def initialize title, subtitle = nil, options = {}
         @title, @subtitle = title, subtitle
+        @spotlit = options[:spotlit]
       end
     
       # Returns a representation of this TitleCard as a Hash.
       #
       # @return [Hash{String=>Object}] this TitleCard as a Hash
-      # @see Animoto::Support::Visual#to_hash
       def to_hash
-        hash = super
+        hash = {}
         hash['h1'] = title
         hash['h2'] = subtitle if subtitle
         hash['spotlit'] = spotlit? unless @spotlit.nil?

data/lib/animoto/client.rb

@@ -3,13 +3,11 @@ require 'uri'
 require 'logger'
 
 require 'animoto/support/content_type'
-require 'animoto/support/coverable'
 require 'animoto/support/dynamic_class_loader'
 require 'animoto/support/errors'
 require 'animoto/support/hash'
 require 'animoto/support/standard_envelope'
 require 'animoto/support/string'
-require 'animoto/support/visual'
 
 require 'animoto/resources/base'
 require 'animoto/resources/storyboard'

data/lib/animoto/manifests/directing.rb

@@ -11,8 +11,8 @@ module Animoto
       # @return [String]
       attr_accessor :pacing
       
-      # The array of Visual objects in this manifest.
-      # @return [Array<Support::Visual>]
+      # The array of visual objects in this manifest.
+      # @return [Array<Assets::Base,Assets::TitleCard>]
       attr_reader   :visuals
       
       # The song for this video.
@@ -85,14 +85,14 @@ module Animoto
 
       # Adds a visual/song to this manifest.
       #
-      # @param [Support::Visual,Assets::Song] asset the asset to add
+      # @param [Assets::Base,Assets::TitleCard] asset the asset to add
       # @return [void]
-      # @raise [ArgumentError] if the asset isn't a Song or Visual
+      # @raise [ArgumentError] if the asset isn't a Song, Image, Footage, or TitleCard
       def add_visual asset
         case asset
         when Animoto::Assets::Song
           @song = asset
-        when Animoto::Support::Visual
+        when Animoto::Assets::Base, Animoto::Assets::TitleCard
           @visuals << asset
         else
           raise ArgumentError
@@ -101,7 +101,7 @@ module Animoto
 
       # Adds a visual/song to this manifest.
       #
-      # @param [Support::Visual,Assets::Song] asset the asset to add
+      # @param [Assets::Base,Assets::TitleCard] asset the asset to add
       # @return [self]
       def << asset
         add_visual asset

data/spec/animoto/assets/footage_spec.rb

@@ -2,8 +2,35 @@ require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
 
 describe Animoto::Assets::Footage do
   
-  it "should be a visual" do
-    Animoto::Assets::Footage.should include(Animoto::Support::Visual)
+  describe "initialization" do
+    before do
+      @footage = Animoto::Assets::Footage.new 'http://website.com/movie.mp4',
+        :audio_mix => true, :start_time => 1.0, :duration => 5.0, :rotation => 3, :cover => true
+    end
+    
+    it "should set the source to the given url" do
+      @footage.source.should == 'http://website.com/movie.mp4'
+    end
+    
+    it "should set the audio mix to the given value" do
+      @footage.audio_mix.should be_true
+    end
+    
+    it "should set the start time to the given time" do
+      @footage.start_time.should == 1.0
+    end
+    
+    it "should set the duration to the given length" do
+      @footage.duration.should == 5.0
+    end
+    
+    it "should set the rotation to the given amount" do
+      @footage.rotation.should == 3
+    end
+    
+    it "should set the cover to the given value" do
+      @footage.should be_a_cover
+    end
   end
   
   describe "#to_hash" do
@@ -16,10 +43,6 @@ describe Animoto::Assets::Footage do
       @footage.to_hash['source_url'].should == @footage.source
     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
@@ -52,5 +75,27 @@ describe Animoto::Assets::Footage do
         @footage.to_hash['duration'].should == @footage.duration
       end
     end
+    
+    describe "if a rotation was given" do
+      before do
+        @footage.rotation = 3
+      end
+      
+      it "should have a 'rotation' key with the rotation" do
+        @footage.to_hash.should have_key('rotation')
+        @footage.to_hash['rotation'].should == @footage.rotation
+      end
+    end
+    
+    describe "if this footage is the cover" do
+      before do
+        @footage.cover = true
+      end
+      
+      it "should have a 'cover' key with telling whether or not this footage is the cover" do
+        @footage.to_hash.should have_key('cover')
+        @footage.to_hash['cover'].should == @footage.cover?
+      end
+    end
   end
 end

data/spec/animoto/assets/image_spec.rb

@@ -2,10 +2,29 @@ require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
 
 describe Animoto::Assets::Image do
   
-  it "should be a visual" do
-    Animoto::Assets::Image.should include(Animoto::Support::Visual)
+  describe "initialization" do
+    before do
+      @image = Animoto::Assets::Image.new 'http://website.com/image.png',
+        :rotation => 2, :spotlit => true, :cover => true
+    end
+    
+    it "should set the source to the given url" do
+      @image.source.should == 'http://website.com/image.png'
+    end
+    
+    it "should set the rotation to the given amount" do
+      @image.rotation.should == 2
+    end
+    
+    it "should set the spotlighting to the given value" do
+      @image.should be_spotlit
+    end
+    
+    it "should set the cover to the given value" do
+      @image.should be_a_cover
+    end
   end
-  
+
   describe "#to_hash" do
     before do
       @image = Animoto::Assets::Image.new 'http://website.com/image.png'
@@ -21,7 +40,7 @@ describe Animoto::Assets::Image do
         @image.rotation = 2
       end
       
-      it "should have a 'rotation' key with the EXIF rotation value" do
+      it "should have a 'rotation' key with the rotation value" do
         @image.to_hash.should have_key('rotation')
         @image.to_hash['rotation'].should == @image.rotation
       end
@@ -37,5 +56,16 @@ describe Animoto::Assets::Image do
         @image.to_hash['spotlit'].should == @image.spotlit?
       end
     end
+    
+    describe "if this image is the cover" do
+      before do
+        @image.cover = true
+      end
+      
+      it "should have a 'cover' key telling whether or not this image is the cover" do
+        @image.to_hash.should have_key('cover')
+        @image.to_hash['cover'].should == @image.cover?
+      end
+    end
   end
 end

data/spec/animoto/assets/song_spec.rb

@@ -2,6 +2,33 @@ require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
 
 describe Animoto::Assets::Song do
   
+  describe "initialization" do
+    before do
+      @song = Animoto::Assets::Song.new 'http://website.com/song.mp3',
+        :start_time => 30.0, :duration => 90.0, :title => "Hooray for Dolphins!", :artist => "Some Chick with Bangs"
+    end
+    
+    it "should set the source to the given url" do
+      @song.source.should == 'http://website.com/song.mp3'
+    end
+    
+    it "should set the start time to the given time" do
+      @song.start_time.should == 30.0
+    end
+    
+    it "should set the duration to the given length" do
+      @song.duration.should == 90.0
+    end
+    
+    it "should set the title to the given string" do
+      @song.title.should == 'Hooray for Dolphins!'
+    end
+    
+    it "should set the artist to the given string" do
+      @song.artist.should == 'Some Chick with Bangs'
+    end
+  end
+
   describe "#to_hash" do
     before do
       @song = Animoto::Assets::Song.new 'http://website.com/song.mp3'
@@ -32,6 +59,28 @@ describe Animoto::Assets::Song do
         @song.to_hash.should have_key('duration')
         @song.to_hash['duration'].should == @song.duration
       end
-    end    
+    end
+    
+    describe "if a title was specified" do
+      before do
+        @song.title = 'Hooray for Dolphins!'
+      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
+    
+    describe "if an artist was specified do" do
+      before do
+        @song.artist = 'Some Chick with Bangs'
+      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
+    end
   end
 end

data/spec/animoto/assets/title_card_spec.rb

@@ -2,10 +2,24 @@ require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
 
 describe Animoto::Assets::TitleCard do
   
-  it "should be a visual" do
-    Animoto::Assets::TitleCard.should include(Animoto::Support::Visual)
+  describe "initialization" do
+    before do
+      @card = Animoto::Assets::TitleCard.new "hooray", "for everything", :spotlit => true
+    end
+    
+    it "should set the title to the given string" do
+      @card.title.should == 'hooray'
+    end
+    
+    it "should set the subtitle to the given string" do
+      @card.subtitle.should == 'for everything'
+    end
+    
+    it "should set the spotlighting to the given value" do
+      @card.should be_spotlit
+    end
   end
-  
+
   describe "#to_hash" do
     before do
       @card = Animoto::Assets::TitleCard.new("hooray")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: animoto
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: false
   segments: 
   - 1
-  - 2
+  - 3
   - 0
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Animoto
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-05 00:00:00 -04:00
+date: 2011-04-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -83,13 +83,11 @@ files:
 - ./lib/animoto/response_parsers/json_adapter.rb
 - ./lib/animoto/response_parsers/yajl_adapter.rb
 - ./lib/animoto/support/content_type.rb
-- ./lib/animoto/support/coverable.rb
 - ./lib/animoto/support/dynamic_class_loader.rb
 - ./lib/animoto/support/errors.rb
 - ./lib/animoto/support/hash.rb
 - ./lib/animoto/support/standard_envelope.rb
 - ./lib/animoto/support/string.rb
-- ./lib/animoto/support/visual.rb
 - ./lib/animoto.rb
 - ./spec/animoto/assets/base_spec.rb
 - ./spec/animoto/assets/footage_spec.rb
@@ -114,9 +112,7 @@ files:
 - ./spec/animoto/resources/video_spec.rb
 - ./spec/animoto/response_parsers/json_adapter_spec.rb
 - ./spec/animoto/response_parsers/yajl_adapter_spec.rb
-- ./spec/animoto/support/coverable_spec.rb
 - ./spec/animoto/support/standard_envelope_spec.rb
-- ./spec/animoto/support/visual_spec.rb
 - ./spec/animoto_spec.rb
 - ./spec/spec_helper.rb
 has_rdoc: true

data/lib/animoto/support/coverable.rb

@@ -1,31 +0,0 @@
-module Animoto
-  module Support
-    module Coverable
-    
-      # Setter for cover, which makes this visual the cover for the video. Only
-      # one image or piece of footage in a manifest can be declared the cover.
-      #
-      # @param [Boolean] bool true if this visual should be the cover
-      def cover= bool
-        @cover = bool
-      end
-    
-      # Returns true if this visual is the cover.
-      #
-      # @return [Boolean] whether or not this visual is the cover
-      def cover?
-        @cover
-      end
-    
-      # Returns a representation of this visual as a Hash.
-      #
-      # @return [Hash{String=>Object}] this visual as a Hash
-      def to_hash
-        hash = super rescue {}
-        hash['cover'] = cover? unless @cover.nil?
-        hash
-      end
-    
-    end
-  end
-end

data/lib/animoto/support/visual.rb

@@ -1,32 +0,0 @@
-module Animoto
-  module Support
-    module Visual
-    
-      # Setter for spotlighting, which instructs the director to give special attention
-      # to this visual when directing.
-      #
-      # @param [Boolean] bool true if this visual should receive special attention
-      def spotlit= bool
-        @spotlit = bool
-      end
-    
-      # Returns true if this visual is spotlit.
-      #
-      # @return [Boolean] whether or not this visual is spotlit
-      def spotlit?
-        @spotlit
-      end
-
-      # Returns a representation of this Visual as a Hash
-      #
-      # @return [Hash{String=>Object}] this Visual as a Hash
-      def to_hash
-        hash = super rescue {}
-        hash['spotlit'] = spotlit? unless @spotlit.nil?
-        hash['type'] = self.class.name.split('::').last.underscore
-        hash
-      end
-    
-    end
-  end
-end

data/spec/animoto/support/coverable_spec.rb

@@ -1,5 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
-
-describe Animoto::Support::Coverable do
-  
-end

data/spec/animoto/support/visual_spec.rb

@@ -1,5 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
-
-describe Animoto::Support::Visual do
-  
-end