qui 0.8.3 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffd27296d3bff42cfbef8c24ff703783d284844c
-  data.tar.gz: c6d3e4aee9b4c78381338cbd61130155e2df5bfa
+  metadata.gz: 33ced5ed8190bac66954a479a646fe54be968162
+  data.tar.gz: ab2286b5efc9c26bb52d31278f33c4ef61ab19c1
 SHA512:
-  metadata.gz: 8c6e08d3cfff6b68f28293dfd390f0faaf8d4976ebc2389c5bbf80488969e8fdfa8b8611317ce4aacdd8d2a0c1984f671f964e934c28eb89a2e9f6663740bbee
-  data.tar.gz: 4ea45381b357dd9d0521702468ce4c8088b2b7e2508bb6e593014f1a23815426e86e625991b3b39afa91dc42ba1041b7744b2640d94f179cc52754ca32f3c45e
+  metadata.gz: e123202253baca94111462b049c8c511848f7271bc08c0b8892170648f6dbdd19e356a5f19d7391f54287955ef3d935ce1b6a786e565bbe807df7f2e073ecf25
+  data.tar.gz: e8d75deef63de86c07423d30cf9309d39ae410631764b295991bf0014258deecd1580a5240515255bcb50a37a5599746300822bd0a468ee6300b8664a73c32b2

data/README.md

@@ -1,6 +1,6 @@
 # Qui
 
-TODO: Write a gem description
+Qui, or Queuemetrics User Integration, is a gem that creates an ActiveRecord wrapper for manipulating users, agents, and queues within the Queuemetrics calling platform.
 
 ## Installation
 
@@ -16,13 +16,29 @@ Or install it yourself as:
 
     $ gem install qui
 
-## Description
+## Usage
 
-Qui, or Queuemetrics User Integration, is a gem that creates an ActiveRecord wrapper for manipulating users, agents, and queues within the Queuemetrics calling platform.
+First, connect to your Queuemetrics database:
 
-## Usage
+    Qui::Base.new("192.168.1.100","username","password")
+    
+Then simply create users, agents and queues using QueuemetricsAgent, QueuemetricsUser, and QueuemetricsQueue - all inhereit from ActiveRecord::Base.
+
+User:
+
+    u = Qui::User.new(login: "Agent/5555", password: "superSECRET", real_name: "Robert Weathers", classe: 4)
+    u.save
+    
+Agent:
+
+    a = Qui::Agent.new(agent_name: "Agent/5555", agent_description: "rweathers", supervised_by: "Mr. Smith")
+    a.save
+
+You can add queues using ActiveRecord, but can also add or remove agents from queues like below:
 
-TODO: Write usage instructions here
+    q = Qui::Queue.first
+    q.add_agent!("Agent/5555")
+    q.remove_agent!("Agent/4445")
 
 ## Contributing
 

data/lib/qui/{queuemetrics_agent.rb → agent.rb}

@@ -1,8 +1,16 @@
-class QueuemetricsAgent < ActiveRecord::Base
-	self.table_name = 'agenti_noti'
+module Qui
+  class Agent < ActiveRecord::Base
+    self.table_name = 'agenti_noti'
 
-  def initialize(options={})
-    if options then 
+    def initialize(options={})
+      if options then 
+        super set_defaults(options)
+      else
+        super
+      end
+    end
+    
+    def set_defaults(options)
       if options[:agent_name] then options[:nome_agente] = options.delete(:agent_name) end
       if options[:agent_description] then options[:descr_agente] = options.delete(:agent_description) end
       options[:location] = 3
@@ -14,10 +22,7 @@ class QueuemetricsAgent < ActiveRecord::Base
       options[:payroll_code] = " "
       options[:chiave_agente] = " "
       options[:sys_dt_modifica] = Time.now.to_s(:db)
-      super(options)
-    else
-      super
     end
+
   end
-  
 end

data/lib/qui/base.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+
+module Qui
+  class Base
+
+    def self.establish_connection(host, username, password)
+      connection = {
+        :adapter 	=> "mysql2",
+        :host 		=> host,
+        :database => "queuemetrics",
+        :username => username,
+        :password => password,
+      }
+      ActiveRecord::Base.establish_connection connection
+    end
+
+    def self.close_connection
+      ActiveRecord::Base.connection.close
+    end
+
+  end
+end

data/lib/qui/queue.rb

@@ -0,0 +1,36 @@
+module Qui
+  class Queue < ActiveRecord::Base
+    self.table_name = 'code_possibili'
+
+    def initialize(options={}) 
+      super(options) 
+    end
+
+    def add_agent!(userid)
+      if exists_in_queue?(userid) then
+        false
+      else
+        self.agenti_membri += "|#{userid}"
+        self.save
+      end
+    end
+
+    def remove_agent!(userid)
+      if exists_in_queue?(userid) then 
+        members = self.agenti_membri.split("|")
+        members.delete userid
+        self.agenti_membri = members.join("|")
+        self.save
+      else
+        false
+      end
+    end
+
+    private
+
+    def exists_in_queue?(userid)
+      if self.agenti_membri.include?(userid) then true else false end
+    end
+
+  end
+end

data/lib/qui/user.rb

@@ -0,0 +1,26 @@
+module Qui
+  class User < ActiveRecord::Base
+    self.table_name = 'arch_users'
+    
+    def initialize(options={})
+      if options then 
+        super set_defaults(options) 
+      else
+        super
+      end
+    end
+
+    private
+
+      def set_defaults(options)
+        options[:abilitato] = "1"
+        options[:masterkey] = "0"
+        options[:n_logon]  = "0"
+        options[:chiavi_utente] = " "
+        options[:ultimo_logon] = Time.now.to_s(:db)
+        options[:sys_dt_creazione] = Time.now.to_s(:db)
+        options[:sys_dt_modifica] = Time.now.to_s(:db)
+      end
+
+  end
+end

data/lib/qui.rb

@@ -2,10 +2,9 @@
 require "active_record"
 
 #classes
-require "qui/version"
-require "qui/queuemetrics"
-require "qui/queuemetrics_user"
-require "qui/queuemetrics_agent"
-require "qui/queuemetrics_queue"
+require "qui/base"
+require "qui/user"
+require "qui/agent"
+require "qui/queue"
 
 module Qui end

data/qui.gemspec

@@ -1,15 +1,18 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'qui/version'
+require 'qui/base'
+require 'qui/agent'
+require 'qui/user'
+require 'qui/queue'
 
 Gem::Specification.new do |spec|
   spec.name          = "qui"
-  spec.version       = Qui::VERSION
+  spec.version       = "0.8.5"
   spec.authors       = ["Kevin Collette"]
   spec.email         = ["kevcollette@gmail.com"]
   spec.description   = %q{Qui, or Queuemetrics User Integration, is a gem that creates an ActiveRecord wrapper for manipulating users, agents, and queues within the Queuemetrics calling platform.}
-  spec.summary       = %q{Qui creates and manages Queuemetrics users.}
+  spec.summary       = %q{Qui creates and manages Queuemetrics users and queues.}
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/spec/lib/agent_spec.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'qui/base'
+require 'qui/agent'
+
+describe Qui::Agent do
+
+  it "should wrap ActiveRecord" do
+    #@q = YAML::load_file(File.join(__dir__, 'config.yml'))
+    #Qui::Base.establish_connection(@q["host"], @q["username"], @q["password"])
+    Qui::Agent.superclass.should == ActiveRecord::Base
+  end
+
+end

data/spec/lib/{queuemetrics_spec.rb → base_spec.rb}

@@ -1,10 +1,10 @@
 require 'spec_helper'
 require 'yaml'
-require 'qui/queuemetrics'
-require 'qui/queuemetrics_agent'
+require 'qui/base'
+require 'qui/agent'
 require 'active_record'
 
-describe Queuemetrics do
+describe Qui::Base do
 
   before do
     @q = YAML::load_file(File.join(__dir__, 'config.yml'))
@@ -13,7 +13,7 @@ describe Queuemetrics do
   #connected? returns opposite bool
   describe ".establish_connection" do
     it "establishes a connection to a Queuemetrics database." do
-      Queuemetrics.establish_connection(@q["host"], @q["username"], @q["password"])
+      Qui::Base.establish_connection(@q["host"], @q["username"], @q["password"])
       ActiveRecord::Base.connected?.should be_false
       ActiveRecord::Base.connection.current_database.should eq("queuemetrics")
     end
@@ -21,7 +21,7 @@ describe Queuemetrics do
 
   describe ".close_connection" do
     it "closes a connection to the Queuemetrics database." do
-      Queuemetrics.close_connection
+      Qui::Base.close_connection
       ActiveRecord::Base.connected?.should be_true
     end
   end

data/spec/lib/{queuemetrics_queue_spec.rb → queue_spec.rb}

@@ -1,18 +1,18 @@
 require 'spec_helper'
-require 'qui/queuemetrics'
-require 'qui/queuemetrics_queue'
+require 'qui/base'
+require 'qui/queue'
 
-describe QueuemetricsQueue do
+describe Qui::Queue do
 
   before do
-    @queue = QueuemetricsQueue.first
+    @queue = Qui::Queue.first
     @userid = 'agent/128461849'
   end
 
   it "should wrap ActiveRecord" do
-    @q = YAML::load_file(File.join(__dir__, 'config.yml'))
-    Queuemetrics.establish_connection(@q["host"], @q["username"], @q["password"])
-    QueuemetricsQueue.superclass.should == ActiveRecord::Base
+    # @q = YAML::load_file(File.join(__dir__, 'config.yml'))
+    # Qui::Base.establish_connection(@q["host"], @q["username"], @q["password"])
+    Qui::Queue.superclass.should == ActiveRecord::Base
   end
 
   describe ".add_agent!" do

data/spec/lib/user_spec.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'qui/base'
+require 'qui/user'
+
+describe Qui::User do
+
+  it "should wrap ActiveRecord" do
+    # @q = YAML::load_file(File.join(__dir__, 'config.yml'))
+    # Queuemetrics.establish_connection(@q["host"], @q["username"], @q["password"])
+    Qui::User.superclass.should == ActiveRecord::Base
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qui
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.5
 platform: ruby
 authors:
 - Kevin Collette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-15 00:00:00.000000000 Z
+date: 2013-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,18 +83,16 @@ files:
 - README.md
 - Rakefile
 - lib/qui.rb
-- lib/qui/queuemetrics.rb
-- lib/qui/queuemetrics_agent.rb
-- lib/qui/queuemetrics_queue.rb
-- lib/qui/queuemetrics_record.rb
-- lib/qui/queuemetrics_user.rb
-- lib/qui/version.rb
+- lib/qui/agent.rb
+- lib/qui/base.rb
+- lib/qui/queue.rb
+- lib/qui/user.rb
 - qui.gemspec
+- spec/lib/agent_spec.rb
+- spec/lib/base_spec.rb
 - spec/lib/config.yml
-- spec/lib/queuemetrics_agent_spec.rb
-- spec/lib/queuemetrics_queue_spec.rb
-- spec/lib/queuemetrics_spec.rb
-- spec/lib/queuemetrics_user_spec.rb
+- spec/lib/queue_spec.rb
+- spec/lib/user_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -119,11 +117,11 @@ rubyforge_project:
 rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
-summary: Qui creates and manages Queuemetrics users.
+summary: Qui creates and manages Queuemetrics users and queues.
 test_files:
+- spec/lib/agent_spec.rb
+- spec/lib/base_spec.rb
 - spec/lib/config.yml
-- spec/lib/queuemetrics_agent_spec.rb
-- spec/lib/queuemetrics_queue_spec.rb
-- spec/lib/queuemetrics_spec.rb
-- spec/lib/queuemetrics_user_spec.rb
+- spec/lib/queue_spec.rb
+- spec/lib/user_spec.rb
 - spec/spec_helper.rb

data/lib/qui/queuemetrics.rb

@@ -1,18 +0,0 @@
-class Queuemetrics
-
-  def self.establish_connection(host, username, password)
-    connection = {
-      :adapter 	=> "mysql2",
-      :host 		=> host,
-      :database => "queuemetrics",
-      :username => username,
-      :password => password,
-    }
-    ActiveRecord::Base.establish_connection connection
-  end
-
-  def self.close_connection
-    ActiveRecord::Base.connection.close
-  end
-
-end

data/lib/qui/queuemetrics_queue.rb

@@ -1,32 +0,0 @@
-class QueuemetricsQueue < ActiveRecord::Base
-  self.table_name = 'code_possibili'
-
-  def initialize(options={}) super(options) end
-
-  def add_agent!(userid)
-    if exists_in_queue?(userid) then
-      false
-    else
-      self.agenti_membri += "|#{userid}"
-      self.save
-    end
-  end
-
-  def remove_agent!(userid)
-    if exists_in_queue?(userid) then 
-      members = self.agenti_membri.split("|")
-      members.delete userid
-      self.agenti_membri = members.join("|")
-      self.save
-    else
-      false
-    end
-  end
-
-  private
-
-  def exists_in_queue?(userid)
-    if self.agenti_membri.include?(userid) then true else false end
-  end
-
-end

data/lib/qui/queuemetrics_record.rb

@@ -1,27 +0,0 @@
-module QueuemetricsRecord
-  include ActiveRecord::Base
-
-  def save
-    if self.exists? then 
-      message = false
-    else
-      message = true
-      begin
-				self.class.create(self.db_attributes)
-      rescue Exception => e
-        message = false
-      end
-    end
-    return message
-  end
-
-  def delete
-    if self.exists? then 
-      u = self.class.where(:nome_agente => "Agent/#{@userid}", :descr_agente => @username).first
-      u.destroy
-    else
-      false
-    end
-  end
-
-end

data/lib/qui/queuemetrics_user.rb

@@ -1,19 +0,0 @@
-class QueuemetricsUser < ActiveRecord::Base
-  self.table_name = 'arch_users'
-  
-  def initialize(options={})
-    if options then 
-      options[:abilitato] = "1"
-      options[:masterkey] = "0"
-      options[:n_logon]  = "0"
-      options[:chiavi_utente] = " "
-      options[:ultimo_logon] = Time.now.to_s(:db)
-      options[:sys_dt_creazione] = Time.now.to_s(:db)
-      options[:sys_dt_modifica] = Time.now.to_s(:db)
-      super(options) 
-    else
-      super
-    end
-  end
-
-end

data/lib/qui/version.rb

@@ -1,3 +0,0 @@
-module Qui
-  VERSION = "0.8.3"
-end

data/spec/lib/queuemetrics_agent_spec.rb

@@ -1,13 +0,0 @@
-require 'active_record'
-require 'qui/queuemetrics'
-require 'qui/queuemetrics_agent'
-
-describe QueuemetricsAgent do
-
-  it "should wrap ActiveRecord" do
-    @q = YAML::load_file(File.join(__dir__, 'config.yml'))
-    Queuemetrics.establish_connection(@q["host"], @q["username"], @q["password"])
-    QueuemetricsAgent.superclass.should == ActiveRecord::Base
-  end
-
-end

data/spec/lib/queuemetrics_user_spec.rb

@@ -1,13 +0,0 @@
-require 'active_record'
-require 'qui/queuemetrics'
-require 'qui/queuemetrics_user'
-
-describe QueuemetricsUser do
-
-  it "should wrap ActiveRecord" do
-    @q = YAML::load_file(File.join(__dir__, 'config.yml'))
-    Queuemetrics.establish_connection(@q["host"], @q["username"], @q["password"])
-    QueuemetricsAgent.superclass.should == ActiveRecord::Base
-  end
-
-end