更新日: 2014年3月11日
Ruby

Flickr API で Ruby + flickraw を使い画像検索

Flickr の API を用いて、タグで画像を検索する Ruby コードを書きました。調べたら flickraw という便利な gem を発見したので、これを利用します。

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

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

flickraw をインストール


$ gem install flickraw

$ gem install flickraw

または、


$ vi Gemfile
gem "flickraw"
$ bundle install

$ vi Gemfile

gem "flickraw"

$ bundle install

hanklords/flickraw
flickraw RDoc Documentation

Flickr の API キーを取得

Flickr にログインし、Flickr Services からAPIキーを取得します。詳しくは以下を参照。

Flickr APIを使ってみよう(1.APIキーの取得) | Tech Booster

Flickr API はドキュメントが充実しています（英語ですが）。それと各々APIエンドポイントに対して、パラメータを組み立ててリクエストを試し、レスポンスを確認できるツールが用意してあります。

今回利用した flickr.photos.search の API ドキュメント。
Flickr Services: Flickr API: flickr.photos.search

レスポンスを確認するツール。
Flickr Api Explorer – flickr.photos.search

flickraw を使った Ruby コード（Ruby 2.0.0）

では、Flickr API を叩いて、タグで絞り込み検索して画像を取得する Ruby コード。API key, API secret の部分は取得したものに変更します。

require "flickraw"

FlickRaw.api_key = "API key"
FlickRaw.shared_secret = "API secret"

def get_flickr_images(tag)
  thumbnail_size = "m"
  original_size = "z"

  images = flickr.photos.search(tags: tag, sort: "relevance", per_page: 20)  

  flickr_images = []
  images.each do |image|
    flickr_images << FlickrImage.new(
      id: image["id"],
      title: image["title"],
      description: "",
      link_url: "http://www.flickr.com/photos/#{image["owner"]}/#{image["id"]}",
      thumbnail_url: "http://farm#{image["farm"]}.static.flickr.com/#{image["server"]}/#{image["id"]}_#{image["secret"]}_#{thumbnail_size}.jpg",
      original_url: "http://farm#{image["farm"]}.static.flickr.com/#{image["server"]}/#{image["id"]}_#{image["secret"]}_#{original_size}.jpg"
    )
  end

  flickr_images
end

class FlickrImage
  def initialize(id:nil, title:nil, description:nil, link_url:nil, thumbnail_url:nil, original_url:nil)
    @id = id
    @title = title
    @description = description
    @link_url = link_url
    @thumbnail_url = thumbnail_url
    @original_url = original_url
  end

  attr_accessor :id, :title, :description, :link_url, :thumbnail_url, :original_url
end

get_flickr_images("mountain").each do |image|
  puts image.title
  puts image.link_url
end

require "flickraw"

FlickRaw.api_key = "API key"

FlickRaw.shared_secret = "API secret"

def get_flickr_images(tag)

thumbnail_size = "m"

original_size = "z"

images = flickr.photos.search(tags: tag, sort: "relevance", per_page: 20)

flickr_images = []

images.each do |image|

flickr_images << FlickrImage.new(

id: image["id"],

title: image["title"],

description: "",

link_url: "http://www.flickr.com/photos/#{image["owner"]}/#{image["id"]}",

thumbnail_url: "http://farm#{image["farm"]}.static.flickr.com/#{image["server"]}/#{image["id"]}_#{image["secret"]}_#{thumbnail_size}.jpg",

original_url: "http://farm#{image["farm"]}.static.flickr.com/#{image["server"]}/#{image["id"]}_#{image["secret"]}_#{original_size}.jpg"

)

end

flickr_images

end

class FlickrImage

def initialize(id:nil, title:nil, description:nil, link_url:nil, thumbnail_url:nil, original_url:nil)

@id = id

@title = title

@description = description

@link_url = link_url

@thumbnail_url = thumbnail_url

@original_url = original_url

end

attr_accessor :id, :title, :description, :link_url, :thumbnail_url, :original_url

end

get_flickr_images("mountain").each do |image|

puts image.title

puts image.link_url

end

キーワード引数を使っているので、Ruby2.0.0以上で動作させる必要があります。get_flickr_images メソッドにタグ（この例では mountain ）を引数で渡して呼び出すと、FlickrImage のインスタンスの配列を返します。関連性でソートし（sort: “relevance”）、20件取得しています（per_page: 20）。

今回は単純にタグで画像を検索して画像情報を取得するだけのコードを書きましたが、他にも画像のアップロードや OAuth 認証など、Flickr はかなり API が充実している印象です。使い方次第で便利なツールが作れそう。自動で手元の写真をどんどん Flickr にアップロードするツールとか。

flickr の画像URLの仕様については、エントリー末尾の参考リンクがとても分かりやすかったです。FlickrImage#thumbnail_url, FlickrImage#original_url の URL。