five9 0.0.12 → 0.0.13

data/five9.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["dhahn@ctatechs.com"]
   gem.description   = %q{Rubygem integration with five9 API}
   gem.summary       = %q{Write a gem summary}
-  gem.homepage      = "https://github.com/CorporateTechnologyAdvantage/five9"
+  gem.homepage      = "https://github.com/CTA/five9"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/five9.rb

@@ -1,6 +1,6 @@
 require "five9/version"
 require "five9/base"
-require "five9/provision"
+require "five9/user_management"
 require "five9/statistics"
 require "five9/agent_stats.rb"
 require "five9/inbound_campaign_stats.rb"
@@ -8,5 +8,4 @@ require "five9/acd_status.rb"
 
 
 module Five9
-  # Your code goes here...
 end

data/lib/five9/acd_status.rb

@@ -1,17 +1,17 @@
 module Five9
-	class AcdStatus < Statistics
-		attr_accessor :stats
-		def initialize(username,password,timeout=300)
-			@stats = nil
-			super(username,password,timeout)
-		end
+  class AcdStatus < Statistics
+    attr_accessor :stats
+    def initialize(username,password,timeout=300)
+      @stats = nil
+      super(username,password,timeout)
+    end
 
-		def getStatistics(columns=[])
-			@stats = super("ACDStatus",columns)
-		end
+    def getStatistics(columns=[])
+      @stats = super("ACDStatus",columns)
+    end
 
-		def getStatisticsUpdate(long_polling_timeout=10000)
-			super("ACDStatus","Skill Name",long_polling_timeout)
-		end
-	end
-end
+    def getStatisticsUpdate(long_polling_timeout=10000)
+      super("ACDStatus","Skill Name",long_polling_timeout)
+    end
+  end
+end

data/lib/five9/agent_stats.rb

@@ -1,17 +1,17 @@
 module Five9
-	class AgentStats < Statistics
- 		attr_accessor :stats
-		def initialize(username,password,timeout=300)
-			@stats = nil
-			super(username,password,timeout)
-		end
+  class AgentStats < Statistics
+    attr_accessor :stats
+    def initialize(username,password,timeout=300)
+      @stats = nil
+      super(username,password,timeout)
+    end
 
-		def getStatistics(columns=[])
-			@stats = super("AgentStatistics",columns)
-		end
+    def getStatistics(columns=[])
+      @stats = super("AgentStatistics",columns)
+    end
 
-		def getStatisticsUpdate(long_polling_timeout=10000)
-			super("AgentStatistics","Username",long_polling_timeout)
-		end
-	end
-end
+    def getStatisticsUpdate(long_polling_timeout=10000)
+      super("AgentStatistics","Username",long_polling_timeout)
+    end
+  end
+end

data/lib/five9/base.rb

@@ -1,13 +1,13 @@
 require 'savon'
 module Five9
-	class Base
-		def initialize(username,password,given_wsdl,timeout=300)
+  class Base
+    def initialize(username,password,given_wsdl,timeout=300)
       #For some reason httpclient is not compatible with api.five9.com so we have to manually set this option
       HTTPI.adapter = :net_http
       @client = Savon.client do
-				wsdl "#{given_wsdl}#{username}"
+        wsdl "#{given_wsdl}#{username}"
         basic_auth [username, password]
-			end
-		end
-	end
-end
+      end
+    end
+  end
+end

data/lib/five9/inbound_campaign_stats.rb

@@ -1,17 +1,17 @@
 module Five9
-	class InboundCampaignStats < Statistics
-		attr_accessor :stats
-		def initialize(username,password,timeout=300)
-			@stats = nil
-			super(username,password,timeout)
-		end
+  class InboundCampaignStats < Statistics
+    attr_accessor :stats
+    def initialize(username,password,timeout=300)
+      @stats = nil
+      super(username,password,timeout)
+    end
 
-		def getStatistics(columns=[])
-			@stats = super("InboundCampaignStatistics",columns)
-		end
+    def getStatistics(columns=[])
+      @stats = super("InboundCampaignStatistics",columns)
+    end
 
-		def getStatisticsUpdate(long_polling_timeout=10000)
-			super("InboundCampaignStatistics","Campaign Name",long_polling_timeout)
-		end
-	end
-end
+    def getStatisticsUpdate(long_polling_timeout=10000)
+      super("InboundCampaignStatistics","Campaign Name",long_polling_timeout)
+    end
+  end
+end

data/lib/five9/statistics.rb

@@ -1,54 +1,50 @@
 module Five9
-	class Statistics < Base
-		def initialize(username,password,timeout=300)
-			super(username,password,"https://api.five9.com/wssupervisor/SupervisorWebService?wsdl&user=",timeout)
-			@last_working_timestamp = nil
-		end
+  class Statistics < Base
+    def initialize(username,password,timeout=300)
+      super(username,password,"https://api.five9.com/wssupervisor/SupervisorWebService?wsdl&user=",timeout)
+      @last_working_timestamp = nil
+    end
 
-		def setSessionParams(options)
-			@client.call(:set_session_parameters,  message: {viewSettings: {rollingPeriod: options[:rolling_period], shiftStart: options[:shift_start], statisticsRange: options[:statistics_range],timeZone: options[:time_zone]}})
-		end
+    def setSessionParams(options)
+      @client.call(:set_session_parameters,  message: {viewSettings: {rollingPeriod: options[:rolling_period], shiftStart: options[:shift_start], statisticsRange: options[:statistics_range],timeZone: options[:time_zone]}})
+    end
 
-		def getStatistics(statistic_type,columns=[])
-			stats = []
-			response =  @client.call(:get_statistics, message: {statisticType: statistic_type, columnNames: {values: { data: columns}}})
-			data = response.to_array
-			@last_working_timestamp = data[0][:get_statistics_response][:return][:timestamp]
-			headers = data[0][:get_statistics_response][:return][:columns][:values][:data]
-			data[0][:get_statistics_response][:return][:rows].each do |row|
-				stats.push Hash[headers.zip row[:values][:data]]
-			end
-			return stats
-		end
+    def getStatistics(statistic_type,columns=[])
+      stats = []
+      data =  @client.call(:get_statistics, message: {statisticType: statistic_type, columnNames: {values: { data: columns}}}).to_array
+      @last_working_timestamp = data[0][:get_statistics_response][:return][:timestamp]
+      headers = data[0][:get_statistics_response][:return][:columns][:values][:data]
+      data[0][:get_statistics_response][:return][:rows].each do |row|
+              stats.push Hash[headers.zip row[:values][:data]]
+      end
+      return stats
+    end
 
-		def getStatisticsUpdate(statistic_type, object_name,long_polling_timeout=10000)
-			begin
-				prev_timestamp = @last_working_timestamp
-				response = @client.call(:get_statistics_update, message: {statisticType: statistic_type, previousTimestamp: prev_timestamp, longPollingTimeout: long_polling_timeout})
-				data = response.to_array
-				raise TypeError, "No Updated Statistics" if data[0][:get_statistics_update_response][:return].nil?
-				prev_timestamp = data[0][:get_statistics_update_response][:return][:last_timestamp]
-				stats = data[0][:get_statistics_update_response][:return][:data_update]
-				@last_working_timestamp = prev_timestamp
-				updateStats(stats,object_name)
-			rescue TypeError => e
-				p e
-				p e.backtrace if !e.message.include?("No Updated Statistics")
-				return false
-			end
-			return stats
-		end
+    def getStatisticsUpdate(statistic_type, object_name,long_polling_timeout=10000)
+      begin
+        data = @client.call(:get_statistics_update, message: {statisticType: statistic_type, previousTimestamp: @last_working_timestamp, longPollingTimeout: long_polling_timeout}).to_array
+        raise TypeError, "No Updated Statistics" if data[0][:get_statistics_update_response][:return].nil?
+        stats = data[0][:get_statistics_update_response][:return][:data_update]
+        @last_working_timestamp = data[0][:get_statistics_update_response][:return][:last_timestamp]
+        updateStats(stats,object_name)
+      rescue TypeError => e
+        p e
+        p e.backtrace if !e.message.include?("No Updated Statistics")
+        return false
+      end
+      return stats
+    end
 
-		private
-			def updateStats(updated_stats,object_name)
-				if updated_stats.class == Hash
-					@stats.each {|stat| stat[updated_stats[:column_name]] = updated_stats[:column_value] if updated_stats[:object_name] == stat[object_name]}
-				elsif updated_stats.class == Array
-					updated_stats.each do |updated_stat|	
-						@stats.each {|stat| stat[updated_stat[:column_name]] = updated_stat[:column_value] if updated_stat[:object_name] == stat[object_name]}
-					end
-				end
-				updated_stats
-			end
-	end
+    private
+      def updateStats(updated_stats,object_name)
+        if updated_stats.class == Hash
+          @stats.each {|stat| stat[updated_stats[:column_name]] = updated_stats[:column_value] if updated_stats[:object_name] == stat[object_name]}
+        elsif updated_stats.class == Array
+          updated_stats.each do |updated_stat|	
+            @stats.each {|stat| stat[updated_stat[:column_name]] = updated_stat[:column_value] if updated_stat[:object_name] == stat[object_name]}
+          end
+        end
+        updated_stats
+      end
+  end
 end

data/lib/five9/user_management.rb

@@ -0,0 +1,128 @@
+module Five9
+  class UserManagement < Base
+    # This class is essentially a cut-paste of the User Management methods
+    # from the Five9 API. Arguments to the methods should be hashes of the
+    # data values required in the API, unless otherwise specified.
+
+    def initialize(adminuser, password)
+      # arguments should be strings
+      super(adminuser, password,
+      "https://api.five9.com/wsadmin/v2/AdminWebService?wsdl&user=")
+    end
+
+    def create_user(args = {})
+      # Use this method to create a user. 
+      # An exception is thrown if the user already exists, if the limit number of users is reached, or if user attributes are invalid.
+      begin
+        @client.call :create_user, message: args
+      rescue => error
+        puts error.to_s.inspect
+        return false
+      end
+    end
+
+    def delete_user(username)
+      # Use this method to delete the specified user. 
+      # An exception is thrown if the user does not exist.
+      # username is a string
+      begin
+        @client.call :delete_user, message: { user_name: username }
+      rescue => error
+        puts error.to_s.inspect
+        return false
+      end
+    end
+
+    def get_users_general_info(username_pattern = nil)
+      # Use this method to obtain general information about each user name that matches a pattern.
+        # username_pattern should be a regular expression.
+        # If omitted or equal to an empty string, all objects are returned.
+        # For example, a pattern may be the first characters of the user name.
+      begin
+        @client.call :get_users_general_info, message: { userNamePattern: username_pattern }
+      rescue => error
+        puts error.to_s.inspect
+        return false
+      end
+    end
+
+    def get_users_info(username_pattern = nil)
+      # Use this method to obtain information about roles and skills 
+      # in addition to general information for the user, 
+      # for each user name that matches a pattern.
+      # username_pattern should be a regular expression
+      begin
+        @client.call :get_users_info, message: { userNamePattern: username_pattern }      
+      rescue => error
+        puts error.to_s.inspect
+        return false
+      end
+    end
+
+    def modify_user(args = {})
+      # Use this method to modify user attributes
+      # args may include userGeneralInfo, rolesToSet, and rolesToRemove
+      begin
+        @client.call :modify_user, message: args
+      rescue => error
+        puts error.to_s.inspect
+        return false
+      end
+    end
+
+    def modify_user_canned_reports(args = {})
+      # Use this method to modify the list of canned reports associated with a specific user.
+      # args may incldue user, cannedReportsToAdd, and cannedReportsToRemove
+      begin
+        @client.call :modify_user_canned_reports, message: args
+      rescue => error
+        puts error.to_s.inspect
+        return false
+      end
+    end
+
+    def add_user_skill(user_skill)
+      # user_skill is a userSkill hash 
+      affect_user_skill(:user_skill_add, user_skill)
+      # begin
+      #   @client.call :userSkillAdd, message: { userSkill: user_skill }    
+      # rescue => error
+      #   puts error.to_s.inspect
+      #   return false
+      # end
+    end
+
+    def modify_user_skill(user_skill)
+      # user_skill is a userSkill hash 
+      affect_user_skill(:user_skill_modify, user_skill)
+      # begin
+      #   @client.call :userSkillModify, message: { userSkill: user_skill }
+      # rescue => error
+      #   puts error.to_s.inspect
+      #   return false
+      # end
+    end
+
+    def remove_user_skill(user_skill)
+      # user_skill is a userSkill hash 
+      affect_user_skill(:user_skill_remove, user_skill)
+      # begin
+      #   @client.call :userSkillRemove, message: { userSkill: user_skill }
+      # rescue => error
+      #   puts error.to_s.inspect
+      #   return false
+      # end
+    end
+
+    private
+
+      def affect_user_skill(affect, user_skill)
+        begin
+          @client.call affect, message: { userSkill: user_skill }
+        rescue => error
+          puts error.to_s.inspect
+          return false
+        end
+      end
+  end
+end

data/lib/five9/version.rb

@@ -1,3 +1,3 @@
 module Five9
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: five9
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -34,6 +34,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .DS_Store
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -45,10 +46,10 @@ files:
 - lib/five9/agent_stats.rb
 - lib/five9/base.rb
 - lib/five9/inbound_campaign_stats.rb
-- lib/five9/provision.rb
 - lib/five9/statistics.rb
+- lib/five9/user_management.rb
 - lib/five9/version.rb
-homepage: https://github.com/CorporateTechnologyAdvantage/five9
+homepage: https://github.com/CTA/five9
 licenses: []
 post_install_message: 
 rdoc_options: []

data/lib/five9/provision.rb

@@ -1,4 +0,0 @@
-module Five9
-	class Provision < Base
-	end
-end