heywatch 0.0.1

data/Manifest.txt

@@ -0,0 +1,18 @@
+Manifest.txt
+README.txt
+Rakefile
+lib/heywatch.rb
+lib/heywatch/video.rb
+lib/heywatch/version.rb
+lib/heywatch/job.rb
+lib/heywatch/ext.rb
+lib/heywatch/encoded_video.rb
+lib/heywatch/download.rb
+lib/heywatch/discover.rb
+lib/heywatch/browser.rb
+lib/heywatch/base.rb
+lib/heywatch/auth.rb
+lib/heywatch/account.rb
+setup.rb
+test/test_helper.rb
+test/test_heywatch.rb

data/README.txt

@@ -0,0 +1,163 @@
+=Hey!Watch - Video Encoding Web Service
+
+Hey!Watch <http://heywatch.com> provides a simple and robust encoding plateform.
+The service allows developers to access a fast, scalable and inexpensive web 
+service to encode videos easier. The API can be easily integrated 
+in any web or desktop applications.
+
+The documentation of the API can be found at http://wiki.heywatch.com/API_Documentation
+
+
+==Getting started
+
+===Transfer a video, encode it in ipod format and download the encoded video
+
+ require 'heywatch'
+ include HeyWatch
+
+ Base::establish_connection! :login => 'login', :password => 'password'
+
+ raw_video = Discover.create(:url => 'http://youtube.com/watch?v=SXcpNZCyQJw', :download => true) do |percent, total_size, received|
+   puts "#{percent}%"
+ end
+ 
+ ipod_format = Format.find_by_name('iPod 4:3')
+ encoded_video = Job.create(:video_id => raw_video.id, :format_id => ipod_format.id) do |percent|
+   puts "#{percent}%"
+ end
+
+ puts "downloading {encoded_video.title}"
+ path = encoded_video.download
+ puts "video saved in {path}"
+
+ 
+===Upload a video from the disk, encode it with FTP auto transfer option
+
+ raw_video = Video.create(:file => 'videos/myvideo.avi', :title => 'Funny video') do |percent, total_size, received|
+   puts "#{percent}%"
+ end
+
+ Job.create :video_id => raw_video.id, :default_format => true, :ftp_directive => 'ftp://login:pass@host.com/heywatch_vids/'
+
+
+===Generate a thumbnail
+
+  v = EncodedVideo.find(5400)
+  v.thumbnail :start => 15, :width => 640, :height => 480    
+
+
+===Update your account
+
+  account = Account.find
+  account.update_attributes :ping_url_after_encode => 'http://yourhost.com/ping/encode'
+
+
+
+==Integration in a rails application
+
+This short HOWTO uses the ping options. So in your HeyWatch account, you must
+configure all the ping URL (except transfer for this example).
+
+Examples:
+
+ ping_url_after_encode => http://myhost.com/ping/encode
+ ping_url_if_error => http://myhost.com/ping/error
+
+
+===Config
+
+In your config/environment.rb:
+
+  require 'heywatch'
+  HeyWatch::Base::establish_connection! :login => 'login', :password => 'passwd'
+
+
+===Item Model
+
+ create_table "items", :force => true do |t|
+   t.column "title",       :string,                          :null => false
+   t.column "description", :text,                            :null => false
+   t.column "created_at",  :datetime
+   t.column "updated_at",  :datetime
+   t.column "status",      :string,   :default => "working"
+   t.column "url",         :string
+   t.column "meta",        :text
+   t.column "user_id",     :integer
+ end
+
+In app/models/item.rb:
+
+ class Item < ActiveRecord::Base
+   belongs_to :user
+   serialize :meta
+   after_create :convert
+
+   # When HeyWatch send videos to your FTP,
+   # they will be available to this HTTP url.
+   def base_url
+     "http://myhost.com/flv/#{self.id}/"
+   end
+
+   # Transfer the given URL and convert the video from 
+   # this address in format 31 (flv format). When the encode
+   # is done, the video will be sent to the specified FTP
+   # with custom path.
+   #
+   # Note item_id which is a custom field.
+   def convert        
+     HeyWatch::Discover.create(
+       :url              => self.url, 
+       :download         => true, 
+       :item_id          => self.id,
+       :title            => self.title, 
+       :automatic_encode => true,
+       :format_id        => 31,
+       :ftp_directive    => "ftp://login:passwd@myhost.com/flv/#{self.id}/"
+     )
+   end
+ end
+
+
+===Ping Controller
+
+In app/controllers/ping_controller.rb:
+
+ class PingController < ApplicationController
+   before_filter :find_item
+
+   def encode
+     @encoded_video = HeyWatch::EncodedVideo.find(params[:encoded_video_id])
+     @full_url = @item.base_url + @encoded_video.filename
+     @item.status = 'finished'
+     @item.meta = {
+       :url       => @full_url,
+       :thumb     => @full_url + ".jpg",
+       :size      => @encoded_video.specs["size"],
+       :mime_type => @encoded_video.specs["mime_type"],
+       :length    => @encoded_video.specs.video["length"]
+     }
+     @item.save
+     @encoded_video.job.video.destroy # delete the raw video
+     @encoded_video.destroy # delete the encoded video
+     render :nothing => true
+   end
+
+   def error
+     if params[:discover_id]
+       error_msg = "No video link found"
+     else
+       error_msg = HeyWatch::ErrorCode[params[:error_code].to_i]      
+     end
+     @item.update_attributes :status => 'error'
+     ItemMailer.deliver_error(error_msg, @item.user)
+     render :nothing => true
+   end
+
+   private
+
+   # item_id is a custom_field sent in Item#convert.
+   # Thanks to it, we can track the item.
+   def find_item
+     @item = Item.find params[:item_id]
+   end
+ end

data/Rakefile

@@ -0,0 +1,74 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'heywatch', 'version')
+
+AUTHOR = 'Bruno Celeste'  # can also be an array of Authors
+EMAIL = "bruno.celeste@heywatch.com"
+DESCRIPTION = "Ruby Library for HeyWatch service (http://heywatch.com)."
+GEM_NAME = 'heywatch' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'heywatch' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+
+
+NAME = "heywatch"
+REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+VERS = ENV['VERSION'] || (HeyWatch::VERSION::STRING + (REV ? ".#{REV}" : ""))
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'heywatch documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README.txt",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.extra_deps = [ ['xml-simple', '>= 1.0.0'] ]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.spec_extras = {:extra_rdoc_files => ["README.txt"], :rdoc_options => RDOC_OPTS}    # A hash of extra values to set in the gemspec.
+end
+
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  host = "#{config["username"]}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
+  # remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+  local_dir = 'website'
+  sh %{rsync -av #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload]

data/lib/heywatch.rb

@@ -0,0 +1,88 @@
+#--
+# Copyright (c) 2007 Bruno Celeste
+#
+# 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.
+#++
+
+require "rubygems"
+require "xmlsimple"
+require "cgi"
+
+module HeyWatch
+	Host = "heywatch.com" unless const_defined? :Host
+	OutFormat = "xml" unless const_defined? :OutFormat
+  Resources = %w{job format download discover encoded_video video account log} unless const_defined? :Resources
+
+  # These are error codes you receive if you use ping options
+  ErrorCode = {
+                100 => "Unknown error",
+                101 => "Unsupported audio codec",
+                102 => "Unsupported video codec",
+                103 => "This video cannot be encoded in this format",
+                104 => "Wrong settings for audio",
+                105 => "Wrong settings for video",
+                106 => "Cannot retrieve info from this video",
+                107 => "Not a video file",
+                108 => "Video too long",
+                109 => "The container of this video is not supported yet",
+                110 => "The audio can't be resampled",
+                201 => "404 Not Found",
+                202 => "Bad address",
+                300 => "No more credit available"
+              } unless const_defined? :ErrorCode
+              
+  class NotAuthorized < RuntimeError; end
+  class RequestError < RuntimeError; end
+  class ResourceNotFound < RuntimeError; end
+  class ServerError < RuntimeError; end
+  class SessionNotFound < RuntimeError; end
+  
+  # Convert the XML response into Hash
+  def self.response(xml)
+    XmlSimple.xml_in(xml, {'ForceArray' => false})
+  end
+  
+  # sanitize url
+  def self.sanitize_url(url)
+    return url.gsub(/[^a-zA-Z0-9:\/\.\-\+_\?\=&]/) {|s| CGI::escape(s)}.gsub("+", "%20")
+  end
+end
+
+$: << File.dirname(File.expand_path(__FILE__))
+
+require "heywatch/ext"
+require "heywatch/version"
+require "heywatch/browser"
+require "heywatch/auth"
+require "heywatch/base"
+require "heywatch/encoded_video"
+require "heywatch/video"
+require "heywatch/account"
+require "heywatch/download"
+require "heywatch/discover"
+require "heywatch/job"
+
+class Hash
+  include HeyWatch::CoreExtension::HashExtension
+end
+
+class Array
+  include HeyWatch::CoreExtension::ArrayExtension
+end

data/lib/heywatch/account.rb

@@ -0,0 +1,32 @@
+module HeyWatch
+  class Account < Base #:nodoc:
+    def new_record?
+      false
+    end
+    
+    def update_attributes(attributes={})
+      attributes.delete "account"
+      attributes.keys.each do |k|
+        attributes.merge!("user[#{k.to_s}]" => attributes[k])
+        attributes.delete k
+      end
+
+      if Account.update(id, attributes)
+        reload
+        true
+      end
+    end
+
+    def reload
+      @attributes = Account.find.attributes
+    end
+    
+    def id
+      ""
+    end
+    
+    def self.find(*args)
+      new(HeyWatch::response(Browser::get(self.path, self.session).body))
+    end
+  end
+end

data/lib/heywatch/auth.rb

@@ -0,0 +1,83 @@
+module HeyWatch
+  # Authenticate to the Hey!Watch service
+  #
+  #  user = Auth.create("login", "password")
+  #  user.account
+  #
+  # If you want to recover a session:
+  #
+  #  user = Auth.recover(session_id)
+  #  user.account
+  #
+  # The initialize and create methods can take blocks.
+  #
+  #  Auth.create("login", "password") do |user|
+  #    video = user.videos.find(:first)
+  #    format = user.formats.find(:first, :conditions => {:name => "iPod 4:3"})
+  #    user.jobs.create :video_id => video.id, :format_id => format.id
+  #  end
+  #
+  # All the resources (pluralized) are available within the Auth class:
+  #
+  #  jobs, encoded_videos, videos, formats, downloads, discovers, logs, account
+  #
+	class Auth
+    attr_reader :session
+    @@sessions = {}
+    
+    # Authenticate to the Hey!Watch service
+    #
+    # options can be:
+    #
+    # * <tt>:login</tt> Hey!Watch username
+    # * <tt>:password</tt> Hey!Watch password
+    # * <tt>:session</tt> A previous session, using this option, you will not be reconnected, you will just recover your session
+		def initialize(options={}, &block)
+      if options[:session]
+        @session = options[:session]
+      else
+        @session = Browser::login(options[:login], options[:password])
+        @@sessions.merge!(@session => true)
+      end
+      yield self if block_given?
+		end
+		
+		# Same as initialize
+		#
+    #   Auth::create 'login', 'password'
+    def self.create(login, password, &block)
+      new(:login => login, :password => password, &block)
+    end
+    
+    # Recover a session
+    #
+    #  Auth.recover(session_id)
+    def self.recover(session, &block)
+      #raise SessionNotFound if @@sessions[session].nil?
+      new(:session => session, &block)
+    end
+
+    Resources.each do |k| 
+      Auth.module_eval(%{
+                         def #{k.to_s+"s"}
+                           klass = #{k.to_s.camelize}
+                           klass.session = @session
+                           klass
+                         end
+                        }
+                      )
+    end
+    
+    # Delete the current session
+    def destroy
+      @@sessions.delete(@session)
+      @session = nil
+    end
+    
+    # Show account info
+    def account
+      Account.session = @session
+      Account.find(:first)
+    end
+	end
+end