wadl 0.2.6 → 0.2.7

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to wadl version 0.2.6
+This documentation refers to wadl version 0.2.7
 
 
 == DESCRIPTION
@@ -45,8 +45,8 @@ The 20060802 WADL standard is almost entirely supported. However,
 == LINKS
 
 <b></b>
-Homepage::      http://www.crummy.com/software/wadl.rb/
-WADL::          http://wadl.dev.java.net/
+Homepage::      http://www.crummy.com/software/wadl.rb
+WADL::          http://wadl.java.net
 Documentation:: http://rdoc.info/projects/blackwinter/wadl
 Source code::   http://github.com/blackwinter/wadl
 
@@ -60,7 +60,7 @@ Source code::   http://github.com/blackwinter/wadl
 == LICENSE AND COPYRIGHT
 
 Copyright (C) 2006-2008 Leonard Richardson
-Copyright (C) 2010-2011 Jens Wille
+Copyright (C) 2010-2012 Jens Wille
 
 wadl is free software: you can redistribute it and/or modify it under
 the terms of the GNU Affero General Public License as published by the

data/lib/wadl/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-2011 Jens Wille                                          #
+# Copyright (C) 2010-2012 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -50,11 +50,13 @@ module WADL
                    path_params = {}, query_params = {}, header_params = {})
       @path_fragments, @query_vars, @headers = path_fragments, query_vars, headers
       @path_params, @query_params, @header_params = path_params, query_params, header_params
+
+      @auth = {}
     end
 
     # Perform a deep copy.
     def deep_copy
-      Address.new(
+      address = Address.new(
         _deep_copy_array(@path_fragments),
         _deep_copy_array(@query_vars),
         _deep_copy_hash(@headers),
@@ -62,6 +64,10 @@ module WADL
         @query_params.dup,
         @header_params.dup
       )
+
+      @auth.each { |header, value| address.auth(header, value) }
+
+      address
     end
 
     def to_s
@@ -69,6 +75,7 @@ module WADL
       " Path fragments: #{@path_fragments.inspect}\n"         <<
       " Query variables: #{@query_vars.inspect}\n"            <<
       " Header variables: #{@headers.inspect}\n"              <<
+      " Authorization parameters: #{@auth.inspect}\n"         <<
       " Unbound path parameters: #{@path_params.inspect}\n"   <<
       " Unbound query parameters: #{@query_params.inspect}\n" <<
       " Unbound header parameters: #{@header_params.inspect}\n"
@@ -82,6 +89,8 @@ module WADL
       query_var_values  = args[:query]   || {}
       header_var_values = args[:headers] || {}
 
+      @auth.each { |header, value| header_var_values[header] = value }.clear
+
       # Bind variables found in the path fragments.
       path_params_to_delete = []
 
@@ -89,17 +98,17 @@ module WADL
         if fragment.respond_to?(:to_str)
           # This fragment is a string which might contain {} substitutions.
           # Make any substitutions available to the provided path variables.
-          self.class.embedded_param_names(fragment).each { |param_name|
-            value = path_var_values[param_name] || path_var_values[param_name.to_sym]
+          self.class.embedded_param_names(fragment).each { |name|
+            value = path_var_values[name] || path_var_values[name.to_sym]
 
-            value = if param = path_params[param_name]
+            value = if param = path_params[name]
               path_params_to_delete << param
               param % value
             else
-              Param.default.format(value, param_name)
+              Param.default.format(value, name)
             end
 
-            fragment.gsub!("{#{param_name}}", value)
+            fragment.gsub!("{#{name}}", value)
           }
         else
           # This fragment is an array of Param objects (style 'matrix'
@@ -107,15 +116,15 @@ module WADL
           # happen, the array will become a mixed array of Param objects
           # and strings.
           fragment.each_with_index { |param, i|
-            if param.respond_to?(:name)
-              name = param.name
+            next unless param.respond_to?(:name)
 
-              value = path_var_values[name] || path_var_values[name.to_sym]
-              value = param % value
-              fragment[i] = value if value
+            name = param.name
 
-              path_params_to_delete << param
-            end
+            value = path_var_values[name] || path_var_values[name.to_sym]
+            value = param % value
+            fragment[i] = value if value
+
+            path_params_to_delete << param
           }
         end
       }
@@ -142,6 +151,11 @@ module WADL
       self
     end
 
+    def auth(header, value)
+      @auth[header] = value
+      self
+    end
+
     def uri(args = {})
       obj, uri = deep_copy.bind!(args), ''
 

data/lib/wadl/cli.rb

@@ -3,7 +3,7 @@
 #                                                                             #
 # A component of wadl, the super cheap Ruby WADL client.                      #
 #                                                                             #
-# Copyright (C) 2010-2011 Jens Wille                                          #
+# Copyright (C) 2010-2012 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@uni-koeln.de>                                    #
@@ -134,12 +134,14 @@ module WADL
         if arg =~ OPTION_RE
           key, value, next_arg = $1, $2, arguments[index + 1]
 
-          add_param(query, key, value || if next_arg =~ OPTION_RE
+          value ||= if next_arg.nil? || next_arg =~ OPTION_RE
             '1'  # "true"
           else
             skip_next = true
             next_arg
-          end)
+          end
+
+          add_param(query, key, value)
         else
           resource_path << arg
         end

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-2011 Jens Wille                                          #
+# Copyright (C) 2010-2012 Jens Wille                                          #
 #                                                                             #
 # Authors:                                                                    #
 #     Leonard Richardson <leonardr@segfault.org> (Original author)            #
@@ -44,19 +44,24 @@ module WADL
       super
     end
 
+    def resource_and_address(child = self, *args)
+      ResourceAndAddress.new(child, *args)
+    end
+
     def dereference_with_context(child)
-      ResourceAndAddress.new(child, parent.address)
+      resource_and_address(child, parent.address)
     end
 
     # Returns a ResourceAndAddress object bound to this resource
     # and the given query variables.
     def bind(args = {})
-      ResourceAndAddress.new(self).bind!(args)
+      resource_and_address.bind!(args)
     end
 
     # Sets basic auth parameters
     def with_basic_auth(user, pass, header = 'Authorization')
-      bind(:headers => { header => "Basic #{["#{user}:#{pass}"].pack('m')}" })
+      resource_and_address.auth(header,
+        "Basic #{["#{user}:#{pass}"].pack('m')}")
     end
 
     # Sets OAuth parameters
@@ -67,8 +72,8 @@ module WADL
     #  :access_token
     #  :token_secret
     def with_oauth(*args)
-      header, prefix = HTTPMethod::OAUTH_HEADER, HTTPMethod::OAUTH_PREFIX
-      bind(:headers => { header => "#{prefix}#{args.to_yaml}" })
+      resource_and_address.auth(HTTPMethod::OAUTH_HEADER,
+        "#{HTTPMethod::OAUTH_PREFIX}#{args.to_yaml}")
     end
 
     def uri(args = {}, working_address = nil)

data/lib/wadl/resource_and_address.rb

@@ -70,6 +70,11 @@ module WADL
       self
     end
 
+    def auth(header, value)
+      @address.auth(header, value)
+      self
+    end
+
     def uri(args = {})
       @address.deep_copy.bind!(args).uri
     end

data/lib/wadl/version.rb

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

data/test/wadl_test.rb

@@ -24,7 +24,7 @@ class WADLTest < Test::Unit::TestCase
     EOT
   end
 
-  # Null test to shut the compiler up.
+  # Null test to shut the compiler up. (Ruby < 1.9)
   def test_null
   end
 
@@ -251,10 +251,12 @@ class PathParameters < WADLTest
     assert_equal(lights.uri(:path => { :light3 => true    }), off_uri)
   end
 
-  class RequestFormatTests < WADLTest
+end
+
+class RequestFormatTests < WADLTest
 
-    def setup
-      @wadl = wadl(<<-EOT)
+  def setup
+    @wadl = wadl(<<-EOT)
 <resources base="http://www.example.com/">
   <resource id="top" path="palette">
     <param style="form" name="api_key" />
@@ -279,32 +281,79 @@ class PathParameters < WADLTest
     </representation>
   </request>
 </method>
-      EOT
+    EOT
+
+    @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' }
+
+    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) }
+  end
+
+  def test_representation
+    graphic = @color.find_method('set_graphic')
+    representation = graphic.request.find_form
 
-      @color = @wadl.find_resource('top').bind(:query => { :api_key => 'foobar' }).find_resource('color')
-    end
+    assert_equal(representation % { :new_graphic => 'foobar', 'filename' => 'blue.jpg' },
+                 'new_graphic=foobar&filename=blue.jpg')
 
-    def test_query_vars
-      graphic = @color.find_method('get_graphic')
-      path    = { :color => 'blue' }
-      query   = { :shade => 'light' }
+    assert_raises(ArgumentError) { representation % { :new_graphic => 'foobar' } }
+  end
+
+end
 
-      assert_equal(graphic.request.uri(@color, :path => path, :query => query),
-                   'http://www.example.com/palette/colors/blue?shade=light')
+class AuthTests < WADLTest
+
+  def setup
+    @wadl = wadl(<<-EOT)
+<resources base="http://www.example.com/">
+  <resource path="service/{id}.json" id="service_id_json">
+    <param name="Authorization" style="header"/>
+    <param name="id" style="template" type="plain"/>
+    <method name="DELETE" id="DELETE-service_id_json">
+      <request></request>
+      <response></response>
+    </method>
+    <method name="PUT" id="PUT-service_id_json">
+      <request>
+        <param name="body" style="header" type="application/json"/>
+      </request>
+      <response></response>
+    </method>
+    <method name="GET" id="GET-service_id_json">
+      <request></request>
+      <response>
+        <representation type="application/json"/>
+      </response>
+    </method>
+  </resource>
+</resources>
+    EOT
 
-      assert_raises(ArgumentError) { graphic.request.uri(@color, path) }
-    end
+    @service = @wadl.resource(:service_id_json)
+  end
 
-    def test_representation
-      graphic = @color.find_method('set_graphic')
-      representation = graphic.request.find_form
+  def test_basic_auth
+    assert_equal("Basic dTpw\n",
+      @service.with_basic_auth('u', 'p').uri.headers['Authorization'])
+  end
 
-      assert_equal(representation % { :new_graphic => 'foobar', 'filename' => 'blue.jpg' },
-                   'new_graphic=foobar&filename=blue.jpg')
+  def test_template_params_with_basic_auth
+    arg = { :path => { :id => 42 } }
+    uri = 'http://www.example.com/service/42.json'
 
-      assert_raises(ArgumentError) { representation % { :new_graphic => 'foobar' } }
-    end
+    assert_equal(uri, u1 = @service.bind(arg).uri)
+    assert_equal(nil, u1.headers['Authorization'])
 
+    assert_equal(uri, u2 = @service.with_basic_auth('u', 'p').bind(arg).uri)
+    assert_equal("Basic dTpw\n", u2.headers['Authorization'])
   end
 
 end

metadata

@@ -1,162 +1,150 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: wadl
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.2.7
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 6
-  version: 0.2.6
 platform: ruby
-authors: 
+authors:
 - Leonard Richardson
 - Jens Wille
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-06 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-open-uri
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mime-types
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: ruby-nuggets
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 7
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-nuggets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.7.3
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.3
 description: Ruby client for the Web Application Description Language.
-email: 
+email:
 - leonardr@segfault.org
 - jens.wille@uni-koeln.de
-executables: 
+executables:
 - wadl
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README
 - COPYING
 - ChangeLog
-files: 
-- lib/wadl.rb
-- lib/wadl/uri_parts.rb
-- lib/wadl/resource.rb
-- lib/wadl/response.rb
-- lib/wadl/option.rb
-- lib/wadl/param.rb
-- lib/wadl/application.rb
-- lib/wadl/resource_and_address.rb
+files:
 - lib/wadl/fault_format.rb
 - lib/wadl/version.rb
-- lib/wadl/link.rb
-- lib/wadl/response_format.rb
-- lib/wadl/resources.rb
-- lib/wadl/representation_container.rb
 - lib/wadl/cli.rb
 - lib/wadl/address.rb
 - lib/wadl/http_method.rb
-- lib/wadl/has_docs.rb
+- lib/wadl/option.rb
+- lib/wadl/request_format.rb
+- lib/wadl/link.rb
+- lib/wadl/representation_container.rb
+- lib/wadl/response.rb
 - lib/wadl/xml_representation.rb
-- lib/wadl/cheap_schema.rb
-- lib/wadl/resource_container.rb
 - lib/wadl/resource_type.rb
+- lib/wadl/response_format.rb
+- lib/wadl/resource_and_address.rb
+- lib/wadl/resource_container.rb
+- lib/wadl/documentation.rb
+- lib/wadl/resources.rb
+- lib/wadl/application.rb
+- lib/wadl/uri_parts.rb
+- lib/wadl/has_docs.rb
 - lib/wadl/fault.rb
-- lib/wadl/request_format.rb
 - lib/wadl/representation_format.rb
-- lib/wadl/documentation.rb
+- lib/wadl/param.rb
+- lib/wadl/resource.rb
+- lib/wadl/cheap_schema.rb
+- lib/wadl.rb
 - bin/wadl
-- ChangeLog
 - COPYING
-- README
-- Rakefile
 - TODO
-- example/YahooSearch.rb
+- ChangeLog
+- Rakefile
+- README
+- example/config.yaml
+- example/delicious.rb
+- example/yahoo.wadl
 - example/yahoo.rb
+- example/crummy.rb
+- example/YahooSearch.rb
 - example/crummy.wadl
-- example/YahooSearch.wadl
-- example/README
 - example/delicious.wadl
-- example/yahoo.wadl
-- example/delicious.rb
-- example/crummy.rb
-- example/config.yaml
+- example/README
+- example/YahooSearch.wadl
 - test/wadl_test.rb
 homepage: http://github.com/blackwinter/wadl
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --main
-- README
-- --all
+rdoc_options:
 - --charset
 - UTF-8
+- --line-numbers
+- --all
 - --title
-- wadl Application documentation (v0.2.6)
-require_paths: 
+- wadl Application documentation (v0.2.7)
+- --main
+- README
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby client for the Web Application Description Language.
 test_files: []
-