ゼロから学ぶOAuth

第2回 OAuth Consumerの実装(入門 : OAuth Access Tokenの取得と利用)

この記事を読むのに必要な時間:およそ 4 分

OAuth Consumerサンプルを動かす

第1回では実際にOAuthを利用したサービスを触り,ユーザから見たOAuthを理解しました。またOAuthの大まかな処理フローについても触れました。

第2回と第3回では,OAuth Consumerの実装を通じてより深くOAuthを理解します。とは言っても,ゼロからアプリケーションを実装していくのには限界があるので,ここではあらかじめ(Ruby on Railsで)実装したサンプルアプリケーションを使います。なお,ConsumerとService Providerの実装は,すべてrailsを用いて行います。

Ruby on Railsの構築に関しては,技術評論社WEB+DB PRESSRubyist Magazineの記事などをご覧ください。

まずはgithubに公開されているoauth_sampleを動かしてみてください。gitをお使いの方は以下のコマンドで。gitをお使いでない方は,oauth_sampleからzipかtar形式でダウンロードしてください。

git clone git://github.com/nov/oauth_sample.git

その後railsアプリを起動します。筆者のMacBook上では以下で問題なく起動しますが,皆さんの環境でもそうであることを祈ります(サンプルが動かない場合は,githubのwikiページにあるコメント欄へコメントください)。

gem install sqlite3-ruby
gem install oauth
cd oauth_sample/oauth_consumer
mkdir log
rake db:migrate
./script/server

http://localhost:3000にアクセスし,適当なユーザ名でログインすると,dashboardが表示されます。

smart.fmにOAuth Consumer登録

サンプルアプリケーションのdashboardには「new consumer」「new access token」というリンクが存在しますが,Access Tokenの取得にはConsumerの情報が必要なので,最初は「new consumer」からConsumer情報を登録します。

図1 Consumer情報の登録

図1 Consumer情報の登録

このアプリは,デフォルトの状態ではsmart.fmとGoogleの2つのOAuth Service Providerに対応しています。もちろんどちらも利用できますが,GoogleでのOAuth Consumer登録にはドメイン認証などが必要なので,ここではsmart.fmでConsumer登録を行います。smart.fmのConsumer登録はsmart.fm OAuth Client Applicationsから行えます。

図2 smart.fm OAuth Client Applications

図2 smart.fm OAuth Client Applications

今回のアプリケーションを利用する場合,登録フォームには以下のURLを入れてください。

  • Main Application URL : http://localhost:3000
  • Callback URL : http://localhost:3000/oauth/smartfm/callback

登録後,得られたConsumer KeyとConsumer SecretをサンプルアプリケーションのConsumer登録フォームに入力します。またsmart.fm APIではConsumer Keyとは別にAPI Keyも必要ですので,smart.fm API 日本語ガイド「APIデベロッパアカウントの登録」からAPI Keyを取得し,そちらもサンプルアプリケーションのConsumer登録フォームに入力して,registerをクリックします。(Scopeは空白で結構です)これでOAuth Consumerの登録は完了です。

著者プロフィール

真武信和(またけのぶかず)

Cerego Japan Inc.で働くWebエンジニア。

smart.fmで外部APIとの連携機能(OAuth Consumer)の開発に携わるほか、smart.fm API(OAuth Service Provider)の開発にも携わっている。

URL:
http://matake.jp/
http://smart.fm/users/matake

コメント

  • 不必要なアクセス

    oauth_access_tokens_controller.rb の37行目から、

    --
    def authorize_url
    if request_token.callback_confirmed?
    # Serveice Provider is supporting OAuth 1.0a
    request_token.authorize_url
    else
    request_token.authorize_url + "&oauth_callback=#{callback_url}"
    end
    end
    --

    となっていますが、これではrequest_tokenを取得するために2度Service Providerへアクセスすることになります。
    正しくは、

    --
    def authorize_url
    token = request_token
    if token.callback_confirmed?
    # Serveice Provider is supporting OAuth 1.0a
    token.authorize_url
    else
    token.authorize_url + "&oauth_callback=#{callback_url}"
    end
    end
    --

    ではないでしょうか?(分かりにくいので変数名も変えました)

    Commented : #2  はらい (2010/12/09, 11:52)

  • Windowsでrake aborted!となる場合

    Windowsで動作させる場合、

    > rake db:migrate

    のステップで

    --
    rake aborted!
    no such file to load -- sqlite3/sqlite3_native
    --

    というエラーが出てしまうときは、

    http://blog.mmediasys.com/2009/07/06/getting-started-with-rails-and-sqlite3/

    を参考にしてsqlite3.dllをRubyのbinディレクトリに置く必要があるようです。

    Commented : #1  はらい (2010/12/08, 07:02)

コメントの記入