yamdi 0.1.1 → 0.1.2

data/Changelog.mdown

@@ -1,3 +1,8 @@
+== 0.1.2 (January 28, 2011)
+
+* Move key frames into a class of their own. [Bob Burbach]
+* Update documentation and provide example rake task for refreshing metadata. [Bob Burbach]
+
 == 0.1.1 (January 25, 2011)
 
 * Fix errant require that caused gem to fail but tests to pass. [Bob Burbach]

data/README.rdoc

@@ -6,6 +6,8 @@ The Yamdi command line tool expects to receive a path to an flv file and will re
 
 The current gem version only supports the reading of metadata. The command line tool also supports the writing of the metadata into a new .flv file but this is not yet supported in this gem.
 
+Tested under ruby 1.8.7 and 1.9.2
+
 
 == Usage
 
@@ -24,6 +26,20 @@ You can also use Yamdi in a Paperclip processor. I've provided a simple example
 
 This is useful for adding things like video duration to your db when a user uploads a video.
 
+  class Video
+    has_attached_file :video,
+                      :styles => {:orginal => {}},
+                      :processors => [:metadata_extractor]
+  end
+  
+Be sure you add the styles hash even if it is empty as above or your paperclip processors won't run.
+
+=== Refreshing Exisitng Videos
+
+Perhaps you're adding yamdi to your current set up, want to refresh the data in your models or add a new column to present to your users.
+
+This is easily accomplished of you are using Paperclip. I've added an example rake task in lib/tasks/metadata_refresh.rake
+
 == Supported methods
 
 duration          :: float, in seconds

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/key_frame.rb

@@ -0,0 +1,41 @@
+require 'nokogiri'
+
+class KeyFrame
+  
+  attr_accessor :time, :file_position
+  
+  def initialize(options = {})
+    @time          = options[:time]
+    @file_position = options[:file_position]
+  end
+  
+  def self.all_from_xml(keyframe_xml)
+    times          = get_times(keyframe_xml.xpath("//times/value"))
+    file_positions = get_file_positions(keyframe_xml.xpath("//filepositions/value"))
+    
+    count = 0
+    key_frames = []
+    while count < times.size do
+      key_frames << KeyFrame.new(:time => times[count], :file_position => file_positions[count])
+      count = count + 1
+    end
+    
+    key_frames
+  end
+  
+  def self.get_times(times_data_xml)
+    times = []
+    times_data_xml.children.each do |el|
+      times << el.inner_text.to_f
+    end
+    times
+  end
+  
+  def self.get_file_positions(file_positions_xml)
+    file_positions = []
+    file_positions_xml.children.each do |el|
+      file_positions << el.inner_text.to_i
+    end
+    file_positions
+  end
+end

data/lib/paperclip_processors/metadata_extractor.rb

@@ -1,3 +1,16 @@
+# This assumes that you are using paperclip.
+# For example you may Video model with an attachment of video.
+# truncated example:
+# class Video
+#   has_attached_file :video,
+#                     :styles => {:orginal => {}},
+#                     :processors => [:metadata_extractor]
+# end
+#
+# Remember for processors to work you must define styles on
+# has_attached_file. Even if they are just blank as the example
+# above. Without them processors won't be triggered.
+
 module Paperclip
   class MetadataExtractor < Paperclip::Processor
     def make

data/lib/tasks/metadata_refresh.rake

@@ -0,0 +1,34 @@
+# Example rake task to refresh your flv metadata using yamdi
+# This assumes that you are using paperclip and have a Video 
+# model with an attachment of video.
+# truncated example:
+# class Video
+#   has_attached_file :video,
+#                     :styles => {:orginal => {}},
+#                     :processors => [:metadata_extractor]
+# end
+#
+# The rake task below even works when using Amazon s3 for storage
+# thanks to Paperclip.
+
+
+namespace :video do
+  namespace :refresh do
+    
+    desc "Regenerates metadata for uploaded flv videos."
+    task :metadata => :environment do
+      errors = []
+      # conditions assume default value of duration column has been set to 0
+      Video.find(:all, :conditions => ['duration = 0']).each do |video|
+        #ensure we are dealing with flv's
+        next unless video.video_file_name && video.video_file_name.include?('.flv')
+  
+        result = video.video.reprocess!
+        errors << [video.id, video.errors] unless video.errors.blank?
+        result
+      end
+      errors.each{|e| puts "#{e.first}: #{e.last.full_messages.inspect}" }
+    end
+    
+  end
+end

data/lib/yamdi.rb

@@ -2,8 +2,12 @@ require 'tempfile'
 require 'ostruct'
 require 'nokogiri'
 
+require 'key_frame'
+
 class Yamdi
   
+  attr_accessor :metadata
+  
   def initialize(flv_path)
     @metadata = Nokogiri.parse( parse(flv_path) )
   end
@@ -121,26 +125,7 @@ class Yamdi
   end
   
   def key_frames
-    times_data_xml = @metadata.xpath("//keyframes/times/value")
-    times = []
-    times_data_xml.children.each do |el|
-      times << el.inner_text.to_f
-    end
-    
-    file_positions_xml = @metadata.xpath("//keyframes/filepositions/value")
-    file_positions = []
-    file_positions_xml.children.each do |el|
-      file_positions << el.inner_text.to_i
-    end
-    
-    count = 0
-    key_frames = []
-    while count < times.size do
-      key_frames << OpenStruct.new(:time => times[count], :file_position => file_positions[count])
-      count = count + 1
-    end
-    
-    key_frames
+    KeyFrame.all_from_xml(@metadata.xpath("//keyframes"))
   end
   
   private

data/spec/key_frame_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "KeyFrame" do
+  let(:flv_path) { File.join(File.dirname(__FILE__), 'files', 'sample.flv') }
+  
+  before(:all) do
+    @metadata_xml = Yamdi.new(flv_path).metadata
+  end
+  
+  context "internal class methods" do
+    it "#self.get_times returns an array of times" do
+      times = KeyFrame.get_times(@metadata_xml.xpath("//keyframes/times/value"))
+      times.first.should eq(0.04)
+      times.last.should eq(6.04)
+    end
+  
+    it "#self.get_file_positions returns an array of file positions" do
+     file_positions = KeyFrame.get_file_positions(@metadata_xml.xpath("//keyframes/filepositions/value"))
+     file_positions.first.should eq(1327)
+     file_positions.last.should eq(83017)
+    end
+  end
+  
+  it "#self.all_from_xml returns an array of Key Frame objects" do
+    KeyFrame.all_from_xml(@metadata_xml.xpath("//keyframes")).class.should eq(Array)
+  end
+  
+  before(:all) do
+    @key_frames = KeyFrame.all_from_xml(@metadata_xml.xpath("//keyframes"))
+  end
+
+  it "#time returns the proper time value" do
+    @key_frames.first.time.should eq(0.04)
+    @key_frames.last.time.should eq(6.04)
+  end
+  
+  it "#file_position returns the proper file position value" do
+    @key_frames.first.file_position.should eq(1327)
+    @key_frames.last.file_position.should eq(83017)
+  end
+end

data/spec/yamdi_spec.rb

@@ -116,26 +116,9 @@ describe "Yamdi" do
     @yamdi.last_key_frame_location.should eq(83017)
   end
   
-  context "key frames" do
-    before(:all) do
-      @key_frame_1 = @yamdi.key_frames.first
-      @key_frame_2 = @yamdi.key_frames.last
-    end
-    
-    it "returns an array of key frame open structs" do
-       @yamdi.key_frames.class.should eq(Array)
-       @yamdi.key_frames.first.class.should eq(OpenStruct)
-       @yamdi.key_frames.last.class.should eq(OpenStruct)
-    end
-    
-    it "returns the proper time values" do
-      @key_frame_1.time.should eq(0.04)
-      @key_frame_2.time.should eq(6.04)
-    end
-    
-    it "returns the proper file position values" do
-      @key_frame_1.file_position.should eq(1327)
-      @key_frame_2.file_position.should eq(83017)
-    end
+  it "returns an array of key frames" do
+     @yamdi.key_frames.class.should eq(Array)
+     @yamdi.key_frames.first.class.should eq(KeyFrame)
+     @yamdi.key_frames.last.class.should eq(KeyFrame)
   end
 end

data/yamdi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{yamdi}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bob Burbach"]
-  s.date = %q{2011-01-25}
+  s.date = %q{2011-01-28}
   s.description = %q{Yamdi is a ruby wrapper around the command line tool yamdi (github.com/ioppermann/yamdi). You'll need yamdi installed in order for the gem to be of any use. If you are on OSX I recommend using homebrew (brew install yamdi).}
   s.email = %q{bob.burbach@gmail.com}
   s.extra_rdoc_files = [
@@ -26,9 +26,12 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "lib/key_frame.rb",
     "lib/paperclip_processors/metadata_extractor.rb",
+    "lib/tasks/metadata_refresh.rake",
     "lib/yamdi.rb",
     "spec/files/sample.flv",
+    "spec/key_frame_spec.rb",
     "spec/spec_helper.rb",
     "spec/yamdi_spec.rb",
     "yamdi.gemspec"
@@ -39,6 +42,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Yamdi is a ruby wrapper around the command line tool yamdi (github.com/ioppermann/yamdi).}
   s.test_files = [
+    "spec/key_frame_spec.rb",
     "spec/spec_helper.rb",
     "spec/yamdi_spec.rb"
   ]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: yamdi
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Bob Burbach
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-25 00:00:00 -08:00
+date: 2011-01-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -131,9 +131,12 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- lib/key_frame.rb
 - lib/paperclip_processors/metadata_extractor.rb
+- lib/tasks/metadata_refresh.rake
 - lib/yamdi.rb
 - spec/files/sample.flv
+- spec/key_frame_spec.rb
 - spec/spec_helper.rb
 - spec/yamdi_spec.rb
 - yamdi.gemspec
@@ -172,5 +175,6 @@ signing_key:
 specification_version: 3
 summary: Yamdi is a ruby wrapper around the command line tool yamdi (github.com/ioppermann/yamdi).
 test_files: 
+- spec/key_frame_spec.rb
 - spec/spec_helper.rb
 - spec/yamdi_spec.rb