savon 0.9.14 → 1.0.0

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.0.0 (2012-06-09)
+
+* Fix: `Savon.client` didn't pass the optional block.
+
+* Improvement: [#291](https://github.com/rubiii/savon/issues/291) changed the `:soap_request` hook to act
+  like an around filter. The hook now receives a callback block to execute the SOAP call and can return
+  the result of the callback to continue the request. It can also not call the callback block and return
+  some `HTTPI::Response` to mock the SOAP request.
+
+  As this change affects `savon_spec`, you need to update `savon_spec` to v1.3.0.
+
 ## 0.9.14 (2012-06-07)
 
 * Fix: [#292](https://github.com/rubiii/savon/issues/292) again

data/README.md

@@ -1,4 +1,4 @@
-Savon [![Build Status](https://secure.travis-ci.org/rubiii/savon.png)](http://travis-ci.org/rubiii/savon)
+Savon [![Build Status](https://secure.travis-ci.org/rubiii/savon.png?branch=master)](http://travis-ci.org/rubiii/savon)
 =====
 
 Heavy metal Ruby SOAP client

data/lib/savon.rb

@@ -6,8 +6,8 @@ require "savon/model"
 module Savon
   extend self
 
-  def client(*args)
-    Client.new(*args)
+  def client(*args, &block)
+    Client.new(*args, &block)
   end
 
   def configure

data/lib/savon/core_ext/string.rb

@@ -4,17 +4,24 @@ module Savon
   module CoreExt
     module String
 
-      # Returns the String in snake_case.
-      def snakecase
-        str = dup
-        str.gsub! /::/, '/'
-        str.gsub! /([A-Z]+)([A-Z][a-z])/, '\1_\2'
-        str.gsub! /([a-z\d])([A-Z])/, '\1_\2'
-        str.tr! ".", "_"
-        str.tr! "-", "_"
-        str.downcase!
-        str
-      end unless method_defined?(:snakecase)
+      def self.included(base)
+        unless "savon".respond_to?(:snakecase)
+          base.send(:include, Extension)
+        end
+      end
+
+      module Extension
+        def snakecase
+          str = dup
+          str.gsub! /::/, '/'
+          str.gsub! /([A-Z]+)([A-Z][a-z])/, '\1_\2'
+          str.gsub! /([a-z\d])([A-Z])/, '\1_\2'
+          str.tr! ".", "_"
+          str.tr! "-", "_"
+          str.downcase!
+          str
+        end
+      end
 
     end
   end

data/lib/savon/hooks/group.rb

@@ -9,14 +9,18 @@ module Savon
     class Group
 
       # Accepts an Array of +hooks+ to start with.
-      def initialize(hooks = nil)
-        self.hooks = hooks
+      def initialize(hooks = [])
+        @hooks = hooks
       end
 
-      attr_writer :hooks
+      # Returns whether this group contains hooks.
+      def empty?
+        hooks.empty?
+      end
 
-      def hooks
-        @hooks ||= []
+      # Returns the number of hooks in this group.
+      def count
+        hooks.count
       end
 
       # Adds a new hook.
@@ -25,14 +29,21 @@ module Savon
       end
 
       # Removes hooks matching the given +ids+.
-      def reject!(*ids)
+      def reject(*ids)
         ids = ids.flatten
         hooks.reject! { |hook| ids.include? hook.id }
       end
 
-      # Returns a new group for a given +hook+.
-      def select(hook)
-        Group.new hooks.select { |h| h.hook == hook }
+      # Fire a given +hook+ with any given +args+.
+      def fire(hook, *args, &callback)
+        callable = select(hook)
+
+        if callable.empty?
+          callback.call
+        else
+          args.unshift(callback) if callback
+          callable.call(*args)
+        end
       end
 
       # Calls the hooks with the given +args+ and returns the
@@ -41,6 +52,17 @@ module Savon
         hooks.inject(nil) { |memo, hook| hook.call(*args) }
       end
 
+      private
+
+      def hooks
+        @hooks ||= []
+      end
+
+      # Returns a new group for a given +hook+.
+      def select(hook)
+        Group.new hooks.select { |h| h.hook == hook }
+      end
+
     end
   end
 end

data/lib/savon/hooks/hook.rb

@@ -8,17 +8,42 @@ module Savon
 
       HOOKS = [
 
-        # Replaces the POST request executed to call a service.
+        # :soap_request
+        #
+        # Around filter wrapping the POST request executed to call a SOAP service.
         # See: Savon::SOAP::Request#response
         #
-        # Receives the <tt>Savon::SOAP::Request</tt> and is expected to return an <tt>HTTPI::Response</tt>.
-        # It can change the request and return something falsy to still execute the POST request.
+        # Arguments
+        #
+        #   [callback] A block to execute the SOAP request
+        #   [request]  The current <tt>Savon::SOAP::Request</tt>
+        #
+        # Examples
+        #
+        #   Log the time before and after the SOAP call:
+        #
+        #     Savon.config.hooks.define(:my_hook, :soap_request) do |callback, request|
+        #       Timer.log(:start, Time.now)
+        #       response = callback.call
+        #       Timer.log(:end, Time.now)
+        #       response
+        #     end
+        #
+        #   Replace the SOAP call and return a custom response:
+        #
+        #     Savon.config.hooks.define(:mock_hook, :soap_request) do |_, request|
+        #       HTTPI::Response.new(200, {}, "")
+        #     end
         :soap_request
 
       ]
 
       # Expects an +id+, the name of the +hook+ to use and a +block+ to be called.
       def initialize(id, hook, &block)
+        unless HOOKS.include?(hook)
+          raise ArgumentError, "No such hook: #{hook}. Expected one of: #{HOOKS.join(', ')}"
+        end
+
         self.id = id
         self.hook = hook
         self.block = block

data/lib/savon/model.rb

@@ -30,8 +30,7 @@ module Savon
     def define_class_action(action)
       class_action_module.module_eval %{
         def #{action.to_s.snakecase}(body = nil, &block)
-          response = client.request :wsdl, #{action.inspect}, :body => body, &block
-          config.hooks.select(:model_soap_response).call(response) || response
+          client.request :wsdl, #{action.inspect}, :body => body, &block
         end
       }
     end
@@ -49,11 +48,6 @@ module Savon
     def class_action_module
       @class_action_module ||= Module.new do
 
-        # Returns the memoized <tt>Savon::Config</tt>.
-        def config
-          @config ||= Savon.config.clone
-        end
-
         # Returns the memoized <tt>Savon::Client</tt>.
         def client(&block)
           @client ||= Savon::Client.new(&block)

data/lib/savon/soap/request.rb

@@ -31,7 +31,7 @@ module Savon
       # Executes the request and returns the response.
       def response
         @response ||= begin
-          response = config.hooks.select(:soap_request).call(self) || with_logging { HTTPI.post(http) }
+          response = config.hooks.fire(:soap_request, self) { with_logging { HTTPI.post(http) } }
           SOAP::Response.new(config, response)
         end
       end

data/lib/savon/version.rb

@@ -1,5 +1,5 @@
 module Savon
 
-  VERSION = "0.9.14"
+  VERSION = "1.0.0"
 
 end

data/spec/savon/hooks/group_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+
+describe Savon::Hooks::Group do
+
+  let(:group) { subject }
+
+  describe "#empty?" do
+    it "returns true for an empty group" do
+      group.should be_empty
+    end
+
+    it "returns false if the group contains hooks" do
+      group = Savon::Hooks::Group.new [:some_hook]
+      group.should_not be_empty
+    end
+  end
+
+  describe "#define" do
+    it "lets you define a new hook" do
+      group.define(:test_hook, :soap_request)
+      group.should_not be_empty
+    end
+
+    it "raises if there is no such hook" do
+      expect { group.define(:supposed_to_fail, :no_such_hook) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#reject" do
+    it "rejects hooks matching any given id" do
+      group.define(:remove1, :soap_request)
+      group.define(:here_to_stay, :soap_request)
+      group.define(:remove2, :soap_request)
+      group.count.should == 3
+
+      group.reject(:remove1, :remove2)
+      group.count.should == 1
+    end
+  end
+
+  describe "#fire" do
+    let(:hook)     { lambda {} }
+    let(:fallback) { lambda {} }
+
+    context "with hooks" do
+      before do
+        group.define(:some_hook, :soap_request, &hook)
+      end
+
+      it "calls the hooks passing any arguments" do
+        hook.expects(:call).with(:arg1, :arg2)
+        group.fire(:soap_request, :arg1, :arg2)
+      end
+
+      it "calls the hooks passing any arguments and the callback" do
+        hook.expects(:call).with(fallback, :arg)
+        group.fire(:soap_request, :arg, &fallback)
+      end
+    end
+
+    context "without hooks" do
+      it "executes the callback" do
+        report = :call
+        fallback = lambda { report = :back }
+        group.fire(:soap_request, &fallback)
+        report.should == :back
+      end
+    end
+  end
+
+end

data/spec/savon/hooks/hook_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe Savon::Hooks::Hook do
+
+  let(:hook) { lambda {} }
+
+  describe "#call" do
+    it "calls the hook" do
+      hook = Savon::Hooks::Hook.new(:my_hook, :soap_request, &hook)
+      hook.expects(:call).with(:arg1, :arg2)
+
+      hook.call(:arg1, :arg2)
+    end
+  end
+
+end

data/spec/savon/logger_spec.rb

@@ -26,7 +26,7 @@ describe Savon::Logger do
   it "logs a given message (pretty and filtered)" do
     logger.subject.expects(logger.level).with(filtered_message.to_xml(:indent => 2))
     logger.filter << :hello
-    warn logger.log(message, :pretty => true, :filter => true)
+    logger.log(message, :pretty => true, :filter => true)
   end
 
   it "defaults to wrap the standard Logger" do

data/spec/savon/model_spec.rb

@@ -6,38 +6,12 @@ describe Savon::Model do
     Class.new { extend Savon::Model }
   end
 
-  describe ":model_soap_response hook" do
-    before(:all) do
-      model.actions :get_user, "GetAllUsers"
-    end
-
-    after do
-      Savon.config.hooks.reject! :test_hook
-    end
-
-    it "can be used for pre-processing SOAP responses" do
-      Savon.config.hooks.define(:test_hook, :model_soap_response) do |response|
-        "hello #{response}"
-      end
-
-      model.client.stubs(:request).returns("world")  #
-      model.get_user.should == "hello world"
-    end
-  end
-
   describe ".client" do
     it "memoizes the Savon::Client" do
       model.client.should equal(model.client)
     end
   end
 
-  describe ".config" do
-    it "memoizes a clone of the global config" do
-      model.config.should be_a(Savon::Config)
-      model.config.should_not equal(Savon.config)
-    end
-  end
-
   describe ".endpoint" do
     it "sets the SOAP endpoint" do
       model.endpoint "http://example.com"

data/spec/savon/soap/request_spec.rb

@@ -2,9 +2,15 @@ require "spec_helper"
 
 describe Savon::SOAP::Request do
 
-  let(:soap_request) { Savon::SOAP::Request.new(config, http_request, soap_xml) }
-  let(:http_request) { HTTPI::Request.new }
-  let(:config)       { Savon::Config.default }
+  let(:soap_request)  { Savon::SOAP::Request.new(config, http_request, soap_xml) }
+  let(:http_request)  { HTTPI::Request.new }
+  let(:http_response) { HTTPI::Response.new 200, {}, Fixture.response(:authentication) }
+
+  let(:config) {
+    config = Savon::Config.default
+    config.log = false
+    config
+  }
 
   def soap_xml(*args)
     @soap_xml ||= soap_xml!(*args)
@@ -26,7 +32,7 @@ describe Savon::SOAP::Request do
 
   describe ".execute" do
     it "executes a SOAP request and returns the response" do
-      HTTPI.expects(:post).returns(HTTPI::Response.new 200, {}, Fixture.response(:authentication))
+      HTTPI.expects(:post).returns(http_response)
       response = Savon::SOAP::Request.execute config, http_request, soap_xml
       response.should be_a(Savon::SOAP::Response)
     end
@@ -67,9 +73,40 @@ describe Savon::SOAP::Request do
 
   describe "#response" do
     it "executes an HTTP POST request and returns a Savon::SOAP::Response" do
-      HTTPI.expects(:post).returns(HTTPI::Response.new 200, {}, Fixture.response(:authentication))
+      HTTPI.expects(:post).returns(http_response)
       soap_request.response.should be_a(Savon::SOAP::Response)
     end
+
+    context "with a :soap_request hook" do
+      it "lets you replace the HTTP request and return your own response" do
+        config.hooks.define(:test, :soap_request) do |_, request|
+          request.should be_a(Savon::SOAP::Request)
+          http_response
+        end
+
+        response = soap_request.response
+        response.http.should equal(http_response)
+      end
+
+      it "works as an around filter for the SOAP request" do
+        HTTPI.expects(:post).returns(http_response)
+        state = []
+
+        config.hooks.define(:test, :soap_request) do |callback, request|
+          state << :before
+          response = callback.call
+          state << response
+          state << :after
+          response
+        end
+
+        response = soap_request.response
+
+        state[0].should == :before
+        state[1].should be_a(HTTPI::Response)
+        state[2].should == :after
+      end
+    end
   end
 
 end

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ RSpec.configure do |config|
 end
 
 # Silence log output
-$stdout = StringIO.new
+Savon.config.log = false
 HTTPI.log = false
 
 require "support/endpoint"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: savon
 version: !ruby/object:Gem::Version 
-  hash: 39
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 9
-  - 14
-  version: 0.9.14
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-07 00:00:00 Z
+date: 2012-06-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -242,6 +242,8 @@ files:
 - spec/savon/client_spec.rb
 - spec/savon/config_spec.rb
 - spec/savon/core_ext/string_spec.rb
+- spec/savon/hooks/group_spec.rb
+- spec/savon/hooks/hook_spec.rb
 - spec/savon/http/error_spec.rb
 - spec/savon/logger_spec.rb
 - spec/savon/model_spec.rb