softlayer_api 1.0.6 → 1.0.7

data/README.textile

@@ -1,6 +1,6 @@
 h1=. SoftLayer API Client for Ruby
 
-The SoftLayer API Client for Ruby is a library for connecting to and calling the routines of "The SoftLayer API":http://sldn.softlayer.com/wiki/index.php/The_SoftLayer_API from the "Ruby":http://www.ruby-lang.org programming language.
+The SoftLayer API Client for Ruby is a library for connecting to and calling the routines of "The SoftLayer API":http://sldn.softlayer.com/article/The_SoftLayer_API from the "Ruby":http://www.ruby-lang.org programming language.
 
 h2. Overview
 
@@ -30,13 +30,13 @@ installs the gem and makes it available to Ruby scripts. Where the gem is instal
 
 h2. Usage
 
-To begin using the Ruby client, you will have to create an instance of the @SoftLayer::Service@ class for each the "API Services":http://sldn.softlayer.com/wiki/index.php/Category:API_Services that your code will call. To create the instance, you will have to provide information that the library will use to authenticate your account with the API servers.
+To begin using the Ruby client, you will have to create an instance of the @SoftLayer::Service@ class for each the "API Services":http://sldn.softlayer.com/reference/services that your code will call. To create the instance, you will have to provide information that the library will use to authenticate your account with the API servers.
 
 Once you have created a service object, you will use that service object to call methods in the SoftLayer API.
 
 h3. Authentication
 
-That instance will have to know your "API authentication information":http://sldn.softlayer.com/wiki/index.php/Authenticating_to_the_SoftLayer_API consisting of your account username and API key. In addition, you will have to select an endpoint, the web address the client will use to contact the SoftLayer API. You may provide this information either through global variables, or by passing them to the constructor.
+That instance will have to know your "API authentication information":http://sldn.softlayer.com/article/Authenticating_to_the_SoftLayer_API consisting of your account username and API key. In addition, you will have to select an endpoint, the web address the client will use to contact the SoftLayer API. You may provide this information either through global variables, or by passing them to the constructor.
 
 h4. Providing authentication information through Globals
 
@@ -55,7 +55,7 @@ table{position:relative;left:2em;width:80%}.
 |{vertical-align:baseline;width:35%}.@API_PUBLIC_ENDPOINT@|A constant containing the base address for the public network REST inspired endpoint of the SoftLayer API - @https://api.softlayer.com/rest/v3/@|
 |{vertical-align:baseline}.@API_PRIVATE_ENDPOINT@|A constant containing the base address for the private network REST inspired endpoint of the SoftLayer API - @https://api.service.softlayer.com/rest/v3/@|
 
-For more information about the two networks see "Choosing_the_Public_or_Private_Network":http://sldn.softlayer.com/wiki/index.php/The_SoftLayer_API#Choosing_the_Public_or_Private_Network. You can change the default endpoint URL by setting the global variable @$SL_API_BASE_URL@ to either of these two values.
+For more information about the two networks see "Choosing_the_Public_or_Private_Network":http://sldn.softlayer.com/article/The_SoftLayer_API#Choosing_the_Public_or_Private_Network. You can change the default endpoint URL by setting the global variable @$SL_API_BASE_URL@ to either of these two values.
 
 Here is an example of using these globals to create a service:
 
@@ -192,7 +192,7 @@ You may add calls to both @object_mask@ and @object_with_id@, but only one call
 
 h2. Examples
 
-Here are some examples that demonstrate using the SoftLayer API Ruby Client. The authentication information, of course, is left as an exercise for the reader.  The first example uses the @getObject@ method of the "SoftLayer_Account":http://sldn.softlayer.com/wiki/index.php/SoftLayer_Account service:
+Here are some examples that demonstrate using the SoftLayer API Ruby Client. The authentication information, of course, is left as an exercise for the reader.  The first example uses the @getObject@ method of the "SoftLayer_Account":http://sldn.softlayer.com/reference/services service:
 
 <pre style="border:1pt solid black;background:#eee;padding:0.5em;margin:0.5em"><code style="font-family:Menlo,Monaco,monospace;font-size:9pt">require 'rubygems'
 require 'softlayer_api'

data/examples/openTickets.rb

@@ -31,7 +31,7 @@ require 'pp'
 $SL_API_USERNAME = "joecustomer"         # enter your username here
 $SL_API_KEY = "feeddeadbeefbadf00d..."   # enter your api key here
 
-# use an account service to get a list of the open tickets and print their 
+# use an account service to get a list of the open tickets and print their
 # IDs and titles
 account_service = SoftLayer::Service.new("SoftLayer_Account")
 

data/examples/ticket_info.rb

@@ -35,8 +35,8 @@ ticket_service = SoftLayer::Service.new("SoftLayer_Ticket",
 begin
   ticket_ref = ticket_service.object_with_id(1683973)
 
-  ticket = ticket_ref.object_mask({"updates" => ["entry", "createDate"]}, 
-                                  "assignedUserId", 
+  ticket = ticket_ref.object_mask({"updates" => ["entry", "createDate"]},
+                                  "assignedUserId",
                                   {"attachedHardware" => "datacenter"}).getObject
   pp ticket
 rescue Exception => exception

data/lib/softlayer/base.rb

@@ -36,7 +36,7 @@
 #
 
 module SoftLayer
-  VERSION = "1.0.6"  # version history at the bottom of the file.
+  VERSION = "1.0.7"  # version history at the bottom of the file.
 
   # The base URL of the SoftLayer API's REST-like endpoints available to the public internet.
   API_PUBLIC_ENDPOINT = 'https://api.softlayer.com/rest/v3/'
@@ -75,8 +75,12 @@ end # module SoftLayer
 # 1.0.3 - Added a request filter to add result limits to request.  Submitted by
 # JN.  Thanks!
 #
-# 1.0.4 - Fixed a bug where the result_limit and result_offset object filters were just not working. 
+# 1.0.4 - Fixed a bug where the result_limit and result_offset object filters were just not working.
 #
 # 1.0.5 - Fixed a bug where empty hashes and empty arrays would not generate meaningful object masks
 #
-# 1.0.6 - Make all API calls with either a GET or a POST as the HTTP verb.
+# 1.0.6 - Make all API calls with either a GET or a POST as the HTTP verb.
+#
+# 1.0.7 - Calls to the "getObject" method of any service should not take parameters.  The gem now
+# warns if you make this type of call and ignores the parameters. This prevents
+# SoftLayer_Virtual_Guest::getObject from accidentally creating (billable) CCI instances.

data/lib/softlayer/object_mask_helpers.rb

@@ -27,7 +27,7 @@
 class Hash
   def to_sl_object_mask(base = "")
     return base if(self.empty?)
-    
+
     # ask the children to convert themselves with the key as the base
     masked_children = self.map { |key, value| result = value.to_sl_object_mask(key); }.flatten
 

data/lib/softlayer/service.rb

@@ -81,27 +81,27 @@ module SoftLayer
       merged_object.parameters = @parameters.merge({ :object_mask => args }) if args && !args.empty?
       merged_object
     end
-    
+
     def result_limit(limit)
       merged_object = APIParameterFilter.new;
       merged_object.target = self.target
       merged_object.parameters = @parameters.merge({ :result_limit => limit })
       merged_object
     end
-    
+
     def server_result_limit
       self.parameters[:result_limit]
     end
-    
+
     def result_offset(offset)
       self.parameters[:result_offset] = offset
       self
     end
-    
+
     def server_result_offset
       self.parameters[:result_offset]
     end
-    
+
 
     def method_missing(method_name, *args, &block)
       return @target.call_softlayer_api_with_params(method_name, self, args, &block)
@@ -205,13 +205,13 @@ module SoftLayer
 
       return proxy.object_mask(*args)
     end
-    
+
     def result_limit(limit)
       proxy = APIParameterFilter.new
       proxy.target = self
       return proxy.result_limit(limit)
     end
-    
+
     def result_offset(offset)
       proxy = APIParameterFilter.new
       proxy.target = self
@@ -278,7 +278,7 @@ module SoftLayer
         # not JSON values.  As a result, 'JSON.parse("true")' yields a parsing
         # exception. To work around this, we force the result JSON text by
         # including it in Array markers, then take the first element of the
-        # resulting array as the result of the parsing. This should allow values 
+        # resulting array as the result of the parsing. This should allow values
         # like true, false, null, and numbers to parse the same way they would in
         # a browser.
         parsed_json = JSON.parse("[ #{json_results} ]")[0]
@@ -316,9 +316,23 @@ module SoftLayer
     def http_request_for_method(method_name, method_url, request_body = nil)
       content_type_header = {"Content-Type" => "application/json"}
 
+      # This is a workaround for a potential problem that arises from mis-using the
+      # API.  If you call SoftLayer_Virtual_Guest and you call the getObject method
+      # but pass a virtual guest as a parameter, what happens is the getObject method
+      # is called through an HTTP POST verb and the API creates a new CCI that is a copy
+      # of the one you passed in.
+      #
+      # The counter-intuitive creation of a new CCI is unexpected and, even worse,
+      # is something you can be billed for.  To prevent that, we ignore the request
+      # body on a "getObject" call and print out a warning.
+      if (method_name == :getObject) && (nil != request_body) then
+        $stderr.puts "Warning - The getObject method takes no parameters.  The parameters you have provided will be ignored."
+        request_body = nil
+      end
+
       if request_body && !request_body.empty?
             url_request = Net::HTTP::Post.new(method_url.request_uri(), content_type_header)
-      else 
+      else
           	url_request = Net::HTTP::Get.new(method_url.request_uri())
       end
 
@@ -409,7 +423,7 @@ module SoftLayer
         mask_value = parameters.server_object_mask.to_sl_object_mask.map { |mask_key| URI.encode(mask_key.to_s.strip) }.join(";")
         query_string = "objectMask=#{mask_value}"
       end
-      
+
       if (parameters && parameters.server_result_limit)
         resultLimit = parameters.server_result_limit
         resultOffset = parameters.server_result_offset

data/test/SoftLayer_Service.rb

@@ -224,6 +224,15 @@ describe SoftLayer::Service, "#missing_method" do
   end
 end
 
+describe SoftLayer::Service, "#http_request_for_method" do
+  it "should only use HTTP GET for requests to the getObject method even if paramters are provided" do
+    service = SoftLayer::Service.new("SoftLayer_Account", :username => "sample_username", :api_key => "blah")
+    request = service.http_request_for_method(:getObject, URI.parse("https://api.softlayer.com/rest/v3/SoftLayer_Ticket/12345/getObject.json"), '{"simple" : "object"}')
+    request.should be_a_kind_of(Net::HTTP::Get)
+    request.should_not be_a_kind_of(Net::HTTP::Post)
+  end
+end
+
 describe SoftLayer::Service, "#call_softlayer_api_with_params" do
   it "should issue an HTTP request for the given method" do
     service = SoftLayer::Service.new("SoftLayer_Account", :username => "sample_username", :api_key => "blah")

data/test/SoftLayer_ToObjectMask.rb

@@ -84,9 +84,9 @@ describe Hash, "#to_sl_object_mask" do
   it "should resolve the mapped values with the base provided" do
     {"top" => [ "middle1", {"middle2" => "end"}]}.to_sl_object_mask.should eql(["top.middle1", "top.middle2.end"])
   end
-  
+
   it "should handle a complex hash object mask with an inner empty hash" do
     { "ipAddress" => { "ipAddress" => {}}}.to_sl_object_mask.should eql(["ipAddress.ipAddress"])
   end
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: softlayer_api
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json