fog-openstack 0.1.10 → 0.1.11

data/lib/fog/storage/openstack/requests/head_container.rb

@@ -0,0 +1,26 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+        # List number of objects and total bytes stored
+        #
+        # ==== Parameters
+        # * container<~String> - Name of container to retrieve info for
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * headers<~Hash>:
+        #     * 'X-Container-Object-Count'<~String> - Count of containers
+        #     * 'X-Container-Bytes-Used'<~String>   - Bytes used
+        def head_container(container)
+          request(
+            :expects => 204,
+            :method  => 'HEAD',
+            :path    => Fog::OpenStack.escape(container),
+            :query   => {'format' => 'json'}
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/openstack/requests/head_containers.rb

@@ -0,0 +1,23 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+        # List number of containers and total bytes stored
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * headers<~Hash>:
+        #     * 'X-Account-Container-Count'<~String> - Count of containers
+        #     * 'X-Account-Bytes-Used'<~String> - Bytes used
+        def head_containers
+          request(
+            :expects => 200..299,
+            :method  => 'HEAD',
+            :path    => '',
+            :query   => {'format' => 'json'}
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/openstack/requests/head_object.rb

@@ -0,0 +1,21 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+        # Get headers for object
+        #
+        # ==== Parameters
+        # * container<~String> - Name of container to look in
+        # * object<~String> - Name of object to look for
+        #
+        def head_object(container, object)
+          request({
+                    :expects => 200,
+                    :method  => 'HEAD',
+                    :path    => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}"
+                  }, false)
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/openstack/requests/post_set_meta_temp_url_key.rb

@@ -0,0 +1,33 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+        # Set the account wide Temp URL Key. This is a secret key that's
+        # used to generate signed expiring URLs.
+        #
+        # Once the key has been set with this request you should create new
+        # Storage objects with the :openstack_temp_url_key option then use
+        # the get_object_https_url method to generate expiring URLs.
+        #
+        # *** CAUTION *** changing this secret key will invalidate any expiring
+        # URLS generated with old keys.
+        #
+        # ==== Parameters
+        # * key<~String> - The new Temp URL Key
+        #
+        # ==== Returns
+        # * response<~Excon::Response>
+        #
+        # ==== See Also
+        # http://docs.rackspace.com/files/api/v1/cf-devguide/content/Set_Account_Metadata-d1a4460.html
+        def post_set_meta_temp_url_key(key)
+          request(
+            :expects => [201, 202, 204],
+            :method  => 'POST',
+            :headers => {'X-Account-Meta-Temp-Url-Key' => key}
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/openstack/requests/public_url.rb

@@ -0,0 +1,26 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+        # Get public_url for an object
+        #
+        # ==== Parameters
+        # * container<~String> - Name of container to look in
+        # * object<~String> - Name of object to look for
+        #
+        def public_url(container = nil, object = nil)
+          return nil if container.nil?
+          u = "#{url}/#{Fog::OpenStack.escape(container)}"
+          u << "/#{Fog::OpenStack.escape(object)}" unless object.nil?
+          u
+        end
+
+        private
+
+        def url
+          "#{@scheme}://#{@host}:#{@port}#{@path}"
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/openstack/requests/put_container.rb

@@ -0,0 +1,24 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+        # Create a new container
+        #
+        # ==== Parameters
+        # * name<~String> - Name for container, should be < 256 bytes and must not contain '/'
+        #
+        def put_container(name, options = {})
+          headers = options[:headers] || {}
+          headers['X-Container-Read'] = '.r:*' if options[:public]
+          headers['X-Remove-Container-Read'] = 'x' if options[:public] == false
+          request(
+            :expects => [201, 202],
+            :method  => 'PUT',
+            :path    => Fog::OpenStack.escape(name),
+            :headers => headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/openstack/requests/put_dynamic_obj_manifest.rb

@@ -0,0 +1,41 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+        # Create a new dynamic large object manifest
+        #
+        # Creates an object with a +X-Object-Manifest+ header that specifies the common prefix ("<container>/<prefix>")
+        # for all uploaded segments. Retrieving the manifest object streams all segments matching this prefix.
+        # Segments must sort in the order they should be concatenated. Note that any future objects stored in the container
+        # along with the segments that match the prefix will be included when retrieving the manifest object.
+        #
+        # All segments must be stored in the same container, but may be in a different container than the manifest object.
+        # The default +X-Object-Manifest+ header is set to "+container+/+object+", but may be overridden in +options+
+        # to specify the prefix and/or the container where segments were stored.
+        # If overridden, names should be CGI escaped (excluding spaces) if needed (see {Fog::OpenStack.escape}).
+        #
+        # @param container [String] Name for container where +object+ will be stored. Should be < 256 bytes and must not contain '/'
+        # @param object [String] Name for manifest object.
+        # @param options [Hash] Config headers for +object+.
+        # @option options [String] 'X-Object-Manifest' ("container/object") "<container>/<prefix>" for segment objects.
+        #
+        # @raise [Fog::Storage::OpenStack::NotFound] HTTP 404
+        # @raise [Excon::Errors::BadRequest] HTTP 400
+        # @raise [Excon::Errors::Unauthorized] HTTP 401
+        # @raise [Excon::Errors::HTTPStatusError]
+        #
+        # @see http://docs.openstack.org/api/openstack-object-storage/1.0/content/dynamic-large-object-creation.html
+        def put_dynamic_obj_manifest(container, object, options = {})
+          path = "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}"
+          headers = {'X-Object-Manifest' => path}.merge(options)
+          request(
+            :expects => 201,
+            :headers => headers,
+            :method  => 'PUT',
+            :path    => path
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/openstack/requests/put_object.rb

@@ -0,0 +1,41 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+        # Create a new object
+        #
+        # When passed a block, it will make a chunked request, calling
+        # the block for chunks until it returns an empty string.
+        # In this case the data parameter is ignored.
+        #
+        # ==== Parameters
+        # * container<~String> - Name for container, should be < 256 bytes and must not contain '/'
+        # * object<~String> - Name for object
+        # * data<~String|File> - data to upload
+        # * options<~Hash> - config headers for object. Defaults to {}.
+        # * block<~Proc> - chunker
+        #
+        def put_object(container, object, data, options = {}, &block)
+          if block_given?
+            params = {:request_block => block}
+            headers = options
+          else
+            data = Fog::Storage.parse_data(data)
+            headers = data[:headers].merge!(options)
+            params = {:body => data[:body]}
+          end
+
+          params.merge!(
+            :expects    => 201,
+            :idempotent => !params[:request_block],
+            :headers    => headers,
+            :method     => 'PUT',
+            :path       => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}"
+          )
+
+          request(params)
+        end
+      end
+    end
+  end
+end

data/lib/fog/storage/openstack/requests/put_static_obj_manifest.rb

@@ -0,0 +1,55 @@
+module Fog
+  module Storage
+    class OpenStack
+      class Real
+        # Create a new static large object manifest.
+        #
+        # A static large object is similar to a dynamic large object. Whereas a GET for a dynamic large object manifest
+        # will stream segments based on the manifest's +X-Object-Manifest+ object name prefix, a static large object
+        # manifest streams segments which are defined by the user within the manifest. Information about each segment is
+        # provided in +segments+ as an Array of Hash objects, ordered in the sequence which the segments should be streamed.
+        #
+        # When the SLO manifest is received, each segment's +etag+ and +size_bytes+ will be verified.
+        # The +etag+ for each segment is returned in the response to {#put_object}, but may also be calculated.
+        # e.g. +Digest::MD5.hexdigest(segment_data)+
+        #
+        # The maximum number of segments for a static large object is 1000, and all segments (except the last) must be
+        # at least 1 MiB in size. Unlike a dynamic large object, segments are not required to be in the same container.
+        #
+        # @example
+        #   segments = [
+        #     { :path => 'segments_container/first_segment',
+        #       :etag => 'md5 for first_segment',
+        #       :size_bytes => 'byte size of first_segment' },
+        #     { :path => 'segments_container/second_segment',
+        #       :etag => 'md5 for second_segment',
+        #       :size_bytes => 'byte size of second_segment' }
+        #   ]
+        #   put_static_obj_manifest('my_container', 'my_large_object', segments)
+        #
+        # @param container [String] Name for container where +object+ will be stored.
+        #     Should be < 256 bytes and must not contain '/'
+        # @param object [String] Name for manifest object.
+        # @param segments [Array<Hash>] Segment data for the object.
+        # @param options [Hash] Config headers for +object+.
+        #
+        # @raise [Fog::Storage::OpenStack::NotFound] HTTP 404
+        # @raise [Excon::Errors::BadRequest] HTTP 400
+        # @raise [Excon::Errors::Unauthorized] HTTP 401
+        # @raise [Excon::Errors::HTTPStatusError]
+        #
+        # @see http://docs.openstack.org/api/openstack-object-storage/1.0/content/static-large-objects.html
+        def put_static_obj_manifest(container, object, segments, options = {})
+          request(
+            :expects => 201,
+            :method  => 'PUT',
+            :headers => options,
+            :body    => Fog::JSON.encode(segments),
+            :path    => "#{Fog::OpenStack.escape(container)}/#{Fog::OpenStack.escape(object)}",
+            :query   => {'multipart-manifest' => 'put'}
+          )
+        end
+      end
+    end
+  end
+end

data/lib/fog/volume/openstack.rb

@@ -0,0 +1,30 @@
+
+
+module Fog
+  module Volume
+    class OpenStack < Fog::Service
+      @@recognizes = [:openstack_auth_token, :openstack_management_url,
+                      :persistent, :openstack_service_type, :openstack_service_name,
+                      :openstack_tenant, :openstack_tenant_id,
+                      :openstack_api_key, :openstack_username, :openstack_identity_endpoint,
+                      :current_user, :current_tenant, :openstack_region,
+                      :openstack_endpoint_type, :openstack_cache_ttl,
+                      :openstack_project_name, :openstack_project_id,
+                      :openstack_project_domain, :openstack_user_domain, :openstack_domain_name,
+                      :openstack_project_domain_id, :openstack_user_domain_id, :openstack_domain_id,
+                      :openstack_identity_prefix]
+
+      # Fog::Image::OpenStack.new() will return a Fog::Volume::OpenStack::V2 or a Fog::Volume::OpenStack::V1,
+      #  choosing the V2 by default, as V1 is deprecated since OpenStack Juno
+      def self.new(args = {})
+        @openstack_auth_uri = URI.parse(args[:openstack_auth_url]) if args[:openstack_auth_url]
+        service = if inspect == 'Fog::Volume::OpenStack'
+                    Fog::Volume::OpenStack::V2.new(args) || Fog::Volume::OpenStack::V1.new(args)
+                  else
+                    super
+                  end
+        service
+      end
+    end
+  end
+end

data/lib/fog/volume/openstack/models/availability_zone.rb

@@ -0,0 +1,10 @@
+require 'fog/openstack/models/model'
+
+module Fog
+  module Volume
+    class OpenStack
+      class AvailabilityZone < Fog::OpenStack::Model
+      end
+    end
+  end
+end

data/lib/fog/volume/openstack/models/transfer.rb

@@ -0,0 +1,28 @@
+require 'fog/openstack/models/model'
+
+module Fog
+  module Volume
+    class OpenStack
+      class Transfer < Fog::OpenStack::Model
+        def save
+          requires :name, :volume_id
+          data = service.create_transfer(volume_id, :name => name)
+          merge_attributes(data.body['transfer'])
+          true
+        end
+
+        def destroy
+          requires :id
+          service.delete_transfer(id)
+          true
+        end
+
+        def initialize(attributes)
+          # Old 'connection' is renamed as service and should be used instead
+          prepare_service_value(attributes)
+          super
+        end
+      end
+    end
+  end
+end

data/lib/fog/volume/openstack/models/transfers.rb

@@ -0,0 +1,34 @@
+require 'fog/openstack/models/collection'
+
+module Fog
+  module Volume
+    class OpenStack
+      module Transfers
+        def all(options = {})
+          load_response(service.list_transfers_detailed(options), 'transfers')
+        end
+
+        def summary(options = {})
+          load_response(service.list_transfers(options), 'transfers')
+        end
+
+        def get(transfer_id)
+          if transfer = service.get_transfer_details(transfer_id).body['transfer']
+            new(transfer)
+          end
+        rescue Fog::Volume::OpenStack::NotFound
+          nil
+        end
+
+        def accept(transfer_id, auth_key)
+          # NOTE: This is NOT a method on the Transfer object, since the
+          # receiver cannot see the transfer object in the get_transfer_details
+          # or list_transfers(_detailed) requests.
+          if transfer = service.accept_transfer(transfer_id, auth_key).body['transfer']
+            new(transfer)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/volume/openstack/models/volumes.rb

@@ -0,0 +1,35 @@
+require 'fog/openstack/models/collection'
+
+module Fog
+  module Volume
+    class OpenStack
+      module Volumes
+        def all(options = {})
+          # the parameter has been "detailed = true" before. Make sure we are
+          # backwards compatible
+          detailed = options.kind_of?(Hash) ? options.delete(:detailed) : options
+          if detailed.nil? || detailed
+            # This method gives details by default, unless false or {:detailed => false} is passed
+            load_response(service.list_volumes_detailed(options), 'volumes')
+          else
+            Fog::Logger.deprecation('Calling OpenStack[:volume].volumes.all(false) or volumes.all(:detailed => false) '\
+                                    ' is deprecated, call .volumes.summary instead')
+            load_response(service.list_volumes(options), 'volumes')
+          end
+        end
+
+        def summary(options = {})
+          load_response(service.list_volumes(options), 'volumes')
+        end
+
+        def get(volume_id)
+          if volume = service.get_volume_details(volume_id).body['volume']
+            new(volume)
+          end
+        rescue Fog::Volume::OpenStack::NotFound
+          nil
+        end
+      end
+    end
+  end
+end