<commit_before>#!/usr/bin/env python
# -*- coding: utf-8 -*-

# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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.

"""
Hotel California

In this example we show how to keep people in the same room. Following command
is used:

- command: open
- response: **Hotel California** mode activated!

- command: close
- response: **Hotel California** mode deactivated!

- command: hotel
- provides current status of the hotel: open or close

To run this script you have to provide a custom configuration, or set
environment variables instead::

- ``CHAT_ROOM_MODERATORS`` - Mention at least your e-mail address
- ``CISCO_SPARK_BOT_TOKEN`` - Received from Cisco Spark on bot registration
- ``CISCO_SPARK_TOKEN`` - Your personal Cisco Spark token
- ``SERVER_URL`` - Public link used by Cisco Spark to reach your server

The token is specific to your run-time, please visit Cisco Spark for
Developers to get more details:

    https://developer.ciscospark.com/

The other token should be associated to a human being, and not to a bot.
This is required so that the software can receive all events for a chat space.
Without it, the bot may not see who is leaving or joining.

For example, if you run this script under Linux or macOs with support from
ngrok for exposing services to the Internet::

    export CHAT_ROOM_MODERATORS="<EMAIL>"
    export CISCO_SPARK_BOT_TOKEN="<token id from Cisco Spark for Developers>"
    export CISCO_SPARK_TOKEN="<personal token id from Cisco Spark>"
    export SERVER_URL="http://1a107f21.ngrok.io"
    python hotel_california.py


Credit: https://github.com/flint-bot/flint
"""

import os
import time

from shellbot import ShellBot, Context, Command
Context.set_logger()

#
# create a bot and load commands
#


class Open(Command):
    keyword = 'open'
    information_message = u"Open Hotel California"

    def execute(self, arguments=None):
        if self.bot.get('hotel_california.state', 'off') == 'on':
            self.bot.say('Hotel California mode is already activated!')
        else:
            self.bot.set('hotel_california.state', 'on')
            self.bot.say('Hotel California mode activated!')


class Close(Command):
    keyword = 'close'
    information_message = u"Close Hotel California"

    def execute(self, arguments=None):
        if self.bot.get('hotel_california.state', 'off') == 'off':
            self.bot.say('Hotel California mode is already deactivated!')
        else:
            self.bot.set('hotel_california.state', 'off')
            self.bot.say('Hotel California mode deactivated!')


class Hotel(Command):
    keyword = 'hotel'
    information_message = u"Get status of Hotel California"

    def execute(self, arguments=None):
        if self.bot.get('hotel_california.state', 'off') == 'off':
            self.bot.say('Hotel California will let you escape')
        else:
            self.bot.say('Hotel California will keep you here forever!')


bot = ShellBot(commands=[Open(), Close(), Hotel()])

# load configuration
#
os.environ['BOT_ON_START'] = 'On a dark desert highway, cool wind in my hair...'
os.environ['CHAT_ROOM_TITLE'] = 'Hotel California'
bot.configure()

# initialise a chat room
#
bot.bond(reset=True)

# add stickiness to the hotel
#

class Magic(object):

    def __init__(self, bot):
        self.bot = bot
        self.addresses = set()

    def on_join(self, received):

        if received.actor_address not in self.addresses:
            self.addresses.add(received.actor_address)
            self.bot.say(u"Welcome to Hotel California, {}".format(received.actor_label))

    def on_leave(self, received):

        if self.bot.get('hotel_california.state', 'off') == 'off':
            self.addresses.discard(received.actor_address)
            self.bot.say('On a dark desert highway, cool wind in my hair...')

        else:
            self.bot.say('Such a lovely place...')
            time.sleep(5)
            self.bot.add_participant(received.actor_address)
            self.bot.say(
                u'{}, you can check out any time you like, but you can never leave!'.format(received.actor_label),
                content=u'<@personEmail:{}|{}>, you can **check out any time you like**, but you can **never** leave!'.format(received.actor_address, received.actor_label))

magic = Magic(bot=bot)
bot.register('join', magic)
bot.register('leave', magic)

# run the bot
#
bot.run()

# delete the chat room when the bot is stopped
#
bot.dispose()<commit_msg>introduce engine to examples/hotel_california<commit_after>#!/usr/bin/env python
# -*- coding: utf-8 -*-

# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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.

"""
Hotel California

In this example we show how to keep people in the same room. Following command
is used:

- command: open
- response: **Hotel California** mode activated!

- command: close
- response: **Hotel California** mode deactivated!

- command: hotel
- provides current status of the hotel: open or close

To run this script you have to provide a custom configuration, or set
environment variables instead::

- ``CHAT_ROOM_MODERATORS`` - Mention at least your e-mail address
- ``CISCO_SPARK_BOT_TOKEN`` - Received from Cisco Spark on bot registration
- ``CISCO_SPARK_TOKEN`` - Your personal Cisco Spark token
- ``SERVER_URL`` - Public link used by Cisco Spark to reach your server

The token is specific to your run-time, please visit Cisco Spark for
Developers to get more details:

    https://developer.ciscospark.com/

The other token should be associated to a human being, and not to a bot.
This is required so that the software can receive all events for a chat space.
Without it, the bot may not see who is leaving or joining.

For example, if you run this script under Linux or macOs with support from
ngrok for exposing services to the Internet::

    export CHAT_ROOM_MODERATORS="<EMAIL>"
    export CISCO_SPARK_BOT_TOKEN="<token id from Cisco Spark for Developers>"
    export CISCO_SPARK_TOKEN="<personal token id from Cisco Spark>"
    export SERVER_URL="http://1a107f21.ngrok.io"
    python hotel_california.py


Credit: https://github.com/flint-bot/flint
"""

import os
import time

from shellbot import Engine, ShellBot, Context, Command
Context.set_logger()

#
# create a bot and load commands
#


class Open(Command):
    keyword = 'open'
    information_message = u"Open Hotel California"

    def execute(self, bot, arguments=None):
        if bot.engine.get('hotel_california.state', 'off') == 'on':
            bot.say('Hotel California mode is already activated!')
        else:
            bot.engine.set('hotel_california.state', 'on')
            bot.say('Hotel California mode activated!')


class Close(Command):
    keyword = 'close'
    information_message = u"Close Hotel California"

    def execute(self, bot, arguments=None):
        if bot.engine.get('hotel_california.state', 'off') == 'off':
            bot.say('Hotel California mode is already deactivated!')
        else:
            bot.engine.set('hotel_california.state', 'off')
            bot.say('Hotel California mode deactivated!')


class Hotel(Command):
    keyword = 'hotel'
    information_message = u"Get status of Hotel California"

    def execute(self, bot, arguments=None):
        if bot.engine.get('hotel_california.state', 'off') == 'off':
            bot.say('Hotel California will let you escape')
        else:
            bot.say('Hotel California will keep you here forever!')


engine = Engine(commands=[Open(), Close(), Hotel()])

# load configuration
#
os.environ['BOT_ON_START'] = 'On a dark desert highway, cool wind in my hair...'
os.environ['CHAT_ROOM_TITLE'] = 'Hotel California'
engine.configure()

# initialise a chat room
#
bot = engine.bond(reset=True)

# add stickiness to the hotel
#

class Magic(object):

    def __init__(self, bot):
        self.bot = bot
        self.addresses = set()

    def on_join(self, received):

        if received.actor_address not in self.addresses:
            self.addresses.add(received.actor_address)
            self.bot.say(u"Welcome to Hotel California, {}".format(received.actor_label))

    def on_leave(self, received):

        if self.bot.engine.get('hotel_california.state', 'off') == 'off':
            self.addresses.discard(received.actor_address)
            self.bot.say('On a dark desert highway, cool wind in my hair...')

        else:
            self.bot.say('Such a lovely place...')
            time.sleep(5)
            self.bot.add_participant(received.actor_address)
            self.bot.say(
                u'{}, you can check out any time you like, but you can never leave!'.format(received.actor_label),
                content=u'<@personEmail:{}|{}>, you can **check out any time you like**, but you can **never** leave!'.format(received.actor_address, received.actor_label))

magic = Magic(bot=bot)
engine.subscribe('join', magic)
engine.subscribe('leave', magic)

# run the bot
#
engine.run()

# delete the chat room when the bot is stopped
#
bot.dispose()
{'fraction_non_alphanumeric': 0.10222264801686147, 'fraction_numerical': 0.0022992910519256562, 'mean_word_length': 3.4383503401360542, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4864607', 'n_tokens_mistral': 3041, 'n_tokens_neox': 2945, 'n_words': 1097}