uddi4r 0.7

data/lib/soap_builder.rb

@@ -0,0 +1,89 @@
+# uddi4r - UDDI Client for Ruby
+# http://rubyforge.org/projects/uddi4r/
+
+module Uddi4r
+  # Helper module to be mixed into Uddi4r::Connection
+  module SoapBuilder
+      # Create payload for given body (DOM element)
+    def create_payload(body)
+      content = REXML::Document.new()
+      content << REXML::XMLDecl.new("1.0", "utf-8")
+      envelope = REXML::Element.new("Envelope")
+      envelope.add_attribute("xmlns", "http://schemas.xmlsoap.org/soap/envelope/")
+      envelope << body
+      content << envelope
+      return content
+    end
+    
+    # Creates tModelBag with key
+    def create_t_model_bag(keys)
+      bags = []
+      keys.each do |key|
+        t_model_bag = REXML::Element.new("tModelBag")
+        t_model_bag.add_element(create_element("tModelKey", key))
+        bags << t_model_bag
+      end
+      return bags
+    end
+    
+    # Create element array
+    def create_elements(name, *values)
+      elems = []
+      values.each do |value|
+        elems << create_element(name, value)
+      end
+      return elems
+    end
+    
+    # Create an empty DOM element for SOAP Body
+    def create_body
+      body = REXML::Element.new("Body")
+    end
+
+    # Create a template operation element for given name
+    def create_uddi_operation(name, attribs={})
+      operation = REXML::Element.new(name)
+      # set UDDI attributes
+      operation.add_attribute("generic",@version)
+      operation.add_attribute("xmlns",@uddi_namespace)
+      operation.add_attribute("maxRows",@max_rows) if @max_rows      
+      # add passed attributes
+      attribs.each {|k,v| operation.add_attribute(k,v)}
+      return operation
+    end
+    
+    # Create a DOM element for given name
+    def create_element(name, value=nil, attributes={})
+      elm = REXML::Element.new(name)
+      elm.text = value if value
+      attributes.each { |k,v| elm.add_attribute(k, v) }
+      return elm
+    end
+    
+    # Create the operation for the SOAP body
+    # name:: Name of the element
+    # attribs:: Attributes for the element
+    # elements:: Sub elements varargs (items can be nil, Hash,
+    # Array of Hashes and REXML:Element)
+    def create_operation(name, attribs={}, *elements)
+      operation = create_uddi_operation(name, attribs)
+      elements.each do |elem|
+        add_element(operation, elem)
+      end
+      return operation
+    end
+  private    
+    def add_element(operation, element)
+      return unless element
+      if element.is_a? Hash
+        element.each do |key,value|
+          operation.add_element(create_element(key,value)) if value
+        end
+      elsif element.is_a? Array
+        element.each { |e| add_element(operation, e) }
+      else
+        operation.add_element(element)
+      end
+    end
+  end
+end

data/test/fixtures/business_service.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <soap:Body>
+    <businessList generic="2.0" operator="ms.com" truncated="true" xmlns="urn:uddi-org:api_v2">
+      <businessInfos>
+        <businessInfo businessKey="c13cc7b2-642d-41d0-b2dd-7bb531a18997">
+          <name xml:lang="en">Microsoft DRMS Dev</name>
+          <serviceInfos>
+            <serviceInfo serviceKey="6166f8b2-436d-4001-9f68-f37ff8b47ea3" businessKey="c13cc7b2-642d-41d0-b2dd-7bb531a18997">
+              <name xml:lang="en">Certification</name>
+            </serviceInfo>
+            <serviceInfo serviceKey="7ae6c133-4471-4deb-93a5-1158aaa826b8" businessKey="c13cc7b2-642d-41d0-b2dd-7bb531a18997">
+              <name xml:lang="en">Machine Activation</name>
+            </serviceInfo>
+            <serv serviceKey="52616482-653c-45f3-ae08-e4d4ca8b66c2" businessKey="c13cc7b2-642d-41d0-b2dd-7bb531a18997">
+              <name xml:lang="en">Server Enrollment</name>
+            </serviceInfo>
+            <serviceInfo serviceKey="597ea82b-f005-4972-812b-d8434e58be89" businessKey="c13cc7b2-642d-41d0-b2dd-7bb531a18997">
+              <name xml:lang="en">Licensing</name>
+            </serviceInfo>
+          </serviceInfos>
+        </businessInfo>
+        <businessInfo businessKey="0e3d9bb8-b765-4a68-a329-51548685fed3">
+          <name xml:lang="en">Microsoft DRMS Isv</name>
+          <serviceInfos>
+            <serviceInfo serviceKey="3b9b66a8-f19c-4ece-90f9-d484abbeb803" businessKey="0e3d9bb8-b765-4a68-a329-51548685fed3">
+              <name xml:lang="en">Machine Activation</name>
+            </serviceInfo>
+            <serviceInfo serviceKey="a8261df2-8829-49c6-a9b8-14a1d8a58f1e" businessKey="0e3d9bb8-b765-4a68-a329-51548685fed3">
+              <name xml:lang="en">Certification</name>
+            </serviceInfo>
+            <serviceInfo serviceKey="c4f18db0-9748-41bd-87f6-142640a1fd42" businessKey="0e3d9bb8-b765-4a68-a329-51548685fed3">
+              <name xml:lang="en">Server Enrollment</name>
+            </serviceInfo>
+          </serviceInfos>
+        </businessInfo>
+      </businessInfos>
+    </businessList>
+  </soap:Body>
+</soap:Envelope>

data/test/fixtures/test_uddi_servers.rb

@@ -0,0 +1,31 @@
+class UddiFixture
+  def self.method_missing(property)
+    return @Properties[property]
+  end
+end
+
+class MicrosoftUddi < UddiFixture
+  @Properties = {
+    :url=>"http://test.uddi.microsoft.com/inquire",
+    :opeartor=>"Microsoft",
+    :version=>"2.0",
+    :expected_business_names=>["Microsoft DRMS Dev", "Microsoft DRMS Isv"],
+    :business_name=>"Microsoft",
+    :business_key=>"c13cc7b2-642d-41d0-b2dd-7bb531a18997"
+  }
+end
+
+class XMethodsUddi < UddiFixture
+  @Properties = {
+    :url=>"http://uddi.xmethods.net/inquire",
+    :operator=>"XMethods",
+    :version=>"2.0",
+    :binding_key=>"9780B801-8CD0-EA03-D6C4-C211A1A46474",
+    :business_key=>"2BF938C6-BFFE-DA78-2AEA-78CA987D1C24",
+    :service_key=>"7CEAB5C2-D40E-1E0C-7942-99C64EF3C1ED",
+    :business_name=>"chaiwat",
+    :service_name=>"Temperature Convert",
+    :t_model_key=>"uuid:928A64AB-E277-32FA-0ABA-A28CE9E5E6A5",
+    :binding_key_2=>"39642DC0-BEB2-07A4-15C0-B3F087E064BC"
+  }  
+end

data/test/test_client.rb

@@ -0,0 +1,141 @@
+require "test/unit"
+require "lib/connection"
+require "lib/client"
+require "lib/models"
+require "test/fixtures/test_uddi_servers"
+
+# Following test run against private UDDI registries. Internet connection
+# is required. The tests will fail if the source registry is modified.
+# To resolve, run with debugging and adjust the expected responses.
+class TestClient < Test::Unit::TestCase
+  @@Report = false
+  @@Debug = false
+  @@UddiVersion = "2.0"
+
+  def uddi_for(fixture)
+    connection = Uddi4r::Connection.new(fixture.url, @@UddiVersion, @@Debug)
+    #connection = Uddi4r::Connection.new(nil, @@UddiVersion, @@Debug)
+    connection.max_rows = 2
+    uddi = Uddi4r::Client.new(connection) 
+    return uddi
+  end
+  
+  # Test finding a business by name and composed services  
+  def test_find_business
+    fix = MicrosoftUddi
+    uddi = uddi_for(fix)
+    business_list = uddi.find_business(:name=>fix.business_name, :business_key=>fix.business_key)
+    businesses = business_list.business_infos
+    assert_equal(2, businesses.size)
+    businesses.each do |biz| 
+      assert(fix.expected_business_names.include?(biz.name))
+      if @@Report
+        puts "Business #{biz.name}"
+        biz.service_infos.each { |svc| puts " - Service #{svc.name} - #{svc.service_key}" }
+      end
+    end
+  end
+  
+  # Follow a drill-down use-case for business > service > binding
+  def test_drill_down
+    fix = XMethodsUddi
+    uddi = uddi_for(fix)
+    biz_list = uddi.find_business(:name=>fix.business_name)
+    biz = biz_list.business_infos.first
+    assert_equal(fix.business_name, biz.name)
+    service = biz.service_infos.first
+    assert_equal(fix.service_name, service.name)
+    assert_not_nil(service.service_key)
+    binding = uddi.find_binding(:service_key=>service.service_key, 
+      :t_model_keys=>[fix.t_model_key])
+    assert_equal(fix.operator, binding.operator)
+    assert_not_nil(bt = binding.binding_template.first)
+    assert_equal("SOAP binding", bt.description)
+    assert_http_endpoint(bt.access_point)
+  end
+
+  # Find a service
+  def test_find_service
+    fix = XMethodsUddi
+    uddi = uddi_for(fix)
+    services = uddi.find_service(:name=>fix.service_name)
+    service = services.service_infos.first
+    assert_equal(fix.service_name, service.name)
+    assert_not_nil(service.service_key)
+  end
+  
+  # Find related businesses
+  def test_find_related_business
+    fix = MicrosoftUddi
+    uddi = uddi_for(fix)
+    biz = uddi.find_business(:name=>fix.business_name).business_infos.first
+    related_biz = uddi.find_related_businesses(:business_key=>fix.business_key)
+    assert_not_nil(related_biz)
+  end
+  
+  # Get binding detail
+  def test_get_binding_detail_single
+    fix = XMethodsUddi
+    uddi = uddi_for(fix)
+    binding = uddi.get_binding_detail(:binding_key=>fix.binding_key)
+    assert_not_nil(binding)
+    assert_http_endpoint(binding.binding_template.first.access_point)
+  end
+
+  # Get binding detail
+  def test_get_binding_detail_multi
+    fix = XMethodsUddi
+    uddi = uddi_for(fix)
+    bindings = uddi.get_binding_detail(:binding_keys=>[fix.binding_key, fix.binding_key_2])
+    assert_not_nil(bindings)
+    bts = bindings.binding_template
+    assert_http_endpoint(bts.first.access_point)
+  end
+  
+  # Get the business details and validate all sub elements
+  def test_get_business_detail
+    fix = XMethodsUddi
+    uddi = uddi_for(fix)    
+    assert_not_nil(bd = uddi.get_business_detail(:business_key=>fix.business_key))
+    assert_not_nil(be = bd.business_entity.first)
+    assert_equal(fix.business_name, be.name)
+    assert_not_nil(be.discovery_url)
+    assert_not_nil(bs = be.business_services.first)
+    assert_equal(fix.service_name, bs.name)
+    assert_not_nil(bt = bs.binding_templates.first)
+    assert_http_endpoint(bt.access_point)
+    assert_not_nil(tmi = bt.t_model_instance_details.first)
+    assert_not_nil(tmi.t_model_key)
+  end
+
+  # Get the tModel detail and validate all sub elements
+  def test_get_t_model_detail
+    fix = XMethodsUddi
+    uddi = uddi_for(fix)    
+    assert_not_nil(bd = uddi.get_t_model_detail(:t_model_key=>fix.t_model_key))
+    assert_not_nil(t_model = bd.t_model.first)
+    assert_equal(fix.service_name, t_model.name)
+    assert_not_nil(t_model.description)
+    assert_not_nil(c_bag = t_model.category_bag)
+    assert_equal("uddi-org:types", c_bag.keyed_reference.first.key_name)
+  end
+
+  # Get the service detail and validate all sub elements
+  def test_service_detail
+    fix = XMethodsUddi
+    uddi = uddi_for(fix)    
+    assert_not_nil(sd = uddi.get_service_detail(:service_key=>fix.service_key))
+    assert_not_nil(bs = sd.business_service.first)
+    assert_equal(fix.service_name, bs.name)
+    assert_not_nil(bt = bs.binding_templates.first)
+    assert_equal(fix.binding_key, bt.binding_key)
+    assert_equal(fix.t_model_key, bt.t_model_instance_details.first.t_model_key)
+  end
+
+  private
+  
+  def assert_http_endpoint(url)
+    assert_equal("http://", url[0..6])
+  end
+  
+end

data/test/test_connection.rb

@@ -0,0 +1,34 @@
+require "test/unit"
+require "lib/connection"
+
+class TestConnection < Test::Unit::TestCase
+  def setup
+    @TestUddiServer = "http://test.uddi.microsoft.com/inquire"
+    @conn = Uddi4r::Connection.new(@TestUddiServer)
+  end
+  
+  def test_connection
+    assert_equal("UDDI connection: #{@TestUddiServer}: 2.0 ns:urn:uddi-org:api_v2",
+      @conn.to_s())
+  end
+  
+  def test_create_body
+    body = @conn.create_body()
+    assert_equal("<Body/>", body.to_s())
+  end
+  
+  def test_create_operation
+    op = @conn.create_operation("op", {"maxRows"=>"5"})
+    assert_equal("<op maxRows='5' generic='2.0' xmlns='urn:uddi-org:api_v2'/>", op.to_s())
+  end
+  
+  def test_create_payload
+    body = @conn.create_body()
+    op = @conn.create_operation("op", {"maxRows"=>"5"})
+    body << op
+    pl = @conn.create_payload(body)
+    expected="<?xml version='1.0' encoding='UTF-8'?><Envelope xmlns='http://schemas.xmlsoap.org/soap/envelope/'><Body><op maxRows='5' generic='2.0' xmlns='urn:uddi-org:api_v2'/></Body></Envelope>"
+    assert_equal(expected, pl.to_s())    
+  end
+  
+end

data/test/test_model.rb

@@ -0,0 +1,34 @@
+require "test/unit"
+require "lib/models"
+
+# Test marshalling of UDDI XML objects to Ruby
+class TestModel < Test::Unit::TestCase
+  def test_business_info
+    xml = <<EOX
+<businessList generic="2.0" operator="ms.com" truncated="true" xmlns="urn:uddi-org:api_v2">
+      <businessInfos>
+        <businessInfo businessKey="c13cc7b2-642d-41d0-b2dd-7bb531a18997">
+          <name xml:lang="en">Microsoft DRMS Dev</name>
+          <serviceInfos>
+            <serviceInfo serviceKey="6166f8b2-436d-4001-9f68-f37ff8b47ea3" businessKey="c13cc7b2-642d-41d0-b2dd-7bb531a18997">
+              <name xml:lang="en">Certification</name>
+            </serviceInfo>
+            <serviceInfo serviceKey="7ae6c133-4471-4deb-93a5-1158aaa826b8" businessKey="c13cc7b2-642d-41d0-b2dd-7bb531a18997">
+              <name xml:lang="en">Machine Activation</name>
+            </serviceInfo>
+          </serviceInfos>
+        </businessInfo>
+      </businessInfos>
+</businessList>
+EOX
+    list = Uddi4r::BusinessList.parse(xml)
+    assert_equal("ms.com", list.operator)
+    biz = list.business_infos.first
+    assert_equal("Microsoft DRMS Dev", biz.name)
+    assert_equal(2, biz.service_infos.size)
+    expected_services = ["Certification", "Machine Activation"]
+    biz.service_infos.each do | svc |
+      expected_services.include? svc.name
+    end
+  end  
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: uddi4r
+version: !ruby/object:Gem::Version 
+  version: "0.7"
+date: 2006-07-16 00:00:00 -04:00
+summary: UDDI for Ruby
+require_paths: 
+- lib
+email: 
+homepage: http://uddi4r.rubyforge.org
+rubyforge_project: 
+description: Uddi4r is a Ruby library designed to make it easier for Ruby developers to work with XML. Using simple annotations, it enables Ruby classes to be mapped to XML. ROXML takes care of the marshalling and unmarshalling of mapped attributes so that developers can focus on building first-class Ruby classes. As a result, ROXML simplifies the development of  RESTful applications, Web Services, and XML-RPC.
+autorequire: uddi4r
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Zak Mandhro
+files: 
+- lib/models.rb
+- lib/soap_builder.rb
+- lib/client.rb
+- lib/connection.rb
+- README
+- test/test_model.rb
+- test/test_client.rb
+- test/fixtures
+- test/test_connection.rb
+- test/fixtures/business_service.xml
+- test/fixtures/test_uddi_servers.rb
+- doc/created.rid
+- doc/rdoc-style.css
+- doc/files
+- doc/classes
+- doc/fr_file_index.html
+- doc/fr_class_index.html
+- doc/fr_method_index.html
+- doc/index.html
+- doc/files/README.html
+- doc/files/lib
+- doc/files/lib/models_rb.html
+- doc/files/lib/soap_builder_rb.html
+- doc/files/lib/client_rb.html
+- doc/files/lib/connection_rb.html
+- doc/classes/Uddi4r.html
+- doc/classes/Uddi4r
+- doc/classes/Uddi4r/SoapBuilder.html
+- doc/classes/Uddi4r/BindingDetail.html
+- doc/classes/Uddi4r/ServiceList.html
+- doc/classes/Uddi4r/BusinessList.html
+- doc/classes/Uddi4r/FindQualifiers.html
+- doc/classes/Uddi4r/IdentifierBag.html
+- doc/classes/Uddi4r/OverviewDoc.html
+- doc/classes/Uddi4r/KeyedReference.html
+- doc/classes/Uddi4r/BindingTemplate.html
+- doc/classes/Uddi4r/TModelInstanceInfo.html
+- doc/classes/Uddi4r/Model.html
+- doc/classes/Uddi4r/BusinessEntity.html
+- doc/classes/Uddi4r/BusinessService.html
+- doc/classes/Uddi4r/BusinessInfo.html
+- doc/classes/Uddi4r/ServiceInfo.html
+- doc/classes/Uddi4r/Client.html
+- doc/classes/Uddi4r/RelatedBusinessesList.html
+- doc/classes/Uddi4r/ServiceDetail.html
+- doc/classes/Uddi4r/TModelDetail.html
+- doc/classes/Uddi4r/Connection.html
+- doc/classes/Uddi4r/TModelBag.html
+- doc/classes/Uddi4r/DiscoveryURLs.html
+- doc/classes/Uddi4r/TModel.html
+- doc/classes/Uddi4r/CategoryBag.html
+- doc/classes/Uddi4r/BusinessDetail.html
+test_files: 
+- test/test_client.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: 
+- roxml
+dependencies: []
+