zendesk_support_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35ce4e3e27845ca77e9d5436ce5cc053f0430a74ca9765ec708425ce19549f18
+  data.tar.gz: b0ac9059cbd6aa2ee599d91025d43f89e1b687dbb3f982ab1f32f7ec41f8105a
+SHA512:
+  metadata.gz: 753387da38749fd018d1c70370ff0f48112b5b287b91339f59f042e9db8c2bd9106b4c481a3ae6d450d858ff3b07db2cc307c26953991fb9b25890ecaeb190b8
+  data.tar.gz: fdad54556055bc06e87c0a9bb5bcc62fbbcc73891ba26ad0b9716528cad3cfb754c7e3f6543be14af788137c292a7c7b7513836a033f8cfcab2d5290fd422e2d

data/.gitlab-ci.yml

@@ -0,0 +1,13 @@
+image: ruby:2.6.1-alpine
+
+pages:
+  script:
+  - gem install yard
+  - yard doc
+  - rm -rf public
+  - mv doc public
+  artifacts:
+    paths:
+    - public
+  only:
+  - master

data/.yardoc/checksums

@@ -0,0 +1,5 @@
+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

data/README.md

@@ -0,0 +1,39 @@
+# ZendeskSupportAPI
+
+
+## Documentation
+
+Documentation (generated via yard) can be found [here](https://reyloc.gitlab.io/zendesk_support_api/)
+
+## Installation
+
+The gem can be installed either via rubygems or bundler:
+
+### Rubygems
+
+```bash
+gem install zendesk_support_api
+```
+
+### Bundler
+
+```ruby
+gem "zendesk_support_api"
+```
+
+The current requirements for the gem are:
+
+* 'faraday', '~>1.0.0'
+* 'oj', '~>3.10.6'
+
+## Configuration
+
+Configuration is done through the creation of a `ZendeskSupportAPI::Client`
+instance:
+
+```ruby
+require 'zendesk_support_api'
+
+client = ZendeskSupportAPI::Client.new('user@example.com', '123abc', 'https://zendesk.com/api/v2')
+```
+

data/lib/zendesk_support_api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'oj'
+
+# ZendeskSupportAPI - https://developer.zendesk.com/rest_api/docs/support/introduction
+module ZendeskSupportAPI
+  require 'zendesk_support_api/client'
+  require 'zendesk_support_api/version'
+end

data/lib/zendesk_support_api/client.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+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/users'
+
+    # Create a new instance of Client
+    #
+    # @param user [String] - The API username to use
+    # @param token [String] - The API token to use
+    # @param url [String] - The API URL to use
+    #
+    # @example
+    #   ZendeskSupportAPI::Client.new('user', '123', 'zendesk.com/api')
+    #   #=> #<ZendeskSupportAPI::Client:0x00007f88779cb330 @user="user",
+    #   #=>    @token="123", @url="zendesk.com/api">
+    def initialize(user, token, url)
+      @user = user
+      @token = token
+      @url = url
+    end
+
+    # Make a request to the Zendesk Support API
+    #
+    # @param http_method [Symbol] The HTTP method to utilize
+    # @param endpoint [String] The endpoint to hit
+    # @param params [Hash] Parameters for the request
+    # @return [Hash]
+    #
+    # @example
+    #   client = ZendeskSupportAPI::Client.new('user', '123', 'zendesk.com/api')
+    #   client.response(:get, 'users.json')
+    #   #=> {users:[{user1},{user2}...{user100}]}
+
+    def request(http_method, endpoint, params = {})
+      response = client.public_send(http_method, endpoint, params)
+      Oj.load(response.body)
+    end
+
+    # Outputs a spinner symbol
+    #
+    # @param string [String] The string to output at the beginning
+    # @param num [Integer] The index of the iteration
+    # @return [String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Client.spinner('users', 1) #=> Grabbing users... \
+    #   ZendeskSupportAPI::Client.spinner('groups', 3) #=> /
+
+    def spinner(string, num)
+      print "Grabbing #{string}... " if num.to_i == 1
+      symbols = ['-', '\\', '|', '/']
+      print symbols[num.to_i % 4]
+      print "\b"
+    end
+
+    # Handles responses that create jobs
+    #
+    # @param job [Hash] - The output from a request that created a job
+    # @return [Hash]
+
+    def handle_job(job)
+      print 'Checking job'
+      while job['job_status']['status'] != 'completed'
+        print '.'
+        job = ZendeskSupportAPI::Jobs.show(self, job['job_status']['id'])
+      end
+      puts 'completed'
+      job['job_status']['results']
+    end
+
+    private
+
+    # Creates a new Faraday instance
+    #
+    # @return [ZendeskSupportAPI::Client]
+
+    def client
+      @client ||= Faraday.new(@url) do |c|
+        c.request :url_encoded
+        c.adapter Faraday.default_adapter
+        c.basic_auth "#{@user}/token", @token
+      end
+    end
+  end
+end

data/lib/zendesk_support_api/jobs.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Jobs class - https://developer.zendesk.com/rest_api/docs/support/job_statuses
+  class Jobs
+    # Make a request to show the job status
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance
+    # @param id [String] The id of the job to check
+    # @return [Hash]
+    #
+    # @example
+    #   client = ZendeskSupportAPI::Client.new('user', '123', 'zendesk.com/api')
+    #   ZendeskSupportAPI::Jobs.show(client, 'abc123')
+    #   #=> {
+    #   #=>   "job_status"=> {
+    #   #=>     "id"=>"abc123",
+    #   #=>     "url"=>"abc123.json",
+    #   #=>     "total"=>2,
+    #   #=>     "progress"=>2,
+    #   #=>     "status"=>"completed",
+    #   #=>     "message"=>"Completed at 2020-04-29 13:26:40 +0000",
+    #   #=>     "results"=> [
+    #   #=>       {
+    #   #=>         "id"=>369731992959,
+    #   #=>         "status"=>"Updated",
+    #   #=>         "email"=>"test@example.com"
+    #   #=>       },
+    #   #=>       {
+    #   #=>         "id"=>369728778639,
+    #   #=>         "status"=>"Updated",
+    #   #=>         "email"=>"test2@example.com"
+    #   #=>       }
+    #   #=>     ]
+    #   #=>   }
+    #   #=> }
+
+    def self.show(client, id)
+      client.request(:get, "job_statuses/#{id}.json")
+    end
+  end
+end

data/lib/zendesk_support_api/users.rb

@@ -0,0 +1,297 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Users class - https://developer.zendesk.com/rest_api/docs/support/users
+  class Users
+    # Function to return a string that side-loads organizations
+    #
+    # @return [String]
+
+    def self.included
+      'include=organizations'
+    end
+
+    # Maps users into user_objects
+    #
+    # @param users [Array] The Array of users to map
+    # @param orgs [Array] The Array of orgs to use in mapping
+    # @return [Hash]
+
+    def self.user_map(users, orgs)
+      users.map { |u| user_object(u, orgs) }
+    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)
+    #   #=> "users.json?include=organizations&page=56
+
+    def self.next_page(res)
+      (res['next_page'].nil? ? nil : res['next_page'].split('/').last)
+    end
+
+    # Lists out users (first 100)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.list(client)
+    #   #=> {users:[{user1},{user2}...{user100}]}
+
+    def self.list(client)
+      res = client.request(:get, "users.json?#{included}")
+      res['users'].map { |u| user_object(u, res['organizations']) }
+      res['users']
+    end
+
+    # Lists out all users (paginates over every page)
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.all(client)
+    #   #=> Grabbing users... / ...done
+    #   #=> {users:[{user1},{user2}...{user201520}]}
+
+    def self.all(client)
+      users = []
+      page = "users.json?#{included}&page=1"
+      until page.nil?
+        res = client.request(:get, page)
+        client.spinner("users (total: #{res['count']})", page.split('=').last)
+        users += user_map(res['users'], res['organizations'])
+        page = next_page(res)
+      end
+      puts ' ...done'
+      users
+    end
+
+    # Grabs a specific user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param id [Integer] The User's ID to use
+    # @return [Hash]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.show(client, 123)
+    #   #=> {
+    #   #=>   "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}")
+      user_object(res['user'], res['organizations'])
+    end
+
+    # Shows many users
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param ids [Array] An array of User IDs to use
+    # @return [Array]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.show_many(client, [123, 456, 789])
+    #   #=> [{user123},{user456},{user789}]
+
+    def self.show_many(client, ids)
+      ids = ids.join(',')
+      res = client.request(:get, "users/show_many.json?#{included}&ids=#{ids}")
+      res['users'].map { |u| user_object(u, res['organizations']) }
+      res['users']
+    end
+
+    # Creates a user hash (for mapping the org into the user Hash)
+    #
+    # @param user [Hash] The user details to use
+    # @param orgs [Array] The Array of orgs to use
+    # @return [Hash]
+
+    def self.user_object(user, orgs)
+      oid = 'organization_id'
+      user['organization'] = orgs.select { |o| o['id'] == user[oid] }
+      user
+    end
+
+    # Creates a user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param user [Hash] The user to create
+    # @return [Hash|String] Either the user details or the error
+    #
+    # @example
+    #   ZendeskSupportAPI::User.create(client, user)
+    #   #=> {user}
+    #   ZendeskSupportAPI::User.create(client, user)
+    #   #=> Creation failed: => "Creation failed: {\"email\"=>[{\"description\"
+    #   #=> =>\"Email: test@example.com is already being used by another user\",
+    #   #=> \"error\"=>\"DuplicateValue\"}]}"
+
+    def self.create(client, user)
+      res = client.request(:post, 'users.json', user: user)
+      return "Creation failed: #{res['details']}" if res['error']
+
+      res
+    end
+
+    # Creates many users
+    #
+    # @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
+
+    def self.create_many(client, users)
+      res = client.request(:post, 'users/create_many.json', users: users)
+      client.handle_job(res)
+    end
+
+    # Creates or updates a user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param user [Hash] The user to create/update
+    # @return [Hash|String] Either the user details or the error
+    #
+    # @example
+    #   ZendeskSupportAPI::User.create_or_update(client, user)
+    #   #=> {user}
+
+    def self.create_or_update(client, user)
+      res = client.request(:post, 'users/create_or_update.json', user: user)
+      return "Create/Update failed: #{res['description']}" if res['error']
+
+      res
+    end
+
+    # Creates or updates many users
+    #
+    # @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
+
+    def self.create_or_update_many(client, users)
+      res = client.request(:post,
+                           'users/create_or_update_many.json',
+                           users: users)
+      client.handle_job(res)
+    end
+
+    # Updates a user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param uid [Integer] The User's ID
+    # @param user [Hash] The user details to update
+    # @return [Hash|String] Either the user details or the error
+    #
+    # @example
+    #   ZendeskSupportAPI::User.update(client, 123, user)
+    #   #=> {user}
+
+    def self.update(client, uid, user)
+      res = client.request(:put, "users/#{uid}.json", user: user)
+      return "Update of #{uid} failed: #{res['error']}" if res['error']
+
+      res
+    end
+
+    # Updates many users
+    #
+    # @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
+
+    def self.update_many(client, users)
+      res = client.request(:put, 'users/update_many.json', users: users)
+      client.handle_job(res)
+    end
+
+    # Deletes a user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param uid [Integer] The User ID to delete
+    # @return [String]
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.delete(client, 123)
+    #   #=> User 123 has been deleted
+    #   ZendeskSupportAPI::Users.delete(client, 123)
+    #   #=> "Deletion of 123 failed: RecordNotFound"
+
+    def self.delete(client, uid)
+      res = client.request(:delete, "users/#{uid}.json")
+      return "Deletion of #{uid} failed: #{res['error']}" if res['error']
+
+      "User #{uid} has been deleted"
+    end
+
+    # Deletes many users
+    #
+    # @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
+
+    def self.delete_many(client, ids)
+      ids = ids.join(',')
+      res = client.request(:delete, "users/destroy_many.json?ids=#{ids}")
+      client.handle_job(res)
+    end
+
+    # Suspends a user
+    #
+    # @param client [ZendeskSupportAPI::Client] The client instance to use
+    # @param id [Integer] The User ID to suspend
+    # @return [String] Either a success message or an error
+    #
+    # @example
+    #   ZendeskSupportAPI::Users.suspend(client, 123)
+    #   #=> User 123 is suspended
+
+    def self.suspend(client, id)
+      res = client.request(:put, "users/#{id}.json", user: { suspended: true })
+      return "Suspension of #{id} failed: #{res['error']}" if res['error']
+
+      "User #{id} suspended" if res['user']['suspended']
+    end
+  end
+end

data/lib/zendesk_support_api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ZendeskSupportAPI
+  # Outputs the gem version
+
+  VERSION = '0.1.0'
+end

data/zendesk_support_api.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zendesk_support_api/version'
+
+Gem::Specification.new do |s|
+  s.name = 'zendesk_support_api'
+  s.version = ZendeskSupportAPI::VERSION
+  s.date = '2020-04-28'
+  s.summary = 'Zendesk Support API wrapper gem'
+  s.description = 'TBD'
+  s.authors = ['Jason Colyer']
+  s.email = 'jcolyer2007@gmail.com'
+  s.homepage = 'https://gitlab.com/reyloc/zendesk_support_api'
+  s.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r(^(test|spec|features)/)) }
+  end
+  # s.homepage = 'TBD'
+  s.license = 'MIT'
+  s.add_dependency 'faraday', '~>1.0.0'
+  s.add_dependency 'oj', '~>3.10.6'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: zendesk_support_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Colyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.6
+description: TBD
+email: jcolyer2007@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitlab-ci.yml"
+- ".yardoc/checksums"
+- ".yardoc/complete"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
+- README.md
+- lib/zendesk_support_api.rb
+- lib/zendesk_support_api/client.rb
+- lib/zendesk_support_api/jobs.rb
+- lib/zendesk_support_api/users.rb
+- lib/zendesk_support_api/version.rb
+- zendesk_support_api.gemspec
+homepage: https://gitlab.com/reyloc/zendesk_support_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Zendesk Support API wrapper gem
+test_files: []