visor-image 0.0.1

data/lib/image/cli.rb

@@ -0,0 +1,397 @@
+require 'open-uri'
+require 'logger'
+require 'optparse'
+require 'fileutils'
+
+require 'goliath/api'
+require 'goliath/runner'
+
+module Visor
+  module Image
+    class CLI
+
+      attr_reader :argv, :conf_file, :options, :new_opts, :command, :parser
+
+      # Available commands
+      COMMANDS     = %w[start stop restart status clean]
+      # Commands that wont load options from the config file
+      NO_CONF_LOAD = %w[stop status clean]
+      # Default files directory
+      DEFAULT_DIR  = File.expand_path('~/.visor')
+
+      # Initialize a new CLI
+      def initialize(argv=ARGV)
+        @argv      = argv
+        @options   = {}
+        @conf_file = load_conf_file
+        @options   = defaults
+        @new_opts  = []
+        @parser    = parser
+        @command   = parse!
+      end
+
+      # Generate the default options
+      def defaults
+        {:config     => ENV['GOLIATH_CONF'],
+         :address    => conf_file[:bind_host],
+         :port       => conf_file[:bind_port],
+         :log_file   => File.join(File.expand_path(conf_file[:log_path]), conf_file[:log_file]),
+         :pid_file   => File.join(DEFAULT_DIR, 'visor_api.pid'),
+         :env        => :production,
+         :daemonize  => true,
+         :log_stdout => false}
+      end
+
+      # OptionParser parser
+      def parser
+        OptionParser.new do |opts|
+          opts.banner = "Usage: visor-image [OPTIONS] COMMAND"
+
+          opts.separator ""
+          opts.separator "Commands:"
+          opts.separator "     start        start the server"
+          opts.separator "     stop         stop the server"
+          opts.separator "     restart      restart the server"
+          opts.separator "     status       current server status"
+
+          opts.separator ""
+          opts.separator "Options:"
+
+          opts.on("-c", "--config FILE", "Load a custom configuration file") do |file|
+            options[:conf_file] = File.expand_path(file)
+            new_opts << :config_file
+          end
+          opts.on("-a", "--address HOST", "Bind to HOST address (default: #{options[:address]})") do |addr|
+            options[:address] = addr
+            new_opts << :address
+          end
+          opts.on("-p", "--port PORT", "Use PORT (default: #{options[:port]})") do |port|
+            options[:port] = port.to_i
+            new_opts << :port
+          end
+          opts.on("-e", "--env NAME", "Set the execution environment (default: #{options[:env]})") do |env|
+            options[:env] = env.to_sym
+            new_opts << :env
+          end
+
+          opts.separator ""
+          opts.on('-l', '--log FILE', "Log to file (default: #{@options[:log_file]})") do |file|
+            @options[:log_file] = file
+            new_opts << :log_file
+          end
+          opts.on('-u', '--user USER', "Run as specified user") do |v|
+            @options[:user] = v
+            new_opts << :user
+          end
+          opts.on("-f", "--foreground", "Do not daemonize") do
+            options[:daemonize]  = false
+            options[:log_stdout] = true
+            new_opts << :daemonize
+          end
+
+          #opts.separator ""
+          #opts.separator "SSL options:"
+          #opts.on('--ssl', 'Enables SSL (default: off)') {|v| @options[:ssl] = v }
+          #opts.on('--ssl-key FILE', 'Path to private key') {|v| @options[:ssl_key] = v }
+          #opts.on('--ssl-cert FILE', 'Path to certificate') {|v| @options[:ssl_cert] = v }
+          #opts.on('--ssl-verify', 'Enables SSL certificate verification') {|v| @options[:ssl_verify] = v }
+
+          opts.separator ""
+          opts.separator "Common options:"
+
+          opts.on_tail("-d", "--debug", "Set debugging on") do
+            options[:debug] = true
+            new_opts << :debug
+          end
+          opts.on_tail('-v', '--verbose', "Enable verbose logging") do
+            options[:verbose] = true
+            new_opts << :verbose
+          end
+          opts.on_tail("-h", "--help", "Show this message") { show_options(opts) }
+          opts.on_tail('-V', '--version', "Show version") { show_version }
+        end
+      end
+
+      # Parse the current shell arguments and run the command.
+      # Exits on error.
+      def run!
+        if command.nil?
+          abort @parser.to_s
+
+        elsif COMMANDS.include?(command)
+          unless NO_CONF_LOAD.include?(command)
+            @options.merge!({address: options[:address], port: options[:port]})
+          end
+
+          case command
+          when 'start' then
+            start
+          when 'stop' then
+            stop
+          when 'restart' then
+            restart
+          when 'status' then
+            status
+          else
+            clean
+          end
+          exit 0
+        else
+          abort "Unknown command: #{command}. Available commands: #{COMMANDS.join(', ')}"
+        end
+      end
+
+      # Remove all files created by the daemon.
+      def clean
+        begin
+          FileUtils.rm(pid_file) rescue Errno::ENOENT
+          FileUtils.rm(url_file) rescue Errno::ENOENT
+        end
+        put_and_log :warn, "Removed all tracking files created at server start"
+      end
+
+      # Restart server
+      def restart
+        @restart = true
+        stop
+        sleep 0.1 while running?
+        start
+      end
+
+      # Display current server status
+      def status
+        if running?
+          STDERR.puts "VISoR Image Server is running PID: #{fetch_pid} URL: #{fetch_url}"
+        else
+          STDERR.puts "VISoR Image Server is not running."
+        end
+      end
+
+      # Stop the server
+      def stop
+        begin
+          pid = File.read(pid_file)
+          put_and_log :warn, "Stopping VISoR Image Server with PID: #{pid.to_i} Signal: INT"
+          Process.kill(:INT, pid.to_i)
+          File.delete(url_file)
+        rescue
+          put_and_log :warn, "Cannot stop VISoR Image Server, is it running?"
+          exit! 1
+        end
+      end
+
+      # Start the server
+      def start
+        FileUtils.mkpath(DEFAULT_DIR) unless Dir.exists?(DEFAULT_DIR)
+        begin
+          is_it_running?
+          can_use_port?
+          write_url
+          launch!
+        rescue => e
+          put_and_log :warn, "Error starting VISoR Image Server: #{e.message}\n#{e.backtrace.to_s}"
+          exit! 1
+        end
+      end
+
+      # Launch the server
+      def launch!
+        put_and_log :info, "Starting VISoR Image Server at #{options[:address]}:#{options[:port]}"
+        debug_settings
+
+        runner     = Goliath::Runner.new(opts_to_goliath, Visor::Image::Server.new)
+        runner.app = Goliath::Rack::Builder.build(Visor::Image::Server, runner.api)
+        runner.run
+      end
+
+
+      protected
+
+      # Convert options hash to a compatible Goliath ARGV array
+      def opts_to_goliath
+        argv_like = []
+        @options.each do |k, v|
+          case k
+          when :config then
+            argv_like << '-c' << v.to_s
+          when :log_file then
+            argv_like << '-l' << v.to_s
+          when :pid_file then
+            argv_like << '-P' << v.to_s
+          when :env then
+            argv_like << '-e' << v.to_s
+          when :address then
+            argv_like << '-a' << v.to_s
+          when :port then
+            argv_like << '-p' << v.to_s
+          when :user then
+            argv_like << '-u' << v.to_s
+          when :daemonize then
+            argv_like << '-d' << v.to_s if v
+          when :verbose then
+            argv_like << '-v' << v.to_s if v
+          when :log_stdout then
+            argv_like << '-s' << v.to_s if v
+          end
+        end
+        argv_like
+      end
+
+      # Display options
+      def show_options(opts)
+        puts opts
+        exit
+      end
+
+      # Show VISoR Image Server version
+      def show_version
+        puts "VISoR Image Server v#{Visor::Image::VERSION}"
+        exit
+      end
+
+      # Check if the server is already running
+      def is_it_running?
+        if files_exist?(pid_file, url_file)
+          if running?
+            put_and_log :warn, "VISoR Image Server is already running at #{fetch_url}"
+            exit! 1
+          else
+            clean
+          end
+        end
+      end
+
+      # Test process pid to access the server status
+      def running?
+        begin
+          Process.kill 0, fetch_pid
+          true
+        rescue Errno::ESRCH
+          false
+        rescue Errno::EPERM
+          true
+        rescue
+          false
+        end
+      end
+
+      # Test if port is open
+      def can_use_port?
+        unless port_open?
+          put_and_log :warn, "Port #{options[:port]} already in use. Please try other."
+          exit! 1
+        end
+      end
+
+      # Access that port is open
+      def port_open?
+        begin
+          STDERR.puts url
+          options[:no_proxy] ? open(url, proxy: nil) : open(url)
+          false
+        rescue OpenURI::HTTPError #TODO: quick-fix, try solve this
+          false
+        rescue Errno::ECONNREFUSED
+          true
+        end
+      end
+
+      # Retrieve a logger instance
+      def logger
+        @logger ||=
+            begin
+              log           = options[:daemonize] ? Logger.new(log_file) : Logger.new(STDERR)
+              conf_level    = conf_file[:log_level] == 'INFO' ? 1 : 0
+              log.level     = options[:debug] ? 0 : conf_level
+              log.formatter = proc do |s, t, n, msg|
+                #"[#{t.strftime(conf_file[:log_datetime_format])}] #{s} - #{msg}\n"
+                "[#{Process.pid}:#{s}] #{t.strftime(conf_file[:log_datetime_format])} :: #{msg}\n"
+              end
+              log
+            end
+      end
+
+      # Print to stderr and log message
+      def put_and_log(level, msg)
+        STDERR.puts msg
+        logger.send level, msg
+      end
+
+      # Parse argv arguments
+      def parse!
+        parser.parse! argv
+        argv.shift
+      end
+
+      # Log debug settings
+      def debug_settings
+        logger.debug "Configurations loaded from #{conf_file[:file]}:"
+        logger.debug "**************************************************************"
+        conf_file.each { |k, v| logger.debug "#{k}: #{v}" unless k == :file }
+        logger.debug "**************************************************************"
+
+        logger.debug "Configurations passed from VISoR Image Server CLI:"
+        logger.debug "**************************************************************"
+        if new_opts.empty?
+          logger.debug "none"
+        else
+          new_opts.each { |k| logger.debug "#{k}: #{options[k]}" }
+        end
+        logger.debug "**************************************************************"
+      end
+
+      # Check if a set of files exist
+      def files_exist?(*files)
+        files.each { |file| return false unless File.exists?(File.expand_path(file)) }
+        true
+      end
+
+      # Generate the listening url
+      def url
+        "http://#{options[:address]}:#{options[:port]}"
+      end
+
+      # Write url to file
+      def write_url
+        File.open(url_file, 'w') { |f| f << url }
+      end
+
+      # Load url from file
+      def fetch_url
+        IO.read(url_file).split('//').last
+      rescue
+        nil
+      end
+
+      # Load configuration file options
+      def load_conf_file
+        Visor::Common::Config.load_config(:visor_image, options[:conf_file])
+      rescue => e
+        raise "There was an error loading the configuration file: #{e.message}"
+      end
+
+      # Fetch pid from file
+      def fetch_pid
+        IO.read(pid_file).to_i
+      rescue
+        nil
+      end
+
+      # Current pid file option
+      def pid_file
+        options[:pid_file]
+      end
+
+      # Current log file option
+      def log_file
+        options[:log_file]
+      end
+
+      # Current url file location
+      def url_file
+        File.join(DEFAULT_DIR, 'visor_api.url')
+      end
+
+    end
+  end
+end

data/lib/image/client.rb

@@ -0,0 +1,490 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module Visor
+  module Image
+
+    # The Client API for the VISoR Image Server. This class supports all image metadata and
+    # files operations through a programmatically interface.
+    #
+    # After Instantiate a Client object its possible to directly interact with the
+    # image server and its store backends.
+    #
+    class Client
+      include Visor::Common::Exception
+      include Visor::Common::Util
+
+      attr_reader :host, :port, :ssl, :access_key, :secret_key
+
+      # Initializes a new new VISoR Image Client.
+      #
+      # @option opts [String] :host (DEFAULT_HOST) The host address where VISoR image server resides.
+      # @option opts [String] :port (DEFAULT_PORT) The host port where VISoR image server resides.
+      # @option opts [String] :ssl (false) If the connection should be made through HTTPS (SSL).
+      #
+      # @example Instantiate a client with default values:
+      #   client = Visor::Image::Client.new
+      #
+      # @example Instantiate a client with custom host and port:
+      #   client = Visor::Image::Client.new(host: '127.0.0.1', port: 3000)
+      #
+      def initialize(opts = {})
+        configs     = Common::Config.load_config :visor_image
+        @host       = opts[:host] || configs[:bind_host] || '0.0.0.0'
+        @port       = opts[:port] || configs[:bind_port] || 4568
+        @ssl        = opts[:ssl] || false
+        @access_key = configs[:access_key]
+        @secret_key = configs[:secret_key]
+      end
+
+      # Retrieves detailed image metadata of the image with the given id.
+      #
+      # @param id [String] The wanted image's _id.
+      #
+      # @example Retrieve the image metadata with _id value:
+      #   # wanted image _id
+      #   id = "5e47a41e-7b94-4f65-824e-28f94e15bc6a"
+      #   # ask for that image metadata
+      #   client.head_image(id)
+      #
+      #     # return example:
+      #     {
+      #        :_id          => "2cceffc6-ebc5-4741-9653-745524e7ac30",
+      #        :name         => "Ubuntu 10.10",
+      #        :architecture => "x86_64",
+      #        :access       => "public",
+      #        :uri          => "http://0.0.0.0:4567/images/2cceffc6-ebc5-4741-9653-745524e7ac30",
+      #        :format       => "iso",
+      #        :status       => "available",
+      #        :store        => "file"
+      #     }
+      #
+      # @return [Hash] The requested image metadata.
+      #
+      # @raise [NotFound] If image not found.
+      # @raise [InternalError] On internal server error.
+      #
+      def head_image(id)
+        path = "/images/#{id}"
+        req  = Net::HTTP::Head.new(path)
+        res  = do_request(req, false)
+        pull_meta_from_headers(res)
+      end
+
+      # Retrieves brief metadata of all public images.
+      # Options for filtering the returned results can be passed in.
+      #
+      # @option query [String] :attribute The image attribute value to filter returned results.
+      # @option query [String] :sort ("_id") The image attribute to sort returned results.
+      # @option query [String] :dir ("asc") The direction to sort results ("asc"/"desc").
+      #
+      # @example Retrieve all public images brief metadata:
+      #   client.get_images
+      #
+      #     # returns:
+      #     [<all images brief metadata>]
+      #
+      # @example Retrieve all public 32bit images brief metadata:
+      #   client.get_images(architecture: 'i386')
+      #
+      #     # returns something like:
+      #     [
+      #       {:_id => "28f94e15...", :architecture => "i386", :name => "Fedora 16"},
+      #       {:_id => "8cb55bb6...", :architecture => "i386", :name => "Ubuntu 11.10 Desktop"}
+      #     ]
+      #
+      # @example Retrieve all public 64bit images brief metadata, descending sorted by their name:
+      #   client.get_images(architecture: 'x86_64', sort: 'name', dir: 'desc')
+      #
+      #     # returns something like:
+      #     [
+      #       {:_id => "5e47a41e...", :architecture => "x86_64", :name => "Ubuntu 10.04 Server"},
+      #       {:_id => "069320f0...", :architecture => "x86_64", :name => "CentOS 6"}
+      #     ]
+      #
+      # @return [Array] All public images brief metadata.
+      #   Just {Visor::Meta::Backends::Base::BRIEF BRIEF} fields are returned.
+      #
+      # @raise [NotFound] If there are no public images registered on the server.
+      # @raise [InternalError] On internal server error.
+      #
+      def get_images(query = {})
+        str = build_query(query)
+        req = Net::HTTP::Get.new("/images#{str}")
+        do_request(req)
+      end
+
+      # Retrieves detailed metadata of all public images.
+      #
+      # @note Filtering and querying works the same as with {#get_images}. The only difference is the number
+      # of disclosed attributes.
+      #
+      # @option query [String] :attribute_name The image attribute value to filter returned results.
+      # @option query [String] :sort ("_id") The image attribute to sort returned results.
+      # @option query [String] :dir ("asc") The direction to sort results ("asc"/"desc").
+      #
+      # @example Retrieve all public images detailed metadata:
+      #   # request for it
+      #   client.get_images_detail
+      #   # returns an array of hashes with all public images metadata.
+      #
+      # @return [Array] All public images detailed metadata.
+      #   The {Visor::Meta::Backends::Base::DETAIL_EXC DETAIL_EXC} fields are excluded from results.
+      #
+      # @raise [NotFound] If there are no public images registered on the server.
+      # @raise [InternalError] On internal server error.
+      #
+      def get_images_detail(query = {})
+        str = build_query(query)
+        req = Net::HTTP::Get.new("/images/detail#{str}")
+        do_request(req)
+      end
+
+      # Retrieves the file of the image with the given id.
+      #
+      # The file is yielded in streaming chunks, so its possible to receive a big file
+      # without buffering it all in memory.
+      #
+      # @param id [String] The wanted image's _id.
+      #
+      # @example Retrieve the image file with _id value:
+      #   # wanted image _id
+      #   id = "5e47a41e-7b94-4f65-824e-28f94e15bc6a"
+      #   # ask for that image file
+      #   client.get_image(id) do |chunk|
+      #     # do something with chunks as they arrive here (e.g. write to file, etc)
+      #   end
+      #
+      # @return [Binary] The requested image file binary data.
+      #
+      # @raise [NotFound] If image not found.
+      # @raise [InternalError] On internal server error.
+      #
+      def get_image(id)
+        req = Net::HTTP::Get.new("/images/#{id}")
+        prepare_headers(req)
+
+        Net::HTTP.start(host, port) do |http|
+          http.request(req) do |res|
+            assert_response(res)
+            res.read_body { |chunk| yield chunk }
+          end
+        end
+      end
+
+      # Register a new image on the server with the given metadata and optionally
+      # upload its file, or provide a :location parameter containing the full path to
+      # the already existing image file, stored somewhere.
+      #
+      # The image file is streamed to the server in chunks, which in turn also buffers chunks
+      # as they arrive, avoiding buffering large files in memory in both clients and server.
+      #
+      # @note If the :location parameter is passed, you can not pass an image file
+      #   and the other way around too.
+      #
+      # @param meta [Hash] The image metadata.
+      # @param file [String] The path to the image file.
+      #
+      # @example Insert a sample image metadata:
+      #   # sample image metadata
+      #   meta = {:name => 'example', :architecture => 'i386'}
+      #   # insert the new image metadata
+      #   client.post_image(meta)
+      #
+      #     # returns:
+      #     {
+      #        :_id          => "d8b36b3f-e044-4a57-88fc-27b57338be10",
+      #        :uri          => "http://0.0.0.0:4568/images/d8b36b3f-e044-4a57-88fc-27b57338be10",
+      #        :name         => "Ubuntu 10.04 Server",
+      #        :architecture => "x86_64",
+      #        :access       => "public",
+      #        :status       => "locked",
+      #        :created_at   => "2012-02-04 16:33:27 +0000"
+      #     }
+      #
+      # @example Insert a sample image metadata and provide the location of its file:
+      #   # sample image poiting to the latest release of Ubuntu Server distro
+      #   meta = {:name  => 'Ubuntu Server (Latest)', :architecture => 'x86_64', :format => 'iso',
+      #           :store => 'http', :location => 'http://www.ubuntu.com/start-download?distro=server&bits=64&release=latest'}
+      #   # insert the new image metadata
+      #   client.post_image(meta)
+      #
+      #     # returns:
+      #     {
+      #        :_id          => "0733827b-836d-469e-8860-b900d4dabc46",
+      #        :uri          => "http://0.0.0.0:4568/images/0733827b-836d-469e-8860-b900d4dabc46",
+      #        :name         => "Ubuntu Server (Latest)",
+      #        :architecture => "x86_64",
+      #        :access       => "public",
+      #        :format       => "iso",
+      #        :store        => "http",
+      #        :location     => "http://www.ubuntu.com/start-download?distro=server&bits=64&release=latest",
+      #        :status       => "available",
+      #        :size         => 715436032, # it will fetch the correct remote file size
+      #        :created_at   => "2012-02-04 16:40:04 +0000",
+      #        :updated_at   => "2012-02-04 16:40:04 +0000",
+      #        :checksum     => "76264-2aa4b000-4af0618f1b180" # it will also fetch the remote file checksum or etag
+      #     }
+      #
+      # @example Insert a sample image metadata and upload its file:
+      #   # sample image metadata
+      #   meta = {:name => 'Ubuntu 10.04 Server', :architecture => 'x86_64', :store => 's3', :format => 'iso'}
+      #   # sample image file path
+      #   file = '~/ubuntu-10.04.3-server-amd64.iso'
+      #   # insert the new image metadata and upload file
+      #   client.post_image(meta, file)
+      #
+      #     # returns:
+      #     {
+      #        :_id          => "8074d23e-a9c0-454d-b935-cda5f6eb1bc8",
+      #        :uri          => "http://0.0.0.0:4568/images/8074d23e-a9c0-454d-b935-cda5f6eb1bc8",
+      #        :name         => "Ubuntu 10.04 Server",
+      #        :architecture => "x86_64",
+      #        :access       => "public",
+      #        :format       => "iso",
+      #        :store        => "file",
+      #        :location     => "s3://<access_key>:<secret_key>@s3.amazonaws.com/<bucket>/8074d23e-a9c0-454d-b935-cda5f6eb1bc8.iso",
+      #        :status       => "available",
+      #        :size         => 713529344,
+      #        :created_at   => "2012-02-04 16:29:04 +0000",
+      #        :updated_at   => "2012-02-04 16:29:04 +0000",
+      #        :checksum     => "fbd9044604120a1f6cc708048a21e066"
+      #     }
+      #
+      # @return [Hash] The already inserted image metadata.
+      #
+      # @raise [Invalid] If image metadata validation fails.
+      # @raise [Invalid] If the location header is present no file content can be provided.
+      # @raise [Invalid] If trying to post an image file to a HTTP backend.
+      # @raise [Invalid] If provided store is an unsupported store backend.
+      # @raise [NotFound] If no image data is found at the provided location.
+      # @raise [ConflictError] If the provided image file already exists in the backend store.
+      # @raise [InternalError] On internal server error.
+      #
+      def post_image(meta, file = nil)
+        req = Net::HTTP::Post.new('/images')
+        push_meta_into_headers(meta, req)
+        if file
+          req['Content-Type']      = 'application/octet-stream'
+          req['Transfer-Encoding'] = 'chunked'
+          req.body_stream          = File.open(File.expand_path file)
+        end
+        do_request(req)
+      end
+
+      # Updates an image record with the given metadata and optionally
+      # upload its file, or provide a :location parameter containing the full path to
+      # the already existing image file, stored somewhere.
+      #
+      # The image file is streamed to the server in chunks, which in turn also buffers chunks
+      # as they arrive, avoiding buffering large files in memory in both clients and server.
+      #
+      # @note Only images with status set to 'locked' or 'error' can be updated
+      #   with an image data file.
+      #
+      # @param id [String] The image's _id which will be updated.
+      # @param meta [Hash] The image metadata.
+      # @param file [String] The path to the image file.
+      #
+      # @example Update a sample image metadata:
+      #   # wanted image _id
+      #   id = "2373c3e5-b302-4529-8e23-c4ffc85e7613"
+      #   # metadata to update
+      #   update = {:name => 'Debian 6.0', :architecture => "x86_64"}
+      #   # update the image metadata with some new values
+      #   client.put_image(id, update)
+      #
+      #     # returns:
+      #     {
+      #        :_id          => "2373c3e5-b302-4529-8e23-c4ffc85e7613",
+      #        :uri          => "http://0.0.0.0:4568/images/2373c3e5-b302-4529-8e23-c4ffc85e7613",
+      #        :name         => "Debian 6.0",
+      #        :architecture => "x86_64",
+      #        :access       => "public",
+      #        :status       => "locked",
+      #        :created_at   => "2012-02-03 12:40:30 +0000",
+      #        :updated_at   => "2012-02-04 16:35:10 +0000"
+      #     }
+      #
+      # @example Update a sample image metadata and provide the location of its file:
+      #   # wanted image _id
+      #   id = "2373c3e5-b302-4529-8e23-c4ffc85e7613"
+      #   # metadata update
+      #   update = {:format => 'iso', :store => 'file', :location => 'file:///Users/server/debian-6.0.4-amd64.iso'}
+      #   # update the image metadata with file values
+      #   client.put_image(id, update)
+      #
+      #     # returns:
+      #     {
+      #        :_id          => "2373c3e5-b302-4529-8e23-c4ffc85e7613",
+      #        :uri          => "http://0.0.0.0:4568/images/2373c3e5-b302-4529-8e23-c4ffc85e7613",
+      #        :name         => "Debian 6.0",
+      #        :architecture => "x86_64",
+      #        :access       => "public",
+      #        :status       => "locked",
+      #        :format       => "iso",
+      #        :store        => "file",
+      #        :location     => "file:///Users/server/debian-6.0.4-amd64.iso",
+      #        :status       => "available",
+      #        :size         => 764529654,
+      #        :created_at   => "2012-02-03 12:40:30 +0000",
+      #        :updated_at   => "2012-02-04 16:38:55 +0000"
+      #     }
+      #
+      # @example Update image metadata and upload its file:
+      #   # wanted image _id
+      #   id = "d5bebdc8-66eb-4450-b8d1-d8127f50779d"
+      #   # metadata update
+      #   update = {:format => 'iso', :store => 's3'}
+      #   # sample image file path
+      #   file = '~/CentOS-6.2-x86_64-LiveCD.iso'
+      #   # insert the new image metadata and upload file
+      #   client.put_image(id, meta, file)
+      #
+      #     # returns:
+      #     {
+      #        :_id          => "d5bebdc8-66eb-4450-b8d1-d8127f50779d",
+      #        :uri          => "http://0.0.0.0:4568/images/d5bebdc8-66eb-4450-b8d1-d8127f50779d",
+      #        :name         => "CentOS 6.2",
+      #        :architecture => "x86_64",
+      #        :access       => "public",
+      #        :format       => "iso",
+      #        :store        => "s3",
+      #        :location     => "s3://<access_key>:<secret_key>@s3.amazonaws.com/<bucket>/d5bebdc8-66eb-4450-b8d1-d8127f50779d.iso",
+      #        :status       => "available",
+      #        :size         => 731906048,
+      #        :created_at   => "2012-01-20 16:29:01 +0000",
+      #        :updated_at   => "2012-02-04 16:50:12 +0000",
+      #        :checksum     => "610c0b9684dba804467514847e8a012f"
+      #     }
+      #
+      # @return [Hash] The already inserted image metadata.
+      #
+      # @raise [Invalid] If the image metadata validation fails.
+      # @raise [Invalid] If no headers neither body found for update.
+      # @raise [Invalid] If the location header is present no file content can be provided.
+      # @raise [Invalid] If trying to post an image file to a HTTP backend.
+      # @raise [Invalid] If provided store is an unsupported store backend.
+      # @raise [NotFound] If no image data is found at the provided location.
+      # @raise [ConflictError] If trying to assign image file to a locked or uploading image.
+      # @raise [ConflictError] If the provided image file already exists in the backend store.
+      # @raise [InternalError] On internal server error.
+      #
+      def put_image(id, meta, file = nil)
+        req = Net::HTTP::Put.new("/images/#{id}")
+        push_meta_into_headers(meta, req) if meta
+        if file
+          req['Content-Type']      = 'application/octet-stream'
+          req['Transfer-Encoding'] = 'chunked'
+          req.body_stream          = File.open(File.expand_path file)
+        end
+        do_request(req)
+      end
+
+      # Removes an image record based on its _id and returns its metadata. If the image
+      # have some registered image file, that file is also deleted on its source store.
+      #
+      # @param id [String] The image's _id which will be deleted.
+      #
+      # @example Delete an image metadata:
+      #   # wanted image _id
+      #   id = "66414330-bbb5-42be-8a0e-b336cf6665f4"
+      #   # delete the image metadata and file
+      #   client.delete_image(id)
+      #
+      #     # returns:
+      #     {
+      #        :_id          => "66414330-bbb5-42be-8a0e-b336cf6665f4",
+      #        :uri          => "http://0.0.0.0:4568/images/66414330-bbb5-42be-8a0e-b336cf6665f4",
+      #        :name         => "Ubuntu 11.04 Server",
+      #        :architecture => "x86_64",
+      #        :access       => "public",
+      #        :format       => "iso",
+      #        :store        => "file",
+      #        :location     => "file:///Users/server/VMs/66414330-bbb5-42be-8a0e-b336cf6665f4.iso",
+      #        :status       => "available",
+      #        :size         => 722549344,
+      #        :created_at   => "2012-02-04 15:23:48 +0000",
+      #        :updated_at   => "2012-02-04 15:54:52 +0000",
+      #        :accessed_at  => "2012-02-04 16:02:44 +0000",
+      #        :access_count => 26,
+      #        :checksum     => "fbd9044604120a1f6cc708048a21e066"
+      #     }
+      #
+      # @return [Hash] The already deleted image metadata. Useful for recover on accidental delete.
+      #
+      # @raise [NotFound] If image meta or data not found.
+      # @raise [Forbidden] If user does not have permission to manipulate the image file.
+      # @raise [InternalError] On internal server error.
+      #
+      def delete_image(id)
+        req = Net::HTTP::Delete.new("/images/#{id}")
+        do_request(req)
+      end
+
+      def delete_by_query(query)
+        result = []
+        images = get_images(query)
+        images.each do |image|
+          req = Net::HTTP::Delete.new("/images/#{image[:_id]}")
+          result << do_request(req)
+        end
+        result
+      end
+
+
+      private
+
+      # Prepare headers for request
+      def prepare_headers(req)
+        sign_request(access_key, secret_key, req.method, req.path, req)
+        req['User-Agent'] = 'VISoR Image Server client'
+        req['Accept']     = "application/json"
+      end
+
+      # Parses the response, which is either a JSON string inside body
+      # or a error message passed on headers
+      def parse_response(res)
+        if res.body
+          result = JSON.parse(res.body, symbolize_names: true)
+          result[:image] || result[:images] || result[:message]
+        else
+          res['x-error-message']
+        end
+      end
+
+      # Build query string from hash
+      def build_query(h)
+        (h.nil? or h.empty?) ? '' : '?' + URI.encode_www_form(h)
+      end
+
+      # Assert response code and raise if necessary
+      def assert_response(res)
+        case res
+        when Net::HTTPNotFound then
+          raise NotFound, parse_response(res)
+        when Net::HTTPBadRequest then
+          raise Invalid, parse_response(res)
+        when Net::HTTPConflict then
+          raise ConflictError, parse_response(res)
+        when Net::HTTPForbidden then
+          raise Forbidden, parse_response(res)
+        when Net::HTTPInternalServerError then
+          raise InternalError, parse_response(res)
+        end
+      end
+
+      # Process requests
+      def do_request(req, parse=true)
+        prepare_headers(req)
+        http              = Net::HTTP.new(host, port)
+        http.read_timeout = 600
+        res               = http.request(req)
+        assert_response(res)
+        parse ? parse_response(res) : res
+      end
+    end
+  end
+end