nsicloudooo 0.4.1 → 0.5.0

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/lib/nsicloudooo/client.rb

@@ -135,7 +135,7 @@ module NSICloudooo
     #
     #
     # @param [String] key of the desired document
-    # @return [String] key of the desired document's thumbnail 
+    # @return [String] key of the desired document's thumbnail
     #
     # @example
     #   nsicloudooo.thumbnail_key_for("some key")
@@ -149,10 +149,47 @@ module NSICloudooo
       execute_request(request)["thumbnail"]
     end
 
+
+    # Enqueue a document to have its metadata extracted
+    #
+    #
+    # @param [String] key of the desired document
+    # @param [String] type of the desired document ('tcc' or 'event')
+    # @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 extract_metadata(document_key, type)
+      request = prepare_request :POST, {:sam_uid => document_key, :type => type, :metadata => true}.to_json
+      execute_request(request)
+    end
+
+    # Return the key of the metadata of a document
+    #
+    #
+    # @param [String] key of the desired document
+    # @return [String] key of the desired document's metadata or false if the metadata wasn't extracted yet
+    #
+    # @example
+    #   nsicloudooo.metadata_key_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 metadata_key_for(document_key)
+      request = prepare_request :GET, {:doc_key => document_key, :metadata => true}.to_json
+      execute_request(request)["metadata_key"]
+    end
+
     # Pre-configure the NSICloudooo module with default params for the NSICloudooo::Client
     #
     # @yield a Configuration object (see {NSICloudooo::Client::Configuration})
-    # 
+    #
     # @example
     #   NSICloudooo::Client.configure do
     #     user     "why"

data/lib/nsicloudooo/fake_server.rb

@@ -16,6 +16,10 @@ module NSICloudooo
       filename = incoming["filename"]
       filename = File.basename(incoming["doc_link"]) if incoming.has_key? "doc_link"
       callback = incoming["callback"] || nil
+      metadata = incoming['metadata']
+      unless metadata.nil?
+        return {doc_key: incoming["sam_uid"]}.to_json
+      end
       verb = incoming["verb"] || nil
       if filename.include? "secs"
         seconds = filename.split(".")[0].delete("secs").to_i
@@ -41,6 +45,9 @@ module NSICloudooo
           return {done: true}.to_json
         end
       elsif incoming.has_key? "doc_key"
+        if incoming.has_key? "metadata"
+          return {"metadata_key" => "metadata for #{incoming['doc_key']}"}.to_json
+        end
         return {:images => [], :files => [], :thumbnail => ['thumbnail key',]}.to_json
       end
     return 404 if incoming["key"].include? "dont"

data/nsicloudooo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "nsicloudooo"
-  s.version = "0.4.1"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Douglas Camata"]
-  s.date = "2012-07-31"
+  s.date = "2012-12-04"
   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

@@ -101,6 +101,18 @@ describe NSICloudooo do
 
   end
 
+  context "metadata extraction" do
+    it "can enqueue documents already stored to metadata extraction" do
+      response = @nsicloudooo.extract_metadata('some key', 'tcc')
+      response["doc_key"].should == 'some key'
+    end
+
+    it "can access the metadata key when it's already extracted" do
+      response = @nsicloudooo.extract_metadata('some key', 'tcc')
+      @nsicloudooo.metadata_key_for(response["doc_key"]).should == "metadata for #{response["doc_key"]}"
+    end
+  end
+
   context "get configuration" do
     before do
       NSICloudooo::Client.configure do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nsicloudooo
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-31 00:00:00.000000000 Z
+date: 2012-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -146,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1653432833353157753
+      hash: -3981209681326791150
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: