zendesk_support_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c28881afdb817ca2ba0c6cda69ca7005b7cafc04a85cd7941e5d4dd6faeaf3b0
-  data.tar.gz: 20032d3c334cef56ee462deddaca967b057d4ae2edd3d64e21697075838f6392
+  metadata.gz: 4914120c422052e97716f808fe888ec810bee8977f4fcd9d275cc6b1705c4ca0
+  data.tar.gz: 4cded8d95430a510322e44f0310f18ce9c01a5776a4dac4ab476eaee487fbecf
 SHA512:
-  metadata.gz: f3bab94f1e5301ea0afdf086b3b7fdd9fefc8c07f4a07920eab6f6ffe55b48bbf4c69b1fda3bbfa3bf80ab6fe30064b1db925c5488bd6258ea8e91b6d95183e5
-  data.tar.gz: e7f1452b31ca1f508c4b12eabd6ac559001fdff33986ffd80b4e19b34b2f0b39fa45d55fa58a547707e44ce16a2b95beb215219559618cc9286de6650e5a4e90
+  metadata.gz: 0065aa4ea3865fd6169a1650ed126d1748e290190dd5a5755c72fda7e37f6f365599e1f73fe178c07d68aa6ed2fed202cad6f6768fec91567c86dd2dafc2817a
+  data.tar.gz: 89c5da1d7258032fe2c56369a7d31e69131137012ada8573618b61693be110ac8a5e0b5bb196afa4cdca0ad1a1e20c21b7ddaa4c51da58f4ddda62e1aef7f162

data/.yardoc/checksums

@@ -1,6 +1,7 @@
 lib/zendesk_support_api.rb fee89f019b11ec8feb844644e000cec6cad6a695
 lib/zendesk_support_api/jobs.rb 15e3db660bb16f1a2bc580ce17a9368f81fc9d0e
-lib/zendesk_support_api/users.rb aae91915f1ffdbaa2b2850f5c3b252e47dc04e6e
-lib/zendesk_support_api/client.rb 65afe092b9549b6cb476821d5963b6ef2a933772
+lib/zendesk_support_api/users.rb eb4f8d81f6f9ccf779679f7bfe354c0cc6be8d0c
+lib/zendesk_support_api/client.rb f73dc3643644c6bf5f1a82593971b78a47b384fc
+lib/zendesk_support_api/groups.rb bcc2a0b1af5bf3552c7838d80f339efbf8636e53
 lib/zendesk_support_api/search.rb e741717c61809c578afbcd44f9b8e8f18a8c0363
-lib/zendesk_support_api/version.rb 0d7f1c19d613fc9c5bd48f6be452e934221318fa
+lib/zendesk_support_api/version.rb e6591152418f6cbe5b2a2ff5d68799f735ed597d

data/README.md

@@ -49,3 +49,7 @@ Soon to come
   * Added Search functions
   * Fixed some yard syntax/formatting
   * Changed version number
+* v0.3.0
+  * Changed version number
+  * Added Group functions
+  * Added User.groups function

data/lib/zendesk_support_api/client.rb

@@ -3,6 +3,7 @@
 module ZendeskSupportAPI
   # Client class - https://developer.zendesk.com/rest_api/docs/support/introduction#security-and-authentication
   class Client
+    require 'zendesk_support_api/groups'
     require 'zendesk_support_api/jobs'
     require 'zendesk_support_api/search'
     require 'zendesk_support_api/users'

data/lib/zendesk_support_api/groups.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Groups class - https://developer.zendesk.com/rest_api/docs/support/groups
+  class Groups
+    # Function to return a string that side-loads users
+    #
+    # @return [String]
+
+    def self.user_map(groups, users)
+      groups.map { |g| group_object(g, users) }
+    end
+
+    # Creates a group hash (for mappping the user into the group Hash)
+    #
+    # @param group [Hash] The group details to use
+    # @param users [Array] The Array of users to use
+    # @return [Hash]
+
+    def self.group_object(group, users)
+      group['user'] = users.select { |u| u['id'] == group['user_id'] }
+      group
+    end
+
+    # Returns the string of the next_page for pagination
+    #
+    # @param res [Hash] The Hash containing the response from a request
+    # @return [nil|String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.next_page(response) #=> nil
+    #   ZendeskSupportAPI::Users.next_page(response)
+    #   #=> "memberships.json?include=users&page=3
+
+    def self.next_page(res)
+      (res['next_page'].nil? ? nil : res['next_page'].split('/').last)
+    end
+
+    # Lists groups (first 100)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Groups.list(client)
+    #   #=> [
+    #   #=>   {
+    #   #=>     "name":       "DJs",
+    #   #=>     "created_at": "2009-05-13T00:07:08Z",
+    #   #=>     "updated_at": "2011-07-22T00:11:12Z",
+    #   #=>     "id":         211
+    #   #=>   },
+    #   #=>   {
+    #   #=>     "name":       "MCs",
+    #   #=>     "created_at": "2009-08-26T00:07:08Z",
+    #   #=>     "updated_at": "2010-05-13T00:07:08Z",
+    #   #=>     "id":         122
+    #   #=>   }
+    #   #=> ]
+
+    def self.list(client)
+      client.request(:get, 'groups.json')['groups']
+    end
+
+    # Shows assignable groups (first 100)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Groups.assignable(client)
+    #   #=> [
+    #   #=>   {
+    #   #=>     "name":       "DJs",
+    #   #=>     "created_at": "2009-05-13T00:07:08Z",
+    #   #=>     "updated_at": "2011-07-22T00:11:12Z",
+    #   #=>     "id":         211
+    #   #=>   },
+    #   #=>   {
+    #   #=>     "name":       "MCs",
+    #   #=>     "created_at": "2009-08-26T00:07:08Z",
+    #   #=>     "updated_at": "2010-05-13T00:07:08Z",
+    #   #=>     "id":         122
+    #   #=>   }
+    #   #=> ]
+
+    def self.assignable(client)
+      client.request(:get, 'assignable.json')['groups']
+    end
+
+    # Shows info about a specific group
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param gid [Integer] The Group ID
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Groups.show(client, 122)
+    #   #=> {
+    #   #=>   "name":       "MCs",
+    #   #=>   "created_at": "2009-08-26T00:07:08Z",
+    #   #=>   "updated_at": "2010-05-13T00:07:08Z",
+    #   #=>   "id":         122
+    #   #=> }
+
+    def self.show(client, gid)
+      client.request(:get, "groups/#{gid}.json")['group']
+    end
+
+    # Create a group
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param group [Hash] The group details to use
+    # @return [String|Hash]
+    #
+    # @example
+    #   group = {
+    #     name: 'Test Group'
+    #   }
+    #   ZendeskSupportAPI::Groups.create(client, group)
+    #   #=> {
+    #   #=>   "name": "Test Group",
+    #   #=>   "created_at": "2011-04-20T17:49:00Z",
+    #   #=>    "updated_at": "2011-04-20T17:49:00Z",
+    #   #=>    "id":         123
+    #   #=> }
+
+    def self.create(client, group)
+      res = client.request(:post, 'groups.json', group: group)
+      return "Creation failed: #{res['details']}" if res['error']
+
+      res
+    end
+
+    # Updates a group
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param gid [Integer] The group ID to use
+    # @param group [Hash] The group details to use
+    # @return [String|Hash]
+    #
+    # @example
+    #   group = {
+    #     name: 'Test Group - defunct'
+    #   }
+    #   ZendeskSupportAPI::Groups.update(client, 123, group)
+    #   #=> {
+    #   #=>   "name": "Test Group - defunct",
+    #   #=>   "created_at": "2011-04-20T17:49:00Z",
+    #   #=>    "updated_at": "2011-07-20T17:49:00Z",
+    #   #=>    "id":         123
+    #   #=> }
+
+    def self.update(client, gid, group)
+      res = client.request(:post, "groups/#{gid}.json", group: group)
+      return "Update failed: #{res['details']}" if res['error']
+
+      res
+    end
+
+    # Deletes a group
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param gid [Integer] The group ID to use
+    # @return [String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Groups.delete(client, 123)
+    #   #=> Group 123 has been deleted
+
+    def self.delete(client, gid)
+      res = client.request(:delete, "groups/#{gid}.json")
+      return "Deletion of #{gid} failed: #{res['error']}" if res['error']
+
+      "Group #{gid} has been deleted"
+    end
+  end
+end

data/lib/zendesk_support_api/users.rb

@@ -57,7 +57,7 @@ module ZendeskSupportAPI
     #
     # @example
     #   ZendeskSupportAPI::Users.all(client)
-    #   #=> Grabbing users... / ...done
+    #   #=> Grabbing users (total: 215336)... / ...done
     #   #=> {users:[{user1},{user2}...{user201520}]}
 
     def self.all(client)
@@ -286,5 +286,32 @@ module ZendeskSupportAPI
 
       "User #{id} suspended" if res['user']['suspended']
     end
+
+    # Shows a users groups
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param uid [Integer] The User ID to use
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.groups(client, 1234)
+    #   #=> [
+    #   #=>   {
+    #   #=>     "name":       "DJs",
+    #   #=>     "created_at": "2009-05-13T00:07:08Z",
+    #   #=>     "updated_at": "2011-07-22T00:11:12Z",
+    #   #=>     "id":         211
+    #   #=>   },
+    #   #=>   {
+    #   #=>     "name":       "MCs",
+    #   #=>     "created_at": "2009-08-26T00:07:08Z",
+    #   #=>     "updated_at": "2010-05-13T00:07:08Z",
+    #   #=>     "id":         122
+    #   #=>   }
+    #   #=> ]
+
+    def self.groups(client, uid)
+      client.request(:get, "users/#{uid}/groups.json")['groups']
+    end
   end
 end

data/lib/zendesk_support_api/version.rb

@@ -3,5 +3,5 @@
 module ZendeskSupportAPI
   # Outputs the gem version
 
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_support_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jason Colyer
@@ -53,6 +53,7 @@ files:
 - README.md
 - lib/zendesk_support_api.rb
 - lib/zendesk_support_api/client.rb
+- lib/zendesk_support_api/groups.rb
 - lib/zendesk_support_api/jobs.rb
 - lib/zendesk_support_api/search.rb
 - lib/zendesk_support_api/users.rb