rs-httpclient 3.0.0.beta1

data/lib/jsonclient.rb

@@ -0,0 +1,66 @@
+require 'httpclient'
+require 'json'
+ 
+# JSONClient auto-converts Hash <-> JSON in request and response.
+# * For PATCH, POST or PUT request, convert Hash body to JSON String with 'application/json; charset=utf-8' header.
+# * For response, convert JSON String to Hash when content-type is '(application|text)/(x-)?json'
+class JSONClient < HTTPClient
+  CONTENT_TYPE_JSON_REGEX = /(application|text)\/(x-)?json/i
+  CONTENT_TYPE_JSON = 'application/json; charset=utf-8'
+
+  attr_reader :content_type_json_request
+  attr_reader :content_type_json_response_regex
+ 
+  def initialize(*args)
+    super
+    @content_type_json_request = CONTENT_TYPE_JSON
+    @content_type_json_response_regex = CONTENT_TYPE_JSON_REGEX
+  end
+ 
+  def patch(uri, *args, &block)
+    request(:patch, uri, argument_to_hash_for_json(args), &block)
+  end
+ 
+  def post(uri, *args, &block)
+    request(:post, uri, argument_to_hash_for_json(args), &block)
+  end
+ 
+  def put(uri, *args, &block)
+    request(:put, uri, argument_to_hash_for_json(args), &block)
+  end
+
+  def request(method, uri, *args, &block)
+    res = super
+    if @content_type_json_response_regex =~ res.content_type
+      res = wrap_json_response(res)
+    end
+    res
+  end
+ 
+private
+
+  def argument_to_hash_for_json(args)
+    hash = argument_to_hash(args, :body, :header, :follow_redirect)
+    if hash[:body].is_a?(Hash) || hash[:body].is_a?(Array)
+      hash[:header] = json_header(hash[:header])
+      hash[:body] = JSON.generate(hash[:body])
+    end
+    hash
+  end
+
+  def json_header(header)
+    header ||= {}
+    if header.is_a?(Hash)
+      header.merge('Content-Type' => @content_type_json_request)
+    else
+      header + [['Content-Type', @content_type_json_request]]
+    end
+  end
+
+  def wrap_json_response(original)
+    res = ::HTTP::Message.new_response(JSON.parse(original.content))
+    res.http_header = original.http_header
+    res.previous = original
+    res
+  end
+end

data/lib/oauthclient.rb

@@ -0,0 +1,111 @@
+# HTTPClient - HTTP client library.
+# Copyright (C) 2000-2015  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)
+    self.strict_response_size_check = true
+  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/", "username", "password")
+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/generate_test_keys.rb

@@ -0,0 +1,99 @@
+require "openssl"
+
+def build_ca
+  root_key = OpenSSL::PKey::RSA.new 2048 # the CA's public/private key
+  root_ca = OpenSSL::X509::Certificate.new
+  root_ca.version = 2 # cf. RFC 5280 - to make it a "v3" certificate
+  root_ca.serial = 1
+  root_ca.subject = OpenSSL::X509::Name.parse "C=JP,O=JIN.GR.JP,OU=RRR,CN=CA"
+  root_ca.issuer = root_ca.subject # root CA's are "self-signed"
+  root_ca.public_key = root_key.public_key
+  root_ca.not_before = Time.now
+  root_ca.not_after = root_ca.not_before + 10 * 365 * 24 * 60 * 60 # 10 years validity
+  ef = OpenSSL::X509::ExtensionFactory.new
+  ef.subject_certificate = root_ca
+  ef.issuer_certificate = root_ca
+  root_ca.add_extension(ef.create_extension("basicConstraints","CA:TRUE",true))
+  root_ca.add_extension(ef.create_extension("keyUsage","keyCertSign, cRLSign", true))
+  root_ca.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false))
+  root_ca.add_extension(ef.create_extension("authorityKeyIdentifier","keyid:always",false))
+  root_ca.sign(root_key, OpenSSL::Digest::SHA256.new)
+  [root_key, root_ca]
+end
+
+root_key, root_ca = build_ca
+
+File.write("test/ca.cert", root_ca.to_s)
+File.write("test/ca.key", root_key.to_s)
+
+def sub_cert(root_key, root_ca, cn, intermediate: false)
+  key = OpenSSL::PKey::RSA.new 2048
+  cert = OpenSSL::X509::Certificate.new
+  cert.version = 2
+  cert.serial = 2
+  cert.subject = OpenSSL::X509::Name.parse "C=JP,O=JIN.GR.JP,OU=RRR,CN=#{cn}"
+  cert.issuer = root_ca.subject # root CA is the issuer
+  cert.public_key = key.public_key
+  cert.not_before = Time.now
+  cert.not_after = cert.not_before + 9 * 365 * 24 * 60 * 60 # 9 years validity
+  ef = OpenSSL::X509::ExtensionFactory.new
+  ef.subject_certificate = cert
+  ef.issuer_certificate = root_ca
+  cert.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false))
+  if intermediate
+    cert.add_extension(ef.create_extension("keyUsage","keyCertSign, cRLSign", true))
+    cert.add_extension(ef.create_extension("basicConstraints","CA:TRUE",true))
+  else
+    cert.add_extension(ef.create_extension("keyUsage","digitalSignature, keyEncipherment", true))
+    cert.add_extension(ef.create_extension("extendedKeyUsage", "serverAuth"))
+  end
+  cert.sign(root_key, OpenSSL::Digest::SHA256.new)
+  [key, cert]
+end
+
+sub_key, sub_cert = sub_cert(root_key, root_ca, "SubCA", intermediate: true)
+File.write("test/subca.cert", sub_cert.to_s)
+File.write("test/subca.key", sub_key.to_s)
+
+server_key, server_cert = sub_cert(sub_key, sub_cert, "localhost")
+File.write("test/server.cert", server_cert.to_s)
+File.write("test/server.key", server_key.to_s)
+
+client_key, client_cert = sub_cert(root_key, root_ca, "localhost")
+File.write("test/client.cert", client_cert.to_s)
+File.write("test/client.key", client_key.to_s)
+
+system(
+  "openssl", "rsa", "-aes256",
+  "-in", "test/client.key",
+  "-out", "test/client-pass.key",
+  "-passout", "pass:pass4key",
+)
+
+File.write("test/ca-chain.pem", root_ca.to_s + sub_cert.to_s)
+
+verify_key = OpenSSL::PKey::RSA.new 2048
+File.write("test/fixtures/verify.key", verify_key.to_s)
+
+def build_self_signed(key, cn)
+  cert = OpenSSL::X509::Certificate.new
+  cert.version = 2
+  cert.serial = 2
+  cert.subject = OpenSSL::X509::Name.parse "C=JP,O=JIN.GR.JP,OU=RRR,CN=#{cn}"
+  cert.issuer = cert.subject
+  cert.public_key = key.public_key
+  cert.not_before = Time.now
+  cert.not_after = cert.not_before + 9 * 365 * 24 * 60 * 60 # 9 years validity
+  ef = OpenSSL::X509::ExtensionFactory.new
+  ef.subject_certificate = cert
+  ef.issuer_certificate = cert
+  cert.add_extension(ef.create_extension("subjectKeyIdentifier","hash",false))
+  cert.add_extension(ef.create_extension("keyUsage","digitalSignature, keyEncipherment", true))
+  cert.add_extension(ef.create_extension("extendedKeyUsage", "serverAuth"))
+  cert.sign(key, OpenSSL::Digest::SHA256.new)
+  cert
+end
+
+File.write("test/fixtures/verify.localhost.cert", build_self_signed(verify_key, "localhost").to_s)
+File.write("test/fixtures/verify.foo.cert", build_self_signed(verify_key, "foo").to_s)
+File.write("test/fixtures/verify.alt.cert", build_self_signed(verify_key, "alt").to_s)

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

data/sample/jsonclient.rb

@@ -0,0 +1,67 @@
+require 'httpclient'
+require 'json'
+ 
+module HTTP
+  class Message
+    # Returns JSON object of message body
+    alias original_content content
+    def content
+      if JSONClient::CONTENT_TYPE_JSON_REGEX =~ content_type
+        JSON.parse(original_content)
+      else
+        original_content
+      end
+    end
+  end
+end
+ 
+ 
+# JSONClient provides JSON related methods in addition to HTTPClient.
+class JSONClient < HTTPClient
+  CONTENT_TYPE_JSON_REGEX = /(application|text)\/(x-)?json/i
+ 
+  attr_accessor :content_type_json
+ 
+  class JSONRequestHeaderFilter
+    attr_accessor :replace
+ 
+    def initialize(client)
+      @client = client
+      @replace = false
+    end
+ 
+    def filter_request(req)
+      req.header['content-type'] = @client.content_type_json if @replace
+    end
+ 
+    def filter_response(req, res)
+      @replace = false
+    end
+  end
+ 
+  def initialize(*args)
+    super
+    @header_filter = JSONRequestHeaderFilter.new(self)
+    @request_filter << @header_filter
+    @content_type_json = 'application/json; charset=utf-8'
+  end
+ 
+  def post(uri, *args, &block)
+    @header_filter.replace = true
+    request(:post, uri, jsonify(argument_to_hash(args, :body, :header, :follow_redirect)), &block)
+  end
+ 
+  def put(uri, *args, &block)
+    @header_filter.replace = true
+    request(:put, uri, jsonify(argument_to_hash(args, :body, :header)), &block)
+  end
+ 
+private
+ 
+  def jsonify(hash)
+    if hash[:body] && hash[:body].is_a?(Hash)
+      hash[:body] = JSON.generate(hash[:body])
+    end
+    hash
+  end
+end

data/sample/oauth_buzz.rb

@@ -0,0 +1,57 @@
+require 'oauthclient'
+require 'zlib'
+require 'stringio'
+
+# Get your own consumer token from http://code.google.com/apis/accounts/docs/RegistrationForWebAppsAuto.html
+consumer_key = nil
+consumer_secret = nil
+
+callback = 'http://localhost/' # should point somewhere else...
+scope = 'https://www.googleapis.com/auth/buzz'
+request_token_url = 'https://www.google.com/accounts/OAuthGetRequestToken'
+access_token_url = 'https://www.google.com/accounts/OAuthGetAccessToken'
+
+STDOUT.sync = true
+
+# create OAuth client.
+client = OAuthClient.new
+client.oauth_config.consumer_key = consumer_key
+client.oauth_config.consumer_secret = consumer_secret
+client.oauth_config.signature_method = 'HMAC-SHA1'
+client.oauth_config.http_method = :get # Twitter does not allow :post
+client.debug_dev = STDERR if $DEBUG
+
+# Get request token.
+res = client.get_request_token(request_token_url, callback, :scope => scope)
+p res.status
+p res.oauth_params
+p res.content
+p client.oauth_config
+token = res.oauth_params['oauth_token']
+secret = res.oauth_params['oauth_token_secret']
+raise if token.nil? or secret.nil?
+
+# You need to confirm authorization out of band.
+puts
+puts "Go here and do confirm: https://www.google.com/buzz/api/auth/OAuthAuthorizeToken?oauth_token=#{token}&domain=#{consumer_key}&scope=#{scope}"
+puts "Type oauth_verifier (if given) and hit [enter] to go"
+require 'cgi'
+verifier = CGI.unescape(gets.chomp)
+verifier = nil if verifier.empty?
+
+# Get access token.
+res = client.get_access_token(access_token_url, token, secret, verifier)
+p res.status
+p res.oauth_params
+p res.content
+p client.oauth_config
+id = res.oauth_params['user_id']
+
+puts
+puts "Access token usage example"
+puts "Hit [enter] to go"
+gets
+
+# Access to a protected resource.
+# @consumption requires Buzz API
+puts client.get_content("https://www.googleapis.com/buzz/v1/activities/@me/@consumption", :alt => :json, :prettyprint => true)

data/sample/oauth_friendfeed.rb

@@ -0,0 +1,59 @@
+require 'oauthclient'
+
+# Get your own consumer token from http://friendfeed.com/api/applications
+consumer_key = 'EDIT HERE'
+consumer_secret = 'EDIT HERE'
+
+request_token_url = 'https://friendfeed.com/account/oauth/request_token'
+oob_authorize_url = 'https://friendfeed.com/account/oauth/authorize'
+access_token_url = 'https://friendfeed.com/account/oauth/access_token'
+
+STDOUT.sync = true
+
+# create OAuth client.
+client = OAuthClient.new
+client.oauth_config.consumer_key = consumer_key
+client.oauth_config.consumer_secret = consumer_secret
+client.oauth_config.signature_method = 'HMAC-SHA1'
+client.oauth_config.http_method = :get # FriendFeed does not allow :post
+client.debug_dev = STDERR if $DEBUG
+
+# Get request token.
+res = client.get_request_token(request_token_url)
+p res.status
+p res.oauth_params
+p res.content
+p client.oauth_config
+token = res.oauth_params['oauth_token']
+secret = res.oauth_params['oauth_token_secret']
+raise if token.nil? or secret.nil?
+
+# You need to confirm authorization out of band.
+puts
+puts "Go here and do confirm: #{oob_authorize_url}?oauth_token=#{token}"
+puts "Hit [enter] to go"
+gets
+
+# Get access token.
+# FYI: You may need to re-construct OAuthClient instance here.
+#      In normal web app flow, getting access token and getting request token
+#      must be done in different HTTP requests.
+#  client = OAuthClient.new
+#  client.oauth_config.consumer_key = consumer_key
+#  client.oauth_config.consumer_secret = consumer_secret
+#  client.oauth_config.signature_method = 'HMAC-SHA1'
+#  client.oauth_config.http_method = :get # Twitter does not allow :post
+res = client.get_access_token(access_token_url, token, secret)
+p res.status
+p res.oauth_params
+p res.content
+p client.oauth_config
+username = res.oauth_params['username']
+
+puts
+puts "Access token usage example"
+puts "Hit [enter] to go"
+gets
+
+# Access to a protected resource. (user profile)
+puts client.get("http://friendfeed-api.com/v2/feedinfo/#{username}?format=json")