Updated the object mask for the new filterMask root property type. Fixed a bug which prevented objects from updating properly

Author: SLsthompson

lib/softlayer/ModelBase.rb

@@ -61,7 +61,7 @@ def to_ary
     # and return the new hash.
     #
     def refresh_details(object_mask = nil)
-      softlayer_hash = self.softlayer_properties(object_mask)
+      @softlayer_hash = self.softlayer_properties(object_mask)
     end
 
     ##

lib/softlayer/ObjectMaskParser.rb

@@ -53,17 +53,17 @@ def parse(mask_string)
       elsif token.type == :property_set_start
         property_set = parse_property_set(@tokenizer)
       else
-        raise ObjectMaskParserError, "A valid Object mask is a 'mask' root property, or a property set containing root properties" + ObjectMaskToken.error_for_unexpected_token(token)
+        raise ObjectMaskParserError, "A valid Object mask is a 'mask' or 'filterMask' root property, or a property set containing root properties" + ObjectMaskToken.error_for_unexpected_token(token)
       end
 
       recognize_token(@tokenizer, :eos, "Extraneous text after object mask: ")
 
-      if property && property.name != "mask"
-        raise ObjectMaskParserError, "Object Mask must begin with a 'mask' root property"
+      if property && (property.name != "mask" && propertyName != "filterMask")
+        raise ObjectMaskParserError, "Object Mask must begin with a 'mask' or 'filterMask' root property"
       end
 
-      if property_set && property_set.find { |subproperty| subproperty.name != 'mask'}
-        raise ObjectMaskParserError, "A root property set must contain only root properties"
+      if property_set && property_set.find { |subproperty| subproperty.name != 'mask' && subproperty.name != 'filterMask' }
+        raise ObjectMaskParserError, "A root property set must contain only 'mask' or 'filterMask' root properties"
       end
 
       property || property_set

lib/softlayer/Server.rb

@@ -119,15 +119,16 @@ def notes=(new_notes)
       }
 
       service.object_with_id(self.id).editObject(edit_template)
+      self.refresh_details()
     end
 
     ##
     # Change the user metadata for the server.
     #
     def user_metadata=(new_metadata)
       raise ArgumentError.new("Cannot set user metadata to nil") unless new_metadata
-
       service.object_with_id(self.id).setUserMetadata([new_metadata])
+      self.refresh_details()
     end
 
     ##
@@ -143,6 +144,7 @@ def set_hostname!(new_hostname)
       }
 
       service.object_with_id(self.id).editObject(edit_template)
+      self.refresh_details()
     end
 
     ##
@@ -160,6 +162,7 @@ def set_domain!(new_domain)
       }
 
       service.object_with_id(self.id).editObject(edit_template)
+      self.refresh_details()
     end
 
     ##
@@ -179,6 +182,7 @@ def change_port_speed(new_speed, public = true)
         service.object_with_id(self.id).setPrivateNetworkInterfaceSpeed(new_speed)
       end
 
+      self.refresh_details()
       self
     end
 

lib/softlayer/VirtualServer.rb

@@ -54,7 +54,6 @@ class VirtualServer < Server
     # transaction can be active at a time.
     sl_attr :activeTransaction
 
-
     ##
     # :attr_reader:
     # Storage devices attached to the server. Storage may be local
@@ -187,6 +186,7 @@ def wait_until_ready(max_trials, wait_for_transactions = false, seconds_between_
         # a server is ready when it is provisioned, not reloading the OS
         # (and if wait_for_transactions is true, when there are no active transactions).
         ready = provisioned && !reloading_os && (!wait_for_transactions || !has_active_transaction)
+
         num_trials = num_trials + 1
 
         yield ready if block_given?

lib/softlayer/object_mask_helpers.rb

@@ -28,7 +28,7 @@ class Hash
   # Given a hash, generate an Object Mask string from the structure
   # found within the hash. This allows object masks to be constructed
   # as hashes, then converted to strings when they must be passed
-  # to the API. The routine does some very rudimentary validation to 
+  # to the API. The routine does some very rudimentary validation to
   # ensure that the hash represents a valid object mask, but care must
   # still be taken when constructing the hash.
   def to_sl_object_mask()
@@ -40,7 +40,7 @@ def to_sl_object_mask()
   end
 
   # Returns a string representing the hash as a property within a larger
-  # object mask. This routine is an implementation detail used in the conversion 
+  # object mask. This routine is an implementation detail used in the conversion
   # of hashes to object mask strings. You should not have to call this method directly.
   def _to_sl_object_mask_property()
     key_strings = __sl_object_mask_properties_for_keys();
@@ -112,9 +112,9 @@ def _to_sl_object_mask_property()
 # Softlayer Extensions to the Symbol class to support using symbols to create
 # object masks
 class Symbol
-  # Converts the Symbol to a string, then converts the string to an 
-  # object mask property. This routine is an implementation detail used in 
-  # the conversion of hashes to object mask strings. You should not have to 
+  # Converts the Symbol to a string, then converts the string to an
+  # object mask property. This routine is an implementation detail used in
+  # the conversion of hashes to object mask strings. You should not have to
   # call this method directly.
   def _to_sl_object_mask_property()
     self.to_s._to_sl_object_mask_property()

spec/ModelBase_spec.rb

@@ -64,4 +64,19 @@
     expect(test_model.to_ary).to be_nil
   end
 
+  it "realizes when low-level hash keys are added" do
+    test_model = SoftLayer::ModelBase.new(nil, { "id" => "12345" })
+    allow(test_model).to receive(:softlayer_properties) { { "id" => "12345", "newInfo" => "fun" } }
+    expect(test_model.has_sl_property? :newInfo).to be_false
+    test_model.refresh_details()
+    expect(test_model.has_sl_property? :newInfo).to be_true
+  end
+
+  it "realizes when low-level hash keys are removed" do
+    test_model = SoftLayer::ModelBase.new(nil, { "id" => "12345", "newInfo" => "fun" })
+    allow(test_model).to receive(:softlayer_properties) { { "id" => "12345" } }
+    expect(test_model.has_sl_property? :newInfo).to be_true
+    test_model.refresh_details()
+    expect(test_model.has_sl_property? :newInfo).to be_false
+  end
 end