visor-image 0.0.3 → 0.0.4

data/bin/visor

@@ -48,21 +48,20 @@ class VisorCLI
 
       opts.separator ""
       opts.separator "Commands:"
-      opts.separator "     brief          Show brief metadata of all public images"
-      opts.separator "     detail         Show detailed metadata of all public images"
-      opts.separator "     head           Show image detailed metadata"
+      opts.separator "     brief          Show brief metadata of all public and user's private images"
+      opts.separator "     detail         Show detailed metadata of all public and user's private images"
+      opts.separator "     head           Show an image detailed metadata"
       opts.separator "     get            Retrieve an image metadata and file"
       opts.separator "     add            Add a new image metadata and optionally upload its file"
       opts.separator "     update         Update an image metadata and/or upload its file"
       opts.separator "     delete         Delete an image metadata and its file"
-      opts.separator "     clean          Delete all images metadata and files"
       opts.separator "     help <cmd>     Show help message for one of the above commands"
 
 
       opts.separator ""
       opts.separator "Options:"
-      opts.on("-a", "--address HOST", "Address of VISoR Image host (default: #{options[:host]})") { |addr| options[:host] = addr }
-      opts.on("-p", "--port PORT", "Port were VISoR Image host listens (default: #{options[:port]})") { |port| options[:port] = port }
+      opts.on("-a", "--address HOST", "Address of the VISOR Image System server (default: #{options[:host]})") { |addr| options[:host] = addr }
+      opts.on("-p", "--port PORT", "Port where the VISOR Image System server listens (default: #{options[:port]})") { |port| options[:port] = port }
       opts.on("-q", "--query QUERY", "HTTP query like string to filter results") do |query|
         begin
           options[:query] = URI.decode_www_form(query)
@@ -83,10 +82,9 @@ class VisorCLI
 
       opts.separator ""
       opts.separator "Common options:"
-      opts.on_tail("-D", "--dry-run", "Don't persist results, just print what would it do") { options[:dry] = true }
       opts.on_tail('-v', '--verbose', "Enable verbose") { options[:verbose] = true }
       opts.on_tail("-h", "--help", "Show this help message") { puts opts; exit 0 }
-      opts.on_tail('-V', '--version', "Show version") { puts "VISoR Image CLI v#{VERSION}"; exit 0 }
+      opts.on_tail('-V', '--version', "Show version") { puts "visor CLI #{VERSION}"; exit 0 }
     end
   end
 
@@ -100,62 +98,62 @@ class VisorCLI
   def run!
     abort parser.to_s if command.nil?
     start = Time.now
-    case command
-    when 'brief' then
-      brief
-    when 'detail' then
-      detail
-    when 'head' then
-      head
-    when 'get' then
-      get
-    when 'add' then
-      add
-    when 'update' then
-      update
-    when 'delete' then
-      delete
-    when 'help' then
-      help
-    else
-      abort "Unknown command '#{command}'"
+    begin
+      case command
+      when 'brief' then
+        brief
+      when 'detail' then
+        detail
+      when 'head' then
+        head
+      when 'get' then
+        get
+      when 'add' then
+        add
+      when 'update' then
+        update
+      when 'delete' then
+        delete
+      when 'help' then
+        help
+      else
+        abort "Unknown command '#{command}'"
+      end
+    rescue NotFound => e
+      puts e.message
+    rescue Errno::ECONNREFUSED
+      abort "Failure while executing '#{command}': VISOR Image System server not found. Is it running?"
+    #rescue => e
+    #  abort "Failure while executing '#{command}': #{e.message}"
     end
     finish = Time.now
-    printf("Done in %-0.4f seconds", finish - start) if verbose?
+    printf("Done in %-0.4f seconds\n", finish - start) if verbose?
     exit 0
   end
 
   # Show brief metadata of all public images
   def brief
-    str    = "%-37s %-21s %-13s %-12s %-8s %-10s %-10s\n"
+    str    = "%-37s %-22s %-13s %-10s %-8s %-10s %-10s\n"
     images = client.get_images(options[:query])
 
-    puts "Found #{images.size} public images records..."
+    puts "Found #{images.size} images records..."
     printf(str, 'ID', 'NAME', 'ARCHITECTURE', 'TYPE', 'FORMAT', 'STORE', 'SIZE')
-    puts "#{'-'*36+"  "+'-'*20+"  "+'-'*12+"  "+'-'*11+"  "+'-'*6+"  "+'-'*10+"  "+'-'*10}"
+    puts "#{'-'*36+"  "+'-'*21+"  "+'-'*12+"  "+'-'*9+"  "+'-'*6+"  "+'-'*10+"  "+'-'*10}"
 
     images.each do |image|
       printf(str, image[:_id], image[:name], image[:architecture], image[:type] || '-', image[:format] || '-', image[:store] || '-', image[:size] || '-')
     end
-  rescue NotFound => e
-    puts e.message
-  rescue => e
-    abort "Failure while executing 'brief':\n#{e.message}"
   end
 
   # Show detailed metadata of all public images
   def detail
     images = client.get_images_detail(options[:query])
-    puts "Found #{images.size} public images records..."
+    puts "Found #{images.size} images records..."
 
     images.each do |image|
       puts('-'*80)
       print_meta(image, false)
     end
-  rescue NotFound => e
-    puts e.message
-  rescue => e
-    abort "Failure while executing 'detail':\n#{e.message}"
   end
 
   # Show image detailed metadata
@@ -164,10 +162,6 @@ class VisorCLI
     abort "No image ID provided as first argument, please provide it." unless id
     image = client.head_image(id)
     print_meta(image)
-  rescue NotFound => e
-    puts e.message
-  rescue => e
-    abort "Failure while executing 'head':\n#{e.message}"
   end
 
   # Retrieve an image metadata and file
@@ -181,7 +175,7 @@ class VisorCLI
     fp   = File.expand_path(File.join(path, "#{id}.#{image[:format] || 'none'}"))
 
     raise "Cannot locate directory '#{path}'." unless Dir.exists? path
-    #raise "File #{fp} already exists." if File.exists? fp  #TODO: restore this
+    raise "File #{fp} already exists." if File.exists? fp
 
     if File.exists? fp
       require "securerandom"
@@ -199,10 +193,6 @@ class VisorCLI
     end
     pbar.finish
     file.close
-  rescue NotFound => e
-    puts e.message
-  rescue => e
-    abort "Failure while executing 'get':\n#{e.message}"
   end
 
 # Add a new image metadata and optionally upload its file
@@ -214,17 +204,11 @@ class VisorCLI
       puts "Adding new metadata and uploading file..."
     end
 
-    begin
-      meta  = parse_meta_from_args
-      image = client.post_image(meta, file)
-      puts "Successfully added new metadata and image with ID #{image[:_id]}." if file
-      puts "Successfully added new metadata with ID #{image[:_id]}." unless file
-      print_meta(image)
-    rescue NotFound => e
-      puts e.message
-    rescue => e
-      abort "Failure while executing 'add':\n#{e.message}"
-    end
+    meta  = parse_meta_from_args
+    image = client.post_image(meta, file)
+    puts "Successfully added new metadata and image with ID #{image[:_id]}." if file
+    puts "Successfully added new metadata with ID #{image[:_id]}." unless file
+    print_meta(image)
   end
 
 # Update an image metadata and/or upload its file
@@ -238,37 +222,25 @@ class VisorCLI
       puts "Updating metadata and uploading file..."
     end
 
-    begin
-      meta  = parse_meta_from_args
-      image = client.put_image(id, meta, file)
-      puts "Successfully updated and uploaded image #{id}." if file
-      puts "Successfully updated image #{id}." unless file
-      print_meta(image) if verbose?
-    rescue NotFound => e
-      puts e.message
-    rescue => e
-      abort "Failure while executing 'update':\n#{e.message}"
-    end
+    meta  = parse_meta_from_args
+    image = client.put_image(id, meta, file)
+    puts "Successfully updated and uploaded image #{id}." if file
+    puts "Successfully updated image #{id}." unless file
+    print_meta(image) if verbose?
   end
 
 # Delete an image metadata and its file
   def delete
-    begin
-      if query = options[:query]
-        result = client.delete_by_query(query)
-        result.each { |image| puts "Successfully deleted image #{image[:_id]}." }
-      else
-        argv.each do |id|
-          abort "No image ID provided as first argument, please provide it." unless id
-          image = client.delete_image(id)
-          puts "Successfully deleted image #{id}."
-          print_meta(image) if verbose?
-        end
+    if query = options[:query]
+      result = client.delete_by_query(query)
+      result.each { |image| puts "Successfully deleted image #{image[:_id]}." }
+    else
+      argv.each do |id|
+        abort "No image ID provided as first argument, please provide it." unless id
+        image = client.delete_image(id)
+        puts "Successfully deleted image #{id}."
+        print_meta(image) if verbose?
       end
-    rescue NotFound => e
-      puts e.message
-    rescue => e
-      abort "Failure while executing 'delete':\n#{e.message}"
     end
   end
 
@@ -289,7 +261,7 @@ It's possible to sort and order results with the --sort (-s) and --dir (-d) opti
 Examples:
   $ visor brief --query 'architecture=i386'
   $ visor brief --query 'architecture=i386&format=iso'
-  $ visor detail --sort name --dir desc]
+  $ visor brief --sort name --dir desc]
     when :detail
       %q[Usage: visor detail [options]
 

data/config/server.rb

@@ -12,3 +12,4 @@ logger.level      = (log_level == 'INFO' ? 1 : 0)
 config['vms']     = Visor::Image::Meta.new(host: meta_host, port: meta_port)
 config['vas']     = Visor::Image::Auth.new(host: auth_host, port: auth_port)
 config['configs'] = conf[:visor_store]
+config['address'] = "#{conf[:visor_image][:bind_host]}:#{conf[:visor_image][:bind_port]}"

data/lib/image/auth.rb

@@ -1,99 +1,103 @@
-require 'net/http'
-require 'net/https'
+require 'em-synchrony'
+require 'em-synchrony/em-http'
 require 'uri'
 require 'json'
 
 module Visor
   module Image
 
-    # The Client API for the VISoR Auth.
+    # The API for the VISOR Auth System (VAS) server. This class supports all user's manipulation operations.
     #
-    # After Instantiate a Client object its possible to directly interact with the auth server and its
+    # After Instantiate a VAS API client object its possible to directly interact with the VAS server and its
     # database backend.
     #
     class Auth
-
       include Visor::Common::Exception
 
-      configs = Common::Config.load_config :visor_auth
-
-      DEFAULT_HOST = configs[:bind_host] || '0.0.0.0'
-      DEFAULT_PORT = configs[:bind_port] || 4567
-
-      attr_reader :host, :port, :ssl
+      attr_reader :host, :port
 
       def initialize(opts = {})
-        @host       = opts[:host] || DEFAULT_HOST
-        @port       = opts[:port] || DEFAULT_PORT
-        @ssl        = opts[:ssl] || false
+        @host = opts[:host]
+        @port = opts[:port]
       end
 
+      # Get information about all registered users.
+      #
+      # Options for filtering the returned results can be passed in.
+      #
+      # @option query [String] :<attribute_name> The user 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").
+      #
+      # @return [Array] All user's accounts.
+      #
+      # @raise [NotFound] If there are no users registered on VAS.
+      #
       def get_users(query = {})
-        str     = build_query(query)
-        request = Net::HTTP::Get.new("/users#{str}")
-        do_request(request)
+        http = request.get path: '/users', query: query, head: get_headers
+        return_response(http)
       end
 
+      # Get information about a specific user.
+      #
+      # @param access_key [String] The user access key (username).
+      #
+      # @return [Hash] The requested user account information.
+      #
+      # @raise [NotFound] If user was not found.
+      #
       def get_user(access_key)
-        request = Net::HTTP::Get.new("/users/#{access_key}")
-        do_request(request)
+        http = request.get path: "/users/#{access_key}", head: get_headers
+        return_response(http)
       end
 
-      def post_user(info)
-        request      = Net::HTTP::Post.new('/users')
-        request.body = prepare_body(info)
-        do_request(request)
-      end
-
-      def put_user(access_key, info)
-        request      = Net::HTTP::Put.new("/users/#{access_key}")
-        request.body = prepare_body(info)
-        do_request(request)
-      end
-
-      def delete_user(access_key)
-        request = Net::HTTP::Delete.new("/users/#{access_key}")
-        do_request(request)
-      end
-
-      private
-
-      # Parses a response body with the JSON parser and extracts and returns a single
-      # key value from it if defined, otherwise returns all the body.
+      # Register a new user account on VAS and return its data.
+      #
+      # @param info [Hash] The user information.
       #
-      # @param key (nil) [Symbol] The hash key to extract the wanted value.
-      # @param response [Net::HTTPResponse] The response which contains the body to parse.
+      # @return [Hash] The already created user detailed information.
       #
-      # @return [String, Hash] If key is provided and exists on the response body, them return
-      #   its value, otherwise return all the body hash.
+      # @raise [Invalid] If user data validation fails.
+      # @raise [NotFound] If user was not found after registered.
+      # @raise [ConflictError] access_key was already taken.
       #
-      def parse(key=nil, response)
-        parsed = JSON.parse(response.body, symbolize_names: true)
-        key ? parsed[key] : parsed
+      def post_user(info)
+        body = prepare_body(info)
+        http = request.post path: '/users', body: body, head: post_headers
+        return_response(http)
       end
 
-      # Generate a valid URI query string from key/value pairs of the given hash.
+      # Update an existing user information and return it.
+      #
+      # @param access_key [String] The wanted user access_key.
+      # @param info [Hash] The user information.
       #
-      # @param opts [Hash] The hash with the key/value pairs to generate query from.
+      # @return [Hash] The already updated user detailed information.
       #
-      # @return [String] The generated query in the form of "?k=v&k1=v1".
+      # @raise [Invalid] If user data validation fails.
+      # @raise [NotFound] If user was not found.
       #
-      def build_query(opts)
-        opts.empty? ? '' : '?' + URI.encode_www_form(opts)
+      def put_user(access_key, info)
+        body = prepare_body(info)
+        http = request.put path: "/users/#{access_key}", body: body, head: put_headers
+        return_response(http)
       end
 
-      # Fill common header keys before each request. This sets the 'User-Agent' and 'Accept'
-      # headers for every request and additionally sets the 'content-type' header
-      # for POST and PUT requests.
+      # Delete an user and returns its information.
       #
-      # @param request [Net::HTTPResponse] The request which will be modified in its headers.
+      # @param access_key [String] The wanted user access_key.
       #
-      def prepare_headers(request)
-        request['User-Agent'] = 'VISoR image server'
-        request['Accept']     = 'application/json'
-        request['content-type'] = 'application/json' if ['POST', 'PUT'].include?(request.method)
+      # @return [Hash] The already deleted user detailed information.
+      #
+      # @raise [NotFound] If user was not found.
+      #
+      def delete_user(access_key)
+        http = request.delete path: "/users/#{access_key}", access_key: delete_headers
+        return_response(http)
       end
 
+      private
+
       # Generate a valid JSON request body for POST and PUT requests.
       # It generates a JSON object encapsulated inside a :image key and then returns it.
       #
@@ -108,7 +112,7 @@ module Visor
 
       # Process requests by preparing its headers, launch them and assert or raise their response.
       #
-      # @param request [Net::HTTPResponse] The request which will be launched.
+      # @param http [EventMachine::HttpRequest] The request which will be launched.
       #
       # @return [String, Hash] If an error is raised, then it parses and returns its message,
       #   otherwise it properly parse and return the response body.
@@ -116,32 +120,59 @@ module Visor
       # @raise [NotFound] If required image was not found (on a GET, PUT or DELETE request).
       # @raise [Invalid] If image meta validation fails (on a POST or PUT request).
       #
-      def do_request(request)
-        prepare_headers(request)
-        response = http_or_https.request(request)
-        case response
-        when Net::HTTPNotFound then
-          raise NotFound, parse(:message, response)
-        when Net::HTTPBadRequest then
-          raise Invalid, parse(:message, response)
+      def return_response(http)
+        body   = http.response
+        status = http.response_header.status.to_i
+
+        case status
+        when 0 then
+          raise InternalError, "VISOR Auth System server not found. Is it running?"
+        when 404 then
+          raise NotFound, parse(body)
+        when 400 then
+          raise Invalid, parse(body)
+        when 500 then
+          raise InternalError, parse(body)
         else
-          parse(:user, response) or parse(:users, response)
+          parse(body)
         end
       end
 
+      def parse(body)
+        parsed = JSON.parse(body, symbolize_names: true)
+        parsed[:user] || parsed[:users] || parsed[:message]
+      end
+
       # Generate a new HTTP or HTTPS connection based on initialization parameters.
       #
-      # @return [Net::HTTP] A HTTP or HTTPS (not done yet) connection ready to use.
+      # @return [EventMachine::HttpRequest] A HTTP or HTTPS (not done yet) connection ready to use.
       #
-      def http_or_https
-        if @ssl
+      def request
+        #if @ssl
           #TODO: ssl connection
-          #https://github.com/augustl/net-http-cheat-sheet/blob/master/ssl_and_https.rb
-        else
-          Net::HTTP.new(@host, @port)
-        end
+        #else
+          EventMachine::HttpRequest.new("http://#{@host}:#{@port}")
+        #end
+      end
+
+      # Fill common header keys before each request. This sets the 'User-Agent' and 'Accept'
+      # headers for every request and additionally sets the 'content-type' header
+      # for POST and PUT requests.
+      #
+      def get_headers
+        {'User-Agent' => 'VISOR Image System',
+         'Accept'     => 'application/json'}
       end
 
+      def post_headers
+        {'User-Agent'   => 'VISOR Image System',
+         'Accept'       => 'application/json',
+         'content-type' => 'application/json'}
+      end
+
+      alias :delete_headers :get_headers
+      alias :put_headers :post_headers
     end
   end
 end
+