CiscoWebex 0.0.4

data/lib/REST/Rest.rb

@@ -0,0 +1,213 @@
+require 'uri'
+require 'net/http'
+require 'json'
+require 'ostruct'
+
+module CiscoWebex
+	class Rest
+		BASE_URL = "https://webexapis.com"
+		
+		def initialize()
+			puts "Initializing Webex::Teams::Rest not required..."
+		end
+
+		# find next request for paging through GET requests
+	    def self.find_next_page(headers)
+	        if headers.has_key?('link')
+				uri = URI(headers['link'].split(";")[0].tr("<>", ""))
+				https = Net::HTTP.new(uri.host, uri.port)
+				https.use_ssl = true
+				request = Net::HTTP::Get.new(uri)
+				request["Authorization"] = "Bearer #{@auth_token}"
+				request["User-Agent"] = "Webex Rudy Library"
+
+				return [ https, request ]
+	        else
+	            return false
+	        end
+	    end
+
+		# format params for passing as needed json/urlencoded
+		def self.parse_params(params, return_format="json")
+			return params if ( return_format == "json" && params.class == String && JSON.parse(params) ) # if already json then just send back
+
+			if params.class == OpenStruct
+				params = params.to_h
+			end
+
+			params = params.delete_if { |key, value| value.to_s.strip == '' } # delete any unused keys
+
+			case return_format
+			when "json"
+				params = params.to_json
+
+			when "www-encoded"
+				params = URI.encode_www_form(params)
+
+			end
+
+			return params
+		end
+
+		def self.send_rest(rest, request, limit=100)
+			# loop adjusts for throttling if needed
+			results = []
+			while true
+				response = rest.request(request)
+				case response.code
+				when "200"
+					# if REST success then parse body to JSON
+					response, headers = [ JSON.parse(response.body), response.each_header.to_h ]
+					if response.has_key?("items") && response['items'].length() > 0
+						results.concat(response['items'])
+
+						next_page = CiscoWebex::Rest.find_next_page(headers)
+						if next_page
+							rest, request = next_page
+						else
+							return results # return array of hashes
+						end
+
+					else
+						return response
+					end
+
+				when "429"
+					# sleep for throttling time
+					STDERR.puts "\tThrottled CiscoWebex::Rest(): #{response.each_header.to_h['Retry-After'] + 1}sec..."
+					sleep(response.each_header.to_h['Retry-After'] + 1)
+
+				else
+					STDERR.puts "Error: CiscoWebex::Rest(): #{response} - #{response.body}"
+					return false
+				end
+			end
+		end
+
+		# basid REST GET to Webex teams
+		def self.get(auth_token, uri, params=nil, limit=100)
+			@auth_token = auth_token
+			if params.class == String
+				uri = "#{uri}/#{params}"
+			elsif params.to_h.has_key?("id")
+				uri = "#{uri}/#{params.to_h['id']}"
+			end
+			# set REST client headers, body etc
+			uri = URI("#{BASE_URL}#{uri}")
+			uri.query = parse_params(params, "www-encoded") if (params.class == Hash || params.class == OpenStruct) # encode and set params if required
+			https = Net::HTTP.new(uri.host, uri.port)
+			https.use_ssl = true
+			request = Net::HTTP::Get.new(uri)
+			request["Authorization"] = "Bearer #{@auth_token}"
+			request["User-Agent"] = "Webex Rudy Library"
+
+			return send_rest(https, request, limit) # send REST call 
+		end
+
+		# basid REST GET to Webex teams
+		def self.head(auth_token, uri, params=nil)
+			# set REST client headers, body etc
+			if params.class == String
+				uri = "#{uri}/#{params}"
+			elsif params.to_h.has_key?("id")
+				uri = "#{uri}/#{params.to_h['id']}"
+			end
+
+			uri = URI("#{BASE_URL}#{uri}")
+			uri.query = parse_params(params, "www-encoded") if params # encode and set params if required
+			https = Net::HTTP.new(uri.host, uri.port)
+			https.use_ssl = true
+			request = Net::HTTP::Head.new(uri)
+			request["Authorization"] = "Bearer #{auth_token}"
+			request["User-Agent"] = "Webex Rudy Library"
+
+			return send_rest(https, request) # send REST call
+		end
+
+		# basid REST DELETE to Webex teams
+		def self.delete(auth_token, uri, params=nil)
+			# set REST client headers, body etc
+			if params.class == String
+				uri = "#{uri}/#{params}"
+			elsif params.to_h.has_key?("id")
+				uri = "#{uri}/#{params.to_h['id']}"
+			end
+
+			uri = URI("#{BASE_URL}#{uri}")
+			uri.query = parse_params(params, "www-encoded") if params # encode and set params if required
+			https = Net::HTTP.new(uri.host, uri.port)
+			https.use_ssl = true
+			request = Net::HTTP::Delete.new(uri)
+			request["Authorization"] = "Bearer #{auth_token}"
+			request["User-Agent"] = "Webex Rudy Library"
+
+			return send_rest(https, request) # send REST call
+		end
+
+		# basic REST POST for Webex
+		def self.post(auth_token, uri, params)
+			if params.class != Hash || params.lenth == 0
+				STDERR.puts "CiscoWebex::Rest.post(): Must supply `params` as hash for post"
+				return False
+			end
+			# build REST client/headers/body etc
+			uri = URI("#{BASE_URL}#{uri}")
+			https = Net::HTTP.new(uri.host, uri.port)
+			https.use_ssl = true
+			request = Net::HTTP::Post.new(uri)
+			request["Authorization"] = "Bearer #{auth_token}"
+			request["Content-Type"] = "application/json"
+			request["Accept"] = "*/*"
+			request["User-Agent"] = "Webex Rudy Library"
+			request.body = parse_params(params) # format params as json body
+
+			return send_rest(https, request) # send REST call
+		end
+
+		# basic REST PUT for Webex
+		def self.put(auth_token, uri, params)
+			if params.class != Hash || params.lenth == 0
+				STDERR.puts "CiscoWebex::Rest.put(): Must supply `params` as hash for update"
+				return False
+			elsif params.to_h.has_key?("id")
+				uri = "#{uri}/#{params['id']}"
+			end
+
+			uri = URI("#{BASE_URL}#{uri}")
+			https = Net::HTTP.new(uri.host, uri.port)
+			https.use_ssl = true
+			request = Net::HTTP::Put.new(uri)
+			request["Authorization"] = "Bearer #{auth_token}"
+			request["Content-Type"] = "application/json"
+			request["Accept"] = "*/*"
+			request["User-Agent"] = "Webex Rudy Library"
+			request.body = parse_params(params) # format params as json body
+
+			return send_rest(https, request) # send REST call
+		end
+
+		# basic REST PUT for Webex
+		def self.patch(auth_token, uri, params)
+			# build REST client/headers/body etc
+			if params.class != Hash || params.lenth == 0
+				STDERR.puts "CiscoWevex::Rest.patch(): Must supply `params` as hash for update"
+				return False
+			elsif params.to_h.has_key?("id")
+				uri = "#{uri}/#{params['id']}"
+			end
+
+			uri = URI("#{BASE_URL}#{uri}")
+			https = Net::HTTP.new(uri.host, uri.port)
+			https.use_ssl = true
+			request = Net::HTTP::Patch.new(uri)
+			request["Authorization"] = "Bearer #{auth_token}"
+			request["Content-Type"] = "application/json"
+			request["Accept"] = "*/*"
+			request["User-Agent"] = "Webex Rudy Library"
+			request.body = parse_params(params) # format params as json body
+
+			return send_rest(https, request) # send REST call
+		end
+
+	end	
+end

data/lib/REST/RestCC.rb

@@ -0,0 +1,242 @@
+require 'uri'
+require 'net/http'
+require 'json'
+require 'ostruct'
+
+module CiscoWebex
+	class RestCC
+		@BASE_URL = "https://api.wxcc-us1.cisco.com"
+		
+		def initialize()
+			puts "Initializing CiscoWebex::CC::Rest not required..."
+		end
+
+		# format params for passing as needed json/urlencoded
+		def self.parse_params(params, return_format="json")
+			return params if ( return_format == "json" && params.class == String && JSON.parse(params) ) # if already json then just send back
+
+			if params.class == OpenStruct
+				params = params.to_h
+			end
+
+			params = params.delete_if { |key, value| value.to_s.strip == '' } # delete any unused keys
+
+			case return_format
+			when "json"
+				params = params.to_json
+
+			when "www-encoded"
+				params = URI.encode_www_form(params)
+
+			end
+
+			return params
+		end
+
+		def self.send_rest(rest, request, limit, format="array")
+			# loop adjusts for throttling if needed
+			results = []
+			while true
+				response = rest.request(request)
+				headers, response_code = [ response.each_header.to_h, response.code ]
+				case response_code
+					when "200"
+						# if REST success then parse body to JSON
+						response = JSON.parse(response.body)
+						return response if format == "array"  # If not an array then convert hash to object and return
+						return OpenStruct.new(response) if format == "object"  # If not an array then convert hash to object and return
+
+					when "429"
+						# sleep for throttling time
+						puts "Throttled.  Waiting #{response.each_header.to_h['retry-after']}..."
+						sleep(response.each_header.to_h['retry-after'].to_i + 1)
+						puts "\t... and go."
+
+					else
+						STDERR.puts "CC REST ERROR: " + response.to_s + response.body.to_s
+						return false
+				end
+			end
+			return OpenStruct.new(response) if format == "object"  
+			return response if format == "array"  
+		end
+
+		# basid REST GET to Webex teams
+		def self.get(auth_token, uri, params={}, limit=50000)
+			if params.class != Hash  # fix missing params
+				limit = params
+				params = {} 
+			end
+			if params.class == Hash && params.has_key?('orgId')
+				orig_id = params['orgId']
+			else
+				org_id = uri.split('/')[2]
+			end
+
+			result = { 'data'=> [], 'meta'=> {'orgId'=> org_id, 'library_added'=> true} }
+			if ( params.class == Hash and ! params.has_key?('page') ) # add page for looping
+				params['page'] = 0 
+			end
+			if ( params.class == Hash and ! params.has_key?('pageSize') ) # add page for looping
+				params['pageSize'] = 100 
+			end
+
+			# provide looping for longer requests
+			while true
+				# set REST client headers, body etc
+				api_uri = "#{uri}?#{parse_params(params, "www-encoded") if (params.class == Hash || params.class == OpenStruct)}"
+				url = URI(@BASE_URL)
+				https = Net::HTTP.new(url.host, url.port)
+				https.use_ssl = true
+				request = Net::HTTP::Get.new(api_uri)
+				request["Authorization"] = "Bearer #{auth_token}"
+				request["User-Agent"] = "Webex Rudy Library"
+
+				rest_response = send_rest(https, request, limit, "array") # send REST call
+				if rest_response == false
+					return false
+
+				else
+					# parse return  based on v1/v2 for set common format of v1
+					if rest_response.class == Hash && rest_response.has_key?('data')
+						# try and check of we need to get the next page.  
+						# if response length is 0 then no need to pull again
+						# if response length is less that the requested page size then no need
+						# Paging not supported on all APIs so if response is larger than the requested page size then concider it done
+						if rest_response['data'].length() == 0 || rest_response['data'].length() < params['pageSize']|| rest_response['data'].length() > params['pageSize']
+							result['data'] = rest_response['data'][0..(limit - 1)]
+							result['meta'] = rest_response['meta']
+							return result
+						end
+						result['data'].concat(rest_response['data'])
+						result['meta'] = rest_response['meta']
+
+					elsif rest_response.class == Array
+						# try and check of we need to get the next page.  
+						# if response length is 0 then no need to pull again
+						# if response length is less that the requested page size then no need
+						# Paging not supported on all APIs so if response is larger than the requested page size then concider it done
+						if rest_response.length() == 0 || rest_response.length() < params['pageSize'] || rest_response.length() > params['pageSize']
+							result['data'] = rest_response[0..(limit - 1)]
+							return result
+						end
+						result['data'].concat(rest_response)
+
+					else
+						return result
+					end	
+
+					# check if limit is met and return if so
+					if result['data'].length() >= limit 
+						result['data'] = result['data'][0..(limit - 1)]
+						return result
+					end
+					
+				params['page'] += 1
+				end
+			end
+		end
+
+		# basid REST GET to Webex teams
+		def self.head(auth_token, uri, params=nil)
+			# set REST client headers, body etc
+			if params.class == String
+				uri = "#{uri}/#{params}"
+			elsif params.has_key?("id")
+				uri = "#{uri}/#{params['id']}"
+				params.delete('id')
+			end
+
+			uri = URI("#{@BASE_URL}#{uri}")
+			uri.query = parse_params(params, "www-encoded") if params # encode and set params if required
+			https = Net::HTTP.new(uri.host, uri.port)
+			https.use_ssl = true
+			request = Net::HTTP::Head.new(uri)
+			request["Authorization"] = "Bearer #{auth_token}"
+			request["User-Agent"] = "Webex Rudy Library"
+
+			return send_rest(https, request) # send REST call
+		end
+
+		# basid REST DELETE to Webex teams
+		def self.delete(auth_token, uri, params=nil)
+			# set REST client headers, body etc
+			uri = URI("#{@BASE_URL}#{uri}")
+			uri.query = parse_params(params, "www-encoded") if params # encode and set params if required
+			https = Net::HTTP.new(uri.host, uri.port)
+			https.use_ssl = true
+			request = Net::HTTP::Delete.new(uri)
+			request["Authorization"] = "Bearer #{auth_token}"
+			request["User-Agent"] = "Webex Rudy Library"
+
+			return send_rest(https, request) # send REST call
+		end
+
+		# basic REST POST for Webex
+		def self.post(auth_token, uri, params)
+			# build REST client/headers/body etc
+			if params.class != Hash || params.lenth == 0
+				STDERR.puts "CiscoWebex::RestCC.put(): Must supply `params` as hash for update"
+				return False
+			elsif params.to_h.has_key?("id")
+				uri = "#{uri}/#{params['id']}"
+			end
+			uri = URI("#{@BASE_URL}#{uri}")
+			https = Net::HTTP.new(uri.host, uri.port)
+			https.use_ssl = true
+			request = Net::HTTP::Post.new(uri)
+			request["Authorization"] = "Bearer #{auth_token}"
+			request["Content-Type"] = "application/json"
+			request["Accept"] = "*/*"
+			request["User-Agent"] = "Webex Rudy Library"
+			request.body = parse_params(params) # format params as json body
+
+			return send_rest(https, request) # send REST call
+		end
+
+		# basic REST PUT for Webex
+		def self.put(auth_token, uri, params)
+			# build REST client/headers/body etc
+			if params.class != Hash || params.lenth == 0
+				STDERR.puts "CiscoWebex::RestCC.put(): Must supply `params` as hash for update"
+				return False
+			elsif params.to_h.has_key?("id")
+				uri = "#{uri}/#{params['id']}"
+			end
+			uri = URI("#{@BASE_URL}#{uri}")
+			https = Net::HTTP.new(uri.host, uri.port)
+			https.use_ssl = true
+			request = Net::HTTP::Put.new(uri)
+			request["Authorization"] = "Bearer #{auth_token}"
+			request["Content-Type"] = "application/json"
+			request["Accept"] = "*/*"
+			request["User-Agent"] = "Webex Rudy Library"
+			request.body = parse_params(params) # format params as json body
+
+			return send_rest(https, request) # send REST call
+		end
+
+		# basic REST PUT for Webex
+		def self.patch(auth_token, uri, params)
+			# build REST client/headers/body etc
+			if params.class != Hash || params.lenth == 0
+				STDERR.puts "CiscoWebex::RestCC.patch(): Must supply `params` as hash for update"
+				return False
+			elsif params.to_h.has_key?("id")
+				uri = "#{uri}/#{params['id']}"
+			end
+			uri = URI("#{@BASE_URL}#{uri}")
+			https = Net::HTTP.new(uri.host, uri.port)
+			https.use_ssl = true
+			request = Net::HTTP::Patch.new(uri)
+			request["Authorization"] = "Bearer #{auth_token}"
+			request["Content-Type"] = "application/json"
+			request["Accept"] = "*/*"
+			request["User-Agent"] = "Webex Rudy Library"
+			request.body = parse_params(params) # format params as json body
+
+			return send_rest(https, request) # send REST call
+		end
+
+	end	
+end

data/lib/Toolbox/Toolbox.rb

@@ -0,0 +1,78 @@
+require 'date'
+require 'time'
+
+module CiscoWebex
+    class Toolbox
+        def self.search(list, params={})
+            if !list || list.class != Array || list.class != Hash || params == {}
+                STDERR.puts "CicoWebex::Toolbox.search(list, params={}): Data provided for search much be am Array of Hashes, `params` must have parameters to search on"
+                return false
+            end
+            results = []
+            for app in list
+                matches = 0
+                for pair in params.each()
+                    if app[pair[0]] == pair[1]
+                        matches += 1
+                    end
+                end
+                if matches == params.length()
+                    results.append(app)
+                end
+            end
+            return results
+        end
+
+        class WebexTime
+            def self.error()
+                STDERR.puts "Error CiscoWebex::Toolbox::WebexTime: Could not format/transform time from timestamp"
+                return false
+            end
+
+            def self.now()
+                return Time.now()
+            end
+
+            # converts possible time type to `Time` format for easier parsing
+            def self.consistent_timestamp(timestamp="now")
+                return timestamp if timestamp.class == Time
+                return Time.now() if timestamp.class == String && timestamp.downcase == "now"
+                return Time.parse(timestamp) if timestamp.class == String
+                return Time.at(timestamp) if timestamp.class == Integer
+                return Time.parse(timestamp.to_s) if timestamp.class == DateTime
+                return self.error()
+            end
+
+            # Format time based on default for Controlhub CC open for epoch
+            def self.format(timestamp, time_format="control_hub")
+                timestamp = self.consistent_timestamp(timestamp)
+
+                if time_format.downcase() == "cc" || time_format.downcase() =~ /contact.*/
+                    return timestamp.strftime("%s").to_i rescue self.error()
+
+                elsif time_format.downcase() == "epoch" || time_format.downcase() == "ms"  
+                    return timestamp.strftime("%s").to_i * 1000
+
+                else
+                    return timestamp.strftime("%Y-%m-%dT%H:%M:%S.000Z") rescue self.error()
+
+                end
+            end
+
+            # shift curret time by X seconds round if required
+            def self.shift(timestamp="now", shift_seconds=60, time_format="control_hub", round=0)
+                timestamp = self.consistent_timestamp(timestamp)
+                timestamp = self.consistent_timestamp(timestamp.to_i + shift_seconds)
+                timestamp = self.round(timestamp, round, time_format) if round.to_i > 0
+                return self.format(timestamp, time_format) rescue self.error()
+            end
+
+            # round time to nearest 15min default
+            def self.round(timestamp="now", interval=15, time_format="control_hub")
+                timestamp = self.consistent_timestamp(timestamp)
+                interval = interval.to_i
+                return self.format(Time.at((timestamp.to_i / (interval*60)).round * interval*60).to_i, time_format) rescue self.error()
+            end
+        end
+    end
+end

data/lib/bersion.rb

@@ -0,0 +1,3 @@
+module CiscoWebex
+  VERSION = '0.0.4'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: CiscoWebex
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Jon Snipes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-03-22 00:00:00.000000000 Z
+dependencies: []
+description: CiscoWebex API
+email: jsnipes@mcloverhound.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/Admin.rb
+- lib/Admin/Admin.rb
+- lib/Admin/AuditEvents.rb
+- lib/Admin/Authorizations.rb
+- lib/Admin/Licenses.rb
+- lib/Admin/Organizations.rb
+- lib/Admin/People.rb
+- lib/Admin/ResourceGroups.rb
+- lib/Admin/Roles.rb
+- lib/CC.rb
+- lib/CC/AddressBooks.rb
+- lib/CC/AgentProfiles.rb
+- lib/CC/Agents.rb
+- lib/CC/AuxiliaryCodes.rb
+- lib/CC/CC.rb
+- lib/CC/Captures.rb
+- lib/CC/DialPlans.rb
+- lib/CC/EntryPointMappings.rb
+- lib/CC/EntryPoints.rb
+- lib/CC/Journey.rb
+- lib/CC/Journey/Actions.rb
+- lib/CC/Journey/Aliases.rb
+- lib/CC/Journey/Events.rb
+- lib/CC/Journey/Identities.rb
+- lib/CC/Journey/Journey.rb
+- lib/CC/Journey/ProfileViews.rb
+- lib/CC/Journey/Report.rb
+- lib/CC/Journey/Reports.rb
+- lib/CC/Journey/Streams.rb
+- lib/CC/Journey/Views.rb
+- lib/CC/MultimediaProfiles.rb
+- lib/CC/OutboundANI.rb
+- lib/CC/Queues.rb
+- lib/CC/Sites.rb
+- lib/CC/SkillProfiles.rb
+- lib/CC/Skills.rb
+- lib/CC/Subscriptions.rb
+- lib/CC/Tasks.rb
+- lib/CC/Teams.rb
+- lib/CC/UserProfiles.rb
+- lib/CC/Users.rb
+- lib/Calling.rb
+- lib/Calling/CallControl.rb
+- lib/Calling/Calling.rb
+- lib/Calling/Calls.rb
+- lib/Calling/Locations.rb
+- lib/Calling/Voicemail.rb
+- lib/CiscoWebex.rb
+- lib/Devices.rb
+- lib/Devices/Configurations.rb
+- lib/Devices/Devices.rb
+- lib/Devices/Endpoints.rb
+- lib/Devices/Workspaces.rb
+- lib/Devices/Xapi.rb
+- lib/Meetings.rb
+- lib/Meetings/ControlStatus.rb
+- lib/Meetings/Invitees.rb
+- lib/Meetings/Meetings.rb
+- lib/Meetings/Participants.rb
+- lib/Meetings/Qualities.rb
+- lib/Meetings/Registrations.rb
+- lib/Meetings/SessionTypes.rb
+- lib/Meetings/Templates.rb
+- lib/Meetings/Transcripts.rb
+- lib/Meetings/WebexMeetings.rb
+- lib/Messaging.rb
+- lib/Messaging/Attachements.rb
+- lib/Messaging/Classifications.rb
+- lib/Messaging/Events.rb
+- lib/Messaging/Memberships.rb
+- lib/Messaging/Messages.rb
+- lib/Messaging/Messaging.rb
+- lib/Messaging/People.rb
+- lib/Messaging/Rooms.rb
+- lib/Messaging/Teams.rb
+- lib/Messaging/Webhooks.rb
+- lib/REST/Rest.rb
+- lib/REST/RestCC.rb
+- lib/Toolbox/Toolbox.rb
+- lib/bersion.rb
+homepage: https://rubygems.org/gems/CiscoWebex
+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.1
+signing_key: 
+specification_version: 4
+summary: CiscoWebex for Ruby
+test_files: []