crowd-stefanwille 0.5.8 → 0.5.9

data/README.rdoc

@@ -1,26 +1,26 @@
 = crowd
-    updated by Stefan Wille <post@stefanwille.com>
-    updated by Olli Helenius <liff@iki.fi>
-    updated by Evgeny Zislis (evgeny.zislis@gmail.com)
-    original by Jason Rimmer (jrimmer@irth.net) & gemified for rubyforge by Daniel Morrison (http://collectiveidea.com)
-
-== DESCRIPTION:
 
 A client for Atlassian[http://www.atlassian.com] Crowd[http://www.atlassian.com/crowd] v2.0.5
 
-=== NOTES:
-WSDL stub generated with:
-  rake wsdl2ruby
-  
-RSpec tests run with:
-  rake test
-  (requires a Crowd server on localhost, easy to setup)  
-  
-Local gem installed with:
-  rake install
-    
+== INSTALL:
 
-Original SOAP API is available from Atlassian at http://confluence.atlassian.com/display/CROWDDEV/SOAP+API
+  sudo gem install crowd-stefanwille
+
+== REQUIREMENTS:
+
+* Ruby v1.8.6
+* soap4r[http://dev.ctor.org/soap4r] v1.5.8
+* Atlassian Crowd[http://atlassian.com/crowd] v2.0
+
+== USE:
+
+See demo/crowd_demo.rb and spec/crowd_spec.rb.
+
+Assumptions (used in demo/crowd_demo.rb and spec/crowd_spec.rb):
+
+* Crowd Server is on localhost, port 8095
+* Application name and password is 'soaptest'
+* Application 'soaptest' directory set to 'True'
 
 == FEATURES:
 
@@ -69,11 +69,19 @@ Methods exercised (*implemented*, not implemented):
 
 Role related methods were left in the Ruby API but are not tested. Roles are deprecated in favor of groups in Crowd 2.0
 
-Assumptions (configured in CrowdTest.rb):
+=== NOTES:
+WSDL stub generated with:
+  rake wsdl2ruby
+  
+RSpec tests run with:
+  rake test
+  (requires a Crowd server on localhost, easy to setup)  
+  
+Local gem installed with:
+  rake install
+    
 
-* Crowd Server is on localhost, port 8095
-* Application name and password is 'soaptest'
-* Application 'soaptest' directory set to 'True'
+Original SOAP API is available from Atlassian at http://confluence.atlassian.com/display/CROWDDEV/SOAP+API
 
 == TODO:
 
@@ -84,16 +92,6 @@ Assumptions (configured in CrowdTest.rb):
 
 Ruby client for Atlassian Crowd 2.0.5
 
-== REQUIREMENTS:
-
-* Ruby v1.8.6
-* soap4r[http://dev.ctor.org/soap4r] v1.5.8
-* Atlassian Crowd[http://atlassian.com/crowd] v2.0
-
-== INSTALL:
-
-  sudo gem install crowd2
-
 == FILES:
 
 * <tt>README.rdoc</tt> - You're soaking in it
@@ -106,6 +104,16 @@ Ruby client for Atlassian Crowd 2.0.5
 * <tt>lib/crowd/soap/default.rb</tt> - Generated
 * <tt>lib/crowd/soap/SecurityServerClient.rb</tt> - Generated
 
+== AUTHORS:
+
+updated by Stefan Wille <post@stefanwille.com>
+
+updated by Olli Helenius <liff@iki.fi>
+
+updated by Evgeny Zislis (evgeny.zislis@gmail.com)
+
+original by Jason Rimmer (jrimmer@irth.net) & gemified for rubyforge by Daniel Morrison (http://collectiveidea.com)
+
 == LICENSE:
 
 Public Domain

data/Rakefile

@@ -28,13 +28,15 @@ begin
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "crowd-stefanwille"
     gemspec.version = Crowd::Version::STRING
-    gemspec.summary = "Ruby client for Atlassian Crowd"
-    gemspec.description = "A client for Atlassian[http://www.atlassian.com] Crowd[http://www.atlassian.com/crowd] v2.0.5"
+    gemspec.summary = "Ruby client for Atlassian Crowd 2.0"
+    gemspec.description = "A client for Atlassian[http://www.atlassian.com] Crowd[http://www.atlassian.com/crowd] v2.0. Tested with Crowd 2.0.2 and 2.0.5."
     gemspec.email = "post @nospam@ stefanwille.com"
     gemspec.homepage = "http://github.com/stefanwille/crowd"
     gemspec.authors = ["Stefan Wille", "Evgeny Zislis", "Jason Rimmer & Daniel Morrison"]
     gemspec.add_dependency('soap4r')
     gemspec.add_development_dependency('rspec')
+    # Silence a warning about missing rubyforge_project
+    gemspec.rubyforge_project = "nowarning"
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"

data/{stefanwille-crowd.gemspec → crowd-stefanwille.gemspec}

@@ -4,13 +4,13 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{stefanwille-crowd}
-  s.version = "0.5.8"
+  s.name = %q{crowd-stefanwille}
+  s.version = "0.5.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stefan Wille", "Evgeny Zislis", "Jason Rimmer & Daniel Morrison"]
-  s.date = %q{2010-07-14}
-  s.description = %q{A client for Atlassian[http://www.atlassian.com] Crowd[http://www.atlassian.com/crowd] v2.0.5}
+  s.date = %q{2010-07-20}
+  s.description = %q{A client for Atlassian[http://www.atlassian.com] Crowd[http://www.atlassian.com/crowd] v2.0. Tested with Crowd 2.0.2 and 2.0.5.}
   s.email = %q{post @nospam@ stefanwille.com}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
      "History.txt",
      "README.rdoc",
      "Rakefile",
+     "crowd-stefanwille.gemspec",
      "demo/crowd_demo.rb",
      "lib/crowd.rb",
      "lib/crowd/http/request.rb",
@@ -30,15 +31,16 @@ Gem::Specification.new do |s|
      "lib/crowd/soap/default.rb",
      "lib/crowd/soap/driver.rb",
      "lib/crowd/soap/mapping_registry.rb",
+     "lib/crowd/user_attribute_keys.rb",
      "lib/crowd/version.rb",
-     "spec/crowd_spec.rb",
-     "stefanwille-crowd.gemspec"
+     "spec/crowd_spec.rb"
   ]
   s.homepage = %q{http://github.com/stefanwille/crowd}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
+  s.rubyforge_project = %q{nowarning}
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Ruby client for Atlassian Crowd}
+  s.summary = %q{Ruby client for Atlassian Crowd 2.0}
   s.test_files = [
     "spec/crowd_spec.rb"
   ]

data/lib/crowd.rb

@@ -10,26 +10,10 @@ require 'base64'
 require 'rubygems'
 gem 'soap4r'
 
+require File.join(File.dirname(__FILE__), 'crowd', 'user_attribute_keys')
 require File.join(File.dirname(__FILE__), 'crowd', 'version')
 require File.join(File.dirname(__FILE__), 'crowd', 'soap', 'driver.rb')
 
-#
-# Place 'server.wiredump_dev = STDERR' after any to see
-# the raw SOAP calls and responses in a test console
-#
-
-# public static final String USERNAME = "username";
-# public static final String FIRSTNAME = "givenName";
-# public static final String LASTNAME = "sn";
-# public static final String DISPLAYNAME = "displayName";
-# public static final String EMAIL = "mail";
-# public static final String ICON_LOCATION = "iconLocation";
-# public static final String PASSWORD_LASTCHANGED = "passwordLastChanged";
-# public static final String LAST_AUTHENTICATED = "lastAuthenticated";
-# public static final String INVALID_PASSWORD_ATTEMPTS = "invalidPasswordAttempts";
-# public static final String REQUIRES_PASSWORD_CHANGE = "requiresPasswordChange";
-# public static final String ACTIVE = "active";
-# 
 
 class Crowd
 
@@ -42,25 +26,71 @@ class Crowd
   # Class variables
   #
   private
-      
+  
   @@application_token = nil
   @@crowd_app_name = nil
   @@crowd_app_pword = nil
-  
-  public
-  
   @@crowd_url = nil
+  @@crowd_session_tokenkey = 'crowd.token_key'
+  @@crowd_session_validationinterval = 0
+  @@crowd_session_lastvalidation = 'session.lastvalidation'
+    
+  public
   
+  #
+  # Configuration      
+  #
+      
+  ''' 
+  The URL to use when connecting with the integration libraries to communicate with the Crowd server. 
+  '''
   def self.crowd_url=(value); @@crowd_url = value; end
+
+  ''' 
+  The name that the application will use when authenticating with the Crowd server. 
+  This needs to match the name you specified in Crowd server.
+  '''
   def self.crowd_app_name=(value); @@crowd_app_name = value; end
+
+  ''' 
+  The password that the application will use when authenticating with the Crowd server. 
+  This needs to match the password you specified in Crowd server. 
+  '''
   def self.crowd_app_pword=(value); @@crowd_app_pword = value; end
   
+  #
+  # Relevant for SSO:
+  #
+  
+  ''' 
+  The number of minutes to cache authentication validation in the session. 
+  If this value is set to 0, each HTTP request will be authenticated with the Crowd server. 
+  '''
+  def self.crowd_session_validationinterval=(value); @@crowd_session_validationinterval = value; end
+
+  ''' 
+  The session key to use when storing a String value of the users authentication token. 
+  Has a good default.
+  '''
+  def self.crowd_session_tokenkey=(value); @@crowd_session_tokenkey = value; end
+
+  ''' 
+  The session key to use when storing a timestamp of the users last authentication.   
+  Has a good default.
+  '''
+  def self.crowd_session_lastvalidation=(value); @@crowd_session_lastvalidation = value; end
   
   # for testing
+  def self.application_token=(value); @@application_token = value; end
+  def self.application_token; @@application_token; end
   def self.crowd_url; @@crowd_url; end
   def self.crowd_app_name; @@crowd_app_name; end
   def self.crowd_app_pword; @@crowd_app_pword; end
-  def self.application_token; @@application_token; end
+
+  def self.crowd_session_tokenkey; @@crowd_session_tokenkey; end
+  def self.crowd_session_validationinterval; @@crowd_session_validationinterval; end
+  def self.crowd_session_lastvalidation; @@crowd_session_lastvalidation; end    
+
   
   public
   

data/lib/crowd/user_attribute_keys.rb

@@ -0,0 +1,20 @@
+class Crowd
+
+  #
+  # Keys for user attributes
+  #
+  module UserAttributeKeys
+    USERNAME = "username"
+    FIRSTNAME = "givenName"
+    LASTNAME = "sn"
+    DISPLAYNAME = "displayName"
+    EMAIL = "mail"
+    ICON_LOCATION = "iconLocation"
+    PASSWORD_LASTCHANGED = "passwordLastChanged"
+    LAST_AUTHENTICATED = "lastAuthenticated"
+    INVALID_PASSWORD_ATTEMPTS = "invalidPasswordAttempts"
+    REQUIRES_PASSWORD_CHANGE = "requiresPasswordChange"
+    ACTIVE = "active"
+  end
+
+end

data/lib/crowd/version.rb

@@ -2,7 +2,7 @@ class Crowd #:nodoc:
   module Version #:nodoc:
     MAJOR = 0
     MINOR = 5
-    TINY = 8
+    TINY = 9
   
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/crowd_spec.rb

@@ -11,15 +11,7 @@ gem 'soap4r'
 
 require File.join(File.dirname(__FILE__), '..', 'lib', 'crowd')
 
-# need a special accessor for tests
-class Crowd
-  def self.application_token
-    @@application_token
-  end
-  def self.application_token=(value)
-    @@application_token = value
-  end
-end
+include Crowd::UserAttributeKeys
 
 describe Crowd do
   before(:all) do
@@ -34,7 +26,7 @@ describe Crowd do
   
   it "should add a principal" do
     Crowd.add_principal('unittest','unittest','unit test user', true,
-      { 'mail' => 'unittest@unittest.com', 'givenName' => 'Unit', 'sn' => 'Test' }).should_not be_nil
+      { 'mail' => 'unittest@unittest.com', FIRSTNAME => 'Unit', LASTNAME => 'Test' }).should_not be_nil
   end
   
   it "should find valid principal by name" do
@@ -89,14 +81,14 @@ describe Crowd do
   #    Crowd.remove_role('test_role').should be_true
   #  end
    
-   it "should reset expired application token" do
+   it "should revalidate expired application token" do
      Crowd.application_token.token = 'fake'
      Crowd.application_token.token.should eql('fake')
      Crowd.find_principal_by_username('unittest')
      Crowd.application_token.token.should_not eql('fake')
    end
    
-   it "should validate principal token with invalid token" do
+   it "should invalidate principal token with invalid token" do
      Crowd.is_valid_principal_token?('invalid').should be_false
    end
     

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: crowd-stefanwille
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 5
-  - 8
-  version: 0.5.8
+  - 9
+  version: 0.5.9
 platform: ruby
 authors: 
 - Stefan Wille
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-14 00:00:00 +02:00
+date: 2010-07-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,7 +48,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-description: A client for Atlassian[http://www.atlassian.com] Crowd[http://www.atlassian.com/crowd] v2.0.5
+description: A client for Atlassian[http://www.atlassian.com] Crowd[http://www.atlassian.com/crowd] v2.0. Tested with Crowd 2.0.2 and 2.0.5.
 email: post @nospam@ stefanwille.com
 executables: []
 
@@ -61,6 +61,7 @@ files:
 - History.txt
 - README.rdoc
 - Rakefile
+- crowd-stefanwille.gemspec
 - demo/crowd_demo.rb
 - lib/crowd.rb
 - lib/crowd/http/request.rb
@@ -71,9 +72,9 @@ files:
 - lib/crowd/soap/default.rb
 - lib/crowd/soap/driver.rb
 - lib/crowd/soap/mapping_registry.rb
+- lib/crowd/user_attribute_keys.rb
 - lib/crowd/version.rb
 - spec/crowd_spec.rb
-- stefanwille-crowd.gemspec
 has_rdoc: true
 homepage: http://github.com/stefanwille/crowd
 licenses: []
@@ -103,10 +104,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: nowarning
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Ruby client for Atlassian Crowd
+summary: Ruby client for Atlassian Crowd 2.0
 test_files: 
 - spec/crowd_spec.rb