wadl 0.1.2 → 0.1.3.1

data/lib/wadl/resource_container.rb

@@ -0,0 +1,58 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of wadl, the super cheap Ruby WADL client.                      #
+#                                                                             #
+# Copyright (C) 2006-2008 Leonard Richardson                                  #
+# Copyright (C) 2010 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Leonard Richardson <leonardr@segfault.org> (Original author)            #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# wadl is free software; you can redistribute it and/or modify it under the   #
+# terms of the GNU General Public License as published by the Free Software   #
+# Foundation; either version 3 of the License, or (at your option) any later  #
+# version.                                                                    #
+#                                                                             #
+# wadl is distributed in the hope that it will be useful, but WITHOUT ANY     #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more       #
+# details.                                                                    #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with wadl. If not, see <http://www.gnu.org/licenses/>.                      #
+#                                                                             #
+###############################################################################
+#++
+
+require 'wadl'
+
+module WADL
+
+  # A mixin for objects that contain resources. If you include this, be
+  # sure to alias :find_resource to :find_resource_autogenerated
+  # beforehand.
+
+  module ResourceContainer
+
+    def resource(name_or_id)
+      name_or_id = name_or_id.to_s
+      find_resource { |r| r.id == name_or_id || r.path == name_or_id }
+    end
+
+    def find_resource_by_path(path, auto_dereference = nil)
+      path = path.to_s
+      find_resource(auto_dereference) { |r| r.path == path }
+    end
+
+    def finalize_creation
+      resources.each { |r|
+        define_singleton(r, :id,   :find_resource)
+        define_singleton(r, :path, :find_resource_by_path)
+      } if resources
+    end
+
+  end
+
+end

data/lib/wadl/resource_type.rb

@@ -0,0 +1,44 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of wadl, the super cheap Ruby WADL client.                      #
+#                                                                             #
+# Copyright (C) 2006-2008 Leonard Richardson                                  #
+# Copyright (C) 2010 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Leonard Richardson <leonardr@segfault.org> (Original author)            #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# wadl is free software; you can redistribute it and/or modify it under the   #
+# terms of the GNU General Public License as published by the Free Software   #
+# Foundation; either version 3 of the License, or (at your option) any later  #
+# version.                                                                    #
+#                                                                             #
+# wadl is distributed in the hope that it will be useful, but WITHOUT ANY     #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more       #
+# details.                                                                    #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with wadl. If not, see <http://www.gnu.org/licenses/>.                      #
+#                                                                             #
+###############################################################################
+#++
+
+require 'wadl'
+
+module WADL
+
+  # A type of resource. Basically a mixin of methods and params for actual
+  # resources.
+
+  class ResourceType < HasDocs
+
+    in_document 'resource_type'
+    has_attributes :id
+    has_many HTTPMethod, Param
+
+  end
+
+end

data/lib/wadl/resources.rb

@@ -0,0 +1,44 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of wadl, the super cheap Ruby WADL client.                      #
+#                                                                             #
+# Copyright (C) 2006-2008 Leonard Richardson                                  #
+# Copyright (C) 2010 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Leonard Richardson <leonardr@segfault.org> (Original author)            #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# wadl is free software; you can redistribute it and/or modify it under the   #
+# terms of the GNU General Public License as published by the Free Software   #
+# Foundation; either version 3 of the License, or (at your option) any later  #
+# version.                                                                    #
+#                                                                             #
+# wadl is distributed in the hope that it will be useful, but WITHOUT ANY     #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more       #
+# details.                                                                    #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with wadl. If not, see <http://www.gnu.org/licenses/>.                      #
+#                                                                             #
+###############################################################################
+#++
+
+require 'wadl'
+
+module WADL
+
+  class Resources < HasDocs
+
+    include ResourceContainer
+
+    in_document 'resources'
+    as_member 'resource_list'
+    has_attributes :base
+    has_many Resource
+
+  end
+
+end

data/lib/wadl/response.rb

@@ -0,0 +1,36 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of wadl, the super cheap Ruby WADL client.                      #
+#                                                                             #
+# Copyright (C) 2006-2008 Leonard Richardson                                  #
+# Copyright (C) 2010 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Leonard Richardson <leonardr@segfault.org> (Original author)            #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# wadl is free software; you can redistribute it and/or modify it under the   #
+# terms of the GNU General Public License as published by the Free Software   #
+# Foundation; either version 3 of the License, or (at your option) any later  #
+# version.                                                                    #
+#                                                                             #
+# wadl is distributed in the hope that it will be useful, but WITHOUT ANY     #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more       #
+# details.                                                                    #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with wadl. If not, see <http://www.gnu.org/licenses/>.                      #
+#                                                                             #
+###############################################################################
+#++
+
+require 'wadl'
+
+module WADL
+
+  class Response < Struct.new(:code, :headers, :representation, :format)
+  end
+
+end

data/lib/wadl/response_format.rb

@@ -0,0 +1,108 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of wadl, the super cheap Ruby WADL client.                      #
+#                                                                             #
+# Copyright (C) 2006-2008 Leonard Richardson                                  #
+# Copyright (C) 2010 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Leonard Richardson <leonardr@segfault.org> (Original author)            #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# wadl is free software; you can redistribute it and/or modify it under the   #
+# terms of the GNU General Public License as published by the Free Software   #
+# Foundation; either version 3 of the License, or (at your option) any later  #
+# version.                                                                    #
+#                                                                             #
+# wadl is distributed in the hope that it will be useful, but WITHOUT ANY     #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more       #
+# details.                                                                    #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with wadl. If not, see <http://www.gnu.org/licenses/>.                      #
+#                                                                             #
+###############################################################################
+#++
+
+begin
+  require 'mime/types'
+rescue LoadError
+end
+
+require 'wadl'
+
+module WADL
+
+  class ResponseFormat < HasDocs
+
+    include RepresentationContainer
+
+    in_document 'response'
+    has_many RepresentationFormat, FaultFormat
+
+    # Builds a service response object out of an HTTPResponse object.
+    def build(http_response)
+      # Figure out which fault or representation to use.
+
+      status = http_response.status[0]
+
+      unless response_format = faults.find { |f| f.dereference.status == status }
+        # Try to match the response to a response format using a media
+        # type.
+        response_media_type = http_response.content_type
+        response_format = representations.find { |f|
+          t = f.dereference.mediaType and response_media_type.index(t) == 0
+        }
+
+        # If an exact media type match fails, use the mime-types gem to
+        # match the response to a response format using the underlying
+        # subtype. This will match "application/xml" with "text/xml".
+        response_format ||= begin
+          mime_type = MIME::Types[response_media_type]
+          raw_sub_type = mime_type[0].raw_sub_type if mime_type && !mime_type.empty?
+
+          representations.find { |f|
+            if t = f.dereference.mediaType
+              response_mime_type = MIME::Types[t]
+              response_raw_sub_type = response_mime_type[0].raw_sub_type if response_mime_type && !response_mime_type.empty?
+              response_raw_sub_type == raw_sub_type
+            end
+          }
+        end if defined?(MIME::Types)
+
+        # If all else fails, try to find a response that specifies no
+        # media type. TODO: check if this would be valid WADL.
+        response_format ||= representations.find { |f| !f.dereference.mediaType }
+      end
+
+      body = http_response.read
+
+      if response_format && response_format.mediaType =~ /xml/
+        begin
+          body = REXML::Document.new(body)
+
+          # Find the appropriate element of the document
+          if response_format.element
+            # TODO: don't strip the damn namespace. I'm not very good at
+            # namespaces and I don't see how to deal with them here.
+            element = response_format.element.sub(/.*:/, '')
+            body = REXML::XPath.first(body, "//#{element}")
+          end
+        rescue REXML::ParseException
+        end
+
+        body.extend(XMLRepresentation)
+        body.representation_of(response_format)
+      end
+
+      klass = response_format.is_a?(FaultFormat) ? response_format.subclass : Response
+      obj = klass.new(http_response.status, http_response, body, response_format)
+
+      obj.is_a?(Exception) ? raise(obj) : obj
+    end
+
+  end
+
+end

data/lib/wadl/uri_parts.rb

@@ -0,0 +1,63 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of wadl, the super cheap Ruby WADL client.                      #
+#                                                                             #
+# Copyright (C) 2006-2008 Leonard Richardson                                  #
+# Copyright (C) 2010 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Leonard Richardson <leonardr@segfault.org> (Original author)            #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# wadl is free software; you can redistribute it and/or modify it under the   #
+# terms of the GNU General Public License as published by the Free Software   #
+# Foundation; either version 3 of the License, or (at your option) any later  #
+# version.                                                                    #
+#                                                                             #
+# wadl is distributed in the hope that it will be useful, but WITHOUT ANY     #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more       #
+# details.                                                                    #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with wadl. If not, see <http://www.gnu.org/licenses/>.                      #
+#                                                                             #
+###############################################################################
+#++
+
+require 'wadl'
+
+module WADL
+
+  # Classes to keep track of the logical structure of a URI.
+
+  class URIParts < Struct.new(:uri, :query, :headers)
+
+    def to_s
+      qs = "#{uri.include?('?') ? '&' : '?'}#{query_string}" unless query.empty?
+      "#{uri}#{qs}"
+    end
+
+    alias_method :to_str, :to_s
+
+    def inspect
+      hs = " Plus headers: #{headers.inspect}" if headers
+      "#{to_s}#{hs}"
+    end
+
+    def query_string
+      query.join('&')
+    end
+
+    def hash(x)
+      to_str.hash
+    end
+
+    def ==(x)
+      x.respond_to?(:to_str) ? to_str == x : super
+    end
+
+  end
+
+end

data/lib/wadl/version.rb

@@ -4,7 +4,7 @@ module WADL
 
     MAJOR = 0
     MINOR = 1
-    TINY  = 2
+    TINY  = 3
 
     class << self
 

data/lib/wadl/xml_representation.rb

@@ -0,0 +1,64 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of wadl, the super cheap Ruby WADL client.                      #
+#                                                                             #
+# Copyright (C) 2006-2008 Leonard Richardson                                  #
+# Copyright (C) 2010 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Leonard Richardson <leonardr@segfault.org> (Original author)            #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# wadl is free software; you can redistribute it and/or modify it under the   #
+# terms of the GNU General Public License as published by the Free Software   #
+# Foundation; either version 3 of the License, or (at your option) any later  #
+# version.                                                                    #
+#                                                                             #
+# wadl is distributed in the hope that it will be useful, but WITHOUT ANY     #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more       #
+# details.                                                                    #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with wadl. If not, see <http://www.gnu.org/licenses/>.                      #
+#                                                                             #
+###############################################################################
+#++
+
+require 'rexml/document'
+require 'wadl'
+
+module WADL
+
+  # A module mixed in to REXML documents to make them representations in the
+  # WADL sense.
+
+  module XMLRepresentation
+
+    def representation_of(format)
+      @params = format.params
+    end
+
+    def lookup_param(name)
+      param = @params.find { |p| p.name == name }
+
+      raise ArgumentError, "No such param #{name}" unless param
+      raise ArgumentError, "Param #{name} has no path!" unless param.path
+
+      param
+    end
+
+    # Yields up each XML element for the given Param object.
+    def each_by_param(param_name)
+      REXML::XPath.each(self, lookup_param(param_name).path) { |e| yield e }
+    end
+
+    # Returns an XML element for the given Param object.
+    def get_by_param(param_name)
+      REXML::XPath.first(self, lookup_param(param_name).path)
+    end
+
+  end
+
+end

data/test/test_wadl.rb

@@ -1,5 +1,12 @@
 # Unit tests for the Ruby WADL library.
 
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
 require 'test/unit'
 require 'wadl'