calendar-assistant 0.6.0 → 0.7.0

data/lib/calendar_assistant/cli.rb

@@ -1,233 +1,9 @@
-require "calendar_assistant/cli_helpers"
-
-class CalendarAssistant
-  class CLI < Thor
-    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
-
-    class_option :help,
-                 type: :boolean,
-                 aliases: ["-h", "-?"]
-    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
-      settings = CalendarAssistant::Config.new.settings
-      out.puts TOML::Generator.new({CalendarAssistant::Config::Keys::SETTINGS => settings}).body
-    end
-
-
-    desc "setup",
-         "Link your local calendar-assistant installation to a Google API Client"
-    long_desc <<~EOD
-      This command will walk you through setting up a Google Cloud
-      Project, enabling the Google Calendar API, and saving the
-      credentials necessary to access the API on behalf of users.
-
-      If you already have downloaded client credentials, you don't
-      need to run this command. Instead, rename the downloaded JSON
-      file to `#{CalendarAssistant::Authorizer::CREDENTIALS_PATH}`
-    EOD
-    def setup
-      # 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)
-        return
-      end
-
-      out.launch "https://developers.google.com/calendar/quickstart/ruby"
-      sleep 1
-      out.puts <<~EOT
-        Please click on "ENABLE THE GOOGLE CALENDAR API" and either create a new project or select an existing project.
-
-        (If you create a new project, name it something like "yourname-calendar-assistant" so you remember why it exists.)
-
-        Then click "DOWNLOAD CLIENT CONFIGURATION" to download the credentials to local disk.
-
-        Finally, paste the contents of the downloaded file here (it should be a complete JSON object):
-      EOT
-
-      json = out.prompt "Paste JSON here"
-      File.open(CalendarAssistant::Authorizer::CREDENTIALS_PATH, "w") do |f|
-        f.write json
-      end
-      FileUtils.chmod 0600, CalendarAssistant::Authorizer::CREDENTIALS_PATH
-
-      out.puts "\nOK! Your next step is to run `calendar-assistant authorize`."
-    end
-
-
-    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 have set up your API client
-      credentials. Run `calendar-assistant help setup` for instructions.
-    EOD
-    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
-
-
-    desc "show [DATE | DATERANGE | TIMERANGE]",
-         "Show your events for a date or range of dates (default 'today')"
-    option CalendarAssistant::Config::Keys::Options::COMMITMENTS,
-           type: :boolean,
-           desc: "only show events that you've accepted with another person",
-           aliases: ["-c"]
-    will_create_a_service
-    has_attendees
-    def show datespec="today"
-      return if handle_help_args
-      config = CalendarAssistant::Config.new(options: options)
-      ca = CalendarAssistant.new config
-      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 CalendarAssistant::Config::Keys::Options::JOIN,
-           type: :boolean, default: true,
-           desc: "launch a browser to join the video call URL"
-    will_create_a_service
-    def join timespec="now"
-      return if handle_help_args
-      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
-      end
-    end
-
-
-    desc "location [DATE | DATERANGE]",
-         "Show your location for a date or range of dates (default 'today')"
-    will_create_a_service
-    def location datespec="today"
-      return if handle_help_args
-      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')"
-    will_create_a_service
-    def location_set location=nil, datespec="today"
-      return if handle_help_args
-      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
-
-
-    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 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 BusinessTime string like '9am' or '14:30')",
-                         default_config.setting(CalendarAssistant::Config::Keys::Settings::END_OF_DAY)),
-           aliases: ["-e"]
-    has_attendees
-    will_create_a_service
-    def availability datespec="today"
-      return if handle_help_args
-      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!
-        return true
-      end
-    end
-  end
-end
+require_relative 'cli/config'
+require_relative 'cli/helpers'
+require_relative 'cli/printer'
+require_relative 'cli/event_presenter'
+require_relative 'cli/event_set_presenter'
+require_relative 'cli/linter_event_presenter'
+require_relative 'cli/linter_event_set_presenter'
+require_relative 'cli/authorizer'
+require_relative 'cli/commands'

data/lib/calendar_assistant/cli/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.
+
+class CalendarAssistant
+  module CLI
+    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 = File.join (ENV['CA_HOME'] || ENV["HOME"]), ".calendar-assistant.client"
+      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 setup` for instructions"
+                          end
+
+                          FileUtils.chmod 0600, CREDENTIALS_PATH
+                          client_id = Google::Auth::ClientId.from_file(CREDENTIALS_PATH)
+                          Google::Auth::UserAuthorizer.new(client_id, SCOPE, config_token_store)
+                        end
+      end
+    end
+  end
+end

data/lib/calendar_assistant/cli/commands.rb

@@ -0,0 +1,284 @@
+require "calendar_assistant/cli/helpers"
+
+class CalendarAssistant
+  module CLI
+    class Commands < Thor
+      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::CLI::Config.new options: options # used in option descriptions
+
+      class_option :help,
+                   type: :boolean,
+                   aliases: ["-h", "-?"]
+      class_option CalendarAssistant::Config::Keys::Options::DEBUG,
+                   type: :boolean,
+                   desc: "how dare you suggest there are bugs"
+
+      class_option CalendarAssistant::Config::Keys::Options::FORMATTING,
+                   type: :boolean,
+                   desc: "Enable Text Formatting",
+                   default: CalendarAssistant::Config::DEFAULT_SETTINGS[CalendarAssistant::Config::Keys::Options::FORMATTING]
+
+      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::CLI::Config::CONFIG_FILE_PATH})"
+
+      def config
+        return if handle_help_args
+        settings = CalendarAssistant::CLI::Config.new.settings
+        out.puts TOML::Generator.new({CalendarAssistant::Config::Keys::SETTINGS => settings}).body
+      end
+
+
+      desc "setup",
+           "Link your local calendar-assistant installation to a Google API Client"
+      long_desc <<~EOD
+      This command will walk you through setting up a Google Cloud
+      Project, enabling the Google Calendar API, and saving the
+      credentials necessary to access the API on behalf of users.
+
+      If you already have downloaded client credentials, you don't
+      need to run this command. Instead, rename the downloaded JSON
+      file to `#{CalendarAssistant::CLI::Authorizer::CREDENTIALS_PATH}`
+      EOD
+
+      def setup
+        # TODO ugh see #34 for advice on how to clean this up
+        return if handle_help_args
+        if File.exist? CalendarAssistant::CLI::Authorizer::CREDENTIALS_PATH
+          out.puts sprintf("Credentials already exist in %s",
+                           CalendarAssistant::CLI::Authorizer::CREDENTIALS_PATH)
+          return
+        end
+
+        out.launch "https://developers.google.com/calendar/quickstart/ruby"
+        sleep 1
+        out.puts <<~EOT
+        Please click on "ENABLE THE GOOGLE CALENDAR API" and either create a new project or select an existing project.
+
+        (If you create a new project, name it something like "yourname-calendar-assistant" so you remember why it exists.)
+
+        Then click "DOWNLOAD CLIENT CONFIGURATION" to download the credentials to local disk.
+
+        Finally, paste the contents of the downloaded file here (it should be a complete JSON object):
+        EOT
+
+        json = out.prompt "Paste JSON here"
+        File.open(CalendarAssistant::CLI::Authorizer::CREDENTIALS_PATH, "w") do |f|
+          f.write json
+        end
+        FileUtils.chmod 0600, CalendarAssistant::CLI::Authorizer::CREDENTIALS_PATH
+
+        out.puts "\nOK! Your next step is to run `calendar-assistant authorize`."
+      end
+
+
+      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 have set up your API client
+      credentials. Run `calendar-assistant help setup` for instructions.
+      EOD
+
+      def authorize profile_name = nil
+        return if handle_help_args
+        return help! if profile_name.nil?
+
+        get_authorizer(profile_name: profile_name).authorize
+
+        puts "\nYou're authorized!\n\n"
+      end
+
+      desc "lint [DATE | DATERANGE | TIMERANGE]",
+           "Lint your events for a date or range of dates (default 'today')"
+      will_create_a_service
+      has_attendees
+
+      def lint datespec = "today"
+        calendar_assistant(datespec) do |ca, date|
+          event_set = ca.lint_events date
+          out.print_events ca, event_set, presenter_class: CalendarAssistant::CLI::LinterEventSetPresenter
+        end
+      end
+      
+      desc "show [DATE | DATERANGE | TIMERANGE]",
+           "Show your events for a date or range of dates (default 'today')"
+      option CalendarAssistant::Config::Keys::Options::COMMITMENTS,
+             type: :boolean,
+             desc: "only show events that you've accepted with another person",
+             aliases: ["-c"]
+      will_create_a_service
+      has_attendees
+
+      def show datespec = "today"
+        calendar_assistant(datespec) do |ca, date|
+          event_set = ca.find_events date
+          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 CalendarAssistant::Config::Keys::Options::JOIN,
+             type: :boolean, default: true,
+             desc: "launch a browser to join the video call URL"
+      will_create_a_service
+
+      def join timespec = "now"
+        return if handle_help_args
+        set_formatting
+        ca = CalendarAssistant.new get_config, service: service
+        ca.in_env do
+          event_set, url = CalendarAssistant::CLI::Helpers.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
+        end
+      end
+
+
+      desc "location [DATE | DATERANGE]",
+           "Show your location for a date or range of dates (default 'today')"
+      will_create_a_service
+
+      def location datespec = "today"
+        calendar_assistant(datespec) do |ca, date|
+          event_set = ca.find_location_events date
+          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')"
+      will_create_a_service
+
+      def location_set location = nil, datespec = "today"
+        return help! if location.nil?
+
+        calendar_assistant(datespec) do |ca, date|
+          event_set = ca.create_location_event date, location
+          out.print_events ca, event_set
+        end
+      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 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 BusinessTime string like '9am' or '14:30')",
+                           default_config.setting(CalendarAssistant::Config::Keys::Settings::END_OF_DAY)),
+             aliases: ["-e"]
+      has_attendees
+      will_create_a_service
+
+      def availability datespec = "today"
+        calendar_assistant(datespec) do |ca, date|
+          event_set = ca.availability date
+          out.print_available_blocks ca, event_set
+        end
+      end
+
+      private
+
+      def set_formatting
+        Rainbow.enabled = !!options[:formatting]
+      end
+
+      def service
+        @service ||= begin
+          if filename = get_config.setting(Config::Keys::Options::LOCAL_STORE)
+            CalendarAssistant::LocalService.new(file: filename)
+          else
+            get_authorizer.service
+          end
+        end
+      end
+
+      def get_authorizer(profile_name: get_config.profile_name, token_store: get_config.token_store)
+        @authorizer ||= {}
+        @authorizer[profile_name] ||= Authorizer.new(profile_name, token_store)
+      end
+
+      def calendar_assistant datespec = "today"
+        return if handle_help_args
+        set_formatting
+        ca = CalendarAssistant.new(get_config, service: service)
+        ca.in_env do
+          yield(ca, CalendarAssistant::CLI::Helpers.parse_datespec(datespec))
+        end
+      end
+
+      def get_config
+        @config ||= CalendarAssistant::CLI::Config.new(options: options)
+      end
+
+      def out
+        @out ||= CalendarAssistant::CLI::Printer.new
+      end
+
+      def help!
+        help(current_command_chain.first)
+      end
+
+      def handle_help_args
+        if options[:help]
+          help!
+          return true
+        end
+      end
+    end
+  end
+end