basic features

11 files changed, 147 insertions, 38 deletions

diff --git a/.gitignore b/.gitignore
index 68bc17f..eb701d6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,7 @@
+foursquare/location_example.json
+config.ini
+.idea/
+fsq_poi.db
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..2d13273
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1 @@
+FROM python:3
diff --git a/README b/README
index 6c8ffd4..9b00713 100644
--- a/README
+++ b/README
@@ -1,3 +1,13 @@
 # Swarm2Fediverse
 
 Foursquare Swarm like Telegram bot to checkin at places and post to Fediverse (Mastodon/Pleroma)
+
+TODO:
+
+- Attach up to four images to each checkin
+- Set default checkin visibility to followers-only and add option to set individual checkin visibility
+- Amazon .bot domain
+- i18n
+- Anonymized analysis
+- OAuth login to Mastodon/Pleroma
+- Delayed checkins
diff --git a/bot.py b/bot.py
index 517f810..398e433 100644
--- a/bot.py
+++ b/bot.py
@@ -8,6 +8,7 @@ Basic example for a bot that uses inline keyboards. For an in-depth explanation,
 """
 import logging
 
+import telegram.constants
 from telegram import __version__ as TG_VER
 
 try:
@@ -22,7 +23,12 @@ if __version_info__ < (20, 0, 0, "alpha", 1):
         f"visit https://docs.python-telegram-bot.org/en/v{TG_VER}/examples.html"
     )
 from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update
-from telegram.ext import Application, CallbackQueryHandler, CommandHandler, ContextTypes
+from telegram.ext import Application, CallbackQueryHandler, CommandHandler, ContextTypes, MessageHandler, filters
+
+from config import BOT_TOKEN
+from foursquare.query_poi import query_poi
+from dbstore.dbm_store import get_loc
+from toot import mastodon_client
 
 # Enable logging
 logging.basicConfig(
@@ -32,29 +38,39 @@ logger = logging.getLogger(__name__)
 
 
 async def start(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
-    """Sends a message with three inline buttons attached."""
-    keyboard = [
-        [
-            InlineKeyboardButton("Option 1", callback_data="1"),
-            InlineKeyboardButton("Option 2", callback_data="2"),
-        ],
-        [InlineKeyboardButton("Option 3", callback_data="3")],
-    ]
+    hello = "Hello, this is `checkin.bot`. \n\n" \
+            "This is a Telegram bot with functionality similar to Foursquare Swarm, " \
+            "but check in and post your location to the Fediverse (Mastodon/Pleroma) instead of Twitter.\n\n" \
+            "Aware of privacy concerns, this bot will not store your location data."\
+            "*Be safe and cautious when sharing your real time location on the web.* \n\n"\
+            "Start using this bot by sharing your location using Telegram context menu to it."
 
-    reply_markup = InlineKeyboardMarkup(keyboard)
+    await update.message.reply_text(hello, parse_mode=telegram.constants.ParseMode.MARKDOWN)
 
-    await update.message.reply_text("Please choose:", reply_markup=reply_markup)
+
+async def checkin(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
+    keyboard = []
+
+    for poi in query_poi(update.message.location.latitude, update.message.location.longitude):
+        keyboard.append([
+            InlineKeyboardButton(poi["name"], callback_data=poi["fsq_id"]),
+        ])
+
+    reply_markup = InlineKeyboardMarkup(keyboard)
+    await update.message.reply_text("Select a place", reply_markup=reply_markup)
 
 
 async def button(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
     """Parses the CallbackQuery and updates the message text."""
     query = update.callback_query
 
-    # CallbackQueries need to be answered, even if no notification to the user is needed
-    # Some clients may have trouble otherwise. See https://core.telegram.org/bots/api#callbackquery
     await query.answer()
+    poi = get_loc(query.data)
+
+    mastodon_client.status_post(f"I'm at {poi['name']} in {poi['locality']}, {poi['region']}, \n[OSM]({poi['osm_url']})",
+                                visibility="private")
 
-    await query.edit_message_text(text=f"Selected option: {query.data}")
+    await query.edit_message_text(text=f"Selected option: {poi}")
 
 
 async def help_command(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
@@ -63,12 +79,11 @@ async def help_command(update: Update, context: ContextTypes.DEFAULT_TYPE) -> No
 
 
 def main() -> None:
-    """Run the bot."""
-    # Create the Application and pass it your bot's token.
-    application = Application.builder().token("TOKEN").build()
+    application = Application.builder().token(BOT_TOKEN).build()
 
     application.add_handler(CommandHandler("start", start))
     application.add_handler(CallbackQueryHandler(button))
+    application.add_handler(MessageHandler(filters.LOCATION & ~filters.COMMAND, checkin))
     application.add_handler(CommandHandler("help", help_command))
 
     # Run the bot until the user presses Ctrl-C
diff --git a/config.ini.example b/config.ini.example
new file mode 100644
index 0000000..4c29644
--- /dev/null
+++ b/config.ini.example
@@ -0,0 +1,9 @@
+[DEFAULT]
+BOT_TOKEN =
+FOURSQUARE_API_KEY =
+
+[TOOT]
+CLIENT_ID =
+CLIENT_SECRET =
+API_BASE_URL = https://mastodon.social
+ACCESS_TOKEN =
diff --git a/config.py b/config.py
new file mode 100644
index 0000000..a403db0
--- /dev/null
+++ b/config.py
@@ -0,0 +1,13 @@
+# https://docs.python.org/3/library/configparser.html
+
+import configparser
+config = configparser.ConfigParser()
+config.read("config.ini")
+
+BOT_TOKEN = config["DEFAULT"]["BOT_TOKEN"]
+FSQ_API_KEY = config["DEFAULT"]["FOURSQUARE_API_KEY"]
+
+TOOT_API_BASE_URL = config["TOOT"]["API_BASE_URL"]
+TOOT_CLIENT_ID = config["TOOT"]["CLIENT_ID"]
+TOOT_CLIENT_SECRET = config["TOOT"]["CLIENT_SECRET"]
+TOOT_ACCESS_TOKEN = config["TOOT"]["ACCESS_TOKEN"]
diff --git a/dbstore/dbm_store.py b/dbstore/dbm_store.py
new file mode 100644
index 0000000..fedb505
--- /dev/null
+++ b/dbstore/dbm_store.py
@@ -0,0 +1,34 @@
+import dbm
+
+db = None
+store_file = "fsq_poi.db"
+
+
+def get_loc(fsq_id):
+    global db
+    if db is None:
+        db = dbm.open(store_file, 'c')
+    if fsq_id in db:
+        res = db[fsq_id].decode("utf-8").split("|")
+        return {
+            "name": res[0],
+            "locality": res[1],
+            "region": res[2],
+            "latitude": res[3],
+            "longitude": res[4],
+            "osm_url": res[5],
+        }
+    else:
+        return None
+
+
+def store_loc(loc):
+    global db
+    if db is None:
+        db = dbm.open(store_file, 'c')
+    db[loc["fsq_id"]] = "{}|{}|{}|{}|{}|{}".format(loc["name"],
+                                                   loc["locality"],
+                                                   loc["region"],
+                                                   loc["latitude"],
+                                                   loc["longitude"],
+                                                   loc["osm_url"])
diff --git a/foursquare/query_poi.py b/foursquare/query_poi.py
new file mode 100644
index 0000000..efdd1b1
--- /dev/null
+++ b/foursquare/query_poi.py
@@ -0,0 +1,33 @@
+import requests
+import json
+from config import FSQ_API_KEY
+from dbstore.dbm_store import get_loc, store_loc
+
+POI_API_ENDPOINT = "https://api.foursquare.com/v3/places/nearby?ll={}%2C{}"
+OSM_ENDPOINT = "https://www.openstreetmap.org/?mlat={}&mlon={}&zoom=15&layers=M"
+
+def query_poi(latitude, longitude):
+    locations = list()
+
+    url = POI_API_ENDPOINT.format(latitude, longitude)
+    headers = {
+        "accept": "application/json",
+        "Authorization": FSQ_API_KEY
+    }
+
+    response = requests.get(url, headers=headers)
+
+    for poi in json.loads(response.text)["results"]:
+        loc = {
+            "fsq_id": poi["fsq_id"],
+            "name": poi["name"],
+            "locality": poi["location"]["locality"],
+            "region": poi["location"]["region"],
+            "latitude": poi["geocodes"]["main"]["latitude"],
+            "longitude": poi["geocodes"]["main"]["longitude"],
+            "osm_url": OSM_ENDPOINT.format(poi["geocodes"]["main"]["latitude"], poi["geocodes"]["main"]["longitude"])
+        }
+        locations.append(loc)
+        store_loc(loc)
+
+    return locations
diff --git a/mastodon/__init__.py b/mastodon/__init__.py
deleted file mode 100644
index e69de29..0000000
--- a/mastodon/__init__.py
+++ /dev/null
diff --git a/mastodon/toot.py b/mastodon/toot.py
deleted file mode 100644
index 2d07f0b..0000000
--- a/mastodon/toot.py
+++ /dev/null
@@ -1,21 +0,0 @@
-from mastodon import Mastodon
-
-'''
-https://mastodonpy.readthedocs.io/en/stable/index.html
-
-Mastodon.create_app(
-    'pytooterapp',
-    api_base_url = 'https://mastodon.social',
-    to_file = 'pytooter_clientcred.secret'
-)
-'''
-
-# mastodon = Mastodon(client_id = 'pytooter_clientcred.secret',)
-# mastodon.log_in(
-#     '[email protected]',
-#     'incrediblygoodpassword',
-#     to_file = 'pytooter_usercred.secret'
-# )
-
-mastodon = Mastodon(access_token = 'pytooter_usercred.secret')
-mastodon.toot('Tooting from Python using #mastodonpy !')
\ No newline at end of file
diff --git a/toot.py b/toot.py
new file mode 100644
index 0000000..f1db858
--- /dev/null
+++ b/toot.py
@@ -0,0 +1,11 @@
+from mastodon import Mastodon
+from config import TOOT_API_BASE_URL, TOOT_CLIENT_SECRET, TOOT_ACCESS_TOKEN, TOOT_CLIENT_ID
+
+'''
+https://mastodonpy.readthedocs.io/en/stable/index.html
+'''
+
+mastodon_client = Mastodon(client_id=TOOT_CLIENT_ID,
+                           client_secret=TOOT_CLIENT_SECRET,
+                           api_base_url=TOOT_API_BASE_URL,
+                           access_token=TOOT_ACCESS_TOKEN)