sinatra-soap 0.1.4 → 0.1.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODgxNTkzMGM0NzM2NWQwM2U1NDdkYzlkYWU5YWUyMjA5Y2EyNWFjYQ==
+    ZTQ4NzFhOWQyMzE0NDkzYjJmZDAzZjZmYzUyNGVlZTEyYzA5MzQ2Ng==
   data.tar.gz: !binary |-
-    NTcyMjRlYjNkZGNjYWVmYjY1NzExYjEwNGI0ZGI1Y2FhODIwOGIzYQ==
+    ZDY2YjA5M2IwOWJmOWE0NjE0MDFhYTdhZWE4ZTFjNWJhNjgzODliYQ==
 SHA512:
   metadata.gz: !binary |-
-    ODVmODE5OTQxODUyMmQ2MDJiMjlkNjFmZjZmMWFiZWViNWFlYTlmODg0NTc1
-    YzRmNmNlZGVlYmI0NDU4NGQ2YWVjNDkxMjkzNjdmMDk2Nzc0ZjNjOWRmOGYw
-    MWMyNzk5MjFmN2RjZDdkZmQyMjFjNWExZmNjYjE2NjQ0ZjlkMDk=
+    MjE1NGM1ODRmODU3ZmZjYjNkODhmNjM0NjE2Nzg4ZDZjZDQ5ODg0NDBjMzdm
+    MzI5MGM0ZGMxZDJjNzI5ZjNiMjdhZWY2ZDgwMDM4MmVhNTY3MTM4ZWVkY2I2
+    YzU4OWNiMzRiOTg2MTU3NWY1NzMxNjc3YzQ2YjEwOTU5OWUzNDc=
   data.tar.gz: !binary |-
-    MjUwZGYwMjBmMjI5NDZjZjlkOTViNmYzODU2ZDY3NTkzNjE5MjE0OWZlYzU5
-    ZmE4MzY4NTRhYzNlMjcwNGExNGJlYjc2ZDA4NWMzYmU2OGI5YmUwZDQyYjI5
-    OTI2ZGJkNTA5ZGVjYTBlYzZhYWJiMWExODUxZDdkNzk2M2NkY2U=
+    ODA0YThhZTAxMzZlMDVlNGFmOWU0YWQ3MDEwYTVmMGE2YzkyMDcyY2FmMWJi
+    ZDc0NTJkYzI0MGE3NmZiNzI1NmJhYWNkNmE3MTM1YjQwMjJlMDM4ZmYzNTg3
+    MmI0ZjU0M2VhMzNjY2YzYmE2YTdkNTI5ZWEyYjBhNzNiNDExYjY=

data/README.md

@@ -7,12 +7,7 @@ Sinatra-soap gem makes task to create SOAP API really simple. Inspired by WashOu
 
 ## Overview
 
-In case of simplicity and quick first working release:
- 
- - WSDL would not be generated
- - WSDL would not be checked
- - Response would be ```"#{soap_action}Response"``` and types would guessed.
-
+In case of simplicity and quick first working release: 
 
 ## Usage
 
@@ -22,7 +17,7 @@ A classic application would work like that:
 require 'sinatra'
 require 'sinatra/soap'
 
-soap "SomeAction" do |params|
+soap "SomeAction"
   do_something_with_params # hash to be returned
 end
 ```
@@ -38,7 +33,7 @@ class SoapAPI < Sinatra::Base
   #remember to register extenstion if you are using modular style
   register Sinatra::Soap 
 
-  soap "SomeAction" do |params|
+  soap "SomeAction"
     params # hash to be returned
   end
 end

data/examples/app.rb

@@ -1,16 +1,10 @@
 require 'sinatra/base'
 require 'sinatra/soap'
 
-# require './lib/sinatra/soap/wsdl'
-# require './lib/sinatra/soap/helpers'
 class App < Sinatra::Base
   register Sinatra::Soap
-  soap :test do |params|
-    puts params.inspect
-  end
-
-  get '/' do
-    puts params.inspect
+  soap :test do
+    params
   end
 end
-puts App.run!
+App.run!

data/lib/sinatra/soap.rb

@@ -1,66 +1,35 @@
 require "sinatra/base"
 require "sinatra/soap/version"
-require "sinatra/soap/helpers"
 require "sinatra/soap/wsdl"
 require "sinatra/soap/error"
-# require "sinatra/soap/builder"
+require "sinatra/soap/dsl_methods"
+require "sinatra/soap/request_context_methods"
+require "sinatra/soap/request"
+require "sinatra/soap/response"
 require "builder"
 
 
 module Sinatra
   module Soap
 
-    # soap :LogEvent, 
-    #      args: {},
-    #      return: {},
-    #      namespace: "",
-    #      to: method_name do
-    # end
-    def soap(name, *args, &block)
-      Soap::Wsdl.instance.register_action(name, *args, &block)
-    end
+    include DslMethods
 
     def self.registered(app)
-      app.helpers Sinatra::Soap::Helpers
+      app.helpers Soap::RequestContextMethods
+
       app.set :soap_path, '/action' unless defined?(app.settings.soap_path)
       app.set :wsdl_path, '/wsdl' unless defined?(app.settings.wsdl_path)
 
       app.post(app.settings.soap_path) do
-        begin
-          response = call_action_block
-          builder do |xml|
-            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:#{params[:action]}Response" do
-                  response.each do |key, value| 
-                    xml.tag! key, value
-                  end
-                end
-              end
-            end
-          end
-        rescue Soap::SoapFault => e
-          builder do |xml|
-            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
-          end
-        end
+        content_type 'text/xml'
+        call_action_block
       end
 
       app.get(app.settings.wsdl_path) do 
-        wsdl.generate
+        get_wsdl
       end
     end
+
   end
   Delegator.delegate :soap
   register Soap

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

@@ -1,5 +1,5 @@
 module Sinatra
   module Soap
-    class SoapFault < StandardError; end
+    class Error < StandardError; 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/request_context_methods.rb

@@ -0,0 +1,19 @@
+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/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

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

data/lib/sinatra/soap/wsdl.rb

@@ -1,34 +1,41 @@
-require 'singleton'
-
 module Sinatra
   module Soap
     class Wsdl
-      include Singleton
 
-      attr_accessor :actions, :namespace
+      # class << self
+      #   attr_accessor :actions
+      # end
+      @@actions = {}
 
-      def initialize
-        @actions = {}
+      def self.register(name, *args, &block)
+        @@actions = {} if @@actions.nil?
+        @@actions[name] = {}
+        args = args.pop
+        unless args.nil?
+          args.each do |key, value|
+            @@actions[name][key] = value
+          end
+        end
+        @@actions[name][:block] = block if block_given?
       end
 
-      def generate
-        # raise "Not implemented"
+      def self.generate
       end
 
-      def [](key)
-        actions[key]
+      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 register_action(name, *args, &block)
-        actions[name] = {}
-        args = args.pop
-        unless args.nil?
-          args.each do |key, value|
-            actions[name][key] = value
-          end
-        end
-        actions[name][:block] = block if block_given?
+      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/sinatra-soap.gemspec

@@ -22,9 +22,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "builder"
+  spec.add_development_dependency "debugger"
+
 
   spec.add_dependency "sinatra"
   spec.add_dependency "nori", ">= 2.0.0"
   spec.add_dependency "nokogiri"
-  spec.add_dependency "builder"
 end

data/spec/request_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe "Request" do
+  it "should get soap_action" do 
+    pending
+  end
+
+  it "should get soap arguments" do 
+    pending
+  end
+
+  it "should build response" do 
+    pending
+  end
+
+  it "should validate input with WSDL" do 
+    pending
+  end
+end

data/spec/response_spec.rb

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

data/spec/soap_spec.rb

@@ -1,20 +1,4 @@
-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|
-    params
-  end
-end
-
-module RSpecMixin
-  include Rack::Test::Methods
-end
-
-RSpec.configure { |c| c.include RSpecMixin }
+require 'spec_helper'
 
 
 describe 'A default soap sinatra application' do

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+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
+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/wsdl_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+
+describe "WSDL" do
+  it "should hold registered actions with arguments and blocks" do
+    pending
+  end 
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-soap
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Ivan Shamatov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2013-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,13 +67,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,21 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nori
+  name: debugger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -109,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: builder
+  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:
     - - ! '>='
@@ -140,12 +154,23 @@ files:
 - Rakefile
 - examples/app.rb
 - lib/sinatra/soap.rb
+- lib/sinatra/soap/dsl_methods.rb
 - lib/sinatra/soap/error.rb
-- lib/sinatra/soap/helpers.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
 - 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/wsdl_spec.rb
 homepage: https://github.com/IvanShamatov/sinatra-soap
 licenses:
 - MIT
@@ -171,4 +196,10 @@ signing_key:
 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/wsdl_spec.rb

data/lib/sinatra/soap/helpers.rb

@@ -1,46 +0,0 @@
-require "nori"
-
-module Sinatra
-  module Soap
-    module Helpers
-
-      def call_action_block
-        parse_request
-        wsdl[params[:action]][:block].call(params[:soap][params[:action]])
-      end
-
-      def parse_request
-        action = soap_action
-        soap_params
-        raise Soap::SoapFault, "Undefined Soap Action" unless wsdl.actions.include?(action)
-      end
-
-      def soap_action
-        return params[:action] unless params[:action].nil?
-        params[:action] = env['HTTP_SOAPACTION'].to_s.gsub(/^"(.*)"$/, '\1').to_sym
-      end
-
-      def soap_params 
-        return params[:soap] unless params[:soap].nil?
-        rack_input = env["rack.input"].read
-        env["rack.input"].rewind
-        params[:soap] = nori.parse(rack_input)[:Envelope][:Body]
-      end
-
-      def wsdl
-        Soap::Wsdl.instance
-      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