gitlab_support_readiness 1.0.0

data/lib/support_readiness/zendesk/views.rb

@@ -0,0 +1,469 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Views within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Views < Readiness::Client
+      attr_accessor :active, :conditions, :default, :description, :execution, :id, :position, :restriction, :title
+
+      ##
+      # Creates a new {Readiness::Zendesk::Views} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::Views}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::Views.new
+      def initialize(object = {})
+        @active = object['active']
+        @conditions = object['conditions']
+        @default = object['default']
+        @description = object['description']
+        @execution = object['execution']
+        @id = object['id']
+        @position = object['position']
+        @restriction = object['restriction']
+        @title = object['title']
+      end
+
+      ##
+      # Lists views
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#list-views Zendesk API > Viuews > List Views
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   views = Readiness::Zendesk::Views.list(client)
+      #   pp views.first.title
+      #   # => "Tickets updated less than 12 Hours"
+      def self.list(client)
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("views?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['views'].map { |t| Views.new(t) }
+          break unless body['meta']['has_more']
+
+          opts = body['links'] ['next'].split('?').last
+        end
+        array
+      end
+
+      ##
+      # Locates a view within Zendesk. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param vid [Integer] The view ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#show-view Zendesk API > Views > Show View
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   view = Readiness::Zendesk::Views.find(client, 25)
+      #   pp view.title
+      #   # => "Tickets updated less than 12 Hours"
+      def self.find(client, vid)
+        response = client.connection.get("views/#{vid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: vid }) unless response.status == 200
+        return Views.new(Oj.load(response.body)['view']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a view within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param vid [Integer] The view ID to find
+      # @return [Object] An instance of {Readiness::Zendesk::Views}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#show-view Zendesk API > Views > Show View
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   view = Readiness::Zendesk::Views.find!(client, 25)
+      #   pp view.title
+      #   # => "Tickets updated less than 12 Hours"
+      def self.find!(client, vid)
+        response = client.connection.get("views/#{vid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find view', id: vid }) unless response.status == 200
+        Views.new(Oj.load(response.body)['view'])
+      end
+
+      ##
+      # Locates up to 100 views within Zendesk.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param vids [Array] The view IDs to find
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#list-views-by-id Zendesk API > Views > List Views By ID
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   views = Readiness::Zendesk::Views.find_many(client, [25, 26])
+      #   pp views.map { |v| v.title }
+      #   # => ["Tickets updated less than 12 Hours", "Tickets updated more than 12 Hours"]
+      def self.find_many(client, vids)
+        response = client.connection.get("views/show_many?ids=#{vids.join(',')}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: vids }) unless response.status == 200
+        Oj.load(response.body)['views'].map { |o| Views.new(o) }
+      end
+
+      ##
+      # Creates a view. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param view [Object] An instance of {Readiness::Zendesk::Views}
+      # @return [Object] An instance of {Readiness::Zendesk::Views}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#create-viewr Zendesk API > Views > Create View
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   view = Readiness::Zendesk::Views.new
+      #   view.title = "Kelly's tickets"
+      #   view.description = 'Tickets that are assigned to Kelly'
+      #   view.active = true
+      #   view.position: 3
+      #   view.restriction: { type: 'User', id: '213977756' }
+      #   view.conditions = {
+      #     all: [
+      #       { field: 'status', operator: 'less_than', value: 'solved' },
+      #       { field: 'group_id', operator: 'is', value: '24000932' },
+      #       { field: 'custom_fields_360011872073', operator: 'is', value: 'Canada' }
+      #     ],
+      #     any: []
+      #   }
+      #   view.execution = {
+      #     columns: [
+      #       { id: 'status', title: 'Status', filterable: true, sortable: true},
+      #       { id: 'requester', title: 'Requester', filterable: true, sortable: true},
+      #       { id: 'assignee', title: 'Assignee', filterable: true, sortable: true},
+      #     ]
+      #     group_by: 'assignee',
+      #     group_order: 'desc',
+      #     sort_by: 'status',
+      #     sort_order: 'desc',
+      #     group: {
+      #       id: 'assignee',
+      #       title: 'Assignee',
+      #       filterable: true,
+      #       sortable: true,
+      #       order: 'desc'
+      #     }
+      #     sort: {
+      #       id: 'status',
+      #       title: 'Status',
+      #       filterable: true,
+      #       sortable: true,
+      #       order: 'desc'
+      #     }
+      #   }
+      #   create = Readiness::Zendesk::Views.create!(client, view)
+      #   pp create.id
+      #   # => 9873843
+      def self.create!(client, view)
+        response = client.connection.post 'views', { view: create_or_update_object(view) }.to_json
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create view', message: Oj.load(response.body)}) unless response.status == 201
+        Views.new(Oj.load(response.body)['view'])
+      end
+
+      ##
+      # Updates a view. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param view [Object] An instance of {Readiness::Zendesk::Views}
+      # @return [Object] An instance of {Readiness::Zendesk::Views}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#update-view Zendesk API > Views > Update View
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   view = Readiness::Zendesk::Views.find!(client, 9873843)
+      #   view.title = 'Canada tickets'
+      #   update = Readiness::Zendesk::Views.update!(client, view)
+      #   pp create.title
+      #   # => "Canada tickets"
+      def self.update!(client, view)
+        response = client.connection.put "views/#{view.id}", { view: create_or_update_object(view) }.to_json
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update view', id: view.id, message: Oj.load(response.body)}) unless response.status == 200
+        Views.new(Oj.load(response.body)['view'])
+      end
+
+      ##
+      # Updates multiple views via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param views [Array] An array of {Readiness::Zendesk::Views} instances
+      # @return [object] A {Readiness::Zendesk::JobStatuses} instance
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#update-many-views Zendesk API > Views > Update Many Views
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   view1 = Readiness::Zendesk::Views.find!(client, 9873843)
+      #   view1.title = 'Canada tickets'
+      #   view2 = Readiness::Zendesk::Views.find!(client, 9873858)
+      #   view2.title = 'Mexico tickets'
+      #   views = [view1, view2]
+      #   updates = Readiness::Zendesk::Views.update_many!(client, views)
+      #   pp updates.map { |v| v.title }
+      #   # => ["Canada tickets", "Mexico tickets"]
+      def self.update_many!(client, views)
+        data = { views: views.map { |v| create_or_update_object(view) } }.to_json
+        response = client.connection.put('views/update_many', data)
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update many views', message: Oj.load(response.body)}) unless response.status == 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      ##
+      # Deletes a view. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param view [Object] An instance of {Readiness::Zendesk::Views}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#delete-view Zendesk API > Views > Delete View
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   view = Readiness::Zendesk::Views.find!(client, 9873858)
+      #   delete = Readiness::Zendesk::Views.delete!(client, views)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, view)
+        response = client.connection.delete "views/#{view.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete a view', id: view.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+
+      ##
+      # Deletes multiple views via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param vids [Array] An array of view IDs
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#bulk-delete-views Zendesk API > Views > Bulk Delete Views
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   deletes = Readiness::Zendesk::Views.find!(client, [9873858, 9873843])
+      #   pp deletes
+      #   # => true
+      def self.delete_many(client, vids)
+        response = client.connection.delete("views/destroy_many?ids=#{vids.join(',')}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many views', message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+
+      ##
+      # Previews what a view would look like
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param view [object] An instance of {Readiness::Zendesk::Views}
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#preview-views Zendesk API > Views > Preview View
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   view = Readiness::Zendesk::Views.find!(client, 9873858)
+      #   preview = Readiness::Zendesk::Views.preview!(client, view)
+      #   pp preview['rows']['tickets'].first['id']
+      #   # => 12851
+      def self.preview!(client, view)
+        converted = create_or_update_object(view)
+        data = {
+          view: {
+            all: converted['all'],
+            any: converted['any'],
+            output: converted['output']
+          }
+        }.compact.to_json
+        response = client.connection.post 'views/preview', data
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Preview a view', message: Oj.load(response.body)}) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Get the tickets in a view
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param view [object] An instance of {Readiness::Zendesk::Views}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#list-tickets-from-a-view Zendesk API > Views > List Tickets From a View
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   view = Readiness::Zendesk::Views.find!(client, 9873858)
+      #   tickets = Readiness::Zendesk::Views.tickets(client, view)
+      #   pp tickets.first.id
+      #   # => 12851
+      def self.tickets(client, view)
+        response = client.connection.get "views/#{view.id}/tickets"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Get tickets from a view', message: Oj.load(response.body)}) unless response.status == 200
+        Oj.load(response.body)['tickets']
+      end
+
+      ##
+      # Display count information for a view
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param view [object] An instance of {Readiness::Zendesk::Views}
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#count-tickets-in-view Zendesk API > Views > Count Tickets in View
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   view = Readiness::Zendesk::Views.find!(client, 9873858)
+      #   count = Readiness::Zendesk::Views.count_tickets(client, view)
+      #   pp value['value']
+      #   # => 719
+      def self.count_tickets(client, view)
+        response = client.connection.get "views/#{view.id}/count"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Count tickets in a view', message: Oj.load(response.body)}) unless response.status == 200
+        Oj.load(response.body)['view_count']
+      end
+
+      ##
+      # Display count information for multiple views
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param vids [Array] The view IDs to get count information for
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/views/#count-tickets-in-views Zendesk API > Views > Count Tickets in Views
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   count = Readiness::Zendesk::Views.count_tickets_in_many(client, [25, 78])
+      #   pp value.map { |v| v['value'] }
+      #   # => [719, nil]
+      def self.count_tickets_in_many(client, vids)
+        response = client.connection.get "views/count_many?ids=#{vids.join(',')}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Count tickets in views', message: Oj.load(response.body)}) unless response.status == 200
+        Oj.load(response.body)['view_counts']
+      end
+
+      ##
+      # Returns a Hash used in creating/updating views, as the formatting does not match the Zendesk list functions
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param view [Object] An instance of {Readiness::Zendesk::Views}
+      # @return [Hash]
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::Zendesk::Configuration.new
+      #   config.username = 'alice@example.com'
+      #   config.token = 'test123abc'
+      #   config.url = 'https://example.zendesk.com/api/v2'
+      #   client = Readiness::Zendesk::Client.new(config)
+      #   view = Readiness::Zendesk::Views.find!(client, 9873858)
+      #   object = Readiness::Zendesk::Views.create_or_update_object(view)
+      #   pp object[:id]
+      #   # => 9873858
+      def self.create_or_update_object(view)
+        {
+          id: view.id,
+          title: view.title,
+          description: view.description,
+          active: view.active,
+          position: view.position,
+          restriction: view.restriction,
+          all: view.conditions['all'],
+          any: view.conditions['any'],
+          output: {
+            columns: view.execution['columns'].map { |c| c['id'] },
+            group_by: view.execution['group_by'],
+            group_order: view.execution['group_order'],
+            sort_by: view.execution['sort_by'],
+            sort_order: view.execution['sort_order']
+          }
+        }.compact
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module Zendesk
+  # @author Jason Colyer
+  # @since 1.0.0
+  module Zendesk
+    require "#{__dir__}/zendesk/articles"
+    require "#{__dir__}/zendesk/automations"
+    require "#{__dir__}/zendesk/client"
+    require "#{__dir__}/zendesk/configuration"
+    require "#{__dir__}/zendesk/group_memberships"
+    require "#{__dir__}/zendesk/groups"
+    require "#{__dir__}/zendesk/job_statuses"
+    require "#{__dir__}/zendesk/macros"
+    require "#{__dir__}/zendesk/organization_fields"
+    require "#{__dir__}/zendesk/organization_memberships"
+    require "#{__dir__}/zendesk/organizations"
+    require "#{__dir__}/zendesk/roles"
+    require "#{__dir__}/zendesk/search"
+    require "#{__dir__}/zendesk/sla_policies"
+    require "#{__dir__}/zendesk/ticket_fields"
+    require "#{__dir__}/zendesk/ticket_forms"
+    require "#{__dir__}/zendesk/tickets"
+    require "#{__dir__}/zendesk/triggers"
+    require "#{__dir__}/zendesk/users"
+    require "#{__dir__}/zendesk/views"
+  end
+end

data/lib/support_readiness.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+$VERBOSE = nil
+
+##
+# Defines the module Readiness
+# @author Jason Colyer
+# @since 1.0.0
+module Readiness
+  VERSION = File.read('VERSION').chomp
+end
+
+require 'active_support'
+require 'active_support/time'
+require 'base64'
+require 'cgi'
+require 'digest'
+require 'faraday'
+require 'faraday/multipart'
+require 'faraday/retry'
+require 'json'
+require 'oj'
+require 'redis'
+require 'restforce'
+require "#{__dir__}/support_readiness/client"
+require "#{__dir__}/support_readiness/gitlab"
+require "#{__dir__}/support_readiness/pagerduty"
+require "#{__dir__}/support_readiness/redis"
+require "#{__dir__}/support_readiness/zendesk"