Merging SLsthompson-master

Author: underscorephil

.gitignore

@@ -1,3 +1,6 @@
 .DS_Store
 *.*~
 *.gem
+
+log/
+internal_examples/

.travis.yml

@@ -1,9 +1,8 @@
 language: ruby
-rvm: 
+rvm:
+  - "2.1.1"
   - "2.1.0"
   - "2.0.0"
   - "1.9.3"
   - "1.9.2"
-  - "1.8.7"
-  - jruby-18mode
   - jruby-19mode

CHANGELOG.textile

@@ -1,8 +1,15 @@
+*2.0.0*
+* Switched the Ruby API client to use XML-RPC when calling the SoftLayer API rather than using the REST-like interface.
+* Result limits are now specified using @result_limit(offset,limit)@.
+The @result_offset@ API filter has been removed.
+* The @object_mask@ call modifier no longer accepts Ruby structures. It accepts strings that are Object Masks in the "Extended Object Mask":http://sldn.softlayer.com/article/Object-Masks format.
+* Changed the mechanism for obtaining services to include the Client class. This makes the Ruby API very similar to the API presented by the Python bindings. The old mechanism for obtaining services still works to preserve backward compatibility but you will receive deprecation warnings in debug mode.
+
 *1.0.8*
 * Set a default User-Agent string to be sent with all requests to SoftLayer API.  Provide interface to set a custom User-Agent string.
 
 *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.
+* 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) VirtualServer instances.
 
 *1.0.6*
 * Make all API calls with either a @GET@ or a @POST@ as the HTTP verb.
@@ -14,6 +21,7 @@
 * Fixed a bug where the @result_limit@ and @result_offset@ object filters were just not working.
 
 *1.0.3*
+<<<<<<< HEAD
 * Added a request filter to add result limits to request.  Submitted by JN.  Thanks!
 
 *1.0.2*

Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
-gem 'json', '~> 1.8.1'
+
 gem 'rake'
-gem 'rspec'
+gem 'rspec'
+gem 'configparser', "~> 0.1.2", :require => false

Gemfile.lock

@@ -1,22 +1,23 @@
 GEM
   remote: https://rubygems.org/
   specs:
+    configparser (0.1.2)
     diff-lcs (1.2.5)
-    json (1.8.1)
     rake (10.1.1)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
+    rspec-core (2.14.8)
     rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
-  json (~> 1.8.1)
+  configparser (~> 0.1.2)
   rake
   rspec

README.textile

@@ -25,11 +25,13 @@
 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
+  softlayer_client = SoftLayer::Client.new(
+    :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_client['Account'];
 	account = account_service.getObject
 	pp account
 rescue Exception => exception

examples/accountInformation.rb examples/account_info.rbexamples/accountInformation.rb renamed to examples/account_info.rb

@@ -29,13 +29,16 @@
 $SL_API_USERNAME = "joecustomer"         # enter your username here
 $SL_API_KEY = "feeddeadbeefbadf00d..."   # enter your api key here
 
+softlayer_client = SoftLayer::Client.new()
 begin
   # use an account service to get the account ID of my account
-  account_service = SoftLayer::Service.new("SoftLayer_Account")
+  account_service = softlayer_client.service_named("Account")
   my_account_id = account_service.getCurrentUser['id']
 
   # Use a ticket service to create a standard support ticket, assigned to me.
-  ticket_service = SoftLayer::Service.new("SoftLayer_Ticket")
+  # Note: calling for the Ticket service using the brackets is entirely equivalent
+  # go calling service_named('Ticket')
+  ticket_service = softlayer_client['Ticket']
   new_ticket = ticket_service.createStandardTicket(
                   {
                     "assignedUserId" => my_account_id,
@@ -47,7 +50,7 @@
   puts "Created a new ticket : #{new_ticket['id']} - #{new_ticket['title']}"
 
   # add an update to the newly created ticket.
-  pp ticket_service.object_with_id(new_ticket['id']).edit(nil, "This is a ticket update sent from the Ruby library")
+  pp ticket_service.object_with_id(new_ticket['id']).edit({}, "This is a ticket update sent from the Ruby library")
 rescue Exception => exception
   $stderr.puts "An exception occurred while trying to complete the SoftLayer API calls #{exception}"
 end

examples/createTicket.rb examples/create_ticket.rbexamples/createTicket.rb renamed to examples/create_ticket.rb

@@ -27,9 +27,11 @@
 $SL_API_USERNAME = "joecustomer"         # enter your username here
 $SL_API_KEY = "feeddeadbeefbadf00d..."   # enter your api key here
 
+softlayer_client = SoftLayer::Client.new()
+
 # 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")
+account_service = softlayer_client.service_named("Account")
 
 open_tickets = account_service.getOpenTickets
 open_tickets.each { |ticket| puts "#{ticket['id']} - #{ticket['title']}" }
@@ -38,11 +40,11 @@
 # information known about it. We've already collected this information above,
 # but this will demonstrate using an object mask to filter the results from
 # the server.
-ticket_service = SoftLayer::Service.new("SoftLayer_Ticket")
+ticket_service = softlayer_client["Ticket"]
 open_tickets.each do |ticket|
   begin
-    pp ticket_service.object_with_id(ticket["id"]).object_mask( "id", "title", "createDate", "modifyDate", { "assignedUser" => ["id", "username", "email"] }).getObject
+    pp ticket_service.object_with_id(ticket["id"]).object_mask("mask[id,title,createDate,modifyDate,assignedUser[id,username,email]]").getObject
   rescue Exception => exception
-    puts "exception #{e}"
+    puts "exception #{exception}"
   end
 end

examples/openTickets.rb examples/open_tickets.rbexamples/openTickets.rb renamed to examples/open_tickets.rb

@@ -24,25 +24,25 @@
 require 'softlayer_api'
 require 'pp'
 
-ticket_service = SoftLayer::Service.new("SoftLayer_Ticket",
+softlayer_client = SoftLayer::Client.new(
   :username => "joecustomer",              # enter your username here
-  :api_key => "feeddeadbeefbadf00d...")    # enter your api key here
+  :api_key => "feeddeadbeefbadf00d..."     # enter your api key here
+  )
 
 begin
-  ticket_ref = ticket_service.object_with_id(1683973)
+  ticket_service = softlayer_client.service_named("Ticket");
+  ticket_ref = ticket_service.object_with_id(8172109)
 
-  ticket = ticket_ref.object_mask({"updates" => ["entry", "createDate"]},
-                                  "assignedUserId",
-                                  {"attachedHardware" => "datacenter"}).getObject
+  ticket = ticket_ref.object_mask("mask[updates[entry,createDate],assignedUserId,attachedHardware.datacenter]".getObject
   pp ticket
 rescue Exception => exception
-	puts "Unable to retrieve the ticket"
+  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']}"
 rescue Exception => exception
-	puts "Unable to update the ticket: #{exception}"
+  puts "Unable to update the ticket: #{exception}"
 end