disiid_user 2.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc*
+rvmrc*
+!.rvmrc-template
+

data/.rvmrc-template

@@ -0,0 +1 @@
+rvm 1.9.2-p180@rails3 --create

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in disiid_user.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+desc "Run tests"
+task :default => :spec

data/disiid_user.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "disiid_user/version"
+
+Gem::Specification.new do |s|
+  s.name        = "disiid_user"
+  s.version     = DisiidUser::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Danilo Severina", "Alex Vagin"]
+  s.email       = ["tech@disi.unitn.it"]
+  s.homepage    = "http://disi.unitn.it"
+  s.summary     = %q{DISI ID global user}
+  s.description = %q{DISI - UniTN internal development}
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project = "disiid_user"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake", '~> 0.8.7'
+  s.add_development_dependency "bundler"
+  # runtime dependencies
+  s.add_runtime_dependency "activeresource", '~> 2'
+end

data/lib/disiid_user/version.rb

@@ -0,0 +1,3 @@
+module DisiidUser
+  VERSION = "2.0.1"
+end

data/lib/disiid_user.rb

@@ -0,0 +1,114 @@
+require "disiid_user/version"
+require 'active_resource'
+
+## Usage:
+#
+# in config/initializers/disid.rb:
+#
+#   DisiidUser::RemoteUser.site = 'http://id.provider.com'
+#   DisiidUser::RemoteUser.auth_token = 'a secret token goes here'
+#
+#   # if resource name is different from 'user' (default)
+#   DisiidUser::RemoteUser.element_name = 'user'
+#
+# in app/models/user.rb:
+#
+#   class User < ActiveRecord::Base
+#     include DisiidUser
+#     ...
+#   end
+#
+module DisiidUser
+  
+  def self.included(klass)    
+    klass.class_eval do
+      named_scope :with_local_role, lambda { |role| where('role & ? > 0', 2**LOCAL_ROLES.index(role.to_s)) }
+    end
+  end
+  
+  def self.version_string
+    "DisiidUser version #{VERSION}"
+  end
+  
+  ########################################################################
+  # Check roles of user
+  #
+  
+  # list of local roles
+  LOCAL_ROLES = %w(admin manager) unless defined? LOCAL_ROLES
+  
+  # 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
+  
+  # List of roles for local setup
+  def local_roles
+    LOCAL_ROLES.reject { |r| ((role || 0) & 2**LOCAL_ROLES.index(r)).zero? }
+  end
+  
+  # Add roles to the local setup
+  # all of the following will work: 
+  #   user.local_roles = :admin
+  #   user.local_roles = [:admin, :manager]
+  #   user.local_roles = 'admin'
+  #   user.local_roles = 'admin', 'manager' # w/o brackets
+  def local_roles=(*roles)
+    self.role = (roles.flatten.map { |r| r.to_s } & LOCAL_ROLES).map { |r| 2**LOCAL_ROLES.index(r) }.sum
+  end
+  
+  # List of roles both local and remote (no duplicates)
+  def roles
+    @roles ||= remote_user ? (local_roles + remote_user.roles).uniq : local_roles
+  end
+  
+  # Check if the user has the required role
+  # admin role has all privileges
+  #   has_role? 'manager'
+  #   has_role? :admin
+  def has_role?(role)
+    roles.include?("admin") || roles.include?(role.to_s)
+  end
+
+  ########################################################################
+  # Method for interaction with RemoteUser
+  #
+  
+  # Method for requesting data of remote user
+  REMOTE_ATTRIBUTES.each do |remote_attr| 
+    define_method remote_attr do
+      remote_user.try(remote_attr)
+    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 }
+  rescue
+    nil
+  end
+    
+  # Return the uuid of a user
+  # 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]
+    rescue; nil; end
+  end
+  
+  #######################################################################
+  # Class RemoteUser
+  # interact with remote server to get user information: personal data and roles
+  # active resource
+  #
+  
+  # ROLES defined here must be EQUAL with the one defined remote Class self.site
+  class RemoteUser < ActiveResource::Base
+    self.site = 'http://localhost:3001'
+    self.element_name = 'user'
+    self.format = :json
+    cattr_accessor :auth_token
+  end
+ 
+end
+

data/spec/596568c5-d6e7-4328-815c-c532aeed1198.json

@@ -0,0 +1,15 @@
+{
+ "uuid": "596568c5-d6e7-4328-815c-c532aeed1198",
+ "email":"nobody@example.org",
+ "first_name":"Mr",
+ "last_name":"Anonymous",
+ "nickname":"mr.anon",
+ "photo": "nobody.jpg",
+ "homepage":"",
+ "office_address":"via sommarive, 5",
+ "office_num":"D44",
+ "office_phone":"0461444444",
+ "office_fax":"0461555555",
+ "roles": []
+}
+

data/spec/596568c5-d6e7-4328-815c-c532aeed1198.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<user>
+  <uuid>596568c5-d6e7-4328-815c-c532aeed1198</uuid>
+  <email>nobody@example.org</email>
+  <first-name>Mr</first-name>
+  <last-name>Anonymous</last-name>
+  <nickname>mr.anon</nickname>
+  <photo>nobody.jpg</photo>
+  <homepage nil="true"></homepage>
+  <office-address>via sommarive, 5</office-address>
+  <office-num>D44</office-num>
+  <office-phone>0461444444</office-phone>
+  <office-fax>0461555555</office-fax>
+  <roles type="array"></roles>
+</user>

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

@@ -0,0 +1,15 @@
+{
+ "uuid": "6a002a40-bc63-4095-9bb0-f31bf386bf55",
+ "email":"admin@example.org",
+ "first_name":"John",
+ "last_name":"Smith",
+ "nickname":"john.smith",
+ "photo": "avatar.jpg",
+ "homepage":"http://john.smith.example.org",
+ "office_address":"via sommarive, 5",
+ "office_num":"D14",
+ "office_phone":"0461012345",
+ "office_fax":"0461540123",
+ "roles":["admin","whatever"]
+}
+

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

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<user>
+  <uuid>6a002a40-bc63-4095-9bb0-f31bf386bf55</uuid>
+  <email>admin@example.org</email>
+  <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>
+  <office-address>via sommarive, 5</office-address>
+  <office-num>D14</office-num>
+  <office-phone>0461012345</office-phone>
+  <office-fax>0461540123</office-fax>
+  <roles type="array">
+    <role>admin</role>
+    <role>whatever</role>
+  </roles>
+</user>

data/spec/disiid_user_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+require 'user'
+
+# admin@example.org
+# 6a002a40-bc63-4095-9bb0-f31bf386bf55
+# admin
+
+# nobody@example.org
+# 596568c5-d6e7-4328-815c-c532aeed1198
+# no role
+ 
+describe DisiidUser do
+  
+  before { @user = User.new }
+    
+  it 'should return correct version string' do
+    DisiidUser.version_string.should == "DisiidUser version #{DisiidUser::VERSION}"
+  end
+  
+  it 'should extract uuid from identity_url' do
+    @user.identity_url = "http://openid.provider.local/users/6a002a40-bc63-4095-9bb0-f31bf386bf55"
+    @user.uuid.should == "6a002a40-bc63-4095-9bb0-f31bf386bf55"
+  end
+  
+  it 'should return nil if identity_url is of unknown nature' do
+    @user.identity_url = "http://openid.provider.local/6a002a40-bc63-4095-9bb0-f31bf386bf55"
+    @user.uuid.should be_nil
+  end
+  
+  it 'should return nil if identity_url is not defined' do
+    @user.identity_url = ""
+    @user.uuid.should be_nil
+    
+    # uuid is not memorized so we're safe to reuse @user instance
+    @user.identity_url = nil
+    @user.uuid.should be_nil
+  end
+  
+  context "with local roles" do
+    
+    it 'should correctly parse :role attribute' do
+      @user.role = 1
+      @user.local_roles.should include 'admin'
+      @user.local_roles.length.should == 1
+      
+      @user.role = 3
+      @user.local_roles.should include 'admin'
+      @user.local_roles.should include 'manager'
+      @user.local_roles.length.should == 2
+    end
+    
+    it 'should correctly set :role attribute' do
+      @user.local_roles = 'admin', 'manager'
+      @user.role.should == 3
+      
+      @user.local_roles = ['manager']
+      @user.role.should == 2
+    end
+    
+    describe 'has_role?() method' do
+    
+      it 'should use roles()' do
+        @user.should_receive(:roles).at_least(:once).and_return([])
+        @user.has_role?("does't matter")
+      end
+      
+      context 'when admin' do
+        before { @user.role = 1 }
+        
+        it 'should always return true' do
+          @user.has_role?('admin').should be true
+          @user.has_role?('manager').should be true
+        end
+      end
+      
+      context 'when manager' do
+        before { @user.local_roles = :manager }
+        
+        it 'should not be admin' do
+          @user.has_role?(:admin).should_not be true
+        end
+        
+        it 'should not be something else' do
+          @user.has_role?('something').should_not be true
+        end
+        
+        it 'should be manager' do
+          @user.has_role?('manager').should be true
+        end
+      end # context 'when manager'
+    end # describe 'has_role?() method'
+  end # context "with local roles"
+  
+  context 'with remote user' do
+    before { DisiidUser::RemoteUser.auth_token = 'sometoken' }
+    
+    it 'should fetch it using find()' do
+      DisiidUser::RemoteUser.should_receive(:find).with('some-uuid', :params => hash_including(:auth_token => 'sometoken'))
+      @user.identity_url = "http://host/users/some-uuid"
+      @user.remote_user
+    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
+        @user.remote_user.should be_nil
+      end
+      
+      it 'should return nil for remote attributes' do
+        @user.email.should be_nil
+        @user.homepage.should be_nil
+        @user.first_name.should be_nil
+        @user.last_name.should be_nil
+      end
+    end
+    
+    context 'when exists' do
+      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
+    
+      it 'should get all roles, including remote' do
+        @user.local_roles = 'manager'
+        @user.roles.should include 'admin' # remote
+        @user.roles.should include 'manager' # local
+      end
+    
+      it 'should not have duplicated roles' do
+        @user.local_roles = 'admin', 'manager'
+        # this remote user has two roles, :admin and :whatever
+        # spec/6a002a40-bc63-4095-9bb0-f31bf386bf55.xml
+        %w(admin manager whatever).each { |r|
+          @user.roles.should include r
+        }
+        @user.roles.length.should == 3 
+      end
+    end # context 'when exists'
+  end # context 'with remote user'
+end

data/spec/remote_user_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe DisiidUser::RemoteUser do
+  let(:remote_user_class) { DisiidUser::RemoteUser }
+  
+  it "should have :auth_token class attribute accessor" do
+    remote_user_class.auth_token = 'mysecrettoken'
+    remote_user_class.auth_token.should == 'mysecrettoken'
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'disiid_user'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

data/spec/stub_methods_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'user'
+
+# stub methods check
+describe Array do
+  it 'should return sum of array' do
+    [1,2,3,4].sum.should == 10
+    [10,20,30,40].sum.should == 100
+  end
+end

data/spec/user.rb

@@ -0,0 +1,38 @@
+# Method define in Activesupport
+class Array
+  def sum
+    return self.inject{|sum,x| sum + x }
+  end
+end
+
+# dummy User class for testing.
+# in real app it should be subclassed from ActiveRecord::Base 
+# and have at least these attributes:
+#   - role (Integer)
+#   - identity_url (String)
+class User
+  # stub methods and attributes
+  def self.named_scope(*args); end
+  attr_accessor :role, :identity_url
+  
+  include DisiidUser  
+end
+
+# Stub ActiveRecord so that it won't do real HTTP requests
+module ActiveResource
+  class Connection
+    # taps into ActiveRecord to read data from stub files
+    # instead of doing a real HTTP request
+    def get(path, *args)
+      record = /\/[^\/]+\/([^\/]+)/.match(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}")
+      nil
+    end
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification 
+name: disiid_user
+version: !ruby/object:Gem::Version 
+  hash: 13
+  prerelease: 
+  segments: 
+  - 2
+  - 0
+  - 1
+  version: 2.0.1
+platform: ruby
+authors: 
+- Danilo Severina
+- Alex Vagin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-16 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :runtime
+  version_requirements: *id004
+description: DISI - UniTN internal development
+email: 
+- tech@disi.unitn.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc-template
+- Gemfile
+- Rakefile
+- disiid_user.gemspec
+- lib/disiid_user.rb
+- lib/disiid_user/version.rb
+- spec/596568c5-d6e7-4328-815c-c532aeed1198.json
+- 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/user.rb
+has_rdoc: true
+homepage: http://disi.unitn.it
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: disiid_user
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: DISI ID global user
+test_files: 
+- spec/596568c5-d6e7-4328-815c-c532aeed1198.json
+- 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/user.rb