nsisam 0.2.7 → 0.2.8

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.2.8

data/lib/nsisam/client.rb

@@ -9,6 +9,8 @@ module NSISam
     #
     # @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]
@@ -21,7 +23,9 @@ module NSISam
     # @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
@@ -32,7 +36,10 @@ module NSISam
     #
     # @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
@@ -46,6 +53,9 @@ module NSISam
     #   * "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
@@ -56,9 +66,12 @@ module NSISam
     #
     # @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

data/nsisam.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "nsisam"
-  s.version = "0.2.7"
+  s.version = "0.2.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Douglas Camata"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nsisam
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &17065580 !ruby/object:Gem::Requirement
+  requirement: &13220200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17065580
+  version_requirements: *13220200
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &17064960 !ruby/object:Gem::Requirement
+  requirement: &13775780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17064960
+  version_requirements: *13775780
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &17064220 !ruby/object:Gem::Requirement
+  requirement: &13775140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17064220
+  version_requirements: *13775140
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &17063600 !ruby/object:Gem::Requirement
+  requirement: &13774500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17063600
+  version_requirements: *13774500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &17063020 !ruby/object:Gem::Requirement
+  requirement: &13773540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *17063020
+  version_requirements: *13773540
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &17062340 !ruby/object:Gem::Requirement
+  requirement: &13772660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *17062340
+  version_requirements: *13772660
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &17061800 !ruby/object:Gem::Requirement
+  requirement: &13771920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *17061800
+  version_requirements: *13771920
 description: ! "A simple gem to access a SAM node. For more info about SAM\n                       visit
   www.github.com/nsi-iff/sam_buildout."
 email: d.camata@gmail.com
@@ -126,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2979948941930370823
+      hash: 934113303097294613
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: