calendar-assistant 0.2.1 → 0.3.0

data/Rakefile

@@ -1,9 +1,17 @@
 #require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "concourse"
+require "license_finder"
 
 Concourse.new("calendar-assistant").create_tasks!
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+desc "Ensure all dependencies meet license requirements."
+task :license_finder do
+  LicenseFinder::CLI::Main.start(["report"])
+  LicenseFinder::CLI::Main.start([])
+end
+
+desc "Run specs and license finder"
+task :default => [:spec, :license_finder]

data/lib/calendar_assistant.rb

@@ -1,192 +1,40 @@
-# coding: utf-8
-require "google/apis/calendar_v3"
-require "json"
-require "yaml"
-require "business_time"
-require "rainbow"
-require "set"
-
-require "calendar_assistant/version"
+#
+#  stdlib
+#
+autoload :YAML, "yaml"
+autoload :URI, "uri"
+autoload :Set, "set"
+autoload :FileUtils, "fileutils"
+
+#
+#  gem dependencies
+#
+autoload :BusinessTime, "business_time"
+autoload :Chronic, "chronic"
+autoload :ChronicDuration, "chronic_duration"
+autoload :Google, "calendar_assistant/extensions/google_apis_extensions"
+autoload :Launchy, "launchy"
+autoload :TOML, "toml"
+autoload :Thor, "thor"
+require "calendar_assistant/extensions/rainbow_extensions" # Rainbow() doesn't trigger autoload
+
+#
+#  CalendarAssistant and associated classes
+#
+require "calendar_assistant/calendar_assistant"
 
 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, event_repository: nil
-    @config = config
-    @service = Authorizer.new(config.profile_name, config.token_store).service
-    @calendar = service.get_calendar DEFAULT_CALENDAR_ID
-    @event_repository = event_repository || EventRepository.new(@service, DEFAULT_CALENDAR_ID)
-  end
-
-  def find_events time_range
-    @event_repository.find(time_range)
-  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
-    @event_repository.find(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 = @event_repository.create(transparency: GCal::Event::Transparency::TRANSPARENT, start: range.first, end: range.last , summary: "#{EMOJI_WORLDMAP}  #{location}")
-
-    existing_events.each do |existing_event|
-      if existing_event.start.date >= event.start.date && existing_event.end.date <= event.end.date
-        @event_repository.delete existing_event
-        deleted_events << existing_event
-      elsif existing_event.start.date <= event.end.date && existing_event.end.date > event.end.date
-        @event_repository.update existing_event, start: range.last
-        modified_events << existing_event
-      elsif existing_event.start.date < event.start.date && existing_event.end.date >= event.start.date
-        @event_repository.update existing_event, end: range.first
-        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
-
-    attributes << event.visibility if event.explicit_visibility?
-
-    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
+  autoload :VERSION,                "calendar_assistant/version"
+  autoload :Config,                 "calendar_assistant/config"
+  autoload :Authorizer,             "calendar_assistant/authorizer"
+  autoload :StringHelpers,          "calendar_assistant/string_helpers"
+  autoload :DateHelpers,            "calendar_assistant/date_helpers"
+  autoload :Event,                  "calendar_assistant/event"
+  autoload :EventRepository,        "calendar_assistant/event_repository"
+  autoload :EventRepositoryFactory, "calendar_assistant/event_repository_factory"
+  autoload :EventSet,               "calendar_assistant/event_set"
+  autoload :Scheduler,              "calendar_assistant/scheduler"
+  autoload :LocalService,           "calendar_assistant/local_service"
 end
 
-require "calendar_assistant/config"
-require "calendar_assistant/authorizer"
 require "calendar_assistant/cli"
-require "calendar_assistant/string_helpers"
-require "calendar_assistant/extensions/event_date_time_extensions"
-require "calendar_assistant/extensions/event_extensions"
-require "calendar_assistant/event"
-require "calendar_assistant/event_repository"
-require "calendar_assistant/extensions/rainbow_extensions"

data/lib/calendar_assistant/authorizer.rb

@@ -17,9 +17,6 @@
 # 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

data/lib/calendar_assistant/calendar_assistant.rb

@@ -0,0 +1,122 @@
+# coding: utf-8
+class CalendarAssistant
+  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
+
+  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 self.in_tz time_zone, &block
+    # this is totally not thread-safe
+    orig_time_tz = Time.zone
+    orig_env_tz = ENV['TZ']
+    begin
+      unless time_zone.nil?
+        Time.zone = time_zone
+        ENV['TZ'] = time_zone
+      end
+      yield
+    ensure
+      Time.zone = orig_time_tz
+      ENV['TZ'] = orig_env_tz
+    end
+  end
+
+
+  def initialize config=Config.new,
+                 event_repository_factory: EventRepositoryFactory
+    @config = config
+
+    if filename = config.setting(Config::Keys::Options::LOCAL_STORE)
+      @service = CalendarAssistant::LocalService.new(file: filename)
+    else
+      @service = Authorizer.new(config.profile_name, config.token_store).service
+    end
+    @calendar = service.get_calendar Config::DEFAULT_CALENDAR_ID
+    @event_repository_factory = event_repository_factory
+    @event_repositories = {} # calendar_id → event_repository
+  end
+
+  def in_env &block
+    # this is totally not thread-safe
+    config.in_env do
+      in_tz do
+        yield
+      end
+    end
+  end
+
+  def in_tz &block
+    CalendarAssistant.in_tz calendar.time_zone do
+      yield
+    end
+  end
+
+  def find_events time_range
+    calendar_ids = config.attendees
+    if calendar_ids.length > 1
+      raise "CalendarAssistant#find_events only supports one person (for now)"
+    end
+    event_repository(calendar_ids.first).find(time_range)
+  end
+
+  def availability time_range
+    calendar_ids = config.attendees
+    ers = calendar_ids.map do |calendar_id|
+      event_repository calendar_id
+    end
+    Scheduler.new(self, ers).available_blocks(time_range)
+  end
+
+  def find_location_events time_range
+    event_set = event_repository.find(time_range)
+    event_set.new event_set.events.select { |e| e.location_event? }
+  end
+
+  def create_location_event time_range, location
+    # find pre-existing events that overlap
+    existing_event_set = find_location_events time_range
+
+    # augment event end date appropriately
+    range = CalendarAssistant.date_range_cast time_range
+
+    deleted_events = []
+    modified_events = []
+
+    event = event_repository.create(transparency: CalendarAssistant::Event::Transparency::TRANSPARENT, start: range.first, end: range.last , summary: "#{EMOJI_WORLDMAP}  #{location}")
+
+    existing_event_set.events.each do |existing_event|
+      if existing_event.start_date >= event.start_date && existing_event.end_date <= event.end_date
+        event_repository.delete existing_event
+        deleted_events << existing_event
+      elsif existing_event.start_date <= event.end_date && existing_event.end_date > event.end_date
+        event_repository.update existing_event, start: range.last
+        modified_events << existing_event
+      elsif existing_event.start_date < event.start_date && existing_event.end_date >= event.start_date
+        event_repository.update existing_event, end: range.first
+        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?
+
+    existing_event_set.new response
+  end
+
+  def event_repository calendar_id=Config::DEFAULT_CALENDAR_ID
+    @event_repositories[calendar_id] ||= @event_repository_factory.new_event_repository(@service, calendar_id)
+  end
+end

data/lib/calendar_assistant/cli.rb

@@ -1,17 +1,25 @@
-require "thor"
-require "chronic"
-require "chronic_duration"
-require "launchy"
-
 require "calendar_assistant/cli_helpers"
 
 class CalendarAssistant
   class CLI < Thor
-    def self.supports_profile_option
-      option :profile,
+    def self.will_create_a_service
+      option CalendarAssistant::Config::Keys::Settings::PROFILE,
              type: :string,
              desc: "the profile you'd like to use (if different from default)",
              aliases: ["-p"]
+
+      option CalendarAssistant::Config::Keys::Options::LOCAL_STORE,
+             type: :string,
+             banner: "FILENAME",
+             desc: "Load events from a local file instead of Google Calendar"
+    end
+
+    def self.has_attendees
+      option CalendarAssistant::Config::Keys::Options::ATTENDEES,
+             type: :string,
+             banner: "ATTENDEE1[,ATTENDEE2[,...]]",
+             desc: "[default 'me'] people (email IDs) to whom this command will be applied",
+             aliases: ["-a"]
     end
 
     default_config = CalendarAssistant::Config.new options: options # used in option descriptions
@@ -19,22 +27,25 @@ class CalendarAssistant
     class_option :help,
                  type: :boolean,
                  aliases: ["-h", "-?"]
-    class_option :debug,
+    class_option CalendarAssistant::Config::Keys::Options::DEBUG,
                  type: :boolean,
                  desc: "how dare you suggest there are bugs"
 
 
+    desc "version",
+         "Display the version of calendar-assistant"
+    def version
+      return if handle_help_args
+      out.puts CalendarAssistant::VERSION
+    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
+      settings = CalendarAssistant::Config.new.settings
+      out.puts TOML::Generator.new({CalendarAssistant::Config::Keys::SETTINGS => settings}).body
     end
 
 
@@ -50,11 +61,12 @@ class CalendarAssistant
       file to `#{CalendarAssistant::Authorizer::CREDENTIALS_PATH}`
     EOD
     def setup
-      out = CLIHelpers::Out.new
+      # TODO ugh see #34 for advice on how to clean this up
+      return if handle_help_args
       if File.exist? CalendarAssistant::Authorizer::CREDENTIALS_PATH
         out.puts sprintf("Credentials already exist in %s",
                          CalendarAssistant::Authorizer::CREDENTIALS_PATH)
-        exit 0
+        return
       end
 
       out.launch "https://developers.google.com/calendar/quickstart/ruby"
@@ -92,8 +104,10 @@ class CalendarAssistant
       In order for this to work, you'll need to have set up your API client
       credentials. Run `calendar-assistant help setup` for instructions.
     EOD
-    def authorize profile_name
+    def authorize profile_name=nil
       return if handle_help_args
+      return help! if profile_name.nil?
+
       CalendarAssistant.authorize profile_name
       puts "\nYou're authorized!\n\n"
     end
@@ -101,64 +115,70 @@ class CalendarAssistant
 
     desc "show [DATE | DATERANGE | TIMERANGE]",
          "Show your events for a date or range of dates (default 'today')"
-    option :commitments,
+    option CalendarAssistant::Config::Keys::Options::COMMITMENTS,
            type: :boolean,
            desc: "only show events that you've accepted with another person",
            aliases: ["-c"]
-    supports_profile_option
+    will_create_a_service
+    has_attendees
     def show datespec="today"
       return if handle_help_args
-      config = CalendarAssistant::Config.new options: options
+      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
+      ca.in_env do
+        event_set = ca.find_events CLIHelpers.parse_datespec(datespec)
+        out.print_events ca, event_set
+      end
     end
 
 
     desc "join [TIME]",
          "Open the URL for a video call attached to your meeting at time TIME (default 'now')"
-    option :join,
+    option CalendarAssistant::Config::Keys::Options::JOIN,
            type: :boolean, default: true,
            desc: "launch a browser to join the video call URL"
-    supports_profile_option
+    will_create_a_service
     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
+      ca = CalendarAssistant.new CalendarAssistant::Config.new(options: options)
+      ca.in_env do
+        event_set, url = CLIHelpers.find_av_uri ca, timespec
+        if ! event_set.empty?
+          out.print_events ca, event_set
+          out.puts url
+          out.launch url if options[CalendarAssistant::Config::Keys::Options::JOIN]
+        else
+          out.puts "Could not find a meeting '#{timespec}' with a video call to join."
         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')"
-    supports_profile_option
+    will_create_a_service
     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
+      ca = CalendarAssistant.new CalendarAssistant::Config.new(options: options)
+      ca.in_env do
+        event_set = ca.find_location_events CLIHelpers.parse_datespec(datespec)
+        out.print_events ca, event_set
+      end
     end
 
 
     desc "location-set LOCATION [DATE | DATERANGE]",
          "Set your location to LOCATION for a date or range of dates (default 'today')"
-    supports_profile_option
-    def location_set location, datespec="today"
+    will_create_a_service
+    def location_set location=nil, 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
+      return help! if location.nil?
+
+      ca = CalendarAssistant.new CalendarAssistant::Config.new(options: options)
+      ca.in_env do
+        event_set = ca.create_location_event CLIHelpers.parse_datespec(datespec), location
+        out.print_events ca, event_set
+      end
     end
 
 
@@ -173,29 +193,39 @@ class CalendarAssistant
     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')",
+           desc: sprintf("[default %s] find chunks of available time after TIME (which is a BusinessTime 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')",
+           desc: sprintf("[default %s] find chunks of available time before TIME (which is a BusinessTime string like '9am' or '14:30')",
                          default_config.setting(CalendarAssistant::Config::Keys::Settings::END_OF_DAY)),
            aliases: ["-e"]
-    supports_profile_option
+    has_attendees
+    will_create_a_service
     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
+      ca = CalendarAssistant.new CalendarAssistant::Config.new(options: options)
+      ca.in_env do
+        event_set = ca.availability CLIHelpers.parse_datespec(datespec)
+        out.print_available_blocks ca, event_set
+      end
     end
 
     private
 
+    def out
+      @out ||= CLIHelpers::Out.new
+    end
+
+    def help!
+      help(current_command_chain.first)
+    end
+
     def handle_help_args
       if options[:help]
-        help(current_command_chain.first)
+        help!
         return true
       end
     end