Cleaned up the Ticket model for a first release with an eye toward future enhancement

Removed the account from the process of fetching tickets
Changed the create_ticket example script to use the new model

Author: SLsthompson

examples/create_ticket.rb

@@ -24,32 +24,44 @@
 require 'softlayer_api'
 require 'pp'
 
-# We can use globals to establish our client's credentials
-$SL_API_USERNAME = "joecustomer"         # enter your username here
-$SL_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
+)
 
-softlayer_client = SoftLayer::Client.new()
 begin
-  # use an account service to get the account ID of my account
-  account_service = softlayer_client.service_named("Account")
-  my_account_id = account_service.getCurrentUser['id']
+  # To create a ticket we have to assign the ticket to some user so
+  # assign our new ticket to the current user
+  account = SoftLayer::Account.account_for_client(softlayer_client)
+  account_user = account.service.getCurrentUser
+  my_user_id = account_user["id"]
+  
+  # We also need a subject for the ticket. Subjects are specified by id
+  # This code prints out a table of all the ticket subjects with their
+  # ids:
+  ticket_subjects = SoftLayer::Ticket.ticket_subjects(softlayer_client)
+  ticket_subjects.each do |subject|
+    puts "#{subject['id']}\t#{subject['name']}"
+  end
+  
+  # For this example we'll use 'Public Network Question' as the subject.  That's id 1022
+  public_network_question_id = 1022
 
-  # Use a ticket service to create a standard support ticket, assigned to me.
-  # 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,
-                    "subjectId" => 1022,
-                    "notifyUserOnUpdateFlag" => true
-                  },
-                  "This is a test ticket created from a Ruby client")
+  # A title is optional, but we'll provide one and we offer the body of the ticket
+  # remember to pass the client to create_standard_ticket
+  new_ticket = SoftLayer::Ticket.create_standard_ticket(
+    :client => softlayer_client,
+    :title => "This is a test ticket, please simply close it",
+    :body => "This test ticket was created to test the Ruby API client.  Please ignore it.",
+    :subject_id => public_network_question_id,
+    :assigned_user_id => my_user_id
+  )
 
-  puts "Created a new ticket : #{new_ticket['id']} - #{new_ticket['title']}"
+  puts "Created a new ticket : #{new_ticket.id} - #{new_ticket.title}"
+  
+  # we can also add an update to the ticket:
+  new_ticket.update("This is a ticket update sent from the Ruby library")
 
-  # add an update to the newly created ticket.
-  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/open_tickets.rb

@@ -24,27 +24,22 @@
 require 'softlayer_api'
 require 'pp'
 
-$SL_API_USERNAME = "joecustomer"         # enter your username here
-$SL_API_KEY = "feeddeadbeefbadf00d..."   # enter your api key here
+# One way to provide a username and api key is to provide them
+# as globals.
+# $SL_API_USERNAME = "joecustomer"         # enter your username here
+# $SL_API_KEY = "feeddeadbeefbadf00d..."   # enter your api key here
 
-softlayer_client = SoftLayer::Client.new()
+# The client constructed here must get it's credentials from somewhere
+# In this script you might uncomment the globals above and assign your 
+# credentials there
+SoftLayer::Client.default_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_client.service_named("Account")
+# The openTickets routine will pick up the default client established above.
+open_tickets = SoftLayer::Ticket.open_tickets()
 
-open_tickets = account_service.getOpenTickets
-open_tickets.each { |ticket| puts "#{ticket['id']} - #{ticket['title']}" }
-
-# Now use the ticket service to get a each ticket (by ID) and a subset of the
-# 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_client["Ticket"]
+open_tickets.sort!{ |lhs, rhs| -(lhs.lastEditDate <=> rhs.lastEditDate) } 
 open_tickets.each do |ticket|
-  begin
-    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 #{exception}"
-  end
+  printf "#{ticket.id} - #{ticket.title}"
+
+  ticket.has_updates? ? printf("\t*\n") : printf("\n")
 end

lib/softlayer/Account.rb

@@ -113,30 +113,6 @@ class Account < SoftLayer::ModelBase
       end
     end
 
-    ##
-    # The tickets resource consists of all open tickets, and tickets closed
-    # "recently". These refresh every 5 minutes.
-    # :call-seq:
-    #   tickets(force_update=false)
-    sl_dynamic_attr :tickets do |tickets|
-      tickets.should_update? do
-        @last_ticket_update ||= Time.at(0)
-        (Time.now - @last_ticket_update) > 5 * 60 #update every 5 minutes
-      end
-
-      tickets.to_update do
-        @last_ticket_update = Time.now
-
-        open_ticket_data = self.softlayer_client["Account"].object_mask(Ticket.default_object_mask).getOpenTickets()
-        recently_closed_data = self.softlayer_client["Account"].object_mask(Ticket.default_object_mask).getTicketsClosedInTheLastThreeDays()
-
-        open_tickets = open_ticket_data.collect { |ticket_data| Ticket.new(self.softlayer_client, ticket_data) }
-        closed_tickets = recently_closed_data.collect { |ticket_data| Ticket.new(self.softlayer_client, ticket_data) }
-
-        open_tickets + closed_tickets
-      end
-    end
-
     def service
       softlayer_client["Account"].object_with_id(self.id)
     end

lib/softlayer/Client.rb

@@ -52,6 +52,8 @@ class Client
     ##
     # The client class maintains an (optional) default client. The default client
     # will be used by many methods if you do not provide an explicit client.
+    @@default_client = nil
+
     def self.default_client
       return @@default_client
     end

lib/softlayer/ObjectMaskProperty.rb

@@ -75,6 +75,7 @@ def add_children(new_children)
       new_children.each { |new_child| add_child(new_child) }
     end
 
+    # DANGER: assumes you've already checked can_merge_with? before calling this routine!
     def merge(other_property)
       add_children other_property.children
     end

lib/softlayer/Service.rb

@@ -287,7 +287,7 @@ def call_softlayer_api_with_params(method_name, parameters, args)
     # If this is not defined for Service, then when you print a service object
     # the code will try to convert it to an array and end up calling method_missing
     #
-    # We define this here to prevent odd calls to the Softlayer API
+    # We define this here to prevent odd calls to the SoftLayer API
     def to_ary
       nil
     end

lib/softlayer/Ticket.rb

@@ -24,24 +24,30 @@ module SoftLayer
 	class Ticket < SoftLayer::ModelBase
 
     ##
-    # :attr_reader: title
+    # :attr_reader:
     # The title is an identifying string set when the ticket is created
     sl_attr :title
 
     ##
-    # :attr_reader: subject
+    # :attr_reader:
     # The ticket system maintains a fixed set of subjects for tickets that are used to ensure tickets make it to the right folks quickly
     sl_attr :subject
+    
+    ##
+    # :attr_reader:
+    # The date the ticket was last updated. 
+    sl_attr :lastEditDate
 
     ##
     # Returns true if the ticket has "unread" updates
     def has_updates?
-      self["newUpdatesFlag"] != 0
+      self["newUpdatesFlag"]
     end
 
     ##
     # Returns true if the ticket is a server admin ticket
     def server_admin_ticket?
+      # note that serverAdministrationFlag comes from the server as an Integer (0, or 1)
       self["serverAdministrationFlag"] != 0
     end
 
@@ -89,9 +95,9 @@ def self.default_object_mask
           'status.id',
           'createDate',
           'lastEditDate',
-          'newUpdatesFlag',
-          'awaitingUserResponseFlag',
-          'serverAdministrationFlag',
+          'newUpdatesFlag',             # This comes in from the server as a Boolean value
+          'awaitingUserResponseFlag',   # This comes in from the server as a Boolean value
+          'serverAdministrationFlag',   # This comes in from the server as an integer :-(
         ]
       }
 		end
@@ -112,6 +118,29 @@ def self.ticket_subjects(client = nil)
 			@ticket_subjects
 		end
 
+    ##
+    # Returns the set of currently open tickets
+    #
+    # Options should contain:
+    #
+    # <b>+:client+</b> - the client in which to search for the ticket
+    #
+    # If a client is not provided then the routine will search Client::default_client
+    # If Client::default_client is also nil the routine will raise an error.    
+    def self.open_tickets(options = {})
+      softlayer_client = options[:client] || Client.default_client
+      raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !softlayer_client
+
+      if options.has_key?(:object_mask)
+        object_mask = options[:object_mask]
+      else
+        object_mask = default_object_mask.to_sl_object_mask
+      end
+
+      open_tickets_data = softlayer_client["Account"].object_mask(object_mask).getOpenTickets
+      open_tickets_data.collect { |ticket_data| new(softlayer_client, ticket_data) }
+    end
+    
     ##
     # Find the ticket with the given ID and return it
     #
@@ -132,7 +161,7 @@ def self.ticket_with_id(ticket_id, options = {})
         object_mask = default_object_mask.to_sl_object_mask
       end
 
-      ticket_data = softlayer_client["Ticket"].object_with_id(server_id).object_mask(object_mask).getObject()
+      ticket_data = softlayer_client["Ticket"].object_with_id(ticket_id).object_mask(object_mask).getObject()
 
       return new(softlayer_client, ticket_data)
     end
@@ -153,7 +182,7 @@ def self.ticket_with_id(ticket_id, options = {})
     # * <b>+:body+</b> (String) - The content of the ticket
     # * <b>+:subject_id+</b> (Int) - The id of a subject to use for the ticket.  A list of ticket subjects can be returned by SoftLayer::Ticket.ticket_subjects
     # * <b>+:assigned_user_id+</b> (Int) - The id of a user to whom the ticket should be assigned
-    def self.create_ticket(options = {})
+    def self.create_standard_ticket(options = {})
       softlayer_client = options[:client] || SoftLayer::Client.default_client
       raise "#{__method__} requires a client but none was given and Client::default_client is not set" if !softlayer_client
 

lib/softlayer/object_mask_helpers.rb

@@ -80,7 +80,7 @@ def __sl_object_mask_properties_for_keys
 end
 
 ##
-# Softlayer Extensions to the Array class to support using arrays to create
+# SoftLayer Extensions to the Array class to support using arrays to create
 # object masks
 class Array
   # Returns a string representing the object mask content represented by the
@@ -95,7 +95,7 @@ def _to_sl_object_mask_property()
 end
 
 ##
-# Softlayer Extensions to the String class to support using strings to create
+# SoftLayer Extensions to the String class to support using strings to create
 # object masks
 class String
   # Returns a string representing the object mask content represented by the
@@ -109,7 +109,7 @@ def _to_sl_object_mask_property()
 end
 
 ##
-# Softlayer Extensions to the Symbol class to support using symbols to create
+# 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

spec/Account_spec.rb

@@ -98,27 +98,18 @@
 
   describe "relationship to servers" do
     it "should respond to a request for servers" do
-      fixture_account_data = fixture_from_json("test_account")
-      fixture_bare_metal_data = fixture_from_json("test_bare_metal.json")
-      fixture_virtual_server_data = fixture_from_json("test_virtual_servers")
-
       mock_client = SoftLayer::Client.new(:username => "fakeuser", :api_key => "fake_api_key")
-      allow(mock_client).to receive(:[]) do |service_name|
-        expect(service_name).to eq "Account"
-
-        if(!@mock_service)
-          @mock_service = SoftLayer::Service.new("SoftLayer_Account", :client => mock_client)
-          allow(@mock_service).to receive(:getObject).and_return(fixture_account_data)
-
-          expect(@mock_service).to receive(:getHardware).and_return(fixture_bare_metal_data)
-          expect(@mock_service).to receive(:getVirtualGuests).and_return(fixture_virtual_server_data)
-          allow(@mock_service).to receive(:object_mask).and_return(@mock_service)
-
-          # if we've stubbed everything out correctly... we shouldn't actually be calling the API
-          expect(@mock_service).to_not receive(:call_softlayer_api_with_params)
-        end
-
-        @mock_service
+      account_service = mock_client["Account"]
+      allow(account_service).to receive(:getObject).and_return(fixture_from_json("test_account"))
+      allow(account_service).to receive(:call_softlayer_api_with_params) do |api_method, api_filter, arguments|
+        case api_method
+        when :getHardware
+          fixture_bare_metal_data = fixture_from_json("test_bare_metal")
+        when :getVirtualGuests
+          fixture_from_json("test_virtual_servers")
+        when :getObject
+          fixture_from_json("test_account")
+        end            
       end
 
       test_account = SoftLayer::Account.account_for_client(mock_client)
@@ -131,43 +122,6 @@
     end
   end
 
-  describe "fetching tickets" do
-    before do
-      fixture_account_data = fixture_from_json("test_account")
-      fixture_open_tickets = fixture_from_json("test_tickets")
-      fixture_closed_tickets = fixture_from_json("test_tickets.json")
-
-      @mock_client = SoftLayer::Client.new(:username => "fakeuser", :api_key => "fake_api_key")
-      allow(@mock_client).to receive(:[]) do |service_name|
-        expect(service_name).to eq "Account"
-
-        if !@mock_service
-
-          @mock_service = SoftLayer::Service.new("SoftLayer_Account", :client => @mock_client)
-          allow(@mock_service).to receive(:getObject).and_return(fixture_account_data)
-          allow(@mock_service).to receive(:object_mask).and_return(@mock_service)
-          allow(@mock_service).to receive(:call_softlayer_api_with_params)
-
-          expect(@mock_service).to receive(:getOpenTickets).and_return(fixture_open_tickets)
-          expect(@mock_service).to receive(:getTicketsClosedInTheLastThreeDays).and_return(fixture_closed_tickets)
-
-          # if we've stubbed everything out correctly... we shouldn't actually be calling the API
-          expect(@mock_service).to_not receive(:call_softlayer_api_with_params)
-        end
-
-        @mock_service
-      end
-    end
-
-    it "responds to a tickets request" do
-      test_account = SoftLayer::Account.account_for_client(@mock_client)
-      expect(test_account).to respond_to(:tickets)
-      expect(test_account).to_not respond_to(:tickets=)
-
-      tickets = test_account.tickets
-    end
-  end
-
   describe "Account.account_for_client" do
     it "raises an error if there is no client available" do
       SoftLayer::Client.default_client = nil
@@ -188,5 +142,4 @@
       expect(mock_account.id).to be(12345)
     end
   end
-
 end

spec/Ticket_spec.rb

@@ -33,6 +33,17 @@
     SoftLayer::Ticket.instance_eval { @ticket_subjects = nil }
   end
 
+  it "fetches a list of open tickets" do
+    mock_client = SoftLayer::Client.new(:username => "fakeuser", :api_key => "fake_api_key")
+    account_service = mock_client["Account"]
+
+    expect(account_service).to receive(:call_softlayer_api_with_params).with(:getOpenTickets, instance_of(SoftLayer::APIParameterFilter),[]) do
+      fixture_from_json("test_tickets")
+    end
+
+    SoftLayer::Ticket.open_tickets(:client => mock_client)
+  end
+
 	it "retrieves ticket subjects from API once" do
     fakeTicketSubjects = fixture_from_json("ticket_subjects")