deltacloud-core 0.3.0 → 0.4.0

data/lib/deltacloud/helpers/conversion_helper.rb

@@ -19,7 +19,7 @@ require 'deltacloud/base_driver'
 module ConversionHelper
 
   def convert_to_json(type, obj)
-    if ( [ :flavor, :account, :image, :realm, :instance, :storage_volume, :storage_snapshot, :hardware_profile ].include?( type ) )
+    if ( [ :image, :realm, :instance, :storage_volume, :storage_snapshot, :hardware_profile, :key, :bucket, :blob, :firewall, :load_balancer, :address ].include?( type ) )
       if Array.eql?(obj.class)
         data = obj.collect do |o|
           o.to_hash.merge({ :href => self.send(:"#{type}_url", type.eql?(:hardware_profile) ? o.name : o.id ) })
@@ -27,7 +27,11 @@ module ConversionHelper
         type = type.to_s.pluralize
       else
         data = obj.to_hash
-        data.merge!({ :href => self.send(:"#{type}_url", data[:id]) })
+        if type == :blob
+          data.merge!({ :href => self.send(:"bucket_url", "#{data[:bucket]}/#{data[:id]}" ) })
+        else
+          data.merge!({ :href => self.send(:"#{type}_url", data[:id]) })
+        end
       end
       return { :"#{type}" => data }.to_json
     end

data/lib/deltacloud/helpers/json_helper.rb

@@ -0,0 +1,31 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+module JSONHelper
+
+  def json_features_for_entrypoint(entrypoint)
+    features = driver.features(entrypoint.first).collect { |feature| feature.name }
+    features.empty? ? {} : { :features => features }
+  end
+
+  def json_return_error(error)
+    error_output=Hash.new
+    error_output[:url]    =request.env['REQUEST_URI']
+    error_output[:status] =response.status
+    error_output[:message]=error.message if error
+    error_output.to_json
+  end
+
+end

data/lib/deltacloud/models/address.rb

@@ -0,0 +1,28 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+class Address < BaseModel
+  attr_accessor :instance_id
+
+  def initialize(init=nil)
+    super(init)
+  end
+
+  def associated?
+    true unless self.instance_id.nil?
+  end
+
+end

data/lib/deltacloud/models/base_model.rb

@@ -46,7 +46,11 @@ class BaseModel
 
   def to_hash
     out = {}
-    self.attributes.each { |attribute| out.merge!({ attribute => self.send(:"#{attribute}") } ) }
+    self.attributes.each do |attribute|
+      if self.send(:"#{attribute}")
+        out.merge!({ attribute => self.send(:"#{attribute}") } )
+      end
+    end
     out
   end
 

data/lib/deltacloud/models/blob.rb

@@ -15,7 +15,7 @@
 # under the License.
 
 class Blob < BaseModel
-  
+
   #already has an id from basemodel (for the key)
   attr_accessor :bucket
   attr_accessor :content_length

data/lib/deltacloud/models/bucket.rb

@@ -20,4 +20,14 @@ class Bucket < BaseModel
   attr_accessor :size
   attr_accessor :blob_list
 
+  alias :to_hash_original :to_hash
+
+  def to_hash
+    h = self.to_hash_original
+    unless blob_list.nil?
+      h[:blob_list] = self.blob_list.collect { |blob| { :id => blob,
+        :href => "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/buckets/#{self.id}/#{blob}"}}
+    end
+    return h
+  end
 end

data/lib/deltacloud/models/firewall.rb

@@ -0,0 +1,22 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+class Firewall < BaseModel
+  attr_accessor :name
+  attr_accessor :description
+  attr_accessor :owner_id
+  attr_accessor :rules
+end

data/lib/deltacloud/models/firewall_rule.rb

@@ -0,0 +1,23 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+class FirewallRule < BaseModel
+  attr_accessor :allow_protocol # tcp/udp/icmp
+  attr_accessor :port_from
+  attr_accessor :port_to
+  attr_accessor :sources
+  attr_accessor :direction #ingress egress
+end

data/lib/deltacloud/models/image.rb

@@ -23,4 +23,16 @@ class Image < BaseModel
   attr_accessor :architecture
   attr_accessor :state
 
+  alias :to_hash_original :to_hash
+
+  def to_hash
+    h = self.to_hash_original
+    h.merge({
+      :actions => [ :create_instance => {
+        :method => 'post',
+        :href => "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/instances;image_id=#{self.id}"
+      }]
+    })
+  end
+
 end

data/lib/deltacloud/models/instance.rb

@@ -16,6 +16,8 @@
 
 class Instance < BaseModel
 
+  include ApplicationHelper
+
   attr_accessor :owner_id
   attr_accessor :image_id
   attr_accessor :name
@@ -31,6 +33,7 @@ class Instance < BaseModel
   attr_accessor :username
   attr_accessor :password
   attr_accessor :create_image
+  attr_accessor :firewalls
 
   def can_create_image?
     self.create_image
@@ -59,13 +62,28 @@ class Instance < BaseModel
     if name =~ /is_(\w+)\?/
       return true if self.state.downcase.eql?($1)
     else
-      raise NoMethodError
+      raise NoMethodError.new(name.to_s)
     end
   end
 
   def authn_feature_failed?
     return true unless authn_error.nil?
   end
- 
+
+  alias :to_hash_original :to_hash
+
+  def to_hash
+    h = self.to_hash_original
+    h[:public_addresses] = h[:public_addresses].collect do |address|
+      { :address => { :type => address_type(address), :value => address } }
+    end
+    h[:actions] = self.actions.collect do |action|
+      { :"#{action}" => {
+        :method => collections[:instances].operations[action.to_sym].method,
+        :href => collections[:instances].operations[action.to_sym].path.gsub(':id', self.id)
+      }}
+    end
+    h
+  end
 
 end

data/lib/deltacloud/models/key.rb

@@ -41,7 +41,7 @@ class Key < BaseModel
   # NOTE: This is a fake PEM file, it will not work against SSH
   def self.generate_mock_pem
     chars = (('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a + %w(= / + ))
-    pem_material = (1..21).map do 
+    pem_material = (1..21).map do
       (1..75).collect{|a| chars[rand(chars.size)] }.join
     end.join("\n") + "\n" + (1..68).collect{|a| chars[rand(chars.size)] }.join
     "-----BEGIN RSA PRIVATE KEY-----\n"+pem_material+"-----END RSA PRIVATE KEY-----"

data/lib/deltacloud/runner.rb

@@ -28,11 +28,11 @@ module Deltacloud
         super
       end
     end
-    
+
     class InstanceSSHError < RunnerError; end
 
     def self.execute(command, opts={})
-      
+
       if opts[:credentials] and (not opts[:credentials][:password] and not opts[:private_key])
         raise RunnerError::new("Either password or key must be specified")
       end
@@ -118,7 +118,7 @@ module Deltacloud
     end
 
     class Response
-      
+
       attr_reader :body
       attr_reader :ssh
 

data/lib/deltacloud/validation.rb

@@ -24,7 +24,7 @@ module Deltacloud::Validation
     end
 
     def name
-      param.name
+      param.name if @param
     end
   end
 
@@ -35,12 +35,8 @@ module Deltacloud::Validation
       @name = args[0]
       @klass = args[1] || :string
       @type = args[2] || :optional
-      if args[3] and args[3].class.eql?(String)
-        @description = args[3]
-        @options = []
-      end
-      @options ||= args[3] || []
-      @description ||= args[4] || ''
+      @options = args[3] || []
+      @description = args[4] || ''
     end
 
     def required?

data/lib/drivers.rb

@@ -32,7 +32,13 @@ module Deltacloud
     DRIVER=ENV['API_DRIVER'] ? ENV['API_DRIVER'].to_sym : :mock
 
     def driver_config
-      YAML::load(File.read(File.join(File.dirname(__FILE__), '..', 'config', 'drivers.yaml')))
+      if Thread::current[:drivers].nil?
+        Thread::current[:drivers] = {}
+        Dir[File.join(File::dirname(__FILE__), '..', 'config', 'drivers', '*.yaml')].each do |driver_file|
+          Thread::current[:drivers].merge!(YAML::load(File::read(driver_file)))
+        end
+      end
+      Thread::current[:drivers]
     end
 
     def driver_symbol

data/lib/sinatra/body_proxy.rb

@@ -0,0 +1,34 @@
+# This code was originaly copied from Rack::BodyProxy
+# https://github.com/rack/rack/blob/master/lib/rack/body_proxy.rb
+#
+# Copyright (C) 2007, 2008, 2009, 2010 Christian Neukirchen <purl.org/net/chneukirchen>
+
+module Rack
+  class BodyProxy
+    def initialize(body, &block)
+      @body, @block, @closed = body, block, false
+    end
+
+    def respond_to?(*args)
+      super or @body.respond_to?(*args)
+    end
+
+    def close
+      raise IOError, "closed stream" if @closed
+      begin
+        @body.close if @body.respond_to? :close
+      ensure
+        @block.call
+        @closed = true
+      end
+    end
+
+    def closed?
+      @closed
+    end
+
+    def method_missing(*args, &block)
+      @body.__send__(*args, &block)
+    end
+  end
+end

data/lib/sinatra/lazy_auth.rb

@@ -42,6 +42,11 @@ module Sinatra
 
       private
       def credentials!
+        if ENV["API_USER"] && ENV["API_PASSWORD"]
+          @user = ENV["API_USER"]
+          @password = ENV["API_PASSWORD"]
+          @provided = true
+        end
         unless provided?
           auth = Rack::Auth::Basic::Request.new(@app.request.env)
           unless auth.provided? && auth.basic? && auth.credentials

data/lib/sinatra/rabbit.rb

@@ -23,18 +23,32 @@ module Sinatra
 
   module Rabbit
 
-    class DuplicateParamException < Exception; end
-    class DuplicateOperationException < Exception; end
-    class DuplicateCollectionException < Exception; end
-    class UnsupportedCollectionException < Exception; end
+    def self.routes
+      @routes ||= []
+    end
+
+    class DuplicateParamException < Deltacloud::ExceptionHandler::DeltacloudException; end
+    class DuplicateOperationException < Deltacloud::ExceptionHandler::DeltacloudException; end
+    class DuplicateCollectionException < Deltacloud::ExceptionHandler::DeltacloudException; end
+    class UnsupportedCollectionException < Deltacloud::ExceptionHandler::DeltacloudException
+      def initialize
+        # The server understood the request, but is refusing to fulfill it. Authorization will not help and the request
+        # SHOULD NOT be repeated. If the request method was not HEAD and the server wishes to make public why the request
+        # has not been fulfilled, it SHOULD describe the reason for the refusal in the entity. If the server does not wish
+        # to make this information available to the client, the status code 404 (Not Found) can be used instead.
+        super(403, 'UnsupportedCollection', "Requested collection is not supported for current provider", [])
+      end
+    end
 
     class Operation
-      attr_reader :name, :method, :collection
+      attr_reader :name, :method, :collection, :member
 
       include ::Deltacloud::BackendCapability
       include ::Deltacloud::Validation
+      include ::ApplicationHelper
 
       STANDARD = {
+        :new => { :method => :get, :member => false, :form => true },
         :index => { :method => :get, :member => false },
         :show =>  { :method => :get, :member => true },
         :create => { :method => :post, :member => false },
@@ -63,6 +77,10 @@ module Sinatra
         STANDARD.keys.include?(name)
       end
 
+      def form?
+        STANDARD[name] and STANDARD[name][:form]
+      end
+
       def description(text="")
         return @description if text.blank?
         @description = text
@@ -70,7 +88,8 @@ module Sinatra
 
       def generate_documentation
         coll, oper = @collection, self
-        ::Sinatra::Application.get("/api/docs/#{@collection.name}/#{@name}") do
+        Rabbit::routes << [:get, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/docs/#{@collection.name}/#{@name}"]
+        ::Sinatra::Application.get("#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/docs/#{@collection.name}/#{@name}") do
           @collection, @operation = coll, oper
           @features = driver.features_for_operation(coll.name, oper.name)
           respond_to do |format|
@@ -82,7 +101,8 @@ module Sinatra
 
       def generate_options
         current_operation = self
-        ::Sinatra::Application.options("/api/#{current_operation.collection.name}/#{current_operation.name}") do
+        Rabbit::routes << [:options, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{current_operation.collection.name}/#{current_operation.name}"]
+        ::Sinatra::Application.options("#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{current_operation.collection.name}/#{current_operation.name}") do
           required_params = current_operation.effective_params(driver).collect do |name, validation|
             name.to_s if validation.type.eql?(:required)
           end.compact.join(',')
@@ -105,26 +125,25 @@ module Sinatra
         end
       end
 
-      def prefix
-        # FIXME: Make the /api prefix configurable
-        "/api"
-      end
-
       def path(args = {})
-        l_prefix = args[:prefix] || prefix
         if @member
           if standard?
-            "#{l_prefix}/#{@collection.name}/:id"
+            "#{@collection.name}/:id"
           else
-            "#{l_prefix}/#{@collection.name}/:id/#{name}"
+            "#{@collection.name}/:id/#{name}"
           end
         else
-          "#{l_prefix}/#{@collection.name}"
+          if form?
+            "#{@collection.name}/#{name}"
+          else
+            "#{@collection.name}"
+          end
         end
       end
 
       def generate
-        ::Sinatra::Application.send(@method, path, {}, &@control)
+        Rabbit::routes << [@method, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{path}"]
+        ::Sinatra::Application.send(@method, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{path}", {}, &@control)
         # Set up some Rails-like URL helpers
         if name == :index
           gen_route "#{@collection.name}_url"
@@ -159,12 +178,12 @@ module Sinatra
         if @member
           ::Sinatra::Application.send(:define_method, name) do |id, *args|
             url = query_url(route_url, args[0])
-            url_for url.gsub(/:id/, id.to_s), :full
+            api_url_for url.gsub(/:id/, id.to_s), :full
           end
         else
           ::Sinatra::Application.send(:define_method, name) do |*args|
             url = query_url(route_url, args[0])
-            url_for url, :full
+            api_url_for url, :full
           end
         end
       end
@@ -206,7 +225,8 @@ module Sinatra
 
       def generate_head
         current_collection = self
-        ::Sinatra::Application.head("/api/#{name}") do
+        Rabbit::routes << [:head, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{name}"]
+        ::Sinatra::Application.head("#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{name}") do
           methods_allowed = current_collection.operations.collect { |o| o[1].method.to_s.upcase }.uniq.join(',')
           headers 'Allow' => "HEAD,OPTIONS,#{methods_allowed}"
           [200, '']
@@ -215,7 +235,8 @@ module Sinatra
 
       def generate_options
         current_collection = self
-        ::Sinatra::Application.options("/api/#{name}") do
+        Rabbit::routes << [:options, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{name}"]
+        ::Sinatra::Application.options("#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/#{name}") do
           operations_allowed = current_collection.operations.collect { |o| o[0] }.join(',')
           headers 'X-Operations-Allowed' => operations_allowed
           [200, '']
@@ -224,7 +245,8 @@ module Sinatra
 
       def generate_documentation
         coll = self
-        ::Sinatra::Application.get("/api/docs/#{@name}") do
+        Rabbit::routes << [:get, "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/docs/#{@name}"]
+        ::Sinatra::Application.get("#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/docs/#{@name}") do
           coll.check_supported(driver)
           @collection = coll
           @operations = coll.operations
@@ -252,29 +274,30 @@ module Sinatra
       # This also defines a helper method like show_instance_url that returns
       # the URL to this operation (in request context)
       def operation(name, opts = {}, &block)
-        raise DuplicateOperationException if @operations[name]
+        if @operations.keys.include?(name)
+          raise DuplicateOperationException::new(500, "DuplicateOperation", "Operation #{name} is already defined", [])
+        end
         @operations[name] = Operation.new(self, name, opts, &block)
       end
 
       def generate
-        operations.values.each { |op| op.generate }
+        operations.values.reject { |op| op.member }.each { |o| o.generate }
+        operations.values.select { |op| op.member }.each { |o| o.generate }
         app = ::Sinatra::Application
         collname = name # Work around Ruby's weird scoping/capture
         app.send(:define_method, "#{name.to_s.singularize}_url") do |id|
-            url_for "/api/#{collname}/#{id}", :full
+            api_url_for "#{collname}/#{id}", :full
         end
-
         if index_op = operations[:index]
           app.send(:define_method, "#{name}_url") do
-            url_for index_op.path.gsub(/\/\?$/,''), :full
+            api_url_for index_op.path.gsub(/\/\?$/,''), :full
           end
         end
       end
 
       def check_supported(driver)
         unless global? || driver.has_collection?(@name)
-          raise UnsupportedCollectionException,
-            "Collection #{@name} not supported by this driver"
+          raise UnsupportedCollectionException
         end
       end
     end
@@ -295,7 +318,7 @@ module Sinatra
     end
 
     # Generate a root route for API docs
-    get '/api/docs\/?' do
+    get "#{Sinatra::UrlForHelper::DEFAULT_URI_PREFIX}/docs\/?" do
       respond_to do |format|
         format.html { haml :'docs/index' }
         format.xml { haml :'docs/index' }
@@ -314,7 +337,7 @@ module Sinatra
       collections.values.select { |coll|
         coll.global? || driver.has_collection?(coll.name)
       }.inject([]) do |m, coll|
-        url = url_for coll.operations[:index].path, :full
+        url = api_url_for coll.operations[:index].path, :full
         m << [ coll.name, url ]
       end
     end