diskid 0.1.3 → 0.2

data/README.md

@@ -1,5 +1,16 @@
-# Disk Identification Service 
+# DiskID
  
+Get info from a virtual disk file.
+
+    $ diskid micro-frameos.vmdk
+
+    diskid.frameos.org
+
+    file name: micro-frameos.vmdk
+    file format: vmdk
+    virtual size: 1.2G (1287651328 bytes)
+    disk size: 274M (287593984 bytes)
+
 ## Installation
 
     gem install diskid
@@ -10,9 +21,9 @@ Internet access is also required, as diskid sends a few bytes to http://diskid.f
 
 ## Usage
 
-    diskid path-to-disk-file
+    diskid --help
     
-i.e.
+### EXAMPLES
 
     $ diskid ubuntu64-1104.vmdk
 
@@ -20,15 +31,33 @@ i.e.
 
     file name: ubuntu64-1104.vmdk
     file format: vmdk
-    virtual size: 9.0G (9663676416 bytes)
-    disk size: 319M (334364672 bytes)
+    virtual size: 9.0G 
+    disk size: 319M 
 
 
 PROTIP: You don't need to install diskid to use the service
 
-    head -n 20 ubuntu64-1104.vmdk > /tmp/dchunk && curl -X POST -F chunk=@/tmp/dchunk http://diskid.frameos.org
+    head -n 20 ubuntu64-1104.vmdk > /tmp/dchunk && curl -X POST -F chunk=@/tmp/dchunk http://diskid.frameos.org/?format=text
 
+JSON output:
     
+    $ diskid --format json ubuntu64-1104.vmdk
+
+    diskid.frameos.org
+
+    {"file_name":"ubuntu64-1104.vmdk","format":"vmdk","virtual_size":"9.0G","disk_size":"319M"}
+
+Valid output formats:
+
+* json
+* text
+* xml
+
+## NERD STUFF
+
+DiskID Webservice is a thin wrapper around the bleeding edge version of qemu-img from the QEMU project: http://qemu.org
+
+All the magic happens there!
 
 Copyright (c) 2011 Sergio Rubio. See LICENSE.txt for
 further details.

data/Rakefile

@@ -19,6 +19,7 @@ Jeweler::Tasks.new do |gem|
   gem.add_runtime_dependency 'clamp'
   gem.add_runtime_dependency 'alchemist'
   gem.add_runtime_dependency 'rest-client'
+  gem.add_runtime_dependency 'json'
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/bin/diskid

@@ -2,30 +2,54 @@
 require 'fileutils'
 require 'clamp'
 require 'rest-client'
+require 'alchemist'
+require 'diskid'
 
-disk_file = ARGV[0]
-if disk_file.nil? or not File.exist?(disk_file)
-  puts
-  puts "Usage: diskid path-to-disk-file"
-  puts
-  puts "Supported formats: vvfat vpc vmdk vdi sheepdog raw host_cdrom host_floppy host_device file qed qcow2 qcow parallels nbd dmg tftp ftps ftp https http cow cloop bochs blkverify blkdebug"
-  exit 1
-end
-host = 'diskid.frameos.org'
+class DiskIDCommand < Clamp::Command
+  parameter 'FILE', "Disk file", :attribute_name => 'file'
+  option '--server-port', "PORT", "DiskID service port", :default => '80'
+  option '--server-host', "HOST", "DiskID service host", :default => 'diskid.frameos.org'
+  option '--format', "FORMAT", "Disk info output format (text, json, xml)", :default => 'text'
 
-puts "\n#{host}\n\n"
 
-begin
-  RestClient.get "http://#{host}/service-check"
-rescue => e
-  $stderr.puts "Couldn't reach http://#{host}."
-  exit 1
-end
+  def execute
+
+    if file.nil? or not File.exist?(file)
+      puts
+      puts "Usage: diskid path-to-disk-file"
+      puts
+      puts "Supported formats: vvfat vpc vmdk vdi sheepdog raw host_cdrom host_floppy host_device file qed qcow2 qcow parallels nbd dmg tftp ftps ftp https http cow cloop bochs blkverify blkdebug"
+      exit 1
+    end
+
+    puts "\n#{server_host}\n\n"
+
+    begin
+      RestClient.get "http://#{server_host}:#{server_port}/service-check"
+    rescue => e
+      $stderr.puts "Couldn't reach http://#{server_host}."
+      exit 1
+    end
 
-out = `head -n 20 #{disk_file}|curl -s -X POST -F chunk=@- -F file_size=#{File.size(disk_file)} -F file_name=#{File.basename(disk_file)} http://#{host} 2>&1`
-if $? != 0
-  $stderr.puts "Something went wrong :("
-  $stderr.puts out
-else
-  puts out
+    fsize = File.size(file).bytes.to.megabytes.to_f.round
+    unit = 'M'
+    if fsize > 1024
+      fsize = fsize.megabytes.to.gigabytes.to_f.round
+      unit = 'G'
+    end
+
+    fsize = "#{fsize}#{unit}"
+
+    #out = `head -n 20 #{file}|curl -s -X POST -F client_version=#{DiskID::VERSION} -F chunk=@- -F file_size=#{fsize} -F file_name=#{File.basename(file)} http://#{server_host}:#{server_port}/?format=#{format} 2>&1`
+    out = RestClient.post "http://#{server_host}:#{server_port}/",
+                    :chunk => File.read(file, 20000),
+                    :client_version => DiskID::VERSION,
+                    :file_size => fsize,
+                    :file_name => File.basename(file),
+                    :format => format
+    puts out
+  end
 end
+
+DiskIDCommand.run
+

data/bin/diskid-ws

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'sinatra'
 require 'alchemist'
+require 'diskid'
 
 DOCS = """
 <h1>Virtual Disk Identification Service</h1>
@@ -33,31 +34,41 @@ This web service gives you info about a virtual disk file.
 class DiskIDWS < Sinatra::Base
 
   post '/' do
+    # post using CURL
     tmpfile = params[:chunk][:tempfile] rescue nil
+    # File was posted using diskid client
+    if not tmpfile
+      tmpfile = File.open("/tmp/diskid_#{Time.now.to_i}", 'w+')
+      tmpfile.write(params[:chunk])
+    end
     file_name = (params[:file_name] || '') rescue ''
 
     if tmpfile.nil? 
       halt 400, "Couldn't understand the file you sent me dude."
     end
-    file_size = params[:file_size]
-    out = `qemu-img-bleeding info #{tmpfile.path}`
-    if $? != 0
-      halt 400, "Couldn't understand the file you sent me dude."
-    end
-
+    file_size = params[:file_size] || ''
     begin
-      buf = ''
-      if file_name.empty?
-        buf << "\nSome fields are being omitted and 'disk size:' won't be accurate.\n"
-        buf << "Use diskid command for better results\n\n"
+      inspector = DiskID::Inspector.new(tmpfile.path)
+      di = inspector.inspect
+      di.file_name = file_name
+      di.disk_size = file_size
+      if params[:format] == 'json'
+        buf = di.to_json 
+      elsif params[:format] == 'xml'
+        buf = di.to_xml
       else
-        buf << "file name: #{file_name}\n"
-      end
-      out.each_line do |l|
-        buf << l if l !~ /(image:|disk size:)/
+        out = di.to_hash
+        buf = ''
+        if file_name.empty?
+          buf << "\nSome fields are being omitted and 'disk size:' won't be accurate.\n"
+          buf << "Use diskid command for better results\n\n"
+        else
+          buf << "file_name: #{file_name}\n"
+        end
+        out.each do |k,v|
+          buf << "#{k}: #{v}\n" if k != 'file_name'
+        end
       end
-
-      buf << "disk size: #{'%.0f' % file_size.to_i.bytes.to.megabytes.to_f}M (#{file_size} bytes)\n"
       tmpfile.close
       FileUtils.rm_f tmpfile.path
       buf
@@ -72,6 +83,10 @@ class DiskIDWS < Sinatra::Base
     DOCS
   end
 
+  get '/' do
+    DOCS
+  end
+
   error do
     DOCS
   end

data/lib/diskid.rb

@@ -1,3 +1,70 @@
 module DiskID
-  VERSION = "0.1.3"
+
+  require 'json'
+
+  VERSION = "0.2"
+
+  class DiskInfo
+
+    attr_accessor :file_name, :format, :virtual_size, :disk_size
+
+    def initialize(params)
+      @hash = params
+      @file_name = @hash['file_name']
+      @format = @hash['format']
+      @virtual_size = @hash['virtual_size']
+      @disk_size = @hash['disk_size']
+    end
+
+    def to_json
+      to_hash.to_json
+    end
+
+    def to_xml
+      buf = ""
+      buf << "<disk_info>"
+      buf << "<file_name>#{@file_name}</file_name>"
+      buf << "<format>#{@format}</format>"
+      buf << "<virtual_size>#{@virtual_size}</virtual_size>"
+      buf << "<disk_size>#{@disk_size}</disk_size>"
+      buf << "</disk_info>"
+      buf
+    end
+
+    def to_hash
+      {
+        'file_name' =>  @file_name,
+        'format' => @format,
+        'virtual_size' => @virtual_size,
+        'disk_size' => @disk_size
+      }
+    end
+
+  end
+
+  class Inspector
+
+
+    def initialize(file, qemu_img_bin='qemu-img-bleeding')
+      @qemu_img_bin = qemu_img_bin
+      @file = file
+    end
+
+    def inspect
+      out = `#{@qemu_img_bin} info #{@file}`
+      raise Exception.new("Error getting info from #{@file}") if $? != 0
+
+      md = /image:(.*)$\nfile format:(.*)$\nvirtual size:(.*)$\ndisk size:(.*)\n/.match out
+      @file_name,@format,@virtual_size,@disk_size = [md[1], md[2], md[3], md[4]].map { |e| e.strip.chomp }
+      @virtual_size = @virtual_size.split()[0]
+      DiskInfo.new({
+        'file_name' =>  @file_name,
+        'format' => @format,
+        'virtual_size' => @virtual_size,
+        'disk_size' => @disk_size
+      })
+    end
+
+
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diskid
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-27 00:00:00.000000000 Z
+date: 2011-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &13197200 !ruby/object:Gem::Requirement
+  requirement: &14447600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13197200
+  version_requirements: *14447600
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &13196580 !ruby/object:Gem::Requirement
+  requirement: &14446900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *13196580
+  version_requirements: *14446900
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &13194880 !ruby/object:Gem::Requirement
+  requirement: &14446160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *13194880
+  version_requirements: *14446160
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &13193980 !ruby/object:Gem::Requirement
+  requirement: &14445460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13193980
+  version_requirements: *14445460
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &13193260 !ruby/object:Gem::Requirement
+  requirement: &14444720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13193260
+  version_requirements: *14444720
 - !ruby/object:Gem::Dependency
   name: clamp
-  requirement: &13192540 !ruby/object:Gem::Requirement
+  requirement: &14443980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13192540
+  version_requirements: *14443980
 - !ruby/object:Gem::Dependency
   name: alchemist
-  requirement: &13191980 !ruby/object:Gem::Requirement
+  requirement: &14443500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13191980
+  version_requirements: *14443500
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &13207720 !ruby/object:Gem::Requirement
+  requirement: &14443020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13207720
+  version_requirements: *14443020
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &14442520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14442520
 description: Virtual Disk Identification Service
 email: rubiojr@frameos.org
 executables: