five9 0.0.13 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjFjY2M4ZWE2YTBiMTU5YzFhYWFmMTQ4MDY4NTE3YTcyN2YyNzIzMw==
+  data.tar.gz: !binary |-
+    ZmE5ZGQ2ODc2ZmIwOGYyYmI2ZjI4MzVlMWIzMDRmOWFjOWZhYWY0NA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MmU0MmFlMzVlNmUyYWQxYjQxN2Q5YjU1ZjNmZDg1MDdkMDU4NzIyYjM0YWM4
+    ZmZkZDI0ZWFhZGI1MTcxN2Q3MDQ3MjgzYWU5ZDg2MDZiZDJiZWY4OGZjMzQ2
+    YWY2Y2M4YTUwNmI5MTk4ODBhOTU1NDUwMWI5NTg2YWYwZDYyMzI=
+  data.tar.gz: !binary |-
+    NTMzMzRhMzQwZTU0MDJiNDM2MDExZjMyOTdmOTg4MzRkNWI2MjczMjQ3ZDNk
+    OTc5NjljODFkNWE4OTExOGMyMmIwOWY3NDM3YzQzZmJiODY3YjA2NzRhMzkw
+    Y2U2YTE4MjQ1MmY1ZDQwMGMxYzNlNmZiMTA2M2MxY2EzZmQwOTI=

data/five9.gemspec

@@ -11,10 +11,11 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Rubygem integration with five9 API}
   gem.summary       = %q{Write a gem summary}
   gem.homepage      = "https://github.com/CTA/five9"
-
+  gem.license       = "MIT"
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   gem.add_dependency('savon', '~> 2.2.0')
+  gem.add_dependency('accessible_hash')
 end

data/lib/five9.rb

@@ -1,3 +1,4 @@
+require "accessible_hash"
 require "five9/version"
 require "five9/base"
 require "five9/user_management"
@@ -5,7 +6,9 @@ require "five9/statistics"
 require "five9/agent_stats.rb"
 require "five9/inbound_campaign_stats.rb"
 require "five9/acd_status.rb"
-
+require "five9/user_management.rb"
+require "five9/user.rb"
+require "five9/user_resources/skill_array.rb"
 
 module Five9
 end

data/lib/five9/base.rb

@@ -7,7 +7,8 @@ module Five9
       @client = Savon.client do
         wsdl "#{given_wsdl}#{username}"
         basic_auth [username, password]
-      end
-    end
-  end
+        log false
+			end
+		end
+	end
 end

data/lib/five9/user.rb

@@ -0,0 +1,82 @@
+module Five9
+  class User
+    attr_reader :general_info, :roles, :skills
+    def initialize(args)
+      @user_info = args.make_accessible
+      @general_info = @user_info[:general_info].make_accessible
+      @roles = @user_info[:roles].make_accessible
+      @skills = SkillArray.new(args[:skills])
+    end
+
+    def to_h
+      @user_info[:general_info] = @general_info
+      @user_info[:roles] = @roles
+      @user_info[:skills] = @skills.to_a
+      @user_info
+    end
+
+    def save
+      UserManagement.modify_user(build_modify_hash)
+      @skills.update!
+      self
+    end
+
+    def delete!
+      UserManagement.delete_user user_name
+    end
+
+    def update(args)
+      if args[:general_info]
+        @user_info = to_h.merge(args)
+        @general_info = @user_info[:general_info].make_accessible
+        @roles = @user_info[:roles].make_accessible
+        @skills = SkillArray.new(args[:skills])
+        @user_info
+      else
+        merge! args
+      end
+    end
+
+    def update!(args)
+      update args
+      save
+    end
+
+    def method_missing(method_name, *args)
+      @general_info.send(method_name, *args)
+    end
+
+    def self.exist?(username)
+      not UserManagement.get_users_info(username)[:general_info].nil?
+    end
+
+    def self.create!(args)
+      new UserManagement.create_user(args)
+    end
+
+    def self.find(username)
+      new(UserManagement.get_users_info(username)) if exist?(username)
+    end
+
+    def self.all
+      UserManagement.get_users_info.map do |user_info|
+        new(user_info)
+      end
+    end
+
+    def self.where(args)
+      all.keep_if do |user|
+        user.merge(args).to_hash == user.to_hash
+      end
+    end
+
+    private
+      def build_modify_hash
+        result = {}
+        @general_info["EMail"] ||= @general_info.e_mail
+        result[:userGeneralInfo] = @general_info.to_hash
+        result
+        # TODO configure rolesToSet and rolesToRemove
+      end
+  end
+end

data/lib/five9/user_management.rb

@@ -1,128 +1,101 @@
 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
+	module UserManagement
+    class << self
+      def establish_connection adminuser, password
+        @client = Base.new(adminuser, password,
+          "https://api.five9.com/wsadmin/v2/AdminWebService?wsdl&user=")
+            .instance_variable_get :@client
+        @connected = true
+      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
+      def connected?
+        @connected
       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
+      def create_user user_info = {}
+        validate_connection do
+          response = @client.call :create_user, { message: {
+            userInfo: user_info } }
+          process_return_hash response, :create_user_response
+        end
       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
+      def delete_user username
+        validate_connection do
+          response = @client.call :delete_user, message: { user_name: username }
+          process_return_hash response, :delete_user_response
+        end
       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
+      def get_users_general_info username_pattern = nil
+        validate_connection do
+          response = @client.call :get_users_general_info,
+            message: { userNamePattern: username_pattern }
+          process_return_hash response, :get_users_general_info_response
+        end
       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
+      def get_users_info username_pattern = nil
+        validate_connection do
+          response = @client.call :get_users_info,
+            message: { userNamePattern: username_pattern }      
+          process_return_hash response, :get_users_info_response
+        end
       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
+      def modify_user args
+        validate_connection do
+          response = @client.call :modify_user, message: args
+          process_return_hash response, :modify_user_response
+        end
       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 user_skill_add skill
+        validate_connection do
+          response = @client.call :user_skill_add, message: skill
+          process_return_hash response, :user_skill_add_response
+        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 user_skill_modify skill
+        validate_connection do
+          response = @client.call :user_skill_modify, message: skill
+          process_return_hash response, :user_skill_modify_response
+        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
+      def user_skill_remove skill
+        validate_connection do
+          response = @client.call :user_skill_remove, message: skill
+          process_return_hash response, :user_skill_remove_response
+        end
+      end
 
-    private
+      private
+        def process_return_hash response, method_response_key
+          response_hash = response.to_hash
+          if response_hash[method_response_key].class == Hash
+            unless response_hash[method_response_key][:return].class == NilClass
+              return response_hash[method_response_key][:return]
+            else
+              return response_hash[method_response_key]
+            end
+          else
+            return response_hash
+          end
+        end
 
-      def affect_user_skill(affect, user_skill)
-        begin
-          @client.call affect, message: { userSkill: user_skill }
-        rescue => error
-          puts error.to_s.inspect
-          return false
+        def validate_connection &block
+          if @connected
+            begin
+              block.call if block
+            rescue Wasabi::Resolver::HTTPError
+              raise "Something went wrong! Please insure the connection is established with the proper credentials."
+            end
+          else
+            raise "Connection to Five9 not established!"
+          end
         end
-      end
-  end
-end
+    end
+	end
+end

data/lib/five9/user_resources/profile.rb

@@ -0,0 +1,40 @@
+module Five9
+  class Profile
+    attr_reader :attributes
+    def initialize(args)
+      @attributes = AccessibleHash.new(args)
+    end
+
+    def save
+      ProfileManagement.modify_user_profile(self.to_h)
+    end
+    alias_method :update!, :save
+
+    def method_missing(method_name, *args)
+      @attributes.send(method_name, *args)
+    end
+
+    def self.create!(args)
+      self.new(ProfileManagement.create_user_profile(args))
+    end
+
+    def self.find(profile_name)
+      self.new(matching_profile(all, profile_name))
+    end
+
+    def self.all
+      ProfileManagement.get_user_profiles.map do |profile_info|
+        self.new(profile_info)
+      end
+    end
+
+    private
+      def self.matching_profile(all_profiles, profile_name)
+        matching_profile = all_profiles.select do |profile|
+          profile[:name] == profile_name
+        end
+        raise "No matching profiles were found!" if matching_profile.first.nil?
+        matching_profile.first
+      end
+  end
+end

data/lib/five9/user_resources/profile_management.rb

@@ -0,0 +1,100 @@
+module Five9
+  module ProfileManagement
+    class << self
+      def establish_connection adminuser, password
+        @client = Base.new(adminuser, password,
+          "https://api.five9.com/wsadmin/v2/AdminWebService?wsdl&user=")
+            .instance_variable_get :@client
+        @connected = true
+      end
+
+      def connected?
+        @connected
+      end
+
+      def create_user_profile args
+        validate_connection do
+          response = @client.call :create_user_profile,
+            message: { userProfile: args }
+          process_return_hash response, :create_user_profile_response
+        end
+      end
+
+      def get_user_profile profile_name
+        validate_connection do
+          response = @client.call :get_user_profiles,
+            message: { userProfileName: profile_name }
+          process_return_hash response, :get_user_profiles_response
+        end
+      end
+
+      def get_user_profiles profile_name = nil
+        validate_connection do
+          response = @client.call :get_user_profiles,
+            message: { userProfileNamePattern: profile_name }
+          process_return_hash response, :get_user_profiles_response
+        end
+      end
+
+      def delete_user_profile profile_name
+        validate_connection do
+           response = @client.call :delete_user_profile,
+              message: { userProfileName: profile_name }
+          process_return_hash response, :delete_user_profile_response
+        end
+      end
+
+      def modify_user_profile profile_info
+        validate_connection do
+          response = @client.call :modify_user_profile,
+            message: { userProfile: profile_info }
+          process_return_hash response, :modify_user_profile_response
+        end
+      end
+
+      def modify_user_profile_skills profile_name, skills_to_add=nil, skills_to_remove=nil
+        validate_connection do
+          response = @client.call :modify_user_profile_skills,
+            message: { userProfileName: profile_name,
+            addSkills: skills_to_add, removeSkills: skills_to_remove }
+          process_return_hash response, :modify_user_profile_skills_response
+        end
+      end
+
+      def modify_user_profile_user_list profile_name, users_to_add=nil, users_to_remove=nil
+        validate_connection do
+          response = @client.call :modify_user_profile_user_list,
+            message: { userProfileName: profile_name,
+            addUsers: users_to_add, removeUsers: users_to_remove }
+          process_return_hash response, :modify_user_profile_user_list_response
+        end
+      end
+
+      private
+        def validate_connection &block
+          if @connected
+            begin
+              block.call if block
+            rescue Wasabi::Resolver::HTTPError
+              raise "Something went wrong! Please insure the connection is established with the proper credentials."
+            end
+          else
+            raise "Connection to Five9 not established!"
+          end
+        end
+
+        def process_return_hash response, method_response_key
+          response_hash = response.to_hash
+          if response_hash[method_response_key].class == Hash
+            unless response_hash[method_response_key][:return].class == NilClass
+              return response_hash[method_response_key][:return]
+            else
+              return response_hash[method_response_key]
+            end
+          else
+            return response_hash
+          end
+        end
+    end
+  end
+end

data/lib/five9/user_resources/skill_array.rb

@@ -0,0 +1,58 @@
+module Five9
+  class SkillArray
+    attr_accessor :skills
+    def initialize(args)
+      @skills = []
+      set_initial_skills(args)
+      @old_skills = @skills
+    end
+
+    def to_a
+      @skills
+    end
+
+    def add(skill)
+      @skills << skill unless @skills.include? skill
+    end
+
+    def add!(skill=nil)
+      add(skill) if skill
+      (@skills - @old_skills).each do |new_skill|
+        UserManagement.user_skill_add new_skill
+        @old_skills << new_skill
+      end
+    end
+
+    def remove(skill)
+      @skills.delete(skill)
+    end
+
+    def remove!(skill=nil)
+      remove(skill) if skill
+      (@old_skills - @skills).each do |old_skill|
+        UserManagement.user_skill_remove old_skill
+        @old_skills.delete old_skill
+      end
+    end
+
+    def update!
+      add! ; remove!
+    end
+
+    def method_missing(method_name, *args)
+      @skills.send(method_name, *args)
+    end
+    
+    private
+      def set_initial_skills(args)
+        if args.class == Array
+          args.each do |skill|
+            @skills << skill.make_accessible
+          end
+        elsif args.class == NilClass
+        else
+          @skills << args.make_accessible
+        end
+      end
+  end
+end

data/lib/five9/version.rb

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

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: five9
 version: !ruby/object:Gem::Version
-  version: 0.0.13
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - David Hahn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,11 +20,24 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: accessible_hash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rubygem integration with five9 API
 email:
 - dhahn@ctatechs.com
@@ -47,30 +58,34 @@ files:
 - lib/five9/base.rb
 - lib/five9/inbound_campaign_stats.rb
 - lib/five9/statistics.rb
+- lib/five9/user.rb
 - lib/five9/user_management.rb
+- lib/five9/user_resources/profile.rb
+- lib/five9/user_resources/profile_management.rb
+- lib/five9/user_resources/skill_array.rb
 - lib/five9/version.rb
 homepage: https://github.com/CTA/five9
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Write a gem summary
 test_files: []