wash_out 0.1 → 0.2.0

data/lib/wash_out/dispatcher.rb

@@ -1,32 +1,63 @@
 module WashOut
+  # The WashOut::Dispatcher module should be included in a controller acting
+  # as a SOAP endpoint. It includes actions for generating WSDL and handling
+  # SOAP requests.
   module Dispatcher
-    def wsdl
-      @map       = self.class.wash_with_soap_map
-      @name      = controller_path.gsub('/', '_')
+    # A SOAPError exception can be raised to return a correct SOAP error
+    # response.
+    class SOAPError < Exception; end
+
+    # This action generates the WSDL for defined SOAP methods.
+    def _wsdl
+      @map       = self.class.soap_actions
       @namespace = 'urn:WashOut'
-      
+      @name      = controller_path.gsub('/', '_')
+
       render :template => 'wash_with_soap/wsdl'
     end
-    
-    def soap
-      @map     = self.class.wash_with_soap_map
-      @method  = request.env['HTTP_SOAPACTION'].gsub(/^\"(.*)\"$/, '\1')
-      @current = @map[@method] || @map[@method.to_sym]
-      
-      wash_out_error("Method does not exist") and return if @current.blank?
-      
-      data = Crack::XML.parse(request.raw_post).values.first.select{|k,v| k[-4,4] == "Body"}.values.first[@method]
-      
-      @soap   = @current[:in].load(data)
-      @result = @current[:out].load(send @method.to_sym)
-      
-      render :template => 'wash_with_soap/response'
+
+    # This action maps the SOAP action to a controller method defined with
+    # +soap_action+.
+    def _action
+      map       = self.class.soap_actions
+      method    = request.env['HTTP_SOAPACTION'].gsub(/^\"(.*)\"$/, '\1')
+      @_current = map[method]
+
+      raise SoapError, "Method #{method} does not exists" unless @_current
+
+      xml_data = params['Envelope']['Body'][method]
+
+      params = (xml_data || {}).map do |opt, value|
+        opt = opt.underscore
+        param = @_current[:in].find { |param| param.name == opt }
+        raise SOAPError, "unknown parameter #{opt}" unless param
+        [ opt, param.load(value) ]
+      end
+      @_params.merge!(Hash[*params.flatten])
+
+      send(@_current[:to])
+    end
+
+    def _render_soap(result, options)
+      result = { 'value' => result } unless result.is_a? Hash
+      result = HashWithIndifferentAccess.new(result)
+      result = Hash[*@_current[:out].map do |param|
+        [param, param.store(result[param.name])]
+      end.flatten]
+
+      render :template => 'wash_with_soap/response',
+             :locals => { :result => result }
+    end
+
+    private
+
+    def self.included(controller)
+      controller.send :rescue_from, SOAPError, :with => :_render_soap_error
     end
-    
-  private
-    
-    def wash_out_error(description)
-      @error = description and render :template => 'wash_with_soap/error'
+
+    def _render_soap_error(error)
+      render :template => 'wash_with_soap/error', :status => 500,
+             :locals => { :error_message => error.message }
     end
   end
-end
+end

data/lib/wash_out/engine.rb

@@ -0,0 +1,4 @@
+module WashOut
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/wash_out/param.rb

@@ -4,63 +4,95 @@ module WashOut
     attr_accessor :map
     attr_accessor :type
     attr_accessor :multiplied
-    
-    attr_accessor :value
-    def value
-      struct? ? map : @value
-    end
-    
-    def [](key)
-      map[key]
-    end
-    
-    def struct?
-      type == 'struct'
-    end
-    
-    def namespaced_type
-      struct? ? "typens:#{name}" : "xsd:#{type}"
-    end
-    
+
+    # Defines a WSDL parameter with name +name+ and type specifier +type+.
+    # The type specifier format is described in #parse_def.
     def initialize(name, type, multiplied = false)
       type ||= {}
-      
+
       @name       = name.to_s
       @map        = {}
       @multiplied = multiplied
 
-      if type.is_a?(Hash)
+      if type.is_a?(Symbol)
+        @type = type.to_s
+      else
         @type = 'struct'
-        
-        type.each do |name, type|
-          if type.is_a?(Array)
-            @map[name.to_s] = Param.new(name, type[0], true) 
-          else
-            @map[name.to_s] = Param.new(name, type)
-          end
+        @map  = self.class.parse_def(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)
+      if struct?
+        data = ActiveSupport::HashWithIndifferentAccess.new(data)
+        @map.map do |param|
+          param.load(data[param.name])
         end
       else
-        @type = type.to_s
+        case type
+          when 'string';  data.to_s
+          when 'integer'; data.to_i
+          when 'double';  data.to_f
+          when 'boolean'; data == 'true' # Is this bad?
+          else raise RuntimeError, "Invalid WashOut simple type: #{type}"
+        end
       end
     end
-    
-    def load(data)
+
+    # The opposite of #load.
+    def store(data)
       if struct?
-        map.each do |name, param|
-          param.load(data[name] || data[name.to_sym])
+        data = ActiveSupport::HashWithIndifferentAccess.new(data)
+        @map.map do |param|
+          param.store(data[param.name])
         end
       else
-        @value = Param.convert_scalar(data, type)
+        data.to_s
       end
-      
-      self
     end
-    
-    def self.convert_scalar(data, type)
-      return data.to_s    if type == 'string'
-      return data.to_i    if type == 'integer'
-      return data.to_f    if type == 'double'
-      return data.to_bool if type == 'boolean'
+
+    # Checks if this Param defines a complex type.
+    def struct?
+      type == 'struct'
+    end
+
+    # Returns a WSDL namespaced identifier for this type.
+    def namespaced_type
+      struct? ? "typens:#{name}" : "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(definition)
+      definition = { :value => definition } if definition.is_a? Symbol
+
+      if definition.is_a? Hash
+        definition.map do |name, opt|
+          if opt.is_a? WashOut::Param
+            opt
+          else
+            WashOut::Param.new(name, opt)
+          end
+        end
+      else
+        definition.to_a
+      end
     end
   end
-end
+end

data/lib/wash_out/soap.rb

@@ -0,0 +1,30 @@
+require 'active_support/concern'
+
+module WashOut
+  module SOAP
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      attr_accessor :soap_actions
+
+      # Define a SOAP action +action+. The function has two required +options+:
+      # :args and :return. Each is a type +definition+ of format described in
+      # WashOut::Param#parse_def.
+      #
+      # An optional option :to can be passed to allow for names of SOAP actions
+      # which are not valid Ruby function names.
+      def soap_action(action, options={})
+        self.soap_actions[action.to_s] = {
+          :in     => WashOut::Param.parse_def(options[:args]),
+          :out    => WashOut::Param.parse_def(options[:return]),
+          :to     => options[:to] || action
+        }
+      end
+    end
+
+    included do
+      include WashOut::Dispatcher
+      self.soap_actions = {}
+    end
+  end
+end

data/lib/wash_out/version.rb

@@ -0,0 +1,3 @@
+module WashOut
+  VERSION = "0.2.0"
+end

data/lib/wash_out.rb

@@ -0,0 +1,19 @@
+require 'wash_out/engine'
+require 'wash_out/param'
+require 'wash_out/dispatcher'
+require 'wash_out/soap'
+
+module ActionDispatch::Routing
+  class Mapper
+    # Adds the routes for a SOAP endpoint at +controller+.
+    def wash_out(controller)
+      match "#{controller.to_s}/wsdl" => "#{controller.to_s}#_wsdl"
+      match "#{controller.to_s}/action" => "#{controller.to_s}#_action", :defaults => { :format => 'soap' }
+    end
+  end
+end
+
+Mime::Type.register "application/soap+xml", :soap
+ActionController::Renderers.add :soap do |what, options|
+  _render_soap(what, options)
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require
+require "wash_out"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,23 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,30 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = 'b8d5d5687c012c2ef1a7a6e8006172402c48a3dcccca67c076eaad81c4712ad236ca2717c3706df7b286468c749d223f22acb0d96c27bdf33bbdbb9684ad46e5'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/dummy/config/routes.rb

@@ -0,0 +1,58 @@
+Dummy::Application.routes.draw do
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => "welcome#index"
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id(.:format)))'
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+    <p>We've been notified about this issue and we'll take a look at it shortly.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'