#!/usr/bin/env python3 import argparse import configparser import logging import os import foursquare from ics import Calendar, Event logging.basicConfig(level=logging.INFO, format="%(message)s") logger = logging.getLogger(__name__) current_dir = os.path.realpath(os.path.dirname(__file__)) CONFIG_FILE = os.path.join(current_dir, "config.ini") class FeedGenerator: fetch = "recent" def __init__(self, fetch="recent"): "Loads config, sets up Foursquare API client." self.fetch = fetch self._load_config(CONFIG_FILE) self.client = foursquare.Foursquare(access_token=self.api_access_token) def _load_config(self, config_file): "Set object variables based on supplied config file." config = configparser.ConfigParser() try: config.read_file(open(config_file)) except IOError: logger.critical("Can't read config file: " + config_file) exit() self.api_access_token = config.get("Foursquare", "AccessToken") self.ics_filepath = config.get("Local", "IcsFilepath") def generate(self): "Call this to fetch the data from the API and generate the file." if self.fetch == "all": checkins = self._get_all_checkins() else: checkins = self._get_recent_checkins() calendar = self._generate_calendar(checkins) with open(self.ics_filepath, "w") as f: f.writelines(calendar) exit(0) def _get_recent_checkins(self): "Make one request to the API for the most recent checkins." results = self._get_checkins_from_api() return results["checkins"]["items"] def _get_all_checkins(self): "Make multiple requests to the API to get ALL checkins." offset = 0 checkins = [] # Temporary total: total_checkins = 9999999999 while offset < total_checkins: results = self._get_checkins_from_api(offset) if offset == 0: # First time, set the correct total: total_checkins = results["checkins"]["count"] checkins += results["checkins"]["items"] offset += 250 return checkins def _get_checkins_from_api(self, offset=0): """Returns a list of recent checkins for the authenticated user. Keyword arguments: offset -- Integer, the offset number to send to the API. The number of results to skip. """ try: return self.client.users.checkins( params={"limit": 250, "offset": offset, "sort": "newestfirst"} ) except foursquare.FoursquareException as err: logger.error( "Error getting checkins, with offset of {}: {}".format(offset, err) ) exit(1) def _get_user_url(self): "Returns the Foursquare URL for the authenticated user." try: user = self.client.users() except foursquare.FoursquareException as err: logger.error("Error getting user: {}".format(err)) exit(1) return user["user"]["canonicalUrl"] def _generate_calendar(self, checkins): """Supplied with a list of checkin data from the API, generates an ics Calendar object and returns it. Keyword arguments: checkins -- A list of dicts, each one data about a single checkin. """ user_url = self._get_user_url() c = Calendar() for checkin in checkins: if "venue" not in checkin: # I had some checkins with no data other than # id, createdAt and source. continue venue_name = checkin["venue"]["name"] tz_offset = self._get_checkin_timezone(checkin) e = Event() e.name = "@ {}".format(venue_name) e.location = venue_name e.url = "{}/checkin/{}".format(user_url, checkin["id"]) e.uid = "{}@foursquare.com".format(checkin["id"]) e.begin = checkin["createdAt"] # Use the 'shout', if any, and the timezone offset in the # description. description = [] if "shout" in checkin and len(checkin["shout"]) > 0: description = [checkin["shout"]] description.append("Timezone offset: {}".format(tz_offset)) e.description = "\n".join(description) # Use the venue_name and the address, if any, for the location. location = venue_name if "location" in checkin["venue"]: loc = checkin["venue"]["location"] if "formattedAddress" in loc and len(loc["formattedAddress"]) > 0: address = ", ".join(loc["formattedAddress"]) location = "{}, {}".format(location, address) e.location = location c.events.add(e) return c def _get_checkin_timezone(self, checkin): """Given a checkin from the API, returns a string representing the timezone offset of that checkin. In the API they're given as a number of minutes, positive or negative. e.g. if offset is 60, this returns '+01:00' if offset is 0, this returns '+00:00' if offset is -480, this returns '-08:00' Keyword arguments checkin -- A dict of data about a single checkin """ # In minutes, e.g. 60 or -480 minutes = checkin["timeZoneOffset"] # e.g. 1 or -8 hours = minutes / 60 # e.g. '01.00' or '-08.00' if hours >= 0: offset = "{:05.2f}".format(hours) symbol = "+" else: offset = "{:06.2f}".format(hours) symbol = "" # e.g. '+01:00' or '-08.00' return "{}{}".format(symbol, offset).replace(".", ":") if __name__ == "__main__": parser = argparse.ArgumentParser( description="Makes a .ics file from your Foursquare/Swarm checkins" ) parser.add_argument( "--all", help="Fetch all checkins, not only the most recent", required=False, action="store_true", default=False, ) args = parser.parse_args() if args.all: to_fetch = "all" else: to_fetch = "recent" generator = FeedGenerator(fetch=to_fetch) generator.generate() exit(0)