mikisvaz-simplews 1.3.2

data/History.txt

@@ -0,0 +1,57 @@
+== 1.3.2 2009-03-21
+
+== 1.3.1 2008-12-20
+
+* 1 minor enhancement:
+  * Use Marshal instead of YAML, it seems faster...
+
+* 1 mayor enhancement:
+  * Removed old versions of job based servers
+
+== 1.3.0 2008-12-20
+
+* 1 minor enhancement:
+  * New version for asynchronous job. In this case it uses fork to spawn new
+    processes.
+
+
+
+== 1.1.7 2008-11-27
+
+* 2 minor enhancement:
+  * Inline methods are prepended '_inline_' to avoid polluting namespace
+  * Asynchronous jobs have a hash where they can save information, it is
+    accessible through the 'info' WS method in YAML format
+
+== 1.1.6 2008-11-24
+
+* 1 minor enhancement:
+  * Added documentation
+
+
+== 1.1.5 2008-10-28
+
+* 1 major enhancement:
+  * Jobs save their states across reboots of the server
+
+== 1.1.4 2008-10-28
+
+* 1 major enhancement:
+  * Web Service with asynchronous jobs
+
+== 1.0.2 2008-10-28
+
+* 1 bug fix:
+  * In using the easy client driver creation
+
+== 1.0.1 2008-10-27
+
+* 1 major enhancement:
+  * Easy creation of client driver. Connects to a url and retrieves the WSDL
+    and uses it to generate driver
+
+
+== 1.0.0 2008-10-10
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/simplews.rb
+lib/simplews/jobs.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+simplews.gemspec
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/simplews/test_jobs.rb
+test/test_helper.rb
+test/test_simplews.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on simplews, see http://simplews.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,92 @@
+= simpleWS
+
+== DESCRIPTION:
+
+This defines a class that can simplifies creating Web Services. It inherits from soap2r's 
+SOAP::RPC::StandaloneServer and provides a few enhancements, the most important the fact that
+it is able to produce the WSDL automatically.
+
+== FEATURES/PROBLEMS:
+
+
+== SYNOPSIS:
+
+Each Web Service provided is described using the method 'serve', which takes
+as arguments the name of the service, the name of its arguments, the type of
+its arguments and an optional block of code. If a block of code is provided,
+it will be the one executed when the service is called, if not, a function
+with the same name will be used. The types for the arguments are listed here,
+along with the WSDL type that it is translated to:
+
+:string  => 'xsd:string',
+:integer => 'xsd:integer',
+:array   => 'tns:ArrayOfString',
+:hash    => 'tns:Map',
+:binary  => 'xsd:base64Binary',
+
+The type of the result value may also be specified using the name :return,
+this means no argument may be called :return. If it is not specified there
+will be no return value.
+
+Following is an example of use:
+
+class TestWS < SimpleWS
+    def hi(name)
+        "Hi #{name}, how are you?"
+    end
+
+    def initialize(*args)
+        super(*args)
+        serve :hi, %(name), :name => :string, :return => :string
+
+        serve :bye, %(name), :name => :string, :return => :string do |name
+            "Bye bye #{name}. See you soon."
+        end
+    end
+end
+
+The constructor accepts a number of parameters. The name of the server, a
+description, the host and the port, along with any other arguments one wishes
+to pass to the SOAP::RPC::StandaloneServer constructor
+
+This is an example of instantiating the above server:
+
+server = TestWS.new("TestWS", "Greeting Services", 'localhost', '1984')
+server.wsdl("TestWS.wsdl")
+
+The function 'wsdl' saves the WSDL describing the services and the location
+provided as an argument.
+
+
+== REQUIREMENTS:
+
+Requires soap4r gem to be installed.
+
+== INSTALL:
+
+sudo gem install simpleWS
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Miguel Vazquez (miguel.vazquez@fdi.ucm.es)
+
+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/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/simplews'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('simplews', SimpleWS::VERSION) do |p|
+  p.developer('Miguel Vazquez', 'mikisvaz@yahoo.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'simplews/version'
+
+AUTHOR = 'Miguel Vazquez'  # can also be an array of Authors
+EMAIL = "miguel.vazquez@fdi.ucm.es"
+DESCRIPTION = "Simplifies the development of Web Services, producing WSDL automatically for example. Wraps soap4r."
+GEM_NAME = 'simplews' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'simplews' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Simplews::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'simplews documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/simplews.rb

@@ -0,0 +1,258 @@
+require 'soap/rpc/standaloneServer'
+require 'builder'
+
+
+# SimpleWS is a class that wraps SOAP::RPC::StandaloneServer to ease the
+# implementation of Web Services, specifically the generation of the
+# +WSDL+ file. It provides a particular syntax that allows to specify
+# the methods that are going to be served along with the types of the
+# parameters and of the response so that the +WSDL+ can be generated
+# accordingly. Actual Servers can be instances of this class where
+# methods are assigned dynamically or of classes that extend SimpleWS.
+#   class TestWS < SimpleWS
+#    def hi(name)
+#      "Hi #{name}, how are you?"
+#    end
+#
+#    def initialize(*args)
+#      super(*args)
+#      serve :hi, %w(name), :name => :string, :return => :string
+#
+#      serve :bye, %w(name), :name => :string, :return => :string do |name|
+#          "Bye bye #{name}. See you soon."
+#      end
+#
+#    end
+#  end
+#
+#  # Creating a server and starting it
+#  
+#  server = TestWS.new("TestWS", "Greeting Services", 'localhost', '1984') 
+#  server.wsdl("TestWS.wsdl")
+#
+#  Thread.new do
+#     server.start
+#  end
+#
+#  # Client code. This could be run in another process.
+#
+#  driver = SimpleWS::get_driver('http://localhost:1984', "TestWS")
+#  puts driver.hi('Gladis')  #=> "Hi Gladis, how are you?"
+#  puts driver.bye('Gladis') #=> "Bye bye Gladis. See you soon."
+#
+
+
+
+class SimpleWS <  SOAP::RPC::StandaloneServer
+  VERSION = "1.3.2"
+
+
+  # This is a helper function for clients. Given the +url+ where the
+  # server is listening, as well as the name of the server, it can
+  # manually access the +wsdl+ function and retrieve the complete +WSDL+
+  # file. This works *only* in web servers of class SimpleWS, not on
+  # the general SOAP::RPC::StandaloneServer or any other type of web
+  # server.
+  def self.get_wsdl(url, name)
+     require 'soap/rpc/driver'
+     driver = SOAP::RPC::Driver.new(url, "urn:#{ name }")
+     driver.add_method('wsdl')
+     driver.wsdl
+  end
+
+  # Builds on the get_wsdl function to provide the client with a
+  # reference to the driver. Again, only works with SimpleWS servers.
+  def self.get_driver(url, name)
+    require 'soap/wsdlDriver'
+    require 'fileutils'
+
+    tmp = File.open("/tmp/simpleWS.wsdl",'w')
+    tmp.write SimpleWS::get_wsdl(url, name)
+    tmp.close
+    driver = SOAP::WSDLDriverFactory.new( "/tmp/simpleWS.wsdl"  ).create_rpc_driver
+    FileUtils.rm "/tmp/simpleWS.wsdl"
+
+    driver
+  end
+
+  # Creates an instance of a Server. The parameter +name+ specifies the
+  # +namespace+ used in the +WSDL+, +description+ is the description
+  # also included in the +WSDL+. The parameters +host+ and +port+,
+  # specify where the server will be listening, they are parameters of
+  # the +super+ class SOAP::RPC::StandaloneServer, they are made
+  # explicit here because they are included in the +WSDL+ as well.
+  def initialize(name="WS", description="", host="localhost", port="1984", *args)
+    super(description, "urn:#{ name }", host, port, *args)
+    @host        = host
+    @port        = port
+    @name        = name
+    @description = description
+    @messages    = []
+    @operations  = []
+    @bindings    = []
+
+    serve :wsdl, %w(),  :return => :string
+  end
+
+
+  # This method tells the server to provide a method named by the +name+
+  # parameter, with arguments listed in the +args+ parameter. The
+  # +types+ parameter specifies the types of the arguments as will be
+  # described in the +WSDL+ file (see the TYPES2WSDL constant). The
+  # actual method called will be the one with the same name. Optionally
+  # a block can be provided, this block will be used to define a
+  # function named as in name.
+  #
+  # If the method returns something, then the type of the return value
+  # must be specified in the +types+ parameter as :return. If not value
+  # for :return parameter is specified in the +types+ parameter the
+  # method is taken to return no value. Other than that, if a parameter
+  # type is omitted it is taken to be :string.
+  def serve(name, args=[], types={}, &block)
+    
+    if block
+      inline_name = "_inline_" + name.to_s
+      add_to_ruby(inline_name, &block)
+      add_method_as(self,inline_name, name.to_s,*args)
+    else
+      add_method(self,name.to_s,*args)
+    end
+
+    add_to_wsdl(name, args, types)
+
+    nil
+  end
+
+  # If +filename+ is specified it saves the +WSDL+ file in that file. If
+  # no +filename+ is specified it returns a string containing  the
+  # +WSDL+. The no parameter version is served by default, so that
+  # clients can use this method to access the complete +WSDL+ file, as
+  # used in get_wsdl and get_driver.
+  def wsdl(filename = nil)
+    wsdl = WSDL_STUB.dup
+    wsdl.gsub!(/\$\{MESSAGES\}/m,@messages.join("\n"))
+    wsdl.gsub!(/\$\{OPERATIONS\}/m,@operations.join("\n"))
+    wsdl.gsub!(/\$\{BINDINGS\}/m,@bindings.join("\n"))
+    wsdl.gsub!(/\$\{NAME\}/,@name)
+    wsdl.gsub!(/\$\{DESCRIPTION\}/,@description)
+    wsdl.gsub!(/\$\{LOCATION\}/,"http://#{ @host }:#{ @port }")
+    if filename
+      fwsdl = File.open(filename,'w')
+      fwsdl.write(wsdl)
+      fwsdl.close
+      nil
+    else
+      wsdl
+    end
+  end
+
+  private
+
+  def add_to_ruby(name, &block)
+    self.class.send(:define_method, name, block)
+  end
+
+  def add_to_wsdl(name, args, types)
+    message =  Builder::XmlMarkup.new(:indent => 2).message :name => "#{ name }Request" do |xml|
+      args.each{|param|
+        type = types[param.to_s] || types[param.to_sym] || :string
+        type = type.to_sym
+        xml.part :name => param, :type => TYPES2WSDL[type]
+      }
+    end
+    @messages << message
+    message =  Builder::XmlMarkup.new(:indent => 2).message :name => "#{ name }Response" do |xml|
+      type = types[:return] || types["return"]
+      if type
+        type = type.to_sym
+        xml.part :name => 'return', :type => TYPES2WSDL[type]
+      end
+    end
+    @messages << message
+
+    operation = Builder::XmlMarkup.new(:indent => 2).operation :name => "#{ name }" do |xml|
+      xml.input :message => "tns:#{ name }Request"
+      xml.output :message => "tns:#{ name }Response"
+    end
+
+    @operations << operation
+
+    binding = Builder::XmlMarkup.new(:indent => 2).operation :name => "#{ name }" do |xml|
+      xml.tag! 'soap:operation'.to_sym, :soapAction => "urn:${NAME}##{name}", :style => 'rpc'
+      xml.input do |xml|
+        xml.tag! 'soap:body'.to_sym, :namespace => "urn:${NAME}", :encodingStyle => "http://schemas.xmlsoap.org/soap/encoding/", :use => "encoded"
+      end                                                                                                                                         
+      xml.output do |xml|                                                                                                                         
+        xml.tag! 'soap:body'.to_sym, :namespace => "urn:${NAME}", :encodingStyle => "http://schemas.xmlsoap.org/soap/encoding/", :use => "encoded"
+      end
+    end
+
+    @bindings << binding
+
+  end
+  
+
+  WSDL_STUB =<<EOT
+<?xml version="1.0"?>
+<definitions xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
+xmlns:tns="${NAME}-NS"
+xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" 
+xmlns:si="http://soapinterop.org/xsd" 
+xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" 
+xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" 
+xmlns="http://schemas.xmlsoap.org/wsdl/" 
+targetNamespace="${NAME}-NS">
+
+
+   <types>
+      <schema xmlns="http://www.w3.org/2001/XMLSchema"
+         targetNamespace="${NAME}-NS"
+         xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+         xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+         <complexType name="ArrayOfString">
+            <complexContent>
+               <restriction base="soapenc:Array">
+                  <attribute ref="soapenc:arrayType" 
+                  wsdl:arrayType="string[]"/>
+               </restriction>
+            </complexContent>
+         </complexType>
+     </schema>
+   </types>
+
+${MESSAGES}
+<portType name="${NAME}">
+${OPERATIONS}
+</portType>
+
+<binding name="${NAME}Binding" type="tns:${NAME}">
+   <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
+${BINDINGS}
+</binding>
+<service name="${NAME}">
+    <documentation>${DESCRIPTION}</documentation>
+ 
+    <port name="${NAME}" binding="tns:${NAME}Binding">
+       <soap:address location="${LOCATION}"/>
+    </port>
+</service>
+
+</definitions>
+EOT
+
+  TYPES2WSDL = {
+    :boolean => 'xsd:boolean',
+    :string => 'xsd:string',
+    :integer => 'xsd:integer',
+    :float => 'xsd:float',
+    :array  => 'tns:ArrayOfString',
+    :hash  => 'tns:Map',
+    :binary => 'xsd:base64Binary',
+  }
+
+
+end
+
+