pbxtra 0.5.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 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/README.rdoc

@@ -0,0 +1,17 @@
+= pbxtra
+
+A client library for communicating with Fonality's PBXtra Control Panel
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Carl Hicks. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pbxtra"
+    gem.summary = %Q{A client library for communicating with Fonality's PBXtra Control Panel}
+    gem.description = %Q{A client library for communicating with Fonality's PBXtra Control Panel}
+    gem.email = "carl.hicks@gmail.com"
+    gem.homepage = "http://github.com/chicks/pbxtra"
+    gem.authors = ["Carl Hicks"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pbxtra #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.1

data/lib/pbxtra.rb

@@ -0,0 +1,119 @@
+#! /usr/bin/env ruby
+
+require 'uri'
+require 'net/https'
+
+module PBXtra
+  
+# Raised when credentials are incorrect
+class LoginError < RuntimeError
+end
+
+class Base
+  
+  HOST = "cp-b.fonality.com"
+  URL  = "/cpa.cgi"
+  attr :url, true
+  attr :user, false
+  attr :pass, false
+  attr :connection, true
+  attr :debug, true
+  attr :cookie, true
+  
+  def initialize(user, pass, options={})
+    {:debug => false}.merge! options
+    @debug = options[:debug]
+    
+    @user = user
+    @pass = pass
+    @url  = URI.parse("https://" + HOST + URL)
+    
+    # Handles http/https in url string
+    @ssl  = false
+    @ssl  = true if @url.scheme == "https"
+    
+    @connection = false
+    login!
+    raise LoginError, "Invalid Username or Password" unless logged_in?
+  end
+  
+  # Send a request to the CP.  Send Auth information if we have it.
+  def request(method, parameters={})
+    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)
+    response = @connection.request(request)
+
+    if @debug
+      puts "Path: #{@url.path}"
+      puts response
+      puts "\n"
+    end
+
+    case response
+      when Net::HTTPOK
+        raise EmptyResponse unless response.body
+        return response.body
+      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
+  
+    # Attempt authentication with PBXtra CP
+    def login!
+      connect! unless connected?
+      request  = Net::HTTP::Post.new(@url.path)
+      request.body = "forcesec=&do=authenticate&username=#{@user}&password=#{@pass}"
+      response = @connection.request(request)
+      @cookie  = response["Set-Cookie"].split(/;/)[0]
+      if @debug
+        puts "Cookie: #{@cookie}"
+      end
+    end
+  
+    # Check to see if we are logged in
+    def logged_in?
+      return false unless @cookie
+      true
+    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 system.
+    def connect!
+      @connection = Net::HTTP.new(@url.host, @url.port)
+      if @ssl
+        @connection.use_ssl = true
+        @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      @connection.start
+    end
+    
+    def wrap(method, parameters)
+      body = "?do=#{method}"
+      parameters.each_pair do |k,v|
+        body << "&" + k.to_s + "=" + v.to_s
+      end
+      body
+    end
+  
+end 
+
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'pbxtra'
+
+class Test::Unit::TestCase
+end

data/test/test_pbxtra.rb

@@ -0,0 +1,4 @@
+require 'helper'
+
+class TestPbxtra < Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: pbxtra
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 1
+  version: 0.5.1
+platform: ruby
+authors: 
+- Carl Hicks
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A client library for communicating with Fonality's PBXtra Control Panel
+email: carl.hicks@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/pbxtra.rb
+- test/helper.rb
+- test/test_pbxtra.rb
+has_rdoc: true
+homepage: http://github.com/chicks/pbxtra
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A client library for communicating with Fonality's PBXtra Control Panel
+test_files: 
+- test/helper.rb
+- test/test_pbxtra.rb