openstack_activeresource 0.1.1

data/lib/open_stack/base.rb

@@ -0,0 +1,88 @@
+# This file is part of the OpenStack-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - d.guerri@unidata.it)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OpenStack
+
+  DATETIME_FORMAT="%Y-%m-%dT%H:%M:%S"
+  IPV4_REGEX= /\A(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\Z/
+  IPV4_CIDR_REGEX= /\A(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\/(3[0-2]|[1-2][0-9]|[0-9])\Z/
+
+  class Base < ActiveResource::Base
+
+    self.format = :json
+    self.timeout = 5
+
+    def self.headers
+      if defined?(@headers)
+        _headers = @headers
+      elsif self != OpenStack::Base && superclass.headers
+        _headers = superclass.headers
+      else
+        _headers = @headers || {}
+      end
+
+      if self.token.present?
+        _headers['X-Auth-Token'] = self.token.id
+      end
+
+      _headers
+    end
+
+    protected
+
+    def self.token=(token)
+      Thread.current[:open_stack_token] = token
+    end
+
+    def self.token
+      Thread.current[:open_stack_token]
+    end
+
+  end
+
+end
+
+# Reopen ActiveResource::ClientError to add the proper parsing for OpenStack errors
+class ActiveResource::ClientError < ActiveResource::ConnectionError
+  alias old_message message
+  alias old_to_s to_s
+
+  def message
+    decoded_error = decode_openstack_error
+    decoded_error.nil? ? old_message : decoded_error
+  rescue Exception => e
+    # Fallback to the original method
+    old_message
+  end
+
+  def to_s
+    decoded_error = decode_openstack_error
+    decoded_error.nil? ? old_to_s : decoded_error
+  rescue Exception => e
+    # Fallback to the original method
+    old_to_s
+  end
+
+  private
+
+  def decode_openstack_error
+    decoded_body = ActiveSupport::JSON.decode(self.response.body)
+
+    decoded_body[decoded_body.keys[0]]['message']
+  end
+
+end

data/lib/open_stack/common.rb

@@ -0,0 +1,56 @@
+# This file is part of the OpenStack-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - d.guerri@unidata.it)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OpenStack
+
+  class Common < Base
+
+    # Overrides ActiveResource::Base::element_path to remove .<extension> from resources path
+    def self.element_path(id, prefix_options = {}, query_options = nil)
+      check_prefix_options(prefix_options)
+
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}#{collection_name}/#{URI.parser.escape id.to_s}#{query_string(query_options)}"
+    end
+
+    # Overrides ActiveResource::Base::collection_path to remove .<extension> from resources path
+    def self.collection_path(prefix_options = {}, query_options = nil)
+      check_prefix_options(prefix_options)
+
+      prefix_options, query_options = split_options(prefix_options) if query_options.nil?
+      "#{prefix(prefix_options)}#{collection_name}#{query_string(query_options)}"
+    end
+
+    # Overrides ActiveResource::CustomMethods to remove .<extension>
+    def self.custom_method_collection_url(method_name, options = {})
+      prefix_options, query_options = split_options(options)
+      "#{prefix(prefix_options)}#{collection_name}/#{method_name}#{query_string(query_options)}"
+    end
+
+    private
+
+    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
+
+    def custom_method_new_element_url(method_name, options = {})
+      "#{self.class.prefix(prefix_options)}#{self.class.collection_name}/new/#{method_name}#{self.class.__send__(:query_string, options)}"
+    end
+
+  end
+
+end

data/lib/open_stack/glance/base.rb

@@ -0,0 +1,39 @@
+# This file is part of the OpenStack-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - d.guerri@unidata.it)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OpenStack
+  module Glance
+
+    class Base < OpenStack::Common
+
+      def self.site
+        if self == OpenStack::Glance::Base
+          Thread.current[:open_stack_glance_site]
+        else
+          super
+        end
+      end
+
+      def self.site=(site)
+        super(site)
+        Thread.current[:open_stack_glance_site] = @site
+      end
+
+    end
+
+  end
+end

data/lib/open_stack/glance/image.rb

@@ -0,0 +1,33 @@
+# This file is part of the OpenStack-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - d.guerri@unidata.it)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OpenStack
+  module Glance
+
+    class Image < Base
+      schema do
+          attribute :name, :string
+          attribute :container_format, :string
+          attribute :disk_format, :string
+          attribute :checksum, :string
+          attribute :size, :integer
+      end
+
+    end
+
+  end
+end

data/lib/open_stack/glance.rb

@@ -0,0 +1,27 @@
+# This file is part of the OpenStack-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - d.guerri@unidata.it)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OpenStack
+
+  module Glance
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :Image
+  end
+
+end

data/lib/open_stack/keystone/admin/base.rb

@@ -0,0 +1,41 @@
+# This file is part of the OpenStack-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - d.guerri@unidata.it)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OpenStack
+  module Keystone
+    module Admin
+
+      class Base < OpenStack::Common
+
+        def self.site
+          if self == OpenStack::Keystone::Admin::Base
+            Thread.current[:open_stack_keystone_admin_site]
+          else
+            super
+          end
+        end
+
+        def self.site=(site)
+          super(site)
+          Thread.current[:open_stack_keystone_admin_site] = @site
+        end
+
+      end
+
+    end
+  end
+end

data/lib/open_stack/keystone/admin/role.rb

@@ -0,0 +1,35 @@
+# This file is part of the OpenStack-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - d.guerri@unidata.it)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OpenStack
+  module Keystone
+    module Admin
+
+      class Role < Base
+        self.element_name = "OS-KSADM/role"
+
+        def self.find_by_name(name)
+          all.each { |role| return role if role.name == name }
+
+          nil
+        end
+
+      end
+
+    end
+  end
+end

data/lib/open_stack/keystone/admin/tenant.rb

@@ -0,0 +1,104 @@
+# This file is part of the OpenStack-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - d.guerri@unidata.it)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OpenStack
+  module Keystone
+    module Admin
+
+      class Tenant < Base
+
+        schema do
+          attribute :enabled, :boolean
+          attribute :name, :string
+          attribute :description, :string
+        end
+
+        validates :enabled, :inclusion => {:in => [true, false]}
+        validates :name, :format => {:with => /\A\w[\w\s]+\w\Z/}
+        validates :description, :format => {:with => /\A[\w\s\.\-:@+,'"]+\Z/}
+
+        def self.find_every(options)
+          class_name = self.name.split('::').last.downcase
+          begin
+            case from = options[:from]
+              when Symbol
+                instantiate_collection(get(from, options[:params]))
+              when String
+                path = "#{from}#{query_string(options[:params])}"
+                instantiate_collection(format.decode(connection.get(path, headers).body)[class_name.pluralize] || [])
+              else
+                prefix_options, query_options = split_options(options[:params])
+                path = collection_path(prefix_options, query_options)
+                instantiate_collection((format.decode(connection.get(path, headers).body)[class_name.pluralize] || []), prefix_options)
+            end
+          rescue ActiveResource::ResourceNotFound
+            # Swallowing ResourceNotFound exceptions and return nil - as per
+            # ActiveRecord.
+            nil
+          end
+        end
+
+        def self.find_by_name(name)
+          all.detect { |x| x.name == name }
+        end
+
+        def initialize(params = {}, persisted = false)
+          super(params, persisted)
+
+          self.description = description
+        end
+
+
+        def users(scope = :all)
+          User.find(scope, :params => {:tenant_id => self.id})
+        end
+
+        def user(id)
+          users(id)
+        end
+
+        def user_roles(user, scope = :all)
+          Role.find(scope, :params => {:tenant_id => self.id, :user_id => user.is_a?(User) ? user.id : user})
+        end
+
+        def add_role_to_user(role, user)
+          role_id = role.is_a?(OpenStack::Keystone::Admin::Role) ? role.id : role
+          user_id = user.is_a?(OpenStack::Keystone::Admin::User) ? user.id : user
+
+          put("users/#{user_id}/roles/OS-KSADM/#{role_id}", {}, "null")
+        end
+
+        def delete_role_from_user(role, user)
+          role_id = role.is_a?(OpenStack::Keystone::Admin::Role) ? role.id : role
+          user_id = user.is_a?(OpenStack::Keystone::Admin::User) ? user.id : user
+
+          delete("users/#{user_id}/roles/OS-KSADM/#{role_id}")
+        end
+
+        def role(user)
+          users(user)
+        end
+
+        def description=(description)
+          @attributes[:description] = description.gsub /[^\w\s\.\-:@+,'"]/, '_' if description
+
+        end
+      end
+
+    end
+  end
+end

data/lib/open_stack/keystone/admin/user.rb

@@ -0,0 +1,98 @@
+# This file is part of the OpenStack-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - d.guerri@unidata.it)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OpenStack
+  module Keystone
+    module Admin
+
+      class User < Base
+
+        schema do
+          attribute :name, :string
+          attribute :password, :string
+          attribute :email, :string
+          attribute :enabled, :boolean
+          attribute :tenant_id, :string
+        end
+
+        validates :name, :presence => true
+        validates_length_of :name, :minimum => 4
+        validates_format_of :name, :with => /\A[0-9a-z_]+\Z/i
+        validates_format_of :password, :with => /(?=.*[\d\W])/, :message => :must_contain_at_least_one_digit_or_one_special_character
+        validates_length_of :password, :minimum => 8
+        validates_format_of :email, :with => /\A[-a-z0-9_+\.]+\@([-a-z0-9]+\.)+[a-z0-9]{2,4}\Z/i
+        validates :enabled, :presence => true, :inclusion => {:in => [true, false]}
+
+        def initialize(attributes = {}, persisted = false)
+          attributes = attributes.with_indifferent_access
+
+          if attributes[:tenant].present?
+            attributes[:tenant_id] = attributes.delete(:tenant).id
+          end
+
+          if attributes[:tenantId].present?
+            attributes[:tenant_id] = attributes.delete(:tenantId)
+          end
+
+          super(attributes, persisted)
+        end
+
+        # Overload ActiveRecord::encode method
+        # Custom encoding to deal with openstack API
+        def encode(options={})
+          to_encode = {
+              :user => {
+                  :name => name,
+                  :password => password,
+                  :email => email,
+                  :enabled => enabled
+              }
+          }
+
+          to_encode[:user][:tenantId] = tenant_id if @attributes[:tenant_id].present?
+
+          to_encode.send("to_#{self.class.format.extension}", options)
+        end
+
+        def self.all_by_tenant(tenant)
+          tenant_id = tenant.is_a?(OpenStack::Keystone::Admin::Tenant) ? tenant.id : tenant
+
+          all.select { |user| user.tenant_id == tenant_id }
+        end
+
+        def self.find_by_tenant(id, tenant)
+          tenant_id = tenant.is_a?(OpenStack::Keystone::Admin::Tenant) ? tenant.id : tenant
+
+          user = self.find(id)
+          user.tenant_id == tenant_id ? user : nil
+        end
+
+        def self.find_by_name(name)
+          all.each { |user| return user if user.name == name }
+
+          nil
+        end
+
+        def roles(scope = :all)
+          OpenStack::Keystone::Admin::UserRole.find(scope, :params => { :tenant_id => self.tenant_id, :user_id => self.id })
+        end
+
+      end
+
+    end
+  end
+end

data/lib/open_stack/keystone/admin/user_role.rb

@@ -0,0 +1,34 @@
+# This file is part of the OpenStack-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - d.guerri@unidata.it)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OpenStack
+  module Keystone
+    module Admin
+
+      class UserRole < Base
+        self.element_name = "role"
+
+        def self.site
+          superclass.site + "tenants/:tenant_id/users/:user_id"
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/open_stack/keystone/admin.rb

@@ -0,0 +1,32 @@
+# This file is part of the OpenStack-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - d.guerri@unidata.it)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module OpenStack
+  module Keystone
+
+    module Admin
+      extend ActiveSupport::Autoload
+
+      autoload :Base
+      autoload :Role
+      autoload :Tenant
+      autoload :User
+      autoload :UserRole
+    end
+
+  end
+end