nsicloudooo 0.2.6 → 0.2.7

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.2.7

data/lib/nsicloudooo/client.rb

@@ -27,14 +27,20 @@ module NSICloudooo
     # @example A simple granulation
     #   require 'base64'
     #   doc = Base64.encode64(File.new('document.odt', 'r').read)
-    #   nsicloudooo.granulate(:file => doc, :filename => 'document.odt')
+    #   response = nsicloudooo.granulate(:file => doc, :filename => 'document.odt')
+    #   nsicloudooo.done(response["doc_key"])
+    #   nsicloudooo.grains_keys_for(response["doc_key"])
     # @example Granulating from a SAM uid
     #   doc = Base64.encode64(File.new('document.odt', 'r').read)
     #   response = sam.store({:doc => doc})
     #   doc_key = response["doc_key"]
-    #   nsicloudooo.granulate(:sam_uid => doc_key, :filename => 'document.odt')
+    #   response = nsicloudooo.granulate(:sam_uid => doc_key, :filename => 'document.odt')
+    #   nsicloudooo.done(response["doc_key"])
+    #   nsicloudooo.grains_keys_for(response["doc_key"])
     # @example Downloading and granulating from web
-    #   nsicloudooo.granulate(:doc_link => 'http://google.com/document.odt')
+    #   response = nsicloudooo.granulate(:doc_link => 'http://google.com/document.odt')
+    #   nsicloudooo.done(response["doc_key"])
+    #   nsicloudooo.grains_keys_for(response["doc_key"])
     # @example Sending a callback url
     #   doc = Base64.encode64(File.new('document.odt', 'r').read)
     #   nsicloudooo.granulate(:file => doc, :filename => 'document.odt', :callback => 'http://google.com')
@@ -46,16 +52,24 @@ module NSICloudooo
     #
     # @return [Hash] response
     #   * "doc_key" [String] the key to access the granulated document if the sam node it was stored
+    #
+    # @raise NSICloudooo::Errors::Client::MissingParametersError when an invalid or incomplete set of parameters is provided
+    # @raise NSICloudooo::Errors::Client::SAMConnectionError when cannot connect to the SAM node
+    # @raise NSICloudooo::Errors::Client::AuthenticationError when invalids user and/or password are provided
+    # @raise NSICloudooo::Errors::Client::KeyNotFoundError when an invalid sam_uid is provided
+    #
     def granulate(options = {})
       @request_data = Hash.new
       if options[:doc_link]
         insert_download_data options
-      elsif options[:sam_uid]
+      elsif options[:sam_uid] && options[:filename]
         file_data = {:sam_uid => options[:sam_uid], :filename => options[:filename]}
         @request_data.merge! file_data
-      else
+      elsif options[:file] && options[:filename]
         file_data = {:doc => options[:file], :filename => options[:filename]}
         @request_data.merge! file_data
+      else
+        raise NSICloudooo::Errors::Client::MissingParametersError
       end
       insert_callback_data options
       request = prepare_request :POST, @request_data.to_json
@@ -64,7 +78,6 @@ module NSICloudooo
 
     # Verify if a document is already granulated
     #
-    # @raise NSICloudooo::Errors::Client:KeyNotFoundError when an invalid document key is provided
     #
     # @param [String] key of the desired document
     # @return [Hash] response
@@ -72,6 +85,11 @@ module NSICloudooo
     #
     # @example
     #   nsicloudooo.done("some key")
+    #
+    # @raise NSICloudooo::Errors::Client::SAMConnectionError when cannot connect to the SAM node
+    # @raise NSICloudooo::Errors::Client::AuthenticationError when invalids user and/or password are provided
+    # @raise NSICloudooo::Errors::Client::KeyNotFoundError when an invalid key is provided
+    #
     def done(key)
       request = prepare_request :GET, {:key => key}.to_json
       execute_request(request)
@@ -79,7 +97,6 @@ module NSICloudooo
 
     # Return the keys of the grains of a document
     #
-    # @raise NSICloudooo::Errors::Client:KeyNotFoundError when an invalid document key is provided
     #
     # @param [String] key of the desired document
     # @return [Hash] response
@@ -88,6 +105,11 @@ module NSICloudooo
     #
     # @example
     #   nsicloudooo.grains_keys_for("some key")
+    #
+    # @raise NSICloudooo::Errors::Client::SAMConnectionError when cannot connect to the SAM node
+    # @raise NSICloudooo::Errors::Client::AuthenticationError when invalids user and/or password are provided
+    # @raise NSICloudooo::Errors::Client::KeyNotFoundError when an invalid key is provided
+    #
     def grains_keys_for(document_key)
       request = prepare_request :GET, {:doc_key => document_key}.to_json
       execute_request(request)
@@ -118,6 +140,11 @@ module NSICloudooo
         http.request(request)
       end
       raise NSICloudooo::Errors::Client::KeyNotFoundError if response.code == "404"
+      raise NSICloudooo::Errors::Client::MalformedRequestError if response.code == "400"
+      raise NSICloudooo::Errors::Client::AuthenticationError if response.code == "401"
+      if response.code == "500" and response.body.include?("SAM")
+        raise NSICloudooo::Errors::Client::SAMConnectionError
+      end
       JSON.parse(response.body)
     end
   end

data/lib/nsicloudooo/errors.rb

@@ -3,6 +3,18 @@ module NSICloudooo
     module Client
       class KeyNotFoundError < RuntimeError
       end
+
+      class MissingParametersError < RuntimeError
+      end
+
+      class MalformedRequestError < RuntimeError
+      end
+
+      class AuthenticationError < RuntimeError
+      end
+
+      class SAMConnectionError < RuntimeError
+      end
     end
   end
 end

data/nsicloudooo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "nsicloudooo"
-  s.version = "0.2.6"
+  s.version = "0.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Douglas Camata"]
-  s.date = "2012-04-02"
+  s.date = "2012-04-03"
   s.description = "A simple gem to access a nsi.cloudooo node"
   s.email = "d.camata@gmail.com"
   s.extra_rdoc_files = [

data/spec/nsicloudooo_spec.rb

@@ -20,6 +20,12 @@ describe NSICloudooo do
       response.should_not be_nil
       response["doc_key"].should == "key for document test.odt"
     end
+
+    it "should throw error if any required parameter is missing" do
+      expect { @nsicloudooo.granulate(:file => 'document') }.to raise_error(NSICloudooo::Errors::Client::MissingParametersError)
+      expect { @nsicloudooo.granulate(:sam_uid => 'document') }.to raise_error(NSICloudooo::Errors::Client::MissingParametersError)
+      expect { @nsicloudooo.granulate(:filename => 'document') }.to raise_error(NSICloudooo::Errors::Client::MissingParametersError)
+    end
   end
 
   context "granulation with conversion" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nsicloudooo
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-02 00:00:00.000000000 Z
+date: 2012-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -144,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2544257564898028649
+      hash: 1165319240348010888
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: