よくわからない現代魔法 RubyなTwitter bot作成メモ

/ 2024/04/24 (Wed) / 編集

[PR]上記の広告は3ヶ月以上新規記事投稿のないブログに表示されています。新しい記事を書く事で広告が消えます。

Libro-Twitter-Bot / 2010/06/12 (Sat) / 編集

というわけで、まったく進まずイライラする研究の合間にちょこちょこ作り続けてたbot用のクラスの作成メモ。while(true){実験用プログラム;bot;}て感じだったのであちこち記述がひどいがまぁ多めに見てほしいです。
ちなみにソースコードというよりもノウハウのメモがメイン
[メモ]OAuth認証でTwitterにアクセスを試してみたで取得した情報（「Consumer key」「Consumer secret」「Access token」「Access token secret」）を使うのでまだ持ってない人はそちらを先にどうぞ。
「普通に配布されてるの使えよw」という突っ込みには「趣味です（キリッ」と答えます。

クラスのひな形

とりあえずクラスのひな形、今回はOAuth認証を使って接続するので（もう少しするとBASIC認証は使えなくなる）gemで入れたoauthライブラリを使います。また、取得するデータの形式は（現状では）jsonとxmlとrssが選べるが選べるのでとりあえずJSON、これは単に好みの問題、とりあえずgemでjson用のライブラリもね。
後述しますが、プロフィール画像のアップロードもbotからやりたいときは３つほど追加で読み込んでおく必要があります。

require 'rubygems'
require 'oauth'#gemでインストール
require 'json'#gemでインストール

#プロフィール画像の変更用
require 'open-uri'
require 'net/http'
require 'cgi'

class TwitterClass
  @@format='json'#xml形式もできるよ
  def initialize(con_key,con_secret,ac_token,ac_token_secret)
    @consumer = 
      OAuth::Consumer.new(con_key,con_secret,:site => 'http://twitter.com')
    @access_token = 
      OAuth::AccessToken.new(@consumer,ac_token,ac_token_secret)
  end
end

ここで注意すべきは、「access_token」はAPIにアクセスするたびに使うのでインスタンス変数にしてクラス内のどこからでも使えるようにする事。「consumer」は初期化以外ではプロフィール画像の投稿にしか使いません。

APIへのアクセス

関数の引数で送信する

というわけで、post関数の引数でアクセスする例。

アクセストークン.post("APIのURL","APIのパラメータ"=>"内容")

以下はツィートを投稿するための関数。注意しないといけないのが「タイムアウトはrescueしないとキャッチできない」らしいということ。どこかのサイトでみたんだけどねw

def update(message='')
  return false if (message=='') #メッセージが空じゃないか確認
  begin
    response = @access_token.post('http://twitter.com/statuses/update.json', 'status'=> message)
  rescue Timeout::Error, StandardError #エラーが起きるかもしれないのでrescue
    time = Time.now.strftime("%Y/%m/%d %H:%M:%S")
    puts "#{time}\t[Error:update]\t cannot update message [text]#{message}"
    return false
  end
  #返事の中に送信内容が含まれてれば成功
  retrun_message=JSON.parse(response.body)
  return false  if (retrun_message['text'] != message)
  return true
end

updateのAPIは成功すると送信したメッセージの内容を返してくれるので、返事の中に送信したメッセージが含まれているかどうかで成否を判定しています。

もう一つ注意、「Twitterの制限があるので全く同じ文章を半日以内に送る事は出来ない」らしいので、この関数を試すときは試すたびに文章を変えてね！

「メソッド/パラメータ.format」な方法

たとえばidというメッセージIDをもつツィートをリツィートするには「http://api.twitter.com/1/statuses/retweet/id.format」をPOSTする。この方法ではURLを変更しないといけないのでちょっとめんどい、でもこれでしかアクセスできないAPIもあるっぽい。

#tweet_idをReTweet
def retweet(tweet_id)
  return post_message('statuses/retweet',tweet_id)
end

#POSTのテンプレ
def post_message(method,value)
  response = nil
  #URLを作ります
  url='http://twitter.com/'+method+'/'+"#{value}."+@@format
  begin
    response =  @access_token.post(url)
  rescue Timeout::Error, StandardError
    time = Time.now.strftime("%Y/%m/%d %H:%M:%S")
    puts "#{time}\t[Error:get]\t failed #{url}"
  end
  return response
end

「URL?パラメータ=内容」で渡す例

３つめとして、「URL?パラメータ=内容」でできるAPIもある。ここではタイムラインの取得を行う例。”取得”なのでPOSTではなくGETなとこに注意。
以下のようにすると”メッセージID”以降最新２０件のツィートを持ってくる関数です。

statuses = twitter.get_timeline("since_id=メッセージID")

エラー処理はテンプレと化しているなw

#タイムラインを取得（自分も含む）
#返り値はstatus
def get_timeline(option='')
  return get_message('statuses/friends_timeline',option)
end

#GETのテンプレート
#'http://twitter.com/"method".json'?"option" の値を返す
def get_message(method,option='')
  response = nil
  #URLを作ります
  url='http://twitter.com/'+method+'.'+@@format
  #opstionがあれば付加します
  url = url+'?'+option if(option!='')

  begin
    response = @access_token.get(url)
  rescue Timeout::Error, StandardError
    time = Time.now.strftime("%Y/%m/%d %H:%M:%S")
    puts "#{time}\t[Error:get]\t failed #{url}"
  end
  return response
end
<textarea>

<h2>返り値の中身</h2>
今回はJSONを使っているのでJSONを使ってパースする必要がある訳で。<br>
以下は<a href="http://apiwiki.twitter.com/Twitter-REST-API-Method%3A-statuses-friends_timeline">statuses/friends_timeline</a>の返り値であるところのstatusesの見方。
<br>
<font color="red">注意</font>：TwitterClassは上で作ってたもの、$config[:CONSUMER_KEY]みたいな書き方については後述。
<textarea class="code">
twitter = TwitterClass.new($config[:CONSUMER_KEY],$config[:CONSUMER_SECRET],$config[:ACCESS_TOKEN],$config[:ACCESS_TOKEN_SECRET])
count=0
puts "---- get direct messages ----"
##ダイレクトメッセージを取得
statuses = twitter.get_timeline()

##中身を確認
begin
  if (statuses!=nil) then
    JSON.parse(statuses.body).each do |status|
      count +=1
      posted_user = status['user']
      puts ">> #{status['id']} - #{status['created_at']}"
      puts "\t #{status['text']}"
      puts "\t\t #{posted_user['id']}:#{posted_user['name']}(#{posted_user['screen_name']})"  if(posted_user!=nil)
      puts "\t\t   @#{posted_user['location']}:#{posted_user['url']}" if(posted_user!=nil)
    end
  end
rescue JSON::ParserError
  time = Time.now.strftime("%Y/%m/%d %H:%M:%S")
  puts "#{time}\t[Error:DM] cannot parse json"
end
puts "---- All #{count} messages  ----\n\n"

statuses.bodyにstatusesの中身が入っているのでdoでまわす、JSONでパースしたので中身は連想配列（ハッシュ）になってます。
ここでも一応エラーチェック「JSON::ParserError」、うっかりstatusesの中身が空だったりするとエラーになるので念のため。

プロフィール画像の変更

botに実装できてると楽しいプロフィール画像の変更の方法。とりあえずjpegとpngとgifがアップロード可能、容量制限は700KB以下、どんなに大きな画像を送っても500x500pix以下に縮小されるそうな。

以下はcurlコマンドでやる例、system関数とかで実行すればおけ。

curl -u user:password -H 'Expect:' -F image=@'ファイル名;type=MIMEタイプ' http://api.twitter.com/1/account/update_profile_image.xml

だが待ってほしい、せっかくOAuth認証を使えるようにしてユーザIDやパスワードを不要にしたのにここで直書きとかうざくね？

というわけで@hayesdavisさん作のこのスクリプトを改変してOAuthでやるよ！

ここで俺が勘違いしてたのが、「全部URLで飛ばせば出来る！」と思ってた事、どうやら画像のアップロードはHTTPでヘッダをごにょごにょしつつがんばらないといけないらしい。。。
まずは補助関数の実装。MIMEタイプの識別をする mime_typeとリクエストヘッダをごにょごにょする関数add_multipart_dataは@hayesdavisさんのをコピペ

#画像転送用
def mime_type(file)
  case 
    when file =~ /\.jpg/ then 'image/jpg'
    when file =~ /\.gif$/ then 'image/gif'
    when file =~ /\.png$/ then 'image/png'
    else 'application/octet-stream'
  end
end

#Encodes the request as multipart
def add_multipart_data(req,params)
  crlf = "\r\n"
  boundary = Time.now.to_i.to_s(16)
  req["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
  body = ""
  params.each do |key,value|
  esc_key = CGI.escape(key.to_s)
  body << "--#{boundary}#{crlf}"
  if value.respond_to?(:read)
    body << "Content-Disposition: form-data; name=\"#{esc_key}\"; filename=\"#{File.basename(value.path)}\"#{crlf}"
    body << "Content-Type: #{mime_type(value.path)}#{crlf}#{crlf}"
    body << value.read
  else
    body << "Content-Disposition: form-data; name=\"#{esc_key}\"#{crlf}#{crlf}#{value}"
  end
  body << crlf
  end
  body << "--#{boundary}--#{crlf}#{crlf}"
  req.body = body
  req["Content-Length"] = req.body.size
end

ここからは書き換えが必要、add_oauthはすでにOAuth認証をすましているので産業でおけ、引数もreqだけでいい。ここで使うために「@consumer」にしてあったのです。

def add_oauth(req)
  @consumer.sign!(req,@access_token)
end

あとは実際のアップロード関数。失敗したらnilを、成功するとAPIからの返り値を返します。”ヘッダをごにょごにょ”部分は調べ中なのでまた後日。

#プロフィール画像の変更
#http://gist.github.com/97756
def change_profile_image(filename)
  res=nil
  if (File.exist?(filename)) then
    image_file = File.new(filename)
  else
    time = Time.now.strftime("%Y/%m/%d %H:%M:%S")
    puts "#{time}\t[Error:update]\t #{filename} is not exist"
    return nil
  end
  url = URI.parse('http://twitter.com/account/update_profile_image.json')
  Net::HTTP.new(url.host, url.port).start do |http| 
    req = Net::HTTP::Post.new(url.request_uri)
    add_multipart_data(req,:image=>image_file)
    add_oauth(req)
    res = http.request(req)
  end
  return res.body
end

おまけ：いいかんじの設定ファイル。

$config[:CONSUMER_KEY]について、[m-birdとFreeBSDの同棲日記]rubyで設定ファイルを書くときで学んだほんのり便利な設定ファイルの書き方。

#キーなどを書いておく
@CONSUMER_KEY = 'コンシューマキー'
@CONSUMER_SECRET = 'コンシューマシークレット'
@ACCESS_TOKEN = 'アクセストークン'
@ACCESS_TOKEN_SECRET = 'アクセストークンシークレット'

#http://d.hatena.ne.jp/m-bird/20080513/1210664293
#load 'config.rb',true しといて p $config すると設定が出力できるらしい。
$config = Hash.new
instance_variables.each {|name|
  $config[name[1..-1].to_sym] = instance_variable_get(name)
}

みたいに書いておくと「@xxx」がハッシュに登録されるので便利だねって話。

load 'config.rb',true
p $config

みたいに書いたときにつかえるよ。

{:CONSUMER_SECRET=>"コンシューマシークレット", :ACCESS_TOKEN_SECRET=>"アクセストークンシークレット", :CONSUMER_KEY=>"コンシューマキー",  :ACCESS_TOKEN=>"アクセストークン"}

[0回]

S	M	T	W	T	F	S
	1	2	3	4	5	6
7	8	9	10	11	12	13
14	15	16	17	18	19	20
21	22	23	24	25	26	27
28	29	30

お名前：
URL：		メール：
タイトル：		文字色：
コメント：
パス：