softlayer_api 1.0.2 → 1.0.3

data/README.textile

@@ -79,9 +79,9 @@ table{position:relative;left:2em;width:80%}.
 Here is an example, analogous to the one for global variables, which provides the username and API key as hash arguments. This example also changes the endpoint with the @:endpoint_url@ symbol so that the service will use the API on the SoftLayer Private Network:
 
 <pre style="border:1pt solid black;background:#eee;padding:0.5em;margin:0.5em"><code style="font-family:Menlo,Monaco,monospace;font-size:9pt">account_service = SoftLayer::Service.new("SoftLayer_Account",
-  :username => "joeusername",
-  :api_key => "omitted_for_brevity",
-  :endpoint_url => API_PRIVATE_ENDPOINT)
+    :username => "joeusername",
+    :api_key => "omitted_for_brevity",
+    :endpoint_url => API_PRIVATE_ENDPOINT)
 </code></pre>
 
 h3. Calling Service Methods
@@ -96,12 +96,12 @@ If the method requires arguments, you can supply them as arguments to the method
 <pre style="border:1pt solid black;background:#eee;padding:0.5em;margin:0.5em"><code style="font-family:Menlo,Monaco,monospace;font-size:9pt">#authentication information will be found in the global variables
 ticket_service = SoftLayer::Service.new("SoftLayer_Ticket")
 new_ticket = ticket_service.createStandardTicket(
-  {
+{
     "assignedUserId" => my_account_id,
     "subjectId" => 1022,
     "notifyUserOnUpdateFlag" => true
-  },
-  "This is a test ticket created from a Ruby client")
+},
+"This is a test ticket created from a Ruby client")
 </code></pre>
 
 h4. Identifying Particular Objects
@@ -114,13 +114,13 @@ Some method calls in the SoftLayer API are made on particular objects, rather th
 The @object_with_id@ call returns an object that you can use as a reference to a particular object through the service.  This allows you to reuse that object multiple times without having to repeatedly tack @object_with_id@ on to all your requests. For example, if you want to find a ticket with the id 98765 and add an update to it if it's assigned to user 123456, you might write code like this:
 
 <pre style="border:1pt solid black;background:#eee;padding:0.5em;margin:0.5em"><code style="font-family:Menlo,Monaco,monospace;font-size:9pt">begin
-  ticket_ref = ticket_service.object_with_id(98765)
-  ticket = ticket_ref.object_mask("assignedUserId").getObject
-  if ticket['assignedUserId'] == 123456
-  	updates = ticket_ref.addUpdate({"entry" => "Get to work on these tickets!"})
-  end
+    ticket_ref = ticket_service.object_with_id(98765)
+    ticket = ticket_ref.object_mask("assignedUserId").getObject
+    if ticket['assignedUserId'] == 123456
+        updates = ticket_ref.addUpdate({"entry" => "Get to work on these tickets!"})
+    end
 rescue Exception => exception
-	puts "An error occurred while updating the ticket: #{exception}"
+    puts "An error occurred while updating the ticket: #{exception}"
 end
 </code></pre>
 
@@ -137,15 +137,15 @@ To look at some examples, consider the following object from the server.  It has
 The assignedUser entity has three properties, id, username, and health.
 
 <pre style="border:1pt solid black;background:#eee;padding:0.5em;margin:0.5em"><code style="font-family:Menlo,Monaco,monospace;font-size:9pt">{
-	"id"=>1736473,
-	"title"=>"VM Polling Failure - unable to login",
-	"createDate"=>"2010-04-22T00:12:36-05:00",
-	"modifyDate"=>"2010-06-09T06:44:18-05:00"
-	"assignedUser"=> {
-		"id"=>14
-		"username"=>"AlfredQHacker", 
-		"health"=>"Fantastic"
-	},
+    "id"=>1736473,
+    "title"=>"VM Polling Failure - unable to login",
+    "createDate"=>"2010-04-22T00:12:36-05:00",
+    "modifyDate"=>"2010-06-09T06:44:18-05:00"
+    "assignedUser"=> {
+        "id"=>14
+        "username"=>"AlfredQHacker",
+        "health"=>"Fantastic"
+    },
 }
 </code></pre>
 
@@ -199,15 +199,15 @@ require 'softlayer_api'
 require 'pp'
 
 begin
-	# 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",
-  	:username => "joecustomer"              # enter your username here
-  	:api_key => "feeddeadbeefbadf00d...")   # enter your api key here
+    # 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",
+    :username => "joecustomer",             # enter your username here
+    :api_key => "feeddeadbeefbadf00d...")   # enter your api key here
 
-	account = account_service.getObject
-	pp account
+    account = account_service.getObject
+    pp account
 rescue Exception => exception
-	puts "Unable to retrieve account information: #{exception}"
+    puts "Unable to retrieve account information: #{exception}"
 end
 </code></pre>
 
@@ -219,26 +219,26 @@ require 'softlayer_api'
 require 'pp'
 
 ticket_service = SoftLayer::Service.new("SoftLayer_Ticket",
-  :username => "joecustomer",              # enter your username here
-  :api_key => "feeddeadbeefbadf00d...")    # enter your api key here
+    :username => "joecustomer",              # enter your username here
+    :api_key => "feeddeadbeefbadf00d...")    # enter your api key here
 
 begin
-  ticket_ref = ticket_service.object_with_id(1683973)
+    ticket_ref = ticket_service.object_with_id(123456)
 
-  ticket = ticket_ref.object_mask({"updates" => ["entry", "createDate"]}, 
-                                  "assignedUserId", 
-                                  {"attachedHardware" => "datacenter"}).getObject
-  pp ticket
+    ticket = ticket_ref.object_mask({"updates" => ["entry", "createDate"]},
+                                    "assignedUserId",
+                                    {"attachedHardware" => "datacenter"}).getObject
+    pp ticket
 rescue Exception => exception
 	puts "Unable to retrieve the ticket"
 end
 
 # update the ticket
 begin
-  updates = ticket_ref.addUpdate({"entry" => "An update from the Ruby client!"})
-  puts "Update ticket 123456. The new update's id is #{updates[0]['id']}"
+    updates = ticket_ref.addUpdate({"entry" => "An update from the Ruby client!"})
+    puts "Update ticket 123456. The new update's id is #{updates[0]['id']}"
 rescue Exception => exception
-	puts "Unable to update the ticket: #{exception}"
+    puts "Unable to update the ticket: #{exception}"
 end
 </code></pre>
 
@@ -248,4 +248,4 @@ This software is written by the SoftLayer Development Team <"sldn@softlayer.com"
 
 h2. Copyright
 
-This software is Copyright (c) 2010 "SoftLayer Technologies, Inc":http://www.softlayer.com/. See the bundled LICENSE.textile file for more information.
+This software is Copyright (c) 2010 "SoftLayer Technologies, Inc":http://www.softlayer.com/. See the bundled LICENSE.textile file for more information.

data/lib/softlayer/base.rb

@@ -36,7 +36,7 @@
 #
 
 module SoftLayer
-  VERSION = "1.0.2"  # version history at the bottom of the file.
+  VERSION = "1.0.3"  # 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/'
@@ -68,7 +68,10 @@ end # module SoftLayer
 # posted up to rubygems.org and the 1.0.1 release came about because of that
 # confusion.  There should be no real functionality differences there.
 #
-# 1.0.2 - We have some API routines that start with "get" but expect arguments
+# 1.0.2 - We have some API routines that start with 'get' but expect arguments
 # anyway.  The code now uses HTTP POST to send requests for which the user
 # has provided arguments regardless of the name of the routine.
-#
+#
+# 1.0.3 - Added a request filter to add result limits to request.  Submitted by
+# JN.  Thanks!
+#

data/lib/softlayer/service.rb

@@ -81,6 +81,28 @@ 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)
@@ -184,6 +206,12 @@ module SoftLayer
 
       return proxy.object_mask(*args)
     end
+    
+    def result_limit(limit)
+      proxy = APIParameterFilter.new
+      proxy.target = self
+      return proxy.result_limit=limit
+    end
 
     # This is the primary mechanism by which requests are made. If you call
     # the service with a method it doesn't understand, it will send a call to
@@ -395,6 +423,18 @@ 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
+        resultOffset = 0 if resultOffset.nil?
+        limit_string = "resultLimit=#{resultOffset},#{resultLimit}"
+        if query_string.nil?
+          query_string = limit_string
+        else
+          query_string << "&#{limit_string}"
+        end
+      end
 
       uri.query = query_string
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: softlayer_api
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - SoftLayer Development Team
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-10 00:00:00 -05:00
+date: 2011-01-31 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency