Merge pull request #57 from relaxdiego/feature/28

Add ability to specify an alias for a given request param
    
This allows us to call params with the more familiar Ruby
case/capitalization. For instance, defining the following:
    
param :imageRef, alias: :image_ref
    
in a request file makes the following possible:
    
    session.compute_service.request :create_server do |params|
      params[:imageRef] = 'something'
    end
    
    session.compute_service.request :create_server do |params|
      params.image_ref = 'something'
    end
    
NOTE: At this point, params can only be called via method
calls and not via the [] accessor.

lib/aviator/core/request.rb

@@ -128,11 +128,27 @@ module Aviator
       end
 
 
+      def param_aliases
+        @param_aliases ||= {}
+      end
+
+
       def params_class
-        all_params = required_params + optional_params
+        all_params    = required_params + optional_params
+        param_aliases = self.param_aliases
 
         if all_params.length > 0
-          @params_class ||= Struct.new(*all_params)
+          @params_class ||= Struct.new(*all_params) do
+                              param_aliases.each do |param_alias, param_name|
+                                define_method param_alias do
+                                  self[param_name]
+                                end
+                                
+                                define_method "#{ param_alias }=" do |value|
+                                  self[param_name] = value
+                                end
+                              end
+                            end
         end
 
         @params_class
@@ -182,6 +198,10 @@ module Aviator
         opts  = opts.with_indifferent_access
         list  = (opts[:required] == false ? optional_params : required_params)
         list << param_name unless optional_params.include?(param_name)
+
+        if opts[:alias]
+          self.param_aliases[opts[:alias]] = param_name
+        end
       end
 
     end

lib/aviator/openstack/compute/v2/admin/resize_server.rb

@@ -9,7 +9,7 @@ module Aviator
 
     param :id,        required: true
     param :name,      required: true
-    param :flavorRef, required: true
+    param :flavorRef, required: true, alias: :flavor_ref
 
 
     def body

lib/aviator/openstack/compute/v2/public/change_admin_password.rb

@@ -10,7 +10,7 @@ module Aviator
     link 'additional spec',
          'https://answers.launchpad.net/nova/+question/228462'
 
-    param :adminPass, required: true
+    param :adminPass, required: true, alias: :admin_pass
     param :id,        required: true
 
 

lib/aviator/openstack/compute/v2/public/create_server.rb

@@ -7,11 +7,11 @@ module Aviator
     link 'documentation',
          'http://docs.openstack.org/api/openstack-compute/2/content/CreateServers.html'
 
-    param :accessIPv4,  required: false
+    param :accessIPv4,  required: false, alias: :access_ipv4
-    param :accessIPv6,  required: false
+    param :accessIPv6,  required: false, alias: :access_ipv6
-    param :adminPass,   required: false
+    param :adminPass,   required: false, alias: :admin_pass
-    param :imageRef,    required: true
+    param :imageRef,    required: true,  alias: :image_ref
-    param :flavorRef,   required: true
+    param :flavorRef,   required: true,  alias: :flavor_ref
     param :metadata,    required: false
     param :name,        required: true
     param :networks,    required: false

lib/aviator/openstack/compute/v2/public/list_addresses.rb

@@ -12,7 +12,7 @@ module Aviator
 
 
     param :id,        required: true
-    param :networkID, required: false
+    param :networkID, required: false, alias: :network_id
 
 
     def headers

lib/aviator/openstack/compute/v2/public/list_flavors.rb

@@ -8,8 +8,8 @@ module Aviator
          'http://docs.openstack.org/api/openstack-compute/2/content/List_Flavors-d1e4188.html'
 
     param :details, required: false
-    param :minDisk, required: false
+    param :minDisk, required: false, alias: :min_disk
-    param :minRam,  required: false
+    param :minRam,  required: false, alias: :min_ram
     param :marker,  required: false
     param :limit,   required: false
 

lib/aviator/openstack/compute/v2/public/list_images.rb

@@ -11,7 +11,7 @@ module Aviator
     param :server,         required: false
     param :name,           required: false
     param :status,         required: false
-    param 'changes-since', required: false
+    param 'changes-since', required: false, alias: :changes_since
     param :marker,         required: false
     param :limit,          required: false
     param :type,           required: false

lib/aviator/openstack/compute/v2/public/list_servers.rb

@@ -24,7 +24,7 @@ module Aviator
     param :marker,         required: false
     param :server,         required: false
     param :status,         required: false
-    param 'changes-since', required: false
+    param 'changes-since', required: false, alias: :changes_since
 
 
     def headers

lib/aviator/openstack/compute/v2/public/rebuild_server.rb

@@ -7,11 +7,11 @@ module Aviator
     link 'documentation',
          'http://docs.openstack.org/api/openstack-compute/2/content/Rebuild_Server-d1e3538.html'
 
-    param :accessIPv4,  required: false
+    param :accessIPv4,  required: false, alias: :access_ipv4
-    param :accessIPv6,  required: false
+    param :accessIPv6,  required: false, alias: :access_ipv6
-    param :adminPass,   required: true
+    param :adminPass,   required: true,  alias: :admin_pass
     param :id,          required: true
-    param :imageRef,    required: true
+    param :imageRef,    required: true,  alias: :image_ref
     param :metadata,    required: false
     param :name,        required: true
     param :personality, required: false

lib/aviator/openstack/compute/v2/public/update_server.rb

@@ -7,8 +7,8 @@ module Aviator
     link 'documentation',
          'http://docs.openstack.org/api/openstack-compute/2/content/ServerUpdate.html'
 
-    param :accessIPv4, required: false
+    param :accessIPv4, required: false, alias: :access_ipv4
-    param :accessIPv6, required: false
+    param :accessIPv6, required: false, alias: :access_ipv6
     param :id,         required: true
     param :name,       required: false
 

lib/aviator/openstack/identity/v2/admin/create_user.rb

@@ -23,7 +23,7 @@ module Aviator
 
     param :email,     required: false
     param :enabled,   required: false
-    param :tenantId,  required: false
+    param :tenantId,  required: false, alias: :tenant_id
 
 
     def body

lib/aviator/openstack/identity/v2/admin/update_user.rb

@@ -19,7 +19,7 @@ module Aviator
     param :password,  required: false
     param :email,     required: false
     param :enabled,   required: false
-    param :tenantId,  required: false
+    param :tenantId,  required: false, alias: :tenant_id
 
 
     def body

lib/aviator/openstack/identity/v2/public/create_token.rb

@@ -14,9 +14,9 @@ module Aviator
 
     param :username,   required: false
     param :password,   required: false
-    param :tokenId,    required: false
+    param :tokenId,    required: false, alias: :token_id
-    param :tenantName, required: false
+    param :tenantName, required: false, alias: :tenant_name
-    param :tenantId,   required: false
+    param :tenantId,   required: false, alias: :tenant_id
 
 
     def body

test/aviator/core/request_test.rb

@@ -212,6 +212,38 @@ class Aviator::Test
         error.message.must_include "private method"
       end
       
+      
+      it 'accepts an alias for a given parameter' do
+        klass = Class.new(Aviator::Request) do
+                  param :the_param, required: true, alias: :the_alias
+                end
+        
+        param_val = 999
+        
+        req = klass.new do |params|
+                params.the_param = param_val
+              end
+        
+        req.params.the_param.must_equal param_val
+        req.params.the_alias.must_equal param_val
+      end
+      
+      
+      it 'makes the param alias assignable' do
+        klass = Class.new(Aviator::Request) do
+                  param :the_param, required: true, alias: :the_alias
+                end
+        
+        param_val = 999
+        
+        req = klass.new do |params|
+                params.the_alias = param_val
+              end
+        
+        req.params.the_param.must_equal param_val
+        req.params.the_alias.must_equal param_val
+      end
+    
     end
     
     

test/aviator/openstack/compute/v2/admin/resize_server_test.rb

@@ -119,6 +119,15 @@ class Aviator::Test
     end
     
     
+    validate_attr :param_aliases do
+      aliases = {
+        flavor_ref: :flavorRef
+      }
+      
+      klass.param_aliases.must_equal aliases
+    end
+
+
     validate_attr :url do
       service_spec = get_session_data[:access][:serviceCatalog].find{|s| s[:type] == 'compute' }
       url          = "#{ service_spec[:endpoints][0][:publicURL] }/servers/#{ server[:id] }/action"

test/aviator/openstack/compute/v2/public/change_admin_password_test.rb

@@ -93,6 +93,15 @@ class Aviator::Test
     end
     
     
+    validate_attr :param_aliases do
+      aliases = {
+        admin_pass: :adminPass
+      }
+      
+      klass.param_aliases.must_equal aliases
+    end
+        
+    
     validate_attr :url do
       service_spec = get_session_data[:access][:serviceCatalog].find{|s| s[:type] == 'compute' }
       server_id    = '105b09f0b6500d36168480ad84'

test/aviator/openstack/compute/v2/public/create_server_test.rb

@@ -121,6 +121,19 @@ class Aviator::Test
     end
     
     
+    validate_attr :param_aliases do
+      aliases = {
+        access_ipv4: :accessIPv4,
+        access_ipv6: :accessIPv6,
+        admin_pass:  :adminPass,
+        image_ref:   :imageRef,
+        flavor_ref:  :flavorRef
+      }
+      
+      klass.param_aliases.must_equal aliases
+    end
+    
+
     validate_response 'parameters are provided' do
       image_id  = session.compute_service.request(:list_images).body[:images].first[:id]
       flavor_id = session.compute_service.request(:list_flavors).body[:flavors].first[:id]

test/aviator/openstack/compute/v2/public/list_addresses_test.rb

@@ -108,6 +108,15 @@ class Aviator::Test
     end
     
     
+    validate_attr :param_aliases do
+      aliases = {
+        network_id: :networkID
+      }
+      
+      klass.param_aliases.must_equal aliases
+    end
+        
+    
     validate_response 'a valid server id is provided' do
       server_id = session.compute_service.request(:list_servers).body[:servers].first[:id]
       

test/aviator/openstack/compute/v2/public/list_flavors_test.rb

@@ -116,6 +116,16 @@ class Aviator::Test
     end
 
 
+    validate_attr :param_aliases do
+      aliases = {
+        min_disk: :minDisk,
+        min_ram:  :minRam
+      }
+
+      klass.param_aliases.must_equal aliases
+    end
+
+
     validate_response 'no parameters are provided' do
       response = session.compute_service.request :list_flavors
 

test/aviator/openstack/compute/v2/public/list_images_test.rb

@@ -121,6 +121,15 @@ class Aviator::Test
     end
 
 
+    validate_attr :param_aliases do
+      aliases = {
+        changes_since: 'changes-since'
+      }
+
+      klass.param_aliases.must_equal aliases
+    end
+
+
     validate_response 'no parameters are provided' do
       service = Aviator::Service.new(
         provider: 'openstack',

test/aviator/openstack/compute/v2/public/list_servers_test.rb

@@ -136,6 +136,15 @@ class Aviator::Test
     end
 
 
+    validate_attr :param_aliases do
+      aliases = {
+        changes_since: 'changes-since'
+      }
+
+      klass.param_aliases.must_equal aliases
+    end
+
+
     validate_response 'no parameters are provided' do
       service = Aviator::Service.new(
         provider: 'openstack',

test/aviator/openstack/compute/v2/public/rebuild_server_test.rb

@@ -118,6 +118,18 @@ class Aviator::Test
     end
 
 
+    validate_attr :param_aliases do
+      aliases = {
+        access_ipv4: :accessIPv4,
+        access_ipv6: :accessIPv6,
+        admin_pass:  :adminPass,
+        image_ref:   :imageRef
+      }
+
+      klass.param_aliases.must_equal aliases
+    end
+
+
     validate_response 'valid params are provided' do
       server    = session.compute_service.request(:list_servers).body[:servers].first
       server_id = server[:id]

test/aviator/openstack/compute/v2/public/update_server_test.rb

@@ -107,6 +107,16 @@ class Aviator::Test
     end
 
 
+    validate_attr :param_aliases do
+      aliases = {
+        access_ipv4: :accessIPv4,
+        access_ipv6: :accessIPv6
+      }
+
+      klass.param_aliases.must_equal aliases
+    end
+
+
     validate_response 'valid server id is provided' do
       server    = session.compute_service.request(:list_servers).body[:servers].first
       server_id = server[:id]

test/aviator/openstack/identity/v2/admin/create_user_test.rb

@@ -119,6 +119,15 @@ class Aviator::Test
     end
 
 
+    validate_attr :param_aliases do
+      aliases = {
+        tenant_id: :tenantId
+      }
+
+      klass.param_aliases.must_equal aliases
+    end
+
+
     validate_response 'invalid param is provided' do
       service = session.identity_service
 

test/aviator/openstack/identity/v2/admin/update_user_test.rb

@@ -105,6 +105,15 @@ class Aviator::Test
     end
 
 
+    validate_attr :param_aliases do
+      aliases = {
+        tenant_id: :tenantId
+      }
+
+      klass.param_aliases.must_equal aliases
+    end
+
+
     validate_response 'valid user id is provided' do
       # must be hardcoded so as not to inadvertently alter random resources
       # in case the corresponding cassette is deleted

test/aviator/openstack/identity/v2/public/create_token_test.rb

@@ -92,6 +92,17 @@ class Aviator::Test
     end
 
 
+    validate_attr :param_aliases do
+      aliases = {
+        token_id:    :tokenId,
+        tenant_name: :tenantName,
+        tenant_id:   :tenantId
+      }
+
+      klass.param_aliases.must_equal aliases
+    end
+
+
     validate_response 'parameters are invalid' do
       service = Aviator::Service.new(
         provider: 'openstack',