nexpose 7.0.0 → 7.0.1

data/lib/nexpose/shared_secret.rb

@@ -5,14 +5,14 @@ module Nexpose
     attr_reader :ttl
 
     def initialize(console, time_to_live)
-      uri = "/data/admin/global/shared-secret?time-to-live=#{time_to_live}"
+      uri  = "/data/admin/global/shared-secret?time-to-live=#{time_to_live}"
       json = JSON.parse(AJAX.put(console, uri))
       self.from_json(json)
     end
 
     def from_json(json)
       @key_string = json['keyString']
-      @ttl = json['timeToLiveInSeconds']
+      @ttl        = json['timeToLiveInSeconds']
     end
 
     def delete(console)
@@ -22,10 +22,10 @@ module Nexpose
 
     def ==(other)
       return false unless self.class == other.class
-      return false unless key_string.upcase == other.key_string.upcase
-
+      return false unless key_string.downcase == other.key_string.downcase
       true
     end
-    alias_method :eql?, :==
+    alias eql? ==
   end
+
 end

data/lib/nexpose/silo.rb

@@ -18,14 +18,14 @@ module Nexpose
       arr
     end
 
-    alias_method :silos, :list_silos
+    alias silos list_silos
 
     # Delete the specified silo
     #
     # @return Whether or not the delete request succeeded.
     #
     def delete_silo(silo_id)
-      r = execute(make_xml('SiloDeleteRequest', {'silo-id' => silo_id}), '1.2')
+      r = execute(make_xml('SiloDeleteRequest', { 'silo-id' => silo_id }), '1.2')
       r.success
     end
   end
@@ -39,13 +39,13 @@ module Nexpose
     attr_accessor :max_users
     attr_accessor :max_hosted_assets
 
-    #Optional fields
+    # Optional fields
     attr_accessor :description
     attr_accessor :merchant
     attr_accessor :organization
 
     def initialize(&block)
-      instance_eval &block if block_given?
+      instance_eval(&block) if block_given?
     end
 
     # Copy an existing configuration from a Nexpose instance.
@@ -56,8 +56,8 @@ module Nexpose
     # @return [Silo] Silo configuration loaded from a Nexpose console.
     #
     def self.copy(connection, id)
-      silo = load(connection, id)
-      silo.id = nil
+      silo      = load(connection, id)
+      silo.id   = nil
       silo.name = nil
       silo
     end
@@ -69,7 +69,7 @@ module Nexpose
     # @return [Silo] Silo configuration loaded from a Nexpose console.
     #
     def self.load(connection, id)
-      r = connection.execute(connection.make_xml('SiloConfigRequest', {'silo-id' => id}), '1.2')
+      r = connection.execute(connection.make_xml('SiloConfigRequest', { 'silo-id' => id }), '1.2')
 
       if r.success
         r.res.elements.each('SiloConfigResponse/SiloConfig') do |config|
@@ -80,12 +80,10 @@ module Nexpose
     end
 
     def save(connection)
-      begin
-        update(connection)
-      rescue APIError => error
-        raise error unless (error.message =~ /A silo .* does not exist./)
-        create(connection)
-      end
+      update(connection)
+    rescue APIError => error
+      raise error unless error.message =~ /A silo .* does not exist./
+      create(connection)
     end
 
     # Updates this silo on a Nexpose console.
@@ -118,7 +116,8 @@ module Nexpose
 
     def as_xml
       xml = REXML::Element.new('SiloConfig')
-      xml.add_attributes({'description' => @description, 'name' => @name, 'id' => @id, 'silo-profile-id' => @profile_id, 'max-assets' => @max_assets, 'max-users' => @max_users, 'max-hosted-assets' => @max_hosted_assets})
+      xml.add_attributes({ 'description' => @description, 'name' => @name, 'id' => @id, 'silo-profile-id' => @profile_id,
+                           'max-assets' => @max_assets, 'max-users' => @max_users, 'max-hosted-assets' => @max_hosted_assets })
       xml.add(@merchant.as_xml) if @merchant
       xml.add(@organization.as_xml) if @organization
       xml
@@ -130,13 +129,13 @@ module Nexpose
 
     def self.parse(xml)
       new do |silo|
-        silo.id = xml.attributes['id']
-        silo.profile_id = xml.attributes['silo-profile-id']
-        silo.name = xml.attributes['name']
-        silo.max_assets = xml.attributes['max-assets'].to_i
-        silo.max_users = xml.attributes['max-users'].to_i
+        silo.id                = xml.attributes['id']
+        silo.profile_id        = xml.attributes['silo-profile-id']
+        silo.name              = xml.attributes['name']
+        silo.max_assets        = xml.attributes['max-assets'].to_i
+        silo.max_users         = xml.attributes['max-users'].to_i
         silo.max_hosted_assets = xml.attributes['max-hosted-assets'].to_i
-        silo.description = xml.attributes['description']
+        silo.description       = xml.attributes['description']
 
         xml.elements.each('Merchant') do |merchant|
           silo.merchant = Merchant.parse(merchant)
@@ -156,25 +155,24 @@ module Nexpose
       attr_accessor :zip
       attr_accessor :country
 
-
       def initialize(&block)
-        instance_eval &block if block_given?
+        instance_eval(&block) if block_given?
       end
 
       def self.parse(xml)
         new do |address|
-          address.line1 = xml.attributes['line1']
-          address.line2 = xml.attributes['line2']
-          address.city = xml.attributes['city']
-          address.state = xml.attributes['state']
-          address.zip = xml.attributes['zip']
+          address.line1   = xml.attributes['line1']
+          address.line2   = xml.attributes['line2']
+          address.city    = xml.attributes['city']
+          address.state   = xml.attributes['state']
+          address.zip     = xml.attributes['zip']
           address.country = xml.attributes['country']
         end
       end
 
       def as_xml
         xml = REXML::Element.new('Address')
-        xml.add_attributes({'city' => @city, 'country' => @country, 'line1' => @line1, 'line2' => @line2, 'state' => @state, 'zip' => @zip})
+        xml.add_attributes({ 'city' => @city, 'country' => @country, 'line1' => @line1, 'line2' => @line2, 'state' => @state, 'zip' => @zip })
         xml
       end
     end
@@ -190,28 +188,29 @@ module Nexpose
       attr_accessor :url
 
       def initialize(&block)
-        instance_eval &block if block_given?
+        instance_eval(&block) if block_given?
       end
 
       def as_xml
         xml = REXML::Element.new('Organization')
-        xml.add_attributes({'company' => @company, 'email-address' => @email, 'first-name' => @first_name, 'last-name' => @last_name, 'phone-number' => @phone, 'title' => @title, 'url' => @url})
+        xml.add_attributes({ 'company' => @company, 'email-address' => @email, 'first-name' => @first_name,
+                             'last-name' => @last_name, 'phone-number' => @phone, 'title' => @title, 'url' => @url })
         xml.add(@address.as_xml)
         xml
       end
 
       def self.parse(xml)
         new do |organization|
-          organization.company = xml.attributes['company']
+          organization.company    = xml.attributes['company']
           organization.first_name = xml.attributes['first-name']
-          organization.last_name = xml.attributes['last-name']
-          organization.phone = xml.attributes['phone-number']
+          organization.last_name  = xml.attributes['last-name']
+          organization.phone      = xml.attributes['phone-number']
           xml.elements.each('Address') do |address|
             organization.address = Address.parse(address)
           end
           organization.email = xml.attributes['email']
           organization.title = xml.attributes['title']
-          organization.url = xml.attributes['url']
+          organization.url   = xml.attributes['url']
         end
       end
     end
@@ -233,32 +232,32 @@ module Nexpose
       attr_accessor :qsa
 
       def initialize(&block)
-        instance_eval &block if block_given?
-        @dbas = Array(@dbas)
+        instance_eval(&block) if block_given?
+        @dbas       = Array(@dbas)
         @industries = Array(@industries)
-        @qsa = Array(@qsa)
+        @qsa        = Array(@qsa)
       end
 
       def self.parse(xml)
         new do |merchant|
           merchant.acquirer_relationship = xml.attributes['acquirer-relationship'].to_s.chomp.eql?('true')
-          merchant.agent_relationship = xml.attributes['agent-relationship'].to_s.chomp.eql?('true')
-          merchant.ecommerce = xml.attributes['ecommerce'].to_s.chomp.eql?('true')
-          merchant.grocery = xml.attributes['grocery'].to_s.chomp.eql?('true')
-          merchant.mail_order = xml.attributes['mail-order'].to_s.chomp.eql?('true')
-          merchant.payment_application = xml.attributes['payment-application']
-          merchant.payment_version = xml.attributes['payment-version']
-          merchant.petroleum = xml.attributes['petroleum'].to_s.chomp.eql?('true')
-          merchant.retail = xml.attributes['retail'].to_s.chomp.eql?('true')
-          merchant.telecommunication = xml.attributes['telecommunication'].to_s.chomp.eql?('true')
-          merchant.travel = xml.attributes['travel'].to_s.chomp.eql?('true')
-          merchant.company = xml.attributes['company']
-          merchant.first_name = xml.attributes['first-name']
-          merchant.last_name = xml.attributes['last-name']
-          merchant.phone = xml.attributes['phone-number']
-          merchant.email = xml.attributes['email']
-          merchant.title = xml.attributes['title']
-          merchant.url = xml.attributes['url']
+          merchant.agent_relationship    = xml.attributes['agent-relationship'].to_s.chomp.eql?('true')
+          merchant.ecommerce             = xml.attributes['ecommerce'].to_s.chomp.eql?('true')
+          merchant.grocery               = xml.attributes['grocery'].to_s.chomp.eql?('true')
+          merchant.mail_order            = xml.attributes['mail-order'].to_s.chomp.eql?('true')
+          merchant.payment_application   = xml.attributes['payment-application']
+          merchant.payment_version       = xml.attributes['payment-version']
+          merchant.petroleum             = xml.attributes['petroleum'].to_s.chomp.eql?('true')
+          merchant.retail                = xml.attributes['retail'].to_s.chomp.eql?('true')
+          merchant.telecommunication     = xml.attributes['telecommunication'].to_s.chomp.eql?('true')
+          merchant.travel                = xml.attributes['travel'].to_s.chomp.eql?('true')
+          merchant.company               = xml.attributes['company']
+          merchant.first_name            = xml.attributes['first-name']
+          merchant.last_name             = xml.attributes['last-name']
+          merchant.phone                 = xml.attributes['phone-number']
+          merchant.email                 = xml.attributes['email']
+          merchant.title                 = xml.attributes['title']
+          merchant.url                   = xml.attributes['url']
 
           xml.elements.each('Address') do |address|
             merchant.address = Address.parse(address)
@@ -284,20 +283,22 @@ module Nexpose
       def as_xml
         xml = super
         xml.name = 'Merchant'
-        xml.add_attributes({'acquirer-relationship' => @acquirer_relationship, 'agent-relationship' => @agent_relationship, 'ecommerce' => @ecommerce, 'grocery' => @grocery, 'mail-order' => @mail_order})
-        xml.add_attributes({'payment-application' => @payment_application, 'payment-version' => @payment_version, 'petroleum' => @petroleum, 'retail' => @retail, 'telecommunication' => @telecommunication, 'travel' => @travel})
+        xml.add_attributes({ 'acquirer-relationship' => @acquirer_relationship, 'agent-relationship' => @agent_relationship,
+                             'ecommerce' => @ecommerce, 'grocery' => @grocery, 'mail-order' => @mail_order })
+        xml.add_attributes({ 'payment-application' => @payment_application, 'payment-version' => @payment_version,
+                             'petroleum' => @petroleum, 'retail' => @retail, 'telecommunication' => @telecommunication, 'travel' => @travel })
 
         unless dbas.empty?
           dbas = REXML::Element.new('DBAs')
           @dbas.each do |dba|
-            dbas.add_element('DBA', {'name' => dba})
+            dbas.add_element('DBA', { 'name' => dba })
           end
         end
 
         unless @industries.empty?
           industries = REXML::Element.new('OtherIndustries')
           @industries.each do |industry|
-            industries.add_element('Industry', {'name' => industry})
+            industries.add_element('Industry', { 'name' => industry })
           end
         end
 
@@ -331,23 +332,24 @@ module Nexpose
     attr_reader :max_users
 
     def initialize(&block)
-      instance_eval &block if block_given?
+      instance_eval(&block) if block_given?
     end
 
     def self.parse(xml)
       new do
-        @id = xml.attributes['id']
-        @name = xml.attributes['name']
+        @id          = xml.attributes['id']
+        @name        = xml.attributes['name']
         @description = xml.attributes['description']
-        @profile_id = xml.attributes['silo-profile-id']
+        @profile_id  = xml.attributes['silo-profile-id']
         xml.elements.each('LicenseSummary') do |license|
-          @assets = license.attributes['assets']
-          @max_assets = license.attributes['max-assets']
+          @assets            = license.attributes['assets']
+          @max_assets        = license.attributes['max-assets']
           @max_hosted_assets = license.attributes['max-hosted-assets']
-          @users = license.attributes['users']
-          @max_users = license.attributes['max-users']
+          @users             = license.attributes['users']
+          @max_users         = license.attributes['max-users']
         end
       end
     end
   end
+
 end

data/lib/nexpose/silo_profile.rb

@@ -18,14 +18,14 @@ module Nexpose
       arr
     end
 
-    alias_method :silo_profiles, :list_silo_profiles
+    alias silo_profiles list_silo_profiles
 
     # Delete the specified silo profile
     #
     # @return Whether or not the delete request succeeded.
     #
     def delete_silo_profile(silo_profile_id)
-      r = execute(make_xml('SiloProfileDeleteRequest', {'silo-profile-id' => silo_profile_id}), '1.2')
+      r = execute(make_xml('SiloProfileDeleteRequest', { 'silo-profile-id' => silo_profile_id }), '1.2')
       r.success
     end
   end
@@ -46,24 +46,24 @@ module Nexpose
     attr_accessor :restricted_report_sections
 
     def initialize(&block)
-      instance_eval &block if block_given?
-      @global_report_templates = Array(@global_report_templates)
-      @global_scan_engines = Array(@global_scan_engines)
-      @global_scan_templates = Array(@global_scan_templates)
-      @licensed_modules = Array(@licensed_modules)
-      @restricted_report_formats = Array(@restricted_report_formats)
+      instance_eval(&block) if block_given?
+      @global_report_templates    = Array(@global_report_templates)
+      @global_scan_engines        = Array(@global_scan_engines)
+      @global_scan_templates      = Array(@global_scan_templates)
+      @licensed_modules           = Array(@licensed_modules)
+      @restricted_report_formats  = Array(@restricted_report_formats)
       @restricted_report_sections = Array(@restricted_report_sections)
     end
 
     def self.copy(connection, id)
-      profile = load(connection, id)
-      profile.id = nil
+      profile      = load(connection, id)
+      profile.id   = nil
       profile.name = nil
       profile
     end
 
     def self.load(connection, id)
-      r = connection.execute(connection.make_xml('SiloProfileConfigRequest', {'silo-profile-id' => id}), '1.2')
+      r = connection.execute(connection.make_xml('SiloProfileConfigRequest', { 'silo-profile-id' => id }), '1.2')
 
       if r.success
         r.res.elements.each('SiloProfileConfigResponse/SiloProfileConfig') do |config|
@@ -75,13 +75,13 @@ module Nexpose
 
     def self.parse(xml)
       new do |profile|
-        profile.id = xml.attributes['id']
-        profile.name = xml.attributes['name']
-        profile.description = xml.attributes['description']
-        profile.all_licensed_modules = xml.attributes['all-licensed-modules'].to_s.chomp.eql?('true')
-        profile.all_global_engines = xml.attributes['all-global-engines'].to_s.chomp.eql?('true')
+        profile.id                          = xml.attributes['id']
+        profile.name                        = xml.attributes['name']
+        profile.description                 = xml.attributes['description']
+        profile.all_licensed_modules        = xml.attributes['all-licensed-modules'].to_s.chomp.eql?('true')
+        profile.all_global_engines          = xml.attributes['all-global-engines'].to_s.chomp.eql?('true')
         profile.all_global_report_templates = xml.attributes['all-global-report-templates'].to_s.chomp.eql?('true')
-        profile.all_global_scan_templates = xml.attributes['all-global-scan-templates'].to_s.chomp.eql?('true')
+        profile.all_global_scan_templates   = xml.attributes['all-global-scan-templates'].to_s.chomp.eql?('true')
 
         profile.global_report_templates = []
         xml.elements.each('GlobalReportTemplates/GlobalReportTemplate') { |template| profile.global_report_templates << template.attributes['name'] }
@@ -104,12 +104,10 @@ module Nexpose
     end
 
     def save(connection)
-      begin
-        update(connection)
-      rescue APIError => error
-        raise error unless (error.message =~ /silo profile(\S*|.*?)does not exist/i)
-        create(connection)
-      end
+      update(connection)
+    rescue APIError => error
+      raise error unless error.message =~ /silo profile(\S*|.*?)does not exist/i
+      create(connection)
     end
 
     # Updates an existing silo profile on a Nexpose console.
@@ -142,53 +140,53 @@ module Nexpose
 
     def as_xml
       xml = REXML::Element.new('SiloProfileConfig')
-      xml.add_attributes({'id' => @id,
-                          'name' => @name,
-                          'description' => @description,
-                          'all-licensed-modules' => @all_licensed_modules,
-                          'all-global-engines' => @all_global_engines,
-                          'all-global-report-templates' => @all_global_report_templates,
-                          'all-global-scan-templates' => @all_global_scan_templates})
+      xml.add_attributes({ 'id' => @id,
+                           'name' => @name,
+                           'description' => @description,
+                           'all-licensed-modules' => @all_licensed_modules,
+                           'all-global-engines' => @all_global_engines,
+                           'all-global-report-templates' => @all_global_report_templates,
+                           'all-global-scan-templates' => @all_global_scan_templates })
 
       unless @global_report_templates.empty?
         templates = xml.add_element('GlobalReportTemplates')
         @global_report_templates.each do |template|
-          templates.add_element('GlobalReportTemplate', {'name' => template})
+          templates.add_element('GlobalReportTemplate', { 'name' => template })
         end
       end
 
       unless @global_scan_engines.empty?
         engines = xml.add_element('GlobalScanEngines')
         @global_scan_engines.each do |engine|
-          engines.add_element('GlobalScanEngine', {'name' => engine})
+          engines.add_element('GlobalScanEngine', { 'name' => engine })
         end
       end
 
       unless @global_scan_templates.empty?
         templates = xml.add_element('GlobalScanTemplates')
         @global_scan_templates.each do |template|
-          templates.add_element('GlobalScanTemplate', {'name' => template})
+          templates.add_element('GlobalScanTemplate', { 'name' => template })
         end
       end
 
       unless @licensed_modules.empty?
         licensed_modules = xml.add_element('LicensedModules')
         @licensed_modules.each do |licensed_module|
-          licensed_modules.add_element('LicensedModule', {'name' => licensed_module})
+          licensed_modules.add_element('LicensedModule', { 'name' => licensed_module })
         end
       end
 
       unless @restricted_report_formats.empty?
         formats = xml.add_element('RestrictedReportFormats')
         @restricted_report_formats.each do |format|
-          formats.add_element('RestrictedReportFormat', {'name' => format})
+          formats.add_element('RestrictedReportFormat', { 'name' => format })
         end
       end
 
       unless @restricted_report_sections.empty?
         sections = xml.add_element('RestrictedReportSections')
         @restricted_report_sections.each do |section|
-          sections.add_element('RestrictedReportSection', {'name' => section})
+          sections.add_element('RestrictedReportSection', { 'name' => section })
         end
       end
 
@@ -214,26 +212,25 @@ module Nexpose
     attr_reader :all_global_report_templates
     attr_reader :all_global_scan_templates
 
-
     def initialize(&block)
-      instance_eval &block if block_given?
+      instance_eval(&block) if block_given?
     end
 
     def self.parse(xml)
       new do
-        @id = xml.attributes['id']
-        @name = xml.attributes['name']
-        @description = xml.attributes['description']
-        @global_report_template_count = xml.attributes['global-report-template-count']
-        @global_scan_engine_count = xml.attributes['global-scan-engine-count']
-        @global_scan_template_count = xml.attributes['global-scan-template-count']
-        @licensed_module_count = xml.attributes['licensed-module-count']
+        @id                              = xml.attributes['id']
+        @name                            = xml.attributes['name']
+        @description                     = xml.attributes['description']
+        @global_report_template_count    = xml.attributes['global-report-template-count']
+        @global_scan_engine_count        = xml.attributes['global-scan-engine-count']
+        @global_scan_template_count      = xml.attributes['global-scan-template-count']
+        @licensed_module_count           = xml.attributes['licensed-module-count']
         @restricted_report_section_count = xml.attributes['restricted-report-section-count']
-        @all_licensed_modules = xml.attributes['all-licensed-modules']
-        @all_global_engines = xml.attributes['all-global-engines']
-        @all_global_report_templates = xml.attributes['all-global-report-templates']
-        @all_global_scan_templates = xml.attributes['all-global-scan-templates']
+        @all_licensed_modules            = xml.attributes['all-licensed-modules']
+        @all_global_engines              = xml.attributes['all-global-engines']
+        @all_global_report_templates     = xml.attributes['all-global-report-templates']
+        @all_global_scan_templates       = xml.attributes['all-global-scan-templates']
       end
     end
   end
-end
+end