disiid_user 3.0.1 → 3.0.2

data/TODO

@@ -0,0 +1 @@
+- should be PUTting remote_user on @user.save() so that remote attributes get updated too (if permitted)

data/lib/disiid_user/version.rb

@@ -1,3 +1,3 @@
 module DisiidUser
-  VERSION = "3.0.1"
+  VERSION = "3.0.2"
 end

data/lib/disiid_user.rb

@@ -74,16 +74,26 @@ module DisiidUser
   # Method for interaction with RemoteUser
   #
   
-  # Method for requesting data of remote user
+  # Method for requesting or updating data of remote user
   REMOTE_ATTRIBUTES.each do |remote_attr| 
+    # getters
     define_method remote_attr do
-      remote_user.try(remote_attr)
+      remote_user.public_send(remote_attr) if remote_user
+    end
+    # setters
+    meth = "#{remote_attr}="
+    define_method meth do |val|
+      # works for 1.9.2, not sure public_send() is available for 1.8.7
+      remote_user.public_send(meth, val) if remote_user
     end
   end
   
   # Get the remote user via get ActiveResource
   def remote_user
-    @remote_user ||= DisiidUser::RemoteUser.find uuid, :params => { :auth_token => DisiidUser::RemoteUser.auth_token }
+    return nil unless uuid
+    @remote_user ||= Rails.cache.fetch(uuid, :expires_in => DisiidUser::RemoteUser.cache_expiry) do 
+      DisiidUser::RemoteUser.find uuid, :params => { :auth_token => DisiidUser::RemoteUser.auth_token }
+    end
   rescue; nil; end
     
   # Return the uuid of a user
@@ -105,7 +115,24 @@ module DisiidUser
   class RemoteUser < ActiveResource::Base
     self.site = 'http://localhost:3001'
     self.element_name = 'user'
+    
+    # authentication token that will be appended at the end of the request URL,
+    # e.g. http://id.provider.com/:collection_name/:uuid?auth_token=:auth_token
     cattr_accessor :auth_token
+    
+    # remote_user cache expiration time, in seconds
+    # defaults to 1 hour
+    cattr_accessor :cache_expiry
+    self.cache_expiry = 3600
+    
+    protected
+    
+    # Redefined method from Base class: we need to add auth_token suffix 
+    # to the request params
+    def element_path(options = nil)
+      auth = { :auth_token => self.class.auth_token }
+      self.class.element_path(to_param, (options || prefix_options || {}).merge(auth))
+    end
   end
  
 end

data/spec/disiid_user_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'user'
+require 'stub_user'
 
 # admin@example.org
 # 6a002a40-bc63-4095-9bb0-f31bf386bf55
@@ -95,11 +95,28 @@ describe DisiidUser do
     before { DisiidUser::RemoteUser.auth_token = 'sometoken' }
     
     it 'should fetch it using find()' do
+      @user.identity_url = "http://host/users/some-uuid"
       DisiidUser::RemoteUser.should_receive(:find).with('some-uuid', :params => hash_including(:auth_token => 'sometoken'))
+      
+      @user.remote_user
+    end
+    
+    it 'should be cached' do
       @user.identity_url = "http://host/users/some-uuid"
+      
+      cache_expiry = DisiidUser::RemoteUser.cache_expiry
+      Rails.cache.should_receive(:fetch).with('some-uuid', hash_including(:expires_in => cache_expiry))
+      
       @user.remote_user
     end
     
+    it 'should not search for it if uuid is missing' do
+      @user.identity_url = nil
+      DisiidUser::RemoteUser.should_not_receive(:find)
+      
+      @user.remote_user.should be_nil
+    end
+    
     context 'when does not exist' do
       before { @user.identity_url = "http://openid.provider.local/users/does-no-exist" }
       it 'should just be nil' do
@@ -112,6 +129,14 @@ describe DisiidUser do
         @user.first_name.should be_nil
         @user.last_name.should be_nil
       end
+      
+      it 'should not raise an exception on attributes assignment' do
+        @user.first_name = 'whatever'
+        # this will basically check the part '... if remote_user'
+        # in e.g. define_method('first_name=') { |val| first_name = val if remote_user }
+        @user.first_name.should be_nil
+        # assuming other attributes work the same way
+      end
     end
     
     context 'when exists' do
@@ -125,6 +150,15 @@ describe DisiidUser do
         @user.last_name.should == 'Smith'
         @user.homepage.should == 'http://john.smith.example.org'
       end
+      
+      it 'should have assign methods like email=(...)' do
+        @user.email = 'new@email.com'
+        @user.email.should == 'new@email.com'
+
+        @user.homepage = 'http://some.page.com'
+        @user.homepage.should == 'http://some.page.com'
+        # assuming other attributes work too
+      end
     
       it 'should get all roles, including remote' do
         @user.local_roles = 'manager'

data/spec/stub_methods_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'user'
+require 'stub_user'
 
 # stub methods check
 describe Array do

data/spec/{user.rb → stub_user.rb}

@@ -24,14 +24,41 @@ module ActiveResource
     # taps into ActiveRecord to read data from stub files
     # instead of doing a real HTTP request
     def get(path, *args)
-      record = /\/[^\/]+\/([^\/]+)/.match(path)[1]
+      read_from_file(path)
+    rescue
+      raise ActiveResource::ResourceNotFound.new("dummy remote user didn't find that resource: #{path} #{args.inspect}")
+    end
+    
+    # stubs PUT request so to not do it for real
+    def put(path, payload, headers)
+      read_from_file(path)
+    rescue
+      raise ActiveResource::ResourceNotFound.new("couldn't update dummy remote user: #{path} #{args.inspect}")
+    end
+    
+    
+    private 
+    
+    def read_from_file(fake_url_path)
+      # /collection_name/uuid?query
+      record = /\/[^\/]+\/([^\/\?]+)/.match(fake_url_path)[1]
       # record string includes .xml or .json too
       filename = "#{File.dirname(__FILE__)}/#{record}".sub(/\?.*$/, '')
       # format is either ActiveResource::Formats::XmlFormat or JsonFormat
       # 3.0.x defaults to XML, 3.1.x defaults to JSON
       format.decode open(filename).read
-    rescue
-      raise ActiveResource::ResourceNotFound.new("dummy remote user didn't find that resource: #{path} #{args.inspect}")
     end
   end
 end
+
+# stub implementation for Rails.cache
+# it will never really cache results 
+# so it is safe to Rails.cache.fetch(...) { ... }
+class StubCache
+  def self.fetch(*args); yield; end
+end
+
+module Rails
+  def self.cache; StubCache; end
+end
+

metadata

@@ -2,7 +2,7 @@
 name: disiid_user
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors: 
 - Danilo Severina
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-16 00:00:00 Z
+date: 2011-11-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -60,6 +60,7 @@ files:
 - .rvmrc-template
 - Gemfile
 - Rakefile
+- TODO
 - disiid_user.gemspec
 - lib/disiid_user.rb
 - lib/disiid_user/version.rb
@@ -69,7 +70,7 @@ files:
 - spec/remote_user_spec.rb
 - spec/spec_helper.rb
 - spec/stub_methods_spec.rb
-- spec/user.rb
+- spec/stub_user.rb
 homepage: http://disi.unitn.it
 licenses: []
 
@@ -104,4 +105,4 @@ test_files:
 - spec/remote_user_spec.rb
 - spec/spec_helper.rb
 - spec/stub_methods_spec.rb
-- spec/user.rb
+- spec/stub_user.rb