sirportly 1.1.1 → 1.1.2

data/lib/sirportly/data_objects/brand.rb

@@ -0,0 +1,6 @@
+module Sirportly
+  class Brand < DataObject
+    self.collection_path = 'objects/brands'
+    self.maps = {'departments' => "Department"}
+  end
+end

data/lib/sirportly/data_objects/customer.rb

@@ -0,0 +1,7 @@
+module Sirportly
+  class Customer < DataObject
+    self.collection_path = 'customers/all'
+    self.member = {:path => 'customers/info', :param => 'customer'}
+    self.maps = {'contact_methods' => 'CustomerContactMethod'}
+  end
+end

data/lib/sirportly/data_objects/customer_contact_method.rb

@@ -0,0 +1,4 @@
+module Sirportly
+  class CustomerContactMethod < DataObject
+  end
+end

data/lib/sirportly/data_objects/department.rb

@@ -0,0 +1,6 @@
+module Sirportly
+  class Department < DataObject
+    self.collection_path = 'objects/departments'
+    self.maps = {'brand' => 'Brand', 'escalation_path' => 'EscalationPath'}
+  end
+end

data/lib/sirportly/data_objects/escalation_path.rb

@@ -0,0 +1,6 @@
+module Sirportly
+  class EscalationPath < DataObject
+    self.collection_path = 'objects/escalation_paths'
+    self.maps = {'teams' => 'Team'}
+  end
+end

data/lib/sirportly/data_objects/filter.rb

@@ -0,0 +1,10 @@
+module Sirportly
+  class Filter < DataObject
+    self.collection_path = 'objects/filters'
+    
+    def tickets(options = {})
+      Ticket.filter(@client, self, options)
+    end
+    
+  end
+end

data/lib/sirportly/data_objects/priority.rb

@@ -0,0 +1,5 @@
+module Sirportly
+  class Priority < DataObject
+    self.collection_path = 'objects/priorities'
+  end
+end

data/lib/sirportly/data_objects/sla.rb

@@ -0,0 +1,5 @@
+module Sirportly
+  class SLA < DataObject
+    self.collection_path = 'objects/slas'
+  end
+end

data/lib/sirportly/data_objects/status.rb

@@ -0,0 +1,5 @@
+module Sirportly
+  class Status < DataObject
+    self.collection_path = 'objects/statuses'
+  end
+end

data/lib/sirportly/data_objects/team.rb

@@ -0,0 +1,6 @@
+module Sirportly
+  class Team < DataObject
+    self.collection_path = 'objects/teams'
+    self.maps = {'users' => 'User'}
+  end
+end

data/lib/sirportly/data_objects/ticket.rb

@@ -0,0 +1,96 @@
+module Sirportly
+  class Ticket < DataObject
+    self.collection_path = 'tickets/all'
+    self.member = {:path => 'tickets/ticket', :param => 'reference'}
+    self.maps = {'status' => 'Status', 'priority' => 'Priority', 'department' => 'Department', 'customer' => 'Customer', 'customer_contact_method' => 'CustomerContactMethod',
+      'team' => 'Team', 'user' => 'User', 'sla' => 'SLA', 'updates' => 'TicketUpdate'}
+    
+    # Executes a macro on the ticket. Accepts the name of ID of the macro you wish to execute as a 
+    # string or an integer.
+    def run_macro(name_or_id)
+      if req = client.request('tickets/macro', :ticket => @attributes['reference'], :macro => name_or_id.to_s)
+        set_attributes(req)
+        true
+      else
+        false
+      end
+    end
+    
+    # Updates ticket parameters. Accepts a hash with the parameters which you wish to update.
+    def update(params)      
+      if req = client.request('tickets/update', format_params(params))
+        set_attributes(req)
+        true
+      else
+        false
+      end
+    end
+    
+    # Posts a new update to the ticket. Accepts a hash of parameters needed to create the update.
+    def post_update(params = {})
+      if req = client.request('tickets/post_update', format_params(params))
+        update = TicketUpdate.new(@client, req)
+        (@attributes['updates'] ||= []) << update
+        update
+      else
+        false
+      end
+    end
+    
+    # Adds a follow up to the ticket
+    def add_follow_up(params = {})
+      if req = client.request('tickets/followup', format_params(params))
+        true
+      else
+        false
+      end
+    end
+    
+    # Creates a new ticket and returns a ticket object
+    def self.create(client, params = {})
+      if req = client.request('tickets/submit', format_params(params))
+        self.new(client, req)
+      else
+        false
+      end
+    end
+    
+    # Returns a DataSet containing tickets matching the passed query and page number.
+    def self.search(client, query, page = 1)
+      if req = client.request('tickets/search', :query => query, :page => page)
+        DataSet.new(client, req, self)
+      else
+        false
+      end
+    end
+    
+    # Returns tickets which match the passed filter
+    def self.filter(client, filter, options = {})
+      filter = filter.id if filter.is_a?(Sirportly::Filter)
+      options[:user] = options[:user].id if options[:user].is_a?(Sirportly::User)
+      if req = client.request('tickets/filter', options.merge({:filter => filter}))
+        DataSet.new(client, req, self)
+      else
+        false
+      end
+    end
+    
+    private
+    
+    def format_params(params)
+      self.class.format_params(params.merge({:ticket => @attributes['reference']}))
+    end
+    
+    def self.format_params(params)
+      params.inject({}) do |hash, (k,v)|
+        if v.kind_of?(Sirportly::DataObject) && v.attributes.keys.include?('id')
+          hash[k] = v.id
+        else
+          hash[k] = v
+        end
+        hash
+      end
+    end
+        
+  end
+end

data/lib/sirportly/data_objects/ticket_update.rb

@@ -0,0 +1,17 @@
+module Sirportly
+  class TicketUpdate < DataObject
+    
+    def author
+      if author = self.attributes['author']
+        if author.keys.include?('reference') && author.keys.include?('abbreviated_name') && author.keys.include?('pin')
+          Customer.new(author)
+        else
+          User.new(author)
+        end
+      else
+        nil
+      end
+    end
+    
+  end
+end

data/lib/sirportly/data_objects/user.rb

@@ -0,0 +1,7 @@
+module Sirportly
+  class User < DataObject
+    self.collection_path = 'users/all'
+    self.member = {:path => 'users/info', :param => 'user'}
+    self.maps = {'teams' => 'Team'}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sirportly
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -20,6 +20,19 @@ files:
 - lib/sirportly.rb
 - lib/sirportly/client.rb
 - lib/sirportly/data_object.rb
+- lib/sirportly/data_objects/brand.rb
+- lib/sirportly/data_objects/customer.rb
+- lib/sirportly/data_objects/customer_contact_method.rb
+- lib/sirportly/data_objects/department.rb
+- lib/sirportly/data_objects/escalation_path.rb
+- lib/sirportly/data_objects/filter.rb
+- lib/sirportly/data_objects/priority.rb
+- lib/sirportly/data_objects/sla.rb
+- lib/sirportly/data_objects/status.rb
+- lib/sirportly/data_objects/team.rb
+- lib/sirportly/data_objects/ticket.rb
+- lib/sirportly/data_objects/ticket_update.rb
+- lib/sirportly/data_objects/user.rb
 - lib/sirportly/data_set.rb
 - lib/sirportly/request.rb
 - lib/sirportly/spql_query.rb