nsicloudooo 0.2.0 → 0.2.1

data/Gemfile

@@ -2,7 +2,7 @@ source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
-
+gem 'sinatra'
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do

data/Rakefile

@@ -29,11 +29,7 @@ require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+  spec.rspec_opts = "--color --format nested"
 end
 
 task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/nsicloudooo/client.rb

@@ -0,0 +1,98 @@
+require "json"
+require "net/http"
+require File.dirname(__FILE__) + '/errors'
+
+module NSICloudooo
+  class Client
+
+    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]
+    end
+
+    # Send a document be granulated by a nsi.cloudooo node
+    #
+    # @param [Hash] options used to send a document to be graulated
+    # @option options [String] file the base64 encoded file to be granulated
+    # @option options [String] filename the filename of the document
+    # @note the filename is very importante, the cloudooo node will convert the document based on its filename, if necessary
+    # @option options [String] doc_link link to the document that'll be granulated
+    # @note if provided both doc_link and file options, file will be ignored and the client will download the document instead
+    # @option options [String] callback a callback url to the file granulation
+    # @option options [String] verb the callback request verb, when not provided, nsi.cloudooo default to POST
+    #
+    # @example A simple granulation
+    #   doc = Base64.encode64(File.new('document.odt', 'r').read)
+    #   nsicloudooo.granulate(:file => doc, :filename => 'document.odt')
+    # @example Downloading and granulating from web
+    #   nsicloudooo.granulate(:doc_link => 'http://google.com/document.odt')
+    # @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')
+    #   nsicloudooo.granulate(:doc_link => 'http://google.com/document.odt', :callback => 'http://google.com')
+    # @example Using a custom verb to the callback
+    #   doc = Base64.encode64(File.new('document.odt', 'r').read)
+    #   nsicloudooo.granulate(:file => doc, :filename => 'document.odt', :callback => 'http://google.com', :verb => "PUT")
+    #   nsicloudooo.granulate(:doc_link => 'http://google.com/document.odt', :callback => 'http://google.com', :verb => "PUT")
+    #
+    # @return [Hash] response
+    #   * "key" [String] the key to access the granulated document if the sam node it was stored
+    def granulate(options = {})
+      @request_data = Hash.new
+      if options[:doc_link]
+        insert_download_data options
+      else
+        file_data = {:doc => options[:file], :filename => options[:filename]}
+        @request_data.merge! file_data
+      end
+      insert_callback_data options
+      request = prepare_request :POST, @request_data.to_json
+      execute_request(request)
+    end
+
+    # 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
+    #   * "done" [String] true if the document was already granualted, otherwise, false
+    #
+    # @example
+    #   nsicloudooo.done("some key")
+    def done(key)
+      request = prepare_request :GET, {:key => key}.to_json
+      execute_request(request)
+    end
+
+    private
+
+    def insert_download_data(options)
+      download_data = {doc_link: options[:doc_link]}
+      @request_data.merge! download_data
+    end
+
+    def insert_callback_data(options)
+        @request_data[:callback] = options[:callback] unless options[:callback].nil?
+        @request_data[:verb] = options[:verb] unless options[:verb].nil?
+    end
+
+    def prepare_request(verb, body)
+      verb = verb.to_s.capitalize!
+      request = Net::HTTP.const_get("#{verb}").new '/'
+      request.body = body
+      request.basic_auth @user, @password
+      request
+    end
+
+    def execute_request(request)
+      response = Net::HTTP.start @url, @port do |http|
+        http.request(request)
+      end
+      raise NSICloudooo::Errors::Client::KeyNotFoundError if response.code == "404"
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/nsicloudooo/fake_server.rb

@@ -0,0 +1,72 @@
+require "logger"
+require "sinatra"
+require "json"
+require "thread"
+
+module NSICloudooo
+  class Server < Sinatra::Application
+
+    configure :development do
+      Dir.mkdir('logs') unless File.exist?('logs')
+      $stderr.reopen("logs/output.log", "w")
+    end
+
+    def self.prepare
+      @@done = Hash.new
+    end
+
+    post "/" do
+      content_type :json
+      incoming = JSON.parse(request.body.read)
+      filename = incoming["filename"]
+      filename = File.basename(incoming["doc_link"]) if incoming.has_key? "doc_link"
+      callback = incoming["callback"] || nil
+      verb = incoming["verb"] || nil
+      if filename.include? "secs"
+        seconds = filename.split(".")[0].delete("secs").to_i
+        sleep seconds-1
+      end
+      {
+        key: "key for document #{filename}",
+        callback: callback,
+        verb: verb,
+      }.to_json
+    end
+
+    get "/" do
+      content_type :json
+      incoming = JSON.parse(request.body.read)
+      if incoming["key"].include? "secs"
+        unless @@done.has_key? incoming["key"]
+          @@done[incoming["key"]] = true
+          return {done: false}.to_json
+        else
+          return {done: true}.to_json
+        end
+      else
+        return 404 if incoming["key"].include? "dont"
+      end
+    end
+  end
+
+  class FakeServerManager
+
+    # Start the nsi.cloudooo fake server
+    #
+    # @param [Fixnum] port the port where the fake server will listen
+    #   * make sure there's not anything else listenning on this port
+    def start_server(port=8886)
+      @thread = Thread.new do
+        Server.run! :port => port
+      end
+      sleep(1)
+      self
+    end
+
+    # Stop the SAM fake server
+    def stop_server
+      @thread.kill
+      self
+    end
+  end
+end

data/lib/nsicloudooo.rb

@@ -1,7 +1,11 @@
-require 'client'
-require 'fake_server'
+require File.dirname(__FILE__) + '/nsicloudooo/client'
+require File.dirname(__FILE__) + '/nsicloudooo/fake_server'
+require File.dirname(__FILE__) + '/nsicloudooo/errors'
+
+module NSISam
+end
+
 
 module NSICloudooo
-    include Client
-    include FakeServer
 end
+

data/nsicloudooo.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "nsicloudooo"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Douglas Camata"]
@@ -20,14 +20,14 @@ Gem::Specification.new do |s|
     ".document",
     ".rspec",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
     "VERSION",
-    "lib/client.rb",
-    "lib/errors.rb",
     "lib/nsicloudooo.rb",
+    "lib/nsicloudooo/client.rb",
+    "lib/nsicloudooo/errors.rb",
+    "lib/nsicloudooo/fake_server.rb",
     "nsicloudooo.gemspec",
     "spec/nsicloudooo_spec.rb",
     "spec/spec_helper.rb"
@@ -42,12 +42,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
     else
+      s.add_dependency(%q<sinatra>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
@@ -55,6 +57,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     end
   else
+    s.add_dependency(%q<sinatra>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<yard>, ["~> 0.7"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])

data/spec/nsicloudooo_spec.rb

@@ -1,7 +1,72 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'base64'
+require 'nsisam'
 
-describe "Nsicloudooo" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+$folder = File.expand_path(File.dirname(__FILE__))
+
+describe NSICloudooo do
+
+  before :all do
+    @nsicloudooo = NSICloudooo::Client.new 'http://test:test@localhost:8886'
+    @fake_cloudooo = NSICloudooo::FakeServerManager.new.start_server
+  end
+
+  after :all do
+    @fake_cloudooo.stop_server
+  end
+
+  context "simple granulation" do
+    it "can send a document to be granulated by a cloudooo node" do
+      response = @nsicloudooo.granulate(:file => 'document', :filename => 'test.odt')
+      response.should_not be_nil
+      response["key"].should == "key for document test.odt"
+    end
+  end
+
+  context "granulation with conversion" do
+    it "can send document in a closed format to be granulated by a cloudooo node" do
+      response = @nsicloudooo.granulate(:file => 'document', :filename => 'test.doc')
+      response.should_not be_nil
+      response["key"].should == "key for document test.doc"
+    end
+  end
+
+  context "granulation with download" do
+    it "can download documents from a link to be granulated by a cloudooo node" do
+      response = @nsicloudooo.granulate(:doc_link => "http://doc_link/test.doc")
+      response.should_not be_nil
+      response["key"].should == "key for document test.doc"
+    end
   end
+
+  context "granualtion with callback" do
+    it "can send a document to be granulated by a cloudooo node and specify a callback url" do
+      response = @nsicloudooo.granulate(:file => 'document', :filename => 'test.odt', :callback => 'http://google.com')
+      response.should_not be_nil
+      response["key"].should == "key for document test.odt"
+      response["callback"].should == 'http://google.com'
+    end
+
+    it "can send a document to be granulated by a cloudooo node and specify the verb" do
+      response = @nsicloudooo.granulate(:file => 'document', :filename => 'test.odt', :callback => 'http://google.com', :verb => 'PUT')
+      response.should_not be_nil
+      response["key"].should == "key for document test.odt"
+      response["callback"].should == 'http://google.com'
+      response["verb"].should == 'PUT'
+    end
+  end
+
+  context "verify granulation" do
+    it "can verify is a granulation is done or no" do
+      key = @nsicloudooo.granulate(:file => 'document', :filename => '2secs.odt')["key"]
+      @nsicloudooo.done(key)["done"].should be_false
+      @nsicloudooo.done(key)["done"].should be_true
+    end
+
+    it "raises an error whentrying to verify if non-existing key is done" do
+      expect { @nsicloudooo.done("dont")["done"].should be_false }.to raise_error(NSICloudooo::Errors::Client::KeyNotFoundError)
+    end
+  end
+
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nsicloudooo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -11,9 +11,20 @@ bindir: bin
 cert_chain: []
 date: 2012-03-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &15924680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *15924680
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70157113224960 !ruby/object:Gem::Requirement
+  requirement: &15923600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +32,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70157113224960
+  version_requirements: *15923600
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70157113223880 !ruby/object:Gem::Requirement
+  requirement: &15752860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70157113223880
+  version_requirements: *15752860
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70157113222920 !ruby/object:Gem::Requirement
+  requirement: &15751620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70157113222920
+  version_requirements: *15751620
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70157113221160 !ruby/object:Gem::Requirement
+  requirement: &15750640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70157113221160
+  version_requirements: *15750640
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70157113218800 !ruby/object:Gem::Requirement
+  requirement: &15749720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +76,7 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70157113218800
+  version_requirements: *15749720
 description: A simple gem to access a nsi.cloudooo node
 email: d.camata@gmail.com
 executables: []
@@ -77,14 +88,14 @@ files:
 - .document
 - .rspec
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
-- lib/client.rb
-- lib/errors.rb
 - lib/nsicloudooo.rb
+- lib/nsicloudooo/client.rb
+- lib/nsicloudooo/errors.rb
+- lib/nsicloudooo/fake_server.rb
 - nsicloudooo.gemspec
 - spec/nsicloudooo_spec.rb
 - spec/spec_helper.rb
@@ -103,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2043752576424527838
+      hash: 1497111065395602476
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/Gemfile.lock

@@ -1,33 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    diff-lcs (1.1.3)
-    git (1.2.5)
-    jeweler (1.8.3)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.6.5)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    yard (0.7.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.8.3)
-  rdoc (~> 3.12)
-  rspec (~> 2.8.0)
-  yard (~> 0.7)

data/lib/client.rb

@@ -1,55 +0,0 @@
-require "json"
-require "net/http"
-require "errors"
-
-module Client
-
-  class Client
-
-    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]
-    end
-
-    def granulate_doc(file, filename, options = {})
-      @request_data = Hash.new
-      if options[:doc_link]
-        insert_download_data options
-      else
-        @request_data.merge! {:file => file, :filename => filename}
-      end
-      insert_callback_data options
-      request = prepare_request :POST, @request_data
-      execute_request(request)
-    end
-
-    private
-
-    def insert_download_data(options)
-      @request_data.merge! {:doc_link => options[:doc_link]}
-    end
-
-    def insert_callback_data(options)
-        @request_data[:callback] = options[:callback] unless options[:callback].nil?
-        @request_data[:verb] = options[:verb] unless options[:verb].nil?
-    end
-
-    def prepare_request(verb, body)
-      verb = verb.to_s.capitalize!
-      request = Net::HTTP.const_get("#{verb}").new '/'
-      request.body = body
-      request.basic_auth @user, @password
-      request
-    end
-
-    def execute_request(request)
-      response = Net::HTTP.start @url, @port do |http|
-        http.request(request)
-      end
-      raise NSICloudooo::Errors::Client::KeyNotFoundError if response.code == "404"
-      JSON.parse(response.body)
-    end
-  end
-end