schedule-cli 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27845260a0b3a6e6dd6b06a498c510b452ae0a69b0b14ef524e0c94c9abea2d6
-  data.tar.gz: a87f684a45f6621007e489fa6d51653bc5a1a28f22fc2dc437c0261b63832746
+  metadata.gz: e7f5856a18a1c3b88cfa3303b4becb495617bacdd061bb96eaa83d470272273d
+  data.tar.gz: 1e9f64117af1d689c63094668c7a337b51c7329e310c9df823b72f04fdf648c9
 SHA512:
-  metadata.gz: '08667553ba38fde90bce29ea3609ebf2aece59680e18f3c4b1fd7b2af7b305c0baac5e89042b139b5740dc328e4eeb4d9d3070e15416231d2a40071ab54fd86c'
-  data.tar.gz: ecf30cfa524aee407cd0898e5b84f4339e2d10a356ac6eacffaa92e8b5af88159f8c45ca574fed0290413dc070f71b229af641b7472f6b9d5c1aec62451426cd
+  metadata.gz: bda9a3ead7125b766b539f9a19ea7a288c7c57243612f4da125606de365b2942f330836f5ad3fd18f005a05a755a2bc9c8bfc0728c6ce150f947c631ced5dd7d
+  data.tar.gz: 43dfe7775c369c3cd837cfaa56c9c53de45c4537720d17d83c9cdec21ee0c927efa913f312f2ad27b6ef7e050433de569c070c97c29b15b428f31e9b93b86c77

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    schedule-cli (0.1.1)
+    schedule-cli (0.1.2)
       activesupport (~> 5.2)
       chronic
       google-api-client (~> 0.11)

data/README.md

@@ -1,28 +1,36 @@
 # Schedule
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/schedule`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem allows you to quickly insert your calendar availability to any plain (or rich) text field. It connects with a single Google account but can pull appointments from various calendars. At Karuna, we have this hooked up to an [Alfred](https://www.alfredapp.com/) workflow.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'schedule'
+```bash
+$ gem install schedule
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+Run `schedule availability` to get your default availability table, which shows slots for a 30 minute meeting in a 3-day span centered on the weekday following today. Weekends are not considered as open slots unless the center date (`offset`) is a weekend.
 
-Or install it yourself as:
+The command can optionally be passed two arguments. The first is either the name of a named event (see below), or a number of minutes to specify a duration. The second is a string (such as "next wednesday") which specifies the center of the range to be scheduled over.
 
-    $ gem install schedule
+The command defaults to outputting plain text, but is much more useful when in HTML mode (pass the `--html` flag). This HTML can then be converted to RTF, e.g. using `schedule availability --html | textutil -stdin -format html -convert rtf -stdout`.
 
-## Usage
+## Config
+
+The following configuration flags are available. The YAML config file can be edited by running `schedule config`.
+
+- `calendars` is a list of Calendar IDs to pull appointments from.
+- `day` has two keys, `start` and `end`, which respectively indicate the earliest and latest times an event can be held in a day.
+- `defaults` contains a bunch of options that are applied to events by default, but can be overridden by named events in the `events` list.
+
+  - `align_to` gives the number of minutes to align each event slot to. Defaults to 15.
+  - `day_offset` gives the default offset (center) for a span of days over which an event can be scheduled. Defaults to "next weekday", and can be any simple string describing a relative date.
+  - `day_buffer` gives the number of days on either side of the center to be considered for scheduling events. Defaults to 1.
+  - `duration` gives the number of minutes an event should last for
+  - `min_delay` gives the number of hours in the future that an event must be scheduled after
 
-TODO: Write usage instructions here
+- `footer` is an HTML string that is inserted after the table. This is used to include something like a Calendly link.
 
 ## Development
 
@@ -32,4 +40,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/schedule.
+Bug reports and pull requests are welcome on GitHub at https://github.com/karuna-health/schedule.

data/lib/schedule/calendar.rb

@@ -28,8 +28,8 @@ module Schedule
     end
 
     def free_slots
-      center = Date.today + @options[:day_offset].days
-      (start, end_), events = get_events_in_range(center, @options[:day_buffer])
+      center = Date.today + @options[:day][:offset].days
+      (start, end_), events = get_events_in_range(center, @options[:day][:buffer])
 
       range = AvailabilityRange.new(
         start.beginning_of_day,

data/lib/schedule/cli.rb

@@ -16,20 +16,20 @@ module Schedule
       super
     end
 
-    desc 'availability type', 'print availability table'
+    desc 'availability type|duration offset', 'print availability table'
     method_option :html, type: :boolean, default: false
     method_option :debug, type: :boolean, default: false
     def availability(type = nil, *offset_string)
-      config = Config.values.slice(:calendars, :day).merge(Config.value(:defaults))
+      config = Config.value(:defaults)
       if /\A\d+\z/.match?(type)
         config[:duration] = type.to_i
       else
         config.merge!(Config.value(:events, type&.to_sym) || {})
       end
       if offset_string.present?
-        config[:day_offset] = parse_offset offset_string.join(' ')
-      elsif config[:day_offset].is_a?(String)
-        config[:day_offset] = parse_offset config[:day_offset]
+        config[:day][:offset] = parse_offset offset_string.join(' ')
+      elsif config[:day][:offset].is_a?(String)
+        config[:day][:offset] = parse_offset config[:day][:offset]
       end
       puts config.to_s if options.debug?
       slots = Schedule::Calendar.new(config).free_slots
@@ -41,6 +41,11 @@ module Schedule
       system("${EDITOR:-${VISUAL:-vi}} '#{Config.config_file}'")
     end
 
+    desc 'reset', 'reset config and auth tokens'
+    def reset
+      system("rm -r #{Config::CONFIG_DIR}")
+    end
+
     private
 
     def parse_offset(string)

data/lib/schedule/config.rb

@@ -7,15 +7,15 @@ module Schedule
   class Config
     CONFIG_DIR = "#{Dir.home}/.schedule-cli/"
     DEFAULT_CONFIG = {
-      calendars: ['primary'],
-      day: {
-        start: 8,
-        end: 18,
-      },
       defaults: {
         align_to: 15,
-        day_offset: 'next weekday',
-        day_buffer: 1,
+        calendars: ['primary'],
+        day: {
+          start: 8,
+          end: 18,
+          offset: 'next weekday',
+          buffer: 1,
+        },
         duration: 30,
         min_delay: 4,
       },
@@ -44,7 +44,7 @@ module Schedule
     end
 
     def self.values
-      @values ||= YAML.load(File.read(config_file)) # rubocop:disable Security/YAMLLoad
+      @values ||= DEFAULT_CONFIG.merge(YAML.load(File.read(config_file))) # rubocop:disable Security/YAMLLoad
     end
   end
 end

data/lib/schedule/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Schedule
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schedule-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Yasyf Mohamedali
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-06 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler