pbxtra 0.5.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.document +5 -0
- data/.gitignore +21 -0
- data/LICENSE +20 -0
- data/README.rdoc +17 -0
- data/Rakefile +53 -0
- data/VERSION +1 -0
- data/lib/pbxtra.rb +119 -0
- data/test/helper.rb +10 -0
- data/test/test_pbxtra.rb +4 -0
- metadata +90 -0
data/.document
ADDED
data/.gitignore
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 Carl Hicks
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
= pbxtra
|
2
|
+
|
3
|
+
A client library for communicating with Fonality's PBXtra Control Panel
|
4
|
+
|
5
|
+
== Note on Patches/Pull Requests
|
6
|
+
|
7
|
+
* Fork the project.
|
8
|
+
* Make your feature addition or bug fix.
|
9
|
+
* Add tests for it. This is important so I don't break it in a
|
10
|
+
future version unintentionally.
|
11
|
+
* Commit, do not mess with rakefile, version, or history.
|
12
|
+
(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)
|
13
|
+
* Send me a pull request. Bonus points for topic branches.
|
14
|
+
|
15
|
+
== Copyright
|
16
|
+
|
17
|
+
Copyright (c) 2010 Carl Hicks. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "pbxtra"
|
8
|
+
gem.summary = %Q{A client library for communicating with Fonality's PBXtra Control Panel}
|
9
|
+
gem.description = %Q{A client library for communicating with Fonality's PBXtra Control Panel}
|
10
|
+
gem.email = "carl.hicks@gmail.com"
|
11
|
+
gem.homepage = "http://github.com/chicks/pbxtra"
|
12
|
+
gem.authors = ["Carl Hicks"]
|
13
|
+
gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
|
14
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
15
|
+
end
|
16
|
+
Jeweler::GemcutterTasks.new
|
17
|
+
rescue LoadError
|
18
|
+
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
|
19
|
+
end
|
20
|
+
|
21
|
+
require 'rake/testtask'
|
22
|
+
Rake::TestTask.new(:test) do |test|
|
23
|
+
test.libs << 'lib' << 'test'
|
24
|
+
test.pattern = 'test/**/test_*.rb'
|
25
|
+
test.verbose = true
|
26
|
+
end
|
27
|
+
|
28
|
+
begin
|
29
|
+
require 'rcov/rcovtask'
|
30
|
+
Rcov::RcovTask.new do |test|
|
31
|
+
test.libs << 'test'
|
32
|
+
test.pattern = 'test/**/test_*.rb'
|
33
|
+
test.verbose = true
|
34
|
+
end
|
35
|
+
rescue LoadError
|
36
|
+
task :rcov do
|
37
|
+
abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
task :test => :check_dependencies
|
42
|
+
|
43
|
+
task :default => :test
|
44
|
+
|
45
|
+
require 'rake/rdoctask'
|
46
|
+
Rake::RDocTask.new do |rdoc|
|
47
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
48
|
+
|
49
|
+
rdoc.rdoc_dir = 'rdoc'
|
50
|
+
rdoc.title = "pbxtra #{version}"
|
51
|
+
rdoc.rdoc_files.include('README*')
|
52
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
53
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.5.1
|
data/lib/pbxtra.rb
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
#! /usr/bin/env ruby
|
2
|
+
|
3
|
+
require 'uri'
|
4
|
+
require 'net/https'
|
5
|
+
|
6
|
+
module PBXtra
|
7
|
+
|
8
|
+
# Raised when credentials are incorrect
|
9
|
+
class LoginError < RuntimeError
|
10
|
+
end
|
11
|
+
|
12
|
+
class Base
|
13
|
+
|
14
|
+
HOST = "cp-b.fonality.com"
|
15
|
+
URL = "/cpa.cgi"
|
16
|
+
attr :url, true
|
17
|
+
attr :user, false
|
18
|
+
attr :pass, false
|
19
|
+
attr :connection, true
|
20
|
+
attr :debug, true
|
21
|
+
attr :cookie, true
|
22
|
+
|
23
|
+
def initialize(user, pass, options={})
|
24
|
+
{:debug => false}.merge! options
|
25
|
+
@debug = options[:debug]
|
26
|
+
|
27
|
+
@user = user
|
28
|
+
@pass = pass
|
29
|
+
@url = URI.parse("https://" + HOST + URL)
|
30
|
+
|
31
|
+
# Handles http/https in url string
|
32
|
+
@ssl = false
|
33
|
+
@ssl = true if @url.scheme == "https"
|
34
|
+
|
35
|
+
@connection = false
|
36
|
+
login!
|
37
|
+
raise LoginError, "Invalid Username or Password" unless logged_in?
|
38
|
+
end
|
39
|
+
|
40
|
+
# Send a request to the CP. Send Auth information if we have it.
|
41
|
+
def request(method, parameters={})
|
42
|
+
login! unless logged_in?
|
43
|
+
|
44
|
+
# Sanitize and wrap our method + paramters
|
45
|
+
query = wrap(method, parameters)
|
46
|
+
@url.query = query
|
47
|
+
|
48
|
+
# Send the request
|
49
|
+
header = {'Cookie' => @cookie, 'Accept-Encoding' => ''}
|
50
|
+
request = Net::HTTP::Get.new(@url.path + @url.query, header)
|
51
|
+
response = @connection.request(request)
|
52
|
+
|
53
|
+
if @debug
|
54
|
+
puts "Path: #{@url.path}"
|
55
|
+
puts response
|
56
|
+
puts "\n"
|
57
|
+
end
|
58
|
+
|
59
|
+
case response
|
60
|
+
when Net::HTTPOK
|
61
|
+
raise EmptyResponse unless response.body
|
62
|
+
return response.body
|
63
|
+
when Net::HTTPUnauthorized
|
64
|
+
login!
|
65
|
+
request(method, parameters)
|
66
|
+
when Net::HTTPForbidden
|
67
|
+
raise LoginError, "Invalid Username or Password"
|
68
|
+
else raise UnhandledResponse, "Can't handle response #{response}"
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
protected
|
73
|
+
|
74
|
+
# Attempt authentication with PBXtra CP
|
75
|
+
def login!
|
76
|
+
connect! unless connected?
|
77
|
+
request = Net::HTTP::Post.new(@url.path)
|
78
|
+
request.body = "forcesec=&do=authenticate&username=#{@user}&password=#{@pass}"
|
79
|
+
response = @connection.request(request)
|
80
|
+
@cookie = response["Set-Cookie"].split(/;/)[0]
|
81
|
+
if @debug
|
82
|
+
puts "Cookie: #{@cookie}"
|
83
|
+
end
|
84
|
+
end
|
85
|
+
|
86
|
+
# Check to see if we are logged in
|
87
|
+
def logged_in?
|
88
|
+
return false unless @cookie
|
89
|
+
true
|
90
|
+
end
|
91
|
+
|
92
|
+
# Check to see if we have an HTTP/S Connection
|
93
|
+
def connected?
|
94
|
+
return false unless @connection
|
95
|
+
return false unless @connection.started?
|
96
|
+
true
|
97
|
+
end
|
98
|
+
|
99
|
+
# Connect to the remote system.
|
100
|
+
def connect!
|
101
|
+
@connection = Net::HTTP.new(@url.host, @url.port)
|
102
|
+
if @ssl
|
103
|
+
@connection.use_ssl = true
|
104
|
+
@connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
|
105
|
+
end
|
106
|
+
@connection.start
|
107
|
+
end
|
108
|
+
|
109
|
+
def wrap(method, parameters)
|
110
|
+
body = "?do=#{method}"
|
111
|
+
parameters.each_pair do |k,v|
|
112
|
+
body << "&" + k.to_s + "=" + v.to_s
|
113
|
+
end
|
114
|
+
body
|
115
|
+
end
|
116
|
+
|
117
|
+
end
|
118
|
+
|
119
|
+
end
|
data/test/helper.rb
ADDED
data/test/test_pbxtra.rb
ADDED
metadata
ADDED
@@ -0,0 +1,90 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: pbxtra
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
hash: 9
|
5
|
+
prerelease: false
|
6
|
+
segments:
|
7
|
+
- 0
|
8
|
+
- 5
|
9
|
+
- 1
|
10
|
+
version: 0.5.1
|
11
|
+
platform: ruby
|
12
|
+
authors:
|
13
|
+
- Carl Hicks
|
14
|
+
autorequire:
|
15
|
+
bindir: bin
|
16
|
+
cert_chain: []
|
17
|
+
|
18
|
+
date: 2010-07-23 00:00:00 -07:00
|
19
|
+
default_executable:
|
20
|
+
dependencies:
|
21
|
+
- !ruby/object:Gem::Dependency
|
22
|
+
name: thoughtbot-shoulda
|
23
|
+
prerelease: false
|
24
|
+
requirement: &id001 !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
hash: 3
|
30
|
+
segments:
|
31
|
+
- 0
|
32
|
+
version: "0"
|
33
|
+
type: :development
|
34
|
+
version_requirements: *id001
|
35
|
+
description: A client library for communicating with Fonality's PBXtra Control Panel
|
36
|
+
email: carl.hicks@gmail.com
|
37
|
+
executables: []
|
38
|
+
|
39
|
+
extensions: []
|
40
|
+
|
41
|
+
extra_rdoc_files:
|
42
|
+
- LICENSE
|
43
|
+
- README.rdoc
|
44
|
+
files:
|
45
|
+
- .document
|
46
|
+
- .gitignore
|
47
|
+
- LICENSE
|
48
|
+
- README.rdoc
|
49
|
+
- Rakefile
|
50
|
+
- VERSION
|
51
|
+
- lib/pbxtra.rb
|
52
|
+
- test/helper.rb
|
53
|
+
- test/test_pbxtra.rb
|
54
|
+
has_rdoc: true
|
55
|
+
homepage: http://github.com/chicks/pbxtra
|
56
|
+
licenses: []
|
57
|
+
|
58
|
+
post_install_message:
|
59
|
+
rdoc_options:
|
60
|
+
- --charset=UTF-8
|
61
|
+
require_paths:
|
62
|
+
- lib
|
63
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
64
|
+
none: false
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
hash: 3
|
69
|
+
segments:
|
70
|
+
- 0
|
71
|
+
version: "0"
|
72
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
73
|
+
none: false
|
74
|
+
requirements:
|
75
|
+
- - ">="
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
hash: 3
|
78
|
+
segments:
|
79
|
+
- 0
|
80
|
+
version: "0"
|
81
|
+
requirements: []
|
82
|
+
|
83
|
+
rubyforge_project:
|
84
|
+
rubygems_version: 1.3.7
|
85
|
+
signing_key:
|
86
|
+
specification_version: 3
|
87
|
+
summary: A client library for communicating with Fonality's PBXtra Control Panel
|
88
|
+
test_files:
|
89
|
+
- test/helper.rb
|
90
|
+
- test/test_pbxtra.rb
|