em-http-oauth-request 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-12-09
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/em-http-oauth-request.rb
+script/console
+script/destroy
+script/generate
+test/test_em-http-oauth-request.rb
+test/test_helper.rb

data/README.rdoc

@@ -0,0 +1,67 @@
+= em-http-oauth-request
+
+== Description
+
+Allows you to issue requests with the OAuth gem using em-http-request.
+
+The benefit to this is that you can issue asynchronous non-blocking OAuth requests.
+
+== Installation
+
+  sudo gem install em-http-oauth-request
+
+== Example
+
+    require 'rubygems'
+    require 'oauth'
+    require 'em-http-oauth-request'
+
+    EventMachine.run {
+      consumer = OAuth::Consumer.new('consumer-token', 'consumer-secret', :site => 'http://twitter.com')
+      atoken = 'access-token'
+      asecret = 'access-secret'
+      access_token = OAuth::AccessToken.new(consumer, atoken, asecret)
+  
+      oauth_params = {:consumer => consumer, :token => access_token}
+      req = EventMachine::HttpRequest.new('http://api.twitter.com/1/statuses/home_timeline.json').get
+      oauth_helper = OAuth::Client::Helper.new(req, oauth_params)
+  
+      req.options[:head] = (req.options[:head] || {}).merge!({"Authorization " => [oauth_helper.header]})
+      req.callback {
+        p req.response
+
+        EventMachine.stop
+      }
+    }
+
+
+== Issues
+
+There's currently an issue with em-http-request in which values of 'Authorization' headers are automatically Base64 encoded.  While this is correct for Basic HTTP Authentication, it breaks OAuth requests, which require a number of parameters in the 'Authorization' header.
+
+For the time being, a simple workaround is to add whitespace to the header (for example, 'Authorization ' in the example above).  This works for Twitter's OAuth API, although it may not work for all OAuth providers.
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 Draconis Software, LLC
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/em-http-oauth-request'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'em-http-oauth-request' do
+  self.developer 'Draconis Software', 'info@draconis.com'
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['oauth','>= 0.3.6'], ['em-http-request', '>= 0.2.4']]
+  self.summary = 'Allows em-http-request to be used for OAuth requests.'
+  self.url = 'http://github.com/draconis/em-http-oauth-request'
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/em-http-oauth-request.rb

@@ -0,0 +1,79 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module EmHttpOauthRequest
+  VERSION = '0.0.1'
+end
+
+require 'oauth'
+require 'em-http'
+
+module OAuth::RequestProxy::EventMachine
+  class Client < OAuth::RequestProxy::Base
+    # Proxy for signing Typhoeus::Request requests
+    # Usage example:
+    # EventMachine.run {
+    #   oauth_params = {:consumer => oauth_consumer, :token => access_token}
+    #   req = EventMachine::HttpRequest.new(uri).get(options)
+    #   oauth_helper = OAuth::Client::Helper.new(req, oauth_params)
+    #   req.options[:head] = (req.options[:head] || {}).merge!({"Authorization " => [oauth_helper.header]})
+    #   req.callback {
+    #     p req.response
+    # 
+    #     EventMachine.stop
+    #   }
+    # }
+    #
+    # NOTE: currently, em-http-request automatically base64 encodes the 'Authorization' header, which
+    # breaks OAuth.  It appears that making the key of the header 'Authorization ' (note the space)
+    # fixes this for the time being.
+    proxies ::EventMachine::HttpClient
+    
+    def method
+      request.method
+    end
+    
+    def uri
+      request.uri.to_s
+    end
+    
+    def parameters
+      if options[:clobber_request]
+        options[:parameters]
+      else
+        all_parameters
+      end
+    end
+
+  private
+
+    def all_parameters
+      request_params = {}
+      params = post_parameters.merge(query_parameters).merge(options[:parameters] || {})
+      if params
+        params.each do |k,v|
+          if request_params.has_key?(k)
+            request_params[k] << v
+          else
+            request_params[k] = [v].flatten
+          end
+        end
+      end
+      request_params
+    end
+
+    def query_parameters
+      request.options[:query] || {}
+    end
+
+    def post_parameters
+      # Post params are only used if posting form data
+      headers = request.options[:head] || {}
+      if((method == 'POST' || method == 'PUT') && headers['Content-Type'] && headers['Content-Type'].downcase == 'application/x-www-form-urlencoded')
+        request.options[:body] || {}
+      else
+        {}
+      end
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/em-http-oauth-request.rb'}"
+puts "Loading em-http-oauth-request gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_em-http-oauth-request.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestEmHttpOauthRequest < Test::Unit::TestCase
+  def test_that_proxy_simple_get_request_works
+    EventMachine.run {
+      request = ::EventMachine::HttpRequest.new('http://example.com/test').get :query => {'key' => 'value'}
+
+      request_proxy = OAuth::RequestProxy.proxy(request)
+
+      expected_parameters = {'key' => ['value']}
+      assert_equal expected_parameters, request_proxy.parameters_for_signature
+      assert_equal 'http://example.com/test', request_proxy.normalized_uri
+      assert_equal 'GET', request_proxy.method
+      
+      EventMachine.stop
+    }
+  end
+
+  def test_that_proxy_simple_post_request_works_with_arguments
+    EventMachine.run {
+      request = ::EventMachine::HttpRequest.new('http://example.com/test').post
+      params = {'key' => 'value'}
+      request_proxy = OAuth::RequestProxy.proxy(request, {:parameters => params})
+
+      expected_parameters = {'key' => ['value']}
+      assert_equal expected_parameters, request_proxy.parameters_for_signature
+      assert_equal 'http://example.com/test', request_proxy.normalized_uri
+      assert_equal 'POST', request_proxy.method
+      
+      EventMachine.stop
+    }
+  end
+  
+  def test_that_proxy_simple_post_request_works_with_form_data
+    EventMachine.run {
+      request = ::EventMachine::HttpRequest.new('http://example.com/test').post :body => {'key' => 'value'},
+        :head => {'Content-Type' => 'application/x-www-form-urlencoded'}
+      request_proxy = OAuth::RequestProxy.proxy(request)
+
+      expected_parameters = {'key' => ['value']}
+      assert_equal expected_parameters, request_proxy.parameters_for_signature
+      assert_equal 'http://example.com/test', request_proxy.normalized_uri
+      assert_equal 'POST', request_proxy.method
+      
+      EventMachine.stop
+    }
+  end
+  
+  def test_that_proxy_simple_put_request_works_with_arguments
+    EventMachine.run {
+      request = ::EventMachine::HttpRequest.new('http://example.com/test').put
+      params = {'key' => 'value'}
+      request_proxy = OAuth::RequestProxy.proxy(request, {:parameters => params})
+
+      expected_parameters = {'key' => ['value']}
+      assert_equal expected_parameters, request_proxy.parameters_for_signature
+      assert_equal 'http://example.com/test', request_proxy.normalized_uri
+      assert_equal 'PUT', request_proxy.method
+      
+      EventMachine.stop
+    }
+  end
+  
+  def test_that_proxy_simple_put_request_works_with_form_data
+    EventMachine.run {
+      request = ::EventMachine::HttpRequest.new('http://example.com/test').put :body => {'key' => 'value'},
+        :head => {'Content-Type' => 'application/x-www-form-urlencoded'}
+      request_proxy = OAuth::RequestProxy.proxy(request)
+
+      expected_parameters = {'key' => ['value']}
+      assert_equal expected_parameters, request_proxy.parameters_for_signature
+      assert_equal 'http://example.com/test', request_proxy.normalized_uri
+      assert_equal 'PUT', request_proxy.method
+      
+      EventMachine.stop
+    }
+  end
+  
+  def test_that_proxy_post_request_works_with_mixed_parameter_sources
+    EventMachine.run {
+      request = ::EventMachine::HttpRequest.new('http://example.com/test').post :query => {'key' => 'value'}, :body => {'key2' => 'value2'},
+        :head => {'Content-Type' => 'application/x-www-form-urlencoded'}
+      request_proxy = OAuth::RequestProxy.proxy(request, :parameters => {'key3' => 'value3'})
+
+      expected_parameters = {'key' => ['value'], 'key2' => ['value2'], 'key3' => ['value3']}
+      assert_equal expected_parameters, request_proxy.parameters_for_signature
+      assert_equal 'http://example.com/test', request_proxy.normalized_uri
+      assert_equal 'POST', request_proxy.method
+      
+      EventMachine.stop
+    }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/em-http-oauth-request'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: em-http-oauth-request
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Draconis Software
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.4.0
+    version: 
+description: |-
+  Allows you to issue requests with the OAuth gem using em-http-request.
+  
+  The benefit to this is that you can issue asynchronous non-blocking OAuth requests.
+email: 
+- info@draconis.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/em-http-oauth-request.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_em-http-oauth-request.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/draconis/em-http-oauth-request
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: em-http-oauth-request
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Allows em-http-request to be used for OAuth requests.
+test_files: 
+- test/test_em-http-oauth-request.rb
+- test/test_helper.rb