wash_out 0.9.0 → 0.11.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb290b5f2914d741a1cc5ba218d0eab0b87415fc
-  data.tar.gz: 336edc510428d18429908b002c22d8c84ab5ec41
+  metadata.gz: 9d49adf22c0c16c3f0e8e3e2dcf694b7d6851920
+  data.tar.gz: c42b0da56ed90cd44e4d014aff450f3bef83325f
 SHA512:
-  metadata.gz: 2a06e7e53d7b0ed436951a97dbd29cb7592d1ee39743c4bb60c194e347435f6514368744540d9fafd413c906bf0337271ff897ffb7c158280c16dbe30156b32f
-  data.tar.gz: 658031ea5d90bec54848b5ceebdf03b65ecdc3ecf46a6312f5b8adf0e523944332e81ebb5c7e4ce03c47c8cb3e948b7d550cb49170cde363ec9bab896eb3632d
+  metadata.gz: 9f2dd4239ee3fa9e449bd0903c977b5f2457382ee363cb3d1404d102f5fd0b531fe8f0e32dcee5cc6a5ff14996d60b37bb565ad702b913ac2ed344fbde90ea83
+  data.tar.gz: c9045dd957a04e6751b9ed5ffc2a28fdc6c1d4a1c4eff7a57d8564699423a442a4975fe8c6c4cac7a451a19cd3eeda112ba8357cd0e19228d838e4d8ffcabdb4

data/.gitignore

@@ -2,6 +2,8 @@
 .bundle/
 *.gem
 .idea/
+.ruby-gemset
+.ruby-version
 .rvmrc
 *.swp
 log/*.log
@@ -9,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,6 +1,34 @@
-before_install:
-  - gem install bundler
+script: bundle exec rspec
+gemfile:
+  - gemfiles/rails_3.2.13.gemfile
+  - gemfiles/rails_4.0.0.gemfile
+  - gemfiles/rails_4.1.0.gemfile
+  - gemfiles/rails_4.2.0.gemfile
+  - gemfiles/rails_5.0.0.beta2.gemfile
 rvm:
   - 1.9.3
-  - jruby-19mode
   - 2.0.0
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - jruby
+matrix:
+  exclude:
+    - rvm: 2.2.4
+      gemfile: gemfiles/rails_3.2.13.gemfile
+    - rvm: 2.3.0
+      gemfile: gemfiles/rails_3.2.13.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_4.2.0.gemfile
+    - rvm: jruby
+      gemfile: gemfiles/rails_4.2.0.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails_5.0.0.beta2.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_5.0.0.beta2.gemfile
+    - rvm: 2.1.8
+      gemfile: gemfiles/rails_5.0.0.beta2.gemfile
+    - rvm: jruby
+      gemfile: gemfiles/rails_5.0.0.beta2.gemfile
+before_install:
+  - gem update bundler

data/Appraisals

@@ -1,15 +1,24 @@
-appraise "rails-3.2.8" do
-  gem "rails", "3.2.8"
+appraise "rails-3.2.13" do
+  gem "rails", "3.2.13"
+  gem "test-unit"
+  gem "listen", "< 3.1.0"
 end
 
-appraise "rails-3.1.3" do
-  gem "rails", "3.1.3"
+appraise "rails-4.0.0" do
+  gem "rails", "4.0.0"
+  gem "listen", "< 3.1.0"
 end
 
-appraise "rails-3.2.12" do
-  gem "rails", "3.2.12"
+appraise "rails-4.1.0" do
+  gem "rails", "4.1.0"
+  gem "listen", "< 3.1.0"
 end
 
-appraise "rails-4.0.0" do
-  gem "rails", "4.0.0"
+appraise "rails-4.2.0" do
+  gem "rails", "4.2.0"
+  gem "listen", "< 3.1.0"
+end
+
+appraise "rails-5.0.0.beta2" do
+  gem "rails", "5.0.0.beta2"
 end

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 gem 'wasabi'
 gem 'savon', '>= 2.0.0'
-gem 'httpi', :git => 'git://github.com/savonrb/httpi.git'
+gem 'httpi'
 
 gem 'rspec-rails'
 gem 'guard'
@@ -14,4 +14,4 @@ gem 'appraisal'
 gem 'tzinfo'
 gem 'pry'
 gem 'simplecov'
-gem 'simplecov-summary'
+gem 'simplecov-summary'

data/README.md

@@ -10,11 +10,7 @@ But if you have a chance, please [http://stopsoap.com/](http://stopsoap.com/).
 
 ## Compatibility
 
-Rails >3.0 only. MRI 1.9, 2.0, JRuby (--1.9).
-
-Ruby 1.8 is not officially supported since 0.5.3. We will accept further compatibilty pull-requests but no upcoming versions will be tested against it.
-
-Rubinius support temporarily dropped since 0.6.2 due to Rails 4 incompatibility.
+Rails 3.2.13 and higher (if you are using SOAP and still on Ruby 1.9 - that's just too much evil, sorry)
 
 ## Installation
 
@@ -75,9 +71,47 @@ class RumbasController < ApplicationController
               :args => { :data => [:integer] },
               :return => [:boolean]
   def integers_to_boolean
-    render :soap => params[:data].map{|x| x ? 1 : 0}
+    render :soap => params[:data].map{|i| i > 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
@@ -94,7 +128,7 @@ WashOutSample::Application.routes.draw do
 end
 ```
 
-In such a setup, the generated WSDL may be queried at path `/api/wsdl`. So, with a
+In such a setup, the generated WSDL may be queried at path `/rumbas/wsdl`. So, with a
 gem like Savon, a request can be done using this path:
 
 ```ruby
@@ -122,7 +156,7 @@ inside separate classes for the complex ones. Here's the way to do that:
 class Fluffy < WashOut::Type
   map :universe => {
         :name => :string,
-        :age  => :int
+        :age  => :integer
       }
 end
 
@@ -137,6 +171,32 @@ To use defined type inside your inline declaration, pass the class instead of ty
 Note that WashOut extends the `ActiveRecord` so every model you use is already a WashOut::Type and can be used
 inside your interface declarations.
 
+## WSSE Authentication
+
+WashOut provides two mechanism for WSSE Authentication. 
+
+### Static Authentication
+
+You can configure the service to validate against a username and password with the following configuration:
+
+```ruby
+soap_service namespace: "wash_out", wsse_username: "username", wsse_password: "password"
+```
+
+With this mechanism, all the actions in the controller will be authenticated against the specified username and password. If you need to authenticate different users, you can use the dynamic mechanism described below.
+
+### Dynamic Authentication
+
+Dynamic authentication allows you to process the username and password any way you want, with the most common case being authenticating against a database. The configuration option for this mechanism is called `wsse_auth_callback`:
+
+```ruby
+soap_service namespace: "wash_out", wsse_auth_callback: ->(username, password) {
+  return !User.find_by(username: username).authenticate(password).blank?
+}
+```
+
+Keep in mind that the password may already be hashed by the SOAP client, so you would have to check against that condition too as per [spec](http://www.oasis-open.org/committees/download.php/16782/wss-v1.1-spec-os-UsernameTokenProfile.pdf)
+
 ## Configuration
 
 Use `config.wash_out...` inside your environment configuration to setup WashOut globally.

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

@@ -3,37 +3,57 @@ module WashOutHelper
   def wsdl_data_options(param)
     case controller.soap_config.wsdl_style
     when 'rpc'
-      { :"xsi:type" => param.namespaced_type }
+      if param.map.present? || param.value
+        { :"xsi:type" => param.namespaced_type }
+      else
+        { :"xsi:nil" => true }
+      end
     when 'document'
       { }
     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 +65,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
@@ -65,11 +100,11 @@ module WashOutHelper
   end
 
   def wsdl_occurence(param, inject, extend_with = {})
-    data = !param.multiplied ? {} : {
-      "#{'xsi:' if inject}minOccurs" => 0,
-      "#{'xsi:' if inject}maxOccurs" => 'unbounded'
-    }
-
+    data = {"#{'xsi:' if inject}nillable" => 'true'}
+    if param.multiplied
+      data["#{'xsi:' if inject}minOccurs"] = 0
+      data["#{'xsi:' if inject}maxOccurs"] = 'unbounded'
+    end
     extend_with.merge(data)
   end
 end

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

@@ -2,7 +2,7 @@ xml.instruct!
 xml.tag! "soap:Envelope", "xmlns:soap" => 'http://schemas.xmlsoap.org/soap/envelope/' do
   xml.tag! "soap:Body" do
     xml.tag! "soap:Fault" do
-      xml.faultcode "soap:Server"
+      xml.faultcode error_code
       xml.faultstring error_message
     end
   end

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

@@ -3,9 +3,7 @@ xml.tag! "soap:Envelope", "xmlns:soap" => 'http://schemas.xmlsoap.org/soap/envel
                           "xmlns:xsd" => 'http://www.w3.org/2001/XMLSchema',
                           "xmlns:tns" => @namespace do
   xml.tag! "soap:Body" do
-    key = "tns:#{@operation}#{controller.soap_config.camelize_wsdl ? 'Response' : '_response'}"
-
-    xml.tag! @action_spec[:response_tag] do
+    xml.tag! "tns:#{@action_spec[:response_tag]}" do
       wsdl_data xml, result
     end
   end

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

@@ -19,11 +19,24 @@ 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.keys.each do |operation|
+    @map.each do |operation, formats|
       xml.operation :name => operation do
         xml.input :message => "tns:#{operation}"
-        xml.output :message => "tns:#{operation}#{controller.soap_config.camelize_wsdl ? 'Response' : '_response'}"
+        xml.output :message => "tns:#{formats[:response_tag]}"
       end
     end
   end
@@ -49,20 +62,7 @@ xml.definitions 'xmlns' => 'http://schemas.xmlsoap.org/wsdl/',
 
   xml.service :name => "service" do
     xml.port :name => "#{@name}_port", :binding => "tns:#{@name}_binding" do
-      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 => "#{operation}#{controller.soap_config.camelize_wsdl ? 'Response' : '_response'}" do
-      formats[:out].each do |p|
-        xml.part wsdl_occurence(p, false, :name => p.name, :type => p.namespaced_type)
-      end
+      xml.tag! "soap:address", :location => WashOut::Router.url(request, @name)
     end
   end
 end

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

@@ -3,7 +3,7 @@ xml.tag! "soap:Envelope", "xmlns:soap" => 'http://schemas.xmlsoap.org/soap/envel
                           "xmlns:xsi" => 'http://www.w3.org/2001/XMLSchema-instance' do
   xml.tag! "soap:Body" do
     xml.tag! "soap:Fault", :encodingStyle => 'http://schemas.xmlsoap.org/soap/encoding/' do
-      xml.faultcode "Server", 'xsi:type' => 'xsd:QName'
+      xml.faultcode error_code, 'xsi:type' => 'xsd:QName'
       xml.faultstring error_message, 'xsi:type' => 'xsd:string'
     end
   end

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

@@ -4,9 +4,7 @@ xml.tag! "soap:Envelope", "xmlns:soap" => 'http://schemas.xmlsoap.org/soap/envel
                           "xmlns:xsi" => 'http://www.w3.org/2001/XMLSchema-instance',
                           "xmlns:tns" => @namespace do
   xml.tag! "soap:Body" do
-    key = "tns:#{@operation}#{controller.soap_config.camelize_wsdl ? 'Response' : '_response'}"
-
-    xml.tag! @action_spec[:response_tag] do
+    xml.tag! "tns:#{@action_spec[:response_tag]}" do
       wsdl_data xml, result
     end
   end

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

@@ -19,11 +19,24 @@ 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.keys.each do |operation|
+    @map.each do |operation, formats|
       xml.operation :name => operation do
         xml.input :message => "tns:#{operation}"
-        xml.output :message => "tns:#{operation}#{controller.soap_config.camelize_wsdl ? 'Response' : '_response'}"
+        xml.output :message => "tns:#{formats[:response_tag]}"
       end
     end
   end
@@ -49,20 +62,7 @@ xml.definitions 'xmlns' => 'http://schemas.xmlsoap.org/wsdl/',
 
   xml.service :name => "service" do
     xml.port :name => "#{@name}_port", :binding => "tns:#{@name}_binding" do
-      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 => "#{operation}#{controller.soap_config.camelize_wsdl ? 'Response' : '_response'}" do
-      formats[:out].each do |p|
-        xml.part wsdl_occurence(p, true, :name => p.name, :type => p.namespaced_type)
-      end
+      xml.tag! "soap:address", :location => WashOut::Router.url(request, @name)
     end
   end
-end
+end

data/gemfiles/rails_3.2.13.gemfile

@@ -0,0 +1,21 @@
+# 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.13"
+gem "test-unit"
+gem "listen", "< 3.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.0.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", "4.0.0"
+gem "listen", "< 3.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.0.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", "4.1.0"
+gem "listen", "< 3.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.0.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", "4.2.0"
+gem "listen", "< 3.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_5.0.0.beta2.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", "5.0.0.beta2"
+
+gemspec :path => "../"