issue_centre 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c94dcde5985cb97145e1717d6f56bc486a697cf
-  data.tar.gz: c361fb55e576469ff3ad530866824978aa81fa50
+  metadata.gz: 70636ce468d0f6fcbb1c65cedc00f47bf5da9bac
+  data.tar.gz: 058b320fc07c35b7c10aad0c74d6ec61d11ce046
 SHA512:
-  metadata.gz: b761c060454d0eb712c4d19ca38c186aa3dab5cdcfe4057adcc6f04ae62c279a4df82fe1d5bc8f7b0dc8b267d3a92868a0a0cf6d0b34c19c1b3a47cff4fae33d
-  data.tar.gz: d851d0d22fcc1c2a65042a72424f0f380a747bef308f659b84e495f8fe5ff6e217d78b2aa595b417d4cb169cfb3f23936107ad446237355bce488e0822a9ced3
+  metadata.gz: 961e1fc792d9e4070334001afb9f8434c427c39a21d2e56cc24a175bf0341110fe2fd723a19114b82bd1bf2a9cc7f2fd84351bdac820b51819836214f12b60b8
+  data.tar.gz: 52a2ae27df46ef2c426cd83fa5d797102024acedd145f789382d7f9f7aa681d43098346c6444a58096d316743880446d263f7e61f208466a15f45fc1822bb774

data/.gitignore

@@ -14,3 +14,5 @@
 mkmf.log
 
 *~
+TAGS
+tags

data/README.md

@@ -66,7 +66,7 @@ closed_tickets = ticket_conn.get_closed_tickets( session_key, companies.first[:i
 # Grab a list of events for the specified ticket
 events = ticket_conn.get_events_for_ticket( session_key, closed_tickets.last[:id])
 
-
+# And many more... (don't forget to check the docs for a full list!)
 ```
 
 ## Contributing

data/Rakefile

@@ -1,12 +1,35 @@
 require 'yard'
 
 YARD::Rake::YardocTask.new do |t|
+  puts 'Refreshing YARD docs...'
 end
 
-desc "Generate yard documentation to release process"
-task "release", [:remote] => ["yard"] do
+# Update TAGS file
+desc 'Refresh Emacs tags'
+task 'ctags' do
+  exclude = %w{
+    .git
+    app/views/
+    coverage
+    test/coverage
+    db
+    doc
+    features
+    log
+    tmp
+  }
+  exclude_options = exclude.map{ |e| "--exclude=#{e}"}.join(' ')
+  puts 'Refreshing TAGS...'
+  system("/usr/local/bin/ctags -e -R --extra=+fq #{exclude_options} . $(rvm gemdir)/gems")
 end
-      
+
+# Run ctags followed by yard docs prior to the release steps defined
+# in gem_tasks below...
+#
+desc 'Generate TAGS and YARD docs prior to release'
+task 'release', [:remote] => ['yard', 'ctags'] do
+end
+
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'

data/lib/issue_centre/contract_connection.rb

@@ -0,0 +1,154 @@
+module IssueCentre
+  class ContractConnection < GenericConnection
+
+    # Connection client for authenticating and retrieving contract
+    # information from IssueCentre
+    #
+    # @param [String] customer_url IssueCentre endpoint url (e.g.
+    #   {https://support.callclosed.net/issuecentre/Contract})
+    #
+    # @param [String] session_key SessionKey for this session
+    #
+    # @param [Hash] options Other options to pass to the constructors
+    #
+    # @return [CustomerConnection] Instance of CustomerConnection client
+    #
+    def initialize( customer_url, session_key, options = {})
+      #      @session_key = session_key
+      super( customer_url, options)
+    end
+
+
+    # Return all agents from IssueCentre for this contract
+    #
+    # @param [String] session_key SessionKey object
+    #
+    # @param [Integer] agent_id Agent ID for the contract (0 returns all)
+    #
+    # @return [Array] An array of events and details as hashes
+    #    
+    def get_agents( session_key, agent_id)
+      response_xml = self.call( :get_agents, message: {
+                                  arg0: session_key,
+                                  arg1: agent_id
+                                })
+      response = IssueCentre::Response.parse( response_xml)
+    end
+
+
+    # Return all error types from IssueCentre for this contract
+    #
+    # @param [String] session_key SessionKey object
+    #
+    # @return [Array] An array of error types and details as hashes
+    #    
+    def get_error_types( session_key)
+      response_xml = self.call( :get_error_types, message: {
+                                  arg0: session_key
+                                })
+      response = IssueCentre::Response.parse( response_xml)
+    end
+
+
+    # Return all event types from IssueCentre for this contract
+    #
+    # @param [String] session_key SessionKey object
+    #
+    # @return [Array] An array of events and details as hashes
+    #    
+    def get_event_types( session_key)
+      response_xml = self.call( :get_event_types, message: {
+                                  arg0: session_key
+                                })
+      response = IssueCentre::Response.parse( response_xml)
+    end
+
+
+    # Return all priorities from IssueCentre for this contract
+    #
+    # @param [String] session_key SessionKey object
+    #
+    # @return [Array] An array of priorities and details as hashes
+    #    
+    def get_priorities( session_key)
+      response_xml = self.call( :get_error_types, message: {
+                                  arg0: session_key
+                                })
+      response = IssueCentre::Response.parse( response_xml)
+    end
+
+
+    # Return all products from IssueCentre for this contract
+    #
+    # @param [String] session_key SessionKey object
+    #
+    # @return [Array] An array of products and details as hashes
+    #    
+    def get_products( session_key)
+      response_xml = self.call( :get_products, message: {
+                                  arg0: session_key
+                                })
+      response = IssueCentre::Response.parse( response_xml)
+    end
+
+
+    # Return all vendors from IssueCentre for this contract
+    #
+    # @param [String] session_key SessionKey object
+    #
+    # @return [Array] An array of vendors and details as hashes
+    #    
+    def get_vendors( session_key)
+      response_xml = self.call( :get_vendors, message: {
+                                  arg0: session_key
+                                })
+      response = IssueCentre::Response.parse( response_xml)
+    end
+
+
+    # Return all status types from IssueCentre for this contract
+    #
+    # @param [String] session_key SessionKey object
+    #
+    # @return [Array] An array of statuses and details as hashes
+    #    
+    def get_status_types( session_key)
+      response_xml = self.call( :get_status_types, message: {
+                                  arg0: session_key
+                                })
+      response = IssueCentre::Response.parse( response_xml)
+    end
+
+
+    # Return all 'received by' methods from IssueCentre for this contract
+    #
+    # @param [String] session_key SessionKey object
+    #
+    # @return [Array] An array of 'received by' methods and details as hashes
+    #    
+    def get_received_bymethods( session_key)
+      response_xml = self.call( :get_received_bymethods, message: {
+                                  arg0: session_key
+                                })
+      response = IssueCentre::Response.parse( response_xml)
+    end
+
+
+    # Return ticket summary details from IssueCentre for this contract
+    #
+    # @param [String] session_key SessionKey object
+    #
+    # @return [Array] An array of summary details as hashes
+    #    
+    def get_summary_details( session_key)
+      response_xml = self.call( :get_summary_details, message: {
+                                  arg0: session_key
+                                })
+      response = IssueCentre::Response.parse( response_xml)
+    end
+
+    # @todo Not implemented yet: create_contract, 
+
+  end    
+end
+

data/lib/issue_centre/customer_connection.rb

@@ -73,5 +73,9 @@ module IssueCentre
                                 })
       response = IssueCentre::Response.parse( response_xml)
     end
+
+    # @todo Not implemented yet: createContact, createCompany,
+    # updateContact, updateCompany
+    
   end
 end

data/lib/issue_centre/response.rb

@@ -72,7 +72,7 @@ module IssueCentre
             obj[ :country_id] = attr.value
           when 'isDefault'
             obj[ :is_default] = attr.value == "1"
-          when 'ticketCount', 'changeType', 'supportType'
+          when 'ticketCount', 'changeType', 'supportType', 'totalrecords'
             # skip (we don't need summaries)
           else
             obj[ attr.name.underscore.to_sym] = attr.value

data/lib/issue_centre/ticket_connection.rb

@@ -87,9 +87,118 @@ module IssueCentre
 
 
 
-    # TODO:
-    # :get_all_tags, :get_attachment, 
-    # :get_recently_updated_tickets, :get_ticket_details,
-    # :get_ticket_fix_group, :search_tickets,
+    # Return all details from IssueCentre for this ticket
+    #
+    # @param [String] session_key SessionKey object
+    #
+    # @param [Integer] ticket_id Ticket ID for the required ticket
+    #
+    # @return [Array] An array of details as hashes
+    #    
+    def get_ticket_details( session_key, ticket_id)
+      response_xml = self.call( :get_ticket_details, message: {
+                                  api_key: session_key,
+                                  ticket: ticket_id
+                                })
+      response = IssueCentre::Response.parse( response_xml)
+    end
+
+
+
+    # Return all tickets from IssueCentre that match these search parameters
+    #
+    # @param session_key [String] SessionKey object
+    #
+    # @param [Integer] company_id Company ID to search for (0 returns
+    #   tickets for all companies)
+    #
+    # @param [Integer] contact_id Contact ID to search for (0 returns
+    #   tickets for all contacts)
+    #
+    # @param [Integer] vendor_id Vendor ID to search for (0 returns
+    #   tickets for all vendors)
+    #
+    # @param [Integer] product_id Product ID to search for (0 returns
+    #   tickets for all products)
+    #
+    # @param [Symbol] status Ticket status to search for (:open, :closed, :both)
+    #
+    # @param [String] ticket_reference Ticket reference to search for
+    #   ("" returns tickets for all references)
+    #
+    # @param [Integer] owner_id Ticket Owner ID to limit search by
+    #   (0 returns tickets for all references)
+    #
+    # @param [String] client_reference Client reference to search for
+    #   ("" returns tickets for all references)
+    #
+    # @param [String] supplier_reference Ticket reference to search for
+    #   ("" returns tickets for all references)
+    #
+    # @param [String] company_reference Ticket reference to search for
+    #   ("" returns tickets for all references)
+    #
+    # @param [Time] date_from Date and time to search from (based on
+    #   ticket creation date)
+    #
+    # @param [Time] date_to Date and time to search until (based on
+    #   ticket creation date)
+    #
+    # @param [Integer] ticket_status The ticket status code to search for
+    #   (0 returns all status codes)
+    #
+    # @param [Integer] priority The ticket priority code to search for
+    #   (0 returns all priority codes)
+    #
+    # @param [String] free_text Text to search for within the tickets
+    #
+    # @param [Integer] page_size The number of tickets to be returned per page.
+    #
+    # @param [Integer] page_num Which page number [1+] to return tickets for.
+    #
+    # @param [String] tags Which tags to limit the search to
+    #
+    # @return [Array] An array of tickets and details as hashes
+    #    
+    def search_tickets( session_key, company_id, contact_id,
+                        vendor_id, product_id, status, owner_id,
+                        ticket_reference, client_reference,
+                        supplier_reference, company_reference,
+                        date_from, date_to, ticket_status, priority, free_text,
+                        page_size, page_num, tags)
+
+      response_xml = self.call( :search_tickets, message: {
+                                  arg0:  session_key,
+                                  arg1:  company_id,
+                                  arg2:  contact_id,
+                                  arg3:  vendor_id,
+                                  arg4:  product_id,
+                                  arg5:  status,
+                                  arg6:  owner_id,
+                                  arg7:  ticket_reference,
+                                  arg8:  client_reference,
+                                  arg9:  supplier_reference,
+                                  arg10: company_reference,
+                                  arg11: date_from,
+                                  arg12: date_to,
+                                  arg13: ticket_status,
+                                  arg14: priority,
+                                  arg15: free_text,
+                                  arg16: page_size,
+                                  arg17: page_num,
+                                  arg18: tags
+                                })
+      response = IssueCentre::Response.parse( response_xml)
+    end
+
+    # @todo Not implemented yet: add_event_to_ticket,
+    # add_reminder_to_ticket, create_ticket, get_all_tags,
+    # get_attachment, get_recently_updated_tickets,
+    # get_ticket_fix_group, send_email_response_from_ticket,
+    # set_ticket_fix_group, toggle_notification_for_ticket,
+    # update_custom_field_value, upload_encoded_file_to_ticket,
+    # upload_file_to_ticket
+
   end    
 end
+

data/lib/issue_centre/version.rb

@@ -1,3 +1,3 @@
 module IssueCentre
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/issue_centre.rb

@@ -10,6 +10,7 @@ require 'issue_centre/exception'
 require 'issue_centre/generic_connection'
 require 'issue_centre/auth_connection'
 require 'issue_centre/customer_connection'
+require 'issue_centre/contract_connection'
 require 'issue_centre/ticket_connection'
 require 'issue_centre/response'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: issue_centre
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jason Holloway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-28 00:00:00.000000000 Z
+date: 2016-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,6 +156,7 @@ files:
 - issue_centre.gemspec
 - lib/issue_centre.rb
 - lib/issue_centre/auth_connection.rb
+- lib/issue_centre/contract_connection.rb
 - lib/issue_centre/customer_connection.rb
 - lib/issue_centre/exception.rb
 - lib/issue_centre/generic_connection.rb
@@ -186,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Gem to wrap the IssueCentre API, as published at www.issuecentre.com by First