switchvox 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-04-22
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/switchvox.rb
+lib/switchvox/array.rb
+lib/switchvox/base.rb
+lib/switchvox/hash.rb
+lib/switchvox/net_http_digest_auth.rb
+lib/switchvox/object.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_json_to_obj.rb
+test/test_switchvox.rb

data/README.rdoc

@@ -0,0 +1,70 @@
+= Switchvox
+
+* http://github.com/chicks/switchvox
+
+== SUMMARY: 
+
+Ruby Gem for interacting with Digium's Switchvox PBX via JSON
+
+== DESCRIPTION:
+
+Ruby Gem for interacting with Digium's Switchvox PBX via JSON.
+
+There wasn't a gem out there, so I wrote one.
+
+== FEATURES/PROBLEMS:
+
+* The response hash gets converted into a Ruby object, via Hash#to_obj method.
+
+== SYNOPSIS:
+
+  require 'switchvox'
+  switchvox = Switchvox::Base.new("pbx.foo.com", 'user', 'password', {:debug => false})
+
+  # Pull the software version of Switchvox
+  switchvox.request("switchvox.info.getSoftwareVersion")
+
+  # Pull a call report
+  call_log = switchvox.request("switchvox.callLogs.search", {
+    "start_date"  => "2010-01-01 00:00:00",
+    "end_date"    => "2010-01-02 23:59:59",
+    "account_ids" => [1001],
+  })
+  calls = call_log.calls.call
+  calls.each do |call|
+    c = call.to_obj
+    puts calls.index(call).to_s + ": " + c.start_time + ": " + c.from + " " + c.to
+  end
+
+== REQUIREMENTS:
+
+* json gem
+
+== INSTALL:
+
+* sudo gem install switchvox
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Carl Hicks
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/switchvox'
+
+Hoe.plugin :newgem
+Hoe.plugin :git
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'switchvox' do
+  self.developer 'Carl Hicks', 'carl.hicks@gmail.com'
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps           = [['json']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/switchvox.rb

@@ -0,0 +1,12 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'switchvox/hash'
+require 'switchvox/array'
+require 'switchvox/object'
+require 'switchvox/net_http_digest_auth'
+require 'switchvox/base'
+
+module Switchvox
+  VERSION = '0.1.0'
+end

data/lib/switchvox/array.rb

@@ -0,0 +1,14 @@
+# A fancy way of iterating over an array and converting hashes to objects
+class Array
+  def to_obj
+    # Make a deep copy of the array
+    a = Marshal.load(Marshal.dump(self))
+    a.each do |i|
+      case i.class.to_s
+        when "Hash" then i = i.to_obj
+        when "Array" then i = i.to_obj
+      end
+    end
+    a
+  end
+end

data/lib/switchvox/base.rb

@@ -0,0 +1,145 @@
+#! /usr/bin/env ruby
+
+module Switchvox
+
+require 'uri'
+require 'net/https'
+require 'openssl'
+require 'digest/md5'
+require 'rubygems'
+require 'json'
+
+# Raised when credentials are incorrect
+class LoginError < RuntimeError
+end
+
+# Raised when the response.body is empty
+class EmptyResponse < RuntimeError
+end
+
+# Raised when a response is returned that we don't know how to handle
+class UnhandledResponse < RuntimeError
+end
+
+# The primary class used to interact with Switchvox.
+class Base 
+
+  URL = "/json"
+  attr :host, true
+  attr :url, true
+  attr :user, false
+  attr :pass, false
+  attr :connection, true
+  attr :session, true
+  attr :debug, true
+  attr :auth_header, true
+
+  def initialize(host, user, pass, options={})
+    {:debug => false}.merge! options
+    @debug = options[:debug]
+
+    @host = host
+    @user = user
+    @pass = pass
+    @url  = URI.parse("https://" + @host + URL)
+    @ssl  = false
+    @ssl  = true if @url.scheme == "https"
+        
+    @connection  = false
+    @auth_header = false
+    login!
+    raise LoginError, "Invalid Username or Password" unless logged_in?
+  end
+
+  # A standard REST call to get a list of entries
+  def request(method, parameters={})
+    login! unless logged_in?
+    json = wrap_json(method, parameters)
+    
+    # Send the request
+    header   = {'Content-Type' => "text/json"}
+    request  = Net::HTTP::Post.new(@url.path, header)
+    request.digest_auth(@user, @pass, @auth_header)
+    request.body = json
+    response = @connection.request(request)
+
+    if @debug
+      puts "#{method}: Request"
+      puts json
+      puts "\n"
+    end
+
+    case response
+      when Net::HTTPOK
+        raise EmptyResponse unless response.body
+        response_json = JSON.parse response.body
+        if @debug
+          puts "#{method}: Response:"
+          pp response_json 
+          puts "\n\n"
+        end
+        response_obj = response_json["response"]["result"].to_obj
+        return response_obj
+      when Net::HTTPUnauthorized
+        login!
+        request(method, parameters)
+      when Net::HTTPForbidden
+        raise LoginError, "Invalid Username or Password" 
+      else raise UnhandledResponse, "Can't handle response #{response}"
+    end
+  end
+
+  protected
+
+    # Check to see if we are logged in
+    def logged_in?
+      return false unless @auth_header
+      true
+    end
+  
+    # Attempt HTTP Digest Authentication with Switchvox
+    def login!
+      connect! unless connected?
+      @auth_header = @connection.head(@url.path)
+    end
+
+    # Check to see if we have an HTTP/S Connection
+    def connected?
+      return false unless @connection
+      return false unless @connection.started?
+      true
+    end
+
+    # Connect to the remote Switchvox system.  If SSL is enabled, ignore certificate checking.
+    def connect!
+      @connection = Net::HTTP.new(@url.host, @url.port)
+      if @ssl
+        @connection.use_ssl = true
+        @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      if @debug
+        #@connection.set_debug_output $stderr
+      end
+      @connection.start
+    end
+
+    # Wrap a JSON method and parameters in a Switchvox compatible request body.
+    def wrap_json(method, parameters={})
+      json = <<-"EOF"
+        {
+          \"request\": {
+            \"method\": \"#{method}\",
+            \"parameters\": #{parameters.to_json}
+          }
+        }
+      EOF
+      json.gsub!(/^\s{8}/,'')
+    end
+
+end
+  
+end
+
+
+
+

data/lib/switchvox/hash.rb

@@ -0,0 +1,17 @@
+# A fancy way of iterating over a hash and converting hashes to objects
+class Hash
+  def to_obj
+    o = Object.new
+    self.each do |k,v|
+      # If we're looking at a hash or array, we need to look through them and convert any hashes to objects as well
+      case v.class.to_s
+        when "Hash"  then v = v.to_obj
+        when "Array" then v = v.to_obj
+      end
+      o.instance_variable_set("@#{k}", v)  ## create and initialize an instance variable for this key/value pair
+      o.class.send(:define_method, k, proc{o.instance_variable_get("@#{k}")})  ## create the getter that returns the instance variable
+      o.class.send(:define_method, "#{k}=", proc{|v| o.instance_variable_set("@#{k}", v)})  ## create the setter that sets the instance variable
+    end
+    o
+  end
+end

data/lib/switchvox/net_http_digest_auth.rb

@@ -0,0 +1,34 @@
+module Net
+  module HTTPHeader
+    require 'digest/md5'
+    require 'net/http'
+    
+    @@nonce_count = -1
+    CNONCE = Digest::MD5.new.update("%x" % (Time.now.to_i + rand(65535))).hexdigest
+    def digest_auth(user, password, response)
+      # based on http://segment7.net/projects/ruby/snippets/digest_auth.rb
+      @@nonce_count += 1
+
+      response['www-authenticate'] =~ /^(\w+) (.*)/
+
+      params = {}
+      $2.gsub(/(\w+)="(.*?)"/) { params[$1] = $2 }
+
+      a_1 = "#{user}:#{params['realm']}:#{password}"
+      a_2 = "#{@method}:#{@path}"
+      request_digest = ''
+      request_digest << Digest::MD5.new.update(a_1).hexdigest
+      request_digest << ':' << params['nonce']
+      request_digest << ':' << Digest::MD5.new.update(a_2).hexdigest
+
+      header = []
+      header << "Digest username=\"#{user}\""
+      header << "realm=\"#{params['realm']}\""
+      header << "uri=\"#{@path}\""
+      header << "nonce=\"#{params['nonce']}\""
+      header << "response=\"#{Digest::MD5.new.update(request_digest).hexdigest}\""
+
+      @header['Authorization'] = header
+    end
+  end
+end

data/lib/switchvox/object.rb

@@ -0,0 +1,5 @@
+class Object
+  def to_obj
+    self
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/switchvox.rb'}"
+puts "Loading switchvox gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'stringio'
+require 'test/unit'
+require 'pp'
+require File.dirname(__FILE__) + '/../lib/switchvox'

data/test/test_json_to_obj.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestJson2Object < Test::Unit::TestCase
+  def test_object
+    json = {"string" => "value"}.to_json
+    obj  = JSON.parse(json).to_obj
+    assert_equal("value", obj.string)
+  end
+  
+  def test_nested_object
+    json = {"dogs" => {"retriever" => "sparky", "basset" => "jennie", "pinscher" => "carver"}}.to_json
+    obj  = JSON.parse(json).to_obj
+    assert_equal("sparky", obj.dogs.retriever)
+  end
+  
+  def test_array_of_objects
+    json = [{"retriever" => "sparky"}, {"basset" => "jennie"}, {"pinscher" => "carver"}].to_json
+    obj  = JSON.parse(json).to_obj
+    assert_equal("sparky", obj[0].retriever)
+  end
+  
+  def test_deep_nest_mixed
+    json = {"kennels" => [
+            {"dallas" => [
+             {"name" => "north"},
+             {"name"  => "east"},
+            ]},
+            {"frisco" => [
+             {"name" => "south"},
+             {"name"  => "west"}
+            ],
+            "company" => "Doggie Daze"
+            }
+          ]}.to_json
+    obj  = JSON.parse(json).to_obj
+    assert_equal("west", obj.kennels[1].frisco[0].name)
+  end
+  
+  def test_deep_nest_hash
+    json = {"kennels" => {
+            "kennel" => {
+            "dallas" => ["north", "south"],
+            "frisco" => ["east", "west"]}}
+           }.to_json
+    obj  = JSON.parse(json).to_obj
+    pp obj
+    assert_equal("north", obj.kennels.kennel.dallas[0])
+  end
+end

data/test/test_switchvox.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestSwitchvox < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: switchvox
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Carl Hicks
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id003
+description: |-
+  Ruby Gem for interacting with Digium's Switchvox PBX via JSON.
+  
+  There wasn't a gem out there, so I wrote one.
+email: 
+- carl.hicks@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/switchvox.rb
+- lib/switchvox/array.rb
+- lib/switchvox/base.rb
+- lib/switchvox/hash.rb
+- lib/switchvox/net_http_digest_auth.rb
+- lib/switchvox/object.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_json_to_obj.rb
+- test/test_switchvox.rb
+has_rdoc: true
+homepage: http://github.com/chicks/switchvox
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: switchvox
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby Gem for interacting with Digium's Switchvox PBX via JSON
+test_files: 
+- test/test_helper.rb
+- test/test_json_to_obj.rb
+- test/test_switchvox.rb