zendesk_support_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35ce4e3e27845ca77e9d5436ce5cc053f0430a74ca9765ec708425ce19549f18
-  data.tar.gz: b0ac9059cbd6aa2ee599d91025d43f89e1b687dbb3f982ab1f32f7ec41f8105a
+  metadata.gz: c28881afdb817ca2ba0c6cda69ca7005b7cafc04a85cd7941e5d4dd6faeaf3b0
+  data.tar.gz: 20032d3c334cef56ee462deddaca967b057d4ae2edd3d64e21697075838f6392
 SHA512:
-  metadata.gz: 753387da38749fd018d1c70370ff0f48112b5b287b91339f59f042e9db8c2bd9106b4c481a3ae6d450d858ff3b07db2cc307c26953991fb9b25890ecaeb190b8
-  data.tar.gz: fdad54556055bc06e87c0a9bb5bcc62fbbcc73891ba26ad0b9716528cad3cfb754c7e3f6543be14af788137c292a7c7b7513836a033f8cfcab2d5290fd422e2d
+  metadata.gz: f3bab94f1e5301ea0afdf086b3b7fdd9fefc8c07f4a07920eab6f6ffe55b48bbf4c69b1fda3bbfa3bf80ab6fe30064b1db925c5488bd6258ea8e91b6d95183e5
+  data.tar.gz: e7f1452b31ca1f508c4b12eabd6ac559001fdff33986ffd80b4e19b34b2f0b39fa45d55fa58a547707e44ce16a2b95beb215219559618cc9286de6650e5a4e90

data/.yardoc/checksums

@@ -1,5 +1,6 @@
 lib/zendesk_support_api.rb fee89f019b11ec8feb844644e000cec6cad6a695
-lib/zendesk_support_api/jobs.rb 21241d490bcb750ab702dc07e0d98b194ced2632
-lib/zendesk_support_api/users.rb bac3de0bac0a04cbe8cd1d338357470ddbca3bb6
-lib/zendesk_support_api/client.rb 157b67cde7b4e66ccdcbcda67d5a34bc9c3b8572
-lib/zendesk_support_api/version.rb f929e8c6d528a2522ca83288be610db1c9064a10
+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/search.rb e741717c61809c578afbcd44f9b8e8f18a8c0363
+lib/zendesk_support_api/version.rb 0d7f1c19d613fc9c5bd48f6be452e934221318fa

data/README.md

@@ -37,3 +37,15 @@ require 'zendesk_support_api'
 client = ZendeskSupportAPI::Client.new('user@example.com', '123abc', 'https://zendesk.com/api/v2')
 ```
 
+## Usage
+
+Soon to come
+
+## Changelog
+
+* v0.1.0
+  * Initial creation of gem
+* v0.2.0
+  * Added Search functions
+  * Fixed some yard syntax/formatting
+  * Changed version number

data/lib/zendesk_support_api/client.rb

@@ -4,6 +4,7 @@ module ZendeskSupportAPI
   # Client class - https://developer.zendesk.com/rest_api/docs/support/introduction#security-and-authentication
   class Client
     require 'zendesk_support_api/jobs'
+    require 'zendesk_support_api/search'
     require 'zendesk_support_api/users'
 
     # Create a new instance of Client

data/lib/zendesk_support_api/jobs.rb

@@ -5,7 +5,7 @@ module ZendeskSupportAPI
   class Jobs
     # Make a request to show the job status
     #
-    # @param client [ZendeskSupportAPI::Client] The client instance
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
     # @param id [String] The id of the job to check
     # @return [Hash]
     #
@@ -38,5 +38,58 @@ module ZendeskSupportAPI
     def self.show(client, id)
       client.request(:get, "job_statuses/#{id}.json")
     end
+
+    # Make a request to show all job statuses
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Jobs.show_many(client, ['abc123', 'def456'])
+    #   #=> {
+    #   #=>   "job_statuses": [
+    #   #=>     {
+    #   #=>       "id": "abc123",
+    #   #=>       "status": "completed",
+    #   #=>       ...
+    #   #=>     },
+    #   #=>     {
+    #   #=>      "id": "def456",
+    #   #=>      "status": "completed",
+    #   #=>      ...
+    #   #=>     }
+    #   #=>   ]
+    #   #=> }
+
+    def self.list(client)
+      client.request(:get, 'job_statuses.json')['job_statuses']
+    end
+
+    # Show many job statuses
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param ids [Array] An Array of job IDs to show
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Jobs.show_many(client, ['abc123', 'def456'])
+    #   #=> {
+    #   #=>   "job_statuses": [
+    #   #=>     {
+    #   #=>       "id": "abc123",
+    #   #=>       "status": "completed",
+    #   #=>       ...
+    #   #=>     },
+    #   #=>     {
+    #   #=>      "id": "def456",
+    #   #=>      "status": "completed",
+    #   #=>      ...
+    #   #=>     }
+    #   #=>   ]
+    #   #=> }
+
+    def self.show_many(client, ids)
+      client.request(:get, "job_statuses/show_many.json?ids=#{ids.join(',')}")
+    end
   end
 end

data/lib/zendesk_support_api/search.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Search class - https://developer.zendesk.com/rest_api/docs/support/search
+  class Search
+    # Perform a search and list results (first 100)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param query [String] The query to use
+    # @param sort [String] The sorting method to use (defaults to revelance)
+    # @param order [String] The order to use (defaults to desc)
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Search.list(client, 'bob')
+    #   #=> [
+    #   #=>   {
+    #   #=>     "name":        "Bob McBob",
+    #   #=>     "created_at":  "2009-05-13T00:07:08Z",
+    #   #=>     "updated_at":  "2011-07-22T00:11:12Z",
+    #   #=>     "id":          211,
+    #   #=>     "result_type": "user"
+    #   #=>     "url":         "https://zendesk.com/api/v2/users/211.json"
+    #   #=>   },
+    #   #=>   {
+    #   #=>     "name":        "Bob's Company",
+    #   #=>     "created_at":  "2009-08-26T00:07:08Z",
+    #   #=>     "updated_at":  "2010-05-13T00:07:08Z",
+    #   #=>     "id":          122,
+    #   #=>     "result_type": "group"
+    #   #=>     "url":         "https://zendesk.com/api/v2/groups/122.json"
+    #   #=>   },
+    #   #=>   ...
+    #   #=> ]
+
+    def self.list(client, query, sort = '', order = 'desc')
+      return bad_search("invalid sort - #{sort}") unless sort_valid?(sort)
+      return bad_search("invalid order - #{order}") unless order_valid?(order)
+
+      sort_order = sort_order_string(sort, order)
+      client.request(:get, "search.json?query=#{query}#{sort_order}")['results']
+    end
+
+    # Determines if a given sort string is valid
+    #
+    # @param sort [String] The sort string to check
+    # @return [Boolean]
+    #
+    # @example
+    #   ZendeskSupportAPI::Search.sort_valid? 'updated_at'
+    #   #=> true
+    #   ZendeskSupportAPI::Search.sort_valid? 'ticket_type'
+    #   #=> true
+    #   ZendeskSupportAPI::Search.sort_valid? 'random'
+    #   #=> false
+
+    def self.sort_valid?(sort)
+      return true if sort.empty?
+
+      valid = %w[updated_at created_at priority status ticket_type]
+      valid.include? sort
+    end
+
+    # Determines if a given order string is valid
+    #
+    # @param order [String] The order string to check
+    # @return [Boolean]
+    #
+    # @example
+    #   ZendeskSupportAPI::Search.order_valid? 'asc'
+    #   #=> true
+    #   ZendeskSupportAPI::Search.order_valid? 'desc'
+    #   #=> true
+    #   ZendeskSupportAPI::Search.order_valid? 'random'
+    #   #=> false
+
+    def self.order_valid?(order)
+      valid = %w[asc desc]
+      valid.include? order
+    end
+
+    # Prints out an error message
+    #
+    # @param string [String] The error that occurred
+    # @return [String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Search.bad_search('invalid sort - name')
+    #   #=> "Search cannot be completed: invalid sort - name"
+
+    def self.bad_search(string)
+      "Search cannot be completed: #{string}"
+    end
+
+    # Determines the sort and order to use in the query
+    #
+    # @param sort [String] The sort string to use
+    # @param order [String] The order string to use
+    # @return [String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Search.sort_order_string('', 'asc')
+    #   #=> "&order_by=asc"
+    #   ZendeskSupportAPI::Search.sort_order_string('priority', 'desc')
+    #   #=> "&sort_by=priority"
+    #   ZendeskSupportAPI::Search.sort_order_string('updated_at', 'asc')
+    #   #=> "&sort_by=updated_at&order_by=asc"
+
+    def self.sort_order_string(sort, order)
+      sort = (sort.empty? ? '' : "&sort_by=#{sort}")
+      order = (order == 'desc' ? '' : '&order_by=asc')
+      "#{sort}#{order}"
+    end
+  end
+end

data/lib/zendesk_support_api/users.rb

@@ -85,41 +85,8 @@ module ZendeskSupportAPI
     #   #=>   "id"=>123,
     #   #=>   "url"=>"https://zendesk.com/api/users/123.json",
     #   #=>   "name"=>"Test User",
-    #   #=>   "email"=>"test@example.com",
-    #   #=>   "created_at"=>"2020-04-28T13:45:54Z",
-    #   #=>   "updated_at"=>"2020-04-28T13:45:54Z",
-    #   #=>   "time_zone"=>"Eastern Time (US & Canada)",
-    #   #=>   "iana_time_zone"=>"America/New_York",
-    #   #=>   "phone"=>nil,
-    #   #=>   "shared_phone_number"=>nil,
-    #   #=>   "photo"=>nil,
-    #   #=>   "locale_id"=>1,
-    #   #=>   "locale"=>"en-US",
-    #   #=>   "organization_id"=>nil,
-    #   #=>   "role"=>"end-user",
-    #   #=>   "verified"=>false,
-    #   #=>   "external_id"=>nil,
-    #   #=>   "tags"=>[],
-    #   #=>   "alias"=>nil,
-    #   #=>   "active"=>true,
-    #   #=>   "shared"=>false,
-    #   #=>   "shared_agent"=>false,
-    #   #=>   "last_login_at"=>nil,
-    #   #=>   "two_factor_auth_enabled"=>false,
-    #   #=>   "signature"=>nil,
-    #   #=>   "details"=>nil,
-    #   #=>   "notes"=>nil,
-    #   #=>   "role_type"=>nil,
-    #   #=>   "custom_role_id"=>nil,
-    #   #=>   "moderator"=>false,
-    #   #=>   "ticket_restriction"=>"requested",
-    #   #=>   "only_private_comments"=>false,
-    #   #=>   "restricted_agent"=>true,
-    #   #=>   "suspended"=>false,
-    #   #=>   "chat_only"=>false,
-    #   #=>   "default_group_id"=>nil,
-    #   #=>   "report_csv"=>false,
-    #   #=>   "organization"=>[]}
+    #   #=>   ...
+    #   #=> }
 
     def self.show(client, id)
       res = client.request(:get, "users/#{id}.json?#{included}")
@@ -133,8 +100,19 @@ module ZendeskSupportAPI
     # @return [Array]
     #
     # @example
-    #   ZendeskSupportAPI::Users.show_many(client, [123, 456, 789])
-    #   #=> [{user123},{user456},{user789}]
+    #   ZendeskSupportAPI::Users.show_many(client, [123, 456])
+    #   #=> [
+    #   #=>   {
+    #   #=>     "id": 123,
+    #   #=>     "name": "Johnny Appleseed",
+    #   #=>     ...
+    #   #=>   },
+    #   #=>   {
+    #   #=>     "id": 456,
+    #   #=>     "name": "Rupert Root",
+    #   #=>     ...
+    #   #=>   }
+    #   #=> ]
 
     def self.show_many(client, ids)
       ids = ids.join(',')
@@ -162,11 +140,19 @@ module ZendeskSupportAPI
     # @return [Hash|String] Either the user details or the error
     #
     # @example
-    #   ZendeskSupportAPI::User.create(client, user)
-    #   #=> {user}
+    #   user = {name: 'Roger Wilco', email: 'rw@example.com'}
+    #   ZendeskSupportAPI::Users.create(client, user)
+    #   #=> {
+    #   #=>   "user": {
+    #   #=>     "id":   9873843,
+    #   #=>     "name": "Roger Wilco",
+    #   #=>     "email": "rw@example.com"
+    #   #=>     ...
+    #   #=>   }
+    #   #=> }
     #   ZendeskSupportAPI::User.create(client, user)
     #   #=> Creation failed: => "Creation failed: {\"email\"=>[{\"description\"
-    #   #=> =>\"Email: test@example.com is already being used by another user\",
+    #   #=> =>\"Email: rw@example.com is already being used by another user\",
     #   #=> \"error\"=>\"DuplicateValue\"}]}"
 
     def self.create(client, user)
@@ -180,7 +166,7 @@ module ZendeskSupportAPI
     #
     # @param client [ZendeskSupportAPI::Client] The client instance to use
     # @param users [Array] The users to create
-    # @return [ZendeskSupportAPI::Client.handle_job] Either the user details or the error
+    # @return [ZendeskSupportAPI::Client.handle_job]
 
     def self.create_many(client, users)
       res = client.request(:post, 'users/create_many.json', users: users)
@@ -195,7 +181,14 @@ module ZendeskSupportAPI
     #
     # @example
     #   ZendeskSupportAPI::User.create_or_update(client, user)
-    #   #=> {user}
+    #   #=> {
+    #   #=>   "user": {
+    #   #=>     "id":   9873843,
+    #   #=>     "name": "Roger Wilco",
+    #   #=>     "email": "rw@example.com"
+    #   #=>     ...
+    #   #=>   }
+    #   #=> }
 
     def self.create_or_update(client, user)
       res = client.request(:post, 'users/create_or_update.json', user: user)
@@ -208,7 +201,7 @@ module ZendeskSupportAPI
     #
     # @param client [ZendeskSupportAPI::Client] The client instance to use
     # @param users [Array] The users to create/update
-    # @return [ZendeskSupportAPI::Client.handle_job] Either the user details or the error
+    # @return [ZendeskSupportAPI::Client.handle_job]
 
     def self.create_or_update_many(client, users)
       res = client.request(:post,
@@ -239,7 +232,7 @@ module ZendeskSupportAPI
     #
     # @param client [ZendeskSupportAPI::Client] The client instance to use
     # @param users [Array] The users to update
-    # @return [ZendeskSupportAPI::Client.handle_job] Either the user details or the error
+    # @return [ZendeskSupportAPI::Client.handle_job]
 
     def self.update_many(client, users)
       res = client.request(:put, 'users/update_many.json', users: users)
@@ -269,7 +262,7 @@ module ZendeskSupportAPI
     #
     # @param client [ZendeskSupportAPI::Client] The client instance to use
     # @param ids [Array] The array of User IDs to delete
-    # @return [ZendeskSupportAPI::Client.handle_job] Either the user details or the error
+    # @return [ZendeskSupportAPI::Client.handle_job]
 
     def self.delete_many(client, ids)
       ids = ids.join(',')

data/lib/zendesk_support_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_support_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Colyer
@@ -54,6 +54,7 @@ files:
 - lib/zendesk_support_api.rb
 - lib/zendesk_support_api/client.rb
 - lib/zendesk_support_api/jobs.rb
+- lib/zendesk_support_api/search.rb
 - lib/zendesk_support_api/users.rb
 - lib/zendesk_support_api/version.rb
 - zendesk_support_api.gemspec