openstack_activeresource 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source :rubygems
+
+gem "activemodel", :require => 'active_model'
+gem "activeresource", :require => 'active_resource'
+
+gem "oj", "~> 1.2.9"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.2.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+end
+

data/Gemfile.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.6)
+      activesupport (= 3.2.6)
+      builder (~> 3.0.0)
+    activeresource (3.2.6)
+      activemodel (= 3.2.6)
+      activesupport (= 3.2.6)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    multi_json (1.3.6)
+    oj (1.2.9)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.1.1)
+      shoulda-context (~> 1.0)
+      shoulda-matchers (~> 1.2)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.2.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  activeresource
+  bundler (~> 1.2.0)
+  jeweler (~> 1.8.4)
+  oj (~> 1.2.9)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,14 @@
+OpenStack-ActiveResource
+
+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/>.

data/README.rdoc

@@ -0,0 +1,427 @@
+= openstack_activeresource
+
+OpenStack API Ruby bindings with ActiveResource
+
+Supported API:
+* Glance
+* Keystone (admin and public)
+* Nova
+
+Tested on Folsom and Essex release.
+
+== Installation
+
+    ~# gem install openstack_activeresource
+
+== Sample usages
+
+=== List available tenants (require the 'admin' role)
+
+    require 'openstack_activeresource'
+
+    # Set Keystone Public API endpoint
+    OpenStack::Keystone::Public::Base.site = "https://my.keystone.api.server:5000/v2.0/"
+
+    # Authentication
+    auth = OpenStack::Keystone::Public::Auth.create :username => "adminuser", :password => "adminpassword", :tenant_id => "admintenant_ID"
+
+    # Set the auth token for next API requests
+    OpenStack::Base.token = auth.token
+
+    OpenStack::Keystone::Public::Tenant.all.each { |tenant|
+        printf "Name: %s (id: %s, enabled? %s) - %s\n",
+            tenant.name.center(15), tenant.id.center(20), tenant.enabled.to_s.center(6), tenant.description
+    }
+
+=== Creating a new tenant and a new user (require the 'admin' role)
+
+    require 'openstack_activeresource'
+
+    # Set Keystone Public and Admin API endpoints
+    OpenStack::Keystone::Public::Base.site = "https://my.keystone.api.server:5000/v2.0/"
+    OpenStack::Keystone::Admin::Base.site = "https://my.keystone.api.server:35357/v2.0/"
+
+    # Authentication
+    auth = OpenStack::Keystone::Public::Auth.create :username => "adminuser", :password => "adminpassword", :tenant_id => "admintenant_ID"
+
+    # Set the auth token for next API requests
+    OpenStack::Base.token = auth.token
+
+    # Create a new tenant
+    new_tenant = OpenStack::Keystone::Admin::Tenant.create :enabled => true, :name => "TestTenant", :description => "My new tenant" 
+
+    # Create a new user in new_tenant
+    new_user = OpenStack::Keystone::Admin::User.create :tenant => new_tenant, :name => "TestUser", :password => "testpassword", :email => "test@user.com", :enabled => true
+
+    # Assign the "memberRole" in new_tenant to new_user
+    member_role = OpenStack::Keystone::Admin::Role.find_by_name "memberRole"
+    new_tenant.add_role_to_user member_role, new_user
+
+=== List image index from Nova
+
+    require 'openstack_activeresource'
+
+    # Set Keystone Public API endpoint
+    OpenStack::Keystone::Public::Base.site = "https://my.keystone.api.server:5000/v2.0/"
+
+    # Authentication
+    auth = OpenStack::Keystone::Public::Auth.create :username => "user", :password => "password", :tenant_id => "tenant_id"
+
+    # Set the auth token for next API requests
+    OpenStack::Base.token = auth.token
+
+    # Set the Nova Compute API endpoint from the received service catalog
+    OpenStack::Nova::Compute::Base.site = auth.endpoint_for('compute').publicURL
+
+    OpenStack::Nova::Compute::Image.all.each { |image|
+      printf "Name: %s (%s), minDisk: %3i, minRam: %5i, Status: %s, Progress: %3i\n",
+             image.name.center(40),
+             image.image_type.center(8),
+             image.min_disk || 0,
+             image.min_ram || 0,
+             image.status(7),
+             image.progress
+    }
+
+=== List virtual servers for a tenant
+
+    require 'openstack_activeresource'
+
+    # Set Keystone Public API endpoint
+    OpenStack::Keystone::Public::Base.site = "https://my.keystone.api.server:5000/v2.0/"
+
+    # Authentication
+    auth = OpenStack::Keystone::Public::Auth.create :username => "user", :password => "password", :tenant_id => "tenant_id"
+
+    # Set the auth token for next API requests
+    OpenStack::Base.token = auth.token
+
+    # Set the Nova Compute API endpoint from the received service catalog
+    OpenStack::Nova::Compute::Base.site = auth.endpoint_for('compute').publicURL
+
+    # Get all the servers
+    servers = OpenStack::Nova::Compute::Server.all
+
+    # To get only active server: OpenStack::Compute::Server.find :all, :params => {:status => "ACTIVE"}
+
+    servers.each { |s|
+      printf "Name: %s, Status: %s, Image: %s, Flavor: %s, Created: %s, Updated: %s\n",
+             s.name.center(20),
+             s.status.center(10),
+             s.image.id,
+             s.flavor.id,
+             s.created_at.to_time.localtime,
+             s.updated_at.to_time.localtime
+    }
+
+=== List available flavors
+
+    require 'openstack_activeresource'
+
+    # Set Keystone Public API endpoint
+    OpenStack::Keystone::Public::Base.site = "https://my.keystone.api.server:5000/v2.0/"
+
+    # Authentication
+    auth = OpenStack::Keystone::Public::Auth.create :username => "user", :password => "password", :tenant_id => "tenant_id"
+
+    # Set the auth token for next API requests
+    OpenStack::Base.token = auth.token
+
+    # Set the Nova Compute API endpoint from the received service catalog
+    OpenStack::Nova::Compute::Base.site = auth.endpoint_for('compute').publicURL
+
+    # Get available flavors
+    flavors = OpenStack::Nova::Compute::Flavor.all
+
+    flavors.each { |f|
+      printf "Name: %s, Id: %s, Ram: %5i, Disk: %3i (Ephemeral: %3i), vCPU: %2i\n", f.name.center(15), f.id.center(20), f.ram, f.disk, f.ephemeral_disk, f.vcpus
+    }
+
+=== Create a flavor (require 'admin' role)
+
+    require 'openstack_activeresource'
+
+    # Set Keystone Public API endpoint
+    OpenStack::Keystone::Public::Base.site = "https://my.keystone.api.server:5000/v2.0/"
+
+    # Authentication
+    auth = OpenStack::Keystone::Public::Auth.create :username => "adminuser", :password => "adminpassword", :tenant_id => "admintenant_ID"
+
+    # Set the auth token for next API requests
+    OpenStack::Base.token = auth.token
+
+    # Set the Nova Compute API endpoint from the received service catalog
+    OpenStack::Nova::Compute::Base.site = auth.endpoint_for('compute').publicURL
+
+    # Create a flavor
+    flavors = OpenStack::Nova::Compute::Flavor.create :name => 'my_new_flavor', :ram => 1024, :disk => 20, :ephemeral_disk => 0
+
+=== List available security groups
+
+    require 'openstack_activeresource'
+
+    # Set Keystone Public API endpoint
+    OpenStack::Keystone::Public::Base.site = "https://my.keystone.api.server:5000/v2.0/"
+
+    # Authentication
+    auth = OpenStack::Keystone::Public::Auth.create :username => "user", :password => "password", :tenant_id => "tenant_id"
+
+    # Set the auth token for next API requests
+    OpenStack::Base.token = auth.token
+
+    # Set the Nova Compute API endpoint from the received service catalog
+    OpenStack::Nova::Compute::Base.site = auth.endpoint_for('compute').publicURL
+
+    # Get available security groups
+    security_groups = OpenStack::Nova::Compute::SecurityGroup.all
+
+    security_groups.each { |sg|
+      printf "Name: %s, Description: %s\n", sg.name.center(20), sg.description.center(50)
+
+      sg.rules.each { |r|
+        printf "Protocol: %s, From port: %5i, To port: %5i, Addresses: %s\n",
+               r.ip_protocol.center(4),
+               r.from_port,
+               r.to_port,
+               r.cidr.present? ? r.cidr.center(18) : ''.center(18)
+      }
+      puts "\n"
+    }
+
+=== List available Floating IPs
+
+    require 'openstack_activeresource'
+
+    # Set Keystone Public API endpoint
+    OpenStack::Keystone::Public::Base.site = "https://my.keystone.api.server:5000/v2.0/"
+
+    # Authentication
+    auth = OpenStack::Keystone::Public::Auth.create :username => "user", :password => "password", :tenant_id => "tenant_id"
+
+    # Set the auth token for next API requests
+    OpenStack::Base.token = auth.token
+
+    # Set the Nova Compute API endpoint from the received service catalog
+    OpenStack::Nova::Compute::Base.site = auth.endpoint_for('compute').publicURL
+
+    # Get available floating IPs
+    floatings = OpenStack::Nova::Compute::FloatingIp.all
+
+    floatings.each { |floating|
+      printf "IP: %s, Fixed IP: %s, Pool: %s, Instance: %s (%s)\n",
+             floating.ip.center(20),
+             floating.fixed_ip.present? ? floating.fixed_ip.center(20) : "".center(20),
+             floating.pool.center(20),
+             floating.instance_id.present? ? floating.instance_id.center(40) : "".center(40),
+             floating.instance.present? ? floating.instance.name.center(15) : "".center(15)
+
+    }
+
+=== Start a new virtual server and play with it
+
+    require 'openstack_activeresource'
+
+    # Set Keystone Public API endpoint
+    OpenStack::Keystone::Public::Base.site = "https://my.keystone.api.server:5000/v2.0/"
+
+    # Authentication
+    auth = OpenStack::Keystone::Public::Auth.create :username => "user", :password => "password", :tenant_id => "tenant_id"
+
+    # Set the auth token for next API requests
+    OpenStack::Base.token = auth.token
+
+    # Set the Nova Compute API endpoint from the received service catalog
+    OpenStack::Nova::Compute::Base.site = auth.endpoint_for('compute').publicURL
+
+    # Generate a new keypair
+    new_keypair = OpenStack::Nova::Compute::KeyPair.create :name => 'my_new_keypair'
+
+    # Prints out keypair info (!)
+    printf "Public key: %s\nPrivate key: %s\nKeypair Fingerprint: %s\n",
+        new_keypair.public_key,
+        new_keypair.private_key,
+        new_keypair.fingerprint
+
+    # Start a new virtual server
+    new_server = OpenStack::Nova::Compute::Server.create(
+        :name => 'my_new_server',
+        :flavor => OpenStack::Nova::Compute::Flavor.find_by_name('m1.tiny'),
+        :image => OpenStack::Nova::Compute::Image.find_by_name('Ubuntu Server 12.04 LTS amd64')
+        :key_pair => new_keypair,
+        :security_groups => OpenStack::Nova::Compute::SecurityGroup.all
+    )
+
+    # ... time passes...
+    sleep 5
+    # ... time passes...
+    new_server.refresh_status!
+    # Get server status
+    puts new_server.status
+
+    # Pause/unpause the server
+    new_server.pause
+    # ... time passes...
+    sleep 5
+    # ... time passes...
+    new_server.unpause
+
+    # Suspend/resume the server
+    new_server.suspend
+    # ... time passes...
+    sleep 5
+    # ... time passes...
+    new_server.resume
+
+    # Reboot the server
+    # new_server.reboot(:type => [:soft|:hard]) default :hard
+    new_server.reboot
+
+    # Get the server console output (last 10 row, default 50)
+    puts new_server.console_output(10)
+
+    # Get the server noVNC console URL
+    puts new_server.vnc_console
+
+    # ...code for floating IP retrieval... save the floating IP in my_floating_IP
+    # Add a floating IP to the server
+    new_server.add_floating_ip my_floating_IP
+
+    # ...code for volume retrieval... save the volume in my_volume
+    # Attach a volume to new_server
+    new_server.attach_volume! my_volume, '/dev/vdb'
+
+
+=== List available volumes
+
+    require 'openstack_activeresource'
+
+    # Set Keystone Public API endpoint
+    OpenStack::Keystone::Public::Base.site = "https://my.keystone.api.server:5000/v2.0/"
+
+    # Authentication
+    auth = OpenStack::Keystone::Public::Auth.create :username => "user", :password => "password", :tenant_id => "tenant_id"
+
+    # Set the auth token for next API requests
+    OpenStack::Base.token = auth.token
+
+    # Set the Nova Volume API endpoint from the received service catalog
+    OpenStack::Nova::Volume::Base.site = auth.endpoint_for('volume').publicURL
+
+    # Get available volumes
+    volumes = OpenStack::Nova::Volume::Volume.all
+
+    volumes.each { |volume|
+      printf "Name: %s, Status: %s\n", volume.display_name.center(20), volume.status.center(50)
+    }
+
+=== Simple tenant usage (require 'admin' role)
+
+    require 'openstack_activeresource'
+
+    # Set Keystone Public and Admin API endpoints
+    OpenStack::Keystone::Public::Base.site = "https://my.keystone.api.server:5000/v2.0/"
+
+    # Authentication
+    auth = OpenStack::Keystone::Public::Auth.create :username => "adminuser", :password => "adminpassword", :tenant_id => "admintenant_ID"
+
+    # Set the auth token for next API requests
+    OpenStack::Base.token = auth.token
+
+    # Set the Nova Compute API endpoint from the received service catalog
+    OpenStack::Nova::Compute::Base.site = auth.endpoint_for('compute').publicURL
+
+    # Get the tenant
+    tenant = OpenStack::Keystone::Admin::Tenant.find_by_name "the_tenant"
+
+    # Get usage for a single tenant
+    simple_usage = OpenStack::Nova::Compute::SimpleTenantUsage.find tenant.id, :params => {:start => '1998-07-29T00:00:01', :end => '2012-07-09T00:00:00'}
+    # Or:
+    #past_month_start = (DateTime.now - 1.month).at_beginning_of_month
+    #past_month_end = (DateTime.now - 1.month).at_end_of_month
+    #simple_usage = OpenStack::Nova::Compute::SimpleTenantUsage.find_between_dates tenant.id, past_month_start, past_month_end
+
+    # get usage for all tenants
+    simple_usages = OpenStack::Nova::Compute::SimpleTenantUsage.find_from_date(:all, days.days.ago)
+
+    simple_usages.each { |usage|
+      printf "Tenant: %s, Total hours: %3.3f, Total memory: %8.3f, Total vcpus: %4.3f, Total disk: %5.3f\n",
+             usage.tenant_id.center(30),
+             usage.total_hours,
+             usage.total_memory_mb_usage,
+             usage.total_vcpus_usage,
+             usage.total_local_gb_usage
+
+      usage.server_usages.each { |su|
+        printf "\tName: %s, state: %s, vCPU: %2i, RAM: %5i, Disk: %3i, Started: %31s, Ended: %31s, Hours: %10.5f\n",
+               su.name.center(15),
+               su.state.center(15),
+               su.vcpus,
+               su.memory_mb,
+               su.local_gb,
+               su.started_at.to_time.localtime,
+               su.ended_at.nil? ? '' : su.ended_at.to_time.localtime,
+               su.hours
+      }
+      puts "\n"
+    }
+
+== Using OpenStack-ActiveResource with Ruby on Rails (sample usage)
+
+Create an helper method in your application controller
+
+    class ApplicationController < ActionController::Base
+
+        ...
+
+        private
+
+        def require_openstack_login
+          if OpenStack::Base.token.nil? or OpenStack::Base.token.expired?
+            OpenStack::Keystone::Public::Base.site = <keystone_public_api_uri>
+            # Admin API, if needed
+            OpenStack::Keystone::Admin::Base.site = <keystone_admin_api_uri>
+
+            auth = OpenStack::Keystone::Public::Auth.create :username => <username>, :password => <password>, :tenant_id => <tenant_id>
+
+            OpenStack::Base.token = auth.token
+
+            OpenStack::Nova::Compute::Base.site = auth.endpoint_for('compute').publicURL
+            # Set other endpoints if needed ...
+            # For instance:
+            #   OpenStack::Nova::Volume::Base.site = auth.endpoint_for('volume').publicURL
+
+          end
+        end
+
+        ...
+
+    end
+
+In controllers which need to access the openstack API,
+
+    class OpenStackConsumerController < ApplicationController
+
+        ...
+
+        # "Enable" openstack API only in methods where it is needed
+        before_filter :require_openstack_login, :only => [ :index, :show ]
+
+        ...
+
+    end
+
+== Contributing to openstack_activeresource
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Unidada S.p.A. (Davide Guerri - d.guerri@unidata.it). See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "openstack_activeresource"
+  gem.homepage = "http://github.com/dguerri/openstack_activeresource"
+  gem.license = "GPLv3"
+  gem.summary = %Q{OpenStack Ruby and RoR bindings implemented with ActiveResource}
+  gem.description = %Q{OpenStack Ruby and RoR bindings implemented with ActiveResource}
+  gem.email = "d.guerri@rd.unidata.it"
+  gem.authors = ["Davide Guerri"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['<%= test_task %>'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "OpenStack-ActiveResource #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/hot_fixes.rb

@@ -0,0 +1,55 @@
+# 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/>.
+
+# Reopens ActiveResource::Base to fix "ActiveResource nested resources not being persisted"
+# See https://github.com/rails/rails/pull/3107
+module ActiveResource
+  class Base
+    def load(attributes, remove_root = false)
+      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+      @prefix_options, attributes = split_options(attributes)
+
+      if attributes.keys.size == 1
+        remove_root = self.class.element_name == attributes.keys.first.to_s
+      end
+
+      attributes = Formats.remove_root(attributes) if remove_root
+
+      attributes.each do |key, value|
+        @attributes[key.to_s] =
+            case value
+              when Array
+                resource = nil
+                value.map do |attrs|
+                  if attrs.is_a?(Hash)
+                    resource ||= find_or_create_resource_for_collection(key)
+                    resource.new(attrs, attrs.has_key?(resource.primary_key.to_s))
+                  else
+                    attrs.duplicable? ? attrs.dup : attrs
+                  end
+                end
+              when Hash
+                resource = find_or_create_resource_for(key)
+                resource.new(value, value.has_key?(resource.primary_key.to_s))
+              else
+                value.duplicable? ? value.dup : value
+            end
+      end
+      self
+    end
+  end
+end

data/lib/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  activemodel:
+    errors:
+      messages:
+        must_contain_at_least_one_digit_or_one_special_character: "must contain at least one digit or one special character"