gitlab_support_readiness 1.0.11 → 1.0.12

data/lib/support_readiness/zendesk/user_fields.rb

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class UserFields within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class UserFields < Readiness::Client
+      attr_accessor :active, :custom_field_options, :id, :description, :key, :position, :regexp_for_validation, :title, :type
+
+      ##
+      # Creates a new {Readiness::Zendesk::UserFields} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param object [Object] An instance of {Readiness::Zendesk::UserFields}
+      # @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)
+      #   Readiness::Zendesk::UserFields.new(client)
+      def initialize(client, object = {})
+        @active = object['active']
+        @custom_field_options =  user_field_options(client, object)
+        @id = object['id']
+        @description = object['description']
+        @key = object['key']
+        @position = object['position']
+        @regexp_for_validation = object['regexp_for_validation']
+        @title = object['title']
+        @type = object['type']
+      end
+
+      ##
+      # Gets the user field options for a user field
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param object [Varies] Either a Hash from JSON or a {Readiness::Zendesk::UserFields} instance
+      # @return [Array]
+      def user_field_options(client, object)
+        return nil unless %w[dropdown].include? object['type']
+
+        # Handles when the position value is nil
+        object['custom_field_options'].each do |c|
+          c['position'] = object['custom_field_options'].index(c)
+        end
+        object['custom_field_options'].map { |c| UserFieldOptions.new(c) }
+      end
+
+      ##
+      # Lists user fields
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#list-user-fields Zendesk API > User Fields > List User Fields
+      # @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)
+      #   fields = Readiness::Zendesk::UserFields.list(client)
+      #   pp fields.first.id
+      #   # => 7
+      def self.list(client)
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("user_fields?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['user_fields'].map { |t| UserFields.new(client, t) }
+          break unless body['meta']['has_more']
+
+          opts = body['links'] ['next'].split('?').last
+        end
+        array
+      end
+
+
+      ##
+      # Locates an user field within Zendesk. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param fid [Integer] The user field ID to locate
+      # @return [Object]
+      # @see https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#show-user-field Zendesk API > User Fields > Show User Fiueld
+      # @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)
+      #   field = Readiness::Zendesk::UserFields.find(client, 7)
+      #   pp field.title
+      #   # => "Custom Field 1"
+      def self.find(client, fid)
+        response = client.connection.get "user_fields/#{fid}"
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: fid }) unless response.status == 200
+        return UserFields.new(client, Oj.load(response.body)['user_field']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates an user field within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param fid [Integer] The user field ID to locate
+      # @return [Object]
+      # @see https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#show-user-field Zendesk API > User Fields > Show User Fiueld
+      # @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)
+      #   field = Readiness::Zendesk::UserFields.find!(client, 7)
+      #   pp field.name
+      #   # => "Custom Field 1"
+      def self.find!(client, fid)
+        response = client.connection.get "user_fields/#{fid}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find user field', id: fid }) unless response.status == 200
+        UserFields.new(client, Oj.load(response.body)['user_field'])
+      end
+
+      ##
+      # Creates an user field. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param field [Object] An instance of {Readiness::Zendesk::UserFields}
+      # @return [Object] An instance of {Readiness::Zendesk::UserFields}
+      # @see https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#create-user-field Zendesk API > User Fields > Create User Field
+      # @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)
+      #   field = Readiness::Zendesk::UserFields.new
+      #   field.type = 'text'
+      #   field.title = 'Support desc'
+      #   field.description = 'This field describes the support plan this organization has'
+      #   field.position = 0
+      #   field.active = true
+      #   field.key = 'support_description'
+      #   create = Readiness::Zendesk::UserFields.create!(client, field)
+      #   pp create.id
+      #   # => 25
+      def self.create!(client, field)
+        response = client.connection.post 'user_fields', to_clean_json_with_key(field, 'user_field')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create user field', message: Oj.load(response.body)}) unless response.status == 201
+        UserFields.new(client, Oj.load(response.body)['user_field'])
+      end
+
+      ##
+      # Updates an user field. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param field [Object] An instance of {Readiness::Zendesk::UserFields}
+      # @return [Object] An instance of {Readiness::Zendesk::UserFields}
+      # @see https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#update-user-field Zendesk API > User Fields > Update User Field
+      # @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)
+      #   field = Readiness::Zendesk::UserFields.find!(client, 75)
+      #   field.title = 'Support description'
+      #   update = Readiness::Zendesk::UserFields.update!(client, field)
+      #   pp update.title
+      #   # => "Support description"
+      def self.update!(client, field)
+        response = client.connection.put "user_fields/#{field.id}", to_clean_json_with_key(field, 'user_field')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update user field', message: Oj.load(response.body)}) unless response.status == 200
+        UserFields.new(client, Oj.load(response.body)['user_field'])
+      end
+
+      ##
+      # Deletes an user field. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param field [Object] An instance of {Readiness::Zendesk::UserFields}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#delete-user-field Zendesk API > User Fields > Delete User Field
+      # @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)
+      #   field = Readiness::Zendesk::UserFields.find!(client, 75)
+      #   delete = Readiness::Zendesk::UserFields.delete!(client, field)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, field)
+        response = client.connection.delete "user_fields/#{field.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete user field', id: field.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+
+      ##
+      # Reorders user fields. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param fids [Array] An Array of field IDs (order is important)
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#reorder-user-field Zendesk API > User Fields > Reorder User Field
+      # @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)
+      #   reorder = Readiness::Zendesk::UserFields.reorder!(client, [4, 5, 2, 8])
+      #   pp reorder
+      #   # => true
+      def self.reorder!(client, fids)
+        response = client.connection.put 'user_fields/reorder', { user_field_ids: fids }.to_json
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Reorder user fields', id: fids, message: Oj.load(response.body)}) unless response.status == 200
+        true
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/views.rb

@@ -10,7 +10,7 @@ module Readiness
     # @author Jason Colyer
     # @since 1.0.0
     class Views < Readiness::Client
-      attr_accessor :active, :conditions, :default, :description, :execution, :id, :position, :restriction, :title
+      attr_accessor :active, :conditions, :description, :execution, :id, :position, :restriction, :title
 
       ##
       # Creates a new {Readiness::Zendesk::Views} instance
@@ -24,7 +24,6 @@ module Readiness
       def initialize(object = {})
         @active = object['active']
         @conditions = object['conditions']
-        @default = object['default']
         @description = object['description']
         @execution = object['execution']
         @id = object['id']
@@ -143,6 +142,54 @@ module Readiness
         Oj.load(response.body)['views'].map { |o| Views.new(o) }
       end
 
+      ##
+      # Locates a view within Zendesk by name. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param name [String] The view name to look for
+      # @return [Object] An instance of {Readiness::Zendesk::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)
+      #   field = Readiness::Zendesk::Views.find_by_name(client, 'Tickets updated less than 12 Hours')
+      #   pp field.id
+      #   # => 25
+      def self.find_by_name(client, name)
+        views = Views.list(client)
+        views.detect { |v| v.title == name }
+      end
+
+      ##
+      # Locates a view within Zendesk by name. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param name [String] The view name to look for
+      # @return [Object] An instance of {Readiness::Zendesk::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)
+      #   field = Readiness::Zendesk::Views.find_by_name!(client, 'Tickets updated less than 12 Hours')
+      #   pp field.id
+      #   # => 25
+      def self.find_by_name!(client, name)
+        views = Views.list(client)
+        view = views.detect { |v| v.title == name }
+        handle_request_error(1, 'Zendesk', 404, { action: 'Find view', id: name }) if view.nil?
+        view
+      end
+
       ##
       # Creates a view. Will exit if unsuccessful
       #

data/lib/support_readiness/zendesk.rb

@@ -7,6 +7,8 @@ module Readiness
   # @author Jason Colyer
   # @since 1.0.0
   module Zendesk
+    require "#{__dir__}/zendesk/app_job_statuses"
+    require "#{__dir__}/zendesk/apps"
     require "#{__dir__}/zendesk/articles"
     require "#{__dir__}/zendesk/automations"
     require "#{__dir__}/zendesk/client"
@@ -21,10 +23,15 @@ module Readiness
     require "#{__dir__}/zendesk/roles"
     require "#{__dir__}/zendesk/search"
     require "#{__dir__}/zendesk/sla_policies"
+    require "#{__dir__}/zendesk/theme_job_statuses"
+    require "#{__dir__}/zendesk/themes"
     require "#{__dir__}/zendesk/ticket_fields"
+    require "#{__dir__}/zendesk/ticket_field_options"
     require "#{__dir__}/zendesk/ticket_forms"
     require "#{__dir__}/zendesk/tickets"
     require "#{__dir__}/zendesk/triggers"
+    require "#{__dir__}/zendesk/user_field_options"
+    require "#{__dir__}/zendesk/user_fields"
     require "#{__dir__}/zendesk/users"
     require "#{__dir__}/zendesk/views"
   end

data/lib/support_readiness.rb

@@ -17,11 +17,27 @@ require 'erb'
 require 'faraday'
 require 'faraday/multipart'
 require 'faraday/retry'
+require 'google/apis/calendar_v3'
 require 'json'
+require 'nokogiri'
 require 'oj'
 require 'redis'
+require 'restforce'
+require 'yaml'
+require 'zip'
+
+# This one should always be first
 require "#{__dir__}/support_readiness/client"
+
+# Order does not matter here
+require "#{__dir__}/support_readiness/calendly"
+require "#{__dir__}/support_readiness/dates"
 require "#{__dir__}/support_readiness/gitlab"
+require "#{__dir__}/support_readiness/google_calendar"
+require "#{__dir__}/support_readiness/mailgun"
 require "#{__dir__}/support_readiness/pagerduty"
 require "#{__dir__}/support_readiness/redis"
+require "#{__dir__}/support_readiness/repos"
+require "#{__dir__}/support_readiness/salesforce"
+require "#{__dir__}/support_readiness/slack"
 require "#{__dir__}/support_readiness/zendesk"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-30 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,6 +114,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: google-apis-calendar_v3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.43.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.43.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +142,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.7
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +184,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.0.8
+- !ruby/object:Gem::Dependency
+  name: restforce
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.5.0
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 description: Official gem of GitLab Support Readiness
 email: jcolyer@gitlab.com
 executables: []
@@ -163,24 +233,67 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/support_readiness.rb
+- lib/support_readiness/calendly.rb
+- lib/support_readiness/calendly/client.rb
+- lib/support_readiness/calendly/configuration.rb
+- lib/support_readiness/calendly/organization_memberships.rb
+- lib/support_readiness/calendly/organizations.rb
+- lib/support_readiness/calendly/users.rb
 - lib/support_readiness/client.rb
+- lib/support_readiness/dates.rb
 - lib/support_readiness/gitlab.rb
 - lib/support_readiness/gitlab/client.rb
 - lib/support_readiness/gitlab/configuration.rb
 - lib/support_readiness/gitlab/groups.rb
 - lib/support_readiness/gitlab/issues.rb
+- lib/support_readiness/gitlab/markdown.rb
+- lib/support_readiness/gitlab/merge_requests.rb
 - lib/support_readiness/gitlab/namespaces.rb
 - lib/support_readiness/gitlab/projects.rb
 - lib/support_readiness/gitlab/repositories.rb
 - lib/support_readiness/gitlab/users.rb
+- lib/support_readiness/google_calendar.rb
+- lib/support_readiness/google_calendar/client.rb
+- lib/support_readiness/google_calendar/configuration.rb
+- lib/support_readiness/google_calendar/events.rb
+- lib/support_readiness/mailgun.rb
+- lib/support_readiness/mailgun/bounces.rb
+- lib/support_readiness/mailgun/client.rb
+- lib/support_readiness/mailgun/configuration.rb
+- lib/support_readiness/mailgun/emails.rb
 - lib/support_readiness/pagerduty.rb
 - lib/support_readiness/pagerduty/client.rb
 - lib/support_readiness/pagerduty/configuration.rb
 - lib/support_readiness/pagerduty/escalation_policies.rb
 - lib/support_readiness/pagerduty/schedules.rb
 - lib/support_readiness/pagerduty/services.rb
+- lib/support_readiness/pagerduty/users.rb
 - lib/support_readiness/redis.rb
+- lib/support_readiness/repos.rb
+- lib/support_readiness/repos/articles.rb
+- lib/support_readiness/repos/automations.rb
+- lib/support_readiness/repos/groups.rb
+- lib/support_readiness/repos/macros.rb
+- lib/support_readiness/repos/organization_fields.rb
+- lib/support_readiness/repos/sla_policies.rb
+- lib/support_readiness/repos/ticket_fields.rb
+- lib/support_readiness/repos/ticket_forms.rb
+- lib/support_readiness/repos/triggers.rb
+- lib/support_readiness/repos/user_fields.rb
+- lib/support_readiness/repos/views.rb
+- lib/support_readiness/salesforce.rb
+- lib/support_readiness/salesforce/accounts.rb
+- lib/support_readiness/salesforce/cases.rb
+- lib/support_readiness/salesforce/client.rb
+- lib/support_readiness/salesforce/configuration.rb
+- lib/support_readiness/salesforce/queries.rb
+- lib/support_readiness/slack.rb
+- lib/support_readiness/slack/client.rb
+- lib/support_readiness/slack/configuration.rb
+- lib/support_readiness/slack/messages.rb
 - lib/support_readiness/zendesk.rb
+- lib/support_readiness/zendesk/app_job_statuses.rb
+- lib/support_readiness/zendesk/apps.rb
 - lib/support_readiness/zendesk/articles.rb
 - lib/support_readiness/zendesk/automations.rb
 - lib/support_readiness/zendesk/client.rb
@@ -195,10 +308,15 @@ files:
 - lib/support_readiness/zendesk/roles.rb
 - lib/support_readiness/zendesk/search.rb
 - lib/support_readiness/zendesk/sla_policies.rb
+- lib/support_readiness/zendesk/theme_job_statuses.rb
+- lib/support_readiness/zendesk/themes.rb
+- lib/support_readiness/zendesk/ticket_field_options.rb
 - lib/support_readiness/zendesk/ticket_fields.rb
 - lib/support_readiness/zendesk/ticket_forms.rb
 - lib/support_readiness/zendesk/tickets.rb
 - lib/support_readiness/zendesk/triggers.rb
+- lib/support_readiness/zendesk/user_field_options.rb
+- lib/support_readiness/zendesk/user_fields.rb
 - lib/support_readiness/zendesk/users.rb
 - lib/support_readiness/zendesk/views.rb
 homepage: https://gitlab.com/gitlab-support-readiness/gitlab_support_readiness_gem