encoding-dot-com 0.0.1

data/spec/queue_spec.rb

@@ -0,0 +1,311 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Encoding.com Queue facade" do
+
+  before :each do
+    @http = mock("Http Interface")
+    @facade = EncodingDotCom::Queue.new(1234, "abcd", @http)
+  end
+
+  def expect_xml_with_xpath(xpath)
+    @http.should_receive(:post).with(EncodingDotCom::Queue::ENDPOINT,
+                                     EncodingXpathMatcher.new(xpath)).and_return(stub("Http Response", :code => "200", :body => ""))
+  end
+
+  def expect_response_xml(response_xml)
+    response = stub("Http Response", :code => "200", :body => response_xml)
+    @http.should_receive(:post).and_return(response)
+  end
+  
+  describe "any xml sent to encoding.com" do
+    [:add_and_process, :status].each do |method|
+      it "should have a root query node for method #{method}" do
+        expect_xml_with_xpath("/query")
+        @facade.send(method, stub("source"))
+      end
+
+      it "should have a user_id node for method #{method}" do
+        expect_xml_with_xpath("/query/userid[text()=1234]")
+        @facade.send(method, stub("source"))        
+      end
+
+      it "should have a user key node for method #{method}" do
+        expect_xml_with_xpath("/query/userkey[text()='abcd']")
+        @facade.send(method, stub("source"))                
+      end
+    end
+  end
+
+  describe "request sent to encoding.com" do
+    it "should return true if a success" do
+      @http.should_receive(:post).and_return(stub("Http Response", :code => "200", :body => ""))
+      @facade.add_and_process(stub("source"), {}).should be_true
+    end
+
+    it "should raise an AvailabilityError if response status from encoding.com is not a 200" do
+      @http.should_receive(:post).and_return(stub("Http Response", :code => "503", :body => ""))
+      lambda { @facade.add_and_process(stub("source"), {}) }.should raise_error(EncodingDotCom::AvailabilityError)
+    end
+
+    it "should raise an MessageError if response contains errors" do
+      response = stub("Http Response",
+                      :code => "200",
+                      :body => "<?xml version=\"1.0\"?>\n<response><errors><error>Wrong query format</error></errors></response>\n")
+      @http.should_receive(:post).and_return(response)
+      lambda { @facade.add_and_process(stub("source"), {}) }.should raise_error(EncodingDotCom::MessageError)
+    end
+  end
+  
+  describe "xml sent to encoding.com to process a video" do
+    it "should have an action of 'AddMedia'." do
+      expect_xml_with_xpath("/query/action[text()='AddMedia']")
+      @facade.add_and_process(stub("source"), {})
+    end
+
+    it "should include the source url" do
+      expect_xml_with_xpath("/query/source[text()='http://example.com/']")
+      @facade.add_and_process("http://example.com/", {})
+    end
+
+    it "should include the formats provided" do
+      expect_xml_with_xpath("/query/format/output[text()='flv']")
+      format = EncodingDotCom::Format.create("output" => "flv")
+      @facade.add_and_process(stub("source"), {stub("destination") => format})
+    end
+
+    it "should include the destination urls in the formats provided" do
+      expect_xml_with_xpath("/query/format/destination[text()='http://example.com']")
+      format = EncodingDotCom::Format.create("output" => "flv")
+      @facade.add_and_process(stub("source"), {"http://example.com" => format})
+    end
+  end
+
+  describe "calling add_and_process" do
+    it "should return the a media id" do
+      expect_response_xml("<response><MediaID>1234</MediaID></response>")
+      @facade.add_and_process(stub("source"), {}).should == 1234
+    end
+  end
+
+  describe "xml sent to encoding.com to get the status of a job" do
+    it "should include a action node with 'GetStatus'" do
+      expect_xml_with_xpath("/query/action[text()='GetStatus']")
+      @facade.status("mediaid")
+    end
+
+    it "should include a media id node" do
+      expect_xml_with_xpath("/query/mediaid[text()='abcd']")
+      @facade.status("abcd")
+    end
+  end
+
+  describe "calling simple status method" do
+    it "should respond with a string status from encoding.com" do
+      expect_response_xml("<response><status>New</status></response>")
+      @facade.status("mediaid").should == "New"
+    end
+  end
+
+  describe "calling get media list method" do
+    it "should include an action node with 'GetMediaList'" do
+      expect_xml_with_xpath("/query/action[text()='GetMediaList']")
+      @facade.list
+    end
+    
+    describe "returned MediaListItems" do
+      before :each do
+        expect_response_xml(<<-END
+        <response>
+            <media>
+                <mediafile>foo.wmv</mediafile>
+                <mediaid>1234</mediaid>
+                <mediastatus>Closed</mediastatus>
+                <createdate>2009-01-01 12:00:01</createdate>
+                <startdate>2009-01-01 12:00:02</startdate>
+                <finishdate>2009-01-01 12:00:03</finishdate>
+            </media>
+        </response>
+        END
+        )
+      end
+      
+      it "should return an array of media list values" do
+        @facade.list.should be_kind_of(Enumerable)
+      end
+
+      it "should have a hash of returned attributes with a mediafile key" do
+        @facade.list.first.media_file.should == "foo.wmv"
+      end
+      
+      it "should have a hash of returned attributes with a mediaid key" do
+        @facade.list.first.media_id.should == 1234
+      end
+      
+      it "should have a hash of returned attributes with a mediastatus key" do
+        @facade.list.first.media_status.should == "Closed"
+      end
+      
+      it "should have a hash of returned attributes with a createdate key" do
+        @facade.list.first.create_date.should == Time.local(2009, 1, 1, 12, 0, 1)
+      end
+
+      it "should have a hash of returned attributes with a startdate key" do
+        @facade.list.first.start_date.should == Time.local(2009, 1, 1, 12, 0, 2)
+      end
+
+      it "should have a hash of returned attributes with a finishdate key" do
+        @facade.list.first.finish_date.should == Time.local(2009, 1, 1, 12, 0, 3)
+      end
+    end
+  end
+
+  describe "deleting specified media and all its items in the queue" do
+    it "should have an action of 'CancelMedia'." do
+      expect_xml_with_xpath("/query/action[text()='CancelMedia']")
+      @facade.cancel(5678)
+    end
+
+    it "should have a mediaid of 1234." do
+      expect_xml_with_xpath("/query/mediaid[text()='5678']")
+      @facade.cancel(5678)
+    end
+  end
+
+  describe "processing items already in the encoding" do
+    it "should have an action of 'CancelMedia'." do
+      expect_xml_with_xpath("/query/action[text()='ProcessMedia']")
+      @facade.process(5678)
+    end
+
+    it "should have a mediaid of 1234." do
+      expect_xml_with_xpath("/query/mediaid[text()='5678']")
+      @facade.process(5678)
+    end
+  end
+
+  describe "updating formats of an item already in the encoding.com queue" do
+    it "should have an action of 'UpdateMedia'." do
+      expect_xml_with_xpath("/query/action[text()='UpdateMedia']")
+      @facade.update(5678, {})
+    end
+
+    it "should have a mediaid of 1234." do
+      expect_xml_with_xpath("/query/mediaid[text()='5678']")
+      @facade.update(5678, {})
+    end
+
+    it "should include the formats provided" do
+      expect_xml_with_xpath("/query/format/output[text()='flv']")
+      format = EncodingDotCom::Format.create("output" => "flv")
+      @facade.update(5678, {stub("destination") => format})
+    end
+
+    it "should include the destination urls in the formats provided" do
+      expect_xml_with_xpath("/query/format/destination[text()='http://example.com']")
+      format = EncodingDotCom::Format.create("output" => "flv")
+      @facade.update(5678, {"http://example.com" => format})
+    end
+  end
+
+  describe "adding an item to the encoding.com queue but not processing it" do
+    it "should have an action of 'AddMedia'." do
+      expect_xml_with_xpath("/query/action[text()='AddMediaBenchmark']")
+      @facade.add(stub("source"), {})
+    end
+
+    it "should include the source url" do
+      expect_xml_with_xpath("/query/source[text()='http://example.com/']")
+      @facade.add("http://example.com/", {})
+    end
+
+    it "should include the formats provided" do
+      expect_xml_with_xpath("/query/format/output[text()='flv']")
+      format = EncodingDotCom::Format.create("output" => "flv")
+      @facade.add(stub("source"), {stub("destination") => format})
+    end
+
+    it "should include the destination urls in the formats provided" do
+      expect_xml_with_xpath("/query/format/destination[text()='http://example.com']")
+      format = EncodingDotCom::Format.create("output" => "flv")
+      @facade.add(stub("source"), {"http://example.com" => format})
+    end
+  end
+
+  describe "getting information about a specified media item" do
+    it "should have an action of 'GetMediaInfo'." do
+      expect_xml_with_xpath("/query/action[text()='GetMediaInfo']")
+      @facade.info(5678)
+    end
+
+    it "should have a mediaid of 1234." do
+      expect_xml_with_xpath("/query/mediaid[text()='5678']")
+      @facade.cancel(5678)
+    end
+
+    describe "returned media info object" do
+      before :each do
+        expect_response_xml(<<-END
+          <?xml version="1.0"?>
+          <response>
+            <bitrate>1807k</bitrate>
+            <duration>6464.83</duration>
+            <video_codec>mpeg4</video_codec>
+            <video_bitrate>1679k</video_bitrate>
+            <frame_rate>23.98</frame_rate>
+            <size>640x352</size>
+            <pixel_aspect_ratio>1:1</pixel_aspect_ratio>
+            <display_aspect_ratio>20:11</display_aspect_ratio>
+            <audio_codec>ac3</audio_codec>
+            <audio_sample_rate>48000</audio_sample_rate>
+            <audio_channels>2</audio_channels>
+          </response>
+        END
+        )
+      end
+
+      it "should have a bitrate" do
+        @facade.info(1234).bitrate.should == "1807k"
+      end
+
+      it "should have a duration" do
+        @facade.info(1234).duration.should == 6464.83
+      end
+
+      it "should have a video_codec" do
+        @facade.info(1234).video_codec.should == "mpeg4"
+      end
+
+      it "should have a video_bitrate" do
+        @facade.info(1234).video_bitrate.should == "1679k"
+      end
+
+      it "should have a frame rate" do
+        @facade.info(1234).frame_rate.should == 23.98
+      end
+
+      it "should have a size" do
+        @facade.info(1234).size.should == "640x352"
+      end
+
+      it "should hava a pixel aspect ratio" do
+        @facade.info(1234).pixel_aspect_ratio.should == "1:1"
+      end
+
+      it "should have a display aspect ratio" do
+        @facade.info(1234).display_aspect_ratio.should == "20:11"
+      end
+
+      it "should have an audio codec" do
+        @facade.info(1234).audio_codec.should == "ac3"
+      end
+
+      it "should have an audio sample rate" do
+        @facade.info(1234).audio_sample_rate.should == 48_000
+      end
+
+      it "should have audio channels" do
+        @facade.info(1234).audio_channels.should == 2
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,46 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'encoding-dot-com'
+require 'spec'
+require 'spec/autorun'
+require 'nokogiri'
+
+class EncodingXpathMatcher
+  def initialize(xpath)
+    @xpath = xpath
+  end
+
+  def ==(post_vars)
+    ! Nokogiri::XML(post_vars[:xml]).xpath(@xpath).empty?
+  end
+end
+
+module XpathMatchers
+  class HaveXpath
+    def initialize(xpath)
+      @xpath = xpath
+    end
+
+    def matches?(xml)
+      @xml = xml
+      Nokogiri::XML(xml).xpath(@xpath).any?
+    end
+
+    def failure_message
+      "expected #{@xml} to have xpath #{@xpath}"
+    end
+
+    def negative_failure_message
+      "expected #{@xml} not to have xpath #{@xpath}"
+    end
+  end
+
+  def have_xpath(xpath)
+    HaveXpath.new(xpath)
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(XpathMatchers)
+end

data/spec/thumbnail_format_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Encoding.com Thumbnail Format" do
+
+  it "should have an output attribute of 'thumbnail'" do
+    EncodingDotCom::ThumbnailFormat.new.output.should == "thumbnail"
+  end
+
+  it "should return a ThumbnailFormat if the output is 'thumbnail'" do
+    EncodingDotCom::Format.create("output" => "thumbnail").should be_instance_of(EncodingDotCom::ThumbnailFormat)
+  end
+
+  def format_xml(attributes={})
+    format = EncodingDotCom::ThumbnailFormat.new(attributes)
+    Nokogiri::XML::Builder.new {|b| format.build_xml(b, "http://example.com") }.to_xml
+  end
+  
+  it "should produce a format node in the xml output" do
+    format_xml.should have_xpath("/format")
+  end
+
+  it "should produce an output node in the xml output" do
+    format_xml.should have_xpath("/format/output[text()='thumbnail']")
+  end
+
+  it "should produce a height node in the xml output" do
+    format_xml("height" => 10).should have_xpath("/format/height[text()='10']")
+  end
+
+  it "should produce a width node in the xml output" do
+    format_xml("width" => 10).should have_xpath("/format/width[text()='10']")
+  end
+
+  it "should produce a time node in the xml output" do
+    format_xml("time" => 10).should have_xpath("/format/time[text()='10']")
+  end
+
+  it "should produce a destination node in the output" do
+    format_xml.should have_xpath("/format/destination[text()='http://example.com']")
+  end
+
+  describe "valid times" do
+    it "can be a number greater than 0.01" do
+      lambda { EncodingDotCom::ThumbnailFormat.new("time" => "0") }.should raise_error(EncodingDotCom::IllegalFormatAttribute)
+      lambda { EncodingDotCom::ThumbnailFormat.new("time" => "0.5") }.should_not raise_error
+    end
+
+    it "can be specified in HH:MM::SS.ms format" do
+      lambda { EncodingDotCom::ThumbnailFormat.new("time" => "00:00:01.5") }.should_not raise_error
+    end
+  end
+
+  describe "valid dimensions" do
+    it "should be a positive integer height" do
+      lambda { EncodingDotCom::ThumbnailFormat.new("height" => -1) }.should raise_error(EncodingDotCom::IllegalFormatAttribute)
+      lambda { EncodingDotCom::ThumbnailFormat.new("height" => 1) }.should_not raise_error      
+    end
+
+    it "should be a positive integer width" do
+      lambda { EncodingDotCom::ThumbnailFormat.new("width" => -1) }.should raise_error(EncodingDotCom::IllegalFormatAttribute)
+      lambda { EncodingDotCom::ThumbnailFormat.new("width" => 1) }.should_not raise_error      
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: encoding-dot-com
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Roland Swingler
+- Alan Kennedy
+- Levent Ali
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-07 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A ruby wrapper for the encoding.com API
+email: roland.swingler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- encoding-dot-com.gemspec
+- lib/encoding-dot-com.rb
+- lib/encoding_dot_com.rb
+- lib/encoding_dot_com/attribute_restrictions.rb
+- lib/encoding_dot_com/errors.rb
+- lib/encoding_dot_com/flv_vp6_format.rb
+- lib/encoding_dot_com/format.rb
+- lib/encoding_dot_com/http_adapters/curb_adapter.rb
+- lib/encoding_dot_com/http_adapters/net_http_adapter.rb
+- lib/encoding_dot_com/media_info.rb
+- lib/encoding_dot_com/media_list_item.rb
+- lib/encoding_dot_com/queue.rb
+- lib/encoding_dot_com/thumbnail_format.rb
+- lib/encoding_dot_com/video_format.rb
+- spec/encoding_dot_com/http_adapters/curb_adapter_spec.rb
+- spec/encoding_dot_com/http_adapters/net_http_adapter_spec.rb
+- spec/flv_vp6_format_spec.rb
+- spec/format_spec.rb
+- spec/media_list_item_spec.rb
+- spec/queue_spec.rb
+- spec/spec_helper.rb
+- spec/thumbnail_format_spec.rb
+has_rdoc: true
+homepage: http://encodingdotcom.rubyforge.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper for the encoding.com API
+test_files: 
+- spec/flv_vp6_format_spec.rb
+- spec/spec_helper.rb
+- spec/encoding_dot_com/http_adapters/net_http_adapter_spec.rb
+- spec/encoding_dot_com/http_adapters/curb_adapter_spec.rb
+- spec/format_spec.rb
+- spec/queue_spec.rb
+- spec/media_list_item_spec.rb
+- spec/thumbnail_format_spec.rb