springnote_resources 0.5.1 → 0.6.0

data/History.txt

@@ -1,3 +1,6 @@
+== 0.6.0 / 2008-5-6
+* Support OAuth protocol. Old authententication method will be removed very soon. You should set access_token, access_token_secret, consumer_token, consumer_secret instead of app_key, user_openid, user_key
+
 == 0.5.1 / 2008-4-8
 * protocol configuration added.
 

data/Manifest.txt

@@ -15,5 +15,6 @@ lib/springnote/import_file.rb
 lib/springnote/revision.rb
 lib/exts/active_resource_extension.rb
 lib/exts/common_parameters.rb
+lib/exts/request_with_oauth.rb
 spec/base_spec.rb
 spec/configuration_spec.rb

data/README.korean.txt

@@ -13,6 +13,8 @@
 
 * activesupport
 * activeresource
+* oauth
+* ruby-hmac
 
 == 설치:
 
@@ -20,17 +22,16 @@
 
 == 개발자키와 사용자키 발급 및 설정:
 
-1. 스프링노트 매시업을 작성하기 위해서는 먼저 개발자키가 필요하다. 이 키는 오픈마루 API 센터에서 발급받을 수 있다. 
-자세한 내용은 http://dev.springnote.com/pages/372760 에서 얻을 수 있다.
+1. 스프링노트 매시업을 작성하기 위해서는 먼저 컨슈머 토큰이 필요하다. 이 키는 오픈마루 API 센터(https://api.openmaru.com/oauth/new)에서 발급받을 수 있다. 
+자세한 내용은 http://dev.springnote.com/pages/1083036 에서 얻을 수 있다.
 
-2. 그리고 해당 개발자키에 대한 스프링노트 사용자키를 발급받아야 한다. 이 키 또한 API 센터에서 얻을 수 있다.
-자세한 내용은 http://dev.springnote.com/pages/372761에서 얻을 수 있다.
+2. 그리고 액세스 토큰을 발급받아야 한다.자세한 방법은 OAuth 튜토리얼을 참고하기 바란다. http://myruby.net/pages/1154148
 
 3. 이렇게 받은 키를 스프링노트 리소스에서 사용하려면 아래처럼 설정한다.
 
-Springnote::Base.configuration.set :app_key => '__개발자키__',
-  :user_openid => 'http://user-open-id-url/',
-  :user_key => '__사용자키__'
+Springnote::Base.configuration.set :consumer_token => 'CK', :consumer_secret => 'CS',
+  :access_token => 'AK', :access_secret => 'AS',
+  :domain => 'notename'
 
 == 사용법:
 

data/README.txt

@@ -1,7 +1,7 @@
 = Springnote Resources
 
 * Homepage: http://myruby.net/pages/391111
-* Author: Bryan Kang (http://myruby.net) and Changshin Lee (http://www.iasandcb.pe.kr)
+* Author: deepblue (http://myruby.net) and Changshin Lee (http://www.iasandcb.pe.kr)
 
 == DESCRIPTIONS:
 
@@ -11,6 +11,8 @@ ActiveResource wrapper library for Springnote.com's REST API
 
 * activesupport
 * activeresource
+* oauth
+* ruby-hmac
 
 == INSTALL:
 
@@ -18,19 +20,19 @@ ActiveResource wrapper library for Springnote.com's REST API
 
 == How to get keys
 
-1. You need to register your application on Openmaru API Center and 
-get the application key. Read http://dev.springnote.com/pages/438963 
+1. You need to register your application on Openmaru API Center(https://api.openmaru.com/oauth/new) and 
+get the consumer token. Read http://dev.springnote.com/pages/438963 
 for more details.
 
-2. Now you need to get the user key for the application you registered.
-Read http://dev.springnote.com/pages/438944 for more details.
+2. Now you need to get the access token for the application you registered.
+Read the OAuth tutorial for more details.
 
-3. You have user OpenID, user key, and application key. Configure SpringnoteResources 
-with the information like following code:
+3. You have two tokens. Configure SpringnoteResources with the information 
+like following code:
 
-Springnote::Base.configuration.set :app_key => '__ApplicationKey_Here__',
-  :user_openid => 'http://user-open-id-url/',
-  :user_key => '__UserKey_Here__'
+Springnote::Base.configuration.set :consumer_token => 'CK', :consumer_secret => 'CS',
+  :access_token => 'AK', :access_secret => 'AS',
+  :domain => 'notename'
 
 == USAGE:
 

data/Rakefile

@@ -11,6 +11,7 @@ Hoe.new("springnote_resources", Springnote::VERSION) do |p|
   p.email = 'byblue@gmail.com'
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.need_zip = true
+  p.extra_deps = %w(activeresource ruby-hmac oauth)
 end
 
 task :update_manifest do

data/lib/exts/request_with_oauth.rb

@@ -0,0 +1,35 @@
+module RequestWithOauth
+  def self.included(mod)
+    mod.alias_method_chain :request, :oauth
+    mod.send :cattr_accessor, :oauth_configuration
+  end
+  
+  delegate :oauth_configuration, :to => "self.class"
+    
+  def request_with_oauth(method, path, *arguments)
+    logger.info "#{method.to_s.upcase} #{site.scheme}://#{site.host}:#{site.port}#{path}" if logger
+    result = nil
+    time = Benchmark.realtime { result = http_request(method, path, arguments) }
+    logger.info "--> #{result.code} #{result.message} (#{result.body ? result.body : 0}b %.2fs)" % time if logger
+    handle_response(result)
+  end
+  
+  def http_request(method, path, arguments)
+    # old way
+    return http.send(method, path, *arguments) unless oauth?
+    
+    # new way
+    logger.debug "(request with oauth)" if logger
+    @http = http
+    req = "Net::HTTP::#{method.to_s.capitalize}".constantize.new(path, *arguments)
+    req.oauth! @http, oauth_configuration.consumer, oauth_configuration.token, :signature_method => 'HMAC-SHA1'
+      
+    @http.request(req)
+  end
+  
+  def oauth?
+    oauth_configuration && oauth_configuration.consumer && oauth_configuration.token
+  end
+end
+
+ActiveResource::Connection.send :include, RequestWithOauth

data/lib/springnote/base.rb

@@ -1,5 +1,5 @@
 module Springnote
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
   
   class Base < ActiveResource::Base
     extend ActiveResourceExtension

data/lib/springnote/configuration.rb

@@ -4,18 +4,15 @@ module Springnote
   class MissingConfiguration < RuntimeError; end
   
   class Configuration
-    attr_writer :app_key, :user_key, :user_openid, :protocol
-    attr_reader :domain
+    attr_accessor :consumer_token, :consumer_secret
+    attr_accessor :access_token,   :access_secret
+    attr_accessor :protocol, :domain
     
     SERVER_URL = "api.springnote.com"
     
     def protocol
-      @protocol || 'https'
-    end
-
-    def site
-      "#{protocol}://#{username}:#{password}@#{SERVER_URL}/"
-    end
+      @protocol || 'http'
+    end    
     
     def load(file)
       set YAML.load(File.read(file))
@@ -26,6 +23,28 @@ module Springnote
       Springnote::Base.site = self.site
       self
     end
+        
+    def domain=(name = nil)
+      ActiveResource::Connection.common_params[:domain] = name
+    end
+    
+    def site
+      @app_key ? 
+        "#{protocol}://#{username}:#{password}@#{SERVER_URL}/" :
+        "#{protocol}://#{SERVER_URL}/"
+    end
+    
+    def token
+      @token ||= OAuth::Token.new @access_token, @access_secret if @access_token && @access_secret
+    end
+    
+    def consumer
+      @consumer ||= OAuth::Consumer.new @consumer_token, @consumer_secret, :site => "https://api.openmaru.com" if @consumer_token && @consumer_secret
+    end
+
+    # deprecated
+    attr_writer   :app_key, :user_key
+    attr_writer   :user_openid
     
     def username
       CGI.escape(@user_openid || 'anonymous')
@@ -36,11 +55,7 @@ module Springnote
     end
     
     def app_key
-      @app_key or raise MissingConfiguration
-    end
-    
-    def domain=(name = nil)
-      ActiveResource::Connection.common_params[:domain] = name
-    end
+      @app_key
+    end    
   end
 end # module Springnote

data/lib/springnote_resources.rb

@@ -1,17 +1,21 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'rubygems'
+require 'oauth'
+require 'oauth/consumer'
+
 unless defined?(ActiveResource)
   begin
     $:.unshift(File.dirname(__FILE__) + "/../vendor/activeresource/lib")
     require 'active_resource'  
   rescue LoadError
-    require 'rubygems'
     require 'activeresource'
   end
 end
 
 # extend activeresource
+require 'exts/request_with_oauth'
 require 'exts/common_parameters'
 require 'exts/active_resource_extension'
 
@@ -24,3 +28,5 @@ require 'springnote/page'
 require 'springnote/attachment'
 require 'springnote/lock'
 require 'springnote/revision'
+
+ActiveResource::Connection.oauth_configuration = Springnote::Base.configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: springnote_resources
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors: 
 - Bryan Kang
@@ -9,9 +9,36 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-08 00:00:00 +09:00
+date: 2008-05-06 00:00:00 +09:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-hmac
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   version_requirement: 
@@ -21,7 +48,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.5.1
     version: 
-description: "== DESCRIPTIONS:  ActiveResource wrapper library for Springnote.com's REST API  == REQUIREMENTS:  * activesupport * activeresource"
+description: "== DESCRIPTIONS:  ActiveResource wrapper library for Springnote.com's REST API  == REQUIREMENTS:  * activesupport * activeresource * oauth * ruby-hmac"
 email: byblue@gmail.com
 executables: []
 
@@ -51,6 +78,7 @@ files:
 - lib/springnote/revision.rb
 - lib/exts/active_resource_extension.rb
 - lib/exts/common_parameters.rb
+- lib/exts/request_with_oauth.rb
 - spec/base_spec.rb
 - spec/configuration_spec.rb
 has_rdoc: true
@@ -76,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: springnote
-rubygems_version: 1.0.1
+rubygems_version: 1.1.0
 signing_key: 
 specification_version: 2
 summary: ActiveResource wrapper library for Springnote.com's REST API