RubyGems - openstack-swift - Versions diffs - 0.1.1 → 0.2.0 - Mend

openstack-swift 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (54) hide show

data/Gemfile.lock +2 -2
data/README.rdoc +47 -0
data/doc/Gemfile.html +100 -0
data/doc/Object.html +177 -0
data/doc/Openstack.html +162 -0
data/doc/Openstack/Swift.html +182 -0
data/doc/Openstack/Swift/AuthenticationError.html +151 -0
data/doc/Openstack/Swift/Client.html +316 -0
data/doc/Openstack/Swift/UnauthorizedError.html +147 -0
data/doc/Openstack/Swift/WebApi.html +417 -0
data/doc/Rakefile.html +98 -0
data/doc/created.rid +11 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +88 -0
data/doc/js/darkfish.js +116 -0
data/doc/js/jquery.js +32 -0
data/doc/js/quicksearch.js +114 -0
data/doc/js/thickbox-compressed.js +10 -0
data/doc/lib/openstack-swift/client_rb.html +52 -0
data/doc/lib/openstack-swift/errors_rb.html +52 -0
data/doc/lib/openstack-swift/version_rb.html +52 -0
data/doc/lib/openstack-swift/web_api_rb.html +52 -0
data/doc/lib/openstack-swift_rb.html +66 -0
data/doc/rdoc.css +763 -0
data/doc/spec/openstack-swift/client_spec_rb.html +54 -0
data/doc/spec/openstack-swift/web_api_spec_rb.html +54 -0
data/doc/spec/spec_helper_rb.html +58 -0
data/lib/openstack-swift/api.rb +77 -1
data/lib/openstack-swift/client.rb +12 -57
data/lib/openstack-swift/errors.rb +1 -0
data/lib/openstack-swift/version.rb +1 -1
data/spec/openstack-swift/{web_api_spec.rb → api_spec.rb} +23 -2
data/spec/openstack-swift/client_spec.rb +19 -4
metadata +60 -16
data/openstack-swift-0.1.0.gem +0 -0

data/doc/spec/openstack-swift/client_spec_rb.html ADDED

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  <title>File: client_spec.rb [RDoc Documentation]</title>
+  <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+  <script src="../../js/jquery.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/thickbox-compressed.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/quicksearch.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/darkfish.js" type="text/javascript"
+    charset="utf-8"></script>
+</head>
+<body class="file file-popup">
+  <div id="metadata">
+    <dl>
+      <dt class="modified-date">Last Modified</dt>
+      <dd class="modified-date">2011-08-15 16:04:27 -0300</dd>
+      <dt class="requires">Requires</dt>
+      <dd class="requires">
+        <ul>
+          <li>openstack-swift</li>
+        </ul>
+      </dd>
+    </dl>
+  </div>
+  <div id="documentation">
+    <div class="description">
+      <h2>Description</h2>
+    </div>
+  </div>
+</body>
+</html>

data/doc/spec/openstack-swift/web_api_spec_rb.html ADDED

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  <title>File: web_api_spec.rb [RDoc Documentation]</title>
+  <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet" />
+  <script src="../../js/jquery.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/thickbox-compressed.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/quicksearch.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../../js/darkfish.js" type="text/javascript"
+    charset="utf-8"></script>
+</head>
+<body class="file file-popup">
+  <div id="metadata">
+    <dl>
+      <dt class="modified-date">Last Modified</dt>
+      <dd class="modified-date">2011-08-15 15:34:19 -0300</dd>
+      <dt class="requires">Requires</dt>
+      <dd class="requires">
+        <ul>
+          <li>openstack-swift</li>
+        </ul>
+      </dd>
+    </dl>
+  </div>
+  <div id="documentation">
+    <div class="description">
+      <h2>Description</h2>
+    </div>
+  </div>
+</body>
+</html>

data/doc/spec/spec_helper_rb.html ADDED

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  <title>File: spec_helper.rb [RDoc Documentation]</title>
+  <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet" />
+  <script src="../js/jquery.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../js/thickbox-compressed.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../js/quicksearch.js" type="text/javascript"
+    charset="utf-8"></script>
+  <script src="../js/darkfish.js" type="text/javascript"
+    charset="utf-8"></script>
+</head>
+<body class="file file-popup">
+  <div id="metadata">
+    <dl>
+      <dt class="modified-date">Last Modified</dt>
+      <dd class="modified-date">2011-08-15 15:33:54 -0300</dd>
+      <dt class="requires">Requires</dt>
+      <dd class="requires">
+        <ul>
+          <li>rubygems</li>
+          <li>bundler/setup</li>
+          <li>openstack-swift</li>
+        </ul>
+      </dd>
+    </dl>
+  </div>
+  <div id="documentation">
+    <div class="description">
+      <h2>Description</h2>
+    </div>
+  </div>
+</body>
+</html>

data/lib/openstack-swift/api.rb CHANGED

@@ -3,6 +3,7 @@ module Openstack
   module Swift
     module Api
       extend self
+      MAX_SIZE = 4 * 1024 ** 3
       # Authentication method to get the url and token to conect to swift
       # Returns:
@@ -121,8 +122,64 @@ module Openstack
         file.close rescue nil
       end
-      # Uploads a given object to a given container
+      # Delete a object for a given container and object name
+      def delete_object(url, token, container, object)
+        res = HTTParty.delete("#{url}/#{container}/#{object}", :headers => {"X-Auth-Token"=> token})
+        raise "Could not delete object '#{object}'" if res.code < 200 or res.code >= 300
+        true
+      end
+      # Delete all files listed on a manifest following the swift standard order
+      # What it does is try to delete all files in sequence from a given manifest until there are no files to delete
+      # returning a 404 error code. We don't know how many files are stored for a manifest file.
+      def delete_objects_from_manifest(url, token, container, manifest)
+        manifest_info = object_stat(url, token, container, manifest)
+        files_path = "#{manifest_info["x-object-manifest"]}%08d"
+        manifest_info["content-length"].to_i.times do |index|
+          res = HTTParty.delete("#{url}/#{files_path % index}", :headers => {"X-Auth-Token"=> token})
+          raise ObjectNotFoundError if res.code == 404
+        end
+      rescue ObjectNotFoundError
+        true
+      end
       def upload_object(url, token, container, file_path, options={})
+        options[:segments_size] ||= MAX_SIZE
+        create_container(url, token, container) rescue nil
+        file_name, file_mtime, file_size  = file_info(file_path)
+        if file_size > options[:segments_size]
+          create_container(url, token, "#{container}_segments") rescue nil
+          segments_minus_one = file_size / options[:segments_size]
+          last_piece = file_size - segments_minus_one * options[:segments_size]
+          segments_minus_one.times do |segment|
+            upload_segment(
+              url, token, "#{container}_segments", file_path,
+              :size => options[:segments_size],
+              :position => options[:segments_size] * segment,
+              :object_name => upload_path_for(file_path, segment)
+            )
+          end
+          upload_segment(
+            url, token, "#{container}_segments", file_path,
+            :size => last_piece,
+            :position => options[:segments_size] * segments_minus_one,
+            :object_name => upload_path_for(file_path, segments_minus_one)
+          )
+          create_manifest(url, token, container, file_path)
+        else
+          upload_segment(url, token, container, file_path)
+        end
+      end
+      # Uploads a given object to a given container
+      def upload_segment(url, token, container, file_path, options={})
         options[:object_name] ||= file_path.match(/.+\/(.+?)$/)[1]
         file = File.open(file_path, "rb")
@@ -142,6 +199,25 @@ module Openstack
       ensure
         file.close rescue nil
       end
+      private
+      # Returns the standard swift path for a given file path and segment
+      def upload_path_for(file_path, segment)
+       "%s/%s/%s/%08d" % (file_info(file_path) << segment)
+      end
+      # Get relevant informations about a file
+      # Returns an array with:
+      #   file_name
+      #   file_mtime
+      #   file_size
+      def file_info(file_path)
+       [
+         file_path.match(/.+\/(.+?)$/)[1],
+         File.mtime(file_path).to_f.round(2),
+         File.size(file_path)
+       ]
+      end
     end
   end
 end

data/lib/openstack-swift/client.rb CHANGED

@@ -2,9 +2,6 @@
 module Openstack
   module Swift
     class Client
-      SWIFT_API = Openstack::Swift::Api
-      MAX_SIZE = 4 * 1024 ** 3
       # Initialize method
       # It uses the authenticate method to store the tokens for future requests
       def initialize(proxy, user, password)
@@ -17,7 +14,7 @@ module Openstack
       # avoiding to request a new token for each request
       # It should be used to force a new token
       def authenticate!
-        @url, _, @token = SWIFT_API.auth(@proxy, @user, @password)
+        @url, _, @token = Api.auth(@proxy, @user, @password)
         if @url.blank? or @token.blank?
           raise AuthenticationError
@@ -31,7 +28,7 @@ module Openstack
       #   object_count: Number of objects that this account have allocated
       #   container_count: Number of container
       def account_info
-        headers = SWIFT_API.account(@url, @token)
+        headers = Api.account(@url, @token)
         {
           "bytes_used" => headers["x-account-bytes-used"],
           "object_count" => headers["x-account-object-count"],
@@ -46,7 +43,7 @@ module Openstack
       #   manifest
       #   content_length
       def object_info(container, object)
-        headers = SWIFT_API.object_stat(@url, @token, container, object)
+        headers = Api.object_stat(@url, @token, container, object)
         {
           "last_modified" => headers["last-modified"],
           "md5" => headers["etag"],
@@ -58,63 +55,21 @@ module Openstack
       # This method uploads a file from a given to a given container
       def upload(container, file_path, options={})
-        options[:segments_size] ||= MAX_SIZE
-        SWIFT_API.create_container(@url, @token, container) rescue nil
-        file_name, file_mtime, file_size  = file_info(file_path)
-        if file_size > options[:segments_size]
-          SWIFT_API.create_container(@url, @token, "#{container}_segments") rescue nil
-          segments_minus_one = file_size / options[:segments_size]
-          last_piece = file_size - segments_minus_one * options[:segments_size]
-          segments_minus_one.times do |segment|
-            upload_path_for(file_path, segment)
-            SWIFT_API.upload_object(
-              @url, @token, "#{container}_segments", file_path,
-              :size => options[:segments_size],
-              :position => options[:segments_size] * segment,
-              :object_name => segment_path
-            )
-          end
-          SWIFT_API.upload_object(
-            @url, @token, "#{container}_segments", file_path,
-            :size => last_piece,
-            :position => options[:segments_size] * segments_minus_one,
-            :object_name => upload_path_for(file_path, segments_minus_one)
-          )
-          SWIFT_API.create_manifest(@url, @token, container, file_path)
-        else
-          SWIFT_API.upload_object(@url, @token, container, file_path)
-        end
+        Api.upload_object(@url, @token, container, file_path, options)
       end
       # This method downloads a object from a given container
       def download(container, object)
-        SWIFT_API.download_object(@url, @token, container, object)
+        Api.download_object(@url, @token, container, object)
       end
-     private
-      # Returns the standard swift path for a given file path and segment
-      def upload_path_for(file_path, segment)
-        "%s/%s/s/%08d" % (file_info(file_path) << segment)
-      end
-      # Get relevant informations about a file
-      # Returns an array with:
-      #   file_name
-      #   file_mtime
-      #   file_size
-      def file_info(file_path)
-        [
-          file_path.match(/.+\/(.+?)$/)[1],
-          File.mtime(file_path).to_f.round(2),
-          File.size(file_path)
-        ]
+      # Delete a given object from a given container
+      def delete(container, object)
+        if object_info(container, object)["manifest"]
+          Api.delete_objects_from_manifest(@url, @token, container, object)
+        else
+          Api.delete_object(@url, @token, container, object)
+        end
       end
     end
   end

data/lib/openstack-swift/errors.rb CHANGED

@@ -1,4 +1,5 @@
 # -*- coding: UTF-8 -*-
 module Openstack::Swift
   class AuthenticationError < Exception; end
+  class ObjectNotFoundError < Exception; end
 end

data/lib/openstack-swift/version.rb CHANGED

@@ -1,6 +1,6 @@
 # -*- coding: UTF-8 -*-
 module Openstack
   module Swift
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/spec/openstack-swift/{web_api_spec.rb → api_spec.rb} RENAMED

@@ -33,7 +33,7 @@ describe Openstack::Swift::Api do
   end
   context "when authenticated" do
-    let!(:swift_dummy_file){ File.open("/tmp/swift-dummy", "w") {|f| f.puts("test file"*1000)} }
+    let!(:swift_dummy_file){ File.open("/tmp/swift-dummy", "w") {|f| f.puts("test file"*2000)}; "/tmp/swift-dummy" }
     before do
       @url, _, @token = subject.auth(
@@ -70,10 +70,31 @@ describe Openstack::Swift::Api do
       subject.create_container(@url, @token, "pothix_container").should be_true
     end
+    context "whe excluding an object" do
+      before { @container = "morellon" }
+      it "should delete an existent object" do
+        subject.upload_object(@url, @token, @container, "/tmp/swift-dummy").should be_true
+        subject.delete_object(@url, @token, @container, "swift-dummy").should be_true
+      end
+    end
+    context "when excluding all objects from a manifest" do
+      it "should remove all objects from a given manifest" do
+        container = "multiseg"
+        subject.upload_object(@url, @token, container, swift_dummy_file, {:segments_size => 1024})
+        manifest = subject.object_stat(@url, @token, container, "swift-dummy")["x-object-manifest"]
+        segment_path = manifest.split("/")[1..-1].join("/") + "/00000000"
+        subject.object_stat(@url, @token, "#{container}_segments", segment_path)["etag"].should_not be_nil
+        subject.delete_objects_from_manifest(@url, @token, container, "swift-dummy").should be_true
+        subject.object_stat(@url, @token, "#{container}_segments", segment_path)["etag"].should be_nil
+      end
+    end
     context "when excluding a container" do
       before { @container = "pothix_container" }
-      it "should delete a existent container" do
+      it "should delete an existent container" do
         subject.create_container(@url, @token, @container).should be_true
         subject.delete_container(@url, @token, @container).should be_true
       end

data/spec/openstack-swift/client_spec.rb CHANGED

@@ -25,10 +25,11 @@ describe "Openstack::Swift::Client" do
   context "when authenticated" do
     subject { Openstack::Swift::Client.new(Openstack::SwiftConfig[:url], Openstack::SwiftConfig[:user], Openstack::SwiftConfig[:pass]) }
-    it "should upload a splitted file and create its manifest" do
-      pending "WTF...Not working for a unknown reason"
-      subject.upload("pothix", swift_dummy_file, {:segments_size => 1024*2})
-      subject.object_info("pothix", "swifty-dummy")["manifest"].should_not be_nil
+    it "should try to upload" do
+      expect {
+        subject.upload("pothix", swift_dummy_file, {:segments_size => 1024*2})
+      }.to_not raise_error
+      subject.object_info("pothix", "swift-dummy")["manifest"].should_not be_nil
     end
     it "should download an splitted file" do
@@ -43,5 +44,19 @@ describe "Openstack::Swift::Client" do
       account_info.should have_key("object_count")
       account_info.should have_key("container_count")
     end
+    context "when deleting" do
+      it "should call the delete method for a non manifest file" do
+        Openstack::Swift::Api.should_receive(:object_stat).and_return({"x-object-manifest" => nil})
+        Openstack::Swift::Api.should_receive(:delete_object)
+        subject.delete("pothix","swift-dummy")
+      end
+      it "should call the delete_objects_from_manifest method for a manifest file" do
+        Openstack::Swift::Api.should_receive(:object_stat).and_return({"x-object-manifest" => "pothix_segments/swift-dummy/1313763802.0/9001/"})
+        Openstack::Swift::Api.should_receive(:delete_objects_from_manifest)
+        subject.delete("pothix","swift-dummy")
+      end
+    end
   end
 end