biff 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0da6aff1a04c3f31827aab85246b86b37d9a01ec
-  data.tar.gz: ea755b8c05cc961eade23a301ecc0c66ca668771
+  metadata.gz: 2baea458f955162e0a3a6bc431cbdc6911d8f049
+  data.tar.gz: 7de399206437a9b1ee3aa78c5a413400b8642daf
 SHA512:
-  metadata.gz: 81c38ac5eb631c9fd901d0905977bea38789ba1c972ac1d1146007f8be1794641e5485848dafd5911db1fafaf076981087d6992cfa43786eff72346da30af726
-  data.tar.gz: 4b1d2de44bb119f6a8c4eed863ff7d040259efdbfcf1107633fe2ec141c771ce96cd4e8c61cfdeef6bfedbc48841c1a0e180d91be1a09dfeafea64a688d7b1c6
+  metadata.gz: e4ea12c2f02fccede0695d88fa9c65dd12bcec1934c3c33671e0ebe8d03a920435ec8b04570cc6af6c8cd07c87013fd0b613c0dd2baef2d6a71228a82f59b298
+  data.tar.gz: be6a0c1408e071dbd1957a3f8eb586bf3e733b7fcd3cb780722d5a8da2747b390ae6148c96dd45fdcc19811b7eacc7ae6a2d1770ae4eda46d524aea6732caeb4

data/README.md

@@ -14,14 +14,18 @@ The gem provides two command-line scripts, `biffer` (to avoid conflict w/ system
 
 `biff.5m.rb` is a [BitBar](https://getbitbar.com) script, which will run every 5 minutes to update the menubar entry.
 
-Both scripts use (by default) the configuration in ~/.biff.yaml, which should be in the following format, multiple top-level keys (servers) are allowed. Note that one of either `password` or `passcmd` is required.
+Both scripts use (by default) the configuration in ~/.biff.yaml, which should be in the following format, multiple top-level keys (servers) are allowed. Note that one of `password`, `passcmd`, `token` or `tokencmd` is required.
+
+`token` and `tokencmd` are used for gmail oauth2 authentication, and will generate a runtime error if the [gmail_xoauth](https://github.com/nfo/gmail_xoauth) gem is not installed. See the [gmail_xoauth](https://github.com/nfo/gmail_xoauth) homepage for info on how to generate an oauth2 token.
 
 ```yaml
 Name:
-  host: required.host.address
-  user: required_user_name
+  host: required.host.user
+  addressmak: required_user_name
   password: optional_password
   passcmd: shell_command_if_password_not_specified
+  token: gmail_app_oauth2_token
+  tokencmd: shell_command_for_gmail_token
   run: optional_command_to_run_after_inbox_changes
   cmd: optional_email_command_for_bitbar_menu_hot_link
   debug: optional_set_net_imap_debug

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/lib/biff.rb

@@ -19,10 +19,7 @@ class Biff
   end
 
   def open
-    pass = @config['password'] || `#{@config['passcmd']}`.chomp
-    log('login', @config['user'])
-
-    @imap.login(@config['user'], pass)
+    authenticate || login
     @imap.examine('INBOX')
   end
 
@@ -107,6 +104,30 @@ class Biff
   end
 
   private
+  # gmail oauth
+  def authenticate
+    return false unless @config['token'] || @config['tokencmd']
+
+    begin
+      require 'gmail_xoauth'
+    rescue Error => e
+      log('Is gmail_xoauth installed?')
+      raise e
+    end
+
+    token = @config['token'] || `#{@config['tokencmd']}`.chomp
+
+    @imap.authenticate('XOAUTH2', @config['user'], token)
+  end
+
+  # password login
+  def login
+    pass = @config['password'] || `#{@config['passcmd']}`.chomp
+    log('login', @config['user'])
+
+    @imap.login(@config['user'], pass)
+  end
+
   def log(*args)
     return unless @config['verbose']
     $stderr.puts(['INFO', *args].join(' '))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: biff
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rick Frankel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-17 00:00:00.000000000 Z
+date: 2017-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: version