xcapclient 1.0

data/test/PRES_RULES_EXAMPLE.xml

@@ -0,0 +1,49 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<cp:ruleset xmlns:pr="urn:ietf:params:xml:ns:pres-rules" xmlns:cp="urn:ietf:params:xml:ns:common-policy">
+	<cp:rule id="pres_whitelist">
+		<cp:conditions>
+			<cp:identity>
+				<cp:one id="sip:alice@example.org"/>
+				<cp:one id="sip:bob@example.org"/>
+				<cp:one id="sip:carol@example2.net"/>
+			</cp:identity>
+		</cp:conditions>
+		<cp:actions>
+			<pr:sub-handling>allow</pr:sub-handling>
+		</cp:actions>
+		<cp:transformations>
+			<pr:provide-services>
+				<pr:all-services/>
+			</pr:provide-services>
+			<pr:provide-persons>
+				<pr:all-persons/>
+			</pr:provide-persons>
+			<pr:provide-devices>
+				<pr:all-devices/>
+			</pr:provide-devices>
+			<pr:provide-all-attributes/>
+		</cp:transformations>
+	</cp:rule>
+	<cp:rule id="pres_blacklist">
+		<cp:conditions>
+			<cp:identity>
+				<cp:one id="sip:bill@microsoft.com"/>
+			</cp:identity>
+		</cp:conditions>
+		<cp:actions>
+			<pr:sub-handling>block</pr:sub-handling>
+		</cp:actions>
+		<cp:transformations/>
+	</cp:rule>
+	<cp:rule id="pres_polite_blacklist">
+		<cp:conditions>
+			<cp:identity>
+				<cp:one id="sip:steve@apple.com"/>
+			</cp:identity>
+		</cp:conditions>
+		<cp:actions>
+			<pr:sub-handling>polite-block</pr:sub-handling>
+		</cp:actions>
+		<cp:transformations/>
+	</cp:rule>
+</cp:ruleset>

data/test/test_unit_01.rb

@@ -0,0 +1,352 @@
+#!/usr/bin/env ruby
+
+
+# IMPORTANT: Configure these values with your own setting.
+#
+XCAP_ROOT = "https://xcap.example.org/xcap-root"
+USER = "sip:user@example.org"
+AUTH_USER = "user"
+PASSWORD = "xxxx"
+SSL_VERIFY_CERT = false
+
+
+# Let's check that the user has customized the above settings.
+if USER == "sip:user@example.org"
+	STDERR.puts "ERROR: You must configure the settings with your own values. Edit the top lines of this script."
+	exit 1
+end
+
+
+require "test/unit"
+require "rubygems"
+require "xcapclient"
+
+
+include XCAPClient
+
+
+# This test unit checks XCAPClient's and XCAP server's behaviour according to specifications in RFC 4825.
+# It's focused on OpenXCAP[http://www.openxcap.org] server. In fact, some tests fail due to known bugs in OpenXCAP.
+#
+class TestXCAPClient < Test::Unit::TestCase
+	
+	
+	PRES_RULES = File.new(File.join(File.dirname(__FILE__), "PRES_RULES_EXAMPLE.xml")).read
+	NS = {"pr"=>"urn:ietf:params:xml:ns:pres-rules", "cp"=>"urn:ietf:params:xml:ns:common-policy"}
+	
+	
+	def setup
+		
+		xcap_conf = {
+			:xcap_root => XCAP_ROOT,
+			:user => USER,
+			:auth_user => AUTH_USER,
+			:password => PASSWORD,
+			:ssl_verify_cert => SSL_VERIFY_CERT
+		}
+		
+		xcap_apps = {
+			"pres-rules" => {
+				:xmlns => "urn:ietf:params:xml:ns:pres-rules",
+				:mime_type => "application/auth-policy+xml",
+				:document_name => "pres-rules"
+			}
+		}
+		
+		@client = Client.new(xcap_conf, xcap_apps)
+		@client.application("pres-rules").document.plain = PRES_RULES
+		
+		@doc = @client.application("pres-rules").document
+		
+		reset_document
+		
+	end
+	
+	
+	def teardown
+		reset_document
+	end
+	
+	
+	def test_01_get
+		show "Fetching the document (correct ETag) => 304"
+		begin
+			assert @client.get("pres-rules")
+		rescue => e
+			assert_equal( HTTPDocumentNotModified, e.class )
+		else
+			should_fail
+		end
+	end
+	
+	
+	def test_02_get
+		show "Fetching the document (wrong ETag) => 200"
+		@doc.etag = "wrongETag"
+		assert @client.get("pres-rules")
+	end
+	
+	
+	def test_03_put
+		show "Replace the document (correct ETag)=> 2XX"
+		assert @client.put("pres-rules")
+	end
+	
+	
+	def test_04_put
+		show "Replace the document (wrong ETag) => 412"
+		begin
+			@doc.etag = "wrongETag"
+			@client.put("pres-rules")
+		rescue => e
+			assert_equal( HTTPNoMatchingETag, e.class )
+		else
+			should_fail
+		end
+	end
+	
+	
+	def test_05_put
+		show "Replace the document (no ETag) => 200"
+		assert @client.put("pres-rules", nil, check_etag=false)
+	end
+	
+	
+	def test_06_delete
+		show "Deleting the document (correct ETag) => 200"
+		assert @client.delete("pres-rules")
+	end
+	
+	
+	def test_07_delete
+		show "Deleting a non existing document (no ETag) => 404"
+		@client.delete("pres-rules")
+		begin
+			@client.delete("pres-rules")
+		rescue => e
+			assert_equal( HTTPDocumentNotFound, e.class )
+		else
+			should_fail
+		end
+	end
+	
+	
+	def test_08_delete
+		show "Deleting the document (wrong ETag) => 412"
+		begin
+			@doc.etag = "wrongETag"
+			@client.delete("pres-rules")
+		rescue => e
+			assert_equal( HTTPNoMatchingETag, e.class )
+		else
+			should_fail
+		end
+	end
+	
+	
+	def test_09_delete
+		show "Deleting the document (no ETag) => 200"
+		assert @client.delete("pres-rules", nil, check_etag=false)
+	end
+	
+	
+	def test_10_get_element
+		show "Fetching a node (no ETag) => 200"
+		assert @client.get_element("pres-rules", nil,
+			'/cp:ruleset/cp:rule[@id="pres_whitelist"]/cp:conditions/cp:identity/cp:one[@id="sip:bob@example.org"]',
+			NS,
+			check_etag=false)
+	end
+	
+	
+	def test_11_get_element
+		show "Fetching a node (correct ETag) => 304"
+		begin
+			@client.get_element("pres-rules", nil,
+				'/cp:ruleset/cp:rule[@id="pres_whitelist"]/cp:conditions/cp:identity/cp:one[@id="sip:alice@example.org"]',
+				NS,
+				check_etag=true)
+		rescue => e
+			assert_equal( HTTPDocumentNotModified, e.class )
+		else
+			should_fail
+		end
+	end
+	
+	
+	# NOTE: OpenXCAP doesn't implement fetching element attributes.
+	#   BUG in OpenXCAP: http://openxcap.org/ticket/122
+	def test_12_get_element
+		show "Fetching an attribute (no ETag) => 200 (fails in OpenXCAP, bug http://openxcap.org/ticket/122)"
+		assert @client.get_element("pres-rules", nil,
+			'/cp:ruleset/cp:rule[@id="pres_whitelist"]/cp:conditions/cp:identity/cp:one[@id="sip:alice@example.org"]/@id',
+			NS,
+			check_etag=false)
+	end
+	
+	
+	def test_13_put_element
+		show "Creating a node (no ETag) => 201"
+		assert @client.put_element("pres-rules", nil,
+			'/cp:ruleset/cp:rule[@id="pres_whitelist"]/cp:conditions/cp:identity/cp:one[@id="sip:new-1@new.net"]',
+			'<cp:one id="sip:new-1@new.net"/>',
+			NS,
+			check_etag=false)
+	end
+	
+	
+	def test_14_put_element
+		show "Creating a node (wrong ETag) => 412"
+		begin
+			@doc.etag = "wrongETag"
+			@client.put_element("pres-rules", nil,
+				'/cp:ruleset/cp:rule[@id="pres_whitelist"]/cp:condition/cp:identity/cp:one[@id="sip:new-2@new.net"]',
+				'<cp:one id="sip:new-2@new.net"/>',
+				NS,
+				check_etag=true)
+		rescue => e
+			assert_equal( HTTPNoMatchingETag, e.class )
+		else
+			should_fail
+		end
+	end
+	
+	
+	def test_15_put_element
+		show "Creating a node in wrong position => 409"
+		begin
+			@client.put_element("pres-rules", nil,
+				'/cp:ruleset/cp:rule[@id="non_existing"]/cp:condition/cp:identity/cp:one[@id="sip:new-3@new.net"]',
+				'<cp:one id="sip:new-3@new.net"/>',
+				NS,
+				check_etag=false)
+		rescue => e
+			assert_equal( HTTPConflictError, e.class )
+		else
+			should_fail
+		end
+	end
+	
+	
+	def test_16_put_element
+		show "Creating a node using different NS prefixes than the used in the server document (no ETag) => 409/500"
+		begin
+			@client.put_element("pres-rules", nil,
+				'/ccpp:ruleset/ccpp:rule[@id="pres_whitelist"]/ccpp:conditions/ccpp:identity/ccpp:one[@id="sip:new-4@new.net"]',
+				'<ccpp:one id="sip:new-4@new.net"/>',
+				{"pprr"=>"urn:ietf:params:xml:ns:pres-rules", "ccpp"=>"urn:ietf:params:xml:ns:common-policy"},
+				check_etag=false)
+		rescue => e
+			assert_equal_options( [ HTTPServerError, HTTPConflictError ], e.class )
+		else
+			should_fail
+		end
+	end
+	
+	
+	# NOTE: This should fail since the selector doesn't match an unique node, but OpenXCAP allows it.
+	#   BUG in OpenXCAP: http://openxcap.org/ticket/123
+	def test_17_put_element
+		show "Creating a node using using a non unique selector (no ETag) => 409 (fails in OpenXCAP, bug http://openxcap.org/ticket/123)"
+		begin
+			@client.put_element("pres-rules", nil,
+				'/cp:ruleset/cp:rule/cp:conditions/cp:identity/cp:one[@id="sip:new-5@new.net"]',
+				'<cp:one id="sip:new-5@new.net"/>',
+				NS,
+				check_etag=false)
+		rescue
+			assert_equal( HTTPConflictError, e.class )
+		else
+			should_fail
+		end
+	end
+	
+	
+	def test_18_delete_element
+		show "Deleting an element (no ETag) => 200"
+		assert @client.delete_element("pres-rules", nil,
+			'/cp:ruleset/cp:rule[@id="pres_whitelist"]/cp:conditions/cp:identity/cp:one[@id="sip:bob@example.org"]',
+			NS,
+			check_etag=false)
+	end
+	
+	
+	def test_19_delete_element
+		show "Deleting an element (wrong ETag) => 412"
+		begin
+			@doc.etag = "wrongETag"
+			@client.delete_element("pres-rules", nil,
+				'/cp:ruleset/cp:rule[@id="pres_whitelist"]/cp:condition/cp:identity/cp:one[@id="sip:bob@example.org"]',
+				NS,
+				check_etag=true)
+		rescue => e
+			assert_equal( HTTPNoMatchingETag, e.class )
+		else
+			should_fail
+		end
+	end
+	
+	
+	def test_20_delete_element
+		show "Deleting a no existing element (correct ETag) => 404"
+		@client.delete_element("pres-rules", nil,
+			'/cp:ruleset/cp:rule[@id="pres_whitelist"]/cp:conditions/cp:identity/cp:one[@id="sip:alice@example.org"]',
+			NS)
+		begin
+			@client.delete_element("pres-rules", nil,
+				'/cp:ruleset/cp:rule[@id="pres_whitelist"]/cp:conditions/cp:identity/cp:one[@id="sip:alice@example.org"]',
+				NS)
+		rescue => e
+			assert_equal( HTTPDocumentNotFound, e.class )
+		else
+			should_fail
+		end
+	end
+	
+	
+	# NOTE: OpenXCAP doesn't implement fetching namespaces.
+	#   BUG in OpenXCAP: http://openxcap.org/ticket/124
+	def test_21_get_element_namespaces
+		show "Fetching the namespaces associated to a document node => 200 (fails in OpenXCAP, bug http://openxcap.org/ticket/124)"
+		assert @client.get_element_namespaces("pres-rules", nil,
+				'/ccpp:ruleset/ccpp:rule[@id="pres_whitelist"]/ccpp:conditions/ccpp:identity',
+				{"ccpp"=>"urn:ietf:params:xml:ns:common-policy"},
+				check_etag=false)
+		assert_equal( @client.application("pres-rules").document.last_response.header["Content-Type"], "application/xcap-ns+xml" )
+	end
+	
+	
+	def test_22_get_xcap_auids
+		show "Fetching the XCAP server available 'auids' => 200"
+		assert @client.get_xcap_auids
+	end
+	
+	
+	def reset_document
+		@doc.plain = PRES_RULES
+		@doc.etag = nil
+		@client.put("pres-rules", nil, check_etag=false)  # Upload without cheking ETag.
+	end
+	
+	
+	def show(text)
+		puts "\n\n[#{name}] #{text}"
+	end
+	
+	
+	def should_fail
+		raise RuntimeError, "It should fail but didn't"
+	end
+	
+	
+	def assert_false(object, message="")
+		assert_equal(object, false, message)
+	end
+	
+	
+	def assert_equal_options(options, element)
+		assert options.include?(element)
+	end
+	
+	
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: xcapclient
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- "I\xC3\xB1aki Baz Castillo"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-31 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: XCAP (RFC 4825) is a protocol on top of HTTP which allows a client (usually a VoIP/SIP device) to manipulate the contents of Presence Information Data Format (PIDF) based presence documents. These documents are stored in a server in XML format.  Ruby xcapclient library implements the XCAP protocol in client side, allowing the applications to get, store, modify and delete XML documents in the server.'
+email: ibc@aliax.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- ERRORS.rdoc
+- LICENSE.txt
+- test/PRES_RULES_EXAMPLE.xml
+files: 
+- LICENSE.txt
+- lib/xcapclient/client.rb
+- lib/xcapclient.rb
+- lib/xcapclient/errors.rb
+- lib/xcapclient/application.rb
+- lib/xcapclient/document.rb
+- test/PRES_RULES_EXAMPLE.xml
+- README.rdoc
+- ERRORS.rdoc
+has_rdoc: true
+homepage: http://dev.sipdoc.net/projects/ruby-xcap-client/wiki/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.1
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: xcapclient
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: XCAP client library
+test_files: 
+- test/test_unit_01.rb