shapewear 0.0.1 → 0.0.2

data/README.md

@@ -3,6 +3,11 @@ shapewear [![Build Status](https://secure.travis-ci.org/elementar/shapewear.png)
 
 Make your fat service look skinny.
 
+Work in Progress
+----------------
+
+This gem is still in early development, and it's not yet yet ready for use. Any contribution and feedback is welcome.
+
 Installation
 ------------
 
@@ -21,15 +26,25 @@ First, describe your SOAP service:
 require "shapewear"
 
 class MyFirstService
-  include Shapewear::DSL
+  include Shapewear
+
+  wsdl_namespace 'http://services.example.com/v1'
+  schema_namespace 'http://schemas.example.com/v1'
 
+  operation :hello, :parameters => [[:name, String]], :returns => String
   def hello(name)
     "hello, #{name}"
   end
 
+  operation :sum, :parameters => [[:x, Fixnum], [:y, Fixnum]], :returns => Fixnum
   def sum(x, y)
     x + y
   end
+
+  operation :get_user_info, :parameters => [[:email, String]], :returns => { :name => String, :birthday => DateTime }
+  def get_user_info(email)
+    User.find_by_email(email)
+  end
 end
 ```
 

data/lib/shapewear.rb

@@ -2,9 +2,17 @@ require 'nokogiri'
 
 require 'shapewear/version'
 require 'shapewear/dsl'
+require 'shapewear/wsdl'
+
+module Shapewear
+  def self.included(receiver)
+    receiver.extend(Shapewear::DSL)
+    receiver.extend(Shapewear::WSDL)
+  end
+end
 
 # defines String.camelize if it is not defined by, e.g. Rails
-unless String.respond_to? :camelize
+unless ''.respond_to? :camelize
   class String
     def camelize
       self.split('_').map(&:capitalize).join

data/lib/shapewear/dsl.rb

@@ -2,106 +2,28 @@ require 'builder'
 
 module Shapewear
   module DSL
-    def self.included(receiver)
-      receiver.extend(ClassMethods)
-    end
-
-    #noinspection RubyArgCount,RubyResolve
-    module ClassMethods
-
-      # reference: http://www.w3.org/TR/wsdl
-      def to_wsdl
-        tns = "http://shapewear.elementarsistemas.com.br/auto/#{self.name}.wsdl"
-        xsd = "http://shapewear.elementarsistemas.com.br/auto/#{self.name}.xsd"
-
-        xm = Builder::XmlMarkup.new
-
-        xm.instruct!
-        xm.definitions :name => self.name, 'targetNamespace' => tns,
-                       'xmlns' => 'http://schemas.xmlsoap.org/wsdl/',
-                       'xmlns:soap' => 'http://schemas.xmlsoap.org/wsdl/soap/',
-                       'xmlns:xsd1' => xsd, 'tns' => tns do |xdef|
-
-          xdef.types do |xtypes|
-            xtypes.schema 'xmlns' => 'http://www.w3.org/2000/10/XMLSchema', 'targetNamespace' => xsd do |xschema|
-
-              # define elements for each defined method
-              instance_methods(false).each do |m|
-                build_type_elements_for_method(m, xschema)
-              end
-            end
-          end
+    private
 
-          instance_methods(false).each do |m|
-            xdef.message :name => "#{m.camelize}Input" do |xmsg|
-              xmsg.part :name => :body, :element => "xsd1:#{m.camelize}Request"
-            end unless instance_method(m).arity == 0
-            xdef.message :name => "#{m.camelize}Output" do |xmsg|
-              xmsg.part :name => :body, :element => "xsd1:#{m.camelize}"
-            end
-          end
-
-          xdef.portType :name => "#{self.name}PortType" do |xpt|
-            instance_methods(false).each do |m|
-              xpt.operation :name => m.camelize do |xop|
-                xop.input :message => "tns:#{m.camelize}Input" unless instance_method(m).arity == 0
-                xop.output :message => "tns:#{m.camelize}Output"
-              end
-            end
-          end
-
-          xdef.binding :name => "#{self.name}Binding", :type => "tns:#{self.name}PortType" do |xbind|
-            xbind.tag! 'soap:binding', :style => 'document', :transport => 'http://schemas.xmlsoap.org/soap/http'
-            instance_methods(false).each do |m|
-              xbind.operation :name => m.camelize do |xop|
-                xbind.tag! 'soap:operation', :soapAction => "http://shapewear.elementarsistemas.com.br/auto/op/#{m.camelize}"
-                xbind.input { |xin| xin.tag! 'soap:body', :use => 'literal' } unless instance_method(m).arity == 0
-                xbind.output { |xin| xin.tag! 'soap:body', :use => 'literal' }
-              end
-            end
-          end
+    def options
+      @options ||= {}
+    end
 
-          xdef.service :name => self.name do |xsrv|
-            xsrv.documentation "WSDL auto-generated by shapewear."
-            xsrv.port :name => "#{self.name}Port", :binding => "#{self.name}Binding" do |xport|
-              xport.tag! 'soap:address', :location => "..." # TODO: let the developer configure
-            end
-          end
-        end
-      end
+    protected
 
-      def build_type_elements_for_method(m, xschema)
-        # element for method arguments
-        um = instance_method(m)
+    def wsdl_namespace(ns)
+      options[:wsdl_namespace] = ns
+    end
 
-        if um.arity > 0
-          xschema.element :name => "#{m.camelize}Request" do |xreq|
-            xreq.complexType do |xct|
-              xct.all do |xall|
-                if um.respond_to?(:parameters)
-                  # with Ruby 1.9, we can create the parameters with the correct names
-                  params = um.parameters.select { |p| p.first == :in }.map &:first
-                else
-                  params = (0..um.arity).map { |i| "arg#{i}" }
-                end
+    def schema_namespace(ns)
+      options[:schema_namespace] = ns
+    end
 
-                params.each do |p|
-                  xall.element :name => p, :type => 'xsd:string' # TODO: there must be a better way
-                end
-              end
-            end
-          end
-        end
+    def endpoint_url(url)
+      options[:endpoint_url] = url
+    end
 
-        # element for method result
-        xschema.element :name => "#{m.camelize}" do |xreq|
-          xreq.complexType do |xct|
-            xct.all do |xall|
-              xall.element :name => 'result', :type => 'xsd:string'
-            end
-          end
-        end
-      end
+    def operation(name, ops = {})
+      (options[:operations] ||= {})[name] = ops
     end
   end
 end

data/lib/shapewear/version.rb

@@ -1,5 +1,5 @@
 module Shapewear
 
-  Version = "0.0.1"
+  Version = "0.0.2"
 
 end

data/lib/shapewear/wsdl.rb

@@ -0,0 +1,127 @@
+require 'builder'
+
+module Shapewear
+  #noinspection RubyArgCount,RubyResolve
+  module WSDL
+    # reference: http://www.w3.org/TR/wsdl
+    def to_wsdl
+      tns = options[:wsdl_namespace] || "http://shapewear.elementarsistemas.com.br/auto/#{self.name}.wsdl"
+      xsd = options[:schema_namespace] || "http://shapewear.elementarsistemas.com.br/auto/#{self.name}.xsd"
+
+      xm = Builder::XmlMarkup.new
+
+      xm.instruct!
+      xm.definitions :name => self.name, 'targetNamespace' => tns,
+                     'xmlns' => 'http://schemas.xmlsoap.org/wsdl/',
+                     'xmlns:soap' => 'http://schemas.xmlsoap.org/wsdl/soap/',
+                     'xmlns:xsd1' => xsd, 'xmlns:tns' => tns do |xdef|
+
+        xdef.types do |xtypes|
+          xtypes.schema 'xmlns' => 'http://www.w3.org/2000/10/XMLSchema', 'targetNamespace' => xsd do |xschema|
+
+            # define elements for each defined method
+            instance_methods(false).each do |m|
+              build_type_elements_for_method(m, xschema)
+            end
+          end
+        end
+
+        instance_methods(false).each do |m|
+          xdef.message :name => "#{m.camelize}Input" do |xmsg|
+            xmsg.part :name => :body, :element => "xsd1:#{m.camelize}Request"
+          end unless instance_method(m).arity == 0
+          xdef.message :name => "#{m.camelize}Output" do |xmsg|
+            xmsg.part :name => :body, :element => "xsd1:#{m.camelize}"
+          end
+        end
+
+        xdef.portType :name => "#{self.name}PortType" do |xpt|
+          instance_methods(false).each do |m|
+            xpt.operation :name => m.camelize do |xop|
+              xop.input :message => "tns:#{m.camelize}Input" unless instance_method(m).arity == 0
+              xop.output :message => "tns:#{m.camelize}Output"
+            end
+          end
+        end
+
+        xdef.binding :name => "#{self.name}Binding", :type => "tns:#{self.name}PortType" do |xbind|
+          xbind.tag! 'soap:binding', :style => 'document', :transport => 'http://schemas.xmlsoap.org/soap/http'
+          instance_methods(false).each do |m|
+            xbind.operation :name => m.camelize do |xop|
+              xop.tag! 'soap:operation', :soapAction => "#{tns}/#{m.camelize}"
+              xop.input { |xin| xin.tag! 'soap:body', :use => 'literal' } unless instance_method(m).arity == 0
+              xop.output { |xin| xin.tag! 'soap:body', :use => 'literal' }
+            end
+          end
+        end
+
+        xdef.service :name => self.name do |xsrv|
+          xsrv.documentation "WSDL auto-generated by shapewear."
+          xsrv.port :name => "#{self.name}Port", :binding => "#{self.name}Binding" do |xport|
+            xport.tag! 'soap:address', :location => options[:endpoint_url]
+          end
+        end
+      end
+    end
+
+    def build_type_elements_for_method(m, xschema)
+      # element for method arguments
+      um = instance_method(m)
+      op_options = options[:operations][m.to_sym] rescue nil
+
+      if um.arity > 0
+        xschema.element :name => "#{m.camelize}Request" do |xreq|
+          xreq.complexType do |xct|
+            xct.all do |xall|
+              params = op_options[:parameters] rescue nil
+              if params.nil?
+                if um.respond_to?(:parameters)
+                  # with Ruby 1.9, we can create the parameters with the correct names
+                  params = um.parameters.select { |p| p.first == :in }.map { |p| [p.first, Object] }
+                else
+                  params = (0..um.arity).map { |i| ["arg#{i}", Object] }
+                end
+              end
+
+              params.each do |p|
+                xall.element :name => p.first, :type => to_xsd_type(p.last)
+              end
+            end
+          end
+        end
+      end
+
+      # element for method result
+      xschema.element :name => "#{m.camelize}" do |xreq|
+        xreq.complexType do |xct|
+          xct.all do |xall|
+            ret = op_options[:returns] rescue nil
+            if ret.nil?
+              xall.element :name => 'result', :type => 'xsd:any'
+            elsif ret.is_a?(Class)
+              xall.element :name => 'result', :type => to_xsd_type(ret)
+            elsif ret.is_a?(Hash)
+              ret.each do |name, type|
+                xall.element :name => name, :type => to_xsd_type(type)
+              end
+            else
+              raise "Could not interpret #{ret.inspect} as a return type definition"
+            end
+          end
+        end
+      end
+    end
+
+    def to_xsd_type(t)
+      if t.is_a?(Class)
+        return 'xsd:string' if t == String
+        return 'xsd:integer' if t == Fixnum
+        return 'xsd:dateTime' if t == DateTime
+        return 'xsd:any' if t == Object
+        raise "Could not convert type #{t} to a valid XSD type"
+      elsif t.is_a?(Hash)
+        '??'
+      end
+    end
+  end
+end

data/spec/shapewear/dsl_spec.rb

@@ -7,7 +7,7 @@ describe Shapewear::DSL do
   describe "basic DSL" do
     it "should describe parameterless, 'hello world' services" do
       class ParameterlessHelloWorldService
-        include Shapewear::DSL
+        include Shapewear
 
         def hello_world
           "hello"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shapewear
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "F\xC3\xA1bio Batista"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-02 00:00:00 Z
+date: 2012-01-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder
@@ -102,6 +102,7 @@ files:
 - lib/shapewear.rb
 - lib/shapewear/dsl.rb
 - lib/shapewear/version.rb
+- lib/shapewear/wsdl.rb
 - shapewear.gemspec
 - spec/shapewear/dsl_spec.rb
 - spec/spec_helper.rb