vaccine-spotter 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee6ea9690334fd97f64cccafb4d4a22a59d36ba4e6b999a52b77f5f4128d9cd8
-  data.tar.gz: afd75efd6acd1ce70c8a73cbd7ed401e1cf4a2fe650efabec901c599a2a012fd
+  metadata.gz: 54c43d4e7a183668e99aa9ca2e33ee581ca275cf625022e899c85ea1343ad374
+  data.tar.gz: dfe2031626184c0cd6559b38db0b48acbfd5611396b1a9addb7a9bb985ecd21e
 SHA512:
-  metadata.gz: 12ddd6dcf1befc1d1a2379e9b614e7508988194304016c80115788c546bab9d85f43c89f663dee02d85244abd9c2c2920d615e406529bf7c2b2c93b10c1a6127
-  data.tar.gz: d7552b9a5621c004d52a21c8eff20cb3e2663a0139d6fe47126a460c82d85685a37b820ca72e910b540a4a8ee827cee36ba43cc09ed5b1e9bfd4bc271327c3d7
+  metadata.gz: c479b10fa6e637dc99b11c5799e9ed374047a43135c66fd9d2c0818a032d074ce81b5bb15030158cc6724e1e93d592ba4552fc3f70f90ea1a772ab77790b4528
+  data.tar.gz: dc801614d28a967ede5139e5851aa0ce512de9904647e88ccab6c51aec7b176fb1d990c6c7a97a3994e80594617e2bcf9a6eb6537864e5b4977a07ad1244858b

data/bin/vaccine-spotter

@@ -1,3 +1,66 @@
 #!/usr/bin/env ruby
 
-require 'vaccine-spotter'
+require "thor"
+
+class MyCLI < Thor
+
+  desc "start", "Start vaccine-spotter — the default task when no command or options are given"
+  def start
+    begin
+      require 'vaccine-spotter'
+    rescue LoadError
+      require_relative './../lib/vaccine-spotter'
+    end
+  end
+
+  desc "check", "Run vaccine-spotter once instead of looping"
+  def check
+    $loop = false
+    begin
+      require 'vaccine-spotter'
+    rescue LoadError
+      require_relative './../lib/vaccine-spotter'
+    end
+  end
+
+  desc "config", "Open config file (~/.config/vaccine-spotter.toml) with default editor"
+  def config
+    system("open ~/.config/vaccine-spotter.toml")
+  end
+
+  desc "version", "Print version and OS information"
+  def version
+    begin
+      puts "vaccinespotter.org CLI notifier thing v#{Gem.loaded_specs["vaccine-spotter"].version}"
+    rescue
+      puts "(!) vaccine-spotter: error loading version"
+    end
+    begin
+      require 'os'
+    rescue
+      puts "(!) vaccine-spotter: couldn't load OS gem"
+    end
+    begin
+      puts OS.report
+      puts "ruby_bin: #{OS.ruby_bin}"
+    rescue
+      puts "(!) vaccine-spotter: couldn't print `OS.report`"
+    end
+  end
+  map %w[--version -v] => :version
+
+  default_task :start
+
+end
+
+# The following is from https://stackoverflow.com/a/49044225/
+help_commands = Thor::HELP_MAPPINGS + ["help"]
+if help_commands.any? { |cmd| ARGV.include? cmd }
+  help_commands.each do |cmd|
+    if match = ARGV.delete(cmd)
+      ARGV.unshift match
+    end
+  end
+end
+
+MyCLI.start(ARGV)

data/lib/vaccine-spotter.rb

@@ -11,37 +11,67 @@ require "toml"
 require "tty-config"
 require "tty-prompt"
 require "launchy"
+require "feep"
+require "os"
 
-pastel = Pastel.new
+# Supports https://no-color.org
+env_no_color = false if ENV['NO_COLOR']
+
+pastel = Pastel.new(enabled: env_no_color)
 config = TTY::Config.new
-prompt = TTY::Prompt.new
+prompt = TTY::Prompt.new(enable_color: env_no_color)
 
 config.filename = "vaccine-spotter"
 config.extname = ".toml"
 config.append_path "#{Dir.home}/.config"
 
-if !config.exist?
+if OS.windows?
   puts
-  puts pastel.bold "Hi, welcome to the unofficial vaccinespotter.org CLI notifier thing!"
-  puts "It looks like you don't have a configuration file yet. Would you like to create one?"
-  create_config = prompt.yes? "Create `~/.config/vaccine-spotter.toml`?"
-  if create_config
-    set_state = prompt.ask("What state would you like to monitor? (Two-letter postal code, please)", required: true) do |q|
-      q.modify :up, :remove
+  print pastel.bold.red "(!) Note: Windows is unsupported"
+  puts pastel.red " (I don't have a Windows computer and I barely know how it works)."
+  puts pastel.red "Notifications don't work, I think, and sounds require installing `sounder`. Read more at the project homepage: https://github.com/jltml/vaccine-spotter-cli"
+end
+
+if !config.exist?
+  begin
+    puts
+    puts pastel.bold "Hi, welcome to the unofficial vaccinespotter.org CLI notifier thing!"
+    puts "It looks like you don't have a configuration file yet. Would you like to create one?"
+    create_config = prompt.yes? "Create `~/.config/vaccine-spotter.toml`?"
+    if !create_config
+      puts pastel.bold.red "You'll need to create a configuration file at `~/.config/vaccine-spotter.toml` to use this."
     end
-    config.set(:state, value: set_state)
-    puts "Ok, time to set zip codes…"
-    if prompt.yes? "freemaptools.com has a really helpful tool for getting the zip codes around a radius. Would you like to open it?"
-      Launchy.open "https://www.freemaptools.com/find-zip-codes-inside-radius.htm"
+    if create_config
+      set_state = prompt.ask("What #{pastel.bold.underline "state"} would you like to monitor? (Two-letter postal code, please)", required: true) do |q|
+        q.modify :up, :remove
+        # q.validate(^(?-i:A[LKSZRAEP]|C[AOT]|D[EC]|F[LM]|G[AU]|HI|I[ADLN]|K[SY]|LA|M[ADEHINOPST]|N[CDEHJMVY]|O[HKR]|P[ARW]|RI|S[CD]|T[NX]|UT|V[AIT]|W[AIVY])) # This is supposed to validate but doesn't work # Validates state abbreviation, apparently
+      end
+      config.set(:state, value: set_state)
+      puts "Ok, time to set zip codes…"
+      if prompt.yes? "freemaptools.com has a really helpful tool for getting the zip codes around a radius. Would you like to open it?"
+        Launchy.open "https://www.freemaptools.com/find-zip-codes-inside-radius.htm"
+      end
+      set_zips = prompt.ask("What #{pastel.bold.underline "zip codes"} would you like to track? You can paste here from freemaptools.com, if you used it (comma-separated list of integers, please)", convert: :int_list, required: true)
+      config.set(:zips, value: set_zips)
+      set_vaccine_types = prompt.multi_select("Which types of vaccines would you like to include?", %w(pfizer moderna jj unknown), min: 1, show_help: :always)
+      config.set(:vaccine_types, value: set_vaccine_types)
+      set_refresh_rate = prompt.ask("How often should the script check for updates? (seconds)", convert: :int, required: true)
+      config.set(:refresh_rate, value: set_refresh_rate)
+      set_play_sound = prompt.yes?("Would you like to play a sound when availability is found?", required: true)
+      config.set(:sound, :play, value: set_play_sound)
+      if set_play_sound
+        set_repeat_sound = prompt.ask("How many times should the sound repeat?", convert: :int, required: true)
+        config.set(:sound, :repeat, value: set_repeat_sound)
+      end
+      puts "Perfect; writing to `~/.config/vaccine-spotter.toml`…"
+      config.write
     end
-    set_zips = prompt.ask("What zip codes would you like to track? You can paste here from freemaptools.com, if you used it (comma-separated list of integers, please)", convert: :int_list, required: true)
-    config.set(:zips, value: set_zips)
-    set_vaccine_types = prompt.multi_select("Which types of vaccines would you like to include?", %w(pfizer moderna jj unknown), min: 1, show_help: :always)
-    config.set(:vaccine_types, value: set_vaccine_types)
-    set_refresh_rate = prompt.ask("How often should the script check for updates? (seconds)", convert: :int, required: true)
-    config.set(:refresh_rate, value: set_refresh_rate)
-    puts "Perfect; writing to `~/.config/vaccine-spotter.toml`…"
-    config.write
+
+  rescue Interrupt
+    puts
+    print pastel.red.underline "vaccine-spotter was interrupted during config setup — ~/.config/vaccine-spotter.toml was "
+    puts pastel.red.underline.bold "not created"
+    exit 1
   end
 end
 
@@ -49,6 +79,27 @@ zips = config.read["zips"]
 state = config.read["state"]
 refresh_rate = config.read["refresh_rate"].to_i
 vaccine_types = config.read["vaccine_types"]
+play_sound = config.read["sound"]["play"]
+repeat_sound = config.read["sound"]["repeat"].to_i
+
+def pluralize(number, text)
+  return text + 's' if number != 1
+  text
+end
+
+def blues_scale
+  Feep::Base.new(
+    :freq_or_note => 'E4',
+    :scale => 'blues',
+    :waveform => 'triangle',
+    :volume => 0.8,
+    :duration => 100,
+    :save => false,
+    :verbose => false,
+    :visual_cue => false,
+    :usage => nil
+  )
+end
 
 puts
 print pastel.bold "vaccinespotter.org CLI notifier thing"
@@ -59,44 +110,86 @@ rescue
 end
 puts pastel.dim ", by Jack MapelLentz (jltml.me)"
 puts pastel.dim "This script uses the wonderful vaccinespotter.org, by Nick Muerdter (github.com/GUI)"
-puts "Checking #{pastel.underline zips.length} zip codes in #{pastel.underline state} every #{pastel.underline refresh_rate} seconds"
+print "Checking #{pastel.underline zips.length} zip codes in #{pastel.underline state} "
+if $loop != false
+  puts "every #{pastel.underline refresh_rate} seconds"
+else
+  puts pastel.underline "once"
+end
 puts "Filtering appointments for #{pastel.underline vaccine_types.to_s.tr("[]\"", "")}"
+if play_sound
+  puts "Playing a sound #{pastel.underline repeat_sound} #{pluralize(repeat_sound, "time")} when availability is found"
+else
+  puts "#{pastel.underline "Not"} playing a sound when availability is found"
+end
 puts pastel.dim "Press control-C to quit"
 
-excluded = Array.new
+excluded = Hash.new
 
-loop do
+begin
 
-  number_excluded = excluded.length
+  loop do
 
-  json = Net::HTTP.get(URI("https://www.vaccinespotter.org/api/v0/states/#{state}.json"))
-  parsed_json = JSON.parse(json)
+    initial_number_excluded = excluded.length
 
-  puts
+    json = Net::HTTP.get(URI("https://www.vaccinespotter.org/api/v0/states/#{state}.json"))
+    parsed_json = JSON.parse(json)
 
-  if (Time.now.strftime("%M").to_i%5 == 0) && (Time.now.strftime("%S").to_i < refresh_rate)
-    excluded.clear
-    puts "List of excluded/checked stores cleared"
-  end
+    puts
 
-  parsed_json["features"].each_index do |i|
-    current = parsed_json["features"][i]["properties"]
-    if (current["appointments_available"] == true) and (zips.include?(current["postal_code"].to_i) and (!excluded.include? current["id"].to_i) and !(vaccine_types & current["appointment_vaccine_types"].keys).empty?)
-      puts "- #{pastel.green.bold current["city"]} #{pastel.green.bold current["provider_brand_name"]}: #{current["url"]}"
-      puts " - #{current["appointment_vaccine_types"]} as of #{Time.parse(current["appointments_last_fetched"]).localtime.strftime("%H:%M:%S")}"
-      TerminalNotifier.notify("#{current["provider_brand_name"]} - #{current["city"]}", :title => "vaccine-spotter", :open => "#{current["url"]}")
-      excluded.append current["id"].to_i
+    new_appointment = false
+
+    # This is the main area thing — it loops through each zip code and finds matches
+    parsed_json["features"].each_index do |i|
+      current = parsed_json["features"][i]["properties"]
+
+      # Checks if locations that previously had appointments no longer have availability
+      if (excluded.keys.include? current["id"]) && (current["appointments_available"] == false)
+        print "- "
+        puts pastel.red "#{pastel.bold current["city"].split.map(&:capitalize).join(' ') + ' ' + current["provider_brand_name"]}: Appointments no longer available as of #{Time.parse(current["appointments_last_fetched"]).localtime.strftime("%H:%M:%S")}"
+        excluded.delete current["id"]
+        initial_number_excluded = excluded.length
+      end
+
+      # Finds matches
+      if (current["appointments_available"] == true) && (zips.include?(current["postal_code"].to_i) && (!excluded.include? current["id"].to_i) && (vaccine_types & current["appointment_vaccine_types"].keys).any?)
+
+        # Logs matches to terminal (and uniformly capitalizes location names)
+        puts "- #{pastel.green.bold current["city"].split.map(&:capitalize).join(' ')} #{pastel.green.bold current["provider_brand_name"]}: #{current["url"]}"
+        puts " - #{current["appointment_vaccine_types"].keys.to_s.tr("[]\"", "").split.map(&:capitalize).join(' ')} available as of #{Time.parse(current["appointments_last_fetched"]).localtime.strftime("%H:%M:%S")}"
+
+        # Sends a notification if on macOS (also makes location names all the same title case/capitalization)
+        if OS.mac? then TerminalNotifier.notify("#{current["provider_brand_name"]} - #{current["city"].split.map(&:capitalize).join(' ')} (#{current["appointment_vaccine_types"].keys.to_s.tr("[]\"", "").split.map(&:capitalize).join(' ')})", :title => "vaccine-spotter", :open => "#{current["url"]}") end
+
+        excluded[current["id"].to_i] = current["appointments_last_fetched"] # Add key & value of {"id" => "appointments_last_fetched"} to excluded hash
+        new_appointment = true
+      end
     end
-  end
 
-  print pastel.dim "Checked at #{Time.now.strftime("%H:%M:%S")} on #{Time.now.strftime("%Y-%m-%d")}"
-  if number_excluded == 1
-    print pastel.dim " (#{number_excluded} checked location excluded)"
-  elsif number_excluded != 0
-    print pastel.dim " (#{number_excluded} checked locations excluded)"
-  end
-  puts
+    print pastel.dim "Checked at #{Time.now.strftime("%H:%M:%S")} on #{Time.now.strftime("%Y-%m-%d")}"
+    if initial_number_excluded != 0
+      print pastel.dim " (#{initial_number_excluded} checked #{pluralize(initial_number_excluded, "location")} excluded)"
+    end
+    puts
+
+    # Plays a sound (E blues scale) if there's a new appointment in a new thread so the whole program isn't delayed by the sound playing
+    if play_sound && new_appointment
+      Thread.new {
+        repeat_sound.times do
+          blues_scale
+          sleep 0.5
+        end
+      }
+    end
 
-  sleep refresh_rate
+    break if $loop == false
+
+    sleep refresh_rate
+
+  end
 
+rescue Interrupt
+  print " "
+  puts pastel.underline "Stopping vaccine-spotter…"
+  exit
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vaccine-spotter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Jack MapelLentz
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-15 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-logger
@@ -108,12 +108,52 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: feep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: This gem will notify you when COVID-19 vaccine appointments are available
-  matching certain criteria (a list of zip codes, type of vaccine, etc). It currently
-  pretty much just wraps the very beta API from the absolutely wonderful vaccinespotter.org,
-  though I hope to add my own website scraping soon too so as to improve response
-  times.
-email:
+  matching certain criteria (a list of zip codes, type of vaccine, etc) using the
+  very beta API from the absolutely wonderful vaccinespotter.org.
+email: 
 executables:
 - vaccine-spotter
 extensions: []
@@ -125,7 +165,7 @@ homepage: https://github.com/jltml/vaccine-spotter-cli
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +180,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Get notified of vaccine availability
 test_files: []