app/soc/modules/seeder/logic/providers/email.py

# Copyright 2010 the Melange authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Module containing data providers for UserProperty."""

from django.core.validators import email_re

from soc.modules.seeder.logic.providers.provider import BaseDataProvider
from soc.modules.seeder.logic.providers.provider import FixedValueProvider
from soc.modules.seeder.logic.providers.provider import ParameterValueError


class EmailProvider(BaseDataProvider):
  """Base class for all data providers that return an e-mail."""


class FixedEmailProvider(EmailProvider, FixedValueProvider):
  """Data provider that returns a fixed e-mail."""

  def checkParameters(self):
    super(FixedEmailProvider, self).checkParameters()
    value = self.param_values.get('value', None)
    try:
      if not email_re.match(value):
        raise ValueError
    except (TypeError, ValueError):
      raise ParameterValueError('%s is not a valid e-mail address' % value)


class UniqueEmailProvider(EmailProvider):
  """Data provider that returns a unique email address."""

  counter = 0

  @staticmethod
  def getUsername():
    """Returns a unique username for the generated email address."""
    UniqueEmailProvider.counter += 1
    return 'username%s' % UniqueEmailProvider.counter

  @staticmethod
  def getRandomDomain():
    """Returns a random domain for a link."""
    #TODO(sttwister): Really return a random domain
    return "gmail.com"

  def getValue(self):
    return '%s@%s' % (
        UniqueEmailProvider.getUsername(),
        UniqueEmailProvider.getRandomDomain())