httpclient-jgraichen 2.3.4.2

data/lib/httpclient/util.rb

@@ -0,0 +1,178 @@
+# HTTPClient - HTTP client library.
+# Copyright (C) 2000-2012  NAKAMURA, Hiroshi  <nahi@ruby-lang.org>.
+#
+# This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
+# redistribute it and/or modify it under the same terms of Ruby's license;
+# either the dual license version in 2003, or any later version.
+
+
+unless ''.respond_to?(:bytesize)
+  class String
+    alias bytesize size
+  end
+end
+
+if RUBY_VERSION < "1.9.3"
+  require 'uri'
+  module URI
+    class Generic
+      def hostname
+        v = self.host
+        /\A\[(.*)\]\z/ =~ v ? $1 : v
+      end
+    end
+  end
+end
+
+class HTTPClient
+
+
+  # A module for common function.
+  module Util
+
+    # URI abstraction; Addressable::URI or URI
+    require 'uri'
+    begin
+      require 'addressable/uri'
+      # Older versions doesn't have #default_port
+      unless Addressable::URI.instance_methods.include?(:default_port) # 1.9 only
+        raise LoadError
+      end
+      class AddressableURI < Addressable::URI
+        # Overwrites the original definition just for one line...
+        def authority
+          self.host && @authority ||= (begin
+            authority = ""
+            if self.userinfo != nil
+              authority << "#{self.userinfo}@"
+            end
+            authority << self.host
+            if self.port != self.default_port # ...HERE! Compares with default_port because self.port is not nil in this wrapper.
+              authority << ":#{self.port}"
+            end
+            authority
+          end)
+        end
+
+        # HTTPClient expects urify("http://foo/").port to be not nil but 80 like URI.
+        def port
+          super || default_port
+        end
+
+        # Captured from uri/generic.rb
+        def hostname
+          v = self.host
+          /\A\[(.*)\]\z/ =~ v ? $1 : v
+        end
+      end
+      AddressableEnabled = true
+    rescue LoadError
+      AddressableEnabled = false
+    end
+
+    # Keyword argument helper.
+    # args:: given arguments.
+    # *field:: a list of arguments to be extracted.
+    #
+    # You can extract 3 arguments (a, b, c) with:
+    #
+    #   include Util
+    #   def my_method(*args)
+    #     a, b, c = keyword_argument(args, :a, :b, :c)
+    #     ...
+    #   end
+    #   my_method(1, 2, 3)
+    #   my_method(:b => 2, :a = 1)
+    #
+    # instead of;
+    #
+    #   def my_method(a, b, c)
+    #     ...
+    #   end
+    #
+    def keyword_argument(args, *field)
+      if args.size == 1 and Hash === args[0]
+        h = args[0]
+        if field.any? { |f| h.key?(f) }
+          return h.values_at(*field)
+        end
+      end
+      args
+    end
+
+    # Keyword argument to hash helper.
+    # args:: given arguments.
+    # *field:: a list of arguments to be extracted.
+    #
+    # Returns hash which has defined keys. When a Hash given, returns it
+    # including undefined keys. When an Array given, returns a Hash which only
+    # includes defined keys.
+    def argument_to_hash(args, *field)
+      return nil if args.empty?
+      if args.size == 1 and Hash === args[0]
+        h = args[0]
+        if field.any? { |f| h.key?(f) }
+          return h
+        end
+      end
+      h = {}
+      field.each_with_index do |e, idx|
+        h[e] = args[idx]
+      end
+      h
+    end
+
+    # Gets an URI instance.
+    def urify(uri)
+      if uri.nil?
+        nil
+      elsif uri.is_a?(URI)
+        uri
+      elsif AddressableEnabled
+        AddressableURI.parse(uri.to_s)
+      else
+        URI.parse(uri.to_s)
+      end
+    end
+    module_function :urify
+
+    # Returns true if the given 2 URIs have a part_of relationship.
+    # * the same scheme
+    # * the same host String (no host resolution or IP-addr conversion)
+    # * the same port number
+    # * target URI's path starts with base URI's path.
+    def uri_part_of(uri, part)
+      ((uri.scheme == part.scheme) and
+       (uri.host == part.host) and
+       (uri.port == part.port) and
+       uri.path.upcase.index(part.path.upcase) == 0)
+    end
+    module_function :uri_part_of
+
+    # Returns parent directory URI of the given URI.
+    def uri_dirname(uri)
+      uri = uri.clone
+      uri.path = uri.path.sub(/\/[^\/]*\z/, '/')
+      uri
+    end
+    module_function :uri_dirname
+
+    # Finds a value of a Hash.
+    def hash_find_value(hash, &block)
+      v = hash.find(&block)
+      v ? v[1] : nil
+    end
+    module_function :hash_find_value
+
+    # Checks if the given URI is https.
+    def https?(uri)
+      uri.scheme && uri.scheme.downcase == 'https'
+    end
+
+    def http?(uri)
+      uri.scheme && uri.scheme.downcase == 'http'
+    end
+  end
+
+
+end

data/lib/httpclient/version.rb

@@ -0,0 +1,3 @@
+class HTTPClient
+  VERSION = '2.3.4.1'
+end

data/lib/oauthclient.rb

@@ -0,0 +1,110 @@
+# HTTPClient - HTTP client library.
+# Copyright (C) 2000-2009  NAKAMURA, Hiroshi  <nahi@ruby-lang.org>.
+#
+# This program is copyrighted free software by NAKAMURA, Hiroshi.  You can
+# redistribute it and/or modify it under the same terms of Ruby's license;
+# either the dual license version in 2003, or any later version.
+
+
+require 'httpclient'
+
+module HTTP
+  class Message
+    attr_accessor :oauth_params
+  end
+end
+
+
+# OAuthClient provides OAuth related methods in addition to HTTPClient.
+#
+# See sample/ dir how to use OAuthClient. There are sample clients for Twitter,
+# FriendFeed and Google Buzz.
+class OAuthClient < HTTPClient
+
+  # HTTPClient::OAuth::Config:: OAuth configurator.
+  attr_accessor :oauth_config
+
+  # Creates a OAuthClient instance which provides OAuth related methods in
+  # addition to HTTPClient.
+  #
+  # Method signature is as same as HTTPClient.  See HTTPClient.new
+  def initialize(*arg)
+    super
+    @oauth_config = HTTPClient::OAuth::Config.new
+    self.www_auth.oauth.set_config(nil, @oauth_config)
+    self.www_auth.oauth.challenge(nil)
+  end
+
+  # Get request token.
+  # uri:: URI for request token.
+  # callback:: callback String. This can be nil for OAuth 1.0a
+  # param:: Additional query parameter Hash.
+  #
+  # It returns a HTTP::Message instance as a response. When the request is made
+  # successfully, you can retrieve a pair of request token and secret like
+  # following;
+  #   res = client.get_request_token(...)
+  #   token = res.oauth_params['oauth_token']
+  #   secret = res.oauth_params['oauth_token_secret']
+  def get_request_token(uri, callback = nil, param = nil)
+    oauth_config.token = nil
+    oauth_config.secret = nil
+    oauth_config.callback = callback
+    oauth_config.verifier = nil
+    res = request(oauth_config.http_method, uri, param)
+    filter_response(res)
+    res
+  end
+
+  # Get access token.
+  # uri:: URI for request token.
+  # request_token:: a request token String. See get_access_token.
+  # request_token_secret:: a request secret String. See get_access_token.
+  # verifier:: a verifier tag String.
+  #
+  # When the request succeeds and the server returns a pair of access token
+  # and secret, oauth_config.token and oauth_token.secret are updated with
+  # the access token. Then you can call OAuthClient#get, #post, #delete, etc.
+  # All requests are signed.
+  def get_access_token(uri, request_token, request_token_secret, verifier = nil)
+    oauth_config.token = request_token
+    oauth_config.secret = request_token_secret
+    oauth_config.callback = nil
+    oauth_config.verifier = verifier
+    res = request(oauth_config.http_method, uri)
+    filter_response(res)
+    oauth_config.verifier = nil
+    res
+  end
+
+  # Parse response and returns a Hash.
+  def get_oauth_response(res)
+    enc = res.header['content-encoding']
+    body = nil
+    if enc and enc[0] and enc[0].downcase == 'gzip'
+      body = Zlib::GzipReader.wrap(StringIO.new(res.content)) { |gz| gz.read }
+    else
+      body = res.content
+    end
+    body.split('&').inject({}) { |r, e|
+      key, value = e.split('=', 2)
+      r[unescape(key)] = unescape(value)
+      r
+    }
+  end
+
+private
+
+  def unescape(escaped)
+    escaped ? ::HTTP::Message.unescape(escaped) : nil
+  end
+
+  def filter_response(res)
+    if res.status == 200
+      if res.oauth_params = get_oauth_response(res)
+        oauth_config.token = res.oauth_params['oauth_token']
+        oauth_config.secret = res.oauth_params['oauth_token_secret']
+      end
+    end
+  end
+end

data/sample/async.rb

@@ -0,0 +1,8 @@
+require 'httpclient'
+
+c = HTTPClient.new
+conn = c.get_async("http://dev.ctor.org/")
+io = conn.pop.content
+while str = io.read(40)
+  p str
+end

data/sample/auth.rb

@@ -0,0 +1,11 @@
+require 'httpclient'
+
+c = HTTPClient.new
+c.debug_dev = STDOUT
+
+# for Proxy authentication: supports Basic, Negotiate and NTLM.
+#c.set_proxy_auth("admin", "admin")
+
+# for WWW authentication: supports Basic, Digest and Negotiate.
+c.set_auth("http://dev.ctor.org/http-access2/", "user", "user")
+p c.get("http://dev.ctor.org/http-access2/login")

data/sample/cookie.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join('..', 'lib'))
+require 'httpclient'
+
+proxy = ENV['HTTP_PROXY']
+clnt = HTTPClient.new(proxy)
+clnt.set_cookie_store("cookie.dat")
+clnt.debug_dev = STDOUT if $DEBUG
+
+while urlstr = ARGV.shift
+  response = clnt.get(urlstr){ |data|
+    print data
+  }
+  p response.contenttype
+end
+
+clnt.save_cookie_store

data/sample/dav.rb

@@ -0,0 +1,103 @@
+require 'uri'
+require 'httpclient'
+
+class DAV
+  attr_reader :headers
+
+  def initialize(uri = nil)
+    @uri = nil
+    @headers = {}
+    open(uri) if uri
+    proxy = ENV['HTTP_PROXY'] || ENV['http_proxy'] || nil
+    @client = HTTPClient.new(proxy)
+  end
+
+  def open(uri)
+    @uri = if uri.is_a?(URI)
+	uri
+      else
+	URI.parse(uri)
+      end
+  end
+
+  def set_basic_auth(user_id, passwd)
+    @client.set_basic_auth(@uri, user_id, passwd)
+  end
+
+  # TODO: propget/propset support
+
+  def propfind(target)
+    target_uri = @uri + target
+    res = @client.propfind(target_uri)
+    res.body.content
+  end
+
+  def get(target, local = nil)
+    local ||= target
+    target_uri = @uri + target
+    if FileTest.exist?(local)
+      raise RuntimeError.new("File #{ local } exists.")
+    end
+    f = File.open(local, "wb")
+    res = @client.get(target_uri, nil, @headers) do |data|
+      f << data
+    end
+    f.close
+    STDOUT.puts("#{ res.header['content-length'][0] } bytes saved to file #{ target }.")
+  end
+
+  def debug_dev=(dev)
+    @client.debug_dev = dev
+  end
+
+  def get_content(target)
+    target_uri = @uri + target
+    @client.get_content(target_uri, nil, @headers)
+  end
+
+  def put_content(target, content)
+    target_uri = @uri + target
+    res = @client.put(target_uri, content, @headers)
+    if res.status < 200 or res.status >= 300
+      raise "HTTP PUT failed: #{res.inspect}"
+    end
+  end
+
+  class Mock
+    attr_reader :headers
+
+    def initialize(uri = nil)
+      @uri = nil
+      @headers = {}
+      open(uri) if uri
+
+      @cache = {}
+    end
+
+    def open(uri)
+      @uri = uri.is_a?(URI) ?  uri : URI.parse(uri)
+    end
+
+    def set_basic_auth(user_id, passwd)
+      # ignore
+    end
+
+    def propfind(target)
+      # not found
+      nil
+    end
+
+    def get(target, local = nil)
+      # ignore
+    end
+
+    def get_content(target)
+      @cache[target]
+    end
+
+    def put_content(target, content)
+      @cache[target] = content
+      nil
+    end
+  end
+end

data/sample/howto.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join('..', 'lib'))
+require 'httpclient'
+
+proxy = ENV['HTTP_PROXY']
+clnt = HTTPClient.new(proxy)
+clnt.set_cookie_store("cookie.dat")
+target = ARGV.shift || "http://localhost/foo.cgi"
+
+puts
+puts '= GET content directly'
+puts clnt.get_content(target)
+
+puts '= GET result object'
+result = clnt.get(target)
+puts '== Header object'
+p result.header
+puts "== Content-type"
+p result.contenttype
+puts '== Body object'
+p result.body
+puts '== Content'
+print result.content
+puts '== GET with Block'
+clnt.get(target) do |str|
+  puts str
+end
+
+puts
+puts '= GET with query'
+puts clnt.get(target, { "foo" => "bar", "baz" => "quz" }).content
+
+puts
+puts '= GET with query 2'
+puts clnt.get(target, [["foo", "bar1"], ["foo", "bar2"]]).content
+
+clnt.debug_dev = STDERR
+puts
+puts '= GET with extra header'
+puts clnt.get(target, nil, { "SOAPAction" => "HelloWorld" }).content
+
+puts
+puts '= GET with extra header 2'
+puts clnt.get(target, nil, [["Accept", "text/plain"], ["Accept", "text/html"]]).content
+
+clnt.debug_dev = nil
+
+clnt.save_cookie_store