sinatra-soap 0.1.5 → 0.1.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTQ4NzFhOWQyMzE0NDkzYjJmZDAzZjZmYzUyNGVlZTEyYzA5MzQ2Ng==
+    MWUwYzNjZWUyM2I2ZDZhZmFkNzM0NmVjMmQxM2QwMTJlN2E1OGIwMg==
   data.tar.gz: !binary |-
-    ZDY2YjA5M2IwOWJmOWE0NjE0MDFhYTdhZWE4ZTFjNWJhNjgzODliYQ==
+    ZGRmYTMyMmYyMTFhYjI4OTU3OWNhMTc3ZmM3MjE0YTRjNTNmNzc0Yg==
 SHA512:
   metadata.gz: !binary |-
-    MjE1NGM1ODRmODU3ZmZjYjNkODhmNjM0NjE2Nzg4ZDZjZDQ5ODg0NDBjMzdm
-    MzI5MGM0ZGMxZDJjNzI5ZjNiMjdhZWY2ZDgwMDM4MmVhNTY3MTM4ZWVkY2I2
-    YzU4OWNiMzRiOTg2MTU3NWY1NzMxNjc3YzQ2YjEwOTU5OWUzNDc=
+    OTdmYWEyYWQyZjY1MWNlNzQxMjc4YzdmZjFiNTEwNTQ4NjlhNzk2NmExNjY4
+    ZWJkYjE2YzE4ZTlhMjI2YjNjMTVkYzRmMzg0YzQwNGFkYWYwMGY1NGIxZGVj
+    OWY3MzhhNmJkNmQ5YTQxZWQ2YzMzMTRhNjljNWQ3NGJkZDUzYzY=
   data.tar.gz: !binary |-
-    ODA0YThhZTAxMzZlMDVlNGFmOWU0YWQ3MDEwYTVmMGE2YzkyMDcyY2FmMWJi
-    ZDc0NTJkYzI0MGE3NmZiNzI1NmJhYWNkNmE3MTM1YjQwMjJlMDM4ZmYzNTg3
-    MmI0ZjU0M2VhMzNjY2YzYmE2YTdkNTI5ZWEyYjBhNzNiNDExYjY=
+    NWJiZDVjZjNjM2MwZmZhYjlmMDQ5NmMxNDE4NWY5Y2FlYzBhYmExZmM0MDZm
+    YTUwYmFmMDM1YWVmYzcwODBmZWM2Y2Q2ZTc4MDdhODE2ZTcwN2VkMTNkMzMy
+    YzAxNzM3Yjk3YjEwYWY1MzI1NzFiMDE1MmMwM2E0ZTUwYzFiMWM=

data/README.md

@@ -17,7 +17,7 @@ A classic application would work like that:
 require 'sinatra'
 require 'sinatra/soap'
 
-soap "SomeAction"
+soap "SomeAction" do
   do_something_with_params # hash to be returned
 end
 ```
@@ -33,14 +33,82 @@ class SoapAPI < Sinatra::Base
   #remember to register extenstion if you are using modular style
   register Sinatra::Soap 
 
-  soap "SomeAction"
+  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/lib/sinatra/soap.rb

@@ -3,7 +3,7 @@ require "sinatra/soap/version"
 require "sinatra/soap/wsdl"
 require "sinatra/soap/error"
 require "sinatra/soap/dsl_methods"
-require "sinatra/soap/request_context_methods"
+require "sinatra/soap/helper_methods"
 require "sinatra/soap/request"
 require "sinatra/soap/response"
 require "builder"
@@ -15,21 +15,23 @@ module Sinatra
     include DslMethods
 
     def self.registered(app)
-      app.helpers Soap::RequestContextMethods
+      app.helpers Soap::HelperMethods
 
-      app.set :soap_path, '/action' unless defined?(app.settings.soap_path)
-      app.set :wsdl_path, '/wsdl' unless defined?(app.settings.wsdl_path)
+      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.soap_path) do
+      app.post(app.settings.endpoint) do
         content_type 'text/xml'
         call_action_block
       end
 
-      app.get(app.settings.wsdl_path) do 
+      app.get(app.settings.wsdl_route) do 
+        content_type 'text/xml'
         get_wsdl
       end
     end
-
   end
   Delegator.delegate :soap
   register Soap

data/lib/sinatra/soap/helper_methods.rb

@@ -0,0 +1,32 @@
+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
+    end
+  end
+end

data/lib/sinatra/soap/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Soap
-    VERSION = "0.1.5"
+    VERSION = "0.1.7"
   end
 end

data/lib/sinatra/soap/wsdl.rb

@@ -2,11 +2,12 @@ module Sinatra
   module Soap
     class Wsdl
 
-      # class << self
-      #   attr_accessor :actions
-      # end
       @@actions = {}
 
+      def self.actions
+        @@actions
+      end
+
       def self.register(name, *args, &block)
         @@actions = {} if @@actions.nil?
         @@actions[name] = {}

data/lib/sinatra/views/wsdl.builder

@@ -0,0 +1,68 @@
+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]).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/request_spec.rb

@@ -1,16 +1,27 @@
 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 
-    pending
+    expect(@request.action).to eq(:test)
   end
 
   it "should get soap arguments" do 
-    pending
+    expect(@request.params).to eq({par: "one", par2: "bar", foo: "wat"})
   end
 
   it "should build response" do 
-    pending
+    expect(@request.execute).to be_an_instance_of(Sinatra::Soap::Response)
   end
 
   it "should validate input with WSDL" do 

data/spec/soap_spec.rb

@@ -5,7 +5,6 @@ describe 'A default soap sinatra application' do
   def app
     SoapApp 
   end
-  
 
   it "should parse soap request and send response" do
     headers = {"HTTP_SOAPACTION" => 'test'}
@@ -23,7 +22,7 @@ describe 'A default soap sinatra application' do
   </soap:Body>
 </soap:Envelope>
     XML
-    last_response.body.should == response
+    expect(last_response.body).to eq(response)
   end
 
 
@@ -42,17 +41,22 @@ describe 'A default soap sinatra application' do
   </soap:Body>
 </soap:Envelope>
     XML
-    last_response.body.should == response
+    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
-    endpoint.should eq 1
+    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
-    wsdl.should == 1
+    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

@@ -8,6 +8,13 @@ class SoapApp < Sinatra::Base
   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

data/spec/views/wsdl.builder

@@ -0,0 +1,68 @@
+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]).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

@@ -2,7 +2,25 @@ require 'spec_helper'
 
 
 describe "WSDL" do
+
+  def wsdl 
+    Sinatra::Soap::Wsdl
+  end
+
   it "should hold registered actions with arguments and blocks" do
-    pending
+    [: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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-soap
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Ivan Shamatov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,20 +156,21 @@ files:
 - lib/sinatra/soap.rb
 - lib/sinatra/soap/dsl_methods.rb
 - lib/sinatra/soap/error.rb
+- lib/sinatra/soap/helper_methods.rb
 - lib/sinatra/soap/request.rb
-- lib/sinatra/soap/request_context_methods.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/response_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:
@@ -197,9 +198,9 @@ specification_version: 4
 summary: Handling SOAP requests for sinatra inspired by washout
 test_files:
 - spec/request_spec.rb
-- spec/response_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

data/lib/sinatra/soap/request_context_methods.rb

@@ -1,19 +0,0 @@
-module Sinatra
-  module Soap
-    module RequestContextMethods
-
-      def call_action_block
-        request = Soap::Request.new(env, request, params)
-        response = request.execute
-        builder :response, locals: {wsdl: response.wsdl, params: response.params}
-      rescue Soap::Error => e
-        builder :error, locals: {e: e}
-      end
-
-      def get_wsdl
-        Soap::Wsdl.generate
-      end
-
-    end
-  end
-end

data/spec/response_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-
-describe "Response" do 
-
-  it "should build response" do
-    pending 
-  end
-
-  it "should build soap faults" do 
-    pending
-  end
-end