openstack 1.0.7 → 1.0.8

data/README.rdoc

@@ -195,7 +195,7 @@ See the class definitions for documentation on specific methods and operations.
   >> os.detach_volume(704289, 90805)
   => true
 
-== Examples for Volumes:
+== Examples for Volumes and Snaphots:
 
   #NOTE - attach/detach operations are implemented for the compute service as the OS API defines these operations as extensions to Openstack Compute.
 
@@ -227,6 +227,21 @@ See the class definitions for documentation on specific methods and operations.
   >> vs.delete_volume(90805)
   => true
 
+  # Create a snapshot: - must specify display_name and volume_id parameters... optionally also :display_description
+  >> vs.create_snapshot({:volume_id=>"3b38b570-a4ff-4444-984a-3566cbdc8ab2", :display_name=>"marios_snapshot"})
+  => #<OpenStack::Volume::Snapshot:0xa0cfea4 @id=223, @display_name="marios_snapshot", @display_description=nil, @volume_id="3b38b570-a4ff-4444-984a-3566cbdc8ab2", @status="creating", @size=1, @created_at="2013-01-23 14:25:02.654217">
+
+  # List snapshots: - aliased as just 'snapshots' ... vs.snapshots
+  >> vs.list_snapshots
+  => [#<OpenStack::Volume::Snapshot:0x9a6e4fc @id="0e76dacb-2fcf-4565-84a3-aa3d7bd16224", @display_name="marios_snapshot", @display_description=nil, @volume_id="3b38b570-a4ff-4444-984a-3566cbdc8ab2", @status="creating", @size=1, @created_at="2013-01-23T14:18:13.000000">]
+
+  # Get a specific snapshot: - aliased as 'snapshot'
+  >> vs.get_snapshot("0e76dacb-2fcf-4565-84a3-aa3d7bd16224")
+  => #<OpenStack::Volume::Snapshot:0x9a890b8 @id="0e76dacb-2fcf-4565-84a3-aa3d7bd16224", @display_name="marios_snapshot", @display_description=nil, @volume_id="3b38b570-a4ff-4444-984a-3566cbdc8ab2", @status="creating", @size=1, @created_at="2013-01-23T14:18:13.000000">
+
+  # Delete a snapshot:
+  >> vs.delete_snapshot("0e76dacb-2fcf-4565-84a3-aa3d7bd16224")
+  => true
 
 == Examples for Object-Store:
 

data/VERSION

@@ -1 +1 @@
-1.0.7
+1.0.8

data/lib/openstack.rb

@@ -45,6 +45,7 @@ module OpenStack
   require 'openstack/volume/connection'
   require 'openstack/volume/volume'
   require 'openstack/volume/snapshot'
+  require 'openstack/image/connection'
 
 
   # Constants that set limits on server creation

data/lib/openstack/connection.rb

@@ -65,7 +65,9 @@ class Connection
           OpenStack::Swift::Connection.new(connection)
         when "volume"
           OpenStack::Volume::Connection.new(connection)
-        else
+        when "image"
+          OpenStack::Image::Connection.new(connection)
+       else
           raise Exception::InvalidArgument, "Invalid :service_type parameter: #{@service_type}"
       end
     end

data/lib/openstack/image/connection.rb

@@ -0,0 +1,16 @@
+module OpenStack
+module Image
+
+  class Connection
+
+    attr_accessor   :connection
+
+    def initialize(connection)
+      @connection = connection
+      OpenStack::Authentication.init(@connection)
+    end
+
+  end
+
+end
+end

data/lib/openstack/volume/connection.rb

@@ -9,7 +9,8 @@ module Volume
     def initialize(connection)
       @connection = connection
       OpenStack::Authentication.init(@connection)
-      @volumes_native, @volume_path = check_if_native
+      @volumes_native, @volume_path = check_if_native("volumes")
+      @snapshots_native, @snapshot_path = check_if_native("snapshots")
     end
 
     # Returns true if the authentication was successful and returns false otherwise.
@@ -27,6 +28,7 @@ module Volume
       raise OpenStack::Exception::MissingArgument, ":display_name and :size must be specified to create a volume" unless (options[:display_name] && options[:size])
       data = JSON.generate(:volume => options)
       response = @connection.csreq("POST",@connection.service_host,"#{@connection.service_path}/#{@volume_path}",@connection.service_port,@connection.service_scheme,{'content-type' => 'application/json'},data)
+      OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
       volume_info = JSON.parse(response.body)["volume"]
       volume = OpenStack::Volume::Volume.new(volume_info)
     end
@@ -53,32 +55,63 @@ module Volume
       true
     end
 
-    #TODO SNAPSHOTS
+    def list_snapshots
+      response = @connection.req("GET", "/#{@snapshot_path}")
+      snapshot_hash = JSON.parse(response.body)["snapshots"]
+      snapshot_hash.inject([]){|res, current| res << OpenStack::Volume::Snapshot.new(current); res}
+    end
+    alias :snapshots :list_snapshots
+
+    def get_snapshot(snap_id)
+      response = @connection.req("GET", "/#{@snapshot_path}/#{snap_id}")
+      snapshot_hash = JSON.parse(response.body)["snapshot"]
+      OpenStack::Volume::Snapshot.new(snapshot_hash)
+    end
+    alias :snapshot :get_snapshot
+
+    #require params:  {:display_name, :volume_id}
+    #optional params: {:display_description, :metadata=>{:key=>val, ...}, :availability_zone, :volume_type }
+    #returns OpenStack::Volume::Snapshot object
+    def create_snapshot(options)
+      raise OpenStack::Exception::MissingArgument, ":volume_id and :display_name must be specified to create a snapshot" unless (options[:display_name] && options[:volume_id])
+      #:force documented in API but not explained... clarify (fails without)
+      options.merge!({:force=>"true"})
+      data = JSON.generate(:snapshot => options)
+      response = @connection.csreq("POST",@connection.service_host,"#{@connection.service_path}/#{@snapshot_path}",@connection.service_port,@connection.service_scheme,{'content-type' => 'application/json'},data)
+      OpenStack::Exception.raise_exception(response) unless response.code.match(/^20.$/)
+      snapshot_info = JSON.parse(response.body)["snapshot"]
+      OpenStack::Volume::Snapshot.new(snapshot_info)
+    end
+
+    def delete_snapshot(snap_id)
+      @connection.req("DELETE", "/#{@snapshot_path}/#{snap_id}")
+      true
+    end
 
     private
 
     #fudge... not clear if volumes support is available as 'native' volume API or
     #as the os-volumes extension. Need to probe to find out (for now)
     #see https://lists.launchpad.net/openstack/msg16601.html
-    def check_if_native
+    def check_if_native(entity) #volumes or snapshots
       native = extension = false
       #check if 'native' volume API present:
       begin
-        response = @connection.req("GET", "/volumes")
+        response = @connection.req("GET", "/#{entity}")
         native = true if response.code.match(/^20.$/)
-        return true, "volumes"
+        return true, entity
       rescue OpenStack::Exception::ItemNotFound => not_found
         native = false
       end
       #check if available as extension:
       begin
-        response = @connection.req("GET", "/os-volumes")
+        response = @connection.req("GET", "/os-#{entity}")
         extension = true if response.code.match(/^20.$/)
-        return false, "os-volumes"
+        return false, "os-#{entity}"
       rescue OpenStack::Exception::ItemNotFound => not_found
         extension = false
       end
-      raise OpenStack::Exception::NotImplemented.new("No Volumes support for this provider", 501, "No Volumes Support") unless (native || extension)
+      raise OpenStack::Exception::NotImplemented.new("No Volumes support for this provider", 501, "No #{entity} Support") unless (native || extension)
     end
 
 

data/lib/openstack/volume/snapshot.rb

@@ -0,0 +1,25 @@
+module OpenStack
+  module Volume
+    class Snapshot
+
+      attr_reader :id
+      attr_reader :display_name
+      attr_reader :display_description
+      attr_reader :volume_id
+      attr_reader :status
+      attr_reader :size
+      attr_reader :created_at
+
+      def initialize(snap_info)
+        @id = snap_info["id"]
+        @display_name = snap_info["display_name"] || snap_info["displayName"]
+        @display_description = snap_info["display_description"] || snap_info["displayDescription"]
+        @volume_id = snap_info["volume_id"] || snap_info["volumeId"]
+        @status = snap_info["status"]
+        @size  = snap_info["size"]
+        @created_at = snap_info["created_at"] || snap_info["createdAt"]
+      end
+
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstack
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-19 00:00:00.000000000 Z
+date: 2013-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -81,6 +81,7 @@ files:
 - lib/openstack/compute/personalities.rb
 - lib/openstack/compute/server.rb
 - lib/openstack/connection.rb
+- lib/openstack/image/connection.rb
 - lib/openstack/swift/connection.rb
 - lib/openstack/swift/container.rb
 - lib/openstack/swift/storage_object.rb