gitlab_support_readiness 1.0.0

data/lib/support_readiness/zendesk/group_memberships.rb

@@ -0,0 +1,256 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class GroupMemberships within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class GroupMemberships < Readiness::Client
+      attr_accessor :id, :default, :group_id, :user_id
+
+      ##
+      # Creates a new {Readiness::Zendesk::GroupMemberships} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::GroupMemberships}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::GroupMemberships.new
+      def initialize(object = {})
+        @id = object['id']
+        @default = object['default']
+        @group_id = object['group_id']
+        @user_id = object['user_id']
+      end
+
+      ##
+      # Lists the first 100 group memberships
+      #
+      # @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/groups/group_memberships/#list-memberships Zendesk API > Group Memberships > List Memberships
+      # @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)
+      #   memberships = Readiness::Zendesk::GroupMemberships.list(client)
+      #   pp memberships.first.id
+      #   # => 4
+      def self.list(client)
+        response = client.connection.get("group_memberships?page[size]=100")
+        handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+        Oj.load(response.body)['group_memberships'].map { |m| GroupMemberships.new(m) }
+      end
+
+      ##
+      # Lists many group memberships. Does not stop until it ends or the page limit is hit.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param limit [Integer] The number of pages to stop at. Using 0 means to list all.
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/#list-memberships Zendesk API > Group Memberships > List Memberships
+      # @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)
+      #   memberships = Readiness::Zendesk::GroupMemberships.list_many(client)
+      #   pp memberships.first.id
+      #   # => 4
+      def self.list_many(client, limit = 0)
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("group_memberships?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['group_memberships'].map { |o| GroupMemberships.new(o) }
+          break if limit != 0 && array.count >= (limit * 100)
+          break unless body['meta']['has_more']
+
+          opts = body['links'] ['next'].split('?').last
+        end
+        array
+      end
+
+      ##
+      # Locates a group membership 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 gid [Integer] The group membership ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/#show-membership Zendesk API > Group Memberships > Show Membership
+      # @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)
+      #   membership = Readiness::Zendesk::GroupMemberships.find(client, 4)
+      #   pp membership.user_id
+      #   # => 29
+      def self.find(client, gid)
+        response = client.connection.get("group_memberships/#{gid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: gid }) unless response.status == 200
+        return GroupMemberships.new(Oj.load(response.body)['group_membership']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a group membership within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param gid [Integer] The group membership ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/#show-membership Zendesk API > Group Memberships > Show Membership
+      # @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)
+      #   membership = Readiness::Zendesk::GroupMemberships.find!(client, 4)
+      #   pp membership.user_id
+      #   # => 29
+      def self.find!(client, gid)
+        response = client.connection.get("group_memberships/#{gid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find group membership', id: gid }) unless response.status == 200
+        GroupMemberships.new(Oj.load(response.body)['group_membership'])
+      end
+
+      ##
+      # Creates an organization membership. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param membership [Object] An instance of {Readiness::Zendesk::GroupMemberships}
+      # @return [Object] An instance of {Readiness::Zendesk::GroupMemberships}
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/#create-membership Zendesk API > Group Memberships > Create Membership
+      # @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)
+      #   membership = Readiness::Zendesk::GroupMemberships.new
+      #   membership.user_id = 72
+      #   membership.group_id: 88
+      #   create = Readiness::Zendesk::GroupMemberships.create!(client, membership)
+      #   pp create.id
+      #   # => 461
+      def self.create!(client, membership)
+        response = client.connection.post 'group_memberships', to_clean_json_with_key(membership, 'group_membership')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create group membership', message: Oj.load(response.body)}) unless response.status == 201
+        GroupMemberships.new(Oj.load(response.body)['group_membership'])
+      end
+
+      ##
+      # Creates multiple organization memberships via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param memberships [Array] An array of {Readiness::Zendesk::GroupMemberships} instances
+      # @return [object] A {Readiness::Zendesk::JobStatuses} instance
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/#bulk-create-memberships Zendesk API > Group Memberships > Create Many Memberships
+      # @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)
+      #   membership1 = Readiness::Zendesk::GroupMemberships.new
+      #   membership1.user_id = 72
+      #   membership1.group_id: 88
+      #   membership2 = Readiness::Zendesk::GroupMemberships.new
+      #   membership2.user_id = 27
+      #   membership2.group_id: 88
+      #   memberships = [membership1, membership2]
+      #   create = Readiness::Zendesk::GroupMemberships.create_many!(client, memberships)
+      #   pp create.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.create_many(client, memberships)
+        data = { group_memberships: memberships.map { |t| to_hash(t).compact } }.to_json
+        response = client.connection.post('group_memberships/create_many', data)
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create many group memberships', message: Oj.load(response.body)}) unless response.status == 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      ##
+      # Deletes an group membership. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param membership [Object] An instance of {Readiness::Zendesk::GroupMemberships}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/#delete-membership Zendesk API > Group Memberships > Delete Membership
+      # @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)
+      #   membership = Readiness::Zendesk::GroupMemberships.find!(client, 4)
+      #   delete = Readiness::Zendesk::GroupMemberships.delete!(client, membership)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, membership)
+        response = client.connection.delete "group_memberships/#{membership.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete group membership', message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+
+      ##
+      # Deletes multiple organization memberships via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param mids [Array] An array of group memberships IDs
+      # @return [object] A {Readiness::Zendesk::JobStatuses} instance
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/#bulk-delete-memberships Zendesk API > Group Memberships > Bulk Delete Memberships
+      # @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)
+      #   delete = Readiness::Zendesk::GroupMemberships.delete_many!(client, [1, 2, 3])
+      #   pp delete.id
+      #   # => "82de0b044094f0c67893ac9fe64f1a99"
+      def self.delete_many!(client, mids)
+        response = client.connection.delete("group_memberships/destroy_many?ids=#{mids.join(',')}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many group memberships', message: Oj.load(response.body)}) unless response.status == 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/groups.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Groups within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Groups < Readiness::Client
+      attr_accessor :default, :deleted, :description, :id, :is_public, :name
+
+      ##
+      # Creates a new {Readiness::Zendesk::Groups} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::Groups}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::Groups.new
+      def initialize(object = {})
+        @default = object['default']
+        @deleted = object['deleted']
+        @description = object['description']
+        @id = object['id']
+        @is_public = object['is_public']
+        @name = object['name']
+      end
+
+      ##
+      # Lists the first 100 groups
+      #
+      # @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/groups/groups/#list-groups Zendesk API > Groups > List Groups
+      # @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)
+      #   groups = Readiness::Zendesk::Groups.list(client)
+      #   pp groups.first.id
+      #   # => 211
+      def self.list(client)
+        response = client.connection.get("groups?page[size]=100")
+        handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+        Oj.load(response.body)['groups'].map { |g| Groups.new(g) }
+      end
+
+      ##
+      # Show information on the approximate count of groups.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/groups/#count-groups Zendesk API > Groups > Count Groups
+      # @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::Groups.count(client)
+      #   pp count['value']
+      #   # => 102
+      def self.count(client)
+        response = client.connection.get('groups/count')
+        handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+        Oj.load(response.body)['count']
+      end
+
+      ##
+      # Locates a group 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 gid [Integer] The group ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/groups/#show-group Zendesk API > Groups > Show Group
+      # @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)
+      #   group = Readiness::Zendesk::Groups.find(client, 211)
+      #   pp group.name
+      #   # => "DJs"
+      def self.find(client, gid)
+        response = client.connection.get("groups/#{gid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: gid }) unless response.status == 200
+        return Groups.new(Oj.load(response.body)['group']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a group within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param gid [Integer] The group ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/groups/#show-group Zendesk API > Groups > Show Group
+      # @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)
+      #   group = Readiness::Zendesk::Groups.find!(client, 211)
+      #   pp group.name
+      #   # => "DJs"
+      def self.find!(client, gid)
+        response = client.connection.get("groups/#{gid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find group', id: gid }) unless response.status == 200
+        Groups.new(Oj.load(response.body)['group'])
+      end
+
+      ##
+      # Creates a group. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param group [Object] An instance of {Readiness::Zendesk::Groups}
+      # @return [Object] An instance of {Readiness::Zendesk::Groups}
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/groups/#create-group Zendesk API > Groups > Create Group
+      # @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)
+      #   group = Readiness::Zendesk::Groups.new
+      #   group.name = 'My Group'
+      #   create = Readiness::Zendesk::Groups.create!(client, group)
+      #   pp create.id
+      #   # => 122
+      def self.create!(client, group)
+        response = client.connection.post 'groups', to_clean_json_with_key(group, 'group')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create group', message: Oj.load(response.body)}) unless response.status == 201
+        Groups.new(Oj.load(response.body)['group'])
+      end
+
+      ##
+      # Updates a group. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param group [Object] An instance of {Readiness::Zendesk::Groups}
+      # @return [Object] An instance of {Readiness::Zendesk::Groups}
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/groups/#update-group Zendesk API > Groups > Update Group
+      # @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)
+      #   group = Readiness::Zendesk::Groups.find!(client, 122)
+      #   group.name = 'My Group 2'
+      #   update = Readiness::Zendesk::Groups.update!(client, group)
+      #   pp update.name
+      #   # => "My Group 2"
+      def self.update!(client, group)
+        response = client.connection.put "groups/#{group.id}", to_clean_json_with_key(group, 'group')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update group', id: group.id, message: Oj.load(response.body)}) unless response.status == 200
+        Groups.new(Oj.load(response.body)['group'])
+      end
+
+      ##
+      # Deletes a group. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param group [Object] An instance of {Readiness::Zendesk::Groups}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/groups/groups/#delete-group Zendesk API > Groups > Delete Group
+      # @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)
+      #   group = Readiness::Zendesk::Groups.find!(client, 122)
+      #   delete = Readiness::Zendesk::Groups.delete!(client, group)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, group)
+        response = client.connection.delete "groups/#{group.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete an group', id: group.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+
+      ##
+      # Lists the members of a group
+      #
+      # @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/groups/group_memberships/#list-memberships Zendesk API > Group Memberships > List Memberships
+      # @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)
+      #   group = Readiness::Zendesk::Groups.find!(client, 122)
+      #   members = Readiness::Zendesk::Groups.memberships(client, group)
+      #   pp members.count
+      #   # => 38
+      def self.memberships(client, group)
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("groups/#{group.id}/memberships?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['group_memberships']
+          break if limit != 0 && array.count >= (limit * 100)
+          break unless body['meta']['has_more']
+
+          opts = body['links'] ['next'].split('?').last
+        end
+        array
+      end
+    end
+  end
+end