simplews 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-10-10
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,24 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/simplews.rb
+lib/simplews/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+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,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

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

@@ -0,0 +1,10 @@
+module Simplews
+  module VERSION #:nodoc:
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+    self
+  end
+end

data/lib/simplews.rb

@@ -0,0 +1,155 @@
+require 'soap/rpc/standaloneServer'
+require 'builder'
+
+
+class SimpleWS <  SOAP::RPC::StandaloneServer
+
+
+  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    = []
+  end
+
+  def serve(name, args=[], types={}, &block)
+    
+    if block
+      add_to_ruby(name, &block)
+    end
+
+    add_to_wsdl(name, args, types)
+    add_method(self,name.to_s,*args)
+
+    nil
+  end
+
+  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 => @@type2wsdl[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 => @@type2wsdl[type]
+      end
+    end
+    @messages << message
+
+    operation = Builder::XmlMarkup.new(:indent => 2).operation :name => "#{ name }" do |xml|
+      xml.input :message => "#{ name }Request"
+      xml.output :message => "#{ 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
+
+  @@type2wsdl = {
+    :string => 'xsd:string',
+    :integer => 'xsd:integer',
+    :array  => 'tns:ArrayOfString',
+    :hash  => 'tns:Map',
+    :binary => 'xsd:base64Binary',
+  }
+
+
+end
+
+

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/simplews.rb'}"
+puts "Loading simplews gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'simplews' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'simplews'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
+
+version  = Simplews::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.configure.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)