pbxtra 0.5.1 → 0.7.0

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+local_test

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.7.0

data/example/extension.rb

@@ -0,0 +1,65 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+require 'pbxtra'
+
+pbx         = PBXtra::Base.new("user", 'pass', {:debug => true})
+parameters  = {:list_ext => 'all' }
+request     = {
+  :callforward        => nil,
+  :override_phone     => 1,
+  :existing_extension => 5003,
+  :old_mailbox        => nil,
+  :old_in_blast_group => nil,
+  :existing_username  => nil,
+  :existing_password  => nil,
+  :username           => nil,
+  :password           => nil.
+  :do                 => 'ext',
+  :old_visual_only    => 0,
+  :old_department     => nil,
+  :add_ext_final_step => 1,
+  :extension          => 5002,
+  :description        => 'John',
+  :first_name         => 'Doe',
+  :last_name          => 'User',
+  :username2          => 7744_5003,
+  :password2          => 'Sugar123!',
+  :employee_email     => 'jdoe@sugarcrm.com',
+  :employee_im        => 'jdoe@yahoo.com',
+  :employee_phonenumber => '+1-555-555-5555',
+  :sms_selector       => 'cingularme.com',
+  :sms_gateway        => '15555555555@cingularme.com',
+  :phone_number       => nil,
+  :caller_id          => 14084546900,
+  :moh_dialargs       => nil,
+  :ring_seconds       => 20,
+  :old_device_id      => nil,
+  :device_id          => 322674,
+  :virt_device_id     => 280874,
+  :department         => nil,
+  :auto_logoff        => 0,
+  :press_to_accept    => 0,
+  :q_ignore_if_busy   => 1,
+  :q_call_on_qcall    => 0,
+  :q_dont_req_pass    => 0,
+  :insert_into_dir    => 1,
+  :in_company_dir     => 1,
+  :in_blast_group     => 0,
+  :in_hud             => 1,
+  :is_private         => 0,
+  :visual_only        => 0,
+  :vm_enabled         => 1,
+  :uae_ret            => 0,
+  :crm_user_id        => 'None',
+  :mailbox            => 'new',
+  :vm_pass            => 5002,
+  :vm_email           => 'jdoe@sugarcrm.com',
+  :vm_pager           => nil,
+  :vm_attach          => 1,
+  :vm_auto_delete     => 0,
+  :call_return        => 1,
+  :call_out           => 1,
+}
+
+response = pbx.post(:ext, parameters, request)

data/example/report.rb

@@ -0,0 +1,34 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+require 'pbxtra'
+
+pbx             = PBXtra::Base.new("user", 'pass', {:debug => true})
+ext             = 5555
+
+start_date      = "2000-01-01"
+end_date        = "2000-01-10"
+
+csv             = pbx.get(:rep, {
+  :showinbound  => :on,
+  :showoutbound => :on,
+  :showacd      => :on,
+  :src          => :on,
+  :dst          => :on,
+  :disposition  => :on,
+  :calldate     => :on,
+  :duration     => :on,
+  :clid         => :on,
+  :csv          => :on,
+  :for_ext      => ext,
+  :reporting    => 1,
+  :month1       => start_date.split(/-/)[1],
+  :month2       => end_date.split(/-/)[1],
+  :day1         => start_date.split(/-/)[2],
+  :day2         => end_date.split(/-/)[2],
+  :year1        => start_date.split(/-/)[0],
+  :year2        => end_date.split(/-/)[0],
+  :show_report_results => 1
+})
+
+puts csv

data/lib/pbxtra.rb

@@ -9,9 +9,11 @@ module PBXtra
 class LoginError < RuntimeError
 end
 
+class UnhandledResponse < RuntimeError
+end
+
 class Base
   
-  HOST = "cp-b.fonality.com"
   URL  = "/cpa.cgi"
   attr :url, true
   attr :user, false
@@ -20,13 +22,17 @@ class Base
   attr :debug, true
   attr :cookie, true
   
-  def initialize(user, pass, options={})
-    {:debug => false}.merge! options
+  def initialize(user, pass, opts={})
+    options = { 
+      :host   => "https://cp52.fonality.com",
+      :debug  => false
+    }.merge! opts
     @debug = options[:debug]
     
     @user = user
     @pass = pass
-    @url  = URI.parse("https://" + HOST + URL)
+    @host = options[:host]
+    @url  = URI.parse(@host + URL)
     
     # Handles http/https in url string
     @ssl  = false
@@ -37,35 +43,43 @@ class Base
     raise LoginError, "Invalid Username or Password" unless logged_in?
   end
   
+  def get(method, parameters={})
+    @url.query = wrap_url_query(method, parameters)
+    request(Net::HTTP::Get.new(@url.path + @url.query, header)).body
+  end
+  
+  def post(method=nil, parameters={}, body={})
+    @url.query = wrap_url_query(method, parameters)
+    req = Net::HTTP::Post.new(@url.path + @url.query, header)
+    req.body = wrap_body(body)
+    request(req)
+  end
+  
   # Send a request to the CP.  Send Auth information if we have it.
-  def request(method, parameters={})
+  def request(request)
     login! unless logged_in?
-    
-    # Sanitize and wrap our method + paramters
-    query = wrap(method, parameters) 
-    @url.query = query
-    
-    # Send the request
-    header   = {'Cookie' => @cookie, 'Accept-Encoding' => ''}
-    request  = Net::HTTP::Get.new(@url.path + @url.query, header)
+    if @debug
+      puts "Request Type: #{request.class}"
+      puts "Request Path: #{@url}"
+      puts "Request Body: #{request.body}"
+      puts "\n"
+    end
     response = @connection.request(request)
-
     if @debug
-      puts "Path: #{@url.path}"
-      puts response
+      puts "Response Header: " + response.header.to_s
+      puts "Response Body: " + response.body 
       puts "\n"
     end
-
     case response
       when Net::HTTPOK
-        raise EmptyResponse unless response.body
-        return response.body
+        return response
       when Net::HTTPUnauthorized
         login!
         request(method, parameters)
       when Net::HTTPForbidden
         raise LoginError, "Invalid Username or Password" 
-      else raise UnhandledResponse, "Can't handle response #{response}"
+      else 
+        raise UnhandledResponse, "Can't handle response #{response}"
     end
   end
 
@@ -74,13 +88,26 @@ class Base
     # Attempt authentication with PBXtra CP
     def login!
       connect! unless connected?
+      body = {
+        :forcesec => nil,
+        :do       => 'authenticate',
+        :username => @user,
+        :password => @pass
+      }
       request  = Net::HTTP::Post.new(@url.path)
-      request.body = "forcesec=&do=authenticate&username=#{@user}&password=#{@pass}"
+      request.body = wrap_body(body)
       response = @connection.request(request)
-      @cookie  = response["Set-Cookie"].split(/;/)[0]
+      
+      if response["Set-Cookie"]
+        @cookie  = response["Set-Cookie"].split(/;/)[0]
+      else
+        raise LoginError, "Invalid Username or Password"
+      end
+      
       if @debug
         puts "Cookie: #{@cookie}"
       end
+
     end
   
     # Check to see if we are logged in
@@ -106,12 +133,28 @@ class Base
       @connection.start
     end
     
-    def wrap(method, parameters)
-      body = "?do=#{method}"
+    def wrap_url_query(method, parameters={})
+      url = "?do=#{method}"
       parameters.each_pair do |k,v|
-        body << "&" + k.to_s + "=" + v.to_s
+        url << "&" + k.to_s + "=" + v.to_s
+      end
+      url
+    end
+    
+    def wrap_body(parameters={})
+      body = []
+      parameters.each_pair do |k,v|
+        body << k.to_s + "=" + v.to_s
+      end
+      body.join('&')
+    end
+    
+    def header
+      if @cookie
+        {'Cookie' => @cookie, 'Accept-Encoding' => ''}
+      else
+        {}
       end
-      body
     end
   
 end 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pbxtra
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 1
-  version: 0.5.1
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Carl Hicks
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-23 00:00:00 -07:00
+date: 2010-08-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,6 +48,8 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- example/extension.rb
+- example/report.rb
 - lib/pbxtra.rb
 - test/helper.rb
 - test/test_pbxtra.rb