netsoul 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc986dc3e21a355d48e3e08494dc8f8e20f8e10b
-  data.tar.gz: 11cfd33d73a5aa6ce747a6d6366d527d5dd390cc
+  metadata.gz: 6496d73b31b3f059aeabe8bbf5b98ce5f9924a10
+  data.tar.gz: 7540b86bda32a45a04bbc8c141d3a0dc3c23d156
 SHA512:
-  metadata.gz: 538ccf6b1c16631a498b33c9f9b8b1dc97f16e04808d522a1b9b8872d8bf3dde24648d3bbcd4f23b3c2c76f58762860adc859130f7a99abfaf37d35d622ff956
-  data.tar.gz: f6f9e1d42043ec7c64215a0827f65e2b5d3ccdc76d97306b50bf1ad4b4f2293527e04d00dbda16c78c539ee01a9f6fce99ff195422f85ecc8f3627a0b087cf89
+  metadata.gz: 4c13b35d41d89022f1dc91d2f162adecee6443ebf2076e26f89071f1ba22bc47ce543bd226ab47276a3bebf9ec32bc3fff14ce1cb1d05cec89f1ba4d567d4020
+  data.tar.gz: 6585b13351b90d9c0357bf30cc58ed0b5b36c53e805080ff46b3f123eb7c42dcdd61b4bb370981e418447434bb53a91c7f33b2208572c9bda61d24965bf62fbc

data/README.md

@@ -19,61 +19,68 @@ You can use it as a Ruby gem in order to implement your own Netsoul client in Ru
 
 ### On your desktop
 
-    gem install netsoul
+```ruby
+gem install netsoul
+```
 
 ### In your project
 
 #### Gemfile
 
-    gem 'netsoul', '~> 0.1'
+```ruby
+gem 'netsoul', '~> 1.2'
+```
 
 #### project.rb
 
-    require 'netsoul'
+```ruby
+require 'netsoul'
+```
 
 ## Use the client
 
 After installing the gem **netsoul**, call the client as described bellow.
 
-    ```bash
-    netsoul-ruby -config netsoul-config.yml
-    ```
+```bash
+netsoul-ruby -config netsoul-config.yml
+```
 
 ### Example of _netsoul-config.yml_ file
 
 #### Standard (MD5) authentication
 
-    ```yaml
-    ---|
-    :login: 'kakesa_c'
-    :socks_password: 'my socks password'
-    # :unix_password: 'unix password needed for kerberos authentication' # :auth_method must be set to :krb5
-    # :auth_method: :std # :std, :krb5
-    # :server_host: 'ns-server.epita.fr'
-    # :server_port: 4242
-    # :state: :none # :actif, :away, :connection, :idle, :lock, :server, :none
-    # :location: 'Home'
-    # :user_group: 'ETNA_2008'
-    ```
+```yaml
+---|
+:login: 'kakesa_c'
+:socks_password: 'my socks password'
+# :unix_password: 'unix password needed for kerberos authentication' # :auth_method must be set to :krb5
+# :auth_method: :std # :std, :krb5
+# :server_host: 'ns-server.epita.fr'
+# :server_port: 4242
+# :state: :none # :actif, :away, :connection, :idle, :lock, :server, :none
+# :location: 'Home'
+# :user_group: 'ETNA_2008'
+```
 
 #### Kerberos authentication
 
-    ```yaml
-    ---|
-    :login: 'kakesa_c'
-    :unix_password: 'unix password'
-    :auth_method: :krb5 # :std, :krb5
-    # :socks_password: 'my socks password'
-    # :server_host: 'ns-server.epita.fr'
-    # :server_port: 4242
-    # :state: :none # :actif, :away, :connection, :idle, :lock, :server, :none
-    # :location: 'Home'
-    # :user_group: 'ETNA_2008'
-    ```
+```yaml
+---|
+:login: 'kakesa_c'
+:unix_password: 'unix password'
+:auth_method: :krb5 # :std, :krb5
+# :socks_password: 'my socks password'
+# :server_host: 'ns-server.epita.fr'
+# :server_port: 4242
+# :state: :none # :actif, :away, :connection, :idle, :lock, :server, :none
+# :location: 'Home'
+# :user_group: 'ETNA_2008'
+```
 
 ## Use the library in custom Netsoul Ruby client
 
-__[TODO]__
+Look at the client implementation in this gem: [https://github.com/fenicks/netsoul-ruby/blob/master/bin/netsoul-ruby]().
+This client is implemented in less than 150 lines of code.
 
 ## Contributing
 

data/bin/netsoul-ruby

@@ -114,7 +114,7 @@ end
 
 retry_count = 10
 retry_wait_time = 1.0
-RETRY_WAIT_FACTOR = 1.25 # Each time retry is called 'retry_wait_time' is increased with this factor
+RETRY_WAIT_FACTOR = 1.25 # Each time retry is called in Exception, current 'retry_wait_time' is increased with this factor
 begin
   c = Netsoul::Client.new options[:user_opts]
   c.connect

data/lib/netsoul/version.rb

@@ -1,3 +1,3 @@
 module Netsoul
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netsoul
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Christian Kakesa