wadl 0.2.8 → 0.3.0

data/lib/wadl/request_format.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -26,8 +26,6 @@
 ###############################################################################
 #++
 
-require 'wadl'
-
 module WADL
 
   class RequestFormat < HasDocs

data/lib/wadl/resource.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -27,7 +27,6 @@
 #++
 
 require 'set'
-require 'wadl'
 
 module WADL
 
@@ -72,8 +71,7 @@ module WADL
     #  :access_token
     #  :token_secret
     def with_oauth(*args)
-      resource_and_address.auth(HTTPMethod::OAUTH_HEADER,
-        "#{HTTPMethod::OAUTH_PREFIX}#{args.to_yaml}")
+      resource_and_address.auth(*HTTPRequest.oauth_header(args))
     end
 
     def uri(args = {}, working_address = nil)

data/lib/wadl/resource_and_address.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -27,7 +27,6 @@
 #++
 
 require 'delegate'
-require 'wadl'
 
 module WADL
 

data/lib/wadl/resource_container.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -26,8 +26,6 @@
 ###############################################################################
 #++
 
-require 'wadl'
-
 module WADL
 
   # A mixin for objects that contain resources. If you include this, be

data/lib/wadl/resource_type.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -26,8 +26,6 @@
 ###############################################################################
 #++
 
-require 'wadl'
-
 module WADL
 
   # A type of resource. Basically a mixin of methods and params for actual

data/lib/wadl/resources.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -26,8 +26,6 @@
 ###############################################################################
 #++
 
-require 'wadl'
-
 module WADL
 
   class Resources < HasDocs

data/lib/wadl/response.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -26,8 +26,6 @@
 ###############################################################################
 #++
 
-require 'wadl'
-
 module WADL
 
   class Response < Struct.new(:code, :headers, :representation, :format)

data/lib/wadl/response_format.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -26,12 +26,7 @@
 ###############################################################################
 #++
 
-begin
-  require 'mime/types'
-rescue LoadError
-end
-
-require 'wadl'
+require 'mime/types'
 
 module WADL
 
@@ -70,7 +65,7 @@ module WADL
               response_raw_sub_type == raw_sub_type
             end
           }
-        end if defined?(MIME::Types)
+        end
 
         # If all else fails, try to find a response that specifies no
         # media type. TODO: check if this would be valid WADL.
@@ -98,7 +93,7 @@ module WADL
       end
 
       klass = response_format.is_a?(FaultFormat) ? response_format.subclass : Response
-      obj = klass.new(http_response.status, http_response, body, response_format)
+      obj = klass.new(http_response.status, http_response.headers, body, response_format)
 
       obj.is_a?(Exception) ? raise(obj) : obj
     end

data/lib/wadl/uri_parts.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -26,8 +26,6 @@
 ###############################################################################
 #++
 
-require 'wadl'
-
 module WADL
 
   # Classes to keep track of the logical structure of a URI.

data/lib/wadl/version.rb

@@ -3,8 +3,8 @@ module WADL
   module Version
 
     MAJOR = 0
-    MINOR = 2
-    TINY  = 8
+    MINOR = 3
+    TINY  = 0
 
     class << self
 

data/lib/wadl/xml_representation.rb

@@ -4,7 +4,7 @@
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
 # Copyright (C) 2006-2008 Leonard Richardson                                  #
-# Copyright (C) 2010-2013 Jens Wille                                          #
+# Copyright (C) 2010-2014 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -27,7 +27,6 @@
 #++
 
 require 'rexml/document'
-require 'wadl'
 
 module WADL
 

data/test/wadl_test.rb

@@ -1,10 +1,5 @@
 # Unit tests for the Ruby WADL library.
 
-begin
-  require 'rubygems'
-rescue LoadError
-end
-
 $LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
 
 require 'test/unit'
@@ -24,10 +19,6 @@ class WADLTest < Test::Unit::TestCase
     EOT
   end
 
-  # Null test to shut the compiler up. (Ruby < 1.9)
-  def test_null
-  end
-
 end
 
 class FindingWhatYouNeed < WADLTest
@@ -129,15 +120,15 @@ class PathParameters < WADLTest
     insult_resource = @wadl.find_resource_by_path('the/{person}/is/{a}')
 
     # Test simple substitution.
-    assert_equal(insult_resource.uri(:path => { 'person' => 'king', 'a' => 'fink' }),
+    assert_equal(insult_resource.uri(path: { 'person' => 'king', 'a' => 'fink' }),
                  'http://www.example.com/the/king/is/;a=fink')
     # Test default values.
-    assert_equal(insult_resource.uri(:path => { 'person' => 'king' }),
+    assert_equal(insult_resource.uri(path: { 'person' => 'king' }),
                  'http://www.example.com/the/king/is/;a=dork')
 
     # Test use of optional paramaters.
-    assert_equal(insult_resource.uri(:path => { 'person' => 'king', 'a' => 'fink',
-                                                'and' => 'he can bite me' }),
+    assert_equal(insult_resource.uri(path: { 'person' => 'king', 'a' => 'fink',
+                                             'and' => 'he can bite me' }),
                  'http://www.example.com/the/king/is/;a=fink/;and=he%20can%20bite%20me')
 
     # Don't provide required argument.
@@ -145,7 +136,7 @@ class PathParameters < WADLTest
 
     # Provide multiple values for single-valued argument.
     assert_raises(ArgumentError) {
-      insult_resource.uri(:path => { :person => 'king', :a => ['fink', 'dolt'] })
+      insult_resource.uri(path: { person: 'king', a: %w[fink dolt] })
     }
   end
 
@@ -163,10 +154,10 @@ class PathParameters < WADLTest
 </resources>
     EOT
 
-    assert_equal(resource.uri(:path => { :fate => 'Clotho' }),
+    assert_equal(resource.uri(path: { fate: 'Clotho' }),
                  'http://www.example.com/fates/Clotho')
 
-    assert_raises(ArgumentError) { resource.uri(:path => { :fate => 'Groucho' }) }
+    assert_raises(ArgumentError) { resource.uri(path: { fate: 'Groucho' }) }
   end
 
   # This one's complicated. We bind a resource's path parameters to
@@ -178,19 +169,19 @@ class PathParameters < WADLTest
     assert_equal(im_mad_because.uri, 'http://www.example.com/im/mad/because')
 
     insult = im_mad_because.find_resource('insult')
-    assert_equal(insult.uri(:path => { 'person' => 'king', 'a' => 'fink' }),
+    assert_equal(insult.uri(path: { 'person' => 'king', 'a' => 'fink' }),
                   'http://www.example.com/im/mad/because/the/king/is/;a=fink')
 
-    im_mad_because_hes_a_fink = insult.bind!(:path => { 'person' => 'king', 'a' => 'fink' })
+    im_mad_because_hes_a_fink = insult.bind!(path: { 'person' => 'king', 'a' => 'fink' })
     assert_equal(im_mad_because_hes_a_fink.uri,
                  'http://www.example.com/im/mad/because/the/king/is/;a=fink')
 
     im_mad_because_hes_a_fink_lets = im_mad_because_hes_a_fink.find_resource("so-let's")
-    assert_equal(im_mad_because_hes_a_fink_lets.uri(:path => { 'do something' => 'revolt' }),
+    assert_equal(im_mad_because_hes_a_fink_lets.uri(path: { 'do something' => 'revolt' }),
                  "http://www.example.com/im/mad/because/the/king/is/;a=fink/so-let's/revolt")
 
     im_mad_because_hes_a_fink_lets_revolt = im_mad_because_hes_a_fink_lets.
-      bind(:path => { 'person' => 'fink', 'do something' => 'revolt' })
+      bind(path: { 'person' => 'fink', 'do something' => 'revolt' })
 
     assert_equal(im_mad_because_hes_a_fink_lets_revolt.uri,
                  "http://www.example.com/im/mad/because/the/king/is/;a=fink/so-let's/revolt")
@@ -210,7 +201,7 @@ class PathParameters < WADLTest
     { 'plain'  => 'http://www.example.com/i/want/pony,water%20slide,BB%20gun',
       'matrix' => 'http://www.example.com/i/want/;a=pony;a=water%20slide;a=BB%20gun' }.each { |style, uri|
       list = wadl(text % style).find_resource('list')
-      assert_equal(list.uri(:path => { :a => ['pony', 'water slide', 'BB gun'] }), uri)
+      assert_equal(list.uri(path: { a: ['pony', 'water slide', 'BB gun'] }), uri)
     }
   end
 
@@ -223,7 +214,7 @@ class PathParameters < WADLTest
 </resources>
     EOT
 
-    assert_equal(poll.uri(:opinion => 'ungood'),
+    assert_equal(poll.uri(opinion: 'ungood'),
                  'http://www.example.com/big-brother-is/doubleplusgood')
   end
 
@@ -241,19 +232,19 @@ class PathParameters < WADLTest
     on_uri  = 'http://www.example.com/light-panel/;light1;light3'
     off_uri = 'http://www.example.com/light-panel/;light1'
 
-    assert_equal(lights.uri(:path => { :light3 => 'true' }), on_uri)
-    assert_equal(lights.uri(:path => { :light3 => '1'    }), on_uri)
+    assert_equal(lights.uri(path: { light3: 'true' }), on_uri)
+    assert_equal(lights.uri(path: { light3: '1'    }), on_uri)
 
     assert_equal(lights.uri, off_uri)
-    assert_equal(lights.uri(:path => { :light3 => 'false' }), off_uri)
-    assert_equal(lights.uri(:path => { :light3 => false   }), off_uri)
-    assert_equal(lights.uri(:path => { :light3 => 'True'  }), off_uri)
-    assert_equal(lights.uri(:path => { :light3 => true    }), off_uri)
+    assert_equal(lights.uri(path: { light3: 'false' }), off_uri)
+    assert_equal(lights.uri(path: { light3: false   }), off_uri)
+    assert_equal(lights.uri(path: { light3: 'True'  }), off_uri)
+    assert_equal(lights.uri(path: { light3: true    }), off_uri)
   end
 
 end
 
-class RequestFormatTests < WADLTest
+class RequestFormatTest < WADLTest
 
   def setup
     @wadl = wadl(<<-EOT)
@@ -283,15 +274,15 @@ class RequestFormatTests < WADLTest
 </method>
     EOT
 
-    @color = @wadl.find_resource('top').bind(:query => { :api_key => 'foobar' }).find_resource('color')
+    @color = @wadl.find_resource('top').bind(query: { api_key: 'foobar' }).find_resource('color')
   end
 
   def test_query_vars
     graphic = @color.find_method('get_graphic')
-    path    = { :color => 'blue' }
-    query   = { :shade => 'light' }
+    path    = { color: 'blue' }
+    query   = { shade: 'light' }
 
-    assert_equal(graphic.request.uri(@color, :path => path, :query => query),
+    assert_equal(graphic.request.uri(@color, path: path, query: query),
                  'http://www.example.com/palette/colors/blue?shade=light')
 
     assert_raises(ArgumentError) { graphic.request.uri(@color, path) }
@@ -301,15 +292,63 @@ class RequestFormatTests < WADLTest
     graphic = @color.find_method('set_graphic')
     representation = graphic.request.find_form
 
-    assert_equal(representation % { :new_graphic => 'foobar', 'filename' => 'blue.jpg' },
+    assert_equal(representation % { new_graphic: 'foobar', 'filename' => 'blue.jpg' },
                  'new_graphic=foobar&filename=blue.jpg')
 
-    assert_raises(ArgumentError) { representation % { :new_graphic => 'foobar' } }
+    assert_raises(ArgumentError) { representation % { new_graphic: 'foobar' } }
+  end
+
+end
+
+class ResponseFormatTest < WADLTest
+
+  def setup
+    @wadl = wadl(<<-EOT)
+<resources base="http://www.example.com/">
+  <resource id="top" path="palette">
+    <method name="GET" id="get_graphic">
+      <request></request>
+      <response>
+        <representation mediaType="application/json"/>
+      </response>
+    </method>
+  </resource>
+  <resource id="bottom" path="palette">
+    <method name="GET" id="set_graphic">
+      <request></request>
+      <response>
+        <representation mediaType="application/json"/>
+      </response>
+      <response>
+        <representation mediaType="text/xml"/>
+      </response>
+    </method>
+  </resource>
+</resources>
+    EOT
+  end
+
+  def test_representation
+    graphic = @wadl.find_resource('top').find_method('get_graphic')
+    representations = graphic.response.representations
+
+    assert_equal(1, representations.size)
+    assert_equal('application/json', representations.first.mediaType)
+  end
+
+  def test_multiple_response_formats
+    graphic = @wadl.find_resource('bottom').find_method('set_graphic')
+    responses = graphic.responses
+
+    assert_equal(2, responses.size)
+    assert_equal(%w[application/json text/xml], responses.map { |response|
+      response.representations.first.mediaType
+    })
   end
 
 end
 
-class AuthTests < WADLTest
+class AuthTest < WADLTest
 
   def setup
     @wadl = wadl(<<-EOT)
@@ -346,7 +385,7 @@ class AuthTests < WADLTest
   end
 
   def test_template_params_with_basic_auth
-    arg = { :path => { :id => 42 } }
+    arg = { path: { id: 42 } }
     uri = 'http://www.example.com/service/42.json'
 
     assert_equal(uri, u1 = @service.bind(arg).uri)