animoto 1.5.5 → 1.5.6

data/lib/animoto.rb

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

data/lib/animoto/client.rb

@@ -317,4 +317,4 @@ module Animoto
     end
     
   end
-end
+end

data/lib/animoto/manifests/base.rb

@@ -28,14 +28,20 @@ module Animoto
       # @return [String]
       attr_accessor :http_callback_format
 
+      attr_accessor :partner_metadata
+
       # Creates a new manifest
       #
       # @param [Hash{Symbol=>Object}] options
       # @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
+      # @option options [String] :partner_metadata an array of hashes with a predefined format containing  
+      #   the hashes for ['partner_user_id', 'commercial_use', 'partner_intent', 'application_data']
+      #   where application_data is an array of hashes ['title', 'id', 'kind', 'type']
       def initialize options = {}
         @http_callback_url  = options[:http_callback_url]
         @http_callback_format = options[:http_callback_format]
+        @partner_metadata  = options[:partner_metadata]
       end
 
       # Returns a representation of this manifest as a Hash, used to populate
@@ -55,6 +61,16 @@ module Animoto
       end
       
       private
+
+      # Helper method to put the partner_metadata into the manifest hash
+      #
+      # @param [Hash{String=>Object}] job_hash the hash version of the 'job' portion of this manifest
+      # @return [void]
+      def add_partner_metadata job_hash
+        if partner_metadata
+          job_hash['partner_metadata'] = partner_metadata
+        end
+      end
       
       # Helper method to put the standard HTTP callback information into the manifest hash
       #
@@ -70,4 +86,4 @@ module Animoto
       end
     end
   end
-end
+end

data/lib/animoto/manifests/directing.rb

@@ -145,6 +145,7 @@ module Animoto
         hash = { 'directing_job' => { 'directing_manifest' => {} } }
         job  = hash['directing_job']
         add_callback_information job
+        add_partner_metadata job
         manifest              = job['directing_manifest']
         manifest['style']     = style
         manifest['pacing']    = pacing if pacing

data/lib/animoto/manifests/directing_and_rendering.rb

@@ -55,7 +55,9 @@ module Animoto
         hash  = { 'directing_and_rendering_job' => {} }
         job   = hash['directing_and_rendering_job']
         add_callback_information job
+        add_partner_metadata job
         job['directing_manifest'] = self.directing_manifest.to_hash['directing_job']['directing_manifest']
+        
         job['rendering_manifest'] = self.rendering_manifest.to_hash['rendering_job']['rendering_manifest']
         hash
       end

data/lib/animoto/manifests/rendering.rb

@@ -63,6 +63,7 @@ module Animoto
         hash  = { 'rendering_job' => { 'rendering_manifest' => { 'rendering_parameters' => {} } } }
         job   = hash['rendering_job']
         add_callback_information job
+        add_partner_metadata job
         manifest = job['rendering_manifest']
         manifest['storyboard_url'] = storyboard.url if storyboard
         params = manifest['rendering_parameters']

data/lib/animoto/partner_metadata.rb

@@ -0,0 +1,6 @@
+class PartnerMetadata
+  def self.public_params_spec
+    application_data = {'application_data' => ['title', 'id', 'kind', 'type']}
+    {'partner_metadata' => ['partner_user_id', 'commercial_use', 'partner_intent', application_data]}
+  end 
+end

data/lib/example.rb

@@ -1,14 +1,30 @@
 #!/usr/bin/env ruby
+require 'ruby-debug'
 require 'animoto/client'
 include Animoto
 
 # Create a new client using our application key and secret
 client = Client.new("bb0d0e005ac4012dc17712313b013462", "c0fe4cfca8bf544b8d0e687247a600ef55ff82e3")
 client.endpoint = "https://platform-staging.animoto.com" 
+#client = Client.new("698dbba063bc012ea77d1231380e2ed9", "fd3dc39b57878951b480db818c2f3c15")
+#client.endpoint = "https://platform-sandbox.animoto.com"
 
-custom_footage = Postroll::CustomFootage.new("http://s3-s.animoto.com/Footage/wInVzO78f0SjP1GTFtfPrA/t.mp4") #("http://api.client.java.animoto.s3.amazonaws.com/test_assets/footage.mp4")
-#custom_footage.start_time = 2.0
-#custom_footage.duration = 5.0
+custom_footage = Postroll::CustomFootage.new("http://s3-s.animoto.com/Footage/wInVzO78f0SjP1GTFtfPrA/t.mp4?v=animotopro")
+
+#custom_footage = Postroll::CustomFootage.new("http://s3-s.animoto.com/Footage/wInVzO78f0SjP1GTFtfPrA/t.mp4")
+
+custom_footage = Postroll::CustomFootage.new("http://api.client.java.animoto.s3.amazonaws.com/test_assets/footage.mp4")
+custom_footage.start_time = 2.0
+custom_footage.duration = 3.0
+
+
+#application_data = {'application_data' => ['title', 'id', 'kind', 'type']}
+
+#{'partner_metadata' => ['partner_user_id', 'commercial_use', 'partner_intent', application_data]}
+
+app = {'title' => 'hello', 'id' => 'asdf', 'kind' => 'my', 'type' => 'video'}
+
+metadata = {'partner_user_id' => '234', 'commercial_use' => 'our wish', 'partner_intent' => 'business', 'application_data' => app}
 
 # create a directing and rendering manifest with the video title and
 # producer.  Also include rendering parameters like resolution, framerate,
@@ -20,30 +36,36 @@ manifest = Manifests::DirectingAndRendering.new(
   :pacing => "fast",
   :framerate => 24,
   :format => 'h264',
+  :partner_metadata => metadata,
   :postroll => custom_footage
 )
 
+id = { "partner_user_id" => "42-24010"}
+
 # Add some images, text, and footage to our manifest.
 
 img1 = Assets::Image.new("http://cdn.toucharcade.com/wp-content/uploads/2012/12/hac1.jpg")
 #img1.cover = "Doctorine of pace"
 #img1.rotation = 2
 #img1.spotlit = true
-#img1.caption = "Birds can't walk"
+img1.caption = "Birds can't walk"
 
 img2 = Assets::Image.new("http://api.client.java.animoto.s3.amazonaws.com/test_assets/image.jpg")
 img3 = Assets::Image.new("http://blogs.independent.co.uk/wp-content/uploads/2012/12/some-girls-300x225.jpg")
 
 card1 = Assets::TitleCard.new("f1", "01234567890123456789")
-
+card2 = Assets::TitleCard.new("f1", "012sssh 256789")
+card3 = Assets::TitleCard.new("f1", "01234333333")
+footage1 = Assets::Footage.new("http://s3-s.animoto.com/Footage/wInVzO78f0SjP1GTFtfPrA/t.mp4")
 
 
 manifest << img1
 manifest << card1
-#manifest << img2
-#manifest << img3
-#manifest << card2
-#manifest << card3
+manifest << img2
+manifest << img3
+manifest << card2
+manifest << card3
+manifest << footage1
 
 # Setup the soundtrack.
 manifest << Assets::Song.new("http://api.client.java.animoto.s3.amazonaws.com/test_assets/song.mp3", :artist => "Fishy Joe")

data/lib/example2.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+require 'ruby-debug'
+require 'animoto/client'
+include Animoto
+
+client = Client.new("bb0d0e005ac4012dc17712313b013462", "c0fe4cfca8bf544b8d0e687247a600ef55ff82e3")
+client.endpoint = "https://platform-staging.animoto.com" 
+
+custom_footage = Postroll::CustomFootage.new("http://s3-s.animoto.com/Footage/wInVzO78f0SjP1GTFtfPrA/t.mp4?v=animotopro")
+
+custom_footage = Postroll::CustomFootage.new("http://api.client.java.animoto.s3.amazonaws.com/test_assets/footage.mp4")
+custom_footage.start_time = 2.0
+custom_footage.duration = 3.0
+
+metadata = {'partner_user_id' => '234', 'commercial_use' => 'our wish'}
+
+manifest = Manifests::DirectingAndRendering.new(
+  :title => "Amazing Venus3!",
+  :resolution => "360p",
+  :style => "original",
+  :pacing => "fast",
+  :framerate => 24,
+  :format => 'h264',
+  :partner_metadata => metadata,
+  :postroll => custom_footage
+)
+
+id = { "partner_user_id" => "42-24010"}
+manifest.partner_metadata = 'asdf'
+debugger
+
+img1 = Assets::Image.new("http://cdn.toucharcade.com/wp-content/uploads/2012/12/hac1.jpg")
+img1.caption = "Birds can't walk"
+
+img2 = Assets::Image.new("http://api.client.java.animoto.s3.amazonaws.com/test_assets/image.jpg")
+img3 = Assets::Image.new("http://blogs.independent.co.uk/wp-content/uploads/2012/12/some-girls-300x225.jpg")
+
+card1 = Assets::TitleCard.new("f1", "01234567890123456789")
+card2 = Assets::TitleCard.new("f1", "012sssh 256789")
+card3 = Assets::TitleCard.new("f1", "01234333333")
+footage1 = Assets::Footage.new("http://s3-s.animoto.com/Footage/wInVzO78f0SjP1GTFtfPrA/t.mp4")
+
+
+manifest << img1
+manifest << card1
+manifest << img2
+manifest << img3
+manifest << card2
+manifest << card3
+manifest << footage1
+
+manifest << Assets::Song.new("http://api.client.java.animoto.s3.amazonaws.com/test_assets/song.mp3", :artist => "Fishy Joe")
+
+
+
+
+dr_job = client.render!(manifest)
+
+while dr_job.pending?
+  sleep(1)
+  puts "making it ready..."
+  client.reload!(dr_job)
+end

data/spec/animoto/manifests/directing_and_rendering_spec.rb

@@ -20,6 +20,17 @@ describe Animoto::Manifests::DirectingAndRendering do
       manifest.to_hash.should have_key('directing_and_rendering_job')
       manifest.to_hash['directing_and_rendering_job'].should be_a(Hash)
     end
+
+    describe "when the partner metadata is set" do
+      before do
+        manifest.partner_metadata = {'partner_user_id' => '234', 'commercial_use' => 'No'}
+      end
+
+      it "should have the HTTP callback URL in the job" do
+        manifest.to_hash['directing_and_rendering_job'].should have_key('partner_metadata')
+        manifest.to_hash['directing_and_rendering_job']['partner_metadata'].should == manifest.partner_metadata
+      end
+    end
     
     describe "when the callback url is set" do
       before do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: animoto
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: 
   segments: 
   - 1
   - 5
-  - 5
-  version: 1.5.5
+  - 6
+  version: 1.5.6
 platform: ruby
 authors: 
 - Animoto
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-12 00:00:00 Z
+date: 2013-07-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -61,6 +61,7 @@ files:
 - ./lib/animoto/manifests/rendering.rb
 - ./lib/animoto/manifests/storyboard_bundling.rb
 - ./lib/animoto/manifests/storyboard_unbundling.rb
+- ./lib/animoto/partner_metadata.rb
 - ./lib/animoto/postroll.rb
 - ./lib/animoto/postrolls/custom_footage.rb
 - ./lib/animoto/resources/base.rb
@@ -84,6 +85,7 @@ files:
 - ./lib/animoto/support/string.rb
 - ./lib/animoto.rb
 - ./lib/example.rb
+- ./lib/example2.rb
 - ./spec/animoto/assets/base_spec.rb
 - ./spec/animoto/assets/footage_spec.rb
 - ./spec/animoto/assets/image_spec.rb
@@ -141,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Client for working with the Animoto RESTful HTTP API