two-legged-oauth 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+test/settings.yml
+*.gem
+.bundle
+.rvmrc
+*.iml
+.idea
+Gemfile.lock
+pkg/*

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+* Initial prototype

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in two-legged-oauth.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Fraudpointer
+
+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.md

@@ -0,0 +1,74 @@
+# Two Legged OAuth
+
+* https://github.com/fraudpointer/two-legged-oauth-ruby
+
+## Description
+
+The purpose of this gem is to make the [oauth gem](https://github.com/oauth/oauth-ruby) play nice
+with Google's custom 2 legged OAuth (2LO), used specifically for [Google Apps APIs](http://code.google.com/googleapps/) accessed from [Google Apps Marketplace applications](http://code.google.com/googleapps/marketplace/).
+
+For more info on the 2 legged OAuth see these :
+
+* [Google Apps OAuth](http://code.google.com/apis/accounts/docs/OAuth.html#GoogleAppsOAuth)
+* [2 Legged OAuth in PHP](http://gdatatips.blogspot.com/2008/11/2-legged-oauth-in-php.html)
+* [Google Apps Marketplace Authentication Best Practices](http://code.google.com/googleapps/marketplace/best_practices.html)
+* [Google Data APIs 2 Legged OAuth](http://code.google.com/apis/gdata/docs/auth/oauth.html#2LeggedOAuth)
+
+This gem has been tested with the following libraries so far and seems to be working ok :
+
+* [GoogleContactsApi](https://github.com/aliang/google_contacts_api)
+* [GoogleSpreadsheet](https://github.com/gimite/google-spreadsheet-ruby) (with some [custom fixes](https://github.com/fraudpointer/google-spreadsheet-ruby/tree/two_legged_oauth) that hopefully will get integrated to the official gem)
+* [Google Apps Marketplace Ruby tutorial](http://code.google.com/googleapps/marketplace/tutorial_ruby.html)
+
+## Installation
+
+### Bundler
+
+Add on your Gemfile :
+
+    gem 'two-legged-oauth'
+
+### By hand
+
+On the console :
+
+    gem install two-legged-oauth
+
+On your code :
+
+    require 'two-legged-oauth'
+
+## Usage
+
+Create a normal consumer instance :
+
+    consumer = OAuth::Consumer.new("key", "secret")
+
+Initialize a TwoLeggedAccessToken specifying the xoauth_requestor_id :
+
+    access_token = OAuth::TwoLeggedAccessToken.new(oauth_consumer, "user@domain.com")
+
+Pass that access token to Google Data libraries (or your custom scripts) :
+
+    g = GoogleSpreadsheet.login_with_oauth(access_token)
+
+## Internals
+
+This thing works by rewriting the requested URL on-the-fly and appends the xoauth_requestor_id param appropriately. This may be dangerous at times so be aware that some well hidden bugs may come up...
+
+## Bugs/fixes
+
+...
+
+## Contributing
+
+Tested contributions are always welcome! Here's what you should do:
+
+1. Clone the repo
+2. Run the tests
+3. Write some test-driven code
+4. Create a pull request
+
+# License
+
+two-legged-oauth is copyright 2011 by [Fraudpointer](http://www.fraudpointer.com), released under the MIT License (see LICENSE for details).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/two-legged-oauth.rb

@@ -0,0 +1,6 @@
+require 'oauth'
+require "two-legged-oauth/version"
+require "two-legged-oauth/access_token"
+
+module TwoLeggedOAuth
+end

data/lib/two-legged-oauth/access_token.rb

@@ -0,0 +1,70 @@
+module OAuth
+
+  # The TwoLeggedAccessToken is used for the actual "real" web service calls that you perform
+  # against Google Apps APIs with 2LO (2 legged authentication).
+  # Use this instead of the normal {AccessToken} and it should play out of the box.
+  class TwoLeggedAccessToken < AccessToken
+
+    attr_accessor :xoauth_requestor_id
+
+    # @param consumer [OAuth::Consumer] a properly initialized oauth consumer
+    # @param xoauth_requestor_id [String] usually the email of the user (user@google-apps-domain.com)
+    def initialize(consumer, xoauth_requestor_id)
+      super(consumer)
+      @xoauth_requestor_id = xoauth_requestor_id
+    end
+
+    def request(http_method, path, *arguments)
+      Logger.debug("Original OAuth request path : #{path}")
+      request_uri = URI.parse(path)
+
+      if xoauth_requestor_id
+        xoauth_param = "xoauth_requestor_id=#{xoauth_requestor_id}"
+        escaped_xoauth_param = "xoauth_requestor_id=#{CGI.escape(xoauth_requestor_id)}"
+
+        if request_uri.query.present?
+          request_uri.query.gsub!(xoauth_param, '')
+          request_uri.query.gsub!(escaped_xoauth_param, '')
+        end
+
+        request_uri.query = request_uri.query.present? ?
+            "#{request_uri.query}&#{escaped_xoauth_param}" :
+            "#{escaped_xoauth_param}"
+
+        path = request_uri.to_s
+      end
+
+      Logger.debug("Hacked OAuth request path : #{path}")
+      super(http_method, path, *arguments)
+    end
+
+  end
+
+  # Logger helper
+  class Logger
+
+    @@logger = nil
+
+    class StdLogger
+      def debug(message)
+        puts message
+      end
+    end
+
+    def self.debug(message)
+      logger.debug(message)
+    end
+
+    protected
+
+    def self.logger
+      @@logger ||= if defined? Rails
+                     @@logger = Rails.logger
+                   else
+                     @@logger = StdLogger.new
+                   end
+    end
+
+  end
+
+end

data/lib/two-legged-oauth/version.rb

@@ -0,0 +1,3 @@
+module TwoLeggedOAuth
+  VERSION = "0.0.1"
+end

data/test/access_token_test.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+require 'test/unit'
+require 'two-legged-oauth'
+
+class AccessTokenTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_initialize
+    @access_token = OAuth::TwoLeggedAccessToken.new(consumer, xoauth_requestor_id)
+
+    assert_equal xoauth_requestor_id, @access_token.xoauth_requestor_id
+    assert_equal consumer, @access_token.consumer
+    assert_equal Hash.new, @access_token.params
+    assert_equal "", @access_token.token
+    assert_equal "", @access_token.secret
+  end
+
+  #######
+  private
+  #######
+
+  def consumer
+    @consumer ||= OAuth::Consumer.new(consumer_key, consumer_key_secret)
+  end
+
+  def xoauth_requestor_id
+    @xoauth_requestor_id ||= settings['xoauth_requestor_id']
+  end
+
+  def consumer_key
+    @consumer_key ||= settings['consumer_key']
+  end
+
+  def consumer_key_secret
+    @consumer_key_secret ||= settings['consumer_key_secret']
+  end
+
+  def settings
+    @fixtures ||= YAML.load_file(File.join(File.dirname(__FILE__), 'settings.yml'))
+  end
+
+end

data/test/settings.yml.example

@@ -0,0 +1,5 @@
+# Copy this file to settings.yml and populate with your own working set of data
+# (see the README for more info).
+xoauth_requestor_id: "email@domain.com"
+consumer_key: ""
+consumer_key_secret: ""

data/two-legged-oauth.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "two-legged-oauth/version"
+
+Gem::Specification.new do |s|
+  s.name        = "two-legged-oauth"
+  s.version     = TwoLeggedOAuth::VERSION
+  s.authors     = ["Nikos Dimitrakopoulos"]
+  s.email       = ["n.dimitrakopoulos@fraudpointer.com"]
+  s.homepage    = "https://github.com/fraudpointer/two-legged-oauth-ruby"
+  s.summary     = %q{Support for Google Apps 2 Legged OAuth}
+  s.description = %q{Extends the normal oauth gem to support Google's custom two legged OAuth (2LO) mechanism, needed for interacting with the Google Apps APIs through the Google Apps Marketplace.}
+
+  s.rubyforge_project = "two-legged-oauth"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_dependency("oauth", "~> 0.4.0")
+  s.add_development_dependency("bundler", ">= 1.0.0")
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: two-legged-oauth
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nikos Dimitrakopoulos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-03 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+description: Extends the normal oauth gem to support Google's custom two legged OAuth (2LO) mechanism, needed for interacting with the Google Apps APIs through the Google Apps Marketplace.
+email: 
+- n.dimitrakopoulos@fraudpointer.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/two-legged-oauth.rb
+- lib/two-legged-oauth/access_token.rb
+- lib/two-legged-oauth/version.rb
+- test/access_token_test.rb
+- test/settings.yml.example
+- two-legged-oauth.gemspec
+has_rdoc: true
+homepage: https://github.com/fraudpointer/two-legged-oauth-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: two-legged-oauth
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Support for Google Apps 2 Legged OAuth
+test_files: 
+- test/access_token_test.rb
+- test/settings.yml.example