client.rb in nsisam-0.2.8

- old
+ new

@@ -7,10 +7,12 @@
 
     # Initialize a client to a SAM node hosted at a specific url
     #
     # @param [String] url the SAM node url
     # @return [Client] the object itself
+    # @example
+    #   nsisam = NSISam::Client.new 'http://user:pass@ip:port/'
     def initialize(url)
       user_and_pass = url.match(/(\w+):(\w+)/)
       @user, @password = user_and_pass[1], user_and_pass[2]
       @url = url.match(/@(.*):/)[1]
       @port = url.match(/([0-9]+)(\/)?$/)[1]
@@ -19,22 +21,27 @@
     # Store a given data in SAM
     #
     # @param [String] data the desired data to store
     # @return [Hash] response with the data key and checksum
     #   * "key" [String] the key to access the stored data
-    #   * "checksum" [String] the sha1 checksum of the stored data 
+    #   * "checksum" [String] the sha1 checksum of the stored data
+    # @example
+    #   nsisam.store("something")
     def store(data)
       request_data = {:value => data}.to_json
       request = prepare_request :PUT, request_data
       execute_request(request)
     end
 
     # Delete data at a given SAM key
     #
     # @param [Sring] key of the value to delete
     # @return [Hash] response
-    #   * "deleted" [Boolean] true if the key was sucefully deleted 
+    #   * "deleted" [Boolean] true if the key was successfully deleted
+    # @raise [NSISam::Errors::Client::KeyNotFoundError] When the key doesn't exists
+    # @example Deleting an existing key
+    #   nsisam.delete("some key")
     def delete(key)
       request_data = {:key => key}.to_json
       request = prepare_request :DELETE, request_data
       execute_request(request)
     end
@@ -44,22 +51,28 @@
     # @param [String] key of the value to acess
     # @return [Hash] response
     #   * "from_user" [String] the user who stored the value
     #   * "date" [String] the date when the value was stored
     #   * "data" [String, Hash, Array] the data stored at that key
+    # @raise [NSISam::Errors::Client::KeyNotFoundError] When the key doesn't exists
+    # @example
+    #   nsisam.get("some key")
     def get(key)
       request_data = {:key => key}.to_json
       request = prepare_request :GET, request_data
       execute_request(request)
     end
 
     # Update data stored at a given SAM key
     #
     # @param [String] key of the data to update
     # @param [String, Hash, Array] data to be stored at the key
-    # return [Hash] response
+    # @return [Hash] response
     #   * "key" [String] just to value key again
     #   * "checksum" [String] the new sha1 checksum of the key's data
+    # @raise [NSISam::Errors::Client::KeyNotFoundError] When the key doesn't exists
+    # @example
+    #   nsisam.update("my key", "my value")
     def update(key, value)
       request_data = {:key => key, :value => value}.to_json
       request = prepare_request :POST, request_data
       execute_request(request)
     end