aeolus-image 0.0.1 → 0.4.0

data/COPYING

@@ -0,0 +1,161 @@
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work (an example is provided in the Appendix
+below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the purposes
+of this definition, "submitted" means any form of electronic, verbal, or
+written communication sent to the Licensor or its representatives, including
+but not limited to communication on electronic mailing lists, source code
+control systems, and issue tracking systems that are managed by, or on behalf
+of, the Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise designated in
+writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell, import,
+and otherwise transfer the Work, where such license applies only to those
+patent claims licensable by such Contributor that are necessarily infringed by
+their Contribution(s) alone or by combination of their Contribution(s) with the
+Work to which such Contribution(s) was submitted. If You institute patent
+litigation against any entity (including a cross-claim or counterclaim in a
+lawsuit) alleging that the Work or a Contribution incorporated within the Work
+constitutes direct or contributory patent infringement, then any patent
+licenses granted to You under this License for that Work shall terminate as of
+the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+
+You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License. You may add Your own copyright statement to Your
+modifications and may provide additional or different license terms and
+conditions for use, reproduction, or distribution of Your modifications, or for
+any such Derivative Works as a whole, provided Your use, reproduction, and
+distribution of the Work otherwise complies with the conditions stated in this
+License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may have
+executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties
+or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or inability to
+use the Work (including but not limited to damages for loss of goodwill, work
+stoppage, computer failure or malfunction, or any and all other commercial
+damages or losses), even if such Contributor has been advised of the
+possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or
+Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/Rakefile

@@ -1,44 +1,58 @@
+#   Copyright 2011 Red Hat, Inc.
+#
+#   Licensed 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 'rubygems'
 require 'rake'
 require 'rake/clean'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'rubygems/package_task'
+require 'rdoc/task'
 require 'rake/testtask'
-require 'spec/rake/spectask'
-require 'rake/rpmtask'
+require 'rspec/core/rake_task'
+require './rake/rpmtask'
 
 RPMBUILD_DIR = "#{File.expand_path('~')}/rpmbuild"
 RPM_SPEC = "rubygem-aeolus-image.spec"
+RPM_SPEC_IN = "rubygem-aeolus-image.spec.in"
+PKG_VERSION = "0.4.0"
 
 spec = Gem::Specification.new do |s|
   s.name = 'aeolus-image'
-  s.version = '0.0.1'
-  s.has_rdoc = true
-  s.summary= 'cli for aeolus cloud suite'
-  s.description = 'Commandline interface for working with the aeolus cloud management suite'
+  s.version = PKG_VERSION
+  s.summary= 'Ruby Client for Image Warehouse and Image Factory for the Aeolus cloud suite'
+  s.description = 'Library for managing image via the Factory and Warehouse projects for the aeolus cloud management suite'
   s.author = 'Jason Guiditta, Martyn Taylor'
   s.email = 'jguiditt@redhat.com, mtaylor@redhat.com'
-  s.license = 'GPL-2'
+  s.license = 'ASL 2.0'
   s.homepage = 'http://aeolusproject.org'
-  s.executables << 'aeolus-image'
-  s.files = %w(Rakefile) + Dir.glob("{bin,lib,spec,examples,man}/**/*")
+  s.files = %w(Rakefile) + Dir.glob("{lib,spec}/**/*") + %w(COPYING)
   s.require_path = "lib"
-  s.bindir = "bin"
   s.add_dependency('nokogiri', '>=0.4.0')
   s.add_dependency('rest-client')
-  s.add_dependency('imagefactory-console', '>=0.4.0')
+  s.add_dependency('activeresource', '~>3.0.10')
+  s.add_dependency('oauth')
 
   s.add_development_dependency('rspec', '~>1.3.0')
 end
 
-Rake::GemPackageTask.new(spec) do |p|
+Gem::PackageTask.new(spec) do |p|
   p.gem_spec = spec
   p.need_tar = true
   p.need_zip = true
 end
 
 Rake::RDocTask.new do |rdoc|
-  files =['README', 'LICENSE', 'lib/**/*.rb']
+  files =['README', 'COPYING', 'lib/**/*.rb']
   rdoc.rdoc_files.add(files)
   rdoc.main = "README" # page to start on
   rdoc.title = "aeolus-image Docs"
@@ -50,12 +64,11 @@ Rake::TestTask.new do |t|
   t.test_files = FileList['test/**/*.rb']
 end
 
-Spec::Rake::SpecTask.new do |t|
-  t.spec_files = FileList['spec/**/*.rb']
-  t.libs << Dir["lib"]
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = FileList['spec/**/*.rb']
 end
 
-Rake::RpmTask.new(RPM_SPEC) do |rpm|
+Rake::RpmTask.new(RPM_SPEC, {:suffix => '.in', :pkg_version => PKG_VERSION}) do |rpm|
   rpm.need_tar = true
   rpm.package_files.include("lib/*")
   rpm.topdir = "#{RPMBUILD_DIR}"

data/lib/aeolus_image.rb

@@ -0,0 +1,35 @@
+#   Copyright 2011 Red Hat, Inc.
+#
+#   Licensed 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 'optparse'
+require 'logger'
+require 'active_resource'
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/warehouse', 'warehouse_client') # Not sure we need this
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/warehouse', 'warehouse_model')  # We may be able to factor this out?
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/warehouse', 'icicle')
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/warehouse', 'image')
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/warehouse', 'image_build')
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/warehouse', 'provider_image')
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/warehouse', 'target_image')
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/warehouse', 'template')
+
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/factory', 'base')
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/factory', 'image')
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/factory', 'build')
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/factory', 'provider_image')
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/factory', 'target_image')
+require File.join(File.dirname(__FILE__), 'aeolus_image/model/factory', 'builder')
+require File.join(File.dirname(__FILE__), 'aeolus_image', 'active_resource_oauth_client')
+
+require File.join(File.dirname(__FILE__), 'aeolus_image', 'import')

data/lib/aeolus_image/active_resource_oauth_client.rb

@@ -0,0 +1,62 @@
+# Copyright (c) 2011 Red Hat, Inc.
+#
+# 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.
+
+
+require 'oauth'
+
+# Monkey-patch ActiveResource to allow us to merge our OAuth headers in.
+# Portions of the below are taken from Active Resource which is MIT licensed;
+# hence this whole file is being licensed under the MIT License to err on the side of safety.
+module ActiveResourceOAuthClient
+  ActiveResource::Connection.class_eval do
+    def request_with_oauth(method, path, *arguments)
+      @oauth_config = Aeolus::Image::Factory::Base.config || {}
+      # Take care to fall back to the standard request method if we don't have full OAuth credentials
+      unless Aeolus::Image::Factory::Base.use_oauth?
+        return request_without_oauth(method, path, *arguments)
+      end
+      result = ActiveSupport::Notifications.instrument("request.active_resource") do |payload|
+        payload[:method] = method
+        payload[:request_uri] = "#{site.scheme}://#{site.host}:#{site.port}#{path}"
+        oauth_consumer = OAuth::Consumer.new(
+          @oauth_config[:consumer_key],
+          @oauth_config[:consumer_secret],
+          :site => @oauth_config[:site] )
+        token = OAuth::AccessToken.new(oauth_consumer)
+        base_request = oauth_consumer.create_signed_request(method, path, token, {}, *arguments)
+        payload[:result] = http.request(base_request)
+      end
+      # Error-handling code from OAuth
+      # http://wiki.oauth.net/w/page/12238543/ProblemReporting
+      auth_header = result.to_hash['www-authenticate']
+      problem_header = auth_header ? auth_header.select{|h| h =~ /^OAuth /}.select{|h| h =~ /oauth_problem/}.first : nil
+      if auth_header && problem_header
+        params = OAuth::Helper.parse_header(problem_header)
+        raise OAuth::Problem.new(params.delete("oauth_problem"), result, params)
+      end
+      # Error-handling code from ActiveResource
+      handle_response(result)
+      rescue Timeout::Error => e
+        raise TimeoutError.new(e.message)
+      rescue OpenSSL::SSL::SSLError => e
+        raise SSLError.new(e.message)
+    end
+
+    alias_method_chain :request, :oauth
+
+  end
+end

data/lib/aeolus_image/import.rb

@@ -0,0 +1,44 @@
+#   Copyright 2011 Red Hat, Inc.
+#
+#   Licensed 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 Aeolus
+  module Image
+    def self.import(provider_name, deltacloud_driver, image_id, account_id, environment, xml=nil, arch=nil)
+      xml ||= "<image><name>#{image_id}</name></image>"
+      image = Factory::Image.new(
+        :target_name => deltacloud_driver,
+        :provider_name => provider_name,
+        :target_identifier => image_id,
+        :image_descriptor => xml
+      )
+      image.save!
+      # Set the provider_account_id on the image
+      iwhd_image = Warehouse::Image.find(image.id)
+      iwhd_image.set_attr("environment", environment)
+      # For imported images, stash an :architecture flag on the image itself since we have no template
+      iwhd_image.set_attr(:architecture, arch) if arch
+      # Set the account on the provider image
+      # This assumes (as is currently correct) that there will only be one provider image for imported images
+      pimg = iwhd_image.provider_images.first
+      # Check that we have provider images! If not, the import has failed.
+      if pimg
+        pimg.set_attr('provider_account_identifier', account_id)
+        return image
+      else
+        iwhd_image.delete!
+        raise "Image import failed to import provider image! Aborting."
+      end
+    end
+  end
+end

data/lib/aeolus_image/model/factory/base.rb

@@ -0,0 +1,93 @@
+#
+#   Copyright 2011 Red Hat, Inc.
+#
+#   Licensed 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 Aeolus
+  module Image
+    module Factory
+      class Base < ActiveResource::Base
+        self.format = :json
+        self.ssl_options = {:verify_mode  => OpenSSL::SSL::VERIFY_NONE}
+
+        class << self
+          ## Remove format from the url for resources
+          def element_path(id, prefix_options = {}, query_options = nil)
+            prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+            "#{prefix(prefix_options)}#{collection_name}/#{id}#{query_string(query_options)}"
+          end
+
+          ## Remove format from the url for collections
+          def collection_path(prefix_options = {}, query_options = nil)
+            prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+            "#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
+          end
+
+          ## For a collection call, ActiveResource formatting is not
+          ## compliant with Factory's output.
+          def instantiate_collection(collection, prefix_options = {})
+            unless collection.kind_of? Array
+              [instantiate_record(collection, prefix_options)]
+            else
+              collection.collect! { |record| instantiate_record(record, prefix_options) }
+            end
+          end
+
+          ##  The objects returned from this method are not automatically converted into ActiveResource instances - they are ordinary Hashes.
+          ##  Modifications below ensures that you get ActiveResource instances.
+          def get(method_name, options = {})
+            object_array = connection.get(custom_method_collection_url(method_name, options), headers)
+            if object_array.class.to_s=="Array"
+              object_array.collect! {|record| self.class.new.load(record)}
+            else
+              self.class.new.load(object_array)
+            end
+          end
+
+          # This approach does mean you're limited to one server at a time
+          def config
+            defined?(@@config) ? @@config : {}
+          end
+          def config=(conf={})
+            @@config = conf
+            self.site = @@config[:site]
+          end
+
+          # Should we use OAuth?
+          def use_oauth?
+            config[:consumer_key] && config[:consumer_secret] && config[:site]
+          end
+        end
+
+        ## Instance Methods: (modifying the ActiveRecord::CustomMethods).
+        ## This modification is same as defined in above method
+        def get(method_name, options = {})
+          self.class.new.load(connection.get(custom_method_element_url(method_name, options), self.class.headers))
+        end
+
+        # Modifying the url formations to make them Factory compliant
+        def custom_method_element_url(method_name, options = {})
+          "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/#{id}/" +
+          "#{method_name}#{self.class.send!(:query_string, options)}"
+        end
+
+        # Modifying the url formations to make them Factory compliant
+        def self.custom_method_collection_url(method_name, options = {})
+          prefix_options, query_options = split_options(options)
+          url = "#{prefix(prefix_options)}#{collection_name}/#{method_name}#{query_string(query_options)}"
+          url
+        end
+      end
+    end
+  end
+end