deepsecurity 0.0.19 → 0.0.20

data/lib/dsc/host_detail_command.rb

@@ -1,12 +1,20 @@
+# @author Udo Schneider <Udo.Schneider@homeaddress.de>
+
 module Dsc
 
+   # This class defines the arguments, options and implementation for the `host_detail` command/subcommand.
   class HostDetailCommand < Command
 
-
+    # DeepSecurity object covered by this class.
+    # @return [DeepSecurity::HostDetail]
     def self.transport_class
       DeepSecurity::HostDetail
     end
 
+    # @!group Fields flag
+
+    # Default fields if no argument is given
+    # @return [Array<String>] Default fields if no argument is given
     def self.default_fields
       [
           # DNS name of system
@@ -36,13 +44,53 @@ module Dsc
       ]
     end
 
-    def list(options, args)
+    # @!endgroup
+
+    # @!group Command definitions
+
+    # Define all commands for this available for this (sub) command_context
+    # @param command_context [CLI::App] The current context of the command.
+    # @return [void]
+    def self.define_commands(command_context)
+      command_context.desc "Access #{transport_class_string()}s"
+      command_context.command command_symbol do |host_detail_command|
+        define_list_command(host_detail_command)
+        define_schema_command(host_detail_command)
+      end
+    end
+
+    # Define `list` command_context
+    # @param command_context [CLI::App] The current context of the command.
+    # @yieldparam list_command [GLI::Command] The just defined list command_context
+    # @yield [list_command] Gives the list command_context to the block
+    # @return [void]
+    def self.define_list_command(command_context)
+      super(command_context) do |list_command|
+        define_detail_level_flag(list_command)
+        define_time_format_flag(list_command)
+      end
+    end
+
+    # @!endgroup
+
+    # @!group Command Implementations
+
+    # `list` Implementation.
+    # List all entries of the `transport_class` type according to given filter parameters.
+    # @param options [Hash<Symbol => Object>] Merged global/local options from GLI
+    # @option options [String] :fields The fields to display.
+    # @option options [String] :detail_level Query Level to request.
+    # @param args [Array<String>] Arguments from GLI
+    # @return [void]
+    def list_command(options, args)
       fields = parse_fields(options[:fields])
+      detail_level = parse_detail_level(options[:detail_level])
+      parse_time_format(options[:time_format])
       output do |output|
-        authenticate do |dsm|
+        authenticate do |manager|
           hostFilter = DeepSecurity::HostFilter.all_hosts
           progressBar = ProgressBar.new("host_status", 100) if @show_progress_bar
-          hostDetails = DeepSecurity::HostDetail.find_all(hostFilter, :low)
+          hostDetails = manager.host_details(hostFilter, detail_level)
           progressBar.set(25) if @show_progress_bar
           csv = CSV.new(output)
           csv << fields
@@ -50,9 +98,9 @@ module Dsc
             progressBar.inc(75/hostDetails.size) if @show_progress_bar
             csv << fields.map do |attribute|
               begin
-                hostDetail.instance_eval(attribute)
+                to_display_string(hostDetail.instance_eval(attribute))
               rescue => e
-                "ERROR (#{e.message}"
+                 "ERROR (#{e.message})"
               end
             end
           end
@@ -60,6 +108,8 @@ module Dsc
         end
       end
     end
+
+    # @!endgroup
   end
 
 end

data/lib/savon_helper.rb

@@ -1,7 +1,36 @@
 # @author Udo Schneider <Udo.Schneider@homeaddress.de>
 
+require "logger"
+require "savon"
+
 require "savon_helper/missing_type_mapping_exception"
 # require "savon_helper/soap_exception"
 require "savon_helper/type_mappings"
+require "savon_helper/dsl"
 require "savon_helper/mapping_object"
-require "savon_helper/caching_object"
+require "savon_helper/caching_object"
+require "savon_helper/soap_interface"
+
+unless String.respond_to? :blank
+
+  class String
+    def blank?
+      empty?()
+    end
+  end
+
+  class NilClass
+    def blank?
+      true
+    end
+  end
+
+end
+
+class Object
+
+  def self.name_without_namespace
+    name.split('::').last || ''
+  end
+
+end

data/lib/savon_helper/caching_object.rb

@@ -1,30 +1,30 @@
 # @author Udo Schneider <Udo.Schneider@homeaddress.de>
 
+require "cache"
+
 module SavonHelper
 
   class CachingObject < MappingObject
 
-    @@cache_aspects = Hash.new()
+    @@cache_aspects = Hash.new { |hash, key| hash[key] = Set.new() }
+    @@cache = Cache.new(nil, nil, 10000, 5*60)
 
-    # @group Caching
+    # @!group Caching
 
     def self.cache_aspects
-      aspect = @@cache_aspects[self]
-      return aspect if !aspect.nil?
-      @@cache_aspects[self] = Set.new()
       @@cache_aspects[self]
     end
 
+    def self.all_cache_aspects
+      self.superclass.all_cache_aspects + cache_aspects()
+    end
+
     def self.cache_by_aspect(*symbols)
       symbols.each { |each| cache_aspects.add(each) }
     end
 
     def self.cache_key(aspect, value)
-      "#{self}-#{aspect}-#{value}"
-    end
-
-    def cache_aspects
-      self.class.cache_aspects
+      "#{self.name_without_namespace}-#{aspect}-#{value}"
     end
 
     def cache_key(aspect)
@@ -32,17 +32,54 @@ module SavonHelper
     end
 
     def cachable?
-      !cache_aspects.empty?
+      !all_cache_aspects.empty?
     end
 
     def cache
-      DeepSecurity::Manager.current.cache
+      @@cache
     end
 
     def store_in_cache
-      cache_aspects.each { |aspect| cache.store(self.cache_key(aspect), self) }
+      all_cache_aspects.each { |aspect| cache.store(self.cache_key(aspect), self) }
     end
 
+    # @! endgroup
+
+    # @!group Mapping
+
+    # Return an initialized instance with the values from the (type-converted) hash. Store the instance in cache
+    # if cacheable.
+    # @see #store_in_cache
+    #
+    # @param data [Hash] A hash of simple types as provided by Savon
+    # @return [MappingObject] The initialized instance.
+    def self.from_savon(data, interface)
+      instance = super(data, interface)
+      instance.store_in_cache if instance.cachable?
+      instance
+    end
+
+    # @!endgroup
+  end
+
+end
+
+class Object
+
+  def cache_aspects
+    self.class.cache_aspects
+  end
+
+  def self.cache_aspects
+    Set.new()
+  end
+
+  def all_cache_aspects
+    self.class.all_cache_aspects
+  end
+
+  def self.all_cache_aspects
+   Set.new()
   end
 
 end

data/lib/savon_helper/dsl.rb

@@ -0,0 +1,286 @@
+module SavonHelper
+
+  module DSL
+
+    public
+
+    # @!group DSL to define attributes mapping
+
+    # @macro [attach] attr_boolean_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [Boolean]
+    # Define a new Boolean accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def attr_boolean_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, BooleanMapping.new(description))
+    end
+
+    # @macro [attach] array_boolean_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [Array<Boolean>]
+    # Define a new Boolean Array accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def array_boolean_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, ArrayMapping.new(BooleanMapping.new, description))
+    end
+
+    # @macro [attach] attr_integer_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [int]
+    # Define a new Integer accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def attr_integer_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, IntegerMapping.new(description))
+    end
+
+    # @macro [attach] array_integer_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [Array<int>]
+    # Define a new Integer Array accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def array_integer_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, ArrayMapping.new(IntegerMapping.new, description))
+    end
+
+    # @macro [attach] attr_float_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [float]
+    # Define a new Float accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def attr_float_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, FloatMapping.new(description))
+    end
+
+    # @macro [attach] array_float__accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [Array<float>]
+    # Define a new Float array accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def array_float__accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, ArrayMapping.new(FloatMapping.new, description))
+    end
+
+    # @macro [attach] attr_double_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [float]
+    # Define a new Float accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def attr_double_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, FloatMapping.new(description))
+    end
+
+    # @macro [attach] array_double__accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [Array<float>]
+    # Define a new Float Array accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def array_double_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, ArrayMapping.new(FloatMapping.new, description))
+    end
+
+    # @macro [attach] attr_string_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [String]
+    # Define a new String accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def attr_string_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, StringMapping.new(description))
+    end
+
+    # @macro [attach] array_string_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [Array<String>]
+    # Define a new String Array accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def array_string_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, ArrayMapping.new(StringMapping.new, description))
+    end
+
+    # @macro [attach] attr_ip_address_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [int]
+    # Define a new IP Address accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def attr_ip_address_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, IPAddressMapping.new(description))
+    end
+
+    # @macro [attach] array_ip_address_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [Array<int>]
+    # Define a new IP Address Array accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def array_ip_address_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, ArrayMapping.new(IPAddressMapping.new, description))
+    end
+
+    # @macro [attach] attr_datetime_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [DateTime]
+    # Define a new DateTime accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def attr_datetime_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, DatetimeMapping.new(description))
+    end
+
+    # @macro [attach] array_datetime_accessor
+    #   @!attribute [rw] $3
+    #     $2
+    #     @return [Array<DateTime>]
+    # Define a new DateTime Array accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def array_datetime_accessor(accessor, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, ArrayMapping.new(DatetimeMapping.new, description))
+    end
+
+    # @macro [attach] attr_enum_accessor
+    #   @!attribute [rw] $4
+    #     $3
+    #     @return [$2]
+    # Define a new Enum accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param enum [Enum] An hash of Enum to Symbol mappings
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def attr_enum_accessor(accessor, enum, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, EnumMapping.new(enum, description))
+    end
+
+    # @macro [attach] array_enum_accessor
+    #   @!attribute [rw] $4
+    #     $3
+    #     @return [Array<$2>]
+    # Define a new Enum Array accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param enum [Enum] An hash of Enum to Symbol mappings
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def array_enum_accessor(accessor, enum, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, ArrayMapping.new(EnumMapping.new(enum), description))
+    end
+
+    # @macro [attach] hint_object_accessor
+    #   @!attribute [rw] $4
+    #     $3
+    #     @return [$2]
+    # Define a new "hint" for documentation purposes. Please note, that the method has to be define elsewhere!
+    # @param accessor [Symbol] The accessor to be created
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def hint_object_accessor(accessor, klass, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, HintMapping.new(klass, description))
+    end
+
+    # @macro [attach] attr_object_accessor
+    #   @!attribute [rw] $4
+    #     $3
+    #     @return [$2]
+    # Define a new Object accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param klass [Class] The class of the accessed object
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def attr_object_accessor(accessor, klass, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, ObjectMapping.new(klass, description))
+    end
+
+    # @macro [attach] array_object_accessor
+    #   @!attribute [rw] $4
+    #     $3
+    #     @return [Array<$2>]
+    # Define a new Object Array accessor
+    # @param accessor [Symbol] The accessor to be created
+    # @param klass [Class] The class of the accessed object
+    # @param description [String] The description for this accessor
+    # @param alias_accessor [Symbol] An Alias for the accessor
+    # @return [void]
+    def array_object_accessor(accessor, klass, description='', alias_accessor=accessor)
+      create_accessor(accessor, alias_accessor, ArrayMapping.new(ObjectMapping.new(klass, description)))
+    end
+
+    private
+
+    # Create the specified accessor and it's alias
+    # @param accessor [Symbol] The accessor
+    # @param alias_accessor [Symbol] The accessor alias
+    # @return [void]
+    def create_accessor(accessor, alias_accessor, mapping)
+      type_mappings[accessor] = mapping
+      attr_accessor accessor
+      create_alias(accessor, alias_accessor)
+    end
+
+    # Create the specified  alias
+    # @param accessor [Symbol] The accessor
+    # @param alias_accessor [Symbol] The accessor alias
+    # @return [void]
+    def create_alias(accessor, alias_accessor)
+      if alias_accessor != accessor
+        alias_method alias_accessor, accessor
+        alias_method alias_accessor.to_s + "=", accessor.to_s + "="
+      end
+    end
+
+    # @!endgroup
+
+  end
+end