Integrating Twitter OAuth to your Rails Application
Twitter OAuth是做什麼用的?最簡單來說就是讓使用者可以用他們在Twitter.com上面的帳號來註冊/登入你的網站,而藉由Twitter REST API,第三方網站也可以取得使用者在twitter網站上的Following,Follower,Direct Messages等訊息。它的概念是這樣子的:
Have you ever built an application that needed access to user data from a third-party application like Google Apps, Twitter, Facebook, …?
The easiest way would be to get the Google login and password of your users via a login form on your application. You would then be able to use these credentials to connect to the third-party application and get access to your users data.
The OAuth protocol consists of a sequence of interactions between your application, Google services and the end user.
(以上摘自: http://code.google.com/intl/zh-TW/apis/accounts/docs/OAuth.html)
OAuth協議是現在許多大型網站提供API服務所選擇的認證方式,其目的是為API服務提供一個安全、統一和開放的標準。許多知名的大型網路服務都選擇了OAuth協議,如:Facebook、Twitter、Google和MySpace等;或是採用類似的認證方式。
OAuth網站:http://oauth.net/
Twitter的API在初期使用了Basic Auth認證方式,第三方應用只要把用戶名稱和密碼進行BASE64加密,加入到HTTP的Header中就可以使用訪問受限資源的API。隨著用戶和第三方應用越來越多,把用戶名稱和密碼交給第三方應用的方式漸漸變得不安全和麻煩。最後Twitter的開發團隊決定採用OAuth協議對第三方應用進行授權,用戶可以隨時從設置中取消給第三方的授權,就算修改了密碼也不必為修改授權應用的密碼操心。
Google也是OAuth的支持者,下面我們用Google的OAuth流程圖來了解一下OAuth協議的基本流程。
*首先第三方應用會訪問Google OAuth認證服務,來獲取一個Request Token。
*從Google OAuth認證服務傳回一個未授權的Request Token和對應的Request Token Secret。
*應用程式繼續訪問Google OAuth認證服務,要求對未授權的Request Token進行授權。
*如果用戶已經登入Google,將會被重導至一個要求授權的頁面。
*用戶對第三方應用程式進行授權。
*從Google OAuth認證服務傳回已授權的Request Token和對應的Request Token Secret。
*使用已授權的Request Token和對應的Request Token Secret在Google OAuth服務換取Access Token。
*從Google OAuth認證服務傳回Access Token和對應的Access Token Secret。
*使用Access Token和對應的Access Token Secret訪問Google網路服務,如Calendar。
*從Google網路服務傳回使用者的資料,如用戶的Google Calendar資料。
下面是我實作Integrating Twitter OAuth in Rails App的過程:
1.首先要安裝Oauth Gem套件:
$sudo gem i oauth(我使用的版本是0.4.0)
2.到Twitter頁面註冊你的Rails應用程式:
http://twitter.com/oauth_clients
註冊後會得到一個Consumer Key和Consumer Secret值,這是對映到唯一的應用程式
3.現在到#{RAILS_ROOT}/lib目錄下建立一個twitter_oauth.rb檔案,內容如下:
然後編輯lib/login_system.rb(這是我的Rails App用來處理登入驗證機制的地方),我將callback方法放在這裡,並修改其中的一些登入機制:
4.編輯#{RAILS_ROOT}/config/environment.rb,添加下面內容:
5.建立migration新增資料表欄位:
$ruby script/generate migration AddTwitterOauthToUsers
編輯#{RAILS_ROOT}/db/migrate目錄下新增的遷移檔,新增這些欄位到users資料表中:
然後執行 $rake db:migrate 即可。
之後打開phpMyAdmin,給users資料表建立索引,如下圖:
6.編輯#{RAILS_ROOT}/config/routes.rb內容:
之後我們就可以在視圖中使用twitterOAuth_url來將使用者導向Twitter OAuth認證頁面了!
7.編輯users_controller.rb,新增下面的內容:
然後修改users_controller.rb中的create方法:
8.在app/views./users/new.html.erb視圖中添加Twitter OAuth登入驗證按鈕:
#並修改註冊表單的密碼欄位(若透過Twitter OAuth註冊帳號,則不用填寫密碼欄位,但日後可以設定密碼)
9.編輯app/views/users/show.html.erb以及edit.html.erb視圖,添加Twitter Connection按鈕:
然後修改app/views/users/edit.html.erb視圖中的密碼設定欄位:
10.最後修改User Model中的password_required?方法:
OK~到此為止全部搞定啦!
下面是一些OAuth相關的參考資源
Twitter REST API
http://apiwiki.twitter.com/
API Changes
http://apiwiki.twitter.com/API-Overview
OAuth Examples
http://apiwiki.twitter.com/OAuth-Examples
OAuth Gem
http://github.com/pelle/oauth/tree/master
Rails plugin for OAuth
http://github.com/pelle/oauth-plugin/tree/master
OAuth Library
http://code.google.com/p/oauth/
How the RequestToken api works
http://code.google.com/p/oauth-plugin/wiki/RequestToken
How to turn your rails site into an OAuth Provider
http://stakeventures.com/articles/2007/11/26/how-to-turn-your-rails-site-into-an-oauth-provider
Ruby, OAuth & YouTube
http://runerb.com/2010/01/12/ruby-oauth-youtube/
RESTful OAuth認證全過程
http://blog.myspace.cn/e/400934419.htm
OAuth4 (and OAuth4R)投影片
http://www.slideshare.net/choonkeat/oauth4-and-oauth4r
Facebook OAuth on Rails
http://www.wisejive.com/2010/05/facebook-oauth-on-rails.html
Have you ever built an application that needed access to user data from a third-party application like Google Apps, Twitter, Facebook, …?
The easiest way would be to get the Google login and password of your users via a login form on your application. You would then be able to use these credentials to connect to the third-party application and get access to your users data.
The OAuth protocol consists of a sequence of interactions between your application, Google services and the end user.
(以上摘自: http://code.google.com/intl/zh-TW/apis/accounts/docs/OAuth.html)
OAuth協議是現在許多大型網站提供API服務所選擇的認證方式,其目的是為API服務提供一個安全、統一和開放的標準。許多知名的大型網路服務都選擇了OAuth協議,如:Facebook、Twitter、Google和MySpace等;或是採用類似的認證方式。
OAuth網站:http://oauth.net/
Twitter的API在初期使用了Basic Auth認證方式,第三方應用只要把用戶名稱和密碼進行BASE64加密,加入到HTTP的Header中就可以使用訪問受限資源的API。隨著用戶和第三方應用越來越多,把用戶名稱和密碼交給第三方應用的方式漸漸變得不安全和麻煩。最後Twitter的開發團隊決定採用OAuth協議對第三方應用進行授權,用戶可以隨時從設置中取消給第三方的授權,就算修改了密碼也不必為修改授權應用的密碼操心。
Google也是OAuth的支持者,下面我們用Google的OAuth流程圖來了解一下OAuth協議的基本流程。
*首先第三方應用會訪問Google OAuth認證服務,來獲取一個Request Token。
*從Google OAuth認證服務傳回一個未授權的Request Token和對應的Request Token Secret。
*應用程式繼續訪問Google OAuth認證服務,要求對未授權的Request Token進行授權。
*如果用戶已經登入Google,將會被重導至一個要求授權的頁面。
*用戶對第三方應用程式進行授權。
*從Google OAuth認證服務傳回已授權的Request Token和對應的Request Token Secret。
*使用已授權的Request Token和對應的Request Token Secret在Google OAuth服務換取Access Token。
*從Google OAuth認證服務傳回Access Token和對應的Access Token Secret。
*使用Access Token和對應的Access Token Secret訪問Google網路服務,如Calendar。
*從Google網路服務傳回使用者的資料,如用戶的Google Calendar資料。
下面是我實作Integrating Twitter OAuth in Rails App的過程:
1.首先要安裝Oauth Gem套件:
$sudo gem i oauth(我使用的版本是0.4.0)
2.到Twitter頁面註冊你的Rails應用程式:
http://twitter.com/oauth_clients
註冊後會得到一個Consumer Key和Consumer Secret值,這是對映到唯一的應用程式
3.現在到#{RAILS_ROOT}/lib目錄下建立一個twitter_oauth.rb檔案,內容如下:
然後編輯lib/login_system.rb(這是我的Rails App用來處理登入驗證機制的地方),我將callback方法放在這裡,並修改其中的一些登入機制:
4.編輯#{RAILS_ROOT}/config/environment.rb,添加下面內容:
5.建立migration新增資料表欄位:
$ruby script/generate migration AddTwitterOauthToUsers
編輯#{RAILS_ROOT}/db/migrate目錄下新增的遷移檔,新增這些欄位到users資料表中:
然後執行 $rake db:migrate 即可。
之後打開phpMyAdmin,給users資料表建立索引,如下圖:
6.編輯#{RAILS_ROOT}/config/routes.rb內容:
之後我們就可以在視圖中使用twitterOAuth_url來將使用者導向Twitter OAuth認證頁面了!
7.編輯users_controller.rb,新增下面的內容:
然後修改users_controller.rb中的create方法:
8.在app/views./users/new.html.erb視圖中添加Twitter OAuth登入驗證按鈕:
#並修改註冊表單的密碼欄位(若透過Twitter OAuth註冊帳號,則不用填寫密碼欄位,但日後可以設定密碼)
9.編輯app/views/users/show.html.erb以及edit.html.erb視圖,添加Twitter Connection按鈕:
然後修改app/views/users/edit.html.erb視圖中的密碼設定欄位:
10.最後修改User Model中的password_required?方法:
OK~到此為止全部搞定啦!
下面是一些OAuth相關的參考資源
Twitter REST API
http://apiwiki.twitter.com/
API Changes
http://apiwiki.twitter.com/API-Overview
OAuth Examples
http://apiwiki.twitter.com/OAuth-Examples
OAuth Gem
http://github.com/pelle/oauth/tree/master
Rails plugin for OAuth
http://github.com/pelle/oauth-plugin/tree/master
OAuth Library
http://code.google.com/p/oauth/
How the RequestToken api works
http://code.google.com/p/oauth-plugin/wiki/RequestToken
How to turn your rails site into an OAuth Provider
http://stakeventures.com/articles/2007/11/26/how-to-turn-your-rails-site-into-an-oauth-provider
Ruby, OAuth & YouTube
http://runerb.com/2010/01/12/ruby-oauth-youtube/
RESTful OAuth認證全過程
http://blog.myspace.cn/e/400934419.htm
OAuth4 (and OAuth4R)投影片
http://www.slideshare.net/choonkeat/oauth4-and-oauth4r
Facebook OAuth on Rails
http://www.wisejive.com/2010/05/facebook-oauth-on-rails.html