deltacloud-core 0.1.2 → 0.3.0

data/lib/deltacloud/state_machine.rb

@@ -1,6 +1,4 @@
 #
-# Copyright (C) 2009,2010  Red Hat, Inc.
-#
 # 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

data/lib/deltacloud/validation.rb

@@ -1,6 +1,4 @@
 #
-# Copyright (C) 2009,2010  Red Hat, Inc.
-#
 # 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
@@ -37,8 +35,12 @@ module Deltacloud::Validation
       @name = args[0]
       @klass = args[1] || :string
       @type = args[2] || :optional
-      @options = args[3] || []
-      @description = args[4] || ''
+      if args[3] and args[3].class.eql?(String)
+        @description = args[3]
+        @options = []
+      end
+      @options ||= args[3] || []
+      @description ||= args[4] || ''
     end
 
     def required?
@@ -51,7 +53,7 @@ module Deltacloud::Validation
   end
 
   def param(*args)
-    raise DuplicateParamException if params[args[0]]
+    raise "Duplicate param #{args[0]} #{params.inspect} #{self.class.name}" if params[args[0]]
     p = Param.new(args)
     params[p.name] = p
   end
@@ -74,8 +76,8 @@ module Deltacloud::Validation
     params.each_value { |p| yield p }
   end
 
-  def validate(values)
-    each_param do |p|
+  def validate(all_params, values)
+    all_params.each_value do |p|
       if p.required? and not values[p.name]
         raise Failure.new(p, "Required parameter #{p.name} not found")
       end

data/lib/drivers.rb

@@ -1,5 +1,3 @@
-# Copyright (C) 2009, 2010  Red Hat, Inc.
-#
 # 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
@@ -16,62 +14,52 @@
 # under the License.
 
 module Deltacloud
-  DRIVERS = {
-    :ec2 => { :name => "EC2" },
-    :rackspace => { :name => "Rackspace" },
-    :gogrid => { :name => "Gogrid" },
-    :rhevm => { :name => "RHEVM" },
-    :rimuhosting => { :name => "RimuHosting"},
-    :opennebula => { :name => "Opennebula", :class => "OpennebulaDriver" },
-    :terremark => { :name => "Terremark"},
-    :azure => { :name => "Azure" },
-    :mock => { :name => "Mock" }
-  }
 
-  DEFAULT_COLLECTIONS = [
-    :hardware_profiles,
-    :images,
-    :instances,
-    :instance_states,
-    :realms,
-    :storage_volumes,
-    :storage_snapshots
-  ]
+  module Drivers
 
-  DRIVER=ENV['API_DRIVER'] ? ENV['API_DRIVER'].to_sym : :mock
+    require 'yaml'
 
-  def driver_symbol
-    (Thread.current[:driver] || DRIVER).to_sym
-  end
+    DEFAULT_COLLECTIONS = [
+      :hardware_profiles,
+      :images,
+      :instances,
+      :instance_states,
+      :realms,
+      :storage_volumes,
+      :storage_snapshots
+    ]
 
-  def driver_name
-    DRIVERS[:"#{driver_symbol}"][:name]
-  end
+    DRIVER=ENV['API_DRIVER'] ? ENV['API_DRIVER'].to_sym : :mock
 
-  def driver_class_name
-    basename = DRIVERS[:"#{driver_symbol}"][:class] || "#{driver_name}Driver"
-    "Deltacloud::Drivers::#{driver_name}::#{basename}"
-  end
+    def driver_config
+      YAML::load(File.read(File.join(File.dirname(__FILE__), '..', 'config', 'drivers.yaml')))
+    end
 
-  def driver_source_name
-    File.join("deltacloud", "drivers", "#{driver_symbol}", "#{driver_symbol}_driver.rb")
-  end
+    def driver_symbol
+      (Thread.current[:driver] || DRIVER).to_sym
+    end
 
-  def driver_mock_source_name
-    return File.join('deltacloud', 'drivers', "#{driver_symbol}", 
-                     "#{driver_symbol}_driver.rb") if driver_name.eql? 'Mock'
-  end
+    def driver_name
+      driver_config[:"#{driver_symbol}"][:name]
+    end
 
-  def driver
-    require driver_source_name
-    #require 'deltacloud/base_driver/mock_driver.rb'
+    def driver_class
+      basename = driver_config[:"#{driver_symbol}"][:class] || "#{driver_name}Driver"
+      Deltacloud::Drivers.const_get(driver_name).const_get(basename)
+    end
 
-    if Sinatra::Application.environment.eql? :test
-      require driver_mock_source_name if driver_mock_source_name
+    def driver_source_name
+      File.join("deltacloud", "drivers", "#{driver_symbol}", "#{driver_symbol}_driver.rb")
     end
 
-    @driver ||= eval( driver_class_name ).new
+    def driver_mock_source_name
+      return File.join('deltacloud', 'drivers', "#{driver_symbol}",
+		       "#{driver_symbol}_driver.rb") if driver_name.eql? 'Mock'
+    end
+
+    def driver
+      require driver_source_name
+      @driver ||= driver_class.new
+    end
   end
 end
-
-include Deltacloud

data/lib/sinatra/accept_media_types.rb

@@ -1,3 +1,29 @@
+#
+# Based on https://github.com/mynyml/rack-accept-media-types
+# Commit 3d0f38882a466cc72043
+#
+# Original license:
+# Copyright (C) 2009 Martin Aumont (mynyml)
+#
+# Permission is hereby granted, free of charge, to any person obtaining a
+# copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to permit
+# persons to whom the Software is furnished to do so, subject to the
+# following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+# NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+# USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 module Rack
   class Request
     # The media types of the HTTP_ACCEPT header ordered according to their

data/lib/sinatra/lazy_auth.rb

@@ -1,3 +1,19 @@
+#
+# 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.
+
 require 'sinatra/base'
 
 # Lazy Basic HTTP authentication. Authentication is only forced when the

data/lib/sinatra/rabbit.rb

@@ -1,3 +1,19 @@
+#
+# 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.
+
 require 'sinatra/base'
 require 'sinatra/url_for'
 require 'deltacloud/validation'
@@ -10,9 +26,10 @@ module Sinatra
     class DuplicateParamException < Exception; end
     class DuplicateOperationException < Exception; end
     class DuplicateCollectionException < Exception; end
+    class UnsupportedCollectionException < Exception; end
 
     class Operation
-      attr_reader :name, :method
+      attr_reader :name, :method, :collection
 
       include ::Deltacloud::BackendCapability
       include ::Deltacloud::Validation
@@ -35,6 +52,11 @@ module Sinatra
         @description = ""
         instance_eval(&block) if block_given?
         generate_documentation
+        generate_options
+      end
+
+      def http_method
+        @method
       end
 
       def standard?
@@ -50,6 +72,7 @@ module Sinatra
         coll, oper = @collection, self
         ::Sinatra::Application.get("/api/docs/#{@collection.name}/#{@name}") do
           @collection, @operation = coll, oper
+          @features = driver.features_for_operation(coll.name, oper.name)
           respond_to do |format|
             format.html { haml :'docs/operation' }
             format.xml { haml :'docs/operation' }
@@ -57,11 +80,27 @@ module Sinatra
         end
       end
 
+      def generate_options
+        current_operation = self
+        ::Sinatra::Application.options("/api/#{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(',')
+          optional_params = current_operation.effective_params(driver).collect do |name, validation|
+            name.to_s if validation.type.eql?(:optional)
+          end.compact.join(',')
+          headers 'X-Required-Parameters' => required_params
+          headers 'X-Optional-Parameters' => optional_params
+          [200, '']
+        end
+      end
+
       def control(&block)
         op = self
         @control = Proc.new do
-          op.check_capability(Deltacloud::driver)
-          op.validate(params)
+          op.collection.check_supported(driver)
+          op.check_capability(driver)
+          op.validate(op.effective_params(driver), params)
           instance_eval(&block)
         end
       end
@@ -72,7 +111,7 @@ module Sinatra
       end
 
       def path(args = {})
-        l_prefix = args[:prefix] ? args[:prefix] : prefix
+        l_prefix = args[:prefix] || prefix
         if @member
           if standard?
             "#{l_prefix}/#{@collection.name}/:id"
@@ -96,6 +135,24 @@ module Sinatra
         end
       end
 
+      # Return a hash of all params, the params statically defined for this
+      # operation plus the params defined by any features in the +driver+
+      # that might modify this operation
+      def effective_params(driver)
+        driver.features(@collection.name).collect do |f|
+          f.decl.operation(@name)
+        end.flatten.select { |op| op }.inject(params.dup) do |result, fop|
+          fop.params.each_key do |k|
+            if result.has_key?(k)
+              raise DuplicateParamException, "Parameter '#{k}' for operation #{fop.name} in collection #{@collection.name}"
+            else
+              result[k] = fop.params[k]
+            end
+          end
+          result
+        end
+      end
+
       private
       def gen_route(name)
         route_url = path
@@ -120,8 +177,11 @@ module Sinatra
         @name = name
         @description = ""
         @operations = {}
+        @global = false
         instance_eval(&block) if block_given?
         generate_documentation
+        generate_head
+        generate_options
       end
 
       # Set/Return description for collection
@@ -132,10 +192,43 @@ module Sinatra
         @description = text
       end
 
+      # Mark this collection as global, i.e. independent of any specific
+      # driver
+      def global!
+        @global = true
+      end
+
+      # Return +true+ if this collection is global, i.e. independent of any
+      # specific driver
+      def global?
+        @global
+      end
+
+      def generate_head
+        current_collection = self
+        ::Sinatra::Application.head("/api/#{name}") do
+          methods_allowed = current_collection.operations.collect { |o| o[1].method.to_s.upcase }.uniq.join(',')
+          headers 'Allow' => "HEAD,OPTIONS,#{methods_allowed}"
+          [200, '']
+        end
+      end
+
+      def generate_options
+        current_collection = self
+        ::Sinatra::Application.options("/api/#{name}") do
+          operations_allowed = current_collection.operations.collect { |o| o[0] }.join(',')
+          headers 'X-Operations-Allowed' => operations_allowed
+          [200, '']
+        end
+      end
+
       def generate_documentation
-        coll, oper, features = self, @operations, Deltacloud::driver.features(name)
+        coll = self
         ::Sinatra::Application.get("/api/docs/#{@name}") do
-          @collection, @operations, @features = coll, oper, features
+          coll.check_supported(driver)
+          @collection = coll
+          @operations = coll.operations
+          @features = driver.features(coll.name)
           respond_to do |format|
             format.html { haml :'docs/collection' }
             format.xml { haml :'docs/collection' }
@@ -178,19 +271,10 @@ module Sinatra
         end
       end
 
-      def add_feature_params(features)
-        features.each do |f|
-          f.operations.each do |fop|
-            if cop = operations[fop.name]
-              fop.params.each_key do |k|
-                if cop.params.has_key?(k)
-                  raise DuplicateParamException, "Parameter '#{k}' for operation #{fop.name} defined by collection #{@name} and by feature #{f.name}"
-                else
-                  cop.params[k] = fop.params[k]
-                end
-              end
-            end
-          end
+      def check_supported(driver)
+        unless global? || driver.has_collection?(@name)
+          raise UnsupportedCollectionException,
+            "Collection #{@name} not supported by this driver"
         end
       end
     end
@@ -206,9 +290,7 @@ module Sinatra
     # operation on this collection.
     def collection(name, &block)
       raise DuplicateCollectionException if collections[name]
-      return unless Deltacloud::driver.has_collection?(name.to_sym)
       collections[name] = Collection.new(name, &block)
-      collections[name].add_feature_params(Deltacloud::driver.features(name))
       collections[name].generate
     end
 
@@ -229,7 +311,9 @@ module Sinatra
     end
 
     def entry_points
-      collections.values.inject([]) do |m, coll|
+      collections.values.select { |coll|
+        coll.global? || driver.has_collection?(coll.name)
+      }.inject([]) do |m, coll|
         url = url_for coll.operations[:index].path, :full
         m << [ coll.name, url ]
       end
@@ -240,37 +324,11 @@ module Sinatra
   helpers RabbitHelper
 end
 
-class String
-  # Rails defines this for a number of other classes, including Object
-  # see activesupport/lib/active_support/core_ext/object/blank.rb
-  def blank?
-      self !~ /\S/
-  end
-
-  # Title case.
-  #
-  #   "this is a string".titlecase
-  #   => "This Is A String"
-  #
-  # CREDIT: Eliazar Parra
-  # Copied from facets
-  def titlecase
-    gsub(/\b\w/){ $`[-1,1] == "'" ? $& : $&.upcase }
-  end
-
-  def pluralize
-    self + "s"
-  end
-
-  def singularize
-    self.gsub(/s$/, '')
-  end
-
-  def underscore
-      gsub(/::/, '/').
-          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').
-          tr("-", "_").
-          downcase
+configure do
+  class << Sinatra::Base
+    def options(path, opts={}, &block)
+      route 'OPTIONS', path, opts, &block
+    end
   end
+  Sinatra::Delegator.delegate :options
 end