serviceproxy 0.1.5 → 0.2.0

data/LICENSE

@@ -2,7 +2,7 @@ LICENSE
 
 The MIT License
 
-Copyright (c) 2008 Jeremy Durham
+Copyright (c) 2008-2009 Jeremy Durham
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README

@@ -4,11 +4,6 @@ ServiceProxy is a lightweight SOAP library for Ruby.
 
 HOW IT WORKS
 
-Loading the library:
-
-require 'rubygems'
-require 'service_proxy/base'
-
 GENERATING A PROXY
 
 ServiceProxy comes with a simple generator to get started. It can be invoked
@@ -18,7 +13,11 @@ wsdl2proxy [wsdl]
 
 This will generate a file named default.rb, in the current directory. The class
 will be named GeneratedService, and will define build and parse methods for all
-of the available service methods.
+of the available service methods, as well as add some boilerplate code to inspect
+the available methods on the service. 
+
+ServiceProxy does not have any dependencies on Rails or other frameworks, nor does
+the generator.
 
 Please refer to the specs for extended usage examples.
 

data/bin/wsdl2proxy

@@ -31,11 +31,12 @@ proxy.service_methods.each do |service_method|
   
   def parse_#{underscore(service_method)}(response)
     Hpricot.XML(response.body)
-  end  
+  end
   EOS
 end
 template = File.read(template_filename)
 template.gsub!(/%name%/, output_klass_name)
 template.gsub!(/%body%/, output)
+template.gsub!(/%uri%/, ARGV[0])
 File.open(output_filename, 'w') { |f| f.puts template }
 puts "Generated proxy #{output_filename} - You can use the proxy by executing #{output_klass_name}.new('#{ARGV[0]}')"

data/lib/service_proxy/base.rb

@@ -1,6 +1,7 @@
 require 'net/http'
 require 'net/https'
 require 'uri'
+require 'open-uri'
 
 begin
   require 'nokogiri'
@@ -9,104 +10,77 @@ rescue LoadError
   puts "Could not load nokogiri or builder. Please make sure they are installed and in your $LOAD_PATH."
 end
 
+require File.dirname(__FILE__) + '/parser'
+
 module ServiceProxy
   class Base
-    VERSION = '0.1.4'
+    VERSION = '0.2.0'
   
-    attr_accessor :endpoint, :service_methods, :soap_actions, :service_uri, :http, :service_http, :uri, :debug, :wsdl, :target_namespace, :service_ports
+    attr_accessor :endpoint, :service_methods, :soap_actions, :http, 
+                  :uri, :debug, :wsdl, :target_namespace
 
     def initialize(endpoint)
       self.endpoint = endpoint
       self.setup
     end
-  
+
     def call_service(options)
       method   = options[:method]
       headers  = { 'content-type' => 'text/xml; charset=utf-8', 'SOAPAction' => self.soap_actions[method] }
       body     = build_request(method, options)
-      response = self.service_http.request_post(self.service_uri.path, body, headers)    
+      response = self.http.request_post(self.uri.path, body, headers)
       parse_response(method, response)
-    end  
+    end
 
+    def debug=(value)
+      @debug = value
+      self.http.set_debug_output(STDOUT) if value
+    end
+    
   protected
 
     def setup
-      self.soap_actions = {}
       self.service_methods = []
       setup_uri
-      self.http = setup_http(self.uri)
+      setup_http
       get_wsdl
       parse_wsdl
-      setup_namespace
-    end
-  
-    def service_uri
-      @service_uri ||= self.respond_to?(:service_port) ? self.service_port : self.uri
     end
   
-    def service_http
-      @service_http ||= unless self.service_uri == self.uri
-        local_http = self.setup_http(self.service_uri)
-        setup_https(local_http) if self.service_uri.scheme == 'https'
-        local_http
-      else
-        self.http
-      end
-    end
+  private
   
-    def setup_http(local_uri)
-      raise ArgumentError, "Endpoint URI must be valid" unless local_uri.scheme    
-      local_http = Net::HTTP.new(local_uri.host, local_uri.port)
-      setup_https(local_http) if local_uri.scheme == 'https'
-      local_http.set_debug_output(STDOUT) if self.debug
-      local_http.read_timeout = 5
-      local_http
+    def setup_http
+      raise ArgumentError, "Endpoint URI must be valid" unless self.uri.scheme
+      self.http ||= Net::HTTP.new(self.uri.host, self.uri.port)
+      setup_https if self.uri.scheme == 'https'
+      self.http.set_debug_output(STDOUT) if self.debug
+      self.http.read_timeout = 5
     end
 
-    def setup_https(local_http)
-      local_http.use_ssl = true
-      local_http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    def setup_https
+      self.http.use_ssl = true
+      self.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
     end
   
-  private
-  
     def setup_uri
       self.uri = URI.parse(self.endpoint)
     end
     
     def get_wsdl
       response = self.http.get("#{self.uri.path}?#{self.uri.query}")
-      self.wsdl = Nokogiri.XML(response.body)    
+      self.wsdl = response.body
     end
-  
+      
     def parse_wsdl
-      method_list = []    
-      self.wsdl.xpath('//*[name()="soap:operation"]').each do |operation|
-        operation_name = operation.parent.get_attribute('name')
-        method_list << operation_name
-        self.soap_actions[operation_name] = operation.get_attribute('soapAction')
-      end
-      self.wsdl.xpath('//*[name()="wsdl:operation"]').each do |wsdl_operation|
-        operation_name = wsdl_operation.get_attribute('name')
-        method_list << operation_name
-        self.soap_actions[operation_name] = wsdl_operation.xpath('//*[name()="wsdlsoap:operation"]').first.get_attribute('soapAction')
-      end
-      raise RuntimeError, "Could not parse WSDL" if method_list.empty?
-      self.service_methods = method_list.sort
-    
-      port_list = {}
-      self.wsdl.xpath('//wsdl:port', {"xmlns:wsdl" => 'http://schemas.xmlsoap.org/wsdl/'}).each do |port|
-        name = underscore(port['name'])
-        location = port.xpath('./*[@location]').first['location']
-        port_list[name] = location
-      end
-      self.service_ports = port_list
+      parser = ServiceProxy::Parser.new
+      sax_parser = Nokogiri::XML::SAX::Parser.new(parser)
+      sax_parser.parse(self.wsdl)
+      self.service_methods = parser.service_methods.sort
+      self.target_namespace = parser.target_namespace
+      self.soap_actions = parser.soap_actions
+      raise RuntimeError, "Could not parse WSDL" if self.service_methods.empty?
     end
   
-    def setup_namespace
-      self.target_namespace = self.wsdl.namespaces['xmlns:tns']
-    end
-
     def build_request(method, options)
       builder  = underscore("build_#{method}")    
       self.respond_to?(builder) ? self.send(builder, options).target! : 
@@ -126,7 +100,7 @@ module ServiceProxy
       xml = Builder::XmlMarkup.new
       xml.env(:Envelope, 'xmlns:xsd' => xsd, 'xmlns:env' => env, 'xmlns:xsi' => xsi) do
         xml.env(:Body) do
-          xml.__send__(options[:method].to_sym, "xmlns" => self.target_namespace) do        
+          xml.__send__(options[:method].to_sym, 'xmlns' => self.target_namespace) do
             yield xml if block_given?
           end
         end
@@ -136,16 +110,9 @@ module ServiceProxy
       
     def method_missing(method, *args)
       method_name = method.to_s
-      case method_name
-      when /_uri$/
-        sp_name = method_name.gsub(/_uri$/, '')
-        super unless self.service_ports.has_key?(sp_name)
-        URI.parse(self.service_ports[sp_name])
-      else
-        options = args.pop || {}
-        super unless self.service_methods.include?(method_name)
-        call_service(options.update(:method => method_name))
-      end
+      options = args.pop || {}
+      super unless self.service_methods.include?(method_name)
+      call_service(options.update(:method => method_name))
     end
   
     def underscore(camel_cased_word)

data/lib/service_proxy/parser.rb

@@ -0,0 +1,29 @@
+module ServiceProxy
+  class Parser < Nokogiri::XML::SAX::Document
+    attr_accessor :wsdl_namespace, :soap_namespace, :target_namespace, :service_methods, :soap_actions
+    
+    def initialize(*args)
+      self.service_methods = []
+      self.soap_actions = Hash.new('')
+      super
+    end
+    
+    def start_element_namespace(name, attributes, prefix, uri, namespace)      
+      case name
+        when 'definitions'
+          self.wsdl_namespace = prefix if uri == 'http://schemas.xmlsoap.org/wsdl/'
+          self.soap_namespace = prefix if uri == 'http://schemas.xmlsoap.org/wsdl/soap/'
+          attribute = attributes.find { |attribute| attribute.localname == 'targetNamespace' }
+          self.target_namespace = attribute.value if attribute
+        when "operation"
+          service_method = attributes.first.value if prefix == self.wsdl_namespace
+          soap_action = attributes.find { |attribute| attribute.localname == 'soapAction' }
+          self.soap_actions[self.service_methods.last] = soap_action.value if soap_action          
+          (self.service_methods << service_method unless self.service_methods.include?(service_method)) if service_method
+      end
+    end
+    
+    def end_element_namespace(name, prefix, uri)
+    end
+  end
+end

data/lib/templates/proxy.rbt

@@ -4,4 +4,7 @@ require 'hpricot'
 
 class %name% < ServiceProxy::Base
 %body%
-end
+end
+
+proxy = %name%.new('%uri%')
+p proxy.service_methods

data/spec/service_helper.rb

@@ -12,13 +12,7 @@ class ISBNService < ServiceProxy::Base
   def parse_is_valid_isbn13(response)
     xml = Hpricot.XML(response.body)
     xml.at("m:IsValidISBN13Result").inner_text == 'true' ? true : false
-  end
-  
-  def service_port
-    local_uri = URI.parse(self.isbn_service_soap_uri.to_s)
-    local_uri.path << "?dummy=1"
-    local_uri
-  end
+  end  
 end
 
 class SHAGeneratorService < ServiceProxy::Base
@@ -48,4 +42,17 @@ class InvalidSHAGeneratorService < ServiceProxy::Base
 end
 
 class EbayService < ServiceProxy::Base
+end
+
+class ZipcodeService < ServiceProxy::Base
+
+  def build_zip_code_world_us(options)
+    soap_envelope(options) do |xml|
+    end
+  end
+
+  def parse_zip_code_world_us(response)
+    Hpricot.XML(response.body)
+  end
+
 end

data/spec/service_proxy_spec.rb

@@ -53,23 +53,38 @@ describe ServiceProxy do
     end
   end
   
+  describe "connect to the Zipcode Service" do
+    before do
+      @proxy = ZipcodeService.new('http://ws.fraudlabs.com/zipcodeworldUS_webservice.asmx?wsdl')
+    end
+    
+    it "should be successful" do
+      @proxy.ZIPCodeWorld_US.should_not be_nil
+    end
+  end
+  
   describe "making a service call without a parse method" do
     before do
       @proxy = InvalidSHAGeneratorService.new('https://sec.neurofuzz-software.com/paos/genSSHA-SOAP.php?wsdl')
     end
   
+    it "should be SSL" do
+      @proxy.http.use_ssl.should be_true
+    end
+  
     it "should raise a no method error" do
       lambda { result = @proxy.genSSHA(:text => 'hello world', :hash_type => 'sha512') }.should raise_error(NoMethodError)
     end
   end
   
-  describe "using the #service_port hook" do
+  describe "debugging a service call" do
     before do
-      @proxy = ISBNService.new('http://webservices.daehosting.com/services/isbnservice.wso?WSDL')
+      @proxy = ZipcodeService.new('http://ws.fraudlabs.com/zipcodeworldUS_webservice.asmx?wsdl')
     end
     
-    it "should have the dummy query argument" do
-      @proxy.send(:service_uri).path.should match(/\?dummy=1/)
+    it "should set_debug_output on the HTTP connection" do
+      @proxy.http.should_receive(:set_debug_output)
+      @proxy.debug = true
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: serviceproxy
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jeremy Durham
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-23 00:00:00 -04:00
+date: 2009-10-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,6 +56,7 @@ files:
 - README
 - Rakefile
 - lib/service_proxy/base.rb
+- lib/service_proxy/parser.rb
 - lib/templates/proxy.rbt
 - spec/service_helper.rb
 - spec/service_proxy_spec.rb