openstack_activeresource 0.2.1 → 0.3.0

data/lib/open_stack/nova/compute/simple_tenant_usage.rb

@@ -19,6 +19,13 @@ module OpenStack
   module Nova
     module Compute
 
+      # Server usages for a tenant
+      #
+      # ==== Attributes
+      # * +total_hours+ - Amount of hour the SimpleTenantUsage instance is related to
+      # * +total_vcpus_usage+ - Aggregated virtual cpu usage
+      # * +total_memory_mb_usage+ - Aggregated memory usage (MBytes)
+      # * +total_local_gb_usage+ - Aggregated storage usage (GBytes)
       class SimpleTenantUsage < Base
         self.element_name = "os-simple-tenant-usage"
         self.collection_name = "os-simple-tenant-usage"
@@ -32,7 +39,8 @@ module OpenStack
           attribute :start, :datetime
         end
 
-        def self.find(*arguments)
+        # Redefine the find method to add the detailed flag
+        def self.find(*arguments) #:nodoc:
           scope = arguments.slice!(0)
           options = arguments.slice!(0) || {}
 
@@ -64,18 +72,11 @@ module OpenStack
           end
         end
 
-        def server_usages
-          @attributes[:server_usages].present? ? @attributes[:server_usages] : []
-        end
-
-        def start
-          DateTime.parse(@attributes[:start] + ' UTC')
-        end
-
-        def stop
-          DateTime.parse(@attributes[:stop] + ' UTC')
-        end
-
+        # Find all server usage from a given date to the current one
+        #
+        # ==== Attributes
+        # * +scope+ - ActiveResource scope (:all, :first, :last, :one or an id)
+        # * +from_date+ - Initial date
         def self.find_from_date(scope, from_date)
           now = Time.now.utc
 
@@ -86,6 +87,12 @@ module OpenStack
 
         end
 
+        # Find all server usage between the given dates
+        #
+        # ==== Attributes
+        # * +scope+ - ActiveResource scope (:all, :first, :last, :one or an id)
+        # * +from_date+ - Initial date
+        # * +to_date+ - Final date
         def self.find_between_dates(scope, from_date, to_date)
           find(scope, :params => {
               :start => from_date.utc.strftime(OpenStack::DATETIME_FORMAT),
@@ -94,8 +101,35 @@ module OpenStack
 
         end
 
+        # OpenStack::Nova::Compute::ServerUsage instances
+        def server_usages
+          @attributes[:server_usages].present? ? @attributes[:server_usages] : []
+        end
+
+        # The start date for the ServerUsage set
+        def start
+          DateTime.parse(@attributes[:start] + ' UTC')
+        end
+
+        # The stop date for the ServerUsage set
+        def stop
+          DateTime.parse(@attributes[:stop] + ' UTC')
+        end
+
       end
 
+      # A server usage entry
+      #
+      # ==== Attributes
+      # * +name+ - The name of the server this entry is related
+      # * +vcpus+ - Virtual CPU used by the server in the timespan (+started_at+ - +ended_at+ or +uptime+) for this entry
+      # * +memory_mb+ - Memory (MBytes) used by the server in the timespan (+started_at+ - +ended_at+ or +uptime+) for this entry
+      # * +local_gb+ - The amount of storage used over the uptime ()GBytes)
+      # * +flavor+ - The flavor id used by the server in this server usage entry
+      # * +state+ - Current state for the server in this server usage entry
+      # * +uptime+ - The uptime of this server in seconds
+      # * +hours+ - The uptime of this server in hours
+      # * +tenant_id+ - The tenant id for this server usage entry
       class ServerUsage < Base
 
         schema do
@@ -112,10 +146,12 @@ module OpenStack
           attribute :ended_at, :datetime
         end
 
+        # The initial date for this server usage entry
         def started_at
           DateTime.parse(@attributes[:started_at] + ' UTC')
         end
 
+        # The final date for this server usage entry (can be nil if the server is still alive)
         def ended_at
           return nil if @attributes[:ended_at].blank?
           DateTime.parse(@attributes[:ended_at] + ' UTC')

data/lib/open_stack/nova/compute/volume_attachment.rb

@@ -19,6 +19,10 @@ module OpenStack
   module Nova
     module Compute
 
+      # A Volume attachment (this class describes an attachment of a volume to a server)
+      #
+      # ==== Attributes
+      # * +device+ - The volume (unique) name (e.g. /dev/vdc)
       class VolumeAttachment < Base
         self.element_name = "volumeAttachment"
         self.collection_name = "os-volume_attachments"
@@ -34,7 +38,7 @@ module OpenStack
         validates :volume, :presence => true
         validates :server, :presence => true
 
-        def initialize(attributes = {}, persisted = false)
+        def initialize(attributes = {}, persisted = false) #:notnew:
           attributes = attributes.with_indifferent_access
           new_attributes = {
               :device => attributes[:device],
@@ -59,9 +63,9 @@ module OpenStack
           new_attachment
         end
 
-        # Overload ActiveRecord::encode method
-        # Custom encoding to deal with openstack API
-        def encode(options={})
+        # Overloads ActiveRecord::encode method
+        def encode(options={}) #:nodoc:
+          # Custom encoding to deal with openstack API
           to_encode = {
               VolumeAttachment.element_name => {
                   :device => device,
@@ -72,20 +76,30 @@ module OpenStack
           to_encode.send("to_#{self.class.format.extension}", options)
         end
 
+        # Return the server to which this volume_attachment is related (if any)
         def server
           Server.find(server_id) if server_id.present?
         end
 
+        # Bind the volume_attachment to a sever
+        #
+        # ==== Attributes
+        # * +server+ - an OpenStack::Nova::Compute::Server instance
         def server=(server)
-          @attributes[:server_id] = server.id unless !persisted?
+          @attributes[:server_id] = server.id if !persisted?
         end
 
+        # Return the volume to which this volume_attachment is related (if any)
         def volume
           Volume::Volume.find(volume_id) if volume_id.present?
         end
 
+        # Bind the volume_attachment to a volume
+        #
+        # ==== Attributes
+        # * +volume+ - an OpenStack::Nova::Compute::Volume instance
         def volume=(volume)
-          @attributes[:volume_id] = volume.id unless !persisted?
+          @attributes[:volume_id] = volume.id if !persisted?
         end
 
       end

data/lib/open_stack/nova/volume/volume.rb

@@ -19,6 +19,17 @@ module OpenStack
   module Nova
     module Volume
 
+      # An OpenStack Volume
+      #
+      # ==== Attributes
+      # * +display_name+ - Volume name
+      # * +display_description+ - Volume description
+      # * +volume_type+ - Volume type identifier
+      # * +size+ - Volume size (GBytes)
+      # * +availability_zone+ - The availability zone for the volume
+      # * +created_at+ - Creation date for the volume
+      # * +snapshot_id+ - The snapshot id for the volume (not nil if this volume is a snapshot)
+      # * +status+ - If the volume is a snapshot, this is the status of the snapshot (i.e. available)
       class Volume < Base
         schema do
           attribute :display_name, :string
@@ -28,15 +39,14 @@ module OpenStack
           attribute :availability_zone, :string
           attribute :created_at, :datetime
           attribute :snapshot_id, :string
-          attribute :status, :string
         end
 
         alias_attribute :name, :display_name
 
         validates :display_name, :presence => true, :format => {:with => /\A[\w\.\-]+\Z/}, :length => {:minimum => 2, :maximum => 255}
-        validates :size, :presence => true, :numericality => { :greater_than_or_equal_to => 1, :only_integer => true }
+        validates :size, :presence => true, :numericality => {:greater_than_or_equal_to => 1, :only_integer => true}
 
-        def initialize(attributes = {}, persisted = false)
+        def initialize(attributes = {}, persisted = false) #:notnew:
           attributes = attributes.with_indifferent_access
           new_attributes = {
               :id => attributes[:id],
@@ -54,7 +64,6 @@ module OpenStack
           super(new_attributes, persisted)
         end
 
-
         # True if the image is a snapshot
         def snapshot?
           persisted? and snapshot_id.present?
@@ -65,7 +74,7 @@ module OpenStack
           !attachments.empty?
         end
 
-        # Gets the first server this volume is attached to (if any)
+        # The first server to which this volume is attached to (if any)
         def server
           Compute::Server.find(attachments[0].server_id) if attached?
         end

data/openstack_activeresource.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "openstack_activeresource"
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Davide Guerri"]
-  s.date = "2013-02-06"
+  s.date = "2013-02-07"
   s.description = "OpenStack Ruby and RoR bindings implemented with ActiveResource - See also http://www.unicloud.it"
   s.email = "d.guerri@rd.unidata.it"
   s.extra_rdoc_files = [

data/test/test_openstack-activeresource.rb

@@ -223,13 +223,11 @@ class TestOpenStackActiveResource < Test::Unit::TestCase
     assert_not_nil my_server, "Server not spawned after 5 seconds!?!"
 
     # Wait for a network address
-    my_fixed_address = loop_block(60) do
+    my_address = loop_block(60) do
       my_server = OpenStack::Nova::Compute::Server.find new_server_id
-      return my_server.addresses[0] if my_server.addresses.count > 0
-
-      nil
+      my_server.addresses.keys.count > 0 ? my_server.addresses : nil
     end
-    assert_not_nil my_fixed_address, "No fixed address after a minute!"
+    assert_not_nil my_address, "No address after a minute!"
 
     assert_nothing_raised ActiveResource::ClientError, "Problem retrieving the server '#{new_server_id}'" do
       my_server = OpenStack::Nova::Compute::Server.find new_server_id

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstack_activeresource
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -212,7 +212,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1167566582415723720
+      hash: 952086221477201945
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: