visor-common 0.0.1 → 0.0.2

data/bin/visor-config

@@ -33,10 +33,10 @@ end
 puts "\nGenerating VISOR configuration directories and files:\n\n"
 sleep (0.5)
 print "creating #{dir}..."
-system "mkdir #{dir}"
+system "mkdir -p #{dir}"
 puts " [DONE]"
 print "creating #{dir}/logs..."
-system "mkdir #{dir}/logs"
+system "mkdir -p #{dir}/logs"
 puts " [DONE]"
 print "creating #{dir}/visor-config.yml..."
 system "echo '#{Visor::Common::Config::CONFIG_TEMPLATE}' > #{dir}/visor-config.yml"

data/lib/common/config.rb

@@ -23,140 +23,124 @@ module Visor
       DEFAULT_LOG_LEVEL = Logger::INFO
       # Configuration file template
       CONFIG_TEMPLATE = %q[
-# ========== Default always loaded configuration throughout VISOR sub-systems =====
-#
+# ===== Default always loaded configuration throughout VISOR sub-systems ======
 default: &default
     # Set the default log date time format
     log_datetime_format: "%Y-%m-%d %H:%M:%S"
-    # Set the default log path
+    # Set the default log files directory path
     log_path: ~/.visor/logs
-    # VISoR access and secret key credentials, grab yours from $ visor-admin
-    access_key: XXXXXX
-    secret_key: XXXXXX
+    # VISOR access and secret key credentials (from visor-admin command)
+    access_key:
+    secret_key:
 
-# ================================ VISoR Auth ==================================
-#
+# ================================ VISOR Auth =================================
 visor_auth:
-    # Merge default configuration
+    # Merge default configurations
     <<: *default
-    # Address to bind the meta server
+    # Address and port to bind the server
     bind_host: 0.0.0.0
-    # Port to bind the meta server
     bind_port: 4566
-    # Backend connection string (syntax: name://user:pass@host:port/database)
-    backend: mongodb://:@127.0.0.1:27017/visor
-    # backend: mysql://visor:passwd@127.0.0.1:3306/visor
-    # Log file name (available: filename or empty for STDOUT)
+    # Backend connection string (backend://user:pass@host:port/database)
+    #backend: mongodb://<user>:<password>@<host>:27017/visor
+    #backend: mysql://<user>:<password>@<host>:3306/visor
+    # Log file name (empty for STDOUT)
     log_file: visor-auth-server.log
-    # Log level to start logging above events (available: DEBUG, INFO)
+    # Log level to start logging events (available: DEBUG, INFO)
     log_level: INFO
 
-# ================================ VISoR Meta =====================================
-#
+# ================================ VISOR Meta =================================
 visor_meta:
-    # Merge default configuration
+    # Merge default configurations
     <<: *default
-    # Address to bind the meta server
+    # Address and port to bind the server
     bind_host: 0.0.0.0
-    # Port to bind the meta server
     bind_port: 4567
-    # Backend connection string (syntax: name://user:pass@host:port/database)
-    backend: mongodb://:@127.0.0.1:27017/visor
-    # backend: mysql://visor:passwd@127.0.0.1:3306/visor
-    # Log file name (available: filename or empty for STDOUT)
+    # Backend connection string (backend://user:pass@host:port/database)
+    #backend: mongodb://<user>:<password>@<host>:27017/visor
+    #backend: mysql://<user>:<password>@<host>:3306/visor
+    # Log file name (empty for STDOUT)
     log_file: visor-meta-server.log
-    # Log level to start logging above events (available: DEBUG, INFO)
+    # Log level to start logging events (available: DEBUG, INFO)
     log_level: INFO
 
-# ================================ VISoR Image ====================================
-#
+# ================================ VISOR Image ================================
 visor_image:
-    # Merge default configuration
+    # Merge default configurations
     <<: *default
-    # Address to bind the meta server
+    # Address and port to bind the server
     bind_host: 0.0.0.0
-    # Port to bind the meta server
     bind_port: 4568
-    # Log file name (available: filename or empty for STDOUT)
+    # Log file name (empty for STDOUT)
     log_file: visor-api-server.log
-    # Log level to start logging equal and above events (available: DEBUG, INFO)
+    # Log level to start logging events (available: DEBUG, INFO)
     log_level: INFO
 
-# ============================== VISoR Image Backends =============================
-#
+# =========================== VISOR Image Backends ============================
 visor_store:
-    # Default store backend (available: s3, cumulus, walrus, lunacloud, hdfs, file)
+    # Default store (available: s3, lcs, cumulus, walrus, hdfs, file)
     default: file
     #
-    # FileSystem store backend settings
+    # FileSystem store backend (file) settings
     #
     file:
         # Default directory to store image files in
         directory: ~/VMs/
     #
-    # Amazon Simple Storage (S3) store backend settings
+    # Amazon S3 store backend (s3) settings
     #
     s3:
-        # The bucket to store images in, make sure you provide an already existing bucket
-        bucket: XXXXXX
-        # Access and secret key credentials, grab yours on your AWS account settings page
-        access_key: XXXXXX
-        secret_key: XXXXXX
+        # The bucket to store images in, make sure it exists on S3
+        bucket:
+        # Access and secret key credentials, grab yours on your AWS account
+        access_key:
+        secret_key:
     #
-    # Nimbus Cumulus (Cumulus) store backend settings
+    # Lunacloud LCS store backend (lcs) settings
     #
-    cumulus:
-        # The Cumulus host address
-        host: XXXXXX
-        # The Cumulus port number
-        port: XXXXXX
-        # The bucket to store images in, make sure you provide an already existing bucket
-        bucket: XXXXXX
-        # Access and secret key credentials, grab yours with Nimbus cloud
-        access_key: XXXXXX
-        secret_key: XXXXXX
+    lcs:
+        # The bucket to store images in, make sure it exists on LCS
+        bucket:
+        # Access and secret key credentials, grab yours within Lunacloud
+        access_key:
+        secret_key:
     #
-    # Eucalyptus Walrus (Walrus) store backend settings
+    # Nimbus Cumulus store backend (cumulus) settings
     #
-    walrus:
-        # The Walrus host address
-        host: XXXXXX
-        # The Walrus port number
-        port: XXXXXX
-        # A
-        # The bucket to store images in, make sure you provide an already existing bucket
-        bucket: XXXXXX
-        # Access and secret key credentials, grab yours with Eucalyptus cloud
-        access_key: XXXXXX
-        secret_key: XXXXXX
+    cumulus:
+        # The Cumulus host address and port number
+        host:
+        port:
+        # The bucket to store images in, make sure it exists on Cumulus
+        bucket:
+        # Access and secret key credentials, grab yours within Nimbus
+        access_key:
+        secret_key:
     #
-    # Lunacloud (Lunacloud) store backend settings
+    # Eucalyptus Walrus store backend (walrus) settings
     #
-    lunacloud:
-        # The Lunacloud host address
-        host: betalcs.lunacloud.com
-        # The Lunacloud port number
-        port: 80
-        # The bucket to store images in, make sure you provide an already existing bucket
-        bucket: XXXXXX
-        # Access and secret key credentials, grab yours with Lunacloud cloud
-        access_key: XXXXXX
-        secret_key: XXXXXX
+    walrus:
+        # The Walrus host address and port number
+        host:
+        port:
+        # The bucket to store images in, make sure it exists on Walrus
+        bucket:
+        # Access and secret key credentials, grab yours within Eucalyptus
+        access_key:
+        secret_key:
     #
-    # Apache Hadoop HDFS (HDFS) store backend settings
+    # Apache Hadoop HDFS store backend (hdfs) settings
     #
     hdfs:
-        # The HDFS host address
-        host: XXXXXX
-        # The HDFS port number
-        port: XXXXXX
+        # The HDFS host address and port number
+        host:
+        port:
         # The bucket to store images in
-        bucket: XXXXXX
-        # Access credentials
-        username: XXXXXX
+        bucket:
+        # Access credentials, grab yours within Hadoop
+        username:
 ]
 
-      # Ordered search for a VISoR configuration file on default locations and return the first matched.
+      # Ordered search for a VISOR configuration file on default locations and return the first matched.
       #
       # @param other_file [String] Other file to use instead of default config files.
       #
@@ -175,17 +159,16 @@ visor_store:
         end
       end
 
-      # Looks for a VISoR configuration file througth {#self.find_config_file} and returns a hash with
-      # all configuration settings or just a sub-system scoped settings.
+      # Looks for a VISOR configuration file through {#self.find_config_file} and returns a hash with
+      # all configuration settings or just a subsystem scoped settings.
       #
-      # @param scope [String] Used to return just the settings about a specific sub-system.
+      # @param scope [String] Used to return just the settings about a specific subsystem.
       # @param other_file [String] Other file to use instead of default config files.
       #
       # @return [Hash] Global or scoped settings.
       #
       # @raise [RuntimeError] If there is no configuration files or if errors occur during parsing.
       #
-      #TODO: YAML.load_openstruct(File.read(file))
       def self.load_config(scope = nil, other_file = nil)
         file = find_config_file(other_file)
         raise ConfigError, "Could not found any configuration file." unless file
@@ -198,10 +181,10 @@ visor_store:
         config.merge(file: file)
       end
 
-      # Build and return a Logger instance for a given VISoR sub-system, based on configuration
-      # file options, which are validated througth {#self.validate_logger}.
+      # Build and return a Logger instance for a given VISOR subsystem, based on configuration
+      # file options, which are validated through {#self.validate_logger}.
       #
-      # @param app_name [Symbol] The VISoR sub-system app name to build a log for.
+      # @param app_name [Symbol] The VISOR subsystem app name to build a log for.
       # @option configs [Hash] Optional configuration options to override config file ones.
       #
       # @return [Logger] A logger instance already properly configured.

data/lib/common/exception.rb

@@ -2,7 +2,7 @@ module Visor
   module Common
 
     # The Exceptions module introduces a set of custom exceptions used along
-    # all VISoR sub-systems.
+    # all VISOR subsystems.
     #
     module Exception
 

data/lib/common/extensions/array.rb

@@ -2,7 +2,7 @@ module Visor
   module Common
 
     # The Module Extensions provides a set of functions to extend the Standard Core Libraries
-    # with custom usefull methods used allong all VISoR sub-systems.
+    # with custom useful methods used along all VISOR subsystems.
     #
     module Extensions
       #

data/lib/common/extensions/hash.rb

@@ -4,7 +4,7 @@ module Visor
   module Common
 
     # The Module Extensions provides a set of functions to extend the Standard Core Libraries
-    # with custom usefull methods used allong all VISoR sub-systems.
+    # with custom useful methods used along all VISOR subsystems.
     #
     module Extensions
       #

data/lib/common/extensions/object.rb

@@ -2,7 +2,7 @@ module Visor
   module Common
 
     # The Module Extensions provides a set of functions to extend the Standard Core Libraries
-    # with custom usefull methods used allong all VISoR sub-systems.
+    # with custom useful methods used along all VISOR subsystems.
     #
     module Extensions
       #

data/lib/common/extensions/yaml.rb

@@ -2,7 +2,7 @@ module Visor
   module Common
 
     # The Module Extensions provides a set of functions to extend the Standard Core Libraries
-    # with custom usefull methods used allong all VISoR sub-systems.
+    # with custom useful methods used along all VISOR subsystems.
     #
     module Extensions
       #

data/lib/common/util.rb

@@ -5,7 +5,7 @@ require 'base64'
 module Visor
   module Common
 
-    # The Util module provides a set of utility functions used along all VISoR sub-systems.
+    # The Util module provides a set of utility functions used along all VISOR subsystems.
     #
     module Util
       extend self
@@ -14,7 +14,7 @@ module Visor
       # Each key value pair is pushed as a string of the form 'x-image-meta-<key>'.
       #
       # @param meta [Hash] The image metadata
-      # @param header [Hash] (nil) The HTTP headers hash
+      # @param headers [Hash] (nil) The HTTP headers hash
       #
       # @return [Hash] The header containing the metadata headers
       #
@@ -23,6 +23,12 @@ module Visor
         headers
       end
 
+      # Pull image metadata from HTTP headers to a hash.
+      #
+      # @param headers [Hash] (nil) The HTTP headers hash
+      #
+      # @return [Hash] The header containing the metadata
+      #
       def pull_meta_from_headers(headers)
         meta = {}
         headers.each do |k, v|
@@ -34,6 +40,13 @@ module Visor
         meta
       end
 
+      # Find if a string value is an integer, a float or a date. If it matches a type,
+      # then it is converted to that type and returned.
+      #
+      # @param string [String] The string to be parsed.
+      #
+      # @return [Object] The already converted string value.
+      #
       def parse_value(string)
         if is_integer?(string) then
           Integer(string)
@@ -46,19 +59,45 @@ module Visor
         end
       end
 
+      # Find if a an object can be converted to an integer.
+      #
+      # @param object [Object] The object to be converted to integer.
+      #
+      # @return [Integer,NilClass] The converted integer, or nil if it can not be converted to integer.
+      #
       def is_integer?(object)
         true if Integer(object) rescue false
       end
 
+      # Find if a an object can be converted to a float.
+      #
+      # @param object [Object] The object to be converted to a float.
+      #
+      # @return [Float,NilClass] The converted float, or nil if it can not be converted to a float.
+      #
       def is_float?(object)
         true if Float(object) rescue false
       end
 
+      # Find if a an object can be converted to a date.
+      #
+      # @param object [Object] The object to be converted to a date.
+      #
+      # @return [Date,NilClass] The converted float, or nil if it can not be converted to a date.
+      #
       def is_date?(object)
         regexp = /\d{4}[-\/]\d{1,2}[-\/]\d{1,2}\s\d{2}:\d{2}:\d{2}\s\W\d{4}/
         object.match(regexp) ? true : false
       end
 
+      # Sign a request by generating an authorization string and embedding it in the request headers.
+      #
+      # @param access_key [String] The requester user access key.
+      # @param secret_key [String] The requester user secret key.
+      # @param method [String] The request method.
+      # @param path [String] The request path.
+      # @param headers [Hash] The request headers.
+      #
       def sign_request(access_key, secret_key, method, path, headers={})
         headers['Date'] ||= Time.now.utc.httpdate
         desc            = canonical_description(method, path, headers)
@@ -67,6 +106,14 @@ module Visor
         headers['Authorization'] = "VISOR #{access_key}:#{signature}"
       end
 
+      # Generate a request canonical description, which will be used by {#sign_request}.
+      #
+      # @param method [String] The request method.
+      # @param path [String] The request path.
+      # @param headers [Hash] The request headers.
+      #
+      # @return [String] The request canonical description string.
+      #
       def canonical_description(method, path, headers={})
         attributes = {}
         headers.each do |key, value|
@@ -84,12 +131,31 @@ module Visor
         desc << path.gsub(/\?.*$/, '')
       end
 
+      # Authenticate an user request by analysing the request authorization string.
+      #
+      # @param env [Hash] The request attributes.
+      # @param vas [Visor::Image::Auth] A VAS interface object, used to query for user credentials.
+      #
+      # @return [String] The authenticated user access key.
+      #
+      # @raise [Forbidden] If authorization header was not provided along the request.
+      # @raise [Forbidden] If no access key found in the authorization header string.
+      # @raise [Forbidden] If no user found with the given access key.
+      # @raise [Forbidden] If signatures do not match.
+      # @raise [InternalError] If VAS server was not found.
+      #
       def authorize(env, vas)
         auth = env['headers']['Authorization']
         raise Visor::Common::Exception::Forbidden, "Authorization not provided." unless auth
         access_key = auth.scan(/\ (\w+):/).flatten.first
         raise Visor::Common::Exception::Forbidden, "No access key found in Authorization." unless access_key
-        user = vas.get_user(access_key) rescue nil
+        begin
+          user = vas.get_user(access_key)
+        rescue Visor::Common::Exception::InternalError => e
+          raise Visor::Common::Exception::InternalError, e.message
+        rescue => e
+          nil
+        end
         raise Visor::Common::Exception::Forbidden, "No user found with access key '#{access_key}'." unless user
         sign = sign_request(user[:access_key], user[:secret_key], env['REQUEST_METHOD'], env['REQUEST_PATH'], env['headers'])
         raise Visor::Common::Exception::Forbidden, "Invalid authorization, signatures do not match." unless auth == sign
@@ -99,5 +165,3 @@ module Visor
     end
   end
 end
-
-#sign_request('key', 'secret', 'GET', '/users/joaodrp', {'x-image-meta-name' => 'hi'})

data/lib/common/version.rb

@@ -1,5 +1,5 @@
 module Visor
   module Common
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/lib/config_spec.rb

@@ -68,7 +68,7 @@ module Visor::Common
 
       it "should return scoped configuration" do
         conf = Config.load_config :default
-        conf.keys.should == sample_conf[:default].keys << :file
+        conf.keys.should == sample_conf[:default].keys << :access_key << :secret_key << :file
       end
 
       it "should raise an exception if an error occurs during parsing" do
@@ -88,7 +88,7 @@ module Visor::Common
       
       it "should set the log level if provided" do
         log = Config.build_logger :visor_meta, sample_conf
-        log.level.should == Logger::DEBUG
+        log.level.should_not == Logger::DEBUG
       end
 
       it "should set the log level to the default if not provided" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: visor-common
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-10 00:00:00.000000000 Z
+date: 2012-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec