biff 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10baa1580d984257513cc494648360b858da4d2c
-  data.tar.gz: 80e17475020465078acc4186394f08d401b2cabe
+  metadata.gz: 764dc7f862bfed11324c0de3ac43841347c6574e
+  data.tar.gz: 9583d5ea0182e7a32bf92ac40f60dbf681ef00f3
 SHA512:
-  metadata.gz: 461e2fd31358b45231fcccd512338a43b63b53e60a6a2e117202221a433870c3f251c0b11fddc68e1140e9c07b8b41400257d68b37398db3547d6a4eb3de4294
-  data.tar.gz: 205fa341d6cd04c01664e8d78cbae0333ce551a55951c320a5d92656b8d8e9f06723c3f105052bacb71e4d8d224a78110cf96eb34061cc10cd816d438ff16e91
+  metadata.gz: 8d26d37abc4b03c7e39edcd0983b92bd2c4657de5490f6f21d41c2ee1227939ed7bf13018756679fd2c92e0b1124c1bf154fd31a68a5442db15c6ade8e38bd2f
+  data.tar.gz: b4c08d4620cc717e8c2d5e5b0f3282a0d9f0dd2e3053492ae06cbd1b69ba933c3f33cf3b7d71545731a3cda0c08ffd2b7b685e0e52f3e780137196e63d3d8d3b

data/README.md

@@ -4,27 +4,17 @@ Ruby Imap IDLE based biff utility.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'biff'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
     $ gem install biff
 
+or the usual `bundler` incantations if you want to use the library in another app.
+
 ## Usage
 
-The gem provides two command-line scripts, `biffer` (to avoid conflict w/ system `biff` command) and `biff.5m.rb`. `biffer` uses `net/imap#listen` to wait for INBOX changes and print "{server name}:{unseen}/{all}".
+The gem provides two command-line scripts, `biffer` (to avoid conflict w/ system `biff` command) and `biff.5m.rb`. `biffer` uses `net/imap#listen` to wait for INBOX changes and prints "{server name}:{unseen}/{all}". It will exit immediately with an error if the IMAP server does not have the IDLE capability. 
 
-`biff.1m.rb` is a [BitBar](https://getbitbar.com) script, which will run every minute to update the menubar entry.
+`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 allowd. 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 either `password` or `passcmd` is required.
 
 ```yaml
 Name:
@@ -34,8 +24,11 @@ Name:
   passcmd: shell_command_if_password_not_specified
   run: optional_command_to_run_after_inbox_changes
   cmd: optional_email_command_for_bitbar_menu_hot_link
+  debug: optional_set_net_imap_debug
 ```
 
+Typically, `security find-internet-password -a {email-login} -w` is a good choice for `passcmd`. If your IMAP server is on Microsofit Office365, try `security find-internet-password -s 'mail.office365.com' -w` instead.
+
 Note that if you are using, e.g., `rbenv` to manage your ruby versions and gems, you can't use `biff.5m.rb` directly in your plugin directory. A shell script like the following will work:
 
 ``` zsh

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/biffer

@@ -3,8 +3,17 @@ require 'biff/cli'
 
 cli = Biff::CLI.new
 
-cli.update
-threads = cli.listen
+def notify(status)
+  puts "#{status.name}:#{status.unseen}/#{status.all}"
+end
+
+cli.update do |server|
+  notify(server.status)
+end
+
+threads = cli.listen do |status|
+  notify(status)
+end
 
 %w[TERM INT QUIT].each do |sig|
   Signal.trap(sig) do

data/lib/biff.rb

@@ -2,7 +2,7 @@ require 'net/imap'
 require 'rfc2047'
 require 'version'
 
-Status = Struct.new(:name, :unseen, :all, :cmd)
+Status = Struct.new(:name, :unseen, :all)
 
 class Biff
   is_versioned
@@ -43,11 +43,7 @@ class Biff
         idle # wait
 
         count
-        if block_given?
-          yield status
-        else
-          notify
-        end
+        yield status
 
         run
       rescue ThreadError
@@ -73,11 +69,6 @@ class Biff
     [@unseen, @all]
   end
 
-  def notify
-    i = status
-    puts "#{i.name}:#{i.unseen}/#{i.all}"
-  end
-
   def cmd
     @config['cmd']
   end
@@ -97,6 +88,7 @@ class Biff
 
   def unseen_headers
     return unless @unseen
+
     @imap.fetch(@unseen, 'ENVELOPE').map { |e| e.attr['ENVELOPE'] }.map do |e|
       from = e.from[0]
       name    = Rfc2047.decode(from.name || from.mailbox)
@@ -104,7 +96,7 @@ class Biff
       nl = name.length    > NAME_MAX ? NAME_MAX - 1 : NAME_MAX
       sl = subject.length > SUBJ_MAX ? SUBJ_MAX - 1 : SUBJ_MAX
 
-      # rubocop doesn't understand '*' width/precision
+      # rubocop doesn't understand '*.*' width.precision
       # rubocop:disable Lint/FormatParameterMismatch
       sprintf(
         '%*.*s%s: %-*.*s%s',

data/lib/biff/cli.rb

@@ -12,9 +12,7 @@ class Biff::CLI
 
     options.config.each do |name, config|
       config['debug'] ||= options.debug
-      config['verbose'] ||= options.verbose
       config['name'] = name
-      $stderr.puts("INFO #{name}") if options.verbose
 
       b = @servers[name] = Biff.new(config)
       b.open
@@ -39,7 +37,9 @@ class Biff::CLI
 
   def update
     count
-    map_servers(&:notify)
+    map_servers do |server|
+      yield server
+    end
     map_servers(&:run)
   end
 

data/lib/biff/options.rb

@@ -3,7 +3,6 @@ require 'yaml'
 
 class Biff::Options
   ARGS = {
-    verbose: 'Be noisy',
     debug: 'Debug IMAP connection',
     file: ['Config file', 'FILE', '~/.biff.yaml']
   }.freeze
@@ -30,6 +29,11 @@ class Biff::Options
         puts parser
         exit
       end
+
+      on(o, :version, "Print version (#{Biff::VERSION})") do
+        puts Biff::VERSION
+        exit
+      end
     end
 
     parser.parse!(ARGV)

metadata

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