wash-out 0.10.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7847d6250a06240d3f298c1062157159ab87e1dffb26201535632e081c1aaefe
+  data.tar.gz: 1c2408211e747e804ed54f1a5531e4b77c93d33dc82d6aa8ec84e8c7c97eabfd
+SHA512:
+  metadata.gz: 2a4470c56ba059a8c0aabced0c6806eb4864b09edad54a125a44ddda9a561437da81ce3e1092ce73bcf792fcd60f63a61aff7da09bb97521252fd5d20b398394
+  data.tar.gz: 54448aafe1845dcb231b361683094fe14457b5a6f6a43be7f4c9d3bea4143f9cf847d7f46524a6b3b2bc8dee983a4e185aa3c530b40971cc0156664bf0cb5ed9

data/.gitignore

@@ -0,0 +1,17 @@
+.rbx/
+.bundle/
+*.gem
+.idea/
+.ruby-gemset
+.ruby-version
+.rvmrc
+*.swp
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+gemfiles/*.lock
+coverage
+tags
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,35 @@
+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
+  - gemfiles/rails_5.0.0.beta2.gemfile
+rvm:
+  - 1.9.3
+  - 2.0.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
+    - 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

@@ -0,0 +1,25 @@
+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
+  gem "rails", "4.0.0"
+end
+
+appraise "rails-4.1.0" do
+  gem "rails", "4.1.0"
+end
+
+appraise "rails-4.2.0" do
+  gem "rails", "4.2.0"
+end
+
+appraise "rails-5.0.0.beta2" do
+  gem "rails", "5.0.0.beta2"
+end

data/CHANGELOG.md

@@ -0,0 +1,102 @@
+# Changelog
+
+## Not Supported!
+
+This is here for historical reasons. Please refer to [Releases](https://github.com/inossidabile/wash_out/releases) page to get actual information.
+
+## 0.7.1
+
+* Parser switcher [@inossidabile][]
+* Namespaces support patched [@inossidabile][]
+
+## 0.7.0
+
+* WSDL Document mode support [@gorism][]
+
+## 0.6.0
+
+* Switched to Savon2 family [@inossidabile][]
+* Main spec refactored greatly [@inossidabile][]
+
+## 0.5.4
+
+* Ability to manually specify `response_tag` for `soap_action` [@inossidabile][]
+
+## 0.5.2
+
+* .NET-compliant response tags [@ebeigarts][]
+* Tiny fixes [@ebeigarts][]
+
+## 0.5.1
+
+* Better routing points [@inossidabile][]
+
+## 0.5.0
+
+* WSSE password authentication [@dhinus][]
+* Ruby 1.8 compatibility restores [@dhinus][]
+
+## 0.4.2
+
+* SOAP hrefs are now supported [@inossidabile][]
+* Better camelization: reusable types and methods are now supported [@inossidabile][]
+
+## 0.4.1
+
+* .NET-compliant :integer type WSDL [@inossidabile][]
+
+## 0.4.0
+
+* Better content-type for the response (#33) [@inossidabile][]
+* Date type support (#18) [@inossidabile][]
+* Avoid duplication of inner types [@inossidabile][]
+* Output camelization support [@inossidabile][]
+* External types declaration support (#21, #41) [@inossidabile][]
+
+## 0.3.7
+
+* Better empty parameters handling (#26, #30) [@rngtng][]
+
+## 0.3.6
+
+* Unicorn stream reading bug (#20)
+* .NET minOccurs/maxOccurs basic WSDL compatibility (#22, #23)
+
+## 0.3.5
+
+* Very evil thread-safety bug fixed. You are encouraged to never use anything below this version.
+
+## 0.3.4
+
+* WSDL generation fixed to support complex structures for return values
+* Configuration moved to OrderedOptions with proper Engine binding
+* `snakecase` configuration directive added: if set to false, wash_out won't modify params keys
+
+## 0.3.3
+
+* Tiny fixes in wash_out behavior with inline arrays (#11, #12)
+* Ability to change namespace
+
+## 0.3.2
+
+* WashOut doesn't check existance of parameters anymore you should do it yourself from now
+* Proper handling of blank parameters (#10)
+* Proper handling of complex structures inside arrays (#9)
+* Response performance improved
+
+## 0.3.1
+
+* Support of complex structures inside array
+* Better Nori handling (no more dependency on Savon hijacking)
+
+## 0.3.0
+
+* The syntax for empty set (no input params or output params) changed from [] to nil.
+* SOAP response format improved. All results are now wrapped into tns:messages instead of soap:Body.
+* Arrays (minOccurs/maxOccurs) are now supported with `:foo => [:integer]` syntax.
+
+[@inossidabile]: http://staal.io
+[@rngtng]: https://github.com/rngtng
+[@dhinus]: https://github.com/dhinus
+[@ebeigarts]: https://github.com/ebeigarts
+[@gorism]: https://github.com/gorism

data/Gemfile

@@ -0,0 +1,16 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'appraisal'
+gem 'guard'
+gem 'guard-rspec'
+gem 'httpi'
+gem 'pry'
+gem 'rb-fsevent'
+gem 'rspec-rails'
+gem 'savon', '>= 2.0.0'
+gem 'simplecov'
+gem 'simplecov-summary'
+gem 'tzinfo'
+gem 'wasabi'

data/Guardfile

@@ -0,0 +1,12 @@
+# More info at https://github.com/guard/guard#readme
+
+# Could be changed to whatever you want.
+#  See: https://github.com/guard/guard#notification
+notification :off
+
+guard 'rspec' do
+  watch %r{^spec/.+_spec\.rb$}
+  watch %r{lib/} do 'spec' end
+end
+
+# vim:ft=ruby

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2012 Round Lake, inc.,
+                   Peter Zotov <whitequark@whitequark.org>.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,246 @@
+# WashOut
+
+WashOut is a gem that greatly simplifies creation of SOAP service providers.
+
+[![Gem Version](https://badge.fury.io/rb/wash_out.png)](http://badge.fury.io/rb/wash_out)
+[![Travis CI](https://secure.travis-ci.org/inossidabile/wash_out.png)](https://travis-ci.org/inossidabile/wash_out)
+[![Code Climate](https://codeclimate.com/github/inossidabile/wash_out.png)](https://codeclimate.com/github/inossidabile/wash_out)
+
+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.
+
+## Installation
+
+In your Gemfile, add this line:
+
+    gem 'wash_out'
+
+Please read [release details](https://github.com/inossidabile/wash_out/releases) if you are upgrading. We break backward compatibility between large ticks but you can expect it to be specified at release notes.
+
+## Usage
+
+A SOAP endpoint in WashOut is simply a Rails controller which includes the module WashOut::SOAP. Each SOAP
+action corresponds to a certain controller method; this mapping, as well as the argument definition, is defined
+by [soap_action][] method. Check the method documentation for complete info; here, only a few examples will be
+demonstrated.
+
+  [soap_action]: http://rubydoc.info/gems/wash_out/WashOut/SOAP/ClassMethods#soap_action-instance_method
+
+```ruby
+# app/controllers/rumbas_controller.rb
+class RumbasController < ApplicationController
+  soap_service namespace: 'urn:WashOut'
+
+  # Simple case
+  soap_action "integer_to_string",
+              :args   => :integer,
+              :return => :string
+  def integer_to_string
+    render :soap => params[:value].to_s
+  end
+
+  soap_action "concat",
+              :args   => { :a => :string, :b => :string },
+              :return => :string
+  def concat
+    render :soap => (params[:a] + params[:b])
+  end
+
+  # Complex structures
+  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]
+
+    raise SOAPError, "radius is too small" if circle[:radius] < 3.0
+
+    Circle.new(circle[:center][:x], circle[:center][:y], circle[:radius])
+
+    render :soap => nil
+  end
+
+  # Arrays
+  soap_action "integers_to_boolean",
+              :args => { :data => [:integer] },
+              :return => [:boolean]
+  def integers_to_boolean
+    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
+  def dump_parameters
+    Rails.logger.debug params.inspect
+  end
+end
+```
+
+```ruby
+# config/routes.rb
+WashOutSample::Application.routes.draw do
+  wash_out :rumbas
+end
+```
+
+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
+require 'savon'
+
+client = Savon::Client.new(wsdl: "http://localhost:3000/rumbas/wsdl")
+
+client.operations # => [:integer_to_string, :concat, :add_circle]
+
+result = client.call(:concat, message: { :a => "123", :b => "abc" })
+
+# actual wash_out
+result.to_hash # => {:concat_reponse => {:value=>"123abc"}}
+
+# wash_out below 0.3.0 (and this is malformed response so please update)
+result.to_hash # => {:value=>"123abc"}
+```
+
+## Reusable types
+
+Basic inline types definition is fast and furious for the simple cases. You have an option to describe SOAP types
+inside separate classes for the complex ones. Here's the way to do that:
+
+```ruby
+class Fluffy < WashOut::Type
+  map :universe => {
+        :name => :string,
+        :age  => :int
+      }
+end
+
+class FluffyContainer < WashOut::Type
+  type_name 'fluffy_con'
+  map :fluffy => Fluffy
+end
+```
+
+To use defined type inside your inline declaration, pass the class instead of type symbol (`:fluffy => Fluffy`).
+
+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.
+To override the values on a specific controller just add an override as part of the arguments to the `soap_service` method.
+
+Available properties are:
+
+* **parser**: XML parser to use – `:rexml` or `:nokogiri`. The first one is default but the latter is much faster. Be sure to add `gem nokogiri` if you want to use it.
+* **wsdl_style**: sets WSDL style. Supported values are: 'document' and 'rpc'.
+* **catch_xml_errors**: intercept Rails parsing exceptions to return correct XML response for corrupt XML input. Default is `false`.
+* **namespace**: SOAP namespace to use. Default is `urn:WashOut`.
+* **snakecase_input**: Determines if WashOut should modify parameters keys to snakecase. Default is `false`.
+* **camelize_wsdl**: Determines if WashOut should camelize types within WSDL and responses. Supports `true` for CamelCase and `:lower` for camelCase. Default is `false`.
+
+### Camelization
+
+Note that WSDL camelization will affect method names but only if they were given as a symbol:
+
+```ruby
+soap_action :foo  # this will be affected
+soap_action "foo" # this will be passed as is
+```
+
+## Maintainers
+
+* Boris Staal, [@inossidabile](http://staal.io)
+
+## Contributors (in random order)
+
+* Mikael Henriksson, [@mhenrixon](http://twitter.com/mhenrixon)
+* Björn Nilsson [@Bjorn-Nilsson](https://github.com/Bjorn-Nilsson)
+* Tobias Bielohlawek [@rngtng](https://github.com/rngtng)
+* Francesco Negri [@dhinus](https://github.com/dhinus)
+* Edgars Beigarts [@ebeigarts](https://github.com/ebeigarts)
+* [Exad](https://github.com/exad) [@wknechtel](https://github.com/wknechtel) and [@☈king](https://github.com/rking)
+* Mark Goris [@gorism](https://github.com/gorism)
+* ... and [others](https://github.com/inossidabile/wash_out/graphs/contributors)
+
+## License
+
+It is free software, and may be redistributed under the terms of MIT license.
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/inossidabile/wash_out/trend.png)](https://bitdeli.com/free "Bitdeli Badge")