ropenstack 1.2.1 → 2.0.0

data/lib/ropenstack/identity.rb

@@ -0,0 +1,28 @@
+require 'ropenstack/common/rest'
+
+module Ropenstack
+  ##
+  # * Name: Identity	
+  # * Description: An implementation of the Identity API Client in Ruby
+  # * Author: Sam 'Tehsmash' Betts, John Davidge
+  # * Date: 30/16/2014
+  ##
+  class Identity < OpenstackService
+    # Pull in sub-modules.
+    require 'ropenstack/identity/v2'
+    require 'ropenstack/identity/v3'
+
+    def initialize(location, port, token, type)
+      super(location + ":" + port.to_s, token)
+      case type
+      when "identityv2" then extend Version2
+      when "identityv3" then extend Version3
+      else
+        raise Ropenstack::RopenstackError, "Invalid Type Passed to Identity"
+      end
+      unless token.nil?
+        @data = { "access" => { "token" => { "id" => token } } } 
+      end
+    end
+  end
+end

data/lib/ropenstack/identity/v2.rb

@@ -0,0 +1,178 @@
+module Ropenstack
+  ##
+  # * Name: IdentityVersion2
+  # * Description: An implementation of the V2.0 Identity API Client in Ruby
+  # * Author: Sam 'Tehsmash' Betts, John Davidge
+  # * Date: 30/06/2014
+  ##
+  module Identity::Version2
+          ##
+          # Authenticate via keystone, unless a token and tenant are defined then a unscoped 
+          # token is returned with all associated data and stored in the @data variable. 
+          # Does not return anything, but all data is accessible through accessor methods.
+          ## 	
+          def authenticate(username, password, tenant = nil)
+                  data = {
+                          "auth" => { 
+                                  "passwordCredentials" => { 
+                                          "username" => username, 
+                                          "password" => password 
+                                  } 
+                          } 
+                  }
+                  unless tenant.nil?
+                          data["auth"]["tenantName"] = tenant
+                  end
+                  @data = post_request(address("/tokens"), data, @token)
+          end
+
+          ##
+          # Scope token provides two ways to call it:
+          # 	scope_token(tenantName) => Just using the current token and a tenantName it
+          # 				   scopes in the token. Token stays the same.
+          #	scope_token(username, password, tenantName) => This uses the username and 
+          #				   password to reauthenticate with a tenant. The 
+          #				   token changes.
+          ##
+          def scope_token(para1, para2 = nil, para3 = nil)
+                  if ( para2.nil? )
+                          data = { "auth" => { "tenantName" => para1, "token" => { "id" => token() } } }
+                          @data = post_request(address("/tokens"), data, token())
+                  else 
+                          authenticate(para1, para2, token(), para3)			
+                  end
+          end
+
+          ##
+          # Return the raw @data hash with all the data from authentication.
+          ##
+          def raw()
+                  return @data		
+          end
+
+          ##
+          # Gets the authentication token from the hash and returns it as a string.
+          ##
+          def token(token = nil)
+                  if token.nil?
+                          return @data["access"]["token"]["id"] 
+                  else
+                          get_request(address("/tokens/#{token}"), token())
+                  end
+          end
+
+          ##
+          # TODO Add head version of tokens call
+          ##
+          def token?(token)
+                  return false
+          end
+
+          ##
+          # This returns the token and all metadata associated with the token, 
+          # including the tenant information.
+          ##
+          def token_metadata()
+                  return @data["access"]["token"]
+          end
+
+          ##
+          # Return the user hash from the authentication data 
+          ##
+          def user()
+                  return @data["access"]["user"]
+          end
+
+          ##
+          # Returns true if a user is admin.
+          ##
+          def admin()
+                  @data["access"]["user"]["roles"].each do |role|
+                          if role["name"].eql?("admin")
+                                  return true
+                          end
+                  end
+                  return false
+          end
+
+          ##
+          # Get the service catalog returned by Identity on authentication.
+          ##
+          def services()
+                  return @data["access"]["serviceCatalog"]
+          end 
+
+          ##
+          # Get the tenant id from the @data 
+          ##
+          def tenant_id()
+                  return @data["access"]["token"]["tenant"]["id"]
+          end
+
+          def tenant_name()
+                  return @data["access"]["token"]["tenant"]["name"] 
+          end
+
+          # Separate Identity Calls 
+
+          def tenant_list()
+                  return get_request(address('/tenants'), token()) 
+          end
+          
+          ##
+          # Add a service to the keystone services directory
+          ##
+          def add_to_services(name, type, description)
+                  data = {
+                          'OS-KSADM:service' => {
+                                   'name' => name,
+                                   'type' => type,
+                                   'description' => description
+                          }
+                  }
+                  return post_request(address("/OS-KSADM/services"), data, token())
+          end
+          
+          ##
+          # Get list of services
+          ##
+          def get_services()
+                  return get_request(address("/OS-KSADM/services"), token())
+          end
+
+          ##
+          # Add an endpoint list
+          ##
+          def add_endpoint(region, service_id, publicurl, adminurl, internalurl)
+                  data = {
+                          'endpoint' => {
+                                  'region' => region,
+                                  'service_id' => service_id,
+                                  'publicurl' => publicurl,
+                                  'adminurl' => adminurl,
+                                  'internalurl' => internalurl
+                          }
+                  }
+                  return post_request(address("/endpoints"), data, token())
+          end
+
+          ##
+          # Get the endpoint list
+          ##
+          def get_endpoints(token = nil)
+                  if token.nil?
+                          return get_request(address("/endpoints"), token())
+                  else
+                          return get_request(address("/tokens/#{token}/endpoints"), token())
+                  end
+          end
+
+    def address(endpoint)
+      super("/v2.0/" + endpoint)
+    end
+
+    def version
+      "V2"
+    end
+  end
+end

data/lib/ropenstack/identity/v3.rb

@@ -0,0 +1,13 @@
+module Ropenstack
+  ##
+  # * Name: IdentityVersion3
+  # * Description: An implementation of the V3.0 Identity API Client in Ruby
+  # * Author: Sam 'Tehsmash' Betts, John Davidge
+  # * Date: 30/06/2014
+  ##
+  module Identity::Version3
+    def version
+      "V3"
+    end
+  end
+end

data/lib/ropenstack/image.rb

@@ -0,0 +1,25 @@
+require 'ropenstack/common/rest'
+
+module Ropenstack
+  ##
+  # * Name: Image
+	# * Description: Implementation of the Glance API Client in Ruby
+	# * Author: Sam 'Tehsmash' Betts, John Davidge
+	# * Date: 30/06/2014
+  ##
+  class Image < OpenstackService
+    # Pull in sub-modules
+    require 'ropenstack/image/v1'
+    require 'ropenstack/image/v2'
+
+    def initialize(location, token, type)
+      super(location, token)
+      case type
+      when "image" then extend Version1
+      when "imagev2" then extend Version2
+      else
+        raise Ropenstack::RopenstackError, "Invalid type passed to Image"
+      end
+     end
+  end
+end

data/lib/ropenstack/image/v1.rb

@@ -0,0 +1,107 @@
+module Ropenstack
+  ##
+  # * Name: ImageVersion1
+  # * Description: Implementation of the Glance V1.0 API Client in Ruby
+  # * Author: Sam 'Tehsmash' Betts, John Davidge
+  # * Date: 30/06/2014
+  ##
+  module Image::Version1
+
+    ##
+    # No ID provided - Lists details for available images.
+    # ID provided - Shows the image details as headers and the image binary in the body.
+    ##
+    def images(id, tenant_id)
+      if id.nil?
+        return get_request(address(tenant_id, "images/detail"), @token)
+      else
+        return get_request(address(tenant_id, "images/" + id), @token)
+      end
+    end
+
+    ##
+    # Registers a virtual machine image.
+    ##
+    def image_create(name, disk_format, container_format, create_image, tenant_id)
+      data = { 
+        :name => name,
+        :disk_format => disk_format,
+        :container_format => container_format
+      }
+      unless create_image.nil?
+        data[:create_image] = create_image
+      end
+
+      post_request(address(tenant_id, "images"), data, @token)
+    end
+
+    ##
+    # Updates an image, uploads an image file, or updates metadata for an image.
+    # NOT IMPLEMENTED
+    ##
+    def image_update(id, tenant_id)
+      raise Ropenstack::RopenstackError, "Update Method Not Implemented."
+    end
+
+    ##
+    # Deletes the specified image.
+    ##
+    def image_delete(id, tenant_id)
+      delete_request(address(tenant_id, "images/" + id), @token)
+    end
+
+    ##
+    # Replaces the membership list for an image.
+    # @param memberships List of memberships in format [{'member_id': 'tenant1', 'can_share': 'false'}]
+    ##
+    def replace_memberships(id, memberships, tenant_id)
+      data = {
+        :memberships => memberships
+      }
+      put_request(address(tenant_id, "images/" + id + "/members"), data, @token)
+    end
+
+    ##
+    # Adds a member to an image.
+    # @param member_id The member to be added
+    # @param can_share Optional boolean specifiying can_share value. Will default to false.
+    ##
+    def add_member(id, member_id, can_share, tenant_id)
+      if can_share.nil?
+        data = {
+          :member => {:can_share => false}
+        }
+      else
+        data = {
+          :member => {:can_share => can_share}
+        }
+      end
+      put_request(address(tenant_id, "images/" + id + "/members/" + member_id), data, @token)
+    end
+
+    ##
+    # Removes a member from an image
+    ##
+    def delete_member(id, member_id, tenant_id)
+      delete_request(address(tenant_id, "images/" + id + "/members/" + member_id), @token)
+    end
+
+    ##
+    # Lists the images shared with a specified owner.
+    ##
+    def shared_images(id, owner_id, tenant_id)
+      get_request(address(tenant_id, "shared-images/" + owner_id), @token)
+    end
+
+    ##
+    # Returns the v1 address location of an endpoint.
+    ##
+    def address(tenant_id, endpoint)
+      address("/v1/#{tenant_id}/#{endpoint}")
+    end
+
+    def version
+      "V1"
+    end
+  end
+end

data/lib/ropenstack/image/v2.rb

@@ -0,0 +1,134 @@
+module Ropenstack
+  ##
+  # * Name: ImageVersion2
+  # * Description: Implementation of the Glance V2.0 API Client in Ruby
+  # * Author: Sam 'Tehsmash' Betts, John Davidge
+  # * Date: 30/06/2014
+  ##
+  module Image::Version2
+    ##
+    # Returns a list of images with all associated meta-data in 
+    # hash format.
+    ##
+    def images(id)
+      if id.nil?
+        return get_request(address("images"), @token)["images"]
+      else
+        return get_request(address("images/" + id), @token)
+      end
+    end
+
+    def image_create(name, id, visibilty, tags)
+      data = { 
+        :name => name
+      }
+      unless id.nil?
+        data[:id] = id
+      end
+      unless visibility.nil?
+        data[:visibility] = visibility
+      end
+      unless tags.nil?
+        data[:tags] = tags
+      end
+
+      post_request(address("images"), data, @token)
+    end
+
+    def image_delete(id)
+      delete_request(address("images/" + id), @token)
+    end
+
+    # TODO Ruby HTTP Binary Download to FILE
+    def image_download(id)
+    end
+
+    def image_add_tag(id, tag)
+      put_request(address("images/"+id+"/tags/"+tag), @token)
+    end
+
+    def image_delete_tag(id)
+      delete_request(address("images/"+id+"/tags/"+tag), @token)
+    end
+
+    ## Members
+    def members(id)
+    end
+
+    def member_add()
+    end
+
+    def member_delete()
+    end
+
+    def member_update()
+    end
+
+    ## Schemas
+    def schemas(type)
+      return get_request(address("schemas/" + type), @token)
+    end
+
+
+    ## BELOW HERE IS OLD CODE THAT MAY OR MAYNOT WORK, THAR BE DRAGONS
+
+    ##
+    # Upload an image to the Image Service from a file, takes in a ruby file object. 
+    # More convoluted than it should be because for a bug in Quantum
+    # which just returns an error no matter the outcome.
+    ## 
+    def upload_image_from_file(name, disk_format, container_format, minDisk, minRam, is_public, file)
+      data = {
+        "name" => name,
+        "disk_format" => disk_format,
+        "container_format" => container_format,
+        "minDisk" => minDisk,
+        "minRam" => minRam,
+        "public" => is_public
+      }
+      imagesBefore = images()
+      post_request(address("images"), data, @token, false)
+      imagesAfter = images()
+      foundNewImage = true
+      image = nil
+      imagesAfter.each do |imageA|
+        imagesBefore.each do |imageB|
+          if(imageA == imageB)
+            foundNewImage = false				
+          end
+        end
+        if(foundNewImage)
+          image = imageA
+          break
+        end
+      end
+      return put_octect(address(image["file"]), file.read, false)
+    end		
+    
+    ##
+    # Special rest call for sending a file stream using an octet-stream
+    # main change is just custom headers.
+    # Still implemented using do_request function.  
+    ## 
+    def put_octect(uri, data, manage_errors)
+      headers = build_headers(@token)
+      headers["Content-Type"] = 'application/octet-stream'	
+      req = Net::HTTP::Put.new(uri.request_uri, initheader = headers)
+      req.body = data
+      return do_request(uri, req, manage_errors, 0)
+    end
+
+    private
+
+    ##
+    # Function to get the v2 address location of an endpoint.
+    ##
+    def address(endpoint)
+      address("/v2/#{endpoint}")
+    end
+
+    def version
+      "V2"
+    end
+  end
+end