zoom_slack 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1ef070b91f2106a719a6692ec1dc922a7eb92b3
-  data.tar.gz: 6fa3e4c5fcaa389a623fa0b1419dd0401c3cb3e1
+  metadata.gz: c988264e9d02b36a62478a8770a6cb06bd9c25f7
+  data.tar.gz: de22aaf7767abdd2b2c5f71d15bfb52b410cd3cb
 SHA512:
-  metadata.gz: 6e975763ae19ebd3c87674117da6ca35b44a6d09b58520bd770933ce6e1b038e176e5236283912a1f5270223f6c8fc1216ec5cd25b71cb2de7c3f18f8d00a2c0
-  data.tar.gz: 40f1e2584259d236eb61530477a8c9d9a5ec8ef787c387a7925394e3936e6e52fb3f6de01871f61ce61df3085a5623b6032d6eff49171a08eb50947b8f710426
+  metadata.gz: 9728a25b33faa268f901a7b0e862bc7dd8438eadc88ce7adda9b965d93968a477be90284c3e3ffbc36bcf14635c749f8d4cd903e33c3b758c6f66a37dbfdfd9e
+  data.tar.gz: cfd2725c38c3b28dc641fc48fd32500c26d75150af8121d4e6da642e2946d2b8f3fa605cbfe0c9411032261d5ee1161e1f70d915965eb526429767d38bc1dd8f

data/.gitignore

@@ -1,3 +1,4 @@
 .env.local
 Gemfile.lock
 pkg/
+spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+ - 2.4.5

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## Unreleased
+### Added
+- Fully configurable via `bin/zoom_slack`.  Run `zoom_slack -h` to see all the options.
+- Full test coverage.
+
+## [0.0.1] - 2018-11-29
 ### Added
 - Initial version, working on Mac.

data/README.md

@@ -1,5 +1,10 @@
+[![Gem Version](https://badge.fury.io/rb/zoom_slack.svg)](https://badge.fury.io/rb/zoom_slack)
+[![Build Status](https://travis-ci.org/bwebster/zoom_slack.svg?branch=master)](https://travis-ci.org/bwebster/zoom_slack)
+
 # zoom_slack
 
+**Note: this is alpha quality software, and still under active development!**
+
 This gem provides an easy way to automatically set your Slack status any time you are in a Zoom meeting.  
 
 The current implementation will only work on Mac OS X, but other operating system implementations are welcome!
@@ -30,3 +35,10 @@ You can obtain an oauth token by creating a new app and installing it into your
 1. Under the "Settings" sidebar, click "Install App", then click "Install App to Workspace"
 1. Click "Authorize"
 1. Copy you OAuth Access Token
+
+## Todo
+
+1. Tests!
+1. Customizable text, emoji, and expiration
+1. Documentation
+1. Support for additional platforms

data/Rakefile

@@ -1,3 +1,6 @@
+require "rspec/core/rake_task"
 require "bundler/gem_tasks"
 
+RSpec::Core::RakeTask.new
+
 task default: :spec

data/bin/zoom_slack

@@ -1,8 +1,53 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require "optparse"
 require "zoom_slack"
 
-token = ARGV[0] || ENV.fetch("SLACK_API_TOKEN")
+config = ZoomSlack::Config.new
 
-ZoomSlack::Syncer.new(token: token).sync
+OptionParser.new do |opts|
+  opts.banner = "Usage: zoom_slack [options]"
+
+  opts.separator ""
+  opts.separator "Authentication options:"
+
+  opts.on("-t", "--token TOKEN",
+          "Slack token (defaults to $#{ZoomSlack::Config::TOKEN_DEFAULT_ENV})") do |v|
+    config.token = v
+  end
+
+  opts.separator ""
+  opts.separator "Profile status options:"
+
+  opts.on("--text TEXT",
+          "Status text (defaults to '#{ZoomSlack::Config::MEETING_TEXT_DEFAULT}')") do |v|
+    config.meeting_text = v
+  end
+  opts.on("--emoji EMOJI",
+          "Status emoji (defaults to '#{ZoomSlack::Config::MEETING_EMOJI_DEFAULT}')") do |v|
+    config.meeting_emoji = v
+  end
+  opts.on("--expires N",
+          "Status expires in N minutes (defaults to #{ZoomSlack::Config::MEETING_EXPIRES_IN_MIN_DEFAULT})") do |v|
+    config.meeting_expires_in_min = v
+  end
+  opts.on("--clear-text TEXT",
+          "Clear status text (defaults to '#{ZoomSlack::Config::CLEAR_TEXT_DEFAULT}')") do |v|
+    config.clear_text = v
+  end
+  opts.on("--clear-emoji EMOJI",
+          "Clear status emoji (defaults to '#{ZoomSlack::Config::CLEAR_EMOJI_DEFAULT}')") do |v|
+    config.clear_emoji = v
+  end
+
+  opts.separator ""
+  opts.separator "Common options:"
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+ZoomSlack::Syncer.new(config).sync

data/lib/zoom_slack/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ZoomSlack
+  class Config
+    TOKEN_DEFAULT_ENV = "SLACK_API_TOKEN"
+    MEETING_TEXT_DEFAULT = "In a meeting"
+    MEETING_EMOJI_DEFAULT = ":spiral_calendar_pad:"
+    MEETING_EXPIRES_IN_MIN_DEFAULT = 0
+    CLEAR_TEXT_DEFAULT = nil
+    CLEAR_EMOJI_DEFAULT = nil
+
+    attr_accessor :token,
+                  :meeting_text, :meeting_emoji, :meeting_expires_in_min,
+                  :clear_text, :clear_emoji
+
+    def initialize
+      self.token = ENV[TOKEN_DEFAULT_ENV]
+      self.meeting_text = MEETING_TEXT_DEFAULT
+      self.meeting_emoji = MEETING_EMOJI_DEFAULT
+      self.meeting_expires_in_min = MEETING_EXPIRES_IN_MIN_DEFAULT
+      self.clear_text = CLEAR_TEXT_DEFAULT
+      self.clear_emoji = CLEAR_EMOJI_DEFAULT
+    end
+
+    def meeting_expires_in_min=(min)
+      @meeting_expires_in_min = Integer(min)
+    end
+
+    def meeting_expires_at
+      return nil if meeting_expires_in_min == 0
+
+      Time.now.to_i + (meeting_expires_in_min * 60)
+    end
+  end
+end

data/lib/zoom_slack/process_detector/{factory.rb → base.rb}

@@ -6,5 +6,11 @@ module ZoomSlack
     def self.for_platform
       Mac.new
     end
+
+    class Base
+      def running?
+        raise NotImplementedError
+      end
+    end
   end
 end

data/lib/zoom_slack/process_detector/mac.rb

@@ -1,10 +1,18 @@
 # frozen_string_literal: true
 
 require "tmpdir"
+require "open3"
 
 module ZoomSlack
   module ProcessDetector
-    class Mac
+    class Mac < Base
+      SCRIPT = "in_zoom_meeting.applescript"
+      COMPILED_SCRIPT = "in_zoom_meeting.scptd"
+
+      def initialize(open: Open3)
+        self.open = open
+      end
+
       def running?
         compile
         process_running?
@@ -12,20 +20,26 @@ module ZoomSlack
 
       private
 
+      attr_accessor :open
+
       def compile
-        `osacompile -o #{bin_path} #{source_path}` unless Dir.exist?(bin_path)
+        return if Dir.exist?(compiled_path)
+
+        out, _err, _st = open.capture3("osacompile", "-o", compiled_path, source_path)
+        out
       end
 
       def process_running?
-        `osascript #{bin_path}`.chomp == "true"
+        out, _err, _st = open.capture3("osascript", compiled_path)
+        out.chomp == "true"
       end
 
-      def bin_path
-        @bin_path ||= File.join(Dir.tmpdir, "in_zoom_meeting.scptd")
+      def compiled_path
+        @bin_path ||= File.join(Dir.tmpdir, COMPILED_SCRIPT)
       end
 
       def source_path
-        @source_path ||= File.join(File.dirname(__FILE__), "source", "in_zoom_meeting.applescript")
+        @source_path ||= File.join(File.dirname(__FILE__), "source", SCRIPT)
       end
     end
   end

data/lib/zoom_slack/profile_updater.rb

@@ -5,8 +5,9 @@ require "json"
 
 module ZoomSlack
   class ProfileUpdater
-    def initialize(token:)
+    def initialize(token:, stderr: STDERR)
       self.token = token
+      self.stderr = stderr
     end
 
     def status(status)
@@ -15,7 +16,7 @@ module ZoomSlack
 
     private
 
-    attr_accessor :token
+    attr_accessor :token, :stderr
 
     def update_profile(status)
       response = connection.post do |req|
@@ -32,7 +33,7 @@ module ZoomSlack
 
     def human_readable_error(response)
       json = JSON.parse(response.body)
-      puts "Unable to update Slack profile. Did you pass in the right token?" unless json.fetch("ok")
+      stderr.print "Unable to update Slack profile. Did you pass in the right token?\n" unless json.fetch("ok")
     end
 
     def connection

data/lib/zoom_slack/syncer.rb

@@ -2,9 +2,10 @@
 
 module ZoomSlack
   class Syncer
-    def initialize(token:,
-                   profile_updater: ProfileUpdater.new(token: token),
+    def initialize(config,
+                   profile_updater: ProfileUpdater.new(token: config.token),
                    process_detector: ProcessDetector.for_platform)
+      self.config = config
       self.profile_updater = profile_updater
       self.process_detector = process_detector
     end
@@ -19,14 +20,14 @@ module ZoomSlack
 
     private
 
-    attr_accessor :profile_updater, :process_detector
+    attr_accessor :config, :profile_updater, :process_detector
 
     def in_meeting_status
-      Status.new(text: "In a meeting", emoji: ":spiral_calendar_pad:", expires: 0)
+      Status.new(text: config.meeting_text, emoji: config.meeting_emoji, expires: config.meeting_expires_at)
     end
 
     def clear_status
-      Status.new
+      Status.new(text: config.clear_text, emoji: config.clear_emoji)
     end
   end
 end

data/lib/zoom_slack/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZoomSlack
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/zoom_slack.rb

@@ -3,7 +3,9 @@
 module ZoomSlack
 end
 
-require "zoom_slack/process_detector/factory"
+require "zoom_slack/version"
+require "zoom_slack/config"
+require "zoom_slack/process_detector/base"
 require "zoom_slack/process_detector/mac"
 require "zoom_slack/profile_updater"
 require "zoom_slack/status"

data/zoom_slack.gemspec

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+$:.unshift File.expand_path("../lib", __FILE__)
+require "zoom_slack/version"
+
 Gem::Specification.new do |s|
   s.name        = "zoom_slack"
-  s.version     = "0.0.1"
+  s.version     = ZoomSlack::VERSION
   s.date        = "2018-11-29"
   s.summary     = "Zoom to Slack integration"
   s.description = "Automatically update your Slack status when you're in a Zoom meeting."
@@ -20,4 +23,9 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "timecop"
+  s.add_development_dependency "climate_control"
+  s.add_development_dependency "gem-release"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zoom_slack
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Burke Webster
@@ -66,6 +66,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Automatically update your Slack status when you're in a Zoom meeting.
 email: burke.webster@gmail.com
 executables:
@@ -74,7 +144,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -82,7 +154,8 @@ files:
 - Rakefile
 - bin/zoom_slack
 - lib/zoom_slack.rb
-- lib/zoom_slack/process_detector/factory.rb
+- lib/zoom_slack/config.rb
+- lib/zoom_slack/process_detector/base.rb
 - lib/zoom_slack/process_detector/mac.rb
 - lib/zoom_slack/process_detector/source/in_zoom_meeting.applescript
 - lib/zoom_slack/profile_updater.rb