calendar-assistant 0.1.0

data/Rakefile

@@ -0,0 +1,9 @@
+#require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "concourse"
+
+Concourse.new("calendar-assistant").create_tasks!
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/calendar-assistant

@@ -0,0 +1,12 @@
+#! /usr/bin/env ruby
+
+require "calendar_assistant"
+
+Rainbow.enabled = true
+
+begin
+  CalendarAssistant::CLI.start ARGV
+rescue Google::Apis::AuthorizationError, CalendarAssistant::BaseException => e
+  printf "ERROR: %s\n", e
+  exit 1
+end

data/lib/calendar_assistant.rb

@@ -0,0 +1,202 @@
+# coding: utf-8
+require "google/apis/calendar_v3"
+require "json"
+require "yaml"
+require "business_time"
+require "rainbow"
+require "set"
+
+require "calendar_assistant/version"
+
+class CalendarAssistant
+  GCal = Google::Apis::CalendarV3
+
+  class BaseException < RuntimeError ; end
+
+  EMOJI_WORLDMAP  = "🗺" # U+1F5FA WORLD MAP
+  EMOJI_PLANE     = "🛪" # U+1F6EA NORTHEAST-POINTING AIRPLANE
+  EMOJI_1_1       = "👫" # MAN AND WOMAN HOLDING HANDS
+
+  DEFAULT_CALENDAR_ID = "primary"
+
+  attr_reader :service, :calendar, :config
+
+  def self.authorize profile_name
+    config = CalendarAssistant::Config.new
+    Authorizer.new(profile_name, config.token_store).authorize
+  end
+
+  def self.date_range_cast time_range
+    time_range.first.to_date..(time_range.last + 1.day).to_date
+  end
+
+  def initialize config=CalendarAssistant::Config.new
+    @config = config
+    @service = Authorizer.new(config.profile_name, config.token_store).service
+    @calendar = service.get_calendar DEFAULT_CALENDAR_ID
+  end
+
+  def find_events time_range
+    events = service.list_events(DEFAULT_CALENDAR_ID,
+                                 time_min: time_range.first.iso8601,
+                                 time_max: time_range.last.iso8601,
+                                 order_by: "startTime",
+                                 single_events: true,
+                                 max_results: 2000,
+                                )
+    if events.nil? || events.items.nil?
+      return []
+    end
+    events.items
+  end
+
+  def availability time_range
+    length = ChronicDuration.parse(config.setting(Config::Keys::Settings::MEETING_LENGTH))
+
+    start_of_day = Chronic.parse(config.setting(Config::Keys::Settings::START_OF_DAY))
+    start_of_day = start_of_day - start_of_day.beginning_of_day
+
+    end_of_day = Chronic.parse(config.setting(Config::Keys::Settings::END_OF_DAY))
+    end_of_day = end_of_day - end_of_day.beginning_of_day
+
+    events = find_events time_range
+    date_range = time_range.first.to_date .. time_range.last.to_date
+
+    # find relevant events and map them into dates
+    dates_events = date_range.inject({}) { |de, date| de[date] = [] ; de }
+    events.each do |event|
+      if event.accepted?
+        event_date = event.start.to_date!
+        dates_events[event_date] ||= []
+        dates_events[event_date] << event
+      end
+      dates_events
+    end
+
+    # iterate over the days finding free chunks of time
+    avail_time = date_range.inject({}) do |avail_time, date|
+      avail_time[date] ||= []
+      date_events = dates_events[date]
+
+      start_time = date.to_time + start_of_day
+      end_time = date.to_time + end_of_day
+
+      date_events.each do |e|
+        if (e.start.date_time.to_time - start_time) >= length
+          avail_time[date] << CalendarAssistant.available_block(start_time.to_datetime, e.start.date_time)
+        end
+        start_time = e.end.date_time.to_time
+        break if start_time >= end_time
+      end
+
+      if end_time - start_time >= length
+        avail_time[date] << CalendarAssistant.available_block(start_time.to_datetime, end_time.to_datetime)
+      end
+
+      avail_time
+    end
+
+    avail_time
+  end
+
+  def find_location_events time_range
+    find_events(time_range).select { |e| e.location_event? }
+  end
+
+  def create_location_event time_range, location
+    # find pre-existing events that overlap
+    existing_events = find_location_events time_range
+
+    # augment event end date appropriately
+    range = CalendarAssistant.date_range_cast time_range
+
+    deleted_events = []
+    modified_events = []
+
+    event = GCal::Event.new start: GCal::EventDateTime.new(date: range.first.iso8601),
+                            end: GCal::EventDateTime.new(date: range.last.iso8601),
+                            summary: "#{EMOJI_WORLDMAP}  #{location}",
+                            transparency: GCal::Event::Transparency::TRANSPARENT
+
+    event = service.insert_event DEFAULT_CALENDAR_ID, event
+
+    existing_events.each do |existing_event|
+      if existing_event.start.date >= event.start.date && existing_event.end.date <= event.end.date
+        service.delete_event DEFAULT_CALENDAR_ID, existing_event.id
+        deleted_events << existing_event
+      elsif existing_event.start.date <= event.end.date && existing_event.end.date > event.end.date
+        existing_event.update! start: GCal::EventDateTime.new(date: range.last)
+        service.update_event DEFAULT_CALENDAR_ID, existing_event.id, existing_event
+        modified_events << existing_event
+      elsif existing_event.start.date < event.start.date && existing_event.end.date >= event.start.date
+        existing_event.update! end: GCal::EventDateTime.new(date: range.first)
+        service.update_event DEFAULT_CALENDAR_ID, existing_event.id, existing_event
+        modified_events << existing_event
+      end
+    end
+
+    response = {created: [event]}
+    response[:deleted] = deleted_events unless deleted_events.empty?
+    response[:modified] = modified_events unless modified_events.empty?
+    response
+  end
+
+  def event_description event
+    s = sprintf("%-25.25s", event_date_description(event))
+
+    date_ansi_codes = []
+    date_ansi_codes << :bright if event.current?
+    date_ansi_codes << :faint if event.past?
+    s = date_ansi_codes.inject(Rainbow(s)) { |text, ansi| text.send ansi }
+
+    s += Rainbow(sprintf(" | %s", event.view_summary)).bold
+
+    attributes = []
+    unless event.private?
+      attributes << "recurring" if event.recurring_event_id
+      attributes << "not-busy" unless event.busy?
+      attributes << "self" if event.human_attendees.nil? && event.visibility != "private"
+      attributes << "1:1" if event.one_on_one?
+    end
+    s += Rainbow(sprintf(" (%s)", attributes.to_a.sort.join(", "))).italic unless attributes.empty?
+
+    s = Rainbow(Rainbow.uncolor(s)).faint.strike if event.declined?
+
+    s
+  end
+
+  def event_date_description event
+    if event.all_day?
+      start_date = event.start.to_date
+      end_date = event.end.to_date
+      if (end_date - start_date) <= 1
+        event.start.to_s
+      else
+        sprintf("%s - %s", start_date, end_date - 1.day)
+      end
+    else
+      if event.start.date_time.to_date == event.end.date_time.to_date
+        sprintf("%s - %s", event.start.date_time.strftime("%Y-%m-%d  %H:%M"), event.end.date_time.strftime("%H:%M"))
+      else
+        sprintf("%s  -  %s", event.start.date_time.strftime("%Y-%m-%d %H:%M"), event.end.date_time.strftime("%Y-%m-%d %H:%M"))
+      end
+    end
+  end
+
+  private
+
+  def self.available_block start_time, end_time
+    Google::Apis::CalendarV3::Event.new(
+      start: Google::Apis::CalendarV3::EventDateTime.new(date_time: start_time),
+      end: Google::Apis::CalendarV3::EventDateTime.new(date_time: end_time),
+      summary: "available"
+    )
+  end
+end
+
+require "calendar_assistant/config"
+require "calendar_assistant/authorizer"
+require "calendar_assistant/cli"
+require "calendar_assistant/string_helpers"
+require "calendar_assistant/event_extensions"
+require "calendar_assistant/rainbow_extensions"

data/lib/calendar_assistant/authorizer.rb

@@ -0,0 +1,88 @@
+#
+# code in this file is inspired by
+#
+#   https://github.com/gsuitedevs/ruby-samples/blob/master/calendar/quickstart/quickstart.rb
+#
+# Copyright 2018 Google LLC
+#
+# 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
+#
+#     https://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.
+
+require 'googleauth'
+require 'rainbow'
+
+class CalendarAssistant
+  class Authorizer
+    class NoCredentials < CalendarAssistant::BaseException ; end
+    class UnauthorizedError < CalendarAssistant::BaseException ; end
+
+    OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'.freeze
+    APPLICATION_NAME = "Flavorjones Calendar Assistant".freeze
+    CREDENTIALS_PATH = 'credentials.json'.freeze
+    SCOPE = Google::Apis::CalendarV3::AUTH_CALENDAR
+
+    attr_reader :profile_name, :config_token_store
+
+    def initialize profile_name, config_token_store
+      @profile_name = profile_name
+      @config_token_store = config_token_store
+    end
+
+    def authorize
+      credentials || prompt_user_for_authorization
+    end
+
+    def service
+      if credentials.nil?
+        raise UnauthorizedError, "Not authorized. Please run `calendar-assistant authorize #{profile_name}`"
+      end
+
+      Google::Apis::CalendarV3::CalendarService.new.tap do |service|
+        service.client_options.application_name = APPLICATION_NAME
+        service.authorization = credentials
+      end
+    end
+
+  private
+
+    def credentials
+      @credentials ||= authorizer.get_credentials profile_name
+    end
+
+    def prompt_user_for_authorization
+      url = authorizer.get_authorization_url(base_url: OOB_URI)
+
+      puts Rainbow("Please open this URL in your browser:").bold
+      puts
+      puts "  " + url
+      puts
+
+      puts Rainbow("Then authorize '#{APPLICATION_NAME}' to manage your calendar and copy/paste the resulting code here:").bold
+      puts
+      print "> "
+      code = STDIN.gets
+
+      authorizer.get_and_store_credentials_from_code(user_id: profile_name, code: code, base_url: OOB_URI)
+    end
+
+    def authorizer
+      @authorizer ||= begin
+                        if ! File.exists?(CREDENTIALS_PATH)
+                          raise NoCredentials, "No credentials found. Please run `calendar-assistant help authorize` for help"
+                        end
+
+                        client_id = Google::Auth::ClientId.from_file(CREDENTIALS_PATH)
+                        Google::Auth::UserAuthorizer.new(client_id, SCOPE, config_token_store)
+                      end
+    end
+  end
+end

data/lib/calendar_assistant/cli.rb

@@ -0,0 +1,162 @@
+require "thor"
+require "chronic"
+require "chronic_duration"
+require "launchy"
+
+require "calendar_assistant/cli_helpers"
+
+class CalendarAssistant
+  class CLI < Thor
+    default_config = CalendarAssistant::Config.new options: options # used in option descriptions
+
+    #  it's unfortunate that thor does not support this usage of help args
+    class_option :help,
+                 type: :boolean,
+                 aliases: ["-h", "-?"]
+
+    #  note that these options are passed straight through to CLIHelpers.print_events
+    class_option :profile,
+                 type: :string,
+                 desc: "the profile you'd like to use (if different from default)",
+                 aliases: ["-p"]
+    class_option :debug,
+                 type: :boolean,
+                 desc: "how dare you suggest there are bugs"
+
+
+    desc "authorize PROFILE_NAME",
+         "create (or validate) a profile named NAME with calendar access"
+    long_desc <<~EOD
+      Create and authorize a named profile (e.g., "work", "home",
+      "flastname@company.tld") to access your calendar.
+
+      When setting up a profile, you'll be asked to visit a URL to
+      authenticate, grant authorization, and generate and persist an
+      access token.
+
+      In order for this to work, you'll need to follow the
+      instructions at this URL first:
+
+      > https://developers.google.com/calendar/quickstart/ruby
+
+      Namely, the prerequisites are:
+      \x5 1. Turn on the Google API for your account
+      \x5 2. Create a new Google API Project
+      \x5 3. Download the configuration file for the Project, and name it as `credentials.json`
+    EOD
+    def authorize profile_name
+      return if handle_help_args
+      CalendarAssistant.authorize profile_name
+      puts "\nYou're authorized!\n\n"
+    end
+
+
+    desc "show [DATE | DATERANGE | TIMERANGE]",
+         "Show your events for a date or range of dates (default 'today')"
+    option :commitments,
+           type: :boolean,
+           desc: "only show events that you've accepted with another person",
+           aliases: ["-c"]
+    def show datespec="today"
+      return if handle_help_args
+      config = CalendarAssistant::Config.new options: options
+      ca = CalendarAssistant.new config
+      events = ca.find_events CLIHelpers.parse_datespec(datespec)
+      CLIHelpers::Out.new.print_events ca, events, options
+    end
+
+
+    desc "join [TIME]",
+         "Open the URL for a video call attached to your meeting at time TIME (default 'now')"
+    option :join,
+           type: :boolean, default: true,
+           desc: "launch a browser to join the video call URL"
+    def join timespec="now"
+      return if handle_help_args
+      config = CalendarAssistant::Config.new options: options
+      ca = CalendarAssistant.new config
+      event, url = CLIHelpers.find_av_uri ca, timespec
+      if event
+        CLIHelpers::Out.new.print_events ca, event, options
+        CLIHelpers::Out.new.puts url
+        if options[:join]
+          CLIHelpers::Out.new.launch url
+        end
+      else
+        CLIHelpers::Out.new.puts "Could not find a meeting '#{timespec}' with a video call to join."
+      end
+    end
+
+
+    desc "location [DATE | DATERANGE]",
+         "Show your location for a date or range of dates (default 'today')"
+    def location datespec="today"
+      return if handle_help_args
+      config = CalendarAssistant::Config.new options: options
+      ca = CalendarAssistant.new config
+      events = ca.find_location_events CLIHelpers.parse_datespec(datespec)
+      CLIHelpers::Out.new.print_events ca, events, options
+    end
+
+
+    desc "location-set LOCATION [DATE | DATERANGE]",
+         "Set your location to LOCATION for a date or range of dates (default 'today')"
+    def location_set location, datespec="today"
+      return if handle_help_args
+      config = CalendarAssistant::Config.new options: options
+      ca = CalendarAssistant.new config
+      events = ca.create_location_event CLIHelpers.parse_datespec(datespec), location
+      CLIHelpers::Out.new.print_events ca, events, options
+    end
+
+    desc "availability [DATE | DATERANGE | TIMERANGE]",
+         "Show your availability for a date or range of dates (default 'today')"
+    option CalendarAssistant::Config::Keys::Settings::MEETING_LENGTH,
+           type: :string,
+           banner: "LENGTH",
+           desc: sprintf("[default %s] find chunks of available time at least as long as LENGTH (which is a ChronicDuration string like '30m' or '2h')",
+                         default_config.setting(CalendarAssistant::Config::Keys::Settings::MEETING_LENGTH)),
+           aliases: ["-l"]
+    option CalendarAssistant::Config::Keys::Settings::START_OF_DAY,
+           type: :string,
+           banner: "TIME",
+           desc: sprintf("[default %s] find chunks of available time after TIME (which is a Chronic string like '9am' or '14:30')",
+                         default_config.setting(CalendarAssistant::Config::Keys::Settings::START_OF_DAY)),
+           aliases: ["-s"]
+    option CalendarAssistant::Config::Keys::Settings::END_OF_DAY,
+           type: :string,
+           banner: "TIME",
+           desc: sprintf("[default %s] find chunks of available time before TIME (which is a Chronic string like '9am' or '14:30')",
+                         default_config.setting(CalendarAssistant::Config::Keys::Settings::END_OF_DAY)),
+           aliases: ["-e"]
+    def availability datespec="today"
+      return if handle_help_args
+      config = CalendarAssistant::Config.new options: options
+      ca = CalendarAssistant.new config
+      events = ca.availability CLIHelpers.parse_datespec(datespec)
+      CLIHelpers::Out.new.print_available_blocks ca, events, options
+    end
+
+    desc "config",
+         "Dump your configuration parameters (merge of defaults and overrides from #{CalendarAssistant::Config::CONFIG_FILE_PATH})"
+    def config
+      return if handle_help_args
+      config = CalendarAssistant::Config.new
+      settings = {}
+      setting_names = CalendarAssistant::Config::Keys::Settings.constants.map { |k| CalendarAssistant::Config::Keys::Settings.const_get k }
+      setting_names.each do |key|
+        settings[key] = config.setting key
+      end
+      puts TOML::Generator.new({CalendarAssistant::Config::Keys::SETTINGS => settings}).body
+    end
+
+    private
+
+    def handle_help_args
+      if options[:help]
+        help(current_command_chain.first)
+        return true
+      end
+    end
+  end
+end