vtools 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # VTools
 
-Daemon video processor tools to operate the video (get info, encode & generate thumbnails).
+Daemon tools to operate the video (get info, encode & generate thumbnails).
 Under the hood ffmpeg & ffmpegthumbnailer are used.
 Some ideas has been taken at the streamio-ffmpeg gem (parse output methods).
 
@@ -10,13 +10,13 @@ Project was developed for the [WebTV](http://web.tv)
 
   (sudo) gem install vtools
 
-Please read changelog to check ffmpeg versions compatibility.
+Please read changelog to check ffmpeg versions compatibility (vtools understands 0.7 & 0.8).
 
 ## Usage
 
 ### Getting started
 
-Before start, daemon should be correctly configured, to have valid access to the storage.
+Before start, daemon should be configured correctly, to have valid access to the storage.
 Mandatory methods are: **connect**, **recv** and **send**.
 
 ``` ruby
@@ -82,7 +82,7 @@ thumbnailer (ffmpegthumbnailer)
 
 ## Start
 
-To launch daemon is enough to require library with storage setup:
+To launch daemon - is enough to require library with storage setup:
   (sudo) vtools start -- -r library
 
 ## Options
@@ -116,6 +116,7 @@ It accepts file name and should return relative path (excluding file name itself
 # path generator (used to )
 VTools.path_generator do |file_name|
   # ..
+  "#{file_name[0..2]}/{file_name[2..4]}"
 end
 
 ```

data/Rakefile

@@ -8,7 +8,7 @@ require "vtools/version"
 spec = Gem::Specification.new do |s|
   s.name                    = "vtools"
   s.summary                 = "Daemon tools to operate the video (get info, encode & generate thumbnails)."
-  s.description             = File.read(File.join(File.dirname(__FILE__), 'README.md'))
+  s.description             = "Daemon tools to operate the video (get info, encode & generate thumbnails)."
   s.extensions              = 'extconf.rb'
   s.version                 = VTools::VERSION.join('.')
   s.requirements            = ['ffmpeg v >= 1.8', 'ffmpegthumbnailer v >= 2', 'gem Daemons v >= 1.1.4']
@@ -26,4 +26,4 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency  'rspec'
 end
 
-Rake::GemPackageTask.new(spec).define
+Rake::GemPackageTask.new(spec).define

data/doc/LIB_EXAMPLE.md

@@ -2,8 +2,9 @@
 
 Library can be required via `-r` option
 
-  $ vtools start -- -r library
-  $ vtools start -- -r library.rb
+$ vtools start -- -r library
+
+$ vtools start -- -r library.rb
 
 ```ruby
 # -*- encoding: binary -*-
@@ -106,4 +107,4 @@ VTools::Handler.collection do
     print "(#{video.name}) <------ job     |finished | {#{video}} :: scope: #{action}\n"
   end
 end
-```
+```

data/lib/vtools/convert_options.rb

@@ -37,7 +37,6 @@ module VTools
       return value
     end
 
-    # to string method
     def to_s
 
       params = collect do |key, value|

data/lib/vtools/converter.rb

@@ -6,7 +6,6 @@ module VTools
   class Converter
     include SharedMethods
 
-    # constructor
     def initialize video
       @video = video
     end

data/lib/vtools/handler.rb

@@ -2,9 +2,9 @@
 
 module VTools
 
-  # callback handler
-  # allows to execute external script callbacks
-  # multiple callbacs in one placeholder are allowed
+  # hooks handler
+  # allows to execute hooks from external script
+  # multiple hooks in one placeholder are allowed
   #
   # usage:
   #   Handler.set :placeholder_name, &block
@@ -19,14 +19,14 @@ module VTools
     @callbacks = {}
 
     class << self
-      # callbacks setter
+      # hooks setter
       def set action, &block
         action = action.to_sym
         @callbacks[action] = [] unless @callbacks[action].is_a? Array
         @callbacks[action] << block if block_given?
       end
 
-      # pending callbacks exectuion
+      # pending hooks exectuion
       def exec action, *args
         action = action.to_sym
         @callbacks[action].each do |block|

data/lib/vtools/job.rb

@@ -6,7 +6,6 @@ module VTools
   class Job
     attr_reader   :video, :id
 
-    # constructor
     def initialize config
       @id = self.object_id.to_i
       @config = validate config
@@ -15,7 +14,7 @@ module VTools
 
     # execute job
     def execute
-      # start callback
+      # start hook
       Handler.exec :job_started, @video, @config.action
 
       result = @video.get_info # we always get info
@@ -27,7 +26,7 @@ module VTools
         result = @video.create_thumbs @config.setup # will return thumbs array
       end
 
-      # final callbacks
+      # final hook
       Handler.exec :job_finished, result, @video, @config.action
       result
     end
@@ -43,6 +42,5 @@ module VTools
       end
       options
     end
-
   end # Job
 end # VTools

data/lib/vtools/storage.rb

@@ -10,19 +10,19 @@ module VTools
 
     class << self
 
-      # constructor (cretes connection)
+      # creates connection
       def connect
         fails __method__ unless @actions[:connect]
         @actions[:connect].call
       end
 
-      # recv basic method
+      # receive basic method
       def recv
         fails __method__ unless @actions[:recv]
         @actions[:recv].call
       end
 
-      # send masic method
+      # send basic method
       def send data
         fails __method__ unless @actions[:send]
         @actions[:send].call(data)
@@ -33,7 +33,7 @@ module VTools
         @actions[:connect] = block
       end
 
-      # callback setter to recieve data
+      # callback setter to receive data
       def recv_action &block
         @actions[:recv] = block
       end
@@ -59,7 +59,6 @@ module VTools
       private
       # errors generator
       def fails meth
-p "fails orig: #{meth}"
         raise NotImplementedError, "VTools::Storage##{meth}_action must be set"
       end
     end # class << self

data/lib/vtools/thumbnailer.rb

@@ -7,7 +7,6 @@ module VTools
   class Thumbnailer
     include SharedMethods
 
-    # constructor
     def initialize video
       @video = video
     end

data/lib/vtools/thumbs_options.rb

@@ -6,7 +6,6 @@ module VTools
   class ThumbsOptions < Hash
     include SharedMethods
 
-    # constructor
     def initialize options = {}
 
       @ignore = [:thumb_count, :thumb_start_point, :quality, :width, :time, :postfix]
@@ -36,7 +35,6 @@ module VTools
       value
     end
 
-    # to string
     def to_s
       params = collect do |key, value|
         "-#{key} #{value}" unless @ignore.include?(key)

data/lib/vtools/version.rb

@@ -2,5 +2,5 @@
 
 # current version
 module VTools
-  VERSION = [ 0, 0, 1 ]
+  VERSION = [ 0, 0, 2 ]
 end

data/lib/vtools/video.rb

@@ -11,7 +11,6 @@ module VTools
                 :audio_sample_rate,
                 :convert_options, :thumbs_options
 
-    # json generator
     def to_json(*args)
       ignore = [:@convert_options, :@thumbs_options, :@converter, :@thumbnailer, :@uncertain_duration, :invalid]
 
@@ -24,7 +23,6 @@ module VTools
       hsh.to_json(*args)
     end
 
-    # constructor
     def initialize path
 
       @invalid = true
@@ -97,8 +95,7 @@ module VTools
 
       self
     end
-    
-    # define if is valid video file
+
     def valid?
       not @invalid
     end
@@ -108,17 +105,15 @@ module VTools
       @uncertain_duration
     end
 
-    # width getter
     def width
       resolution.split("x").first.to_i rescue nil
     end
 
-    # height getter
     def height
       resolution.split("x").last.to_i rescue nil
     end
 
-    # aspect ratio getter
+    # aspect ratio calculator
     def calculated_aspect_ratio
       if dar
         w, h = dar.split(":")
@@ -134,7 +129,7 @@ module VTools
       File.size(@path)
     end
 
-    # audio channels getter
+    # valid audio channels index
     def audio_channels
       return nil unless @audio_channels
       return @audio_channels[/\d*/].to_i if @audio_channels["channels"]
@@ -143,7 +138,6 @@ module VTools
       return 6 if @audio_channels["5.1"]
     end
 
-    # frame rate getter
     def frame_rate
       video_stream[/(\d*\.?\d*)\s?fps/] ? $1.to_f : nil
     end

data/spec/convert_options_spec.rb

@@ -71,7 +71,7 @@ describe VTools::ConvertOptions do
   context "#to_s" do
 
     # skps ignored values
-    it "reates valid string representation" do
+    it "creates valid string representation" do
 
       # still empty
       @options.to_s.should == ""

data/spec/thumbs_options_spec.rb

@@ -68,7 +68,7 @@ describe VTools::ThumbsOptions do
 
     # [:thumb_count, :thumb_start_point, :quality, :width, :time, :postfix]
     # skps ignored values
-    it "reates valid string representation" do
+    it "creates valid string representation" do
 
       # still empty
       @options.to_s.should == ""

data/spec/video_spec.rb

@@ -249,7 +249,7 @@ describe VTools::Video do
 
   context "#initialize" do
 
-    it "crates instance valid" do
+    it "creates instance valid" do
       VTools::CONFIG[:PWD] = "/root"
       File.stub!(:exists?) { true }
       VTools::Converter.stub!(:new) { nil }

data/vtools.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
 
   s.name                    = "vtools"
   s.summary                 = "Daemon tools to operate the video (get info, encode & generate thumbnails)."
-  s.description             = File.read(File.join(File.dirname(__FILE__), 'README.md'))
+  s.description             = "Daemon tools to operate the video (get info, encode & generate thumbnails)."
 
   s.extensions              = 'extconf.rb'
   s.requirements            = ['ffmpeg v >= 1.8', 'ffmpegthumbnailer v >= 2', 'gem Daemons v >= 1.1.4']

metadata

@@ -1,93 +1,75 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: vtools
-version: !ruby/object:Gem::Version
-  version: 0.0.1
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
-authors:
+authors: 
 - tofir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-23 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-11-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: daemons
-  requirement: &79101960 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 1
+        - 4
         version: 1.1.4
   type: :runtime
-  prerelease: false
-  version_requirements: *79101960
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &79101770 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *79101770
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &79101540 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *79101540
-description: ! "# VTools\n\nDaemon video processor tools to operate the video (get
-  info, encode & generate thumbnails).\nUnder the hood ffmpeg & ffmpegthumbnailer
-  are used.\nSome ideas has been taken at the streamio-ffmpeg gem (parse output methods).\n\nProject
-  was developed for the [WebTV](http://web.tv)\n\n## Installation\n\n  (sudo) gem
-  install vtools\n\nPlease read changelog to check ffmpeg versions compatibility.\n\n##
-  Usage\n\n### Getting started\n\nBefore start, daemon should be correctly configured,
-  to have valid access to the storage.\nMandatory methods are: **connect**, **recv**
-  and **send**.\n\n``` ruby\n#--file library.rb--#\n# encoding: binary\n\n#to setup
-  storage:\nVTools::Storage.setup do\n\n  # connection setup\n  connect_action do\n
-  \   # ... connect to the storage (persistent)\n  end\n\n  # message reciever\n  #
-  should return JSON encoded string\n  # see complete storage setup reference for
-  details\n  recv_action do\n    # ... job data recieve algorithm\n  end\n\n  # message
-  sender\n  # recieves hash: { :data => execution_result, :action => executed_action
-  }\n  # execution_result can be video object or array with thumbnails\n  send_action
-  do |result|\n    # ... send action here\n  end\nend\n\n# storage can be setup separate\nVTools::Storage.connect_action
-  do\n  # ... connect to the storage\nend\n```\n\n### Setup message (JSON)\n\n```\n{
-  \"action\" : \"convert|thumbs|info\", \"file\" : \"path/to/file\", \"setup\" :  <
-  setup > }\n# setup can be:\n# -- \"predefined_set_id\"\n# -- { ffmpeg_options_hash
-  }\n# -- { \"set\": \"predefined_set_str\", ffmpeg_options_hash }\n```\n\n### User
-  friendly option names\n\n```\nconverter (ffmpeg)\n  preserve_aspect   (true or false)\n
-  \ extension         (result file extension)\n  width, height\n  resolution\n  duration\n\nthumbnailer
-  (ffmpegthumbnailer)\n  thumb_count\n  thumb_start_point (in percents)\n  time              (time
-  offset, alias for -t)\n  quality           (0 - 10)\n  width\n```\n\n## Start\n\nTo
-  launch daemon is enough to require library with storage setup:\n  (sudo) vtools
-  start -- -r library\n\n## Options\n\n### Daemon options are\n  start\n  stop\n  restart\n\n###
-  Application options are:\n  -c or --config-file - load config from file\n  -r or
-  --require     - load ruby library file (can be used more than once)\n\n### To see
-  complete options list use\n  vtools --help\n\n### Using logger\n\nBy default the
-  `logger` gem is used. But there is possibility to set custom logger, that is compatible
-  with the default logger.\n\n``` ruby\nVTools.logger = CustomLoger.new($stdout)\n```\n\n###
-  Additioinal methods\n\nPath generator is used by the thumnailer, converter or both
-  to generate necessary dir tree logic for the media.\nIt accepts file name and should
-  return relative path (excluding file name itself)\n\n``` ruby\n# path generator
-  (used to )\nVTools.path_generator do |file_name|\n  # ..\nend\n\n```\n\n**Network
-  calls** (TCP GET request, that will return message body content, ignoring response
-  headers)\n\n``` ruby\n\n# http calls\nVTools.network_call \"site.com/some/uri\"\nVTools.network_call
-  \"www.site.com\"\nVTools.network_call \"http://www.site.com\"\n```\n"
+  version_requirements: *id003
+description: Daemon tools to operate the video (get info, encode & generate thumbnails).
 email: v.tofir@gmail.com
-executables:
+executables: 
 - vtools
-extensions:
+extensions: 
 - extconf.rb
 extra_rdoc_files: []
-files:
+
+files: 
 - bin/vtools
 - README.md
 - Rakefile
@@ -100,7 +82,6 @@ files:
 - lib/vtools/errors.rb
 - lib/vtools/job.rb
 - lib/vtools/convert_options.rb
-- lib/vtools/version.rb~
 - lib/vtools/thumbnailer.rb
 - lib/vtools/shared_methods.rb
 - lib/vtools/handler.rb
@@ -136,23 +117,32 @@ files:
 - extconf.rb
 homepage: http://tofir.comuv.com
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '1.9'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 29
+      segments: 
+      - 1
+      - 9
+      version: "1.9"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-requirements:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: 
 - ffmpeg v >= 1.8
 - ffmpegthumbnailer v >= 2
 - gem Daemons v >= 1.1.4
@@ -161,7 +151,7 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Daemon tools to operate the video (get info, encode & generate thumbnails).
-test_files:
+test_files: 
 - spec/job_spec.rb
 - spec/convert_options_spec.rb
 - spec/config_spec.rb

data/lib/vtools/version.rb~

@@ -1,4 +0,0 @@
-# -*- encoding: binary -*-
-
-# current version
-VTools::VERSION = [ 0, 0, 1 ]