wrest 1.0.0.beta2-universal-java-1.6

data/lib/wrest/curl/delete.rb

@@ -0,0 +1,23 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
+
+module Wrest::Curl
+  class Delete < Request
+    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
+      super(
+            wrest_uri, 
+            :delete, 
+            parameters,
+            nil,
+            headers,
+            options
+          )
+    end
+  end
+end

data/lib/wrest/curl/get.rb

@@ -0,0 +1,23 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
+
+module Wrest::Curl
+  class Get < Request
+    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
+      super(
+        wrest_uri,
+        :get,
+        parameters,
+        nil,
+        headers,
+        options
+      )
+    end
+  end
+end

data/lib/wrest/curl/options.rb

@@ -0,0 +1,16 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
+
+module Wrest::Curl
+  class Options < Request
+    def initialize(*args)
+      raise Wrest::Exceptions::UnsupportedHttpVerb, 'Options'
+    end
+  end
+end

data/lib/wrest/curl/post.rb

@@ -0,0 +1,23 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
+
+module Wrest::Curl
+  class Post < Request
+    def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
+      super(
+        wrest_uri,
+        :post,
+        parameters,
+        body,
+        headers,
+        options
+      )
+    end
+  end
+end

data/lib/wrest/curl/put.rb

@@ -0,0 +1,23 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
+
+module Wrest::Curl
+  class Put < Request
+    def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
+      super(
+        wrest_uri,
+        :put,
+        parameters,
+        body,
+        headers,
+        options
+      )
+    end
+  end
+end

data/lib/wrest/curl/request.rb

@@ -0,0 +1,97 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
+
+module Wrest
+  module Curl
+    # This represents a HTTP request. Typically you will never need to instantiate
+    # one of these yourself - you can use one of the more conveient APIs via Wrest::Uri
+    # or Wrest::Curl::Get etc. instead.
+    class Request
+      attr_reader :http_request, :uri, :body, :headers, :username, :password, :follow_redirects,
+      :follow_redirects_limit, :timeout, :connection, :parameters, :auth_type
+      # Valid tuples for the options are:
+      #   :username => String, defaults to nil
+      #   :password => String, defaults to nil
+      #   :follow_redirects => Boolean, defaults to true for Get, false for anything else
+      #   :follow_redirects_limit => Integer, defaults to 5. This is the number of redirects
+      #                              that Wrest will automatically follow before raising an
+      #                              Wrest::Exceptions::AutoRedirectLimitExceeded exception.
+      #                              For example, if you set this to 1, the very first redirect
+      #                              will raise the exception.
+      #   :timeout => The period, in seconds, after which a Timeout::Error is raised
+      #               in the event of a connection failing to open. Defaulted to 60 by Uri#create_connection.
+      #   :connection => The HTTP Connection object to use. This is how a keep-alive connection can be
+      #                  used for multiple requests. Not yet fully implemented for Curl.
+      #
+      # Curl specific options:
+      #   :auth_type => This is a curl specific option and can be one of :basic, :digest, or :any. The default is :basic.
+      def initialize(wrest_uri, http_verb, parameters = {}, body = nil, headers = {}, options = {})
+        @uri = wrest_uri
+        @headers = headers.stringify_keys
+        @parameters = parameters
+        @body = body
+
+        @options = options.clone
+        @auth_type = @options[:auth_type] || :basic
+        @username = @options[:username]
+        @password = @options[:password]
+        @follow_redirects = (@options[:follow_redirects] ||= false)
+
+        @follow_redirects_limit = (@options[:follow_redirects_limit] ||= 5)
+        @timeout = @options[:timeout] || 60
+        @connection = @options[:connection]
+
+        @http_request = Patron::Request.new
+        @http_request.action = http_verb
+        @http_request.upload_data = body
+        @http_request.headers = headers
+        @http_request.username = username
+        @http_request.password = password
+        @http_request.auth_type = auth_type
+        @http_request.url = parameters.empty? ? uri.to_s : "#{uri.to_s}?#{parameters.to_query}"
+        @http_request.max_redirects = follow_redirects_limit if follow_redirects
+        @http_request.timeout = @timeout
+      end
+
+      # Makes a request and returns a Wrest::Http::Response.
+      # Data about the request is and logged to Wrest.logger
+      # The log entry contains the following information:
+      #
+      #   --> indicates a request
+      #   <-- indicates a response
+      #
+      # The type of request is mentioned in caps, followed by a hash
+      # uniquely uniquely identifying a particular request/response pair.
+      # In a multi-process or multi-threaded scenario, this can be used
+      # to identify request-response pairs.
+      #
+      # The request hash is followed by a connection hash; requests using the
+      # same connection (effectively a keep-alive connection) will have the
+      # same connection hash.
+      #
+      # This is followed by the response code, the payload size and the time taken.
+      def invoke
+        response = nil
+
+        @connection ||= Patron::Session.new
+        raise ArgumentError, "Empty URL" if http_request.url.empty?
+
+        prefix = "#{http_request.action.to_s.upcase} #{http_request.hash} #{connection.hash}"
+
+        Wrest.logger.debug "--> (#{prefix}) #{http_request.url}"
+        time = Benchmark.realtime { response =  Wrest::Curl::Response.new(connection.handle_request(http_request))}
+        Wrest.logger.debug "<-- (#{prefix}) %s (%d bytes %.2fs)" % [response.message, response.body ? response.body.length : 0, time]
+
+        response
+      rescue Patron::TimeoutError => e
+        raise Wrest::Exceptions::Timeout.new(e)
+      end
+    end
+  end
+end

data/lib/wrest/curl/response.rb

@@ -0,0 +1,71 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License"); 
+# you may not use this file except in compliance with the License. 
+# You may obtain a copy of the License at Http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License 
+# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
+# See the License for the specific language governing permissions and limitations under the License. 
+
+module Wrest #:nodoc:
+  module Curl #:nodoc:
+    # Decorates a response providing support for deserialisation.
+    class Response              
+      attr_reader :http_response
+      include HttpShared::Headers
+      
+      extend Forwardable
+      def_delegators  :@http_response, :body, :headers
+      
+      def initialize_http_header
+        headers.merge!(headers.inject({}) do |downcased_headers, tuple|
+          key, value = tuple
+          downcased_headers[key.downcase] = value
+          downcased_headers
+        end)
+      end
+      
+      def initialize(http_response)
+        @http_response = http_response
+        initialize_http_header
+      end
+
+      def deserialise
+        deserialise_using(Wrest::Components::Translators.lookup(content_type))
+      end
+
+      def deserialise_using(translator)
+        translator.deserialise(@http_response)
+      end
+      
+      def code
+        @http_response.status
+      end
+      
+      def message
+        @http_response.status_line
+      end
+      
+      def content_length
+        self[H::ContentLength].try(:to_i)
+      end
+    
+      def content_type
+        self[H::ContentType].split(';').first
+      end
+            
+      # A null object implementation - invoking this method on
+      # a response simply returns the same response unless
+      # the response is a Redirection (code 3xx), in which case a 
+      # get is invoked on the url stored in the response headers
+      # under the key 'location' and the new Response is returned.
+      def follow(redirect_request_options = {})
+        self
+      end
+      
+      def connection_closed?
+        self[StandardHeaders::Connection].downcase == StandardTokens::Close.downcase
+      end
+    end
+  end
+end

data/lib/wrest/curl/session.rb

@@ -0,0 +1,57 @@
+# Copyright 2009 Sidu Ponnappa
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software distributed under the License
+# is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and limitations under the License.
+
+module Wrest::Native
+  # This class is a wrapper for a keep-alive HTTP connection. It simply passes the
+  # same connection instance as an option to all Wrest::Http::Request instances created using it.
+  #
+  # If at any point the server closes an existing connection during a Session by returning a
+  # Connection: Close header the current connection is destroyed and a fresh one created for the next
+  # request.
+  #
+  # The Session constructor can accept either a String URI or a Wrest::Uri as a parameter. If you
+  # need HTTP authentication, you should use a Wrest::Uri.
+  class Session
+    attr_reader :uri
+    def initialize(uri)
+      @uri = uri.is_a?(String) ? uri.to_uri : uri
+      @default_headers = { StandardHeaders::Connection => StandardTokens::KeepAlive }
+
+      yield(self) if block_given?
+    end
+
+    def connection
+      @connection ||= @uri.create_connection
+    end
+
+    def get(path = '', parameters = {}, headers = {})
+      maybe_destroy_connection @uri[path, {:connection => self.connection}].get(parameters, headers.merge(@default_headers))
+    end
+
+    def post(path = '', body = '', headers = {}, params = {})
+      maybe_destroy_connection @uri[path, {:connection => self.connection}].post(body, headers.merge(@default_headers), params)
+    end
+    
+    def put(path = '', body = '', headers = {}, params = {})
+      maybe_destroy_connection @uri[path, {:connection => self.connection}].put(body, headers.merge(@default_headers), params)
+    end
+
+    def delete(path = '', parameters = {}, headers = {})
+      maybe_destroy_connection @uri[path, {:connection => self.connection}].delete(parameters, headers.merge(@default_headers))
+    end
+    
+    def maybe_destroy_connection(response)
+      if response.connection_closed?
+        Wrest.logger.warn "Connection #{@connection.hash} has been closed by the server"
+        @connection = nil 
+      end
+      response
+    end
+  end
+end

data/lib/wrest/exceptions.rb

@@ -0,0 +1,33 @@
+module Wrest
+  module Exceptions #:nodoc:
+    # Raised when a base method that should be overriden
+    # is invoked on a subclass that has not implemented it.
+    class MethodNotOverridden < StandardError
+    end
+
+    # Raised when a translator for an unregisterd response content type
+    # is requested. See Translators.
+    class UnsupportedContentType < StandardError
+    end
+
+    # Raised when a request auto redirects more times than are allowed
+    # by its follow_redirects_limit. See Wrest::Http::Redirection.
+    class AutoRedirectLimitExceeded < StandardError
+    end
+
+    # Raised when a request is made when either RAILS_ENV or
+    # ENV['RAILS_ENV'] is set to 'test', which is the case when
+    # running tests/specs in a Rails application.
+    #
+    # See wrest/test/request_patches.
+    class RealRequestMadeInTestEnvironmet < StandardError
+    end
+
+    # Raised when a request times out
+    class Timeout < StandardError
+    end
+    
+    class UnsupportedHttpVerb < StandardError
+    end
+  end
+end

data/lib/wrest/exceptions.rbc

@@ -0,0 +1,312 @@
+!RBIX
+0
+x
+M
+1
+n
+n
+x
+10
+__script__
+i
+28
+99
+7
+0
+65
+49
+1
+2
+13
+99
+12
+7
+2
+12
+7
+3
+12
+65
+12
+49
+4
+4
+15
+49
+2
+0
+15
+2
+11
+I
+6
+I
+0
+I
+0
+I
+0
+n
+p
+5
+x
+5
+Wrest
+x
+11
+open_module
+x
+15
+__module_init__
+M
+1
+n
+n
+x
+5
+Wrest
+i
+28
+5
+66
+99
+7
+0
+65
+49
+1
+2
+13
+99
+12
+7
+2
+12
+7
+3
+12
+65
+12
+49
+4
+4
+15
+49
+2
+0
+11
+I
+6
+I
+0
+I
+0
+I
+0
+n
+p
+5
+x
+10
+Exceptions
+x
+11
+open_module
+x
+15
+__module_init__
+M
+1
+n
+n
+x
+10
+Exceptions
+i
+80
+5
+66
+99
+7
+0
+45
+1
+2
+65
+49
+3
+3
+15
+1
+15
+99
+7
+4
+45
+1
+5
+65
+49
+3
+3
+15
+1
+15
+99
+7
+6
+45
+1
+7
+65
+49
+3
+3
+15
+1
+15
+99
+7
+8
+45
+1
+9
+65
+49
+3
+3
+15
+1
+15
+99
+7
+10
+45
+1
+11
+65
+49
+3
+3
+15
+1
+15
+99
+7
+12
+45
+1
+13
+65
+49
+3
+3
+15
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+n
+p
+14
+x
+19
+MethodNotOverridden
+x
+13
+StandardError
+n
+x
+10
+open_class
+x
+22
+UnsupportedContentType
+n
+x
+25
+AutoRedirectLimitExceeded
+n
+x
+31
+RealRequestMadeInTestEnvironmet
+n
+x
+7
+Timeout
+n
+x
+19
+UnsupportedHttpVerb
+n
+p
+13
+I
+2
+I
+5
+I
+f
+I
+a
+I
+1c
+I
+f
+I
+29
+I
+17
+I
+36
+I
+1b
+I
+43
+I
+1e
+I
+50
+x
+46
+/Users/sidu/Work/wrest/lib/wrest/exceptions.rb
+p
+0
+x
+13
+attach_method
+p
+3
+I
+2
+I
+2
+I
+1c
+x
+46
+/Users/sidu/Work/wrest/lib/wrest/exceptions.rb
+p
+0
+x
+13
+attach_method
+p
+3
+I
+0
+I
+1
+I
+1c
+x
+46
+/Users/sidu/Work/wrest/lib/wrest/exceptions.rb
+p
+0