@@ -1,4 +1,4 @@ -Copyright (c) 2006 Daniel Morrison, Collective Idea +Copyright (c) 2006-2007 Daniel Morrison, Collective Idea http://collectiveidea.com Permission is hereby granted, free of charge, to any person obtaining MIT-LICENSE @@ -3,7 +3,7 @@ IMAPAuthenticatable A quick library for authenticating against an IMAP server. -It expects a model with a 'username' column You must pass a host. +It expects a model with a 'username' column (or method). You must pass a host. Example: @@ -17,7 +17,7 @@ end other options: :allow_new_users => true/false Alters whether to use find_by_username or find_or_create_by_username. - The default is true. + The default is true (find or create). :default_domain => 'example.com' What usernames have at the end. Defaults to the :host option. @@ -26,4 +26,11 @@ other options: The default is false (always remove). -Other options may be added as need arises. \ No newline at end of file +Other options may be added as need arises. + +Testing: + +To mock the IMAP login in your tests, add the following line to the top of your test_helper.rb + require File.join(File.dirname(__FILE__), '..', 'vendor', 'plugins', 'imap_authenticatable', 'test', 'mocks', 'imap.rb') + +This mock makes the valid password the reverse of the username (username.reverse). \ No newline at end of file README @@ -1 +1 @@ -puts "\nAdd the following line to the top of your lib/authenticated_test_helper.rb\n\trequire File.dirname(__FILE__) + '/../vendor/plugins/imap_authenticatable/test/mocks/imap.rb'\n" \ No newline at end of file +puts IO.read(File.join(File.dirname(__FILE__), 'README')) \ No newline at end of file install.rb e9b247a6bb628e4545bc3e9b5e66cc98de83ff1b Daniel Morrison daniel@collectiveidea.com http://github.com/collectiveidea/imap_authenticatable/commit/b82e14da958163b55216c1057f60ca6412731c7a b82e14da958163b55216c1057f60ca6412731c7a 2007-02-07T17:25:14-08:00 2007-02-07T17:25:14-08:00 Updated readme and such 993e48640cefb7f00d8a2ad20a7654c8de4d2e58 Daniel Morrison daniel@collectiveidea.com