ionis 0.0.9 → 0.1.0

data/README.rdoc

@@ -29,7 +29,7 @@ In a nutshell:
 
     hNetsoul = IONIS::Netsoul.new
     puts hNetsoul.getUser 'meyer_t'
-    puts hNetsoul.getUser 'adam_p'
+    puts hNetsoul.online? 'adam_p'
   rescue IONIS::Exception::HostNotFound => e
     puts e.reason
   rescue IONIS::Exception::ConnectionRefused => e

data/lib/ionisauthentication.rb

@@ -10,6 +10,11 @@ module  IONIS
     @tmpDir = nil
     @lstStudent = nil
 
+	# Instance of Authentication - sshUserName and sshUserPass are needed to update IONIS Auth. file from IONIS Server.
+	# @param [String] sshUserName IONIS Login
+	# @param [String] sshUserPass Unix password
+	# @param [Boolean] forceUpdate Force update of IONIS Auth. files
+	# @return [Authentication] A new instance of Authentication
     def initialize sshUserName, sshUserPass, forceUpdate = false
       @tmpDir = File.join Dir.tmpdir, 'ionis_auth/'
       @lstStudent = Hash.new
@@ -68,12 +73,19 @@ module  IONIS
       hFile.close
     end
 
+	# Check PPP Password of given user
+	# @param [String] userName IONIS Login
+	# @param [String] userPass PPP Password
+	# @return [Mixed] Informations about given user in Array if password if correct. Otherwize: false
     def chkPass userName, userPass
       false if @lstStudent == nil
       return @lstStudent[userName] if BCrypt::Engine.hash_secret(userPass , @lstStudent[userName][:password]) == @lstStudent[userName][:password]
       false
     end
 
+	# Get informations about one user
+	# @param [String] userName IONIS Login
+	# @return [Hash] Information about given user in Array. If User doesn't exist, the returned array will be empty
     def getUser userName
       false if @lstStudent == nil
       return @lstStudent[userName]

data/lib/ionisnetsoul.rb

@@ -8,6 +8,8 @@ module IONIS
     @tmpDir = nil
     @usrData = nil
 
+	# Instance of Netsoul
+	# @return [Netsoul] A new instance of Netsoul
     def initialize
       @tmpDir = File.join Dir.tmpdir, 'ionis_auth'
       Dir.mkdir @tmpDir if !File.directory? @tmpDir
@@ -43,20 +45,30 @@ module IONIS
       end
     end
 
+	# Get informations about given connected user
+	# @param [String] login IONIS Login
+	# @return [Hash] Information about given user in Array. If User doesn't exist, the returned array will be empty
     def getUser login
       return false if !@usrData
       @usrData[login]
     end
 
+	# Get number of connected user(s)
+	# @return [fixnum] Number of connected user(s)
     def size
       return @usrData.size
     end
 
+	# Get informations about all connected user
+	# @return [Hash] Information about given user in Array. If no-one was connected, the returned array will be empty
     def getAllOnlineUsers
       return false if !@usrData
       @usrData[login]
     end
 
+	# Check if user is connected
+	# @param [String] login IONIS Login
+	# @return [Boolean] True if user is Online, otherwize: false
     def online? login
       return false if !@usrData
       return true if @usrData[login]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ionis
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-05 00:00:00.000000000 Z
+date: 2012-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &13778440 !ruby/object:Gem::Requirement
+  requirement: &7571320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *13778440
+  version_requirements: *7571320
 - !ruby/object:Gem::Dependency
   name: net-scp
-  requirement: &13777680 !ruby/object:Gem::Requirement
+  requirement: &6113080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *13777680
+  version_requirements: *6113080
 - !ruby/object:Gem::Dependency
   name: bcrypt-ruby
-  requirement: &13776380 !ruby/object:Gem::Requirement
+  requirement: &5403240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *13776380
+  version_requirements: *5403240
 description: A Ruby set of Classes to get informations about students in Ionis group
 email: meyer.thibault@hotmail.fr
 executables: []
@@ -62,7 +62,7 @@ rdoc_options:
 - --line-numbers
 - --inline-source
 - --title
-- Net-scp
+- IONIS
 - --main
 - README.rdoc
 require_paths: