encoding-dot-com 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,8 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*~
+\#*
+.\#*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Enrich Social Productions Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,56 @@
+= encoding-dot-com
+
+A client library for the encoding.com[http://www.encoding.com] API.
+
+Supports all the actions of the encoding.com API. Example usage:
+
+    require "encoding_dot_com"
+    
+    # Create an interface to the encoding.com queue with your user id and secret
+    queue = EncodingDotCom::Queue.new(1234, "secret")
+    
+    # Create one or more output formats
+    format = EncodingDotCom::Format.create("output" => "flv")
+    
+    # Get an media item processed. You can pass multiple output formats in a hash.
+    media_id = queue.add_and_process("http://source/url/here", "http://destination/url/here" => format)
+    
+    queue.status(media_id) # => returns a string like "Waiting for encoder" or "Finished"
+    queue.info(media_id)   # => returns information about an item in the queue
+
+See the API documentation for more details - Queue is a good starting place. 
+
+By default the library uses Curb for http - there is also a Net/HTTP 
+adapter and it is easy to write your own.
+
+== Dependencies
+
+* Nokogiri
+* (Optionally) curb
+
+== TODOs
+
+* Flesh out validations to ensure that bad data does not get submitted to
+  encoding.com
+* Full status method
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Authors
+
+* {Roland Swingler}[http://github.com/knaveofdiamonds]
+* {Alan Kennedy}[http://github.com/alan]
+* {Levent Ali}[http://github.com/levent]
+
+== Copyright
+
+Copyright (c) 2009 Enrich Social Productions Ltd. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,75 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "encoding-dot-com"
+    gem.summary = %Q{A ruby wrapper for the encoding.com API}
+    gem.description = %Q{A ruby wrapper for the encoding.com API}
+    gem.email = "roland.swingler@gmail.com"
+    gem.homepage = "http://encodingdotcom.rubyforge.org/"
+    gem.authors = ["Roland Swingler", "Alan Kennedy", "Levent Ali"]
+    gem.add_dependency "nokogiri"
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Encoding dot com #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => [:spec, :roodi]
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/encoding-dot-com.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{encoding-dot-com}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Roland Swingler", "Alan Kennedy", "Levent Ali"]
+  s.date = %q{2009-12-07}
+  s.description = %q{A ruby wrapper for the encoding.com API}
+  s.email = %q{roland.swingler@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.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"
+  ]
+  s.homepage = %q{http://encodingdotcom.rubyforge.org/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A ruby wrapper for the encoding.com API}
+  s.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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/lib/encoding-dot-com.rb

@@ -0,0 +1,12 @@
+require 'encoding_dot_com/errors'
+require 'encoding_dot_com/queue'
+require 'encoding_dot_com/attribute_restrictions'
+require 'encoding_dot_com/format'
+require 'encoding_dot_com/video_format'
+require 'encoding_dot_com/thumbnail_format'
+require 'encoding_dot_com/flv_vp6_format'
+require 'encoding_dot_com/media_list_item'
+require 'encoding_dot_com/media_info'
+require 'encoding_dot_com/http_adapters/curb_adapter'
+require 'encoding_dot_com/http_adapters/net_http_adapter'
+

data/lib/encoding_dot_com/attribute_restrictions.rb

@@ -0,0 +1,74 @@
+module EncodingDotCom
+  module AttributeRestrictionsZune #:nodoc:
+    def validate_size
+      allowed_sizes = %w{320x120 320x180 320x0 0x120 0x180}
+      unless size.nil? || allowed_sizes.include?(size)
+        raise IllegalFormatAttribute.new("Size can only be one of #{allowed_sizes.join(',')} but was #{size}")
+      end
+    end
+  end
+
+  module AttributeRestrictionsIpod #:nodoc:
+    def validate_size
+      allowed_sizes = %w{320x240 640x480}
+      unless size.nil? || allowed_sizes.include?(size)
+        raise IllegalFormatAttribute.new("Size can only be one of #{allowed_sizes.join(',')} but was #{size}")
+      end
+    end
+  end
+
+  module AttributeRestrictionsFlv #:nodoc:
+#    validate_inclusion_of :audio_bitrate, %w{32k 40k 48k 56k 64k 80k 96k 112k 128k 144k 160k 192k 224k 256k 320k}
+#    validate_inclusion_of :video_codec, %w{flv libx264 vp6}
+    
+    def validate_audio_bitrate
+      allowed_bitrates = %w{32k 40k 48k 56k 64k 80k 96k 112k 128k 144k 160k 192k 224k 256k 320k}
+    end
+    
+    def validate_video_codec
+      allowed_codecs = %w{flv libx264 vp6}
+      unless video_codec.nil? || allowed_codecs.include?(video_codec)
+        raise IllegalFormatAttribute.new("Video codec can only be one of #{allowed_codecs.join(',')} but was #{video_codec}")
+      end
+    end
+  end
+
+  module AttributeRestrictionsMp4 #:nodoc:
+    def validate_video_codec
+      allowed_codecs = %w{mpeg4 libx264}
+      unless video_codec.nil? || allowed_codecs.include?(video_codec)
+        raise IllegalFormatAttribute.new("Video codec can only be one of #{allowed_codecs.join(',')} but was #{video_codec}")
+      end
+    end
+  end
+
+  module AttributeRestrictionsFl9 #:nodoc:
+  end
+
+  module AttributeRestrictionsWmv #:nodoc:
+  end
+
+  module AttributeRestrictions3gp #:nodoc:
+  end
+  
+  module AttributeRestrictionsM4v #:nodoc:
+  end
+
+  module AttributeRestrictionsIphone #:nodoc:
+  end
+  
+  module AttributeRestrictionsAppletv #:nodoc:
+  end
+
+  module AttributeRestrictionsPsp #:nodoc:
+  end
+  
+  module AttributeRestrictionsMp3 #:nodoc:
+  end
+  
+  module AttributeRestrictionsWma #:nodoc:
+  end
+  
+  module AttributeRestrictionsThumbnail #:nodoc:
+  end
+end

data/lib/encoding_dot_com/errors.rb

@@ -0,0 +1,15 @@
+module EncodingDotCom
+  # Error raised if there is an http-level problem accessing the
+  # encoding.com API.
+  class AvailabilityError < StandardError
+  end
+
+  # Error raised if there is an problem with the message sent to
+  # encoding.com API.
+  class MessageError < StandardError
+  end
+
+  # Error raised if a format's attribute has an illegal value
+  class IllegalFormatAttribute < StandardError
+  end
+end

data/lib/encoding_dot_com/flv_vp6_format.rb

@@ -0,0 +1,26 @@
+module EncodingDotCom
+  # FLV Format that uses the VP6 codec - there are fewer attributes
+  # that can be set for VP6 compared to other video codecs.
+  class FLVVP6Format < Format #:nodoc:
+    allowed_attributes :output, :video_codec, :size, :destination, :bitrate, :audio_bitrate, :audio_sample_rate, :audio_channels_number, :framerate
+    
+    def initialize(attributes={})
+      @attributes = attributes.merge("output" => "flv", "video_codec" => "vp6")
+      validate_attributes
+    end
+
+    def validate_attributes
+      validate_size
+    end
+        
+    private
+    
+    def validate_size
+      return if size.nil?
+      if video_codec == "vp6" && ! size.split("x").all? {|n| (n.to_i % 16) == 0 }
+        raise IllegalFormatAttribute.new("Dimensions #{} should be multiples of 16")
+      end
+    end
+    
+  end
+end

data/lib/encoding_dot_com/format.rb

@@ -0,0 +1,73 @@
+module EncodingDotCom
+  # Base class for all formats sent to encoding.com
+  #
+  # You should create formats by calling +create+ with format attributes.
+  class Format
+    class << self
+      # Factory method that returns an appropriate Format. The
+      # +output+ attribute is required, others are optional (see the
+      # encoding.com documentation for full list of attributes).
+      def create(attributes)
+        if attributes["output"] == "thumbnail"
+          ThumbnailFormat.new(attributes)
+        elsif attributes["output"] == "flv" && attributes["video_codec"] == "vp6"
+          FLVVP6Format.new(attributes)
+        else
+          VideoFormat.new(attributes)
+        end
+      end
+
+      def allowed_attributes(*attrs) #:nodoc:
+        @allowed_attributes ||= []
+        if attrs.empty?
+          @allowed_attributes
+        else
+          @allowed_attributes += attrs.map {|a| a.to_s }.each { |attr| define_method(attr) { @attributes[attr] } }
+        end
+      end
+      
+      def boolean_attributes(*attrs) #:nodoc:
+        @boolean_attributes ||= []
+        if attrs.empty?
+          @boolean_attributes  
+        else
+          allowed_attributes *attrs
+          @boolean_attributes += attrs.map {|a| a.to_s }
+        end
+      end
+    end
+
+    # Builds the XML for this format.
+    #
+    # +builder+:: a Nokogiri builder, declared with a block
+    # +destination_url+:: where the encoded file should be placed. See
+    #                     the encoding.com documentation for details.
+    def build_xml(builder, destination_url=nil)
+      logo_attributes, other_attributes = self.class.allowed_attributes.partition {|a| a[0..3] == "logo" }
+
+      builder.format {
+        builder.destination destination_url
+        other_attributes.each do |attr|
+          builder.send(attr, output_value(attr)) unless @attributes[attr].nil?
+        end
+        if logo_attributes.any? {|attr| @attributes[attr] }
+          builder.logo {
+            logo_attributes.each {|attr| builder.send(attr, output_value(attr)) if @attributes[attr] }
+          }
+        end
+      }
+    end
+
+    private
+
+    # Returns a value suitable for the format XML - i.e. translates
+    # booleans to yes/no.
+    def output_value(key)
+      if self.class.boolean_attributes.include?(key)
+        (@attributes[key] ? "yes" : "no")
+      else
+        @attributes[key]
+      end
+    end
+  end
+end

data/lib/encoding_dot_com/http_adapters/curb_adapter.rb

@@ -0,0 +1,27 @@
+module EncodingDotCom
+  module HttpAdapters
+
+    Response = Struct.new(:code, :body)
+
+    # Wraps the curb[http://curb.rubyforge.org/] library for use with
+    # the Queue.
+    class CurbAdapter
+      def initialize
+        require 'curb'
+      end
+
+      # Makes a POST request. Raises an AvailabilityError if the
+      # request times out or has other problems.
+      def post(url, parameters={})
+        curl = Curl::Easy.new(url) {|c| c.follow_location = true }
+        post_parameters = parameters.map {|k,v| Curl::PostField.content(k.to_s, v.to_s) }
+        begin
+          curl.http_post(*post_parameters)
+        rescue => e
+          raise AvailabilityError.new(e.message)
+        end
+        Response.new(curl.response_code.to_s, curl.body_str)
+      end
+    end
+  end
+end

data/lib/encoding_dot_com/http_adapters/net_http_adapter.rb

@@ -0,0 +1,22 @@
+module EncodingDotCom
+  module HttpAdapters
+
+    # Wraps the Net/HTTP library for use with the Queue.
+    class NetHttpAdapter
+      def initialize
+        require 'net/http'
+      end
+
+      # Makes a POST request. Raises an AvailabilityError if the
+      # request times out or has other problems.
+      def post(url, parameters={})
+        Net::HTTP.post_form(URI.parse(url), parameters)
+      rescue => e
+        raise AvailabilityError.new(e.message)
+      rescue Timeout::Error => e
+        raise AvailabilityError.new(e.message)          
+      end
+    end
+    
+  end
+end

data/lib/encoding_dot_com/media_info.rb

@@ -0,0 +1,25 @@
+require 'parsedate'
+
+module EncodingDotCom
+  # Represents information about a video or image in the encoding.com queue
+  class MediaInfo
+    attr_reader :bitrate, :duration, :video_codec, :video_bitrate, :frame_rate, :size, :pixel_aspect_ratio, :display_aspect_ratio, :audio_codec, :audio_sample_rate, :audio_channels
+
+    # Creates a MediaInfo object, given a <response> Nokogiri::XML::Node
+    #
+    # See the encoding.com documentation for GetMediaInfo action for more details
+    def initialize(node)
+      @bitrate = (node / "bitrate").text
+      @duration = (node / "duration").text.to_f
+      @video_codec = (node / "video_codec").text
+      @video_bitrate = (node / "video_bitrate").text
+      @frame_rate = (node / "frame_rate").text.to_f
+      @size = (node / "size").text
+      @pixel_aspect_ratio = (node / "pixel_aspect_ratio").text
+      @display_aspect_ratio = (node / "display_aspect_ratio").text
+      @audio_codec = (node / "audio_codec").text
+      @audio_sample_rate = (node / "audio_sample_rate").text.to_i
+      @audio_channels = (node / "audio_channels").text.to_i
+    end
+  end
+end

data/lib/encoding_dot_com/media_list_item.rb

@@ -0,0 +1,28 @@
+require 'parsedate'
+
+module EncodingDotCom
+
+  # Represents a video or image in the encoding.com queue
+  class MediaListItem
+    attr_reader :media_file, :media_id, :media_status, :create_date, :start_date, :finish_date
+
+    # Creates a MediaListItem, given a <media> Nokogiri::XML::Node
+    #
+    # See the encoding.com documentation for GetMediaList for more details
+    def initialize(node)
+      @media_file = (node / "mediafile").text
+      @media_id = (node / "mediaid").text.to_i
+      @media_status = (node / "mediastatus").text
+      @create_date = parse_time_node(node / "createdate")
+      @start_date = parse_time_node(node / "startdate")
+      @finish_date = parse_time_node(node / "finishdate")
+    end
+
+    private
+
+    def parse_time_node(node)
+      time_elements = ParseDate.parsedate(node.text)
+      Time.local *time_elements unless time_elements.all? {|e| e.nil? || e == 0 }
+    end
+  end
+end