gitlab-customer-support-operations_zendesk 1.0.0

data/lib/support_ops_zendesk/zendesk/base.rb

@@ -0,0 +1,472 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Base within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Base
+      class << self
+        def client
+          Configuration.config.client
+        end
+
+        def configure
+          yield Configuration.config
+        end
+
+        def define_attributes(*attrs)
+          @attributes = attrs
+          attrs.each do |attr|
+            attr_accessor attr
+          end
+        end
+
+        def attributes
+          @attributes || []
+        end
+  
+        def readonly_attributes(*attrs)
+          return @readonly_attributes || [] if attrs.empty?
+
+          @readonly_attributes = attrs
+        end
+      end
+  
+      def initialize(attributes = {}, client = nil)
+        @client = client
+        @original_attributes = {}
+        set_attributes(attributes)
+        store_original_attributes
+      end
+
+      def store_original_attributes
+        @original_attributes = {}
+        self.class.attributes.each do |attr|
+          @original_attributes[attr] = instance_variable_get("@#{attr}")
+        end
+      end
+
+      ##
+      # Converts an Object to a Hash
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object]
+      # @return [Hash]
+      def self.to_hash(object)
+        Hash[object.instance_variables.map { |name| [name.to_s[1..-1], object.instance_variable_get(name)] }]
+      end
+
+      def find
+        ensure_client_present!
+        set_attributes(get_record)
+        store_original_attributes
+        self
+      end
+
+      def find!
+        ensure_client_present!
+        attrs = get_record
+        if attrs == nil
+          if self.is_a? SupportOps::Zendesk::Translations
+            raise "Unable to locate #{self.class.name.demodulize.singularize.downcase} '#{self.source_id} (locale: #{self.locale})'"
+          else
+            raise "Unable to locate #{self.class.name.demodulize.singularize.downcase} '#{self.id}'"
+          end
+        end
+        set_attributes(attrs)
+        store_original_attributes
+        self
+      end
+
+      def collaborators
+        ensure_client_present!
+        collaborators_record
+      end
+
+      def followers
+        ensure_client_present!
+        followers_record
+      end
+
+      def ccs
+        ensure_client_present!
+        ccs_record
+      end
+
+      def comments
+        ensure_client_present!
+        comments_record
+      end
+
+      def mark_as_spam!
+        ensure_client_present!
+        mark_as_spam_record
+      end
+
+      def incidents
+        ensure_client_present!
+        incidents_record
+      end
+
+      def redact_attachments!
+        ensure_client_present!
+        redact_attachments_record
+      end
+  
+      def save!
+        ensure_client_present!
+        new_data = if id.nil?
+                     create_record
+                   else
+                     update_record
+                   end
+        if self.is_a? SupportOps::Zendesk::Themes
+          new_data
+        else
+          new_data.each do |key, value|
+            self.instance_variable_set("@#{key}", value) if self.respond_to?("#{key}=")
+          end
+          store_original_attributes
+          self
+        end
+      end
+
+      def delete!
+        ensure_client_present!
+        delete_record
+      end
+
+      def create_or_update!
+        ensure_client_present!
+        new_data = create_or_update_record
+        store_original_attributes
+        new_data.each do |key, value|
+          self.instance_variable_set("@#{key}", value) if self.respond_to?("#{key}=")
+        end
+        self
+      end
+
+      def tickets
+        ensure_client_present!
+        tickets_record
+      end
+
+      def ccd_tickets
+        ensure_client_present!
+        ccd_ticket_record
+      end
+
+      def assigned_tickets
+        ensure_client_present!
+        assigned_ticket_record
+      end
+
+      def organization
+        ensure_client_present!
+        organization_record
+      end
+
+      def organizations
+        ensure_client_present!
+        organizations_record
+      end
+
+      def memberships
+        ensure_client_present!
+        memberships_record
+      end
+
+      def organization_memberships
+        ensure_client_present!
+        organization_memberships_record
+      end
+
+      def group_memberships
+        ensure_client_present!
+        group_memberships_record
+      end
+
+      def groups
+        ensure_client_present!
+        groups_record
+      end
+
+      def set_password!
+        ensure_client_present!
+        set_password_record
+      end
+
+      def users
+        ensure_client_present!
+        users_record
+      end
+
+      def make_default!
+        ensure_client_present!
+        make_default_record
+      end
+
+      def create_satisfaction_score!(**args)
+        ensure_client_present!
+        create_satisfaction_score_record(**args)
+      end
+
+      def wait_for_completetion(**args)
+        ensure_client_present!
+        new_data = wait_for_completetion_record(**args)
+        store_original_attributes
+        new_data.each do |key, value|
+          self.instance_variable_set("@#{key}", value) if self.respond_to?("#{key}=")
+        end
+        self
+      end
+
+      def preview!
+        ensure_client_present!
+        preview_record
+      end
+
+      def holidays
+        ensure_client_present!
+        holidays_record
+      end
+
+      def category
+        ensure_client_present!
+        category_record
+      end
+
+      def clone!
+        ensure_client_present!
+        clone_record
+      end
+
+      def field_options
+        ensure_client_present!
+        field_options_record
+      end
+
+      def item_variants
+        ensure_client_present!
+        item_variants_record
+      end
+
+      def parent
+        ensure_client_present!
+        parent_record
+      end
+
+      def translations
+        ensure_client_present!
+        translations_record
+      end
+
+      def public_key
+        ensure_client_present!
+        public_key_record
+      end
+
+      def web_url
+        web_url_record
+      end
+
+      def client=(new_client)
+        @client = new_client
+      end
+  
+      protected
+  
+      attr_reader :attributes, :original_attributes
+
+      def set_attributes(attributes)
+        return unless attributes
+
+        attrs = attributes.transform_keys(&:to_sym)
+        
+        self.class.attributes.each do |attr|
+          instance_variable_set("@#{attr}", attrs[attr])
+        end
+      end
+
+      def attributes_for_save
+        if send(:id) == nil
+          self.class.attributes
+            .reject { |attr| self.class.readonly_attributes.include?(attr) }
+            .each_with_object({}) do |attr, hash|
+              hash[attr] = send(attr)
+            end
+        else
+          self.class.attributes
+            .reject { |attr| self.class.readonly_attributes.include?(attr) }
+            .each_with_object({}) do |attr, hash|
+              current_value = send(attr)
+              original_value = @original_attributes[attr]
+
+              hash[attr] = current_value if attr == :id
+              if original_value != current_value
+                hash[attr] = current_value
+              end
+            end
+        end
+      end
+
+      def client
+        @client ||= self.class.client
+      end
+  
+      def ensure_client_present!
+        raise 'No client configured. Use SupportOps::Zendesk.configure to set up the client.' unless client
+      end
+
+      def get_record(**args)
+        raise NotImplementedError
+      end
+
+      def create_record
+        raise NotImplementedError
+      end
+  
+      def update_record
+        raise NotImplementedError
+      end
+
+      def delete_record
+        raise NotImplementedError
+      end
+
+      def collaborators_record
+        raise NotImplementedError
+      end
+
+      def followers_record
+        raise NotImplementedError
+      end
+
+      def ccs_record
+        raise NotImplementedError
+      end
+
+      def comments_record
+        raise NotImplementedError
+      end
+
+      def mark_as_spam_record
+        raise NotImplementedError
+      end
+
+      def incidents_record
+        raise NotImplementedError
+      end
+
+      def redact_attachments_record
+        raise NotImplementedError
+      end
+
+      def create_or_update_record
+        raise NotImplementedError
+      end
+
+      def tickets_record
+        raise NotImplementedError
+      end
+
+      def ccd_ticket_record
+        raise NotImplementedError
+      end
+
+      def assigned_ticket_record
+        raise NotImplementedError
+      end
+
+      def organization_record
+        raise NotImplementedError
+      end
+
+      def memberships_record
+        raise NotImplementedError
+      end
+
+      def organization_memberships_record
+        raise NotImplementedError
+      end
+
+      def group_memberships_record
+        raise NotImplementedError
+      end
+
+      def set_password_record
+        raise NotImplementedError
+      end
+
+      def organizations_record
+        raise NotImplementedError
+      end
+
+      def groups_record
+        raise NotImplementedError
+      end
+
+      def users_record
+        raise NotImplementedError
+      end
+
+      def make_default_record
+        raise NotImplementedError
+      end
+
+      def wait_for_completetion_record(**args)
+        raise NotImplementedError
+      end
+
+      def create_satisfaction_score_record(**args)
+        raise NotImplementedError
+      end
+
+      def preview_record
+        raise NotImplementedError
+      end
+
+      def holidays_record
+        raise NotImplementedError
+      end
+
+      def category_record
+        raise NotImplementedError
+      end
+
+      def clone_record
+        raise NotImplementedError
+      end
+
+      def field_options_record
+        raise NotImplementedError
+      end
+
+      def item_variants_record
+        raise NotImplementedError
+      end
+
+      def parent_record
+        raise NotImplementedError
+      end
+
+      def translations_record
+        raise NotImplementedError
+      end
+
+      def public_key_record
+        raise NotImplementedError
+      end
+
+      def web_url_record
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/support_ops_zendesk/zendesk/brands.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Brands within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Boolean] active If the brand is set as active
+    # @attr [String] brand_url The url of the brand
+    # @attr [String] created_at The time the brand was created
+    # @attr [Boolean] default Is the brand the default brand for this account
+    # @attr [Boolean] has_help_center If the brand has a Help Center
+    # @attr [String] help_center_state The state of the Help Center. Allowed values are "enabled", "disabled", or "restricted".
+    # @attr [String] host_mapping The hostmapping to this brand, if any. Only admins view this property.
+    # @attr [Integer] id The ID automatically assigned when the brand is created
+    # @attr [Boolean] is_deleted If the brand object is deleted or not
+    # @attr [Hash] logo A file represented as an Attachment object
+    # @attr [String] name The name of the brand
+    # @attr [String] signature_template The signature template for a brand
+    # @attr [String] subdomain The subdomain of the brand
+    # @attr [Array] ticket_form_ids The ids of ticket forms that are available for use by a brand
+    # @attr [String] updated_at The time of the last update of the brand
+    # @todo Create brand => https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#create-brand
+    # @todo Update a Brand => https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#update-a-brand
+    # @todo Delete a Brand => https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#delete-a-brand
+    # @todo Check Host Mapping Validity => https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#check-host-mapping-validity
+    # @todo Check Host Mapping Validity for an Existing Brand => https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#check-host-mapping-validity-for-an-existing-brand
+    class Brands < SupportOps::Zendesk::Base
+      define_attributes :active, :brand_url, :created_at, :default,
+                        :has_help_center, :help_center_state, :host_mapping,
+                        :id, :is_deleted, :logo, :name, :signature_template,
+                        :subdomain, :ticket_form_ids, :updated_at
+      readonly_attributes :created_at, :help_center_state, :id,
+                          :ticket_form_ids, :updated_at
+
+      ##
+      # Lists all brands in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#list-brands
+      #   Zendesk API > Brands > List Brands
+      # @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
+      #
+      #   brands = SupportOps::Zendesk::Brands.list
+      #   pp brands.last.name
+      #   # => "Billing"
+      def self.list
+        response = client.connection.get('brands?page[size]=100')
+        Oj.load(response.body)['brands'].map { |b| Brands.new(b) }
+      end
+
+      ##
+      # Locates a brand 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::Brands to use as a cache
+      # @return [Object] An instance of {SupportOps::Zendesk::Brands}
+      # @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
+      #
+      #   brands = SupportOps::Zendesk::Brands.list
+      #   brand = SupportOps::Zendesk::Brands.find_by_name(name: 'Billing', cache: brands)
+      #   pp brand.name
+      #   # => "Billing"
+      #   pp brand.id
+      #   # => 123456
+      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
+          brands = args[:cache]
+        else
+          brands = list
+        end
+        brands.detect { |c| c.name.downcase == args[:name].to_s.downcase }
+      end
+
+      ##
+      # Locates a specific group in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#show-a-brand
+      #   Zendesk API > Brands > Show a Brand
+      # @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
+      #
+      #   brand = SupportOps::Zendesk::Brands.get(123456)
+      #   pp brand.name
+      #   # => "Billing"
+      def self.get(object)
+        if object.is_a? Brands
+          Brands.new(id: id).find
+        else
+          Brands.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific group in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#show-a-brand
+      #   Zendesk API > Brands > Show a Brand
+      # @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
+      #
+      #   brand = SupportOps::Zendesk::Brands.get!(123456)
+      #   pp brand.name
+      #   # => "Billing"
+      def self.get!(object)
+        if object.is_a? Brands
+          Brands.new(id: id).find!
+        else
+          Brands.new(id: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("brands/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['brand']
+      end
+    end
+  end
+end