animoto 1.0.0 → 1.1.0

data/spec/animoto/http_engines/base_spec.rb

@@ -1,19 +1,6 @@
 require File.dirname(__FILE__) + '/../../spec_helper'
 
-describe Animoto::HTTPEngines::Base do
-  
-  describe "autoloading subclasses" do
-    before do
-      Animoto::HTTPEngines::Base.const_defined?(:BeefHearts).should be_false
-    end
-    
-    
-    
-    after do
-      Animoto::HTTPEngines::Base.remove_const(:BeefHearts)
-    end
-  end
-  
+describe Animoto::HTTPEngines::Base do  
   describe "making a request" do
     before do
       @engine = Animoto::HTTPEngines::Base.new

data/spec/animoto/manifests/rendering_spec.rb

@@ -41,7 +41,7 @@ describe Animoto::Manifests::Rendering do
   describe "generating a hash" do
     before do
       @storyboard = Animoto::Resources::Storyboard.new
-      @url = "http://animoto.com/storyboards/1"
+      @url = "http://platform.animoto.com/storyboards/1"
       @storyboard.instance_variable_set(:@url, @url)
       manifest(@storyboard, :resolution => "720p", :framerate => 24, :format => 'flv')
     end

data/spec/animoto/manifests/storyboard_bundling_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Animoto::Manifests::StoryboardBundling do
+  
+  describe "initialization" do
+    before do
+      @storyboard = Animoto::Resources::Storyboard
+    end
+    
+    it "should take a storyboard as the first argument" do
+      Animoto::Manifests::StoryboardBundling.new(@storyboard).storyboard.should == @storyboard
+    end
+    
+    it "should take :http_callback_url and :http_callback_format parameters to set the callback" do
+      manifest = Animoto::Manifests::StoryboardBundling.new(@storyboard, :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::Resources::Storyboard.new
+      @url = "http://platform.animoto.com/storyboards/1"
+      @storyboard.instance_variable_set(:@url, @url)
+      @manifest = Animoto::Manifests::StoryboardBundling.new(@storyboard)
+    end
+
+    it "should have a top-level storyboard_bundling_job object" do
+      @manifest.to_hash.should have_key('storyboard_bundling_job')
+      @manifest.to_hash['storyboard_bundling_job'].should be_a(Hash)
+    end
+    
+    it "should have a storyboard_bundling_manifest object in the storyboard_bundling_job object" do
+      @manifest.to_hash['storyboard_bundling_job'].should have_key('storyboard_bundling_manifest')
+      @manifest.to_hash['storyboard_bundling_job']['storyboard_bundling_manifest'].should be_a(Hash)
+    end
+    
+    it "should have a storyboard_url key in the manifest, whose value is the storyboard's URL" do
+      @manifest.to_hash['storyboard_bundling_job']['storyboard_bundling_manifest'].should have_key('storyboard_url')
+      @manifest.to_hash['storyboard_bundling_job']['storyboard_bundling_manifest']['storyboard_url'].should == @storyboard.url
+    end
+
+    describe "when a 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 "and the format is also set" do
+        before do
+          @manifest.http_callback_format = 'xml'
+        end
+        
+        it "should have an http_callback key in the job object, whose value is the HTTP callback URL" do
+          @manifest.to_hash['storyboard_bundling_job'].should have_key('http_callback')
+          @manifest.to_hash['storyboard_bundling_job']['http_callback'].should == @manifest.http_callback_url
+        end
+        
+        it "should have an http_callback_format key in the job object, whose value is the callback's format" do
+          @manifest.to_hash['storyboard_bundling_job'].should have_key('http_callback_format')
+          @manifest.to_hash['storyboard_bundling_job']['http_callback_format'].should == @manifest.http_callback_format
+        end
+      end
+    end
+  end
+  
+end

data/spec/animoto/manifests/storyboard_unbundling_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Animoto::Manifests::StoryboardUnbundling do
+  
+  describe "initialization" do
+    before do
+      @bundle_url = "http://partner.com/animoto-bundle.zip"
+    end
+    
+    it "should take a storyboard as the first argument" do
+      Animoto::Manifests::StoryboardUnbundling.new(:bundle_url => @bundle_url).bundle_url.should == @bundle_url
+    end
+    
+    it "should take :http_callback_url and :http_callback_format parameters to set the callback" do
+      manifest = Animoto::Manifests::StoryboardUnbundling.new(:bundle_url => @bundle_url, :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
+      @bundle_url = "http://partner.com/animoto-bundle.zip"
+      @manifest = Animoto::Manifests::StoryboardUnbundling.new(:bundle_url => @bundle_url)
+    end
+
+    it "should have a top-level storyboard_unbundling_job object" do
+      @manifest.to_hash.should have_key('storyboard_unbundling_job')
+      @manifest.to_hash['storyboard_unbundling_job'].should be_a(Hash)
+    end
+    
+    it "should have a storyboard_unbundling_manifest object in the storyboard_unbundling_job object" do
+      @manifest.to_hash['storyboard_unbundling_job'].should have_key('storyboard_unbundling_manifest')
+      @manifest.to_hash['storyboard_unbundling_job']['storyboard_unbundling_manifest'].should be_a(Hash)
+    end
+    
+    it "should have a bundle_url key in the manifest, whose value is the bundle's URL" do
+      @manifest.to_hash['storyboard_unbundling_job']['storyboard_unbundling_manifest'].should have_key('bundle_url')
+      @manifest.to_hash['storyboard_unbundling_job']['storyboard_unbundling_manifest']['bundle_url'].should == @bundle_url
+    end
+
+    describe "when a 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 "and the format is also set" do
+        before do
+          @manifest.http_callback_format = 'xml'
+        end
+        
+        it "should have an http_callback key in the job object, whose value is the HTTP callback URL" do
+          @manifest.to_hash['storyboard_unbundling_job'].should have_key('http_callback')
+          @manifest.to_hash['storyboard_unbundling_job']['http_callback'].should == @manifest.http_callback_url
+        end
+        
+        it "should have an http_callback_format key in the job object, whose value is the callback's format" do
+          @manifest.to_hash['storyboard_unbundling_job'].should have_key('http_callback_format')
+          @manifest.to_hash['storyboard_unbundling_job']['http_callback_format'].should == @manifest.http_callback_format
+        end
+      end
+    end
+  end
+  
+end

data/spec/animoto/resources/base_spec.rb

@@ -17,7 +17,7 @@ describe Animoto::Resources::Base do
 
   describe "identity mapping" do
     before do
-      @url = "https://api.animoto.com/videos/1"
+      @url = "https://platform.animoto.com/videos/1"
       @video = Animoto::Resources::Video.new :url => @url
       @body = {
         'response' => {
@@ -26,7 +26,7 @@ describe Animoto::Resources::Base do
             'video' => {
               'links' => {
                 'download' => "http://animoto.com/videos/1",
-                'storyboard' => "https://api.animoto.com/storyboards/1",
+                'storyboard' => "https://platform.animoto.com/storyboards/1",
                 'self' => @url
               },
               'metadata' => {

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

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../spec_helper")
+
+describe Animoto::Resources::Jobs::StoryboardBundling do
+
+  it "should have endpoint /jobs/storyboard_bundling" do
+    Animoto::Resources::Jobs::StoryboardBundling.endpoint.should == '/jobs/storyboard_bundling'
+  end
+  
+  it "should have content type 'application/vnd.animoto.storyboard_bundling_job" do
+    Animoto::Resources::Jobs::StoryboardBundling.content_type.should == 'storyboard_bundling_job'
+  end
+  
+  it "should have payload key storyboard_bundling_job" do
+    Animoto::Resources::Jobs::StoryboardBundling.payload_key.should == 'storyboard_bundling_job'
+  end
+
+  describe "loading from a response body" do
+    before do
+      @body = {
+        'response' => {
+          'status' => {
+            'code' => 200
+          },
+          'payload' => {
+            'storyboard_bundling_job' => {
+              'state' => 'completed',
+              'links' => {
+                'self' => 'https://platform.animoto.com/jobs/storyboard_bundling/1',
+                'bundle' => 'http://some-kind-of-storage-service.com/animoto-bundles/1'
+              }
+            }
+          }
+        }
+      }
+      @job = Animoto::Resources::Jobs::StoryboardBundling.load @body
+    end
+    
+    it "should set the bundle_url from the body" do
+      @job.bundle_url.should == "http://some-kind-of-storage-service.com/animoto-bundles/1"
+    end
+  end
+
+end

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

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + "/../../../spec_helper")
+
+describe Animoto::Resources::Jobs::StoryboardUnbundling do
+
+  it "should have endpoint /jobs/storyboard_unbundling" do
+    Animoto::Resources::Jobs::StoryboardUnbundling.endpoint.should == '/jobs/storyboard_unbundling'
+  end
+  
+  it "should have content type 'application/vnd.animoto.storyboard_unbundling_job" do
+    Animoto::Resources::Jobs::StoryboardUnbundling.content_type.should == 'storyboard_unbundling_job'
+  end
+  
+  it "should have payload key storyboard_unbundling_job" do
+    Animoto::Resources::Jobs::StoryboardUnbundling.payload_key.should == 'storyboard_unbundling_job'
+  end
+
+  describe "loading from a response body" do
+    before do
+      @body = {
+        'response' => {
+          'status' => {
+            'code' => 200
+          },
+          'payload' => {
+            'storyboard_unbundling_job' => {
+              'state' => 'completed',
+              'links' => {
+                'self' => 'https://platform.animoto.com/jobs/storyboard_unbundling/1',
+                'storyboard' => 'https://platform.animoto.com/storyboards/1'
+              }              
+            }
+          }
+        }
+      }
+      @job = Animoto::Resources::Jobs::StoryboardUnbundling.load @body
+    end
+    
+    it "should set the storyboard_url from the body" do
+      @job.storyboard_url.should == "https://platform.animoto.com/storyboards/1"
+    end
+    
+    it "should create a storyboard from the storyboard url" do
+      @job.storyboard.should be_a(Animoto::Resources::Storyboard)
+      @job.storyboard_url.should == @job.storyboard.url
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,9 +1,10 @@
-require 'rubygems'
-require 'spec'
+Bundler.setup(:default, :test)
+
+require 'rspec'
 require 'webmock/rspec'
 require 'mocha'
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   config.mock_with :mocha
   config.include WebMock::API
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: animoto
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Animoto
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-13 00:00:00 -05:00
+date: 2011-02-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
         version: 0.0.0
   type: :runtime
   version_requirements: *id001
-description: ""
+description: The Animoto API is a RESTful web service that transforms images, videos, music, and text into amazing video presentations. The Animoto API Ruby Client provides a convenient Ruby interface for working with the Animoto RESTful HTTP API.
 email: theteam@animoto.com
 executables: []
 
@@ -44,7 +44,6 @@ extra_rdoc_files: []
 
 files: 
 - README.md
-- ./integration/test.rb
 - ./lib/animoto/assets/base.rb
 - ./lib/animoto/assets/footage.rb
 - ./lib/animoto/assets/image.rb
@@ -61,11 +60,15 @@ files:
 - ./lib/animoto/manifests/directing.rb
 - ./lib/animoto/manifests/directing_and_rendering.rb
 - ./lib/animoto/manifests/rendering.rb
+- ./lib/animoto/manifests/storyboard_bundling.rb
+- ./lib/animoto/manifests/storyboard_unbundling.rb
 - ./lib/animoto/resources/base.rb
 - ./lib/animoto/resources/jobs/base.rb
 - ./lib/animoto/resources/jobs/directing.rb
 - ./lib/animoto/resources/jobs/directing_and_rendering.rb
 - ./lib/animoto/resources/jobs/rendering.rb
+- ./lib/animoto/resources/jobs/storyboard_bundling.rb
+- ./lib/animoto/resources/jobs/storyboard_unbundling.rb
 - ./lib/animoto/resources/storyboard.rb
 - ./lib/animoto/resources/video.rb
 - ./lib/animoto/response_parsers/base.rb
@@ -90,11 +93,15 @@ files:
 - ./spec/animoto/manifests/directing_and_rendering_spec.rb
 - ./spec/animoto/manifests/directing_spec.rb
 - ./spec/animoto/manifests/rendering_spec.rb
+- ./spec/animoto/manifests/storyboard_bundling_spec.rb
+- ./spec/animoto/manifests/storyboard_unbundling_spec.rb
 - ./spec/animoto/resources/base_spec.rb
 - ./spec/animoto/resources/jobs/base_spec.rb
 - ./spec/animoto/resources/jobs/directing_and_rendering_spec.rb
 - ./spec/animoto/resources/jobs/directing_spec.rb
 - ./spec/animoto/resources/jobs/rendering_spec.rb
+- ./spec/animoto/resources/jobs/storyboard_bundling_spec.rb
+- ./spec/animoto/resources/jobs/storyboard_unbundling_spec.rb
 - ./spec/animoto/resources/storyboard_spec.rb
 - ./spec/animoto/resources/video_spec.rb
 - ./spec/animoto/response_parsers/json_adapter_spec.rb
@@ -137,6 +144,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: ""
+summary: Client for working with the Animoto RESTful HTTP API
 test_files: []
 

data/integration/test.rb

@@ -1,49 +0,0 @@
-require 'rubygems'
-require 'rdiscount'
-require 'nokogiri'
-require 'yaml'
-
-puts "Reading in code from README.md"
-
-readme_path = File.dirname(__FILE__) + '/../README.md'
-begin
-  readme = RDiscount.new(File.read(readme_path))
-rescue Errno::ENOENT
-  raise "README.md not found in #{File.expand_path(readme_path)}!"
-end
-
-begin
-  credentials = YAML.load(File.read(File.dirname(__FILE__) + '/credentials.yml'))
-rescue Errno::ENOENT
-  raise "Credentials file not found at #{File.expand_path(File.dirname(__FILE__) + '/credentials.yml')}!"
-end
-
-begin
-  assets = YAML.load(File.read(File.dirname(__FILE__) + '/assets.yml'))
-rescue Errno::ENOENT
-  raise "Assets file not found in at #{File.dirname(__FILE__) + '/assets.yml'}!" unless assets
-end
-
-doc = Nokogiri::HTML(readme.to_html)
-example_code_path = '//h3[contains(text(),"basic example")]/following-sibling::pre/code/text()'
-code_node = doc.at(example_code_path)
-
-raise "Example code not found in README (expected at xpath '#{example_code_path}')" unless code_node
-
-code = code_node.text
-
-puts "Replacing example credentials with valid ones"
-code.sub!(/Client\.new\(.+\)/, %Q{Client.new("#{credentials[:key]}","#{credentials[:secret]}",:endpoint => "#{credentials[:endpoint]}")})
-
-puts "Replacing example assets with valid ones"
-code.gsub!(/Image\.new\(.+\)/) { %Q{Image.new("#{assets[:images].shift}")} }
-# Replace the song with a real one
-code.sub!(/Song\.new\(.+\)/, %Q{Song.new("#{assets[:song]}")})
-# Get rid of the footage (since it won't render right now anyway)
-code = code.lines.reject { |l| /Footage\.new/ === l }.join
-
-puts "Executing example"
-eval code
-
-puts
-puts "If you're seeing this, things should have worked fine!"