nexpose 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99af3c0c74693a9df896c50271778eb81ba30347
-  data.tar.gz: 6545d6a48af4804641464b9664e66b4ccd9c4874
+  metadata.gz: 53818a10219a24c3d90a3fb09b2f658936aedd0b
+  data.tar.gz: 1b9a61cfb7ee75f878f9969d1472bba737e8499c
 SHA512:
-  metadata.gz: 0604a979b91e03b8d213fe29608a193228b633e679916480996b8e92d2cb1aeacaccd685c84a4b4d0380c9e0c796571827e48884807adadea521fa21ac7b8892
-  data.tar.gz: 07bd389940f0ecf8d94442a5c388e79db2f3259c3f92c1d60c648cb2a6d2a398686b6a325c9b8eb2867909fe6cd4966215f6b9160a85be0d26d1f4b16c87ceb5
+  metadata.gz: f6fd0316810c84f88463f7db042ef87934cfefa0547fe9df7d8530d9b2d45d579452b22305b16850ae0ea1fcf13d5a5ea6dd45422a1c78a351955fa4c769b880
+  data.tar.gz: 5e7422dfe20cdc0066e47e9b0ba1638fa8d6c0269a85df03d50b38fe1f6b5aef1c45ac50f8d932aeeb95b3a0d5219646edd1de01332210f31d793abc6448f76f

data/lib/nexpose/role.rb

@@ -118,7 +118,7 @@ module Nexpose
     GLOBAL_ADMINISTRATOR = 'global-admin'
     ASSET_OWNER = 'system-admin'
     SECURITY_MANAGER = 'security-manager'
-    SITE_ADMINISTRATOR = 'site-admin'
+    SITE_OWNER = 'site-admin'
     USER = 'user'
 
     # Array of all privileges which are enabled for this role.

data/lib/nexpose/user.rb

@@ -1,15 +1,49 @@
 module Nexpose
 
+  module NexposeAPI
+    include XMLUtils
+
+    # Retrieve a list of all users configured on this console.
+    #
+    # @return [Array[UserSummary]] Array of users.
+    #
+    def users
+      r = execute(make_xml('UserListingRequest'))
+      arr = []
+      if r.success
+        r.res.elements.each('UserListingResponse/UserSummary') do |summary|
+          arr << UserSummary.parse(summary)
+        end
+      end
+      arr
+    end
+
+    # Retrieve the User ID based upon the user's login name.
+    def get_user_id(user_name)
+      users.find { |user| user.name.eql? user_name }
+    end
+
+    # Delete a user from the Nexpose console.
+    #
+    # @param [Fixnum] user_id Unique ID for the user to delete.
+    # @return [Boolean] Whether or not the user deletion succeeded.
+    #
+    def delete_user(user_id)
+      response = execute(make_xml('UserDeleteRequest', { 'id' => user_id }))
+      response.success
+    end
+  end
+
   # Summary only returned by API when issuing a listing request.
   class UserSummary
-    attr_reader :id, :auth_source, :auth_module, :user_name, :full_name, :email
+    attr_reader :id, :auth_source, :auth_module, :name, :full_name, :email
     attr_reader :is_admin, :is_disabled, :is_locked, :site_count, :group_count
 
-    def initialize(id, auth_source, auth_module, user_name, full_name, email, is_admin, is_disabled, is_locked, site_count, group_count)
+    def initialize(id, auth_source, auth_module, name, full_name, email, is_admin, is_disabled, is_locked, site_count, group_count)
       @id = id
       @auth_source = auth_source
       @auth_module = auth_module
-      @user_name = user_name
+      @name = name
       @full_name = full_name
       @email = email
       @is_admin = is_admin
@@ -19,52 +53,19 @@ module Nexpose
       @group_count = group_count
     end
 
-    def to_s
-      out = "#{@user_name} (#{@full_name}) [ID: #{@id}]"
-      out << " e-mail: #{@email}" unless @email.empty?
-      out << ' Administrator' if @is_admin
-      out << ' Disabled' if @is_disabled
-      out << ' Locked' if @is_locked
-      out << ", sites: #{@site_count}"
-      out << ", groups: #{@group_count}"
-    end
-
     # Provide a list of user accounts and information about those accounts.
-    def self.listing(connection)
-      xml = '<UserListingRequest session-id="' + connection.session_id + '" />'
-      r = connection.execute(xml, '1.1')
-      if r.success
-        res = []
-        r.res.elements.each('UserListingResponse/UserSummary') do |summary|
-          res << UserSummary.new(
-            summary.attributes['id'].to_i,
-            summary.attributes['authSource'],
-            summary.attributes['authModule'],
-            summary.attributes['userName'],
-            summary.attributes['fullName'],
-            summary.attributes['email'],
-            summary.attributes['administrator'].to_s.chomp.eql?('1'),
-            summary.attributes['disabled'].to_s.chomp.eql?('1'),
-            summary.attributes['locked'].to_s.chomp.eql?('1'),
-            summary.attributes['siteCount'].to_i,
-            summary.attributes['groupCount'].to_i)
-        end
-        res
-      else
-        false
-      end
-    end
-
-    # Retrieve the User ID based upon the user's login name.
-    def self.get_user_id(connection, user_name)
-      xml = '<UserListingRequest session-id="' + connection.session_id + '" />'
-      r = connection.execute(xml, '1.1')
-      if r.success
-        r.res.elements.each('UserListingResponse/UserSummary') do |user|
-          return user.attributes['id'] if user_name.eql? user.attributes['userName']
-        end
-      end
-      return -1
+    def self.parse(summary)
+      new(summary.attributes['id'].to_i,
+          summary.attributes['authSource'],
+          summary.attributes['authModule'],
+          summary.attributes['userName'],
+          summary.attributes['fullName'],
+          summary.attributes['email'],
+          summary.attributes['administrator'].to_s.chomp.eql?('1'),
+          summary.attributes['disabled'].to_s.chomp.eql?('1'),
+          summary.attributes['locked'].to_s.chomp.eql?('1'),
+          summary.attributes['siteCount'].to_i,
+          summary.attributes['groupCount'].to_i)
     end
   end
 
@@ -103,15 +104,6 @@ module Nexpose
       @groups = []
     end
 
-    def to_s
-      out = "#{@name} (#{@full_name}) [ID: #{@id}, Role: #{@role_name}]"
-      out << ' Disabled' unless @enabled
-      out << ' All-Sites' if @all_sites
-      out << ' All-Groups' if @all_groups
-      out << " e-mail: #{@email}" unless @email.nil? || @email.empty?
-      out
-    end
-
     def to_xml
       xml = '<UserConfig'
       xml << %Q{ id="#{@id}"}
@@ -177,22 +169,9 @@ module Nexpose
       end
     end
 
-    # Delete a user account.
-    def self.delete(connection, user_id)
-      xml = '<UserDeleteRequest session-id="' + connection.session_id + '"'
-      xml << %Q{ id="#{user_id}"}
-      xml << ' />'
-      r = connection.execute(xml, '1.1')
-      if r.success
-        r.res.elements.each('UserConfigResponse/UserConfig') do |config|
-          '1'.eql? config.attributes['id']
-        end
-      end
-    end
-
     # Delete the user account associated with this object.
     def delete(connection)
-      User.delete(connection, @id)
+      connection.delete_user(@id)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - HD Moore
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: librex