wash_out 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9149b2f9a1a04ad8d6ba859ef68f2dbf9db6d585
-  data.tar.gz: 55936871f904cf8d45517312b4479a39a5a5e5d5
+  metadata.gz: a23248a1bd38c14fe7eae75c2589b4eb945687f6
+  data.tar.gz: 5f806cadfebf37d0b46ee2d7f69d00266f0bae53
 SHA512:
-  metadata.gz: 5e2798c550e16322bb72de0dfa08c0e3a18ec3d292b481fc905d36f72d4b51a60bd889a583b723fc54081a484520c260a07e8b28dab1bb9babfa10f115e76e4b
-  data.tar.gz: 08821de12b76c9fc9f4c79ddc381279ebddfa7c42d6a197e9a7b7528f94044b46927edffab4bf9bb7dfcb090e4678effe80ef1e61cfd4cdee6c339dd0ed64090
+  metadata.gz: 5879036aca9ca31804573e45c5cc3aa4f7ffdb5303c27ea195c322c9246afd1ecde6d518783cd6e13dcd49ccb7a29c99f7017bc28a8feb43fbb45afeb2988063
+  data.tar.gz: d791bece6a7eb059ff83dbac5bce07ccd6e7dfc95c761579ff53ff97776dae4c7a5156b76997131f8de931b5263ba846545ec5018daa75eeb66faf985bbb2a6e

data/.gitignore

@@ -11,7 +11,7 @@ pkg/
 spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log
 spec/dummy/tmp/
-gemfiles
+gemfiles/*.lock
 coverage
 tags
 Gemfile.lock

data/.travis.yml

@@ -1,7 +1,26 @@
-before_install:
-  - gem install bundler
+script: bundle exec rspec
+gemfile:
+  - gemfiles/rails_3.1.3.gemfile
+  - gemfiles/rails_3.2.12.gemfile
+  - gemfiles/rails_4.0.0.gemfile
+  - gemfiles/rails_4.1.0.gemfile
+  - gemfiles/rails_4.2.0.gemfile
 rvm:
   - 1.9.3
-  - jruby-19mode
   - 2.0.0
-  - 2.1.0
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - jruby
+matrix:
+  exclude:
+    - rvm: 2.2.4
+      gemfile: gemfiles/rails_3.1.3.gemfile
+    - rvm: 2.2.4
+      gemfile: gemfiles/rails_3.2.12.gemfile
+    - rvm: 2.3.0
+      gemfile: gemfiles/rails_3.1.3.gemfile
+    - rvm: 2.3.0
+      gemfile: gemfiles/rails_3.2.12.gemfile
+before_install:
+  - gem update bundler

data/Appraisals

@@ -1,13 +1,11 @@
-appraise "rails-3.2.8" do
-  gem "rails", "3.2.8"
-end
-
 appraise "rails-3.1.3" do
   gem "rails", "3.1.3"
+  gem "test-unit"
 end
 
 appraise "rails-3.2.12" do
   gem "rails", "3.2.12"
+  gem "test-unit"
 end
 
 appraise "rails-4.0.0" do

data/Gemfile

@@ -14,4 +14,4 @@ gem 'appraisal'
 gem 'tzinfo'
 gem 'pry'
 gem 'simplecov'
-gem 'simplecov-summary'
+gem 'simplecov-summary'

data/README.md

@@ -78,6 +78,44 @@ class RumbasController < ApplicationController
     render :soap => params[:data].map{|x| x ? 1 : 0}
   end
 
+  # Params from XML attributes;
+  # e.g. for a request to the 'AddCircle' action:
+  #   <soapenv:Envelope>
+  #     <soapenv:Body>
+  #       <AddCircle>
+  #         <Circle radius="5.0">
+  #           <Center x="10" y="12" />
+  #         </Circle>
+  #       </AddCircle>
+  #     </soapenv:Body>
+  #   </soapenv:Envelope>
+  soap_action "AddCircle",
+              :args   => { :circle => { :center => { :@x => :integer,
+                                                     :@y => :integer },
+                                        :@radius => :double } },
+              :return => nil, # [] for wash_out below 0.3.0
+              :to     => :add_circle
+  def add_circle
+    circle = params[:circle]
+    Circle.new(circle[:center][:x], circle[:center][:y], circle[:radius])
+
+    render :soap => nil
+  end
+
+  # With a customised input tag name, in case params are wrapped;
+  # e.g. for a request to the 'IntegersToBoolean' action:
+  #   <soapenv:Envelope>
+  #     <soapenv:Body>
+  #       <MyRequest>  <!-- not <IntegersToBoolean> -->
+  #         <Data>...</Data>
+  #       </MyRequest>
+  #     </soapenv:Body>
+  #   </soapenv:Envelope>
+  soap_action "integers_to_boolean",
+              :args => { :my_request => { :data => [:integer] } },
+              :as => 'MyRequest',
+              :return => [:boolean]
+
   # You can use all Rails features like filtering, too. A SOAP controller
   # is just like a normal controller with a special routing.
   before_filter :dump_parameters

data/Rakefile

@@ -5,10 +5,9 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-desc "Default: run the unit tests."
-task :default => [:all]
-
-desc 'Test the plugin under all supported Rails versions.'
-task :all => ["appraisal:install"] do |t|
-  exec('rake appraisal spec')
-end
+task :console do
+  require "action_controller/railtie"
+  require "rails/test_unit/railtie"
+  Bundler.require
+  binding.pry
+end

data/app/helpers/wash_out_helper.rb

@@ -9,31 +9,47 @@ module WashOutHelper
     end
   end
 
+  def wsdl_data_attrs(param)
+    param.map.reduce({}) do |memo, p|
+      if p.respond_to?(:attribute?) && p.attribute?
+        memo.merge p.attr_name => p.value
+      else
+        memo
+      end
+    end
+  end
+
   def wsdl_data(xml, params)
     params.each do |param|
+      next if param.attribute?
+
       tag_name = param.name
       param_options = wsdl_data_options(param)
+      param_options.merge! wsdl_data_attrs(param)
 
-      if !param.struct?
-        if !param.multiplied
-          xml.tag! tag_name, param.value, param_options
+      if param.struct?
+        if param.multiplied
+          param.map.each do |p|
+            attrs = wsdl_data_attrs p
+            if p.is_a?(Array) || p.map.size > attrs.size
+              blk = proc { wsdl_data(xml, p.map) }
+            end
+            attrs.reject! { |_, v| v.nil? }
+            xml.tag! tag_name, param_options.merge(attrs), &blk
+          end
         else
-          param.value = [] unless param.value.is_a?(Array)
-          param.value.each do |v|
-            xml.tag! tag_name, v, param_options
+          xml.tag! tag_name, param_options do
+            wsdl_data(xml, param.map)
           end
         end
       else
-        if !param.multiplied
-          xml.tag! tag_name,  param_options do
-            wsdl_data(xml, param.map)
+        if param.multiplied
+          param.value = [] unless param.value.is_a?(Array)
+          param.value.each do |v|
+            xml.tag! tag_name, v, param_options
           end
         else
-          param.map.each do |p|
-            xml.tag! tag_name, param_options do
-              wsdl_data(xml, p.map)
-            end
-          end
+          xml.tag! tag_name, param.value, param_options
         end
       end
     end
@@ -45,12 +61,27 @@ module WashOutHelper
     if param.struct?
       if !defined.include?(param.basic_type)
         xml.tag! "xsd:complexType", :name => param.basic_type do
-          xml.tag! "xsd:sequence" do
-            param.map.each do |value|
-              more << value if value.struct?
-              xml.tag! "xsd:element", wsdl_occurence(value, false, :name => value.name, :type => value.namespaced_type)
+          attrs, elems = [], []
+          param.map.each do |value|
+            more << value if value.struct?
+            if value.attribute?
+              attrs << value
+            else
+              elems << value
+            end
+          end
+
+          if elems.any?
+            xml.tag! "xsd:sequence" do
+              elems.each do |value|
+                xml.tag! "xsd:element", wsdl_occurence(value, false, :name => value.name, :type => value.namespaced_type)
+              end
             end
           end
+
+          attrs.each do |value|
+            xml.tag! "xsd:attribute", wsdl_occurence(value, false, :name => value.attr_name, :type => value.namespaced_type)
+          end
         end
 
         defined << param.basic_type

data/app/views/{wash_with_soap → wash_out}/document/wsdl.builder

@@ -19,6 +19,19 @@ xml.definitions 'xmlns' => 'http://schemas.xmlsoap.org/wsdl/',
     end
   end
 
+  @map.each do |operation, formats|
+    xml.message :name => "#{operation}" do
+      formats[:in].each do |p|
+        xml.part wsdl_occurence(p, false, :name => p.name, :type => p.namespaced_type)
+      end
+    end
+    xml.message :name => formats[:response_tag] do
+      formats[:out].each do |p|
+        xml.part wsdl_occurence(p, false, :name => p.name, :type => p.namespaced_type)
+      end
+    end
+  end
+
   xml.portType :name => "#{@name}_port" do
     @map.each do |operation, formats|
       xml.operation :name => operation do
@@ -52,17 +65,4 @@ xml.definitions 'xmlns' => 'http://schemas.xmlsoap.org/wsdl/',
       xml.tag! "soap:address", :location => send("#{@name}_action_url")
     end
   end
-
-  @map.each do |operation, formats|
-    xml.message :name => "#{operation}" do
-      formats[:in].each do |p|
-        xml.part wsdl_occurence(p, false, :name => p.name, :type => p.namespaced_type)
-      end
-    end
-    xml.message :name => formats[:response_tag] do
-      formats[:out].each do |p|
-        xml.part wsdl_occurence(p, false, :name => p.name, :type => p.namespaced_type)
-      end
-    end
-  end
 end

data/app/views/{wash_with_soap → wash_out}/rpc/wsdl.builder

@@ -19,6 +19,19 @@ xml.definitions 'xmlns' => 'http://schemas.xmlsoap.org/wsdl/',
     end
   end
 
+  @map.each do |operation, formats|
+    xml.message :name => "#{operation}" do
+      formats[:in].each do |p|
+        xml.part wsdl_occurence(p, true, :name => p.name, :type => p.namespaced_type)
+      end
+    end
+    xml.message :name => formats[:response_tag] do
+      formats[:out].each do |p|
+        xml.part wsdl_occurence(p, true, :name => p.name, :type => p.namespaced_type)
+      end
+    end
+  end
+
   xml.portType :name => "#{@name}_port" do
     @map.each do |operation, formats|
       xml.operation :name => operation do
@@ -52,17 +65,4 @@ xml.definitions 'xmlns' => 'http://schemas.xmlsoap.org/wsdl/',
       xml.tag! "soap:address", :location => send("#{@name}_action_url")
     end
   end
-
-  @map.each do |operation, formats|
-    xml.message :name => "#{operation}" do
-      formats[:in].each do |p|
-        xml.part wsdl_occurence(p, true, :name => p.name, :type => p.namespaced_type)
-      end
-    end
-    xml.message :name => formats[:response_tag] do
-      formats[:out].each do |p|
-        xml.part wsdl_occurence(p, true, :name => p.name, :type => p.namespaced_type)
-      end
-    end
-  end
-end
+end

data/gemfiles/rails_3.1.3.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "wasabi"
+gem "savon", ">= 2.0.0"
+gem "httpi"
+gem "rspec-rails"
+gem "guard"
+gem "guard-rspec"
+gem "rb-fsevent"
+gem "appraisal"
+gem "tzinfo"
+gem "pry"
+gem "simplecov"
+gem "simplecov-summary"
+gem "rails", "3.1.3"
+gem "test-unit"
+
+gemspec :path => "../"

data/gemfiles/rails_3.2.12.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "wasabi"
+gem "savon", ">= 2.0.0"
+gem "httpi"
+gem "rspec-rails"
+gem "guard"
+gem "guard-rspec"
+gem "rb-fsevent"
+gem "appraisal"
+gem "tzinfo"
+gem "pry"
+gem "simplecov"
+gem "simplecov-summary"
+gem "rails", "3.2.12"
+gem "test-unit"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.0.gemfile

@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "wasabi"
+gem "savon", ">= 2.0.0"
+gem "httpi"
+gem "rspec-rails"
+gem "guard"
+gem "guard-rspec"
+gem "rb-fsevent"
+gem "appraisal"
+gem "tzinfo"
+gem "pry"
+gem "simplecov"
+gem "simplecov-summary"
+gem "rails", "4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.0.gemfile

@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "wasabi"
+gem "savon", ">= 2.0.0"
+gem "httpi"
+gem "rspec-rails"
+gem "guard"
+gem "guard-rspec"
+gem "rb-fsevent"
+gem "appraisal"
+gem "tzinfo"
+gem "pry"
+gem "simplecov"
+gem "simplecov-summary"
+gem "rails", "4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.0.gemfile

@@ -0,0 +1,19 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "wasabi"
+gem "savon", ">= 2.0.0"
+gem "httpi"
+gem "rspec-rails"
+gem "guard"
+gem "guard-rspec"
+gem "rb-fsevent"
+gem "appraisal"
+gem "tzinfo"
+gem "pry"
+gem "simplecov"
+gem "simplecov-summary"
+gem "rails", "4.2.0"
+
+gemspec :path => "../"

data/lib/wash_out/dispatcher.rb

@@ -32,22 +32,27 @@ module WashOut
     end
 
     def _map_soap_parameters
-      strip_empty_nodes = lambda{|hash|
-        hash.keys.each do |key|
-          if hash[key].is_a? Hash
-            value = hash[key].delete_if{|k, v| k.to_s[0] == '@'}
+      @_params = _load_params action_spec[:in],
+        _strip_empty_nodes(action_spec[:in], xml_data)
+    end
 
-            if value.length > 0
-              hash[key] = strip_empty_nodes.call(value)
-            else
-              hash[key] = nil
-            end
-          end
+    def _strip_empty_nodes(params, hash)
+      hash.keys.each do |key|
+        param = params.detect { |a| a.raw_name.to_s == key.to_s }
+        next if !(param && hash[key].is_a?(Hash))
+
+        value = hash[key].delete_if do |k, _|
+          k.to_s[0] == '@' && !param.map.detect { |a| a.raw_name.to_s == k.to_s }
         end
 
-        hash
-      }
-      @_params = _load_params(action_spec[:in], strip_empty_nodes.call(xml_data))
+        if value.length > 0
+          hash[key] = _strip_empty_nodes param.map, value
+        else
+          hash[key] = nil
+        end
+      end
+
+      hash
     end
 
     # Creates the final parameter hash based on the request spec and xml_data from the request
@@ -69,7 +74,7 @@ module WashOut
       @namespace = soap_config.namespace
       @name      = controller_path.gsub('/', '_')
 
-      render :template => "wash_with_soap/#{soap_config.wsdl_style}/wsdl", :layout => false,
+      render :template => "wash_out/#{soap_config.wsdl_style}/wsdl", :layout => false,
              :content_type => 'text/xml'
     end
 
@@ -124,7 +129,7 @@ module WashOut
         return result_spec
       }
 
-      render :template => "wash_with_soap/#{soap_config.wsdl_style}/response",
+      render :template => "wash_out/#{soap_config.wsdl_style}/response",
              :layout => false,
              :locals => { :result => inject.call(result, @action_spec[:out]) },
              :content_type => 'text/xml'
@@ -146,7 +151,7 @@ module WashOut
     # Rails do not support sequental rescue_from handling, that is, rescuing an
     # exception from a rescue_from handler. Hence this function is a public API.
     def render_soap_error(message, code=nil)
-      render :template => "wash_with_soap/#{soap_config.wsdl_style}/error", :status => 500,
+      render :template => "wash_out/#{soap_config.wsdl_style}/error", :status => 500,
              :layout => false,
              :locals => { :error_message => message, :error_code => (code || 'Server') },
              :content_type => 'text/xml'
@@ -188,14 +193,19 @@ module WashOut
       self.class.soap_actions[soap_action]
     end
 
+    def request_input_tag
+      action_spec[:request_tag]
+    end
+
     def soap_action
       request.env['wash_out.soap_action']
     end
 
     def xml_data
       xml_data = env['wash_out.soap_data'].values_at(:envelope, :Envelope).compact.first
-      xml_data = xml_data.values_at(:body, :Body).compact.first
-      xml_data = xml_data.values_at(soap_action.underscore.to_sym, soap_action.to_sym).compact.first || {}
+      xml_data = xml_data.values_at(:body, :Body).compact.first || {}
+      return xml_data if soap_config.wsdl_style == "document"
+      xml_data = xml_data.values_at(soap_action.underscore.to_sym, soap_action.to_sym, request_input_tag.to_sym).compact.first || {}
     end
 
   end

data/lib/wash_out/param.rb

@@ -7,6 +7,7 @@ module WashOut
     attr_accessor :multiplied
     attr_accessor :value
     attr_accessor :source_class
+    attr_accessor :soap_config
 
     # Defines a WSDL parameter with name +name+ and type specifier +type+.
     # The type specifier format is described in #parse_def.
@@ -63,6 +64,7 @@ module WashOut
         operation = case type
           when 'string';       :to_s
           when 'integer';      :to_i
+          when 'long';         :to_i
           when 'double';       :to_f
           when 'boolean';      lambda{|dat| dat === "0" ? false : !!dat}
           when 'date';         :to_date
@@ -160,10 +162,19 @@ module WashOut
     def flat_copy
       copy = self.class.new(@soap_config, @name, @type.to_sym, @multiplied)
       copy.raw_name = raw_name
-      copy.source_class = copy.source_class
+      copy.source_class = source_class
       copy
     end
 
+    def attribute?
+      name[0] == "@"
+    end
+
+    def attr_name
+      raise 'Not attribute' unless attribute?
+      name[1..-1]
+    end
+
     private
 
     # Used to load an entire structure.
@@ -178,7 +189,8 @@ module WashOut
       # RUBY18 Enumerable#each_with_object is better, but 1.9 only.
       @map.map do |param|
         if data.has_key? param.raw_name
-          struct[param.raw_name] = yield param, data, param.raw_name
+          param_name = param.attribute? ? param.attr_name : param.raw_name
+          struct[param_name] = yield param, data, param.raw_name
         end
       end
 

data/lib/wash_out/router.rb

@@ -52,11 +52,11 @@ module WashOut
     end
 
     def soap_body(env)
-      # Don't let nobody intercept us ^_^
-      env['rack.input'].rewind if env['rack.input'].respond_to?(:rewind)
-
-      env['rack.input'].respond_to?(:string) ? env['rack.input'].string
-                                             : env['rack.input'].read
+      body = env['rack.input']
+      body.rewind if body.respond_to? :rewind
+      body.respond_to?(:string) ? body.string : body.read
+    ensure
+      body.rewind if body.respond_to? :rewind
     end
 
     def parse_soap_parameters(env)

data/lib/wash_out/soap.rb

@@ -30,6 +30,7 @@ module WashOut
 
         self.soap_actions[action] = options.merge(
           :in           => WashOut::Param.parse_def(soap_config, options[:args]),
+          :request_tag  => options[:as] || action,
           :out          => WashOut::Param.parse_def(soap_config, options[:return]),
           :to           => options[:to] || action,
           :response_tag => options[:response_tag] || default_response_tag

data/lib/wash_out/version.rb

@@ -1,3 +1,3 @@
 module WashOut
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

data/lib/wash_out/wsse.rb

@@ -49,8 +49,8 @@ module WashOut
     def matches_expected_digest?(password)
       nonce     = @username_token.values_at(:nonce, :Nonce).compact.first
       timestamp = @username_token.values_at(:created, :Created).compact.first
-
       return false if nonce.nil? || timestamp.nil?
+      timestamp = timestamp.to_datetime
 
       # Token should not be accepted if timestamp is older than 5 minutes ago
       # http://www.oasis-open.org/committees/download.php/16782/wss-v1.1-spec-os-UsernameTokenProfile.pdf
@@ -62,11 +62,11 @@ module WashOut
       flavors = Array.new
 
       # Ruby / Savon
-      token = nonce + timestamp.to_s + expected_password
+      token = nonce + timestamp.strftime("%Y-%m-%dT%H:%M:%SZ") + expected_password
       flavors << Base64.encode64(Digest::SHA1.hexdigest(token)).chomp!
 
       # Java
-      token = Base64.decode64(nonce) + timestamp.to_s + expected_password
+      token = Base64.decode64(nonce) + timestamp.strftime("%Y-%m-%dT%H:%M:%SZ") + expected_password
       flavors << Base64.encode64(Digest::SHA1.digest(token)).chomp!
 
       flavors.each do |f|

data/lib/wash_out.rb

@@ -11,6 +11,12 @@ require 'wash_out/model'
 require 'wash_out/wsse'
 require 'wash_out/middleware'
 
+module WashOut
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
+end
+
 module ActionDispatch::Routing
   class Mapper
     # Adds the routes for a SOAP endpoint at +controller+.

data/spec/dummy/config/environments/test.rb

@@ -26,4 +26,5 @@ Dummy::Application.configure do
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr
+  config.active_support.test_order = :random
 end