calendar-assistant 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71db4f83ef4cb314c49b308e9fbf752b958823bb320aa7db5d404665e23c3eb9
-  data.tar.gz: 8bd30697df26b5a3975e9a06add5de2c49be64344a3787a09576d3b081bbe121
+  metadata.gz: 9acd200de6edb4b52d97c1994e25d657195e595c1042ef676c552ff6904d6c88
+  data.tar.gz: 59926908cc71682f6480d561323eebdc29aec95fdf351c8a73a6dddefed9f9fc
 SHA512:
-  metadata.gz: b1701eb120de9b9ebdb5065695762eeca199b043e26554386feac9eae62b9ad9cd2b2aa6abe63e7de90716c5e55b74a7fa4e80bcc0056ab29f98c4d4ff840d56
-  data.tar.gz: 0f5f584849f62313666931d943f0b070d0e34d3388f94df57d6ca2b7751db6c23f2ef9ed65b691980ddfda2f54a3ebbd255a356186aae25c0eab25c24abd57a8
+  metadata.gz: 9756ccc795a449ac0fde9707b5b87f6d03457b7ba22a7c802a9073e592c1c758d561223b873e7c2c6b71a336d80329998a0556545183a1ad536d3fab1f25b703
+  data.tar.gz: eb497928c8fd6ae16fad8ee0d2b093cd3417338457367c99a8c8efb94c3a8a48d467215e1f93eddfe0f0e4f147312defc7649d3431f8e0fe4f9e24f0e481d3d8

data/Gemfile

@@ -6,7 +6,8 @@ group :optional do
   # These gems are not required for a functioning test suite, so not listing them in the gemspec.
   # I personally find them useful in the developer role, though.
   gem "autotest"
+  gem "pry"
   gem "rspec-autotest"
+  gem "rufo"
   gem "test_notifier"
-  gem "pry"
 end

data/README.md

@@ -36,6 +36,7 @@
   * [`show`: View your calendar events](#show-view-your-calendar-events)
   * [`lint`: Calendar events that require action](#lint-calendar-events-that-require-action)
   * [`config`: View your configuration parameters](#config-view-your-configuration-parameters)
+  * [`interactive`: Interactive Console](#interactive-interactive-console)
 - [Development](#development)
   * [Running Tests Locally](#running-tests-locally)
   * [Continuous Integration](#continuous-integration)
@@ -160,12 +161,11 @@ Options:
                                          # Default: true
 
 Description:
-  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.
+  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
-  `/home/user/.calendar-assistant.client`
+  If you already have downloaded client credentials, you don't need to run this command. Instead, rename the downloaded
+  JSON file to `/home/user/.calendar-assistant.client`
 </pre>
 
 
@@ -182,14 +182,13 @@ Options:
                                          # Default: true
 
 Description:
-  Create and authorize a named profile (e.g., "work", "home", "flastname@company.tld") to access your
-  calendar.
+  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.
+  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.
+  In order for this to work, you'll need to have set up your API client credentials. Run `calendar-assistant help setup`
+  for instructions.
 </pre>
 
 
@@ -197,17 +196,18 @@ Description:
 
 <pre>
 Commands:
-  calendar-assistant authorize PROFILE_NAME                       # create (or validate) a profil...
-  calendar-assistant availability [DATE | DATERANGE | TIMERANGE]  # Show your availability for a ...
-  calendar-assistant config                                       # Dump your configuration param...
-  calendar-assistant help [COMMAND]                               # Describe available commands o...
-  calendar-assistant join [TIME]                                  # Open the URL for a video call...
-  calendar-assistant lint [DATE | DATERANGE | TIMERANGE]          # Lint your events for a date o...
-  calendar-assistant location [DATE | DATERANGE]                  # Show your location for a date...
-  calendar-assistant location-set LOCATION [DATE | DATERANGE]     # Set your location to LOCATION...
-  calendar-assistant setup                                        # Link your local calendar-assi...
-  calendar-assistant show [DATE | DATERANGE | TIMERANGE]          # Show your events for a date o...
-  calendar-assistant version                                      # Display the version of calend...
+  calendar-assistant authorize PROFILE_NAME                       # create (or validate) a profile named NAME with ca...
+  calendar-assistant availability [DATE | DATERANGE | TIMERANGE]  # Show your availability for a date or range of dat...
+  calendar-assistant config                                       # Dump your configuration parameters (merge of defa...
+  calendar-assistant help [COMMAND]                               # Describe available commands or one specific command
+  calendar-assistant interactive                                  # interactive console for calendar assistant
+  calendar-assistant join [TIME]                                  # Open the URL for a video call attached to your me...
+  calendar-assistant lint [DATE | DATERANGE | TIMERANGE]          # Lint your events for a date or range of dates (de...
+  calendar-assistant location [DATE | DATERANGE]                  # Show your location for a date or range of dates (...
+  calendar-assistant location-set LOCATION [DATE | DATERANGE]     # Set your location to LOCATION for a date or range...
+  calendar-assistant setup                                        # Link your local calendar-assistant installation t...
+  calendar-assistant show [DATE | DATERANGE | TIMERANGE]          # Show your events for a date or range of dates (de...
+  calendar-assistant version                                      # Display the version of calendar-assistant
 
 Options:
   -h, -?, [--help], [--no-help]          
@@ -579,6 +579,27 @@ meeting-length = "30m"
 start-of-day = "9am"
 </pre>
 
+### `interactive`: Interactive Console
+
+<pre>
+Usage:
+  calendar-assistant interactive
+
+Options:
+  -h, -?, [--help], [--no-help]          
+          [--debug], [--no-debug]        # how dare you suggest there are bugs
+  -f, [--formatting], [--no-formatting]  # Enable Text Formatting
+                                         # Default: true
+
+interactive console for calendar assistant
+</pre>
+
+For example, check the version of calendar assistant
+
+```
+calendar-assistant> version
+0.0.0
+```
 
 ## Development
 

data/Rakefile

@@ -2,13 +2,14 @@
 require "rspec/core/rake_task"
 require "concourse"
 require "license_finder"
+require "tempfile"
+require "rainbow"
 
 #
 #  concourse
 #
 Concourse.new("calendar-assistant", fly_target: "calendar-assistants").create_tasks!
 
-
 #
 #  spec tasks
 #
@@ -17,26 +18,38 @@ RSpec::Core::RakeTask.new("spec")
 task "test" => "spec" # undocumented alias for 'spec'
 
 desc "Run unit specs"
-RSpec::Core::RakeTask.new("spec:unit")  do |t|
+RSpec::Core::RakeTask.new("spec:unit") do |t|
   t.rspec_opts ||= []
   t.rspec_opts << " --tag=~type:aruba"
 end
 
 desc "Run feature specs"
-RSpec::Core::RakeTask.new("spec:feature")  do |t|
+RSpec::Core::RakeTask.new("spec:feature") do |t|
   t.rspec_opts ||= []
   t.rspec_opts << " --tag=type:aruba"
 end
 
-desc "Ensure all dependencies meet license requirements."
+desc "Ensure all dependencies meet license requirements"
 task "license_finder" do
   LicenseFinder::CLI::Main.start(["report"])
   LicenseFinder::CLI::Main.start([])
 end
 
-desc "Run unit specs, feature specs, and license finder"
-task "default" => ["spec", "license_finder"]
+#
+#  readme tasks
+#
+desc "Generate the README.md from its erb template"
+task "readme" do
+  sh "./generate-readme"
+end
 
+desc "Generate the README.md from its erb template"
+task "readme:check" do
+  file = Tempfile.new("readme").path
+  sh "./generate-readme #{file}"
+  sh "diff -C3 #{file} README.md"
+  puts Rainbow("README.md looks good").green
+end
 
 #
 # docker docker docker
@@ -53,3 +66,17 @@ end
 
 desc "Build and push a docker image for testing"
 task "docker" => ["docker:build", "docker:push"]
+
+#
+#  formatting
+#
+desc "Format ruby code"
+task "format" do
+  sh "rufo lib spec", verbose: true
+end
+
+#
+#  default
+#
+desc "Run unit specs, feature specs, license finder, and check the README"
+task "default" => ["spec", "license_finder", "readme:check"]

data/bin/calendar-assistant

@@ -1,9 +1,10 @@
 #! /usr/bin/env ruby
-libdir = File.join( File.dirname(__FILE__), "..", "lib")
+libdir = File.join(File.dirname(__FILE__), "..", "lib")
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
 require "calendar_assistant"
 
+Encoding.default_internal = Encoding::UTF_8
 Rainbow.enabled = true
 
 begin

data/lib/calendar_assistant.rb

@@ -25,21 +25,21 @@ require "active_support/time" # Time doesn't trigger autoload
 require "calendar_assistant/calendar_assistant"
 
 class CalendarAssistant
-  autoload :VERSION,                 "calendar_assistant/version"
-  autoload :Config,                  "calendar_assistant/config"
-  autoload :StringHelpers,           "calendar_assistant/string_helpers"
-  autoload :DateHelpers,             "calendar_assistant/date_helpers"
-  autoload :HasDuration,             "calendar_assistant/has_duration"
-  autoload :AvailableBlock,          "calendar_assistant/available_block"
-  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"
+  autoload :VERSION, "calendar_assistant/version"
+  autoload :Config, "calendar_assistant/config"
+  autoload :StringHelpers, "calendar_assistant/string_helpers"
+  autoload :DateHelpers, "calendar_assistant/date_helpers"
+  autoload :HasDuration, "calendar_assistant/has_duration"
+  autoload :AvailableBlock, "calendar_assistant/available_block"
+  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"
   autoload :LocationEventRepository, "calendar_assistant/location_event_repository"
-  autoload :LintEventRepository,     "calendar_assistant/lint_event_repository"
-  autoload :PredicateCollection,     "calendar_assistant/predicate_collection"
+  autoload :LintEventRepository, "calendar_assistant/lint_event_repository"
+  autoload :PredicateCollection, "calendar_assistant/predicate_collection"
   autoload :LocationConfigValidator, "calendar_assistant/location_config_validator"
 end
 

data/lib/calendar_assistant/available_block.rb

@@ -9,4 +9,4 @@ class CalendarAssistant
       @end = HasDuration.cast_datetime(params[:end]) if params[:end]
     end
   end
-end
+end

data/lib/calendar_assistant/calendar_assistant.rb

@@ -1,46 +1,42 @@
 # coding: utf-8
 class CalendarAssistant
-  class BaseException < RuntimeError ; end
+  class BaseException < RuntimeError; end
 
-  EMOJI_PLANE     = "🛪" # U+1F6EA NORTHEAST-POINTING AIRPLANE
-  EMOJI_1_1       = "👫" # MAN AND WOMAN HOLDING HANDS
+  EMOJI_PLANE = "🛪" # U+1F6EA NORTHEAST-POINTING AIRPLANE
+  EMOJI_1_1 = "👫" # MAN AND WOMAN HOLDING HANDS
 
   attr_reader :service, :calendar, :config
 
-  def self.date_range_cast time_range
+  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
+  def self.in_tz(time_zone, &block)
     # this is totally not thread-safe
     orig_time_tz = Time.zone
-    orig_env_tz = ENV['TZ']
+    orig_env_tz = ENV["TZ"]
     begin
       unless time_zone.nil?
         Time.zone = time_zone
-        ENV['TZ'] = time_zone
+        ENV["TZ"] = time_zone
       end
       yield
     ensure
       Time.zone = orig_time_tz
-      ENV['TZ'] = orig_env_tz
+      ENV["TZ"] = orig_env_tz
     end
   end
 
-
-  def initialize config=Config.new,
+  def initialize(config = Config.new,
                  event_repository_factory: EventRepositoryFactory,
-                 service:
-    @config = config
+                 service:) @config = config
     @service = service
-
     @calendar = service.get_calendar Config::DEFAULT_CALENDAR_ID
     @event_repository_factory = event_repository_factory
     @event_repositories = {} # type, calendar_id → event_repository
-    @event_predicates = PredicateCollection.build(config.must_be, config.must_not_be)
-  end
+    @event_predicates = PredicateCollection.build(config.must_be, config.must_not_be)   end
 
-  def in_env &block
+  def in_env(&block)
     # this is totally not thread-safe
     config.in_env do
       in_tz do
@@ -49,21 +45,21 @@ class CalendarAssistant
     end
   end
 
-  def in_tz &block
+  def in_tz(&block)
     CalendarAssistant.in_tz calendar.time_zone do
       yield
     end
   end
 
-  def lint_events time_range
+  def lint_events(time_range)
     calendar_ids = config.calendar_ids
     if calendar_ids.length > 1
       raise BaseException, "CalendarAssistant#lint_events only supports one person (for now)"
     end
-    event_repository(calendar_ids.first, type: :lint).find(time_range,  predicates: @event_predicates)
+    event_repository(calendar_ids.first, type: :lint).find(time_range, predicates: @event_predicates)
   end
 
-  def find_events time_range
+  def find_events(time_range)
     calendar_ids = config.calendar_ids
     if calendar_ids.length > 1
       raise BaseException, "CalendarAssistant#find_events only supports one person (for now)"
@@ -71,7 +67,7 @@ class CalendarAssistant
     event_repository(calendar_ids.first).find(time_range, predicates: @event_predicates)
   end
 
-  def availability time_range
+  def availability(time_range)
     calendar_ids = config.calendar_ids
     ers = calendar_ids.map do |calendar_id|
       event_repository calendar_id
@@ -79,14 +75,14 @@ class CalendarAssistant
     Scheduler.new(self, ers).available_blocks(time_range, predicates: @event_predicates)
   end
 
-  def find_location_events time_range
+  def find_location_events(time_range)
     event_repository(type: :location).find(time_range, predicates: @event_predicates)
   end
 
-  def create_location_events time_range, location
+  def create_location_events(time_range, location)
     LocationConfigValidator.valid?(config)
 
-    event_set = EventSet::Hash.new(event_repository,{})
+    event_set = EventSet::Hash.new(event_repository, {})
 
     unique_calendar_ids.each do |calendar_id|
       event_set[calendar_id] = event_repository(calendar_id, type: :location).create(time_range, location, predicates: @event_predicates)
@@ -95,7 +91,7 @@ class CalendarAssistant
     event_set
   end
 
-  def event_repository calendar_id=Config::DEFAULT_CALENDAR_ID, type: :base
+  def event_repository(calendar_id = Config::DEFAULT_CALENDAR_ID, type: :base)
     @event_repositories[type] ||= {}
     @event_repositories[type][calendar_id] ||=
       @event_repository_factory.new_event_repository(@service, calendar_id, config: config, type: type)

data/lib/calendar_assistant/cli.rb

@@ -1,10 +1,10 @@
-require_relative 'cli/config'
-require_relative 'cli/helpers'
-require_relative 'cli/command_service'
-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'
+require_relative "cli/config"
+require_relative "cli/helpers"
+require_relative "cli/command_service"
+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

@@ -20,17 +20,17 @@
 class CalendarAssistant
   module CLI
     class Authorizer
-      class NoCredentials < CalendarAssistant::BaseException ; end
-      class UnauthorizedError < CalendarAssistant::BaseException ; end
+      class NoCredentials < CalendarAssistant::BaseException; end
+      class UnauthorizedError < CalendarAssistant::BaseException; end
 
-      OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'.freeze
+      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"
+      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
+      def initialize(profile_name, config_token_store)
         @profile_name = profile_name
         @config_token_store = config_token_store
       end
@@ -50,7 +50,7 @@ class CalendarAssistant
         end
       end
 
-    private
+      private
 
       def credentials
         @credentials ||= authorizer.get_credentials profile_name
@@ -74,15 +74,15 @@ class CalendarAssistant
 
       def authorizer
         @authorizer ||= begin
-                          if ! File.exists?(CREDENTIALS_PATH)
-                            raise NoCredentials, "No credentials found. Please run `calendar-assistant help setup` for instructions"
-                          end
+          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
+          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
+end