sinatra-soap-current 0.1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38b98a95ec28ca97366c1bd815ed35b50a2b0546
+  data.tar.gz: 145e978d20e525cef7887fb3bf45c7c0f5f3daa6
+SHA512:
+  metadata.gz: 17fe741df3d1bfbc0810f930b3b60c1001b9b4f9f5be032592b1729b217a4fd0795048fa7380198a406b2402f3f98869be06ce79603a0a5799f794aef092c912
+  data.tar.gz: 5db6d0bef29b7f61a33f33c1acb30f1c66295f43a59f8590214598a6bbf49bade640e62ff3b9692e38dad2ba745d89c597d1127807fb6efd61c2208e52f2c433

data/.gitignore

@@ -0,0 +1,7 @@
+.rbx/
+.bundle/
+*.gem
+.idea/
+.rvmrc
+*.swp*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+before_install:
+  - gem install bundler
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-soap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ivan Shamatov
+
+MIT License
+
+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,120 @@
+# Sinatra::Soap
+
+[![Build Status](https://travis-ci.org/ejhayes/sinatra-soap.svg?branch=master)](https://travis-ci.org/ejhayes/sinatra-soap) [![Maintainability](https://api.codeclimate.com/v1/badges/97acacfcc02aa7f03f6a/maintainability)](https://codeclimate.com/github/ejhayes/sinatra-soap/maintainability) [![Gem Version](https://badge.fury.io/rb/sinatra-soap-current.png)](http://badge.fury.io/rb/sinatra-soap-current)
+
+Sinatra-soap gem makes task to create SOAP API really simple. Inspired by WashOut gem for Rails. But remember, the only reason why you should use SOAP is legacy code.
+
+
+## Overview
+
+In case of simplicity and quick first working release: 
+
+## Usage
+
+Add the following to your gemfile:
+
+```ruby
+gem 'sinatra-soap-current'
+```
+
+A classic application would work like that: 
+
+```ruby
+require 'sinatra'
+require 'sinatra/soap'
+
+soap "SomeAction" do
+  do_something_with_params # hash to be returned
+end
+```
+
+A modular application would look like that:
+
+```ruby
+require 'sinatra/base'
+require 'sinatra/soap'
+
+class SoapAPI < Sinatra::Base
+
+  #remember to register extenstion if you are using modular style
+  register Sinatra::Soap 
+
+  soap "SomeAction" do
+    params # hash to be returned
+  end
+end
+```
+
+
+## Settings
+
+* **:wsdl_route** — url for getting wsdl, either static or dynamically generated file
+```ruby
+set :wsdl_route, '/wsdl'
+```
+Defines route for app to response with wsdl. Default is '/wsdl'
+
+
+* **:endpoint** — url for sending SOAP Requests
+```ruby
+set :endpoint, '/action'
+```
+Defines route for SOAP Requests. Default is '/action'
+
+
+* **:wsdl_file** — app will send static file, if this setting specified
+```ruby
+set :wsdl_file, "wsdl.xml"
+```
+If wsdl_file is set, app will try to read wsdl file from ```:public_folder``` (by default ./public directory). If file does not exist, app will raise an error. You also don't need to specify ```:namespace``` or ```:service``` if you want to serve static wsdl.
+
+
+* **:namespace** — wsdl setting, required for generating wsdl
+```ruby
+set :namespace, "http://schemas.xmlsoap.org/wsdl/"
+```
+Namespace is taking it's place in ```xmlns:tns``` and ```targetNamespace``` definitions of SOAP Envelope
+
+* **:service** — wsdl setting, required for generating wsdl
+```ruby
+set :service, "sinatra"
+```
+Service involved in ```portType```, ```binding``` and ```service``` definitions as a prefix for name attribute.
+
+
+
+
+## Soap Arguments
+
+If you want to be able to generate wsdl on a fly, you need to specify incoming and outgoing nodes with their types. 
+
+```ruby
+soap :test, in: {circle: {center: {x: :integer, 
+                                   y: :integer}, 
+                          radius: :double}
+                },
+            out: nil do
+  params #=> {circle: {center: {x: 3, y: 2}, radius: 12.0} }
+  nil
+end
+```
+
+The code above will respond to request like this:
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsdl="anynamespacehere" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+  <env:Body>
+    <wsdl:test>
+      <circle>
+        <center>
+          <x>3</x>
+          <y>2</y>
+        </center>
+        <radius>12.0</radius>
+      </circle>
+    </wsdl:test>
+  </env:Body>
+</env:Envelope>
+``` 
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/examples/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'sinatra-soap-current'
+gem 'savon', '~> 2.0'

data/examples/app.rb

@@ -0,0 +1,26 @@
+require 'sinatra/base'
+require 'sinatra/soap'
+
+class App < Sinatra::Base
+  register Sinatra::Soap
+
+  set :service, "sinatra"
+  set :namespace, "http://schemas.xmlsoap.org/wsdl/"
+  set :endpoint, '/action'
+  set :wsdl_route, '/wsdl'
+
+  #soap :test do
+  #  params
+  #end
+
+  soap :test, in: { hello: :string }, out: nil do
+    params
+  end
+
+  soap :ObjectTest, in: { TestObject: { a: :string, b: :string }}, out: { hello: :string } do
+    params
+  end
+
+
+end
+App.run!

data/examples/client.rb

@@ -0,0 +1,16 @@
+require "savon"
+
+#client = Savon.client do
+#  endpoint "http://127.0.0.1:4567/action"
+#  namespace "http://schemas.xmlsoap.org/wsdl/"
+#end
+
+
+client = Savon.client(wsdl: "http://127.0.0.1:4567/wsdl")
+
+puts client.operations
+
+puts client.call(:test, message: { :hello => :world })
+puts client.call(:test, message: { :should => :fail })
+
+ 

data/lib/sinatra/soap.rb

@@ -0,0 +1,38 @@
+require "sinatra/base"
+require "sinatra/soap/version"
+require "sinatra/soap/wsdl"
+require "sinatra/soap/error"
+require "sinatra/soap/dsl_methods"
+require "sinatra/soap/helper_methods"
+require "sinatra/soap/request"
+require "sinatra/soap/response"
+require "builder"
+
+
+module Sinatra
+  module Soap
+
+    include DslMethods
+
+    def self.registered(app)
+      app.helpers Soap::HelperMethods
+
+      app.set :wsdl_route, '/wsdl' unless defined?(app.settings.wsdl_path)
+      app.set :namespace, 'http://schemas.xmlsoap.org/wsdl/' unless defined?(app.settings.namespace)
+      app.set :endpoint, '/action' unless defined?(app.settings.endpoint)
+      app.set :service, 'Sinatra' unless defined?(app.settings.service)
+
+      app.post(app.settings.endpoint) do
+        content_type 'text/xml'
+        call_action_block
+      end
+
+      app.get(app.settings.wsdl_route) do 
+        content_type 'text/xml'
+        get_wsdl
+      end
+    end
+  end
+  Delegator.delegate :soap
+  register Soap
+end

data/lib/sinatra/soap/dsl_methods.rb

@@ -0,0 +1,11 @@
+module Sinatra
+  module Soap
+    module DslMethods
+
+      def soap(action, *args, &block)
+        Soap::Wsdl.register(action, *args, &block)
+      end
+
+    end
+  end
+end

data/lib/sinatra/soap/error.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Soap
+    class Error < StandardError; end
+  end
+end

data/lib/sinatra/soap/helper_methods.rb

@@ -0,0 +1,68 @@
+require_relative 'param'
+
+module Sinatra
+  module Soap
+    module HelperMethods
+
+      # Return the location where we can find our views
+      def soap_views()
+        File.join(File.dirname(__FILE__), "..", "views")
+      end
+
+      def call_action_block
+        request = Soap::Request.new(env, request, params)
+        response = request.execute
+        builder :response, locals: {wsdl: response.wsdl, params: response.params}, :views => self.soap_views
+      rescue Soap::Error => e
+        builder :error, locals: {e: e}, :views => self.soap_views
+      end
+
+      def get_wsdl
+        if defined?(settings.wsdl_path)
+          path = File.join(settings.public_folder, settings.wsdl_path)
+          if File.exist?(path)
+            File.read(path)
+          else
+            raise "No wsdl file"
+          end
+        else
+          builder :wsdl, locals: {wsdl: Soap::Wsdl.actions}, :views => self.soap_views
+        end
+      end
+
+      def wsdl_occurence(param, inject, extend_with = {})
+        param=Param.new(param[0], param[1])
+        extend_with = { :name => param.name, :type => param.namespaced_type }
+        data = !param.multiplied ? {} : {
+          "#{'xsi:' if inject}minOccurs" => 0,
+          "#{'xsi:' if inject}maxOccurs" => 'unbounded'
+        }
+        extend_with.merge(data)
+      end
+
+      def wsdl_type(xml, param, defined=[])
+        param = Param.new(param[0], param[1])
+        more = []
+        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|
+                  param_value = Param.new(value[0], value[1])
+                  more << value if param_value.struct?
+                  xml.tag! "xsd:element", wsdl_occurence(value, false)
+                end
+              end
+            end
+            defined << param.basic_type
+          elsif !param.classified?
+            raise RuntimeError, "Duplicate use of `#{param.basic_type}` type name. Consider using classified types."
+          end
+        end
+        more.each do |p|
+          wsdl_type xml, p, defined
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/soap/param.rb

@@ -0,0 +1,181 @@
+module Sinatra
+module Soap
+  class Param
+    attr_accessor :raw_name
+    attr_accessor :name
+    attr_accessor :map
+    attr_accessor :type
+    attr_accessor :multiplied
+    attr_accessor :value
+    attr_accessor :source_class
+
+    def initialize(name, type, multiplied = false)
+      type ||= {}
+      @name       = name.to_s
+      @raw_name   = name.to_s
+      @map        = {}
+      @multiplied = multiplied
+
+      if type.is_a?(Symbol)
+        @type = type.to_s
+      elsif type.is_a?(Class)
+        @type         = 'struct'
+        @source_class = type
+        @map          = type
+      else
+        @type = 'struct'
+        @map  = type 
+      end
+    end
+
+    # Converts a generic externally derived Ruby value, such as String or
+    # Hash, to a native Ruby object according to the definition of this type.
+    def load(data, key)
+      if !data.has_key? key
+        raise Error, "Required SOAP parameter '#{key}' is missing"
+      end
+
+      data = data[key]
+      data = [data] if @multiplied && !data.is_a?(Array)
+
+      if struct?
+        data ||= {}
+        if @multiplied
+          data.map do |x|
+            map_struct x do |param, dat, elem|
+              param.load(dat, elem)
+            end
+          end
+        else
+          map_struct data do |param, dat, elem|
+            param.load(dat, elem)
+          end
+        end
+      else
+        operation = case type
+          when 'string';       :to_s
+          when 'integer';      :to_i
+          when 'double';       :to_f
+          when 'boolean';      lambda{|dat| dat === "0" ? false : !!dat}
+          when 'date';         :to_date
+          when 'datetime';     :to_datetime
+          when 'time';         :to_time
+          when 'base64Binary'; lambda{|dat| Base64.decode64(dat)}
+          else raise RuntimeError, "Invalid WashOut simple type: #{type}"
+        end
+
+        begin
+          if data.nil?
+            data
+          elsif @multiplied
+            return data.map{|x| x.send(operation)} if operation.is_a?(Symbol)
+            return data.map{|x| operation.call(x)} if operation.is_a?(Proc)
+          elsif operation.is_a? Symbol
+            data.send(operation)
+          else
+            operation.call(data)
+          end
+        rescue
+          raise Error, "Invalid SOAP parameter '#{key}' format"
+        end
+      end
+    end
+
+    # Checks if this Param defines a complex type.
+    def struct?
+      type == 'struct'
+    end
+
+    def classified?
+      !source_class.nil?
+    end
+
+    def basic_type
+      return name unless classified?
+      return source_class.wash_out_param_name(@soap_config)
+    end
+
+    def xsd_type
+      return 'int' if type.to_s == 'integer'
+      return 'dateTime' if type.to_s == 'datetime'
+      return type
+    end
+
+    # Returns a WSDL namespaced identifier for this type.
+    def namespaced_type
+      struct? ? "tns:#{basic_type}" : "xsd:#{xsd_type}"
+    end
+
+    # Parses a +definition+. The format of the definition is best described
+    # by the following BNF-like grammar.
+    #
+    #   simple_type := :string | :integer | :double | :boolean
+    #   nested_type := type_hash | simple_type | WashOut::Param instance
+    #   type_hash   := { :parameter_name => nested_type, ... }
+    #   definition  := [ WashOut::Param, ... ] |
+    #                  type_hash |
+    #                  simple_type
+    #
+    # If a simple type is passed as the +definition+, a single Param is returned
+    # with the +name+ set to "value".
+    # If a WashOut::Param instance is passed as a +nested_type+, the corresponding
+    # +:parameter_name+ is ignored.
+    #
+    # This function returns an array of WashOut::Param objects.
+    def self.parse_def(soap_config, definition)
+      raise RuntimeError, "[] should not be used in your params. Use nil if you want to mark empty set." if definition == []
+      return [] if definition == nil
+
+      if definition.is_a?(Class) && definition.ancestors.include?(WashOut::Type)
+        definition = definition.wash_out_param_map
+      end
+
+      if [Array, Symbol].include?(definition.class)
+        definition = { :value => definition }
+      end
+
+      if definition.is_a? Hash
+        definition.map do |name, opt|
+          if opt.is_a? WashOut::Param
+            opt
+          elsif opt.is_a? Array
+            WashOut::Param.new(soap_config, name, opt[0], true)
+          else
+            WashOut::Param.new(soap_config, name, opt)
+          end
+        end
+      else
+        raise RuntimeError, "Wrong definition: #{definition.inspect}"
+      end
+    end
+
+    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
+    end
+
+    private
+
+    # Used to load an entire structure.
+    def map_struct(data)
+      unless data.is_a?(Hash)
+        raise Error, "SOAP message structure is broken"
+      end
+
+      data   = data.with_indifferent_access
+      struct = {}.with_indifferent_access
+
+      # 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
+        end
+      end
+
+      struct
+    end
+  end
+end
+end

data/lib/sinatra/soap/request.rb

@@ -0,0 +1,63 @@
+require "nori"
+
+module Sinatra
+  module Soap
+    class Request
+
+      attr_reader :wsdl, :action, :env, :request, :params
+
+      def initialize(env, request, params)
+        @env = env
+        @request = request
+        @params = params
+        parse_request
+      end
+
+
+      def execute
+        request_block = wsdl.block
+        response_hash = self.instance_eval(&request_block)
+        Soap::Response.new(wsdl, response_hash)
+      end
+
+      alias_method :orig_params, :params
+
+      def action
+        return orig_params[:action] unless orig_params[:action].nil?
+        orig_params[:action] = env['HTTP_SOAPACTION'].to_s.gsub(/^"(.*)"$/, '\1').to_sym
+      end
+
+
+      def params 
+        return orig_params[:soap] unless orig_params[:soap].nil?
+        rack_input = env["rack.input"].read
+        env["rack.input"].rewind
+        orig_params[:soap] = nori.parse(rack_input)[:Envelope][:Body][action]
+      end
+
+
+      def wsdl
+        @wsdl = Soap::Wsdl.new(action)
+      end
+
+      private
+
+      def parse_request
+        action
+        params
+      end
+
+      def nori(snakecase=false)
+        Nori.new(
+          :strip_namespaces => true,
+          :advanced_typecasting => true,
+          :convert_tags_to => (
+            snakecase ? lambda { |tag| tag.snakecase.to_sym } 
+                      : lambda { |tag| tag.to_sym }
+          )
+        )
+      end
+
+    end
+  end
+end

data/lib/sinatra/soap/response.rb

@@ -0,0 +1,13 @@
+module Sinatra
+  module Soap
+    class Response
+
+      attr_reader :wsdl, :params
+
+      def initialize(wsdl, params)
+        @wsdl = wsdl
+        @params = params
+      end
+    end
+  end
+end

data/lib/sinatra/soap/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Soap
+    VERSION = "0.1.8"
+  end
+end

data/lib/sinatra/soap/wsdl.rb

@@ -0,0 +1,39 @@
+module Sinatra
+  module Soap
+    class Wsdl
+
+      @@actions = {}
+
+      def self.actions
+        @@actions
+      end
+
+      def self.register(name, *args, &block)
+        @@actions[name] = {}
+        args = args.pop || {}
+        args.each do |key, value|
+          @@actions[name][key] = value || {}
+        end
+        @@actions[name][:block] = block if block_given?
+      end
+
+      def self.generate
+      end
+
+      attr_accessor :action, :block, :arguments
+
+      def initialize(action)
+        data = all[action]
+        raise Soap::Error, "Undefined Soap Action" if data.nil?
+        @action = action
+        @block = data[:block]
+        @arguments = data.select {|k,v| k != :block}
+      end
+
+      def all
+        @@actions
+      end
+
+    end
+  end
+end

data/lib/sinatra/views/error.builder

@@ -0,0 +1,10 @@
+xml.instruct!
+xml.tag! 'soap:Envelope', 'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
+      '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 'Client'
+      xml.faultstring e.message
+    end
+  end
+end

data/lib/sinatra/views/response.builder

@@ -0,0 +1,11 @@
+xml.instruct!
+xml.tag! 'soap:Envelope', 'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
+        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance' do
+  xml.tag! 'soap:Body' do
+    xml.tag! "soap:#{wsdl.action}Response" do
+      params.each do |key, value| 
+        xml.tag! key, value
+      end
+    end
+  end
+end

data/lib/sinatra/views/wsdl.builder

@@ -0,0 +1,77 @@
+xml.instruct!
+xml.definitions 'xmlns' => 'http://schemas.xmlsoap.org/wsdl/',
+                'xmlns:tns' => settings.namespace,
+                'xmlns:soap' => 'http://schemas.xmlsoap.org/wsdl/soap/',
+                'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+                'xmlns:soap-enc' => 'http://schemas.xmlsoap.org/soap/encoding/',
+                'xmlns:wsdl' => 'http://schemas.xmlsoap.org/wsdl/',
+                'name' => settings.service,
+                'targetNamespace' => settings.namespace do
+
+  xml.types do
+    xml.tag! "schema", :targetNamespace => settings.namespace, :xmlns => 'http://www.w3.org/2001/XMLSchema' do
+      defined = []
+      wsdl.each do |operation, formats|
+        formats[:in]||={}
+        formats[:out]||={}
+        formats[:in].each do |p|
+          wsdl_type xml, p, defined
+        end
+        formats[:out].each do |p|
+          wsdl_type xml, p, defined
+        end
+      end
+    end
+  end
+
+  xml.portType :name => "#{settings.service}_port" do
+    wsdl.keys.each do |operation|
+      xml.operation :name => operation do
+        xml.input :message => "tns:#{operation}"
+        xml.output :message => "tns:#{operation}Response"
+      end
+    end
+  end
+
+  xml.binding :name => "#{settings.service}_binding", :type => "tns:#{settings.service}_port" do
+    xml.tag! "soap:binding", :style => 'document', :transport => 'http://schemas.xmlsoap.org/soap/http'
+    wsdl.keys.each do |operation|
+      xml.operation :name => operation do
+        xml.tag! "soap:operation", :soapAction => operation
+        xml.input do
+          xml.tag! "soap:body",
+            :use => "literal",
+            :namespace => settings.namespace
+        end
+        xml.output do
+          xml.tag! "soap:body",
+            :use => "literal",
+            :namespace => settings.namespace
+        end
+      end
+    end
+  end
+
+  xml.service :name => "service" do
+    xml.port :name => "#{settings.service}_port", :binding => "tns:#{settings.service}_binding" do
+      xml.tag! "soap:address", :location => "http://#{request.host_with_port}#{settings.endpoint}"
+    end
+  end
+
+  wsdl.each do |operation, formats|
+    xml.message :name => "#{operation}" do
+      formats[:in] ||= []
+      formats[:in].each do |p|
+        xml.part wsdl_occurence(p, false)
+#, :name => param.name, :type => param.namespaced_type)
+      end
+    end
+    xml.message :name => "#{operation}Response" do
+      formats[:out] ||= []
+      formats[:out].each do |p|
+        xml.part wsdl_occurence(p, false)
+#, :name => param.name, :type => param.namespaced_type)
+      end
+    end
+  end
+end

data/sinatra-soap.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/soap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra-soap-current"
+  spec.version       = Sinatra::Soap::VERSION
+  spec.authors       = ["Ivan Shamatov"]
+  spec.email         = ["eric@deployfx.com"]
+  spec.description   = %q{Sinatra-soap gem makes task to create SOAP API really simple. Inspired by WashOut gem for Rails. But remember, the only reason why you should use SOAP is legacy code.}
+  spec.summary       = %q{Handling SOAP requests for sinatra inspired by washout}
+  spec.homepage      = "https://github.com/IvanShamatov/sinatra-soap"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "byebug"
+
+
+  spec.add_runtime_dependency "builder"
+  spec.add_runtime_dependency "sinatra"
+  spec.add_runtime_dependency "nori", ">= 2.0.0"
+  spec.add_runtime_dependency "nokogiri"
+end

data/spec/request_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe "Request" do
+  def app
+    SoapApp 
+  end
+
+  before :each do 
+    headers = {"HTTP_SOAPACTION" => 'test'}
+    message = '<?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsdl="any" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><wsdl:test><par>one</par><par2>bar</par2><foo>wat</foo></wsdl:test></env:Body></env:Envelope>'
+    post '/action', message, headers
+    @request = Sinatra::Soap::Request.new(last_request.env, last_request, last_request.params)
+  end
+
+  it "should get soap_action" do 
+    expect(@request.action).to eq(:test)
+  end
+
+  it "should get soap arguments" do 
+    expect(@request.params).to eq({par: "one", par2: "bar", foo: "wat"})
+  end
+
+  it "should build response" do 
+    expect(@request.execute).to be_an_instance_of(Sinatra::Soap::Response)
+  end
+
+  #it "should validate input with WSDL" do 
+  #  pending
+  #end
+end

data/spec/soap_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+
+describe 'A default soap sinatra application' do
+  def app
+    SoapApp 
+  end
+
+  it "should parse soap request and send response" do
+    headers = {"HTTP_SOAPACTION" => 'test'}
+    message = '<?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsdl="any" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><wsdl:test><par>one</par><par2>bar</par2><foo>wat</foo></wsdl:test></env:Body></env:Envelope>'
+    post '/action', message, headers
+    response =<<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<soap:Envelope xmlns:soap=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">
+  <soap:Body>
+    <soap:testResponse>
+      <par>one</par>
+      <par2>bar</par2>
+      <foo>wat</foo>
+    </soap:testResponse>
+  </soap:Body>
+</soap:Envelope>
+    XML
+    expect(last_response.body).to eq(response)
+  end
+
+
+  it "should raise soap fault on unknown action" do
+    headers = {"HTTP_SOAPACTION" => 'test2'}
+    message = '<?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:wsdl="any" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><wsdl:test><par>one</par><par2>bar</par2><foo>wat</foo></wsdl:test></env:Body></env:Envelope>'
+    post '/action', message, headers
+    response =<<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soap:Body>
+    <soap:Fault encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+      <faultcode>Client</faultcode>
+      <faultstring>Undefined Soap Action</faultstring>
+    </soap:Fault>
+  </soap:Body>
+</soap:Envelope>
+    XML
+    expect(last_response.body).to eq(response)
+  end
+
+  it "should have endpoint for soap actions" do
+    endpoint = app.routes["POST"].select {|k| k[0].to_s.match('action')}.count
+    expect(endpoint).to eq 1
+  end
+
+  it "should have route for wsdl" do
+    wsdl = app.routes["GET"].select {|k| k[0].to_s.match('wsdl')}.count
+    expect(wsdl).to eq(1)
+  end
+
+  it "should return a usable soap views directory" do
+    view_search = File.join(app.views, "*.builder")
+    expect(Dir.glob(view_search).count).to be > 0
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+ENV['RACK_ENV'] = 'test'
+require File.join(File.join(File.expand_path(File.dirname(__FILE__))), '..', 'lib', 'sinatra', 'soap')
+require 'rspec'
+require 'rack/test'
+
+class SoapApp < Sinatra::Base
+  register Sinatra::Soap
+  soap :test do
+    params
+  end
+
+  soap :add_circle, in: {circle: {center: {x: :integer, y: :integer}, 
+                                  radius: :double}},
+            				out: nil do
+  	params #=> {circle: {center: {x: 3, y: 2}, radius: 12.0} }
+  	nil
+	end
+end
+
+module RSpecMixin
+  include Rack::Test::Methods
+end
+
+RSpec.configure { |c| c.include RSpecMixin }

data/spec/views/error.builder

@@ -0,0 +1,10 @@
+xml.instruct!
+xml.tag! 'soap:Envelope', 'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
+      '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 'Client'
+      xml.faultstring e.message
+    end
+  end
+end

data/spec/views/response.builder

@@ -0,0 +1,11 @@
+xml.instruct!
+xml.tag! 'soap:Envelope', 'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/',
+        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance' do
+  xml.tag! 'soap:Body' do
+    xml.tag! "soap:#{wsdl.action}Response" do
+      params.each do |key, value| 
+        xml.tag! key, value
+      end
+    end
+  end
+end

data/spec/views/wsdl.builder

@@ -0,0 +1,73 @@
+xml.instruct!
+xml.definitions 'xmlns' => 'http://schemas.xmlsoap.org/wsdl/',
+                'xmlns:tns' => settings.namespace,
+                'xmlns:soap' => 'http://schemas.xmlsoap.org/wsdl/soap/',
+                'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+                'xmlns:soap-enc' => 'http://schemas.xmlsoap.org/soap/encoding/',
+                'xmlns:wsdl' => 'http://schemas.xmlsoap.org/wsdl/',
+                'name' => settings.service,
+                'targetNamespace' => settings.namespace do
+
+  xml.types do
+    xml.tag! "schema", :targetNamespace => settings.namespace, :xmlns => 'http://www.w3.org/2001/XMLSchema' do
+      defined = []
+      wsdl.each do |operation, formats|
+        formats[:in]||={}
+        formats[:out]||={}
+        formats[:in].each do |p|
+          wsdl_type xml, p, defined
+        end
+        formats[:out].each do |p|
+          wsdl_type xml, p, defined
+        end
+      end
+    end
+  end
+
+  xml.portType :name => "#{settings.service}_port" do
+    wsdl.keys.each do |operation|
+      xml.operation :name => operation do
+        xml.input :message => "tns:#{operation}"
+        xml.output :message => "tns:#{operation}Response"
+      end
+    end
+  end
+
+  xml.binding :name => "#{settings.service}_binding", :type => "tns:#{settings.service}_port" do
+    xml.tag! "soap:binding", :style => 'document', :transport => 'http://schemas.xmlsoap.org/soap/http'
+    wsdl.keys.each do |operation|
+      xml.operation :name => operation do
+        xml.tag! "soap:operation", :soapAction => operation
+        xml.input do
+          xml.tag! "soap:body",
+            :use => "literal",
+            :namespace => settings.namespace
+        end
+        xml.output do
+          xml.tag! "soap:body",
+            :use => "literal",
+            :namespace => settings.namespace
+        end
+      end
+    end
+  end
+
+  xml.service :name => "service" do
+    xml.port :name => "#{settings.service}_port", :binding => "tns:#{settings.service}_binding" do
+      xml.tag! "soap:address", :location => send("#{settings.service}_action_url")
+    end
+  end
+
+  wsdl.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}Response}" do
+      formats[:out].each do |p|
+        xml.part wsdl_occurence(p, false, :name => p.name, :type => p.namespaced_type)
+      end
+    end
+  end
+end

data/spec/wsdl_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+
+describe "WSDL" do
+
+  def wsdl 
+    Sinatra::Soap::Wsdl
+  end
+
+  it "should hold registered actions with arguments and blocks" do
+    [:test, :add_circle].each do |action|
+      expect(wsdl.actions).to include(action)
+    end
+  end 
+
+  it "should hold blocks for registered actions" do
+    [:test, :add_circle].each do |action|
+      expect(wsdl.actions[action]).to include(:block)
+    end
+  end
+
+  it "should hould arguments types" do
+    expect(wsdl.actions[:add_circle]).to include(:in)
+    expect(wsdl.actions[:add_circle]).to include(:out)
+  end
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-soap-current
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+platform: ruby
+authors:
+- Ivan Shamatov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sinatra-soap gem makes task to create SOAP API really simple. Inspired
+  by WashOut gem for Rails. But remember, the only reason why you should use SOAP
+  is legacy code.
+email:
+- eric@deployfx.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/Gemfile
+- examples/app.rb
+- examples/client.rb
+- lib/sinatra/soap.rb
+- lib/sinatra/soap/dsl_methods.rb
+- lib/sinatra/soap/error.rb
+- lib/sinatra/soap/helper_methods.rb
+- lib/sinatra/soap/param.rb
+- lib/sinatra/soap/request.rb
+- lib/sinatra/soap/response.rb
+- lib/sinatra/soap/version.rb
+- lib/sinatra/soap/wsdl.rb
+- lib/sinatra/views/error.builder
+- lib/sinatra/views/response.builder
+- lib/sinatra/views/wsdl.builder
+- sinatra-soap.gemspec
+- spec/request_spec.rb
+- spec/soap_spec.rb
+- spec/spec_helper.rb
+- spec/views/error.builder
+- spec/views/response.builder
+- spec/views/wsdl.builder
+- spec/wsdl_spec.rb
+homepage: https://github.com/IvanShamatov/sinatra-soap
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Handling SOAP requests for sinatra inspired by washout
+test_files:
+- spec/request_spec.rb
+- spec/soap_spec.rb
+- spec/spec_helper.rb
+- spec/views/error.builder
+- spec/views/response.builder
+- spec/views/wsdl.builder
+- spec/wsdl_spec.rb