encodingdotcom 0.2.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mick Staugaard
+
+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,18 @@
+= encodingdotcom
+
+Description goes here.
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2009 Mick Staugaard. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "encodingdotcom"
+    gem.summary = "a library for integrating with encoding.com"
+    gem.description = "a library for integrating with encoding.com"
+    gem.email = "mick@staugaard.com"
+    gem.homepage = "http://github.com/staugaard/encodingdotcom"
+    gem.authors = ["Mick Staugaard"]
+    gem.add_dependency('httparty', ">= 0.2.10")
+    # 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+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 = "encodingdotcom #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/encodingdotcom.gemspec

@@ -0,0 +1,58 @@
+# 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{encodingdotcom}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mick Staugaard"]
+  s.date = %q{2009-10-11}
+  s.description = %q{a library for integrating with encoding.com}
+  s.email = %q{mick@staugaard.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "encodingdotcom.gemspec",
+     "lib/encoding_dot_com.rb",
+     "lib/encoding_dot_com/connection.rb",
+     "lib/encoding_dot_com/format.rb",
+     "lib/encoding_dot_com/media.rb",
+     "lib/encoding_dot_com/thumbnail.rb",
+     "lib/encodingdotcom.rb",
+     "test/encodingdotcom_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/staugaard/encodingdotcom}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{a library for integrating with encoding.com}
+  s.test_files = [
+    "test/encodingdotcom_test.rb",
+     "test/test_helper.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<httparty>, [">= 0.2.10"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.2.10"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.2.10"])
+  end
+end

data/lib/encoding_dot_com.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+gem 'builder'
+gem 'httparty'
+
+require 'encoding_dot_com/media'

data/lib/encoding_dot_com/connection.rb

@@ -0,0 +1,66 @@
+require 'httparty'
+
+module EncodingDotCom
+  class EncodingDotComError < StandardError
+  end
+
+  class BadRequestError < EncodingDotComError
+  end
+
+  class AuthenticationError < EncodingDotComError
+  end
+
+  class NotFoundError < EncodingDotComError
+  end
+
+  class BadUrlError < EncodingDotComError
+  end
+
+  class BadSourceUrlError < BadUrlError
+  end
+
+  class BadDestinationUrlError < BadUrlError
+  end
+
+  class Connection
+    include HTTParty
+    base_uri 'manage.encoding.com'
+
+    class << self
+      attr_accessor :user_id, :user_key, :s3_key, :s3_secret, :logger
+
+      def call(request_xml_document)
+        if logger
+          logger.info("Sending encoding.com request:\n#{request_xml_document}")
+        end
+
+        response = post('/', :body => {:xml => request_xml_document})
+
+        if logger
+          logger.info("Received encoding.com response:\n#{response.inspect}")
+        end
+        response = response['response']
+
+        if response['errors']
+          message = response['errors']['error']
+          case message
+          when /Wrong XML/, /No XML/, /Wrong query format/, /Invalid action/, /No formats specified/, /No output format specified/, /Output format .* is not allowed/
+            raise(BadRequestError, message)
+          when /Wrong user id or key/
+            raise(AuthenticationError, message)
+          when /Media ID is not indicated/, /Wrong Media ID/
+            raise(NotFoundError, message)
+          when /Wrong source file url/, /Source file is not indicated/
+            raise(BadSourceUrlError, message)
+          when /Wrong destination file url/
+            raise(BadDestinationUrlError, message)
+          else
+            raise(EncodingDotComError, message)
+          end
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/encoding_dot_com/format.rb

@@ -0,0 +1,192 @@
+module EncodingDotCom
+  class Format
+    OUTPUTS = [:"3gp", :appletv, :fl9, :flv, :iphone, :ipod, :m4v, :mp3, :mp4, :psp, :wma, :wmv, :zune]
+    VIDEO_CODECS = [:flv, :libx264, :mpeg4, :msmpeg4, :h263, :vp6, :wmv2]
+    AUDIO_CODECS = [:libmp3lame, :libfaac, :wmav2, :libamr_nb]
+
+    BOOLEAN_FIELDS = [:stereo, :two_pass, :constant_bitrate, :deinterlace, :turbo]
+    INTEGER_FIELDS = [:video_bitrate, :framerate, :audio_bitrate, :audio_sample_rate, :max_bitrate, :min_bitrate, :key_frame_interval ]
+
+    attr_accessor :output,
+      :dimensions,
+      :video_bitrate,
+      :framerate,
+      :video_codec,
+      :audio_bitrate,
+      :audio_sample_rate,
+      :audio_codec,
+      :stereo,
+      :two_pass,
+      :constant_bitrate,
+      :max_bitrate,
+      :min_bitrate,
+      :key_frame_interval,
+      :deinterlace,
+      :turbo,
+      :destination
+
+    def initialize(attributes = {})
+      self.output = attributes.delete(:output)
+      attributes.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def destination=(destination_url)
+      @destination = Media.media_url_string(URI.parse(destination_url.to_s))
+    end
+
+    def output=(new_output)
+      @output = new_output.to_sym
+
+      case @output
+        when :'3gp'
+          self.dimensions ||= [176, 144]
+          self.video_bitrate ||= 256
+          self.framerate ||= 25
+          self.video_codec ||= :h263
+          self.audio_bitrate ||= 12.2
+          self.audio_sample_rate ||= 8000
+          self.audio_codec ||= :libamr_nb
+          self.stereo = false if self.stereo.nil?
+        when :appletv
+          self.dimensions ||= [710, 480]
+          self.video_bitrate ||= 512
+          self.framerate ||= 25
+          self.video_codec ||= :mpeg4
+          self.audio_bitrate ||= 64
+          self.audio_codec ||= :libfaac
+        when :flv
+          self.video_bitrate ||= 512
+          self.framerate ||= 25
+          self.video_codec ||= :flv
+          self.audio_bitrate ||= 64
+          self.audio_sample_rate ||= 44100
+          self.audio_codec ||= :libmp3lame
+        when :flv9
+          self.video_bitrate ||= 512
+          self.framerate ||= 25
+          self.video_codec ||= :libx264
+          self.audio_bitrate ||= 64
+          self.audio_codec ||= :libfaac
+        when :iphone
+          self.dimensions ||= [480, 368]
+          self.video_bitrate ||= 1024
+          self.framerate ||= 25
+          self.video_codec ||= :mpeg4
+          self.audio_bitrate ||= 128
+          self.audio_codec ||= :libfaac
+        when :ipod
+          self.video_bitrate ||= 1024
+          self.framerate ||= 25
+          self.video_codec ||= :mpeg4
+          self.audio_bitrate ||= 128
+          self.audio_codec ||= :libfaac
+        when :m4v
+          self.video_bitrate ||= 512
+          self.framerate ||= 25
+          self.video_codec ||= :mpeg4
+          self.audio_bitrate ||= 64
+          self.audio_codec ||= :libfaac
+        when :mp3
+          self.audio_bitrate ||= 64
+          self.audio_sample_rate ||= 44100
+          self.audio_codec ||= :libmp3lame
+        when :mp4
+          self.video_bitrate ||= 512
+          self.framerate ||= 25
+          self.video_codec ||= :mpeg4
+          self.audio_bitrate ||= 64
+          self.audio_codec ||= :libfaac
+        when :psp
+          self.dimensions ||= [368, 192]
+          self.video_bitrate ||= 1024
+          self.framerate ||= [30000, 1001]
+          self.video_codec ||= :mpeg4
+          self.audio_bitrate ||= 128
+          self.audio_codec ||= :libfaac
+        when :wma
+          self.audio_bitrate ||= 64
+        when :wmv
+          self.video_bitrate ||= 512
+          self.framerate ||= 25
+          self.video_codec ||= :wmv2
+          self.audio_bitrate ||= 64
+          self.audio_codec ||= :wmav2
+        when :zune
+          self.dimensions ||= [320, 180]
+          self.video_bitrate ||= 512
+          self.framerate ||= 25
+          self.video_codec ||= :wmv2
+          self.audio_bitrate ||= 64
+          self.audio_sample_rate ||= 44100
+          self.audio_codec ||= :wmav2
+      end
+
+      self.stereo = true if self.stereo.nil?
+      self.two_pass = false if self.two_pass.nil?
+      self.constant_bitrate = false if self.constant_bitrate.nil?
+      self.key_frame_interval ||= 300
+      self.deinterlace = false if self.deinterlace.nil?
+      self.turbo = false if self.turbo.nil?
+    end
+
+    [:video_bitrate, :audio_bitrate, :audio_sample_rate, :max_bitrate, :min_bitrate, :key_frame_interval].each do |method_name|
+      define_method("#{method_name}=") do |value|
+        if value.blank?
+          instance_variable_set("@#{method_name}", nil)
+        else
+          instance_variable_set("@#{method_name}", value.to_i)
+        end
+      end
+    end
+
+    def to_xml(options = {})
+      xml = options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent] ||= 2)
+
+      xml.format do
+        xml.output(output.to_s)
+        xml.video_codec(video_codec.to_s) if video_codec
+        xml.audio_codec(audio_codec.to_s) if audio_codec
+        xml.bitrate("#{video_bitrate}k") if video_bitrate
+        xml.audio_bitrate("#{audio_bitrate}k") if audio_bitrate
+        xml.audio_sample_rate(audio_sample_rate.to_s) if audio_sample_rate
+        xml.size("#{dimensions[0]}x#{dimensions[1]}") if dimensions
+        xml.minrate("#{min_bitrate}k") if min_bitrate
+        xml.maxrate("#{max_bitrate}k") if max_bitrate
+        xml.keyframe(key_frame_interval) if key_frame_interval
+        xml.framerate(framerate.is_a?(Array) ? "#{framerate[0]}/#{framerate[1]}" : framerate.to_s) if framerate
+        xml.audio_channels_number(stereo ? '2' : '1') unless stereo.nil?
+        xml.two_pass(two_pass ? 'yes' : 'no') unless two_pass.nil?
+        xml.cbr(constant_bitrate ? 'yes' : 'no') unless constant_bitrate.nil?
+        xml.deinterlacing(deinterlace ? 'yes' : 'no') unless deinterlace.nil?
+        xml.destination(destination) unless destination.nil?
+        xml.turbo(turbo ? 'yes' : 'no') unless turbo.nil?
+      end
+    end
+
+    def to_hash
+      hash = {
+        :output => output,
+        :stereo => stereo,
+        :turbo => turbo
+      }
+
+      hash[:dimensions] = dimensions unless dimensions.nil?
+      hash[:video_bitrate] = video_bitrate unless video_bitrate.nil?
+      hash[:framerate] = framerate unless framerate.nil?
+      hash[:video_codec] = video_codec unless video_codec.nil?
+      hash[:audio_bitrate] = audio_bitrate unless audio_bitrate.nil?
+      hash[:audio_sample_rate] = audio_sample_rate unless audio_sample_rate.nil?
+      hash[:audio_codec] = audio_codec unless audio_codec.nil?
+      hash[:two_pass] = two_pass unless two_pass.nil?
+      hash[:constant_bitrate] = constant_bitrate unless constant_bitrate.nil?
+      hash[:max_bitrate] = max_bitrate unless max_bitrate.nil?
+      hash[:min_bitrate] = min_bitrate unless min_bitrate.nil?
+      hash[:key_frame_interval] = key_frame_interval unless key_frame_interval.nil?
+      hash[:deinterlace] = deinterlace unless deinterlace.nil?
+
+      hash
+    end
+  end
+end

data/lib/encoding_dot_com/media.rb

@@ -0,0 +1,104 @@
+require 'encoding_dot_com/connection'
+require 'encoding_dot_com/format'
+require 'uri'
+require 'builder'
+
+module EncodingDotCom
+  class Media
+    attr_reader :id, :source_location, :notify_url, :formats
+
+    def initialize(location_or_id, options = {})
+      if location_or_id.is_a?(Fixnum)
+        @id = location_or_id
+      else
+        @source_location = URI.parse(location_or_id.to_s)
+        @notify_url = options[:notify_url]
+      end
+      @formats = []
+    end
+
+    def new_record?
+      @id.nil?
+    end
+
+    def save
+      create_or_update
+    end
+
+    def create_or_update
+      new_record? ? create : update
+    end
+
+    def create
+      request = to_xml('AddMediaBenchmark') { |xml|
+        xml.source(self.class.media_url_string(@source_location))
+        xml.notify(@notify_url) if @notify_url
+        formats.each do |format|
+          format.to_xml(:builder => xml)
+        end
+      }
+
+      response = Connection.call(request)
+
+      if response['message'] == 'Added' && response['MediaID']
+        @id = response['MediaID'].to_i
+        true
+      else
+        false
+      end
+    end
+
+    def update
+      request = to_xml('UpdateMedia') { |xml|
+        formats.each do |format|
+          format.to_xml(:builder => xml)
+        end
+      }
+
+      response = Connection.call(request)
+    end
+
+    def info
+      Connection.call(to_xml('GetMediaInfo'))
+    end
+
+    def status(reload = false)
+      if !@status || reload
+        @status = Connection.call(to_xml('GetStatus'))
+      end
+
+      @status
+    end
+
+    def to_xml(action, options = {})
+      xml = options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent])
+
+      xml.instruct!
+      xml.query do
+        xml.userid(Connection.user_id)
+        xml.userkey(Connection.user_key)
+        xml.action(action)
+        xml.mediaid(@id) if @id
+        yield(xml) if block_given?
+      end
+    end
+
+    [:created, :started, :downloaded, :finished].each do |event|
+      define_method("#{event}_at") do
+        begin
+          Time.parse("#{status[event.to_s]}-05:00")
+        rescue ArgumentError => e
+          nil
+        end
+      end
+    end
+
+    def self.media_url_string(url)
+      if Connection.s3_key && Connection.s3_secret && url.host =~ /s3.amazonaws.com/
+        url.user = ERB::Util.url_encode(Connection.s3_key)
+        url.password = ERB::Util.url_encode(Connection.s3_secret)
+      end
+      url.to_s
+    end
+  end
+end

data/lib/encoding_dot_com/thumbnail.rb

@@ -0,0 +1,21 @@
+module EncodingDotCom
+  class Thumbnail
+    def initialize(time, destination_url, options = {})
+      @time = time
+      @destination = Media.media_url_string(URI.parse(destination_url.to_s))
+      @options = options
+    end
+
+    def to_xml(options = {})
+      xml = options[:builder] ||= ::Builder::XmlMarkup.new(:indent => options[:indent] ||= 2)
+
+      xml.format do
+        xml.output('thumbnail')
+        xml.time(@time)
+        xml.width(@options[:width]) if @options[:width]
+        xml.height(@options[:height]) if @options[:height]
+        xml.destination(@destination) unless @destination.nil?
+      end
+    end
+  end
+end

data/lib/encodingdotcom.rb

@@ -0,0 +1 @@
+require 'encoding_dot_com'

data/test/encodingdotcom_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class EncodingdotcomTest < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'encodingdotcom'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: encodingdotcom
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Mick Staugaard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.10
+    version: 
+description: a library for integrating with encoding.com
+email: mick@staugaard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- encodingdotcom.gemspec
+- lib/encoding_dot_com.rb
+- lib/encoding_dot_com/connection.rb
+- lib/encoding_dot_com/format.rb
+- lib/encoding_dot_com/media.rb
+- lib/encoding_dot_com/thumbnail.rb
+- lib/encodingdotcom.rb
+- test/encodingdotcom_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/staugaard/encodingdotcom
+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 library for integrating with encoding.com
+test_files: 
+- test/encodingdotcom_test.rb
+- test/test_helper.rb