douban 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+test
+pkg
+.DS_Store

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,53 @@
+Douban
+======
+
+A Ruby wrapper for Douban(豆瓣) API, Rails 3 support only.
+
+Install
+=======
+
+$ gem install douban
+
+Usage
+=======
+
+1. Add below lines to your Gemfile:
+
+gem 'douban', :require => 'oauth'
+require 'douban'
+
+2. Run generator
+
+$ script/rails generate douban
+
+3. Set you api key and secret in config/douban.yml, and include 
+DoubanHelper in your ApplicationController:
+
+class ApplicationController
+  include DoubanHelper
+end
+
+4. Then you can insert below lines into your application layout
+
+<% if douban_authorized? %>
+  <%= link_to 'Logout From Douban', douban_logout_path %>
+<% else %>
+  <%= link_to "Login with douban", douban_login_path %>
+<% end %>
+
+Other available helpers:
+
+* douban_auth_or_login_required, it's useful if you use RESTFUL_AUTH.
+* douban_auth_required, you can add it to before_filter.
+
+5. To access douban resources, you can simple call:
+
+douban.get('/people/ahbei')
+douban.post('/reviews', review)
+
+6. To determine if your have authorized by user, simple call:
+
+douban.authorized?
+=> true  # if your access token is valid.
+
+Feedback are always welcome, Yuanyi Zhang(zhangyuanyi#gmail.com)

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake'
+require 'rake/testtask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "douban"
+    s.summary = "A Ruby wrapper of Douban(豆瓣) API"
+    s.email = "zhangyuanyi@gmail.com"
+    s.homepage = "http://github.com/yzhang/douban"
+    s.description = "A Ruby wrapper of Douban(豆瓣) API"
+    s.authors = ["Yuanyi Zhang"]
+    s.files =  FileList["[A-Z]*", "{lib}/**/*", '.gitignore']
+    s.add_dependency 'oauth'
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/douban.rb

@@ -0,0 +1,118 @@
+require 'oauth'
+
+class Douban
+  attr_accessor :callback, :request_token, :access_token
+  
+  class << self
+    def load(data)
+      access_token        = data[:access_token]
+      access_token_secret = data[:access_token_secret]
+    
+      douban               = Douban.new(data[:request_token], data[:request_token_secret])
+      douban.access_token  = OAuth::AccessToken.new(api_consumer, access_token, access_token_secret) if access_token
+      douban
+    end
+
+    def auth_consumer
+      @@auth_consumer ||= OAuth::Consumer.new(key, secret, {
+          :signature_method   => "HMAC-SHA1",
+          :site               => "http://www.douban.com",
+          :scheme             => :header,
+          :request_token_path => '/service/auth/request_token',
+          :access_token_path  => '/service/auth/access_token',
+          :authorize_path     => '/service/auth/authorize',
+          :realm              => url
+         })
+    end
+  
+    def api_consumer
+      @@api_consumer ||= OAuth::Consumer.new(key, secret,
+        {
+          :site             => "http://api.douban.com",
+          :scheme           => :header,
+          :signature_method => "HMAC-SHA1",
+          :realm            => url
+        })
+    end
+    
+    def key; config['key'];  end
+    def secret; config['secret']; end
+    def url; config['url']; end
+    
+    def config
+      @@config ||= lambda do
+        require 'yaml'
+        filename = "#{Rails.root}/config/douban.yml"
+        file     = File.open(filename)
+        yaml     = YAML.load(file)
+        return yaml[Rails.env]
+      end.call
+    end
+  end
+  
+  def initialize(request_token = nil, request_token_secret = nil)
+    if request_token && request_token_secret
+      self.request_token = OAuth::RequestToken.new(self.class.auth_consumer, request_token, request_token_secret)
+    else
+      self.request_token = self.class.auth_consumer.get_request_token()
+    end
+  end
+  
+  def authorize_url
+    @authorize_url ||= request_token.authorize_url(:oauth_callback => self.callback)
+  end
+  
+  def authorize
+    return unless self.access_token.nil?
+    
+    access_token = self.request_token.get_access_token
+    self.access_token ||= OAuth::AccessToken.new(self.class.api_consumer, access_token.token, access_token.secret)
+  end
+  
+  def authorized?
+    return false if access_token.nil?
+    response = self.get("/access_token/#{access_token.token}")
+    response.code == '200'
+  end
+  
+  def destroy
+    destroy_access_key if !access_token.nil?
+    request_token = access_token = nil
+  end
+
+  def dump
+    {
+      :request_token        => request_token.token, 
+      :request_token_secret => request_token.secret,
+      :access_token         => access_token.nil? ? nil : access_token.token,
+      :access_token_secret  => access_token.nil? ? nil : access_token.secret
+    }
+  end
+  
+  def request(http_method, path, headers = {})
+    access_token.request(http_method, path, headers)
+  end
+    
+  def get(path, headers = {})
+    request(:get, path, headers)
+  end
+  
+  def post(path, headers = {})
+    request(:post, path, headers)
+  end
+    
+  def delete(path, headers = {})
+    request(:delete, path, headers)
+  end
+  
+  def put(path, headers = {})
+    request(:put, path, headers)
+  end
+  
+  protected
+  
+  def destroy_access_key
+    response = delete("/access_token/#{access_token.token}")
+    response.code == '200'
+  end
+end

data/lib/generators/douban/douban_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+
+class DoubanGenerator < Rails::Generators::Base
+  def install_douban
+    copy_file('douban_controller.rb', 'app/controllers/douban_controller.rb')
+    copy_file("douban_helper.rb", 'app/helpers/douban_helper.rb')
+    copy_file("douban.yml", 'config/douban.yml')
+    
+    route %(# Routes for Douban OAuth
+  scope "/douban" do
+    match '/new' => 'douban#new',           :as => :douban_login
+    match '/callback' => 'douban#callback', :as => :douban_callback
+    match '/logout' => 'douban#destroy',    :as => :douban_logout
+  end)
+  end
+  
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+end

data/lib/generators/douban/templates/douban.yml

@@ -0,0 +1,8 @@
+development:
+  key:    "your api key from douban"
+  secret: "secret key"
+  url:    "http://yoursite.com"
+production:
+  key:    "your api key from douban"
+  secret: "secret key"
+  url:    "http://yoursite.com"

data/lib/generators/douban/templates/douban_controller.rb

@@ -0,0 +1,31 @@
+class DoubanController < ApplicationController
+  def new
+    douban = Douban.new
+    douban.callback = douban_callback_url
+    authorize_url = douban.authorize_url
+    
+    respond_to do |wants|
+      session[:back]   = request.env['HTTP_REFERER'] unless request.env['HTTP_REFERER'].blank?
+      session[:douban] = douban.dump
+      wants.html {redirect_to authorize_url}
+    end
+  end
+  
+  def callback
+    if session[:douban]
+      douban = Douban.load(session[:douban])
+      douban.authorize
+      session[:douban] = douban.dump
+    end
+    
+    redirect_to(session[:back] || '/')
+    session[:back] = nil
+  end
+  
+  def destroy
+    return unless douban_authorized?
+    session[:douban] = nil
+    douban.destroy
+    redirect_to '/'
+  end
+end

data/lib/generators/douban/templates/douban_helper.rb

@@ -0,0 +1,21 @@
+module DoubanHelper
+  def douban
+    @douban ||= (session[:douban] && session[:douban][:access_token]) ? Douban.load(session[:douban]) : nil
+  end
+  
+  def douban_authorized?
+    !douban.nil?
+  end
+  
+  def douban_auth_required
+    douban_authorized? || redirect_to(douban_auth_path)
+  end
+  
+  def douban_auth_or_login_required
+    douban_authorized? || login_required
+  end
+  
+  def self.included(base)
+    base.send :helper_method, :douban_authorized? if base.respond_to? :helper_method
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: douban
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Yuanyi Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-07 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: "A Ruby wrapper of Douban(\xE8\xB1\x86\xE7\x93\xA3) API"
+email: zhangyuanyi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/douban.rb
+- lib/generators/douban/douban_generator.rb
+- lib/generators/douban/templates/douban.yml
+- lib/generators/douban/templates/douban_controller.rb
+- lib/generators/douban/templates/douban_helper.rb
+has_rdoc: true
+homepage: http://github.com/yzhang/douban
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: "A Ruby wrapper of Douban(\xE8\xB1\x86\xE7\x93\xA3) API"
+test_files: []
+