signet-rails 0.0.1 → 0.0.2

data/README.md

@@ -28,6 +28,30 @@ $ gem install signet-rails
 
 TODO: Write usage instructions here
 
+## TODO
+
+A list of items still todo or work in progress
+
+0. Give an example usage
+ * Example of setting default options
+ * Example of setting per provider options
+ * Clearly document default `extract\_from\_env`
+ * Clearly document default `extract\_by\_oauth\_id`
+1. Is there a better (Rails) way to creating per-request instances of signet OAuth clients?
+2. Currently use the env variable to store the handlers and references to the instances... is this thread safe (probably) and the best way (probably not)?
+3. Better way of sourcing the Google default authorization_uri and token_credential_uri? From signet directly?
+4. Clear definition of the Signet options and the `signet-rails` options
+5. More Rails-esque way of getting the `rack.session` in `extract\_from\_env`?
+6. Better way of loading persistance wrappers in builder?
+7. Check to see whether we have all required signet options at the end of Builder.provder?
+8. Sort out `approval\_prompt` vs 'prompt'
+9. Better `auth\_options` split at the end of Builder.provider?
+10. Avoid having to dup options the whole time: fix signet?
+11. Refactor Handler.handle code... messy
+12. Document handling of callback in Rails
+13. Error handling...
+14. Document the various `env` values that can/will be set and when (e.g. `signet.XXX.persistance\_obj` on `auth\_callback`)
+
 ## Contributing
 
 1. Fork it

data/lib/signet/rails/builder.rb

@@ -1,5 +1,5 @@
 require 'signet/rails'
-require 'signet/rails/wrappers/active_record'
+require 'active_support/core_ext/string'
 
 module Signet
   module Rails
@@ -7,7 +7,7 @@ module Signet
       @@default_options = {}
 
       def self.set_default_options opts = {}
-	# normalize to symbol version
+	# normalize to symbol hash
 	n_opts = opts.inject({}) { |memo,(k,v)| memo[k.to_sym] = v; memo }
 	@@default_options = n_opts
       end
@@ -17,17 +17,31 @@ module Signet
       end
 
       def provider(opts = {}, &block)
-	# normalize to symbol version
+	# normalize to symbol hash
 	n_opts = opts.inject({}) { |memo,(k,v)| memo[k.to_sym] = v; memo }
+
+	# use the default_options as a base... then merge these changes on top
 	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[:persist_attrs] ||= [:refresh_token, :access_token, :expires_in, :issued_at]
 	combined_options[:name] ||= :google
+
+	# TODO: see https://developers.google.com/accounts/docs/OAuth2Login#authenticationuriparameters
 	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'
+
+	# unless specified, we need to set this at request-time because we need the env to get server etc
+	# combined_options[:redirect_uri] = ??? need env 
+	
+	# TODO: better way of sourcing these defaults... from signet?
+	combined_options[:authorization_uri] ||= 'https://accounts.google.com/o/oauth2/auth'
+	combined_options[:token_credential_uri] ||= 'https://accounts.google.com/o/oauth2/token'
+
+	# whether we handle the persistance of the auth callback or simply pass-through
+	combined_options[:handle_auth_callback] ||= true
+
+	# method to get the persistance object when creating a client via the factory
 	combined_options[:extract_from_env] ||= lambda do |env, client|
 	  u = nil
 	  session = env['rack.session']
@@ -39,7 +53,8 @@ module Signet
 	  end
 	  u
 	end
-	combined_options[:handle_callback] ||= true
+
+	# when on an auth_callback, how do we get the persistance object from the id?
 	combined_options[:extract_by_oauth_id] ||= lambda do |id, client|
 	  u = nil
 	  begin
@@ -51,19 +66,27 @@ module Signet
 	  u
 	end
 
-	def active_record_wrapper meth
+	combined_options[:persistance_wrapper] ||= :active_record
+	persistance_wrapper = lambda do |meth|
 	  lambda do |context, client|
 	    y = meth.call context, client
-	    w = Signet::Rails::Wrappers::ActiveRecord.new y, client
+	    klass_str = combined_options[:persistance_wrapper].to_s
+	    require "signet/rails/wrappers/#{klass_str}"
+	    w = "Signet::Rails::Wrappers::#{klass_str.camelize}".constantize.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]
+	combined_options[:extract_by_oauth_id] = persistance_wrapper.call combined_options[:extract_by_oauth_id]
+	combined_options[:extract_from_env] = persistance_wrapper.call combined_options[:extract_from_env]
 
 	# TODO: check here we have the basics?
+	
+	# TODO: better auth_options split?
+	auth_option_keys = [:prompt, :redirect_uri, :access_type, :approval_prompt, :client_id]
+	base_options = combined_options
+	auth_options = base_options.select { |k,v| auth_option_keys.include? k }
 
-	use Signet::Rails::Handler, combined_options, &block
+	use Signet::Rails::Handler, base_options, auth_options, &block
       end
 
       def call(env)

data/lib/signet/rails/factory.rb

@@ -5,19 +5,25 @@ module Signet
 
     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
+        # TODO: thread safe? best approach? Other uses below
+        client = env["signet.#{name.to_s}.instance"]
 
-	if opt_hsh[:load_token]
-	  obj = handler.options[:extract_from_env].call env, client
-	  handler.load_token_state obj, client
+        return client if !!client
+        
+        # TODO: again, not pretty...
+        handler = env["signet.#{name.to_s}"]
 
-	  env["signet.#{name.to_s}.instance"] = obj
-	end
+        client = Signet::OAuth2::Client.new handler.options
 
-	client
+        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

data/lib/signet/rails/handler.rb

@@ -5,52 +5,69 @@ require 'rack/utils'
 module Signet
   module Rails
     class Handler
-      def initialize(app, opts = {}, &block)
+      def initialize(app, opts = {}, auth_opts = {}, &block)
 	@app = app
 	@options = opts
+	@auth_options = auth_opts
       end
 
       def options
-	@options
+	# TODO: this is because signet doesn't dup what we pass in....
+	@options.dup
+      end
+
+      def auth_options env
+	# TODO: this is because signet doesn't dup what we pass in....
+	ret = @auth_options.dup
+	unless ret.include? :redirect_uri
+	  req = Rack::Request.new env
+	  scheme = req.ssl? ? 'https' : 'http'
+	  ret[:redirect_uri] = "#{scheme}://#{req.host_with_port}/signet/#{options[:name]}/auth_callback"
+	end
+	ret
       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
+	# set these to 'handle' the request
+	status = headers = body = nil
 
-	  # 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
+	# TODO: better way than a gross if elsif block?
+	if "/signet/#{options[:name]}/auth" == env['PATH_INFO'] && 'GET' == env['REQUEST_METHOD']
+
+	  # we are looking to auth... so nothing to load
+	  client = Factory.create_from_env options[:name], env, load_token: false
+
+	  r = Rack::Response.new
+	  redirect_uri = client.authorization_uri(auth_options(env)).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
+	  status, headers, body = r.finish
+	elsif "/signet/#{options[:name]}/auth_callback" == env['PATH_INFO'] && 'GET' == env['REQUEST_METHOD']
+	  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!
+	  client.redirect_uri = auth_options(env)[:redirect_uri]
+	  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
+	  if options[:handle_auth_callback]
+	    # TODO: remove
+	    puts '******************************************'
+	    puts client.decoded_id_token.inspect
+
+	    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
-
+	    env["signet.#{options[:name]}.persistance_obj"] = obj.obj
 	  else
-	    # pass this on for handling by the rails app
-	    env["signet.#{options[:name]}.client"] = client
-
+	    env["signet.#{options[:name]}.auth_client"] = client
 	  end
-	  
-	  [nil,nil,nil]
 	end
+
+	[status, headers, body]
       end
 
       def persist_token_state wrapper, client
-	for i in @options[:persist]
+	for i in options[:persist_attrs]
 	  if client.respond_to?(i) && wrapper.obj.respond_to?(i.to_s+'=')
 	    wrapper.obj.method(i.to_s+'=').call(client.method(i).call)
 	  end
@@ -58,7 +75,7 @@ module Signet
       end
 
       def load_token_state wrapper, client
-	for i in @options[:persist]
+	for i in options[:persist_attrs]
 	  if wrapper.obj.respond_to?(i) && client.respond_to?(i.to_s+'=')
 	    client.method(i.to_s+'=').call(wrapper.obj.method(i).call)
 	  end
@@ -67,15 +84,15 @@ module Signet
 
       def call(env)
 	# rework this to use singleton?
-	env["signet.#{@options[:name]}"] = self
+	env["signet.#{options[:name]}"] = self
 
 	status, headers, body = handle(env)
-	
+
 	unless status
 
 	  status, headers, body = @app.call(env)
 
-	  obj = env["signet.#{@options[:name]}.instance"] 
+	  obj = env["signet.#{options[:name]}.instance"] 
 	  if !!obj
 	    obj.persist
 	  end
@@ -84,7 +101,6 @@ module Signet
 
 	[status, headers, body]
       end
-
     end
   end
 end

data/lib/signet/rails/version.rb

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

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signet-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: