signet-rails 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Jolly
+
+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,37 @@
+# Signet::Rails
+
+A basic Rails wrapper around the "Signet":https://github.com/google/signet gem
+
+Work in progress
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'signet-rails'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install signet-rails
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/signet/rails/builder.rb

@@ -0,0 +1,74 @@
+require 'signet/rails'
+require 'signet/rails/wrappers/active_record'
+
+module Signet
+  module Rails
+    class Builder < ::Rack::Builder
+      @@default_options = {}
+
+      def self.set_default_options opts = {}
+	# normalize to symbol version
+	n_opts = opts.inject({}) { |memo,(k,v)| memo[k.to_sym] = v; memo }
+	@@default_options = n_opts
+      end
+
+      def initialize(app, &block)
+	super
+      end
+
+      def provider(opts = {}, &block)
+	# normalize to symbol version
+	n_opts = opts.inject({}) { |memo,(k,v)| memo[k.to_sym] = v; memo }
+	combined_options = @@default_options.merge(n_opts)
+
+	# now set some defaults if they aren't already set
+	combined_options[:persist] ||= [:refresh_token, :access_token, :expires_in, :issued_at]
+	combined_options[:name] ||= :google
+	combined_options[:approval_prompt] ||= 'auto'
+	combined_options[:redirect_uri] = "http://localhost:3000/signet/#{combined_options[:name]}/callback"
+	combined_options[:authorization_uri] = 'https://accounts.google.com/o/oauth2/auth'
+	combined_options[:token_credential_uri] = 'https://accounts.google.com/o/oauth2/token'
+	combined_options[:extract_from_env] ||= lambda do |env, client|
+	  u = nil
+	  session = env['rack.session']
+	  if !!session && !!session[:user_id]
+	    begin
+	      u = User.find(session[:user_id])
+	    rescue ActiveRecord::RecordNotFound => e
+	    end
+	  end
+	  u
+	end
+	combined_options[:handle_callback] ||= true
+	combined_options[:extract_by_oauth_id] ||= lambda do |id, client|
+	  u = nil
+	  begin
+	    u = User.where(uid: id).first_or_initialize(
+	      refresh_token: client.refresh_token
+	    )
+	  rescue ActiveRecord::RecordNotFound => e
+	  end
+	  u
+	end
+
+	def active_record_wrapper meth
+	  lambda do |context, client|
+	    y = meth.call context, client
+	    w = Signet::Rails::Wrappers::ActiveRecord.new y, client
+	  end
+	end
+
+	combined_options[:extract_by_oauth_id] = active_record_wrapper combined_options[:extract_by_oauth_id]
+	combined_options[:extract_from_env] = active_record_wrapper combined_options[:extract_from_env]
+
+	# TODO: check here we have the basics?
+
+	use Signet::Rails::Handler, combined_options, &block
+      end
+
+      def call(env)
+	to_app.call(env)
+      end
+    end
+  end
+end

data/lib/signet/rails/factory.rb

@@ -0,0 +1,25 @@
+require 'signet/oauth_2'
+
+module Signet
+  module Rails
+
+    class Factory
+      def self.create_from_env name, env, opt_hsh = {load_token: true}
+	# rework this to use singleton?
+	handler = env["signet.#{name.to_s}"]
+
+	client = Signet::OAuth2::Client.new handler.options
+
+	if opt_hsh[:load_token]
+	  obj = handler.options[:extract_from_env].call env, client
+	  handler.load_token_state obj, client
+
+	  env["signet.#{name.to_s}.instance"] = obj
+	end
+
+	client
+      end
+    end
+  end
+end
+

data/lib/signet/rails/handler.rb

@@ -0,0 +1,90 @@
+require 'signet/oauth_2'
+require 'signet/rails'
+require 'rack/utils'
+
+module Signet
+  module Rails
+    class Handler
+      def initialize(app, opts = {}, &block)
+	@app = app
+	@options = opts
+      end
+
+      def options
+	@options
+      end
+
+      def handle(env)
+
+	if "/signet/#{@options[:name]}/login" == env['PATH_INFO'] && 'GET' == env['REQUEST_METHOD']
+	  client = Factory.create_from_env @options[:name], env
+	  r = Rack::Response.new
+
+	  # TODO: a better way of filtering down to the auth options
+	  auth_options_whitelist = [:approval_prompt]
+	  auth_options = @options.select { |k,_| auth_options_whitelist.include?(k) }
+	  redirect_uri = client.authorization_uri(auth_options).to_s
+	  r.redirect(redirect_uri)
+	  r.finish
+	elsif "/signet/#{@options[:name]}/callback" == env['PATH_INFO'] 
+	  client = Factory.create_from_env @options[:name], env, load_token: false
+	  query_string_params = Rack::Utils.parse_query(env['QUERY_STRING'])
+	  client.code = query_string_params['code']
+	  fat = client.fetch_access_token!
+
+	  if @options[:handle_callback]
+	    # try to get the token store
+	    obj = @options[:extract_by_oauth_id].call client.decoded_id_token['id'], client
+	    persist_token_state obj, client
+	    obj.persist
+	    env["signet.#{options[:name]}.obj"] = obj.obj
+
+	  else
+	    # pass this on for handling by the rails app
+	    env["signet.#{options[:name]}.client"] = client
+
+	  end
+	  
+	  [nil,nil,nil]
+	end
+      end
+
+      def persist_token_state wrapper, client
+	for i in @options[:persist]
+	  if client.respond_to?(i) && wrapper.obj.respond_to?(i.to_s+'=')
+	    wrapper.obj.method(i.to_s+'=').call(client.method(i).call)
+	  end
+	end
+      end
+
+      def load_token_state wrapper, client
+	for i in @options[:persist]
+	  if wrapper.obj.respond_to?(i) && client.respond_to?(i.to_s+'=')
+	    client.method(i.to_s+'=').call(wrapper.obj.method(i).call)
+	  end
+	end
+      end
+
+      def call(env)
+	# rework this to use singleton?
+	env["signet.#{@options[:name]}"] = self
+
+	status, headers, body = handle(env)
+	
+	unless status
+
+	  status, headers, body = @app.call(env)
+
+	  obj = env["signet.#{@options[:name]}.instance"] 
+	  if !!obj
+	    obj.persist
+	  end
+
+	end
+
+	[status, headers, body]
+      end
+
+    end
+  end
+end

data/lib/signet/rails/version.rb

@@ -0,0 +1,5 @@
+module Signet
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/lib/signet/rails/wrappers/active_record.rb

@@ -0,0 +1,22 @@
+module Signet
+  module Rails
+    module Wrappers
+      class ActiveRecord
+	def initialize obj, client
+	  @obj = obj
+	  @client = client
+	end
+
+	def obj
+	  @obj
+	end
+
+	def persist
+	  if @obj.changed?
+	    @obj.save
+	  end
+	end
+      end
+    end
+  end
+end

data/lib/signet/rails.rb

@@ -0,0 +1,7 @@
+module Signet
+  module Rails
+    autoload :Builder,  'signet/rails/builder'
+    autoload :Handler,  'signet/rails/handler'
+    autoload :Factory,  'signet/rails/factory'
+  end
+end

data/signet-rails.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'signet/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "signet-rails"
+  spec.version       = Signet::Rails::VERSION
+  spec.authors       = ["Paul Jolly"]
+  spec.email         = ["paul@myitcv.org.uk"]
+  spec.description   = %q{A wrapper around the Google Signet OAuth Library}
+  spec.summary       = %q{Incorporate Signet goodness into Rails}
+  spec.homepage      = "https://github.com/myitcv/signet-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "signet"
+  spec.add_development_dependency "rack"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: signet-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Jolly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: signet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A wrapper around the Google Signet OAuth Library
+email:
+- paul@myitcv.org.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/signet/rails.rb
+- lib/signet/rails/builder.rb
+- lib/signet/rails/factory.rb
+- lib/signet/rails/handler.rb
+- lib/signet/rails/version.rb
+- lib/signet/rails/wrappers/active_record.rb
+- signet-rails.gemspec
+homepage: https://github.com/myitcv/signet-rails
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Incorporate Signet goodness into Rails
+test_files: []