sinatra-soap 0.1.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODgxNTkzMGM0NzM2NWQwM2U1NDdkYzlkYWU5YWUyMjA5Y2EyNWFjYQ==
+  data.tar.gz: !binary |-
+    NTcyMjRlYjNkZGNjYWVmYjY1NzExYjEwNGI0ZGI1Y2FhODIwOGIzYQ==
+SHA512:
+  metadata.gz: !binary |-
+    ODVmODE5OTQxODUyMmQ2MDJiMjlkNjFmZjZmMWFiZWViNWFlYTlmODg0NTc1
+    YzRmNmNlZGVlYmI0NDU4NGQ2YWVjNDkxMjkzNjdmMDk2Nzc0ZjNjOWRmOGYw
+    MWMyNzk5MjFmN2RjZDdkZmQyMjFjNWExZmNjYjE2NjQ0ZjlkMDk=
+  data.tar.gz: !binary |-
+    MjUwZGYwMjBmMjI5NDZjZjlkOTViNmYzODU2ZDY3NTkzNjE5MjE0OWZlYzU5
+    ZmE4MzY4NTRhYzNlMjcwNGExNGJlYjc2ZDA4NWMzYmU2OGI5YmUwZDQyYjI5
+    OTI2ZGJkNTA5ZGVjYTBlYzZhYWJiMWExODUxZDdkNzk2M2NkY2U=

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,51 @@
+# Sinatra::Soap — Under construction
+
+[![Build Status](https://travis-ci.org/IvanShamatov/sinatra-soap.png?branch=master)](https://travis-ci.org/IvanShamatov/sinatra-soap) [![Code Climate](https://codeclimate.com/github/IvanShamatov/sinatra-soap.png)](https://codeclimate.com/github/IvanShamatov/sinatra-soap) [![Gem Version](https://badge.fury.io/rb/sinatra-soap.png)](http://badge.fury.io/rb/sinatra-soap)
+
+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:
+ 
+ - WSDL would not be generated
+ - WSDL would not be checked
+ - Response would be ```"#{soap_action}Response"``` and types would guessed.
+
+
+## Usage
+
+A classic application would work like that: 
+
+```ruby
+require 'sinatra'
+require 'sinatra/soap'
+
+soap "SomeAction" do |params|
+  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|
+    params # hash to be returned
+  end
+end
+```
+
+
+
+
+
+

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/app.rb

@@ -0,0 +1,16 @@
+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
+  end
+end
+puts App.run!

data/lib/sinatra/soap.rb

@@ -0,0 +1,67 @@
+require "sinatra/base"
+require "sinatra/soap/version"
+require "sinatra/soap/helpers"
+require "sinatra/soap/wsdl"
+require "sinatra/soap/error"
+# require "sinatra/soap/builder"
+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
+
+    def self.registered(app)
+      app.helpers Sinatra::Soap::Helpers
+      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
+      end
+
+      app.get(app.settings.wsdl_path) do 
+        wsdl.generate
+      end
+    end
+  end
+  Delegator.delegate :soap
+  register Soap
+end

data/lib/sinatra/soap/error.rb

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

data/lib/sinatra/soap/helpers.rb

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

data/lib/sinatra/soap/version.rb

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

data/lib/sinatra/soap/wsdl.rb

@@ -0,0 +1,34 @@
+require 'singleton'
+
+module Sinatra
+  module Soap
+    class Wsdl
+      include Singleton
+
+      attr_accessor :actions, :namespace
+
+      def initialize
+        @actions = {}
+      end
+
+      def generate
+        # raise "Not implemented"
+      end
+
+      def [](key)
+        actions[key]
+      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?
+      end
+    end
+  end
+end

data/sinatra-soap.gemspec

@@ -0,0 +1,30 @@
+# 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"
+  spec.version       = Sinatra::Soap::VERSION
+  spec.authors       = ["Ivan Shamatov"]
+  spec.email         = ["status.enable@gmail.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_dependency "sinatra"
+  spec.add_dependency "nori", ">= 2.0.0"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "builder"
+end

data/spec/soap_spec.rb

@@ -0,0 +1,74 @@
+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 }
+
+
+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
+    last_response.body.should == 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
+    last_response.body.should == 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
+  end
+
+  it "should have route for wsdl" do
+    wsdl = app.routes["GET"].select {|k| k[0].to_s.match('wsdl')}.count
+    wsdl.should == 1
+  end
+
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-soap
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Ivan Shamatov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-28 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: 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'
+- !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'
+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:
+- status.enable@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/app.rb
+- lib/sinatra/soap.rb
+- lib/sinatra/soap/error.rb
+- lib/sinatra/soap/helpers.rb
+- lib/sinatra/soap/version.rb
+- lib/sinatra/soap/wsdl.rb
+- sinatra-soap.gemspec
+- spec/soap_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.1.10
+signing_key: 
+specification_version: 4
+summary: Handling SOAP requests for sinatra inspired by washout
+test_files:
+- spec/soap_spec.rb