directories_interface 0.0.1

data/lib/directories_interface.rb

@@ -0,0 +1,7 @@
+require "savon"
+require "rubygems"
+require "Nokogiri"
+require "directories_interface/version"
+require "directories_interface/xml_parser"
+require "directories_interface/communication"
+require "directories_interface/directories_interface_wrapper"

data/lib/directories_interface/communication.rb

@@ -0,0 +1,11 @@
+module DirectoriesInterface
+
+  class Communication
+    attr_accessor :type, :number
+
+    def to_s
+      "type => #{type}, number => #{number}"
+    end
+  end
+
+end

data/lib/directories_interface/directories_interface_wrapper.rb

@@ -0,0 +1,59 @@
+module DirectoriesInterface
+
+  class DirectoriesInterfaceWrapper
+
+    def initialize
+      # SETUP WEB SERVICES
+      @login = Savon::Client.new do
+        wsdl.document = "https://secure.directories.ch/administration/v4/security.asmx?WSDL"
+      end
+
+      @client = Savon::Client.new do
+        wsdl.document = "http://service.directories.ch/search/v4/searchaddress.asmx?WSDL"
+      end
+
+      @login.http.auth.ssl.verify_mode = :none
+    end
+
+    #returns a sessionID
+    def login(username,password,service_id)
+      soap_login_response = @login.request "Login", :xmlns => "urn:directories/administration/v4/security" do
+        http.headers["SOAPAction"] = '"urn:directories/administration/v4/security/Login"'
+        soap.body = '<loginParam>' + XmlParser.generate_login_xml(:username=> username, :password=>password, :service_id=>service_id)+'</loginParam>'
+      end
+      login_response = XmlParser.extract_login_response(soap_login_response.to_hash[:login_response][:login_result])
+      XmlParser.extract_session_id(login_response) if result_available login_response
+    end
+
+    #returns a search result as XML. auth = [ServiceID,SessionID], person = [nachname,vorname,location]
+    def search_address(service_id,session_id, person)
+      result = @client.request "SearchAddress", :xmlns =>"urn:directories/search/v4/searchaddress" do
+        http.headers["SOAPAction"] = '"urn:directories/search/v4/searchaddress/SearchAddress"'
+        soap.body = "<addressParam>" + XmlParser.generate_search_xml(service_id,session_id,person) + "</addressParam>"
+      end
+
+      numbers = nil
+
+      if result.success?
+        result_xml = XmlParser.extract_search_result(result.to_hash[:search_address_response][:search_address_result])
+        if result_available result_xml
+          if XmlParser.count_matches(result_xml) == "1"
+            numbers = XmlParser.extract_services(result_xml)
+          end
+        end
+      end
+      numbers
+    end
+
+    def result_available(result_xml)
+      error_code = XmlParser.extract_error_code(result_xml)
+      case error_code
+        when "200" then false
+        when "0" then true
+        else raise "Service has error: #{error_code}"
+      end
+    end
+
+  end
+
+end

data/lib/directories_interface/version.rb

@@ -0,0 +1,3 @@
+module DirectoriesInterface
+  VERSION = "0.0.1"
+end

data/lib/directories_interface/xml_parser.rb

@@ -0,0 +1,67 @@
+module DirectoriesInterface
+
+  class XmlParser
+    def initialize
+
+    end
+
+    def self.generate_login_xml(attr)
+      res=Nokogiri::XML::Builder.new do  |xml|
+        xml.LoginParam(:ServiceId=>attr[:service_id], :UserName=>attr[:username], :Password=>attr[:password])
+      end
+      res.to_xml.to_s.gsub(/\n/,"").encode(:xml => :text)
+
+    end
+
+    def self.generate_search_xml(service_id,session_id,person)
+      res = Nokogiri::XML::Builder.new do |xml|
+        xml.AddressParam {
+          xml.Authentication(:ServiceId=>service_id, :SessionId=>session_id)
+          xml.Paging(:StartAtIndex=>"1", :FinishAtIndex=>"5")
+          xml.LastName(:Value=>person[:nachname], :Phonetic=>"1", :PrecisionCode=>"FIELDGROUP")
+          xml.FirstName(:Value=>person[:vorname], :Phonetic=>"1", :PrecisionCode=>"FIELDGROUP")
+          xml.StreetHouseNo(:Value=>person[:address], :Phonetic=>"1") if person.has_key?(:address)
+          xml.Location(:Value=>person[:location], :Phonetic=>"0")
+          xml.TypeCode "ALL"
+        }
+      end
+      res.to_xml.to_s.gsub(/\n/,"").encode(:xml => :text)
+
+    end
+
+    def self.extract_login_response(soap_login_response)
+      Nokogiri::XML(soap_login_response)
+    end
+
+    def self.extract_session_id(login_response)
+      login_response.xpath("//@SessionId").to_s
+    end
+
+    def self.extract_search_result(res)
+      Nokogiri::XML(res)
+    end
+
+    def self.extract_error_code(xml_res)
+      xml_res.xpath("//@ErrorCode").to_s
+    end
+
+    def self.count_matches(xml_res)
+      xml_res.xpath("//@MatchedEntries").to_s
+    end
+
+    #take the (unique)search result and returns an array of communications
+    def self.extract_services(xml_res)
+      services = xml_res.xpath("//Service[@TypeGrpCode='TEL' or @TypeGrpCode='NATEL' or @TypeGrpCode='FAX']")
+      result = Array.new
+      services.each do |node|
+        item = Communication.new
+        item.type = node.xpath("@TypeGrpCode").to_s
+        item.number = node.xpath("@Value").to_s
+        result << item
+      end
+      result
+    end
+  end
+
+end
+

data/spec/directories_interface/directories_interface_wrapper_spec.rb

@@ -0,0 +1,37 @@
+
+require "spec_helper"
+
+module DirectoriesInterface
+  describe DirectoriesInterfaceWrapper do
+    before(:each) do
+      @username = ""
+      @password = ""
+      @service_id = ""
+    end
+
+    describe "#login" do
+      it "returns a sessionID" do
+        dir1 = DirectoriesInterfaceWrapper.new
+        @session_id = dir1.login(@username, @password, @service_id)
+        puts @session_id
+        @session_id.should_not be_nil
+      end
+    end
+
+    describe "#search_address" do
+      before(:each) do
+        @dir1 = DirectoriesInterfaceWrapper.new
+        @session_id = @dir1.login(@username, @password, @service_id)
+      end
+
+      it "if exactly one match found, returns a list of numbers" do
+        person = {:vorname=>"Daniele", :nachname=>"Pestalozzi", :location=>"Novazzano", :address=>"via al Loi"}
+        result = @dir1.search_address(@service_id, @session_id,person)
+        puts result
+        result.should_not be_nil
+        result.length.should == 2
+      end
+    end
+  end
+
+end

data/spec/directories_interface/xml_parser_spec.rb

@@ -0,0 +1,12 @@
+require "rspec"
+
+module DirectoriesInterface
+  describe XmlParser do
+
+    it "should do something" do
+
+      #To change this template use File | Settings | File Templates.
+      true.should == false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'directories_interface'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: directories_interface
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nicola Pestalozzi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: certified
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: First version of the interface. Searches for a person and returns an
+  array of phone numbers
+email:
+- np@impac.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/directories_interface/communication.rb
+- lib/directories_interface/directories_interface_wrapper.rb
+- lib/directories_interface/version.rb
+- lib/directories_interface/xml_parser.rb
+- lib/directories_interface.rb
+- spec/directories_interface/directories_interface_wrapper_spec.rb
+- spec/directories_interface/xml_parser_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: directories_interface
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Interface to Directories.ch
+test_files:
+- spec/directories_interface/directories_interface_wrapper_spec.rb
+- spec/directories_interface/xml_parser_spec.rb
+- spec/spec_helper.rb