disiid_user 3.1.0 → 3.1.1

data/disiid_user.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler"
   # runtime dependencies
   s.add_runtime_dependency "activeresource", '~> 3'
+  s.add_runtime_dependency "activerecord", '~> 3'
 end

data/lib/disiid_user/version.rb

@@ -1,3 +1,3 @@
 module DisiidUser
-  VERSION = "3.1.0"
+  VERSION = "3.1.1"
 end

data/lib/disiid_user.rb

@@ -32,12 +32,41 @@ module DisiidUser
   # Class Methods
   #
   module ClassMethods
-    # Search
-    # Return list of users that match the query search params
+    # Returns a list of users as ActiveResource objects that match given query params, e.g.
+    #   User.search(:q => "dude")            # => [{name: 'dude', ...}, {...}]
+    #   User.search(:position => 'whatever)  # => []
     def search(args = {})
       args.merge! :auth_token => DisiidUser::RemoteUser.auth_token
       DisiidUser::RemoteUser.find :all, :params => args
     end
+    
+    # Creates a new user object with the identity attribute assigned
+    # and returns a not presisted record. 
+    # You'll need to call .save or .save! on the returned result 
+    # if you want to persist it in a local database.
+    #
+    # Note: your local :users table should :identity_url string attribute for this to work.
+    def build_from_identity(url)
+      user = new
+      user.identity_url = url
+      user
+    end
+    
+    # Looks for a local user record with a given UUID by matching its local attribute :identity_url.
+    # Creates a new user if it doesn't exist locally but is present remotely using #build_from_identity method.
+    # This method will throw ActiveRecord::RecordNotFound exception if persistance process didn't go well.
+    def find_local_or_remote_by_uuid!(id)
+      user = first(conditions: ['identity_url LIKE ?', "%#{id}"])
+      if !user && DisiidUser::RemoteUser.exists?(id, params: {auth_token: DisiidUser::RemoteUser.auth_token})
+        user_url = "#{DisiidUser::RemoteUser.site}/#{DisiidUser::RemoteUser.collection_name}/#{id}"
+        user = build_from_identity(user_url)
+        user.save!
+      end
+      user
+    rescue
+      raise ::ActiveRecord::RecordNotFound
+    end
+    
   end
   
   def self.version_string
@@ -118,8 +147,7 @@ module DisiidUser
   # Last part of identity_url, after path 'user' (element_name of RemoteUser params)
   def uuid
     @uuid ||= begin
-      collection_name = DisiidUser::RemoteUser.collection_name
-      /.*\/#{collection_name}\/([a-z0-9\-]+)$/.match(identity_url.to_s)[1]
+      /.*\/#{DisiidUser::RemoteUser.collection_name}\/([a-z0-9\-]+)$/.match(identity_url.to_s)[1]
     rescue; nil; end
   end
   
@@ -145,6 +173,7 @@ module DisiidUser
     # defaults to 1 hour
     cattr_accessor :cache_expiry
     self.cache_expiry = 3600
+
     
     protected
     

data/spec/disiid_user_spec.rb

@@ -36,6 +36,87 @@ describe DisiidUser do
     @user.uuid.should be_nil
   end
   
+  it "should build a new user with correct identity url" do
+    u = User.build_from_identity 'http://openid.provider.local/users/6a002a40-bc63-4095-9bb0-f31bf386bf55'
+    
+    u.should be_instance_of(User)
+    u.should be_new_record
+    u.identity_url.should == 'http://openid.provider.local/users/6a002a40-bc63-4095-9bb0-f31bf386bf55'
+    u.uuid.should == '6a002a40-bc63-4095-9bb0-f31bf386bf55'
+  end
+  
+  describe "#find_local_or_remote_by_uuid!" do
+    let(:user) { User }
+    subject { user }
+    
+    it { should respond_to :find_local_or_remote_by_uuid! }
+    it "should look for a local user" do
+      user.should_receive(:first).with(hash_including(conditions: ['identity_url LIKE ?', '%some-uuid'])).and_return(true)
+      user.find_local_or_remote_by_uuid!('some-uuid')
+    end
+    
+    context "when local user doesn't exist" do
+      let(:new_user) { mock('new user', :save! => true) }
+      before { 
+        user.stub(:first).and_return(nil) 
+        user.stub(:build_from_identity).and_return(new_user)
+      }
+      
+      it "should try and see if remote user exists" do
+        DisiidUser::RemoteUser.should_receive(:exists?).with('some-uuid', params: hash_including(
+          auth_token: DisiidUser::RemoteUser.auth_token
+        ))
+        user.find_local_or_remote_by_uuid!('some-uuid')
+      end
+      
+      context "but the remote does" do
+        before { DisiidUser::RemoteUser.stub(:exists?).and_return(true) }
+        it "should build a new user" do
+          user.should_receive(:build_from_identity).with('http://localhost:3001/users/a-uuid')
+          user.find_local_or_remote_by_uuid!('a-uuid')
+        end
+        
+        it "should store user with .save!" do
+          new_user.should_receive(:save!)
+          user.find_local_or_remote_by_uuid!('a-uuid')
+        end
+        
+        it "should return newly created user" do
+          user.find_local_or_remote_by_uuid!('a-uuid').should == new_user
+        end
+        
+        it "should raise 'record not found' if .save! fails" do
+          new_user.stub(:save!).and_raise('some exception')
+          expect { user.find_local_or_remote_by_uuid!('some-uuid') }.to raise_error(ActiveRecord::RecordNotFound)
+        end
+      end
+      
+      context "and niether does remote" do
+        before { DisiidUser::RemoteUser.stub(:exists?).and_return(false) }
+        subject { user.find_local_or_remote_by_uuid!('some-uuid') }
+        it { should be_nil }
+      end
+      
+      context "and an exception's been raised" do
+        before { DisiidUser::RemoteUser.stub(:exists?).and_raise('some error') }
+        it "should throw 'record not found'" do
+          expect { user.find_local_or_remote_by_uuid!('some-uuid') }.to raise_error(ActiveRecord::RecordNotFound)
+        end
+      end
+    end
+    
+    context "when local user exists" do
+      let(:existing_user) { mock('existing user') }
+      before { user.stub(:first).and_return(existing_user) }
+      
+      it "should not fetch from remote" do
+        DisiidUser::RemoteUser.should_not_receive(:exists?)
+        user.should_not_receive(:build_from_identity)
+        user.find_local_or_remote_by_uuid!('some-uuid').should == existing_user
+      end
+    end
+  end
+  
   context "with local roles" do
     
     it 'should correctly parse :role attribute' do

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'rspec'
 require 'disiid_user'
+require 'active_record/errors'
 
 RSpec.configure do |config|
   config.color_enabled = true

data/spec/stub_user.rb

@@ -11,11 +11,18 @@ end
 #   - role (Integer)
 #   - identity_url (String)
 class User
+  attr_accessor :new_record, :role, :identity_url
+  alias_method :new_record?, :new_record
+  
+  def initialize(*args)
+    super(*args)
+    @new_record = true
+  end
+  
   # stub methods and attributes
   def self.scope(*args); end
-  attr_accessor :role, :identity_url
   
-  include DisiidUser  
+  include DisiidUser
 end
 
 class FakeResponse

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: disiid_user
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00.000000000Z
+date: 2011-12-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70317348018360 !ruby/object:Gem::Requirement
+  requirement: &70154939590940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70317348018360
+  version_requirements: *70154939590940
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70317348017780 !ruby/object:Gem::Requirement
+  requirement: &70154939648160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70317348017780
+  version_requirements: *70154939648160
 - !ruby/object:Gem::Dependency
   name: activeresource
-  requirement: &70317348017160 !ruby/object:Gem::Requirement
+  requirement: &70154939656120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,7 +44,18 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *70317348017160
+  version_requirements: *70154939656120
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70154939665280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70154939665280
 description: DISI - UniTN internal development
 email:
 - tech@disi.unitn.it