gitlab-customer-support-operations_zendesk 1.0.0

data/lib/support_ops_zendesk/zendesk/webhooks.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Webhooks within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Hash] authentication Adds authentication to the webhook's HTTP requests
+    # @attr [String] created_at When the webhook was created
+    # @attr [String] created_by id of the user who created the webhook. "-1" represents the Zendesk system
+    # @attr [Hash] custom_headers Custom headers to deliver additional non-credential info to destinations
+    # @attr [String] description Webhook description
+    # @attr [String] endpoint The destination URL that the webhook notifies when Zendesk events occur
+    # @attr [Hash] external_source External source by which a webhook is created, e.g. Zendesk Marketplace
+    # @attr [String] http_method HTTP method used for the webhook's requests. To subscribe the webhook to Zendesk events, this must be "POST". Allowed values are "GET", "POST", "PUT", "PATCH", or "DELETE".
+    # @attr [String] id An auto-generated webhook id
+    # @attr [String] name Webhook name
+    # @attr [String] request_format The format of the data that the webhook will send. To subscribe the webhook to Zendesk events, this must be "json". Allowed values are "json", "xml", or "form_encoded".
+    # @attr [Hash] signing_secret Signing secret used to verify webhook requests.
+    # @attr [String] status Current status of the webhook. Allowed values are "active", or "inactive".
+    # @attr [Array] subscriptions Event subscriptions for the webhook.
+    # @attr [String] updated_at When the webhook was last updated
+    # @attr [String] update_by id of the user who last updated the webhook
+    # @todo Test Webhook => https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#test-webhook
+    # @todo Create or Clone Webhook => https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#create-or-clone-webhook
+    # @todo Update Webhook => https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#update-webhook
+    # @todo Patch Webhook => https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#patch-webhook
+    # @todo Delete Webhook => https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#delete-webhook
+    # @todo List Webhook Invocations => https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#list-webhook-invocations
+    # @todo List Webhook Invocation Attempts => https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#list-webhook-invocation-attempts
+    # @todo Show Webhook Signing Secret => https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#show-webhook-signing-secret
+    # @todo Reset Webhook Signing Secret => https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#reset-webhook-signing-secret
+    class Webhooks < SupportOps::Zendesk::Base
+      define_attributes :authentication, :created_at, :created_by,
+                        :custom_headers, :description, :endpoint,
+                        :external_source, :http_method, :id, :name,
+                        :request_format, :signing_secret, :status,
+                        :subscriptions, :updated_at, :update_by
+      readonly_attributes :created_at, :created_by, :external_source, :id,
+                          :signing_secret, :updated_at, :update_by
+
+      ##
+      # Lists webhooks in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param name_contains [String optional] Filters the webhooks by a
+      #     string in the name
+      #   @param status [String optional] Filters the webhooks by webhook
+      #     status. Allowed values are "active", or "inactive".
+      #   @param sort [String optional] Defines the sorting criteria. Only
+      #     supports name and status. Allowed values are "name", or "status".
+      #   @param limit [Integer optional] The limit to the number of webhooks
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#list-webhooks
+      #   Zendesk API > Webhooks > List Webhooks
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   webhooks = SupportOps::Zendesk::Webhooks.list(name_contains: 'test', limit: 25)
+      #   pp webhooks.count
+      #   # => 2
+      def self.list(**args)
+        args[:name_contains] = nil unless args[:name_contains]
+        args[:status] = nil unless args[:status]
+        args[:sort] = nil unless args[:sort]
+        args[:limit] = 0 unless args[:limit]
+        params = ''
+        params += "filter[name_contains]=#{args[:name_contains]}&" unless args[:name_contains].nil?
+        params += "filter[status]=#{args[:status]}&" unless args[:status].nil?
+        params += "sort=#{args[:sort]}&" unless args[:sort].nil?
+        webhooks = []
+        opts = "#{params}page[size]=100"
+        loop do
+          response = client.connection.get("webhooks?#{opts}")
+          body = Oj.load(response.body)
+          webhooks += body['webhooks'].map { |w| Webhooks.new(w) }
+          break if args[:limit].to_i.positive? && webhooks.count >= args[:limit].to_i
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        return webhooks if args[:limit].to_i.zero?
+        
+        webhooks.first(args[:limit].to_i)
+      end
+
+      ##
+      # Locates a webhook within Zendesk by name. Can utilize a cache for quicker results
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload find_by_name(key: value)
+      #   @param name [String required] The name to search for
+      #   @param cache [Array] An Array of SupportOps::Zendesk::Webhooks to use as a cache
+      # @return [Object] An instance of {SupportOps::Zendesk::Webhooks}
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   webhooks = SupportOps::Zendesk::Webhooks.list
+      #   webhook = SupportOps::Zendesk::Webhooks.find_by_name(name: 'Test Webhook', cache: webhooks)
+      #   pp webhook.name
+      #   # => "Test Webhook"
+      #   pp webhook.id
+      #   # => "01J58PJGENEYVBE5SXJQ1E8JB7"
+      def self.find_by_name(**args)
+        raise 'You have to provide a name' unless args[:name]
+        if args[:cache]
+          raise 'Provided cache is not an Array' unless args[:cache].is_a? Array
+          webhooks = args[:cache]
+        else
+          webhooks = list
+        end
+        webhooks.detect { |c| c.name.downcase == args[:name].to_s.downcase }
+      end
+
+      ##
+      # Locates a specific webhook in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#show-webhook
+      #   Zendesk API > Webhooks > Show Webhook
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   webhook = SupportOps::Zendesk::Webhooks.get('01J58PJGENEYVBE5SXJQ1E8JB7')
+      #   pp webhook.name
+      #   # => "Test Webhook"
+      def self.get(object)
+        if object.is_a? Webhooks
+          Webhooks.new(id: id).find
+        else
+          Webhooks.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific webhook in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#show-webhook
+      #   Zendesk API > Webhooks > Show Webhook
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   webhook = SupportOps::Zendesk::Webhooks.get!('01J58PJGENEYVBE5SXJQ1E8JB7')
+      #   pp webhook.name
+      #   # => "Test Webhook"
+      def self.get!(object)
+        if object.is_a? Webhooks
+          Webhooks.new(id: id).find!
+        else
+          Webhooks.new(id: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("webhooks/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['webhook']
+      end
+    end
+  end
+end

data/lib/support_ops_zendesk/zendesk.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  ##
+  # Defines the module Zendesk within the module {SupportOps}.
+  #
+  # @author Jason Colyer
+  # @since 1.0.0
+  module Zendesk
+    # This one should always be first
+    require "#{__dir__}/zendesk/base"
+    # Order does not matter here
+    require "#{__dir__}/zendesk/app_job_statuses"
+    require "#{__dir__}/zendesk/apps"
+    require "#{__dir__}/zendesk/articles"
+    require "#{__dir__}/zendesk/audit_logs"
+    require "#{__dir__}/zendesk/automations"
+    require "#{__dir__}/zendesk/brands"
+    require "#{__dir__}/zendesk/client"
+    require "#{__dir__}/zendesk/comments"
+    require "#{__dir__}/zendesk/configuration"
+    require "#{__dir__}/zendesk/custom_roles"
+    require "#{__dir__}/zendesk/dynamic_content"
+    require "#{__dir__}/zendesk/dynamic_content_variants"
+    require "#{__dir__}/zendesk/groups"
+    require "#{__dir__}/zendesk/group_memberships"
+    require "#{__dir__}/zendesk/help_center_categories"
+    require "#{__dir__}/zendesk/help_center_content_tags"
+    require "#{__dir__}/zendesk/help_center_management_permission_groups"
+    require "#{__dir__}/zendesk/help_center_sections"
+    require "#{__dir__}/zendesk/help_center_topics"
+    require "#{__dir__}/zendesk/help_center_user_segments"
+    require "#{__dir__}/zendesk/job_statuses"
+    require "#{__dir__}/zendesk/locales"
+    require "#{__dir__}/zendesk/macros"
+    require "#{__dir__}/zendesk/oauth_clients"
+    require "#{__dir__}/zendesk/oauth_tokens"
+    require "#{__dir__}/zendesk/organization_fields"
+    require "#{__dir__}/zendesk/organizations"
+    require "#{__dir__}/zendesk/organization_memberships"
+    require "#{__dir__}/zendesk/requester_roles"
+    require "#{__dir__}/zendesk/satisfaction_reasons"
+    require "#{__dir__}/zendesk/schedules"
+    require "#{__dir__}/zendesk/schedule_holidays"
+    require "#{__dir__}/zendesk/search"
+    require "#{__dir__}/zendesk/sla_policies"
+    require "#{__dir__}/zendesk/targets"
+    require "#{__dir__}/zendesk/theme_job_statuses"
+    require "#{__dir__}/zendesk/themes"
+    require "#{__dir__}/zendesk/ticket_field_options"
+    require "#{__dir__}/zendesk/ticket_fields"
+    require "#{__dir__}/zendesk/ticket_forms"
+    require "#{__dir__}/zendesk/ticket_user_types"
+    require "#{__dir__}/zendesk/tickets"
+    require "#{__dir__}/zendesk/translations"
+    require "#{__dir__}/zendesk/trigger_categories"
+    require "#{__dir__}/zendesk/triggers"
+    require "#{__dir__}/zendesk/user_field_options"
+    require "#{__dir__}/zendesk/user_fields"
+    require "#{__dir__}/zendesk/users"
+    require "#{__dir__}/zendesk/via_types"
+    require "#{__dir__}/zendesk/views"
+    require "#{__dir__}/zendesk/webhooks"
+  end
+end

data/lib/support_ops_zendesk.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+$VERBOSE = nil
+
+##
+# Defines the module SupportOps
+# @author Jason Colyer
+# @since 1.0.0
+module SupportOps; end
+
+require 'active_support'
+require 'active_support/time'
+require 'base64'
+require 'cgi'
+require 'digest'
+require 'erb'
+require 'faraday'
+require 'faraday/multipart'
+require 'faraday/retry'
+require 'json'
+require 'oj'
+require 'yaml'
+require 'zip'
+
+# This one should always be first
+
+# Order does not matter here
+require "#{__dir__}/support_ops_zendesk/packages"
+require "#{__dir__}/support_ops_zendesk/zendesk"

metadata

@@ -0,0 +1,274 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-customer-support-operations_zendesk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jason Colyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 7.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 7.0.8
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+- !ruby/object:Gem::Dependency
+  name: digest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.16.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.16.3
+- !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: Zendesk gem of GitLab Customer Support Operations
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/support_ops_zendesk.rb
+- lib/support_ops_zendesk/packages.rb
+- lib/support_ops_zendesk/zendesk.rb
+- lib/support_ops_zendesk/zendesk/app_installations.rb
+- lib/support_ops_zendesk/zendesk/app_job_statuses.rb
+- lib/support_ops_zendesk/zendesk/apps.rb
+- lib/support_ops_zendesk/zendesk/articles.rb
+- lib/support_ops_zendesk/zendesk/audit_logs.rb
+- lib/support_ops_zendesk/zendesk/automations.rb
+- lib/support_ops_zendesk/zendesk/base.rb
+- lib/support_ops_zendesk/zendesk/brands.rb
+- lib/support_ops_zendesk/zendesk/client.rb
+- lib/support_ops_zendesk/zendesk/comments.rb
+- lib/support_ops_zendesk/zendesk/configuration.rb
+- lib/support_ops_zendesk/zendesk/custom_roles.rb
+- lib/support_ops_zendesk/zendesk/dynamic_content.rb
+- lib/support_ops_zendesk/zendesk/dynamic_content_variants.rb
+- lib/support_ops_zendesk/zendesk/group_memberships.rb
+- lib/support_ops_zendesk/zendesk/groups.rb
+- lib/support_ops_zendesk/zendesk/help_center_categories.rb
+- lib/support_ops_zendesk/zendesk/help_center_content_tags.rb
+- lib/support_ops_zendesk/zendesk/help_center_management_permission_groups.rb
+- lib/support_ops_zendesk/zendesk/help_center_sections.rb
+- lib/support_ops_zendesk/zendesk/help_center_topics.rb
+- lib/support_ops_zendesk/zendesk/help_center_user_segments.rb
+- lib/support_ops_zendesk/zendesk/job_statuses.rb
+- lib/support_ops_zendesk/zendesk/locales.rb
+- lib/support_ops_zendesk/zendesk/macros.rb
+- lib/support_ops_zendesk/zendesk/oauth_clients.rb
+- lib/support_ops_zendesk/zendesk/oauth_tokens.rb
+- lib/support_ops_zendesk/zendesk/organization_fields.rb
+- lib/support_ops_zendesk/zendesk/organization_memberships.rb
+- lib/support_ops_zendesk/zendesk/organizations.rb
+- lib/support_ops_zendesk/zendesk/requester_roles.rb
+- lib/support_ops_zendesk/zendesk/satisfaction_reasons.rb
+- lib/support_ops_zendesk/zendesk/schedule_holidays.rb
+- lib/support_ops_zendesk/zendesk/schedules.rb
+- lib/support_ops_zendesk/zendesk/search.rb
+- lib/support_ops_zendesk/zendesk/sla_policies.rb
+- lib/support_ops_zendesk/zendesk/targets.rb
+- lib/support_ops_zendesk/zendesk/theme_job_statuses.rb
+- lib/support_ops_zendesk/zendesk/themes.rb
+- lib/support_ops_zendesk/zendesk/ticket_field_options.rb
+- lib/support_ops_zendesk/zendesk/ticket_fields.rb
+- lib/support_ops_zendesk/zendesk/ticket_forms.rb
+- lib/support_ops_zendesk/zendesk/ticket_user_types.rb
+- lib/support_ops_zendesk/zendesk/tickets.rb
+- lib/support_ops_zendesk/zendesk/translations.rb
+- lib/support_ops_zendesk/zendesk/trigger_categories.rb
+- lib/support_ops_zendesk/zendesk/triggers.rb
+- lib/support_ops_zendesk/zendesk/user_field_options.rb
+- lib/support_ops_zendesk/zendesk/user_fields.rb
+- lib/support_ops_zendesk/zendesk/users.rb
+- lib/support_ops_zendesk/zendesk/via_types.rb
+- lib/support_ops_zendesk/zendesk/views.rb
+- lib/support_ops_zendesk/zendesk/webhooks.rb
+homepage: https://gitlab.com/reyloc/gitlab-customer-support-operations_zendesk
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://gitlab.com/reyloc/gitlab-customer-support-operations_zendesk/-/issues
+  documentation_uri: https://reyloc.gitlab.io/gitlab-customer-support-operations_zendesk/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '='
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key: 
+specification_version: 4
+summary: GitLab Customer Support Operations > Zendesk
+test_files: []