disiid_user 3.0.2 → 3.1.0

data/lib/disiid_user.rb

@@ -25,6 +25,19 @@ module DisiidUser
     klass.class_eval do
       scope :with_local_role, lambda { |role| where('role & ? > 0', 2**LOCAL_ROLES.index(role.to_s)) }
     end
+    klass.extend(ClassMethods)
+  end
+  
+  ########################################################################
+  # Class Methods
+  #
+  module ClassMethods
+    # Search
+    # Return list of users that match the query search params
+    def search(args = {})
+      args.merge! :auth_token => DisiidUser::RemoteUser.auth_token
+      DisiidUser::RemoteUser.find :all, :params => args
+    end
   end
   
   def self.version_string
@@ -40,7 +53,12 @@ module DisiidUser
   
   # list of methid name that could be called from User instance to get data
   # from the RemoteUser instance
-  REMOTE_ATTRIBUTES = %w(email first_name last_name homepage) unless defined? REMOTE_ATTRIBUTES
+  REMOTE_ATTRIBUTES = %w(email first_name last_name homepage
+                         nickname homepage position office_address office_num 
+                         office_phone office_fax
+                         provider ada_id okkam_id unitn_uid
+                         photo photo_normal photo_thumb hide_photo
+                         remote_created_at remote_updated_at) unless defined? REMOTE_ATTRIBUTES
   
   # List of roles for local setup
   def local_roles
@@ -110,7 +128,10 @@ module DisiidUser
   # interact with remote server to get user information: personal data and roles
   # active resource
   #
-  
+  # Useful settings:
+  #  - DisiidUser::RemoteUser.format = format
+  #  - ActiveSupport.parse_json_times = true
+  #
   # ROLES defined here must be EQUAL with the one defined remote Class self.site
   class RemoteUser < ActiveResource::Base
     self.site = 'http://localhost:3001'

data/lib/disiid_user/version.rb

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

data/spec/6a002a40-bc63-4095-9bb0-f31bf386bf55.json

@@ -0,0 +1,24 @@
+{
+ "uuid": "6a002a40-bc63-4095-9bb0-f31bf386bf55",
+ "email":"admin@example.org",
+ "first_name":"John",
+ "last_name":"Smith",
+ "nickname":"john.smith",
+ "homepage":"http://john.smith.example.org",
+ "position":"full_proffesor",
+ "ada_id":"ADA1122334455",
+ "okkam_id":"kkilpp009iiouy7rccfw5aa",
+ "provider":null,
+ "unitn_uid":null,
+ "office_address":"via sommarive, 5",
+ "office_num":"D14",
+ "office_phone":"0461012345",
+ "office_fax":"0461540123",
+ "roles":["admin","whatever"],
+ "photo":"http://remote_url.example.com/assets/nophoto.jpg",
+ "photo_normal":"http://remote_url.example.com/assets/nophoto-normal.jpg",
+ "photo_thumb":"http://remote_url.example.com/assets/nophoto-thumb.jpg",
+ "hide_photo":false,
+ "remote_created_at":"2011-11-03T10:23:11Z",
+ "remote_updated_at":"2011-12-06T11:15:33Z"
+}

data/spec/6a002a40-bc63-4095-9bb0-f31bf386bf55.xml

@@ -5,8 +5,12 @@
   <first-name>John</first-name>
   <last-name>Smith</last-name>
   <nickname>john.smith</nickname>
-  <photo>avatar.jpg</photo>
   <homepage>http://john.smith.example.org</homepage>
+  <position>full_proffesor</position>
+  <ada-id>ADA1122334455</ada-id>
+  <okkam-id>kkilpp009iiouy7rccfw5aa</okkam-id>
+  <provider nil="true"></provider>
+  <unitn-uid nil="true"></unitn-uid>
   <office-address>via sommarive, 5</office-address>
   <office-num>D14</office-num>
   <office-phone>0461012345</office-phone>
@@ -15,4 +19,11 @@
     <role>admin</role>
     <role>whatever</role>
   </roles>
+  <photo>http://remote_url.example.com/assets/nophoto.jpg</photo>
+  <photo-normal>http://remote_url.example.com/assets/nophoto-normal.jpg</photo-normal>
+  <photo-thumb>http://remote_url.example.com/assets/nophoto-thumb.jpg</photo-thumb>
+  <hide-photo type="boolean">false</hide-photo>
+  <remote-created-at type="datetime">2011-11-03T10:23:11Z</remote-created-at>
+  <remote-updated-at type="datetime">2011-12-06T11:15:33Z</remote-updated-at>
 </user>
+

data/spec/disiid_user_spec.rb

@@ -128,6 +128,18 @@ describe DisiidUser do
         @user.homepage.should be_nil
         @user.first_name.should be_nil
         @user.last_name.should be_nil
+        @user.nickname.should be_nil
+        @user.homepage.should be_nil
+        @user.position.should be_nil
+        @user.office_address.should be_nil
+        @user.office_num.should be_nil
+        @user.office_phone.should be_nil
+        @user.office_fax.should be_nil
+        @user.provider.should be_nil
+        @user.ada_id.should be_nil
+        @user.okkam_id.should be_nil
+        @user.remote_created_at.should be_nil 
+        @user.remote_updated_at.should be_nil
       end
       
       it 'should not raise an exception on attributes assignment' do
@@ -140,16 +152,41 @@ describe DisiidUser do
     end
     
     context 'when exists' do
-      before { 
+      before {
         @user.identity_url = "http://openid.provider.local/users/6a002a40-bc63-4095-9bb0-f31bf386bf55" 
       }
     
-      it 'should have remote attributes' do
-        @user.email.should == 'admin@example.org'
-        @user.first_name.should == 'John'
-        @user.last_name.should == 'Smith'
-        @user.homepage.should == 'http://john.smith.example.org'
-      end
+      [:xml, :json].each { |format|
+        it "should have remote attributes in #{format} format" do
+          DisiidUser::RemoteUser.format = format
+          ActiveSupport.parse_json_times = true
+          
+          @user.email.should == 'admin@example.org'
+          @user.first_name.should == 'John'
+          @user.last_name.should == 'Smith'
+          @user.homepage.should == 'http://john.smith.example.org'
+          @user.nickname.should == 'john.smith'
+          @user.position.should == 'full_proffesor'
+          @user.office_address.should == 'via sommarive, 5'
+          @user.office_num.should == 'D14'
+          @user.office_phone.should == '0461012345'
+          @user.office_fax.should == '0461540123'
+          @user.provider.should be_nil
+          @user.unitn_uid.should be_nil
+          @user.ada_id.should == 'ADA1122334455'
+          @user.okkam_id.should == 'kkilpp009iiouy7rccfw5aa'
+          @user.photo.should == 'http://remote_url.example.com/assets/nophoto.jpg'
+          @user.photo_normal.should == 'http://remote_url.example.com/assets/nophoto-normal.jpg'
+          @user.photo_thumb.should == 'http://remote_url.example.com/assets/nophoto-thumb.jpg'
+          # in JSON the following two will be strings
+          # if ActiveSupport.parse_json_times is not set to true
+          @user.remote_created_at.should == DateTime.parse('2011-11-03T10:23:11Z')
+          @user.remote_updated_at.should == DateTime.parse('2011-12-06T11:15:33Z')
+          # for this to evaluate to boolean 
+          # XML tag should contain type="boolean" attribute
+          @user.hide_photo.should be_false
+        end
+      }
       
       it 'should have assign methods like email=(...)' do
         @user.email = 'new@email.com'
@@ -175,6 +212,33 @@ describe DisiidUser do
         }
         @user.roles.length.should == 3 
       end
-    end # context 'when exists'
+    end # context 'when exists' 
+    
+    context 'when search' do
+      before { DisiidUser::RemoteUser.auth_token = 'sometoken' }
+    
+      it 'should find a list of users with activeresource' do
+        @users = DisiidUser::RemoteUser.find(:all , :params => {:q => 'e', :auth_token => 'sometoken'})
+        @users.size.should == 3
+        @users[0].uuid.should == "7ee5003f-faaa-40ac-939c-615c0da69deb"
+        @users[1].uuid.should == "2632c516-eb32-4cc8-879f-e8060577fc14"
+        @users[2].uuid.should == "ad80daad-7a2f-4f5e-a62e-3189248486a9"
+        @users[0].photo.should == "http://localhost:3000/uploads/user/photo/7ee5003f-faaa-40ac-939c-615c0da69deb/mouse-medium.jpg"
+        @users[1].nickname.should == "test.user"
+        @users[2].last_name.should == "service"
+      end
+            
+      it 'should find a list of users through User model' do
+        @users = User.search(:q => 'e')
+        @users.size.should == 3
+        @users[0].uuid.should == "7ee5003f-faaa-40ac-939c-615c0da69deb"
+        @users[1].uuid.should == "2632c516-eb32-4cc8-879f-e8060577fc14"
+        @users[2].uuid.should == "ad80daad-7a2f-4f5e-a62e-3189248486a9"
+        @users[0].photo.should == "http://localhost:3000/uploads/user/photo/7ee5003f-faaa-40ac-939c-615c0da69deb/mouse-medium.jpg"
+        @users[1].nickname.should == "test.user"
+        @users[2].last_name.should == "service"
+      end      
+      
+    end # context 'when search'
   end # context 'with remote user'
 end

data/spec/stub_user.rb

@@ -18,6 +18,11 @@ class User
   include DisiidUser  
 end
 
+class FakeResponse
+  attr_accessor :body
+  def initialize(body); @body = body; end
+end
+
 # Stub ActiveRecord so that it won't do real HTTP requests
 module ActiveResource
   class Connection
@@ -25,28 +30,28 @@ module ActiveResource
     # instead of doing a real HTTP request
     def get(path, *args)
       read_from_file(path)
-    rescue
-      raise ActiveResource::ResourceNotFound.new("dummy remote user didn't find that resource: #{path} #{args.inspect}")
-    end
+    rescue; raise ActiveResource::ResourceNotFound; 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
-    
+    rescue; raise ActiveResource::ResourceNotFound; 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(/\?.*$/, '')
+      if matched = /users\.(xml|json)/.match(fake_url_path)
+        filename = "#{File.dirname(__FILE__)}/users.#{matched[1]}"
+      else
+        # /collection_name/uuid?query
+        record = /\/[^\/]+\/([^\/\?]+)/.match(fake_url_path)[1]
+        # record string includes .xml or .json too
+        filename = "#{File.dirname(__FILE__)}/#{record}".sub(/\?.*$/, '')
+      end
       # 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
+      data = open(filename).read
+      /3\.1/.match(ActiveResource::VERSION::STRING) ? FakeResponse.new(data) : format.decode(data)
     end
   end
 end

data/spec/users.json

@@ -0,0 +1 @@
+[{"ada_id":"","created_at":"2011-10-13T21:25:16Z","ditwebuser_id":null,"email":"admin@test.org","first_name":"Alex 2","homepage":"http://alex.cloudware.it","last_name":"Test","nickname":".","office_address":"","office_fax":"","office_num":"d14","office_phone":"","okkam_id":"","position":"","provider":null,"unitn_uid":"","updated_at":"2011-12-06T18:10:52Z","uuid":"7ee5003f-faaa-40ac-939c-615c0da69deb","roles":["admin","service"],"photo":"http://localhost:3000/uploads/user/photo/7ee5003f-faaa-40ac-939c-615c0da69deb/mouse-medium.jpg","photo_normal":"http://localhost:3000/uploads/user/photo/7ee5003f-faaa-40ac-939c-615c0da69deb/normal_mouse-medium.jpg","photo_thumb":"http://localhost:3000/uploads/user/photo/7ee5003f-faaa-40ac-939c-615c0da69deb/thumb_mouse-medium.jpg","hide_photo":false},{"ada_id":null,"created_at":"2011-11-03T10:23:11Z","ditwebuser_id":null,"email":"test@example.org","first_name":"Test","homepage":"","last_name":"User","nickname":"test.user","office_address":"addr","office_fax":"","office_num":"d14","office_phone":"","okkam_id":null,"position":null,"provider":null,"unitn_uid":null,"updated_at":"2011-12-06T11:15:33Z","uuid":"2632c516-eb32-4cc8-879f-e8060577fc14","roles":[],"photo":"http://localhost:3000/assets/nophoto.jpg","photo_normal":"http://localhost:3000/assets/nophoto-normal.jpg","photo_thumb":"http://localhost:3000/assets/nophoto-thumb.jpg","hide_photo":false},{"ada_id":null,"created_at":"2011-11-16T10:42:49Z","ditwebuser_id":null,"email":"tech@disi.unitn.it","first_name":"dsc","homepage":"","last_name":"service","nickname":"dsc.service","office_address":"","office_fax":"","office_num":"","office_phone":"","okkam_id":"","position":null,"provider":null,"unitn_uid":"","updated_at":"2011-11-28T14:32:49Z","uuid":"ad80daad-7a2f-4f5e-a62e-3189248486a9","roles":["service"],"photo":"http://localhost:3000/assets/nophoto.jpg","photo_normal":"http://localhost:3000/assets/nophoto-normal.jpg","photo_thumb":"http://localhost:3000/assets/nophoto-thumb.jpg","hide_photo":false}]

data/spec/users.xml

@@ -0,0 +1,84 @@
+
+<?xml version="1.0" encoding="UTF-8"?>
+<users type="array">
+  <user>
+    <uuid>7ee5003f-faaa-40ac-939c-615c0da69deb</uuid>
+    <email>admin@test.org</email>
+    <first-name>Alex 2</first-name>
+    <last-name>Test</last-name>
+    <nickname>.</nickname>
+    <homepage>http://alex.cloudware.it</homepage>
+    <position></position>
+    <office-address></office-address>
+    <office-num>d14</office-num>
+    <office-phone></office-phone>
+    <office-fax></office-fax>
+    <provider nil="true"></provider>
+    <ada-id></ada-id>
+    <okkam-id></okkam-id>
+    <unitn-uid></unitn-uid>
+    <ditwebuser-id type="integer" nil="true"></ditwebuser-id>
+    <created-at type="datetime">2011-10-13T21:25:16Z</created-at>
+    <updated-at type="datetime">2011-12-06T18:10:52Z</updated-at>
+    <roles type="array">
+      <role>admin</role>
+      <role>service</role>
+    </roles>
+    <photo>http://localhost:3000/uploads/user/photo/7ee5003f-faaa-40ac-939c-615c0da69deb/mouse-medium.jpg</photo>
+    <photo-normal>http://localhost:3000/uploads/user/photo/7ee5003f-faaa-40ac-939c-615c0da69deb/normal_mouse-medium.jpg</photo-normal>
+    <photo-thumb>http://localhost:3000/uploads/user/photo/7ee5003f-faaa-40ac-939c-615c0da69deb/thumb_mouse-medium.jpg</photo-thumb>
+    <hide-photo type="boolean">false</hide-photo>
+  </user>
+  <user>
+    <uuid>2632c516-eb32-4cc8-879f-e8060577fc14</uuid>
+    <email>test@example.org</email>
+    <first-name>Test</first-name>
+    <last-name>User</last-name>
+    <nickname>test.user</nickname>
+    <homepage></homepage>
+    <position nil="true"></position>
+    <office-address>addr</office-address>
+    <office-num>d14</office-num>
+    <office-phone></office-phone>
+    <office-fax></office-fax>
+    <provider nil="true"></provider>
+    <ada-id nil="true"></ada-id>
+    <okkam-id nil="true"></okkam-id>
+    <unitn-uid nil="true"></unitn-uid>
+    <ditwebuser-id type="integer" nil="true"></ditwebuser-id>
+    <created-at type="datetime">2011-11-03T10:23:11Z</created-at>
+    <updated-at type="datetime">2011-12-06T11:15:33Z</updated-at>
+    <roles type="array"/>
+    <photo>http://localhost:3000/assets/nophoto.jpg</photo>
+    <photo-normal>http://localhost:3000/assets/nophoto-normal.jpg</photo-normal>
+    <photo-thumb>http://localhost:3000/assets/nophoto-thumb.jpg</photo-thumb>
+    <hide-photo type="boolean">false</hide-photo>
+  </user>
+  <user>
+    <uuid>ad80daad-7a2f-4f5e-a62e-3189248486a9</uuid>
+    <email>tech@disi.unitn.it</email>
+    <first-name>dsc</first-name>
+    <last-name>service</last-name>
+    <nickname>dsc.service</nickname>
+    <homepage></homepage>
+    <position nil="true"></position>
+    <office-address></office-address>
+    <office-num></office-num>
+    <office-phone></office-phone>
+    <office-fax></office-fax>
+    <provider nil="true"></provider>
+    <ada-id nil="true"></ada-id>
+    <okkam-id></okkam-id>
+    <unitn-uid></unitn-uid>
+    <ditwebuser-id type="integer" nil="true"></ditwebuser-id>
+    <created-at type="datetime">2011-11-16T10:42:49Z</created-at>
+    <updated-at type="datetime">2011-11-28T14:32:49Z</updated-at>
+    <roles type="array">
+      <role>service</role>
+    </roles>
+    <photo>http://localhost:3000/assets/nophoto.jpg</photo>
+    <photo-normal>http://localhost:3000/assets/nophoto-normal.jpg</photo-normal>
+    <photo-thumb>http://localhost:3000/assets/nophoto-thumb.jpg</photo-thumb>
+    <hide-photo type="boolean">false</hide-photo>
+  </user>
+</users>

metadata

@@ -1,61 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: disiid_user
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 3.1.0
   prerelease: 
-  version: 3.0.2
 platform: ruby
-authors: 
+authors:
 - Danilo Severina
 - Alex Vagin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-30 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70317348018360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70317348018360
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70317348017780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activeresource
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70317348017780
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: &70317348017160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "3"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *70317348017160
 description: DISI - UniTN internal development
-email: 
+email:
 - tech@disi.unitn.it
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc-template
 - Gemfile
@@ -65,44 +61,47 @@ files:
 - lib/disiid_user.rb
 - lib/disiid_user/version.rb
 - spec/596568c5-d6e7-4328-815c-c532aeed1198.xml
+- spec/6a002a40-bc63-4095-9bb0-f31bf386bf55.json
 - spec/6a002a40-bc63-4095-9bb0-f31bf386bf55.xml
 - spec/disiid_user_spec.rb
 - spec/remote_user_spec.rb
 - spec/spec_helper.rb
 - spec/stub_methods_spec.rb
 - spec/stub_user.rb
+- spec/users.json
+- spec/users.xml
 homepage: http://disi.unitn.it
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: disiid_user
-rubygems_version: 1.8.9
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: DISI ID global user
-test_files: 
+test_files:
 - spec/596568c5-d6e7-4328-815c-c532aeed1198.xml
+- spec/6a002a40-bc63-4095-9bb0-f31bf386bf55.json
 - spec/6a002a40-bc63-4095-9bb0-f31bf386bf55.xml
 - spec/disiid_user_spec.rb
 - spec/remote_user_spec.rb
 - spec/spec_helper.rb
 - spec/stub_methods_spec.rb
 - spec/stub_user.rb
+- spec/users.json
+- spec/users.xml