google_auth_bridge 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg
+Gemfile.lock
+spec/reports
+.bundle
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google_auth_bridge.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 ssatish
+
+MIT License
+
+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,54 @@
+Google Authentication Bridge
+============================
+
+Google allow you to authenticate with their APIs with OAuth. That process can be a little tedious if you have to
+do it over and over. Google Authentication Bridge allows you to authenticate with Google and will store the refresh
+token in a file for subsequent use.
+
+Usage
+=====
+
+With Google Drive https://github.com/gimite/google-drive-ruby
+
+    auth = GoogleAuthenticationBridge::GoogleAuthentication.new(
+      "https://docs.google.com/feeds/ https://docs.googleusercontent.com/ https://spreadsheets.google.com/feeds/",
+      "client-id",
+      "client-secret",
+      "/path/to/token-file.yml"
+    )
+    # first time to create the refresh token
+    token = auth.get_oauth2_access_token("auth-code")
+    # subsequent times using the refresh token
+    token = auth.get_oauth2_access_token
+    session = GoogleDrive.login_with_oauth(token)
+
+With Google API Client http://code.google.com/p/google-api-ruby-client/
+
+    auth = GoogleAuthenticationBridge::GoogleAuthentication.new(
+      "https://www.googleapis.com/auth/analytics.readonly",
+      "client-id",
+      "client-secret",
+      "/path/to/token-file.yml"
+    )
+    # first time to create the refresh token
+    token = auth.get_tokens("auth-code")
+    # subsequent times using the refresh token
+    token = auth.get_tokens
+
+    client = Google::APIClient.new
+    client.update_token!(token)
+
+Rather than providing the credentials directly you can build the authentication object from a YAML configuration
+file.
+
+    auth = GoogleAuthenticationBridge::GoogleAuthentication.create_from_config_file(
+      "scope",
+      "/path/to/credentials.yml",
+      "/path/to/token-file.yml"
+    )
+
+The credentials file should contain the client id and the client secret.
+
+    ---
+    google_client_id: "client id"
+    google_client_secret: "client secret"

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "gem_publisher"
+require "ci/reporter/rake/rspec"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end
+
+desc "Publish gem to RubyGems.org"
+task :publish_gem do |t|
+  gem = GemPublisher.publish_if_updated("google_auth_bridge.gemspec", :rubygems)
+  puts "Published #{gem}" if gem
+end

data/google_auth_bridge.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/google_auth_bridge/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = %w(ssatish)
+  gem.email = %w(seema.satish@digital.cabinet-office.gov.uk)
+  gem.description   = "bridge for supporting multiple google authentication libraries" 
+  gem.summary       = "bridge for supporting multiple google authentication libraries"  
+  gem.homepage      = "https://github.com/alphagov/google-auth-bridge"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "google_auth_bridge"
+  gem.require_paths = %w(lib)
+  gem.version = GoogleAuthenticationBridge::VERSION
+
+  gem.add_dependency('oauth2')
+  gem.add_dependency('google-api-client')
+
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("rspec")
+  gem.add_development_dependency("ci_reporter")
+  gem.add_development_dependency("gem_publisher", "~> 1.1.1")
+
+end

data/jenkins.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -e
+
+bundle install --path "${HOME}/bundles/${JOB_NAME}"
+bundle exec rake ci:setup:rspec spec --trace
+bundle exec rake publish_gem

data/lib/google_auth_bridge.rb

@@ -0,0 +1,110 @@
+require "oauth2"
+require "google/api_client"
+
+module GoogleAuthenticationBridge
+  class GoogleAuthentication
+    GOOGLE_REDIRECT_URI = 'urn:ietf:wg:oauth:2.0:oob'
+
+    def self.create_from_config_file(scope, file_name, token_file)
+      config = YAML.load_file(file_name)
+      GoogleAuthentication.new(
+          scope,
+          config["google_client_id"],
+          config["google_client_secret"],
+          token_file)
+    end
+
+    def initialize(scope, client_id, client_secret, token_file)
+      @scope = scope
+      @client_id = client_id
+      @client_secret = client_secret
+      @token_file = token_file
+    end
+
+    def get_tokens(authorization_code=nil)
+      client = Google::APIClient.new
+      setup_credentials(client, authorization_code)
+      refresh_tokens(client)
+    end
+
+    def get_oauth2_access_token(authorization_code=nil)
+      OAuth2::AccessToken.from_hash(get_oauth2_client, get_tokens(authorization_code))
+    end
+
+    def get_auth_url
+      "https://accounts.google.com/o/oauth2/auth?response_type=code&scope=#{URI::encode(@scope)}&redirect_uri=#{GOOGLE_REDIRECT_URI}&client_id=#{URI::encode(@client_id)}"
+    end
+
+    def load_token_from_file
+      raise FileNotFoundError.new(@token_file) unless File.exists? @token_file
+
+      begin
+        token_data = YAML.load_file(@token_file)
+        token = token_data[:refresh_token]
+
+        raise InvalidFileFormatError.new(@token_file) unless token
+        token
+      rescue
+        raise InvalidFileFormatError.new(@token_file)
+      end
+    end
+
+    def save_token_to_file(refresh_token)
+      raise InvalidTokenError.new(refresh_token) if refresh_token.nil?
+      File.open(@token_file, 'w') { |f|
+        f.write(YAML.dump({:refresh_token => refresh_token}))
+      }
+    end
+
+    private
+    def get_oauth2_client
+      OAuth2::Client.new(@client_id, @client_secret,
+                         site: "https://accounts.google.com",
+                         token_url: "/o/oauth2/token",
+                         authorize_url: "/o/oauth2/auth"
+      )
+    end
+
+    def setup_credentials(client, code)
+      authorization = client.authorization
+      authorization.client_id = @client_id
+      authorization.client_secret = @client_secret
+      authorization.scope = @scope
+      authorization.redirect_uri = GOOGLE_REDIRECT_URI
+      authorization.code = code
+    end
+
+    def refresh_tokens(client)
+      if File.exist? @token_file
+        client.authorization.update_token!(refresh_token: load_token_from_file)
+        tokens = client.authorization.fetch_access_token
+      else
+        tokens = client.authorization.fetch_access_token
+        save_token_to_file(tokens["refresh_token"])
+      end
+      tokens
+    end
+
+  end
+
+  class Error < Exception
+  end
+
+  class FileNotFoundError < Error
+    def initialize filename
+      super "File not found #{filename}"
+    end
+  end
+
+  class InvalidFileFormatError < Error
+    def initialize filename
+      super "Invalid token file format in '#{filename}'."
+    end
+  end
+
+  class InvalidTokenError < Error
+    def initialize token
+      super "Invalid token '#{token.inspect}'."
+    end
+  end
+end

data/lib/google_auth_bridge/version.rb

@@ -0,0 +1,3 @@
+module GoogleAuthenticationBridge
+  VERSION = "0.1.0"
+end

data/spec/google_auth_bridge_spec.rb

@@ -0,0 +1,54 @@
+require_relative "../lib/google_auth_bridge"
+require "tempfile"
+
+describe "Google Authentication Client" do
+  before(:each) do
+    @filename = "/tmp/test.token"
+    @auth = GoogleAuthenticationBridge::GoogleAuthentication.new(nil, nil, nil, @filename)
+    @yaml_content = "---\n:refresh_token: foo bar\n"
+    @yaml_pattern = /---\s?\n:refresh_token: foo bar\n/
+  end
+
+  after(:each) do
+    File.delete(@filename) if File.exists? @filename
+  end
+
+  it "should save refresh token to file as yaml" do
+    File.exists?(@filename).should be_false
+    @auth.save_token_to_file("foo bar")
+    File.exists?(@filename).should be_true
+    File.read(@filename).should match(@yaml_pattern)
+  end
+
+  it "should raise an InvalidTokenError exception if the refresh token is nil" do
+    lambda {
+      @auth.save_token_to_file(nil)
+    }.should raise_error(GoogleAuthenticationBridge::InvalidTokenError)
+  end
+
+  it "should load refresh token from yaml file" do
+    File.open(@filename, 'w') {|f| f.write(@yaml_content) }
+    @auth.load_token_from_file.should == "foo bar"
+  end
+
+  it "should raise a FileNotFoundError exception if the file is not there" do
+    lambda {
+      @auth.load_token_from_file
+    }.should raise_error(GoogleAuthenticationBridge::FileNotFoundError)
+  end
+
+  it "should raise an InvalidFileFormatError exception if the file is badly formatted" do
+    File.open(@filename, 'w') {|f| f.write("bad content") }
+    lambda {
+      @auth.load_token_from_file
+    }.should raise_error(GoogleAuthenticationBridge::InvalidFileFormatError)
+  end
+
+
+  it "should raise an InvalidFileFormatError exception if the file does not contain refresh token" do
+    File.open(@filename, 'w') {|f| f.write("---\n:refresh_token: \n") }
+    lambda {
+      @auth.load_token_from_file
+    }.should raise_error(GoogleAuthenticationBridge::InvalidFileFormatError)
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: google_auth_bridge
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- ssatish
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth2
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: google-api-client
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ci_reporter
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: gem_publisher
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: bridge for supporting multiple google authentication libraries
+email: 
+- seema.satish@digital.cabinet-office.gov.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- google_auth_bridge.gemspec
+- jenkins.sh
+- lib/google_auth_bridge.rb
+- lib/google_auth_bridge/version.rb
+- spec/google_auth_bridge_spec.rb
+homepage: https://github.com/alphagov/google-auth-bridge
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2931254444280982549
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2931254444280982549
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: bridge for supporting multiple google authentication libraries
+test_files: 
+- spec/google_auth_bridge_spec.rb