更新日: 2014年2月17日
Ruby

はてなブックマークAPIを Ruby の XMLRPC::Client で利用する時にはまった箇所

はてブ API を、Ruby の XMLRPC::Client で利用した時に、はまった箇所が2箇所あったので備忘録。

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

はてなブックマーク件数取得API – Hatena Developer Center を利用してはてなブックマーク総数カウンター | EasyRamble を作ったのですが、サンプルプログラムの Perl コードを参考にして Ruby で書いた。jQuery を利用した Ajax リクエストで、Javascript のコードは WordPress の投稿記事内に直接書きました。

最初に書いた Ruby コード（簡略版）

EndPoint = "http://b.hatena.ne.jp/xmlrpc"

server = XMLRPC::Client.new2(EndPoint)

begin
  count = server.call('bookmark.getTotalCount', url)
  puts count
rescue XMLRPC::FaultException => e
  puts "Error:"
  puts e.faultCode
  puts e.faultString
end

EndPoint = "http://b.hatena.ne.jp/xmlrpc"

server = XMLRPC::Client.new2(EndPoint)

begin

count = server.call('bookmark.getTotalCount', url)

puts count

rescue XMLRPC::FaultException => e

puts "Error:"

puts e.faultCode

puts e.faultString

end

簡略化してますけど以上の様なコードを最初書いたところ、以降のエラーに遭遇しました。

Wrong content-type エラー

まず遭遇したのが、以下の content-type が間違ってますよ、のエラー。


/****/xmlrpc/client.rb:498:in `do_rpc': Wrong content-type (received 'application/xml' but expected 'text/xml') (RuntimeError)

/****/xmlrpc/client.rb:498:in `do_rpc': Wrong content-type (received 'application/xml' but expected 'text/xml') (RuntimeError)

xmlrpc/client.rb:498 を確認すると…

# assume text/xml on instances where Content-Type header is not set
ct_expected = resp["Content-Type"] || 'text/xml'
ct = parse_content_type(ct_expected).first
if ct != "text/xml"
  if ct == "text/html"
    raise "Wrong content-type (received '#{ct}' but expected 'text/xml'): \n#{data}"
  else
    raise "Wrong content-type (received '#{ct}' but expected 'text/xml')"
  end
end

# assume text/xml on instances where Content-Type header is not set

ct_expected = resp["Content-Type"] || 'text/xml'

ct = parse_content_type(ct_expected).first

if ct != "text/xml"

if ct == "text/html"

raise "Wrong content-type (received '#{ct}' but expected 'text/xml'): \n#{data}"

else

raise "Wrong content-type (received '#{ct}' but expected 'text/xml')"

end

Ruby のライブラリ XMLRPC::Client（xmlrpc/client）は、content-type として text/xml のみを受け取る前提になっているようです。はてブAPIを叩いて実際に受け取っているのは、application/xml。

parse_content_type メソッドは以下。xmlrpc/utils.rb の163行目〜。

module XMLRPC
...
  module ParseContentType
    def parse_content_type(str)
      a, *b = str.split(";")
      return a.strip.downcase, *b
    end
  end
end

module XMLRPC

...

module ParseContentType

def parse_content_type(str)

a, *b = str.split(";")

return a.strip.downcase, *b

end

モンキーパッチで、以下のように content-type を無理やり書き換えて text/xml を返すようにしてやる。

# monkey patching
module XMLRPC::ParseContentType
  def parse_content_type(str)
    a, *b = str.split(";")
    a = "text/xml" if a == "application/xml"
    return a.strip.downcase, *b
  end
end

# monkey patching

module XMLRPC::ParseContentType

def parse_content_type(str)

a, *b = str.split(";")

a = "text/xml" if a == "application/xml"

return a.strip.downcase, *b

end

このコードを追加して、Wrong content-type エラーは回避出来ました。

Wrong size エラー

次に遭遇したのが、Wrong size エラー。


/*****/xmlrpc/client.rb:506:in `do_rpc': Wrong size. Was 136, should be 117 (RuntimeError)

/*****/xmlrpc/client.rb:506:in `do_rpc': Wrong size. Was 136, should be 117 (RuntimeError)

xmlrpc/client.rb:506 は以下。

expected = resp["Content-Length"] || "<unknown>"
if data.nil? or data.bytesize == 0
  raise "Wrong size. Was #{data.bytesize}, should be #{expected}"
elsif expected != "<unknown>" and expected.to_i != data.bytesize and resp["Transfer-Encoding"].nil?
  raise "Wrong size. Was #{data.bytesize}, should be #{expected}"
end

expected = resp["Content-Length"] || "<unknown>"

if data.nil? or data.bytesize == 0

raise "Wrong size. Was #{data.bytesize}, should be #{expected}"

elsif expected != "<unknown>" and expected.to_i != data.bytesize and resp["Transfer-Encoding"].nil?

raise "Wrong size. Was #{data.bytesize}, should be #{expected}"

end

今度は、Content-Length のサイズが期待されたもの値と違いますよ、という内容のエラーです。これは、XMLRPC が依存する Net::HTTP がデフォルトで HTTP 圧縮を行っているためらしい。ということで、HTTP 圧縮を行わないように header 情報を追加します。

server = XMLRPC::Client.new2(EndPoint)
server.http_header_extra = {'accept-encoding' => 'identity'}

1 2	server = XMLRPC::Client.new2(EndPoint) server.http_header_extra = {'accept-encoding' => 'identity'}

以上で Wrong size エラーも回避できました。

私は以下の本で Ruby を覚えました。メタプログラミングRubyは入門を超える内容で難しめです。

たのしいRuby 第5版

パーフェクトRuby (PERFECT SERIES 6)

メタプログラミングRuby 第2版

>> 次の記事 : SEQUEL DEPRECATION WARNING: Loading the pagination extension globally is deprecated…

<< 前の記事 : Ruby の配列で重複する値のみを取り出す

はてなブックマークAPIを Ruby の XMLRPC::Client で利用する時にはまった箇所

最初に書いた Ruby コード（簡略版）

Wrong content-type エラー

Wrong size エラー

Leave Your Message! コメントをキャンセル