signet-rails 0.0.4 → 0.0.5

data/README.md

@@ -1,8 +1,8 @@
 # Signet::Rails
 
-A basic Rails wrapper around the [Signet](https://github.com/google/signet) gem
+A basic Rails wrapper around the [Signet](https://github.com/google/signet) gem that handles persistence of a user's credentials on top of handling the auth flow within Rails applications. Check out [an example Rails app](https://github.com/myitcv/test-signet-rails) that utilises this gem.
 
-Work in progress
+Please note this is very much work in progress... issues/suggestions/etc gratefully received. Raise an issue/create a pull-request.
 
 ## Installation
 
@@ -26,7 +26,7 @@ $ gem install signet-rails
 
 ## Usage
 
-TODO: Write usage instructions here
+Check out [an example Rails app](https://github.com/myitcv/test-signet-rails) that utilises this gem.
 
 ## TODO
 
@@ -42,7 +42,7 @@ A list of items still todo or work in progress
 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?
+6. Better way of loading persistence 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?
@@ -50,9 +50,13 @@ A list of items still todo or work in progress
 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`)
+14. Document the various `env` values that can/will be set and when (e.g. `signet.XXX.persistence\_obj` on `auth\_callback`)
 15. Allow shortened form of common scopes (userprofile etc)
-16. Do we need a require in the initializer?
+16. Provider `application_name` and `applicatio_version` when initialising the client (per signet error)
+
+## Credits
+
+Credit where it is due, much of what you see here is derived from lessons learned using [omniauth](https://github.com/intridea/omniauth)* but also this [great post by Greg Baugues](http://blog.baugues.com/google-calendar-api-oauth2-and-ruby-on-rails)
 
 ## Contributing
 

data/lib/signet/rails/builder.rb

@@ -38,10 +38,10 @@ module 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
+	# whether we handle the persistence 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
+	# method to get the persistence object when creating a client via the factory
 	combined_options[:extract_from_env] ||= lambda do |env, client|
 	  u = nil
 	  session = env['rack.session']
@@ -54,7 +54,7 @@ module Signet
 	  u
 	end
 
-	# when on an auth_callback, how do we get the persistance object from the id?
+	# when on an auth_callback, how do we get the persistence object from the id?
 	combined_options[:extract_by_oauth_id] ||= lambda do |id, client|
 	  u = nil
 	  begin
@@ -66,18 +66,18 @@ module Signet
 	  u
 	end
 
-	combined_options[:persistance_wrapper] ||= :active_record
-	persistance_wrapper = lambda do |meth|
+	combined_options[:persistence_wrapper] ||= :active_record
+	persistence_wrapper = lambda do |meth|
 	  lambda do |context, client|
 	    y = meth.call context, client
-	    klass_str = combined_options[:persistance_wrapper].to_s
+	    klass_str = combined_options[:persistence_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] = persistance_wrapper.call combined_options[:extract_by_oauth_id]
-	combined_options[:extract_from_env] = persistance_wrapper.call combined_options[:extract_from_env]
+	combined_options[:extract_by_oauth_id] = persistence_wrapper.call combined_options[:extract_by_oauth_id]
+	combined_options[:extract_from_env] = persistence_wrapper.call combined_options[:extract_from_env]
 
 	# TODO: check here we have the basics?
 	

data/lib/signet/rails/factory.rb

@@ -5,14 +5,19 @@ module Signet
 
     class Factory
       def self.create_from_env name, env, opt_hsh = {load_token: true}
-
-        # TODO: thread safe? best approach? Other uses below
-        client = env["signet.#{name.to_s}.instance"]
-
-        return client if !!client
         
-        # TODO: again, not pretty...
+        # TODO: not pretty...thread safe? best approach? Other uses below
         handler = env["signet.#{name.to_s}"]
+	instance = env["signet.#{name.to_s}.instance"]
+	
+        #client = instance.obj
+        client = instance
+
+        return client if !!client
+
+	if handler.nil? 
+	  raise ArgumentError, "Unable to find signet handler named #{name.to_s}"
+	end
 
         client = Signet::OAuth2::Client.new handler.options
 
@@ -20,7 +25,8 @@ module Signet
           obj = handler.options[:extract_from_env].call env, client
           handler.load_token_state obj, client
 
-          env["signet.#{name.to_s}.instance"] = obj
+          #instance.obj = obj
+	  env["signet.#{name.to_s}.instance"] = obj
         end
 
         client

data/lib/signet/rails/handler.rb

@@ -50,14 +50,10 @@ module Signet
 	  client.fetch_access_token! 
 
 	  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
+	    obj = options[:extract_by_oauth_id].call client.decoded_id_token['sub'], client
 	    persist_token_state obj, client
 	    obj.persist
-	    env["signet.#{options[:name]}.persistance_obj"] = obj.obj
+	    env["signet.#{options[:name]}.persistence_obj"] = obj.obj
 	  else
 	    env["signet.#{options[:name]}.auth_client"] = client
 	  end
@@ -69,7 +65,8 @@ module Signet
       def persist_token_state wrapper, client
 	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)
+	    # only transfer the value if it is non-nil
+	    wrapper.obj.method(i.to_s+'=').call(client.method(i).call) unless client.method(i).call.nil?
 	  end
 	end
       end
@@ -92,9 +89,10 @@ module Signet
 
 	  status, headers, body = @app.call(env)
 
-	  obj = env["signet.#{options[:name]}.instance"] 
-	  if !!obj
-	    obj.persist
+	  instance = env["signet.#{options[:name]}.instance"] 
+	  if !!instance
+	    persist_token_state instance, instance.client
+	    instance.persist
 	  end
 
 	end

data/lib/signet/rails/version.rb

@@ -1,5 +1,5 @@
 module Signet
   module Rails
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

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

@@ -7,9 +7,8 @@ module Signet
           @client = client
         end
 
-        def obj
-          @obj
-        end
+	attr_reader :obj
+	attr_reader :client
 
         def persist
           if @obj.changed?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signet-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-17 00:00:00.000000000 Z
+date: 2013-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler