biff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10baa1580d984257513cc494648360b858da4d2c
+  data.tar.gz: 80e17475020465078acc4186394f08d401b2cabe
+SHA512:
+  metadata.gz: 461e2fd31358b45231fcccd512338a43b63b53e60a6a2e117202221a433870c3f251c0b11fddc68e1140e9c07b8b41400257d68b37398db3547d6a4eb3de4294
+  data.tar.gz: 205fa341d6cd04c01664e8d78cbae0333ce551a55951c320a5d92656b8d8e9f06723c3f105052bacb71e4d8d224a78110cf96eb34061cc10cd816d438ff16e91

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/*.gem
+# rspec failure tracking
+.rspec_status

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in biff.gemspec
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+# Biff
+
+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
+
+## 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}".
+
+`biff.1m.rb` is a [BitBar](https://getbitbar.com) script, which will run every minute 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.
+
+```yaml
+Name:
+  host: required.host.address
+  user: required_user_name
+  password: optional_password
+  passcmd: shell_command_if_password_not_specified
+  run: optional_command_to_run_after_inbox_changes
+  cmd: optional_email_command_for_bitbar_menu_hot_link
+```
+
+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
+#!/bin/zsh --login
+
+export RBENV_ROOT=/usr/local/var/rbenv
+export RBENV_GEMSETS=global
+export RBENV_VERSION=2.4.1
+
+exec $RBENV_ROOT/shims/biff.5m.rb
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cybercode/Biff.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rake/version_task'
+
+Rake::VersionTask.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/biff.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'biff'
+  spec.version       = File.read('VERSION').chomp # file managed by version gem...
+
+  spec.authors       = ['Rick Frankel']
+  spec.email         = ['biff@cybercode.nyc']
+
+  spec.summary       = 'Imap IDLE based biff client'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/cybercode/biff'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.test_files    = `git ls-files -z -- spec/*`.split("\x0")
+  spec.bindir        = 'bin'
+  spec.executables   = %w[biffer biff.5m.rb]
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'version', '~> 1.1'
+  spec.add_dependency 'rfc2047', '>= 0.3'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

data/bin/biff.5m.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# <bitbar.title>IMAP Biff</bitbar.title>
+# <bitbar.version>v0.1</bitbar.version>
+# <bitbar.author>Rick Frankel</bitbar.author>
+# <bitbar.author.github>cybercode</bitbar.author.github>
+# <bitbar.desc>
+#    Get Inbox counts (unseen/all) for multiple mailboxes.
+#    Expects ~/.biff.yaml config file
+# </bitbar.desc>
+# <bitbar.image></bitbar.image>
+# <bitbar.dependencies>ruby, biff rubygem (gem install biff)</bitbar.dependencies>
+# <bitbar.abouturl></bitbar.abouturl>
+
+require 'biff/cli'
+
+def report(cli)
+  statii = cli.status
+  all = statii.sum(&:all)
+  unseen = statii.sum(&:unseen)
+  icon = ':envelope:'
+  attrs = ''
+  if unseen.positive?
+    icon = ':mailbox:'
+    attrs = '|color=green'
+  end
+  puts "#{icon}#{unseen}/#{all}#{attrs}"
+  puts '---'
+  statii.each do |s|
+    cmd = cli.servers[s.name].cmd
+    attrs = '|'
+    attrs += 'color=green' if s.unseen.positive?
+    attrs += " bash=#{cmd} terminal=false" if cmd
+    puts "#{s.name} #{s.unseen}/#{s.all}#{attrs}"
+    if s.unseen.positive?
+      cli.servers[s.name].unseen_headers.map do |h|
+        puts h
+      end
+    end
+    puts '---'
+  end
+  puts 'Check Now…|refresh=true'
+
+  cli.servers.values.each(&:run)
+end
+
+cli = Biff::CLI.new
+report(cli)

data/bin/biffer

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'biff/cli'
+
+cli = Biff::CLI.new
+
+cli.update
+threads = cli.listen
+
+%w[TERM INT QUIT].each do |sig|
+  Signal.trap(sig) do
+    threads.each(&:exit)
+  end
+end
+
+threads.each(&:join)

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'biff'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/biff/cli.rb

@@ -0,0 +1,59 @@
+require 'biff'
+require 'biff/options'
+
+class Biff::CLI
+  attr_reader :servers
+
+  def initialize
+    @servers = {}
+
+    options = Biff::Options.new
+    options.parse!
+
+    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
+      b.count
+    end
+  end
+
+  def disconnect
+    map_servers(&:disconnect)
+  end
+
+  def listen(&block)
+    threads = []
+    map_servers do |obj|
+      threads << Thread.new do
+        obj.listen(&block)
+      end
+    end
+
+    threads
+  end
+
+  def update
+    count
+    map_servers(&:notify)
+    map_servers(&:run)
+  end
+
+  def count
+    map_servers(&:count)
+  end
+
+  def status
+    map_servers(&:status)
+  end
+
+  def map_servers
+    @servers.values.map do |obj|
+      yield obj
+    end
+  end
+end

data/lib/biff/options.rb

@@ -0,0 +1,58 @@
+require 'optparse'
+require 'yaml'
+
+class Biff::Options
+  ARGS = {
+    verbose: 'Be noisy',
+    debug: 'Debug IMAP connection',
+    file: ['Config file', 'FILE', '~/.biff.yaml']
+  }.freeze
+
+  attr_accessor(*ARGS.keys)
+
+  def parse!
+    parser = OptionParser.new do |o|
+      o.banner = 'Usage: biff [options]'
+
+      ARGS.each do |k, v|
+        default = false
+
+        if v.is_a?(Array)
+          default = v[2]
+          v = ["#{v[0]} (default #{v[2]})", v[1]]
+        end
+
+        set(k, default)
+        on(o, k, *v)
+      end
+
+      on(o, :help, 'Print help') do
+        puts parser
+        exit
+      end
+    end
+
+    parser.parse!(ARGV)
+  end
+
+  def config
+    @config ||= YAML.parse(File.open(File.expand_path(file))).transform
+  end
+
+  private
+  def set(arg, v)
+    send("#{arg}=", v)
+  end
+
+  def on(o, arg, doc, name=nil)
+    long = name ? "#{arg} #{name}" : arg
+
+    o.on("-#{arg[0]}", "--#{long}", doc) do |v|
+      if block_given?
+        yield v
+      else
+        set(arg, v)
+      end
+    end
+  end
+end

data/lib/biff.rb

@@ -0,0 +1,129 @@
+require 'net/imap'
+require 'rfc2047'
+require 'version'
+
+Status = Struct.new(:name, :unseen, :all, :cmd)
+
+class Biff
+  is_versioned
+
+  def initialize(config)
+    @config = config
+
+    @imap = Net::IMAP.new(
+      @config['host'],
+      @config['port'] || 993,
+      @config['tls'] || true
+    )
+    Net::IMAP.debug = @config['debug']
+
+    return if @imap.capability.include?('IDLE')
+
+    $stderr.puts "ERR #{config['name']} #{@config['host']} unsupported"
+    exit 1
+  end
+
+  def open
+    pass = @config['password'] || `#{@config['passcmd']}`.chomp
+    log('login', @config['user'])
+
+    @imap.login(@config['user'], pass)
+    @imap.examine('INBOX')
+  end
+
+  def status
+    Status.new(@config['name'], @unseen.count, @all.count)
+  end
+
+  def listen
+    @idling = true
+
+    while @idling
+      begin
+        idle # wait
+
+        count
+        if block_given?
+          yield status
+        else
+          notify
+        end
+
+        run
+      rescue ThreadError
+        # thread killed (exited app?)
+        @imap.disconnect
+      end
+    end
+
+    @idling = false
+  end
+
+  def run
+    return unless cmd = @config['run'] # rubocop:disable Lint/AssignmentInCondition
+
+    log('running', cmd)
+    system(cmd)
+  end
+
+  def count
+    @all    = @imap.search('ALL')
+    @unseen = @imap.search('UNSEEN')
+
+    [@unseen, @all]
+  end
+
+  def notify
+    i = status
+    puts "#{i.name}:#{i.unseen}/#{i.all}"
+  end
+
+  def cmd
+    @config['cmd']
+  end
+
+  def disconnect
+    if @idling
+      @idling = false
+      @imap.send(:put_string, "DONE\r\n")
+    end
+
+    @imap.logout
+    @imap.disconnect unless @imap.disconnected?
+  end
+
+  NAME_MAX = 15
+  SUBJ_MAX = 40
+
+  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)
+      subject = Rfc2047.decode(e.subject)
+      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:disable Lint/FormatParameterMismatch
+      sprintf(
+        '%*.*s%s: %-*.*s%s',
+        nl, nl, name,    name.length    > NAME_MAX ? '…' : '',
+        sl, sl, subject, subject.length > SUBJ_MAX ? '…' : '',
+      )
+    end
+  end
+
+  private
+  def log(*args)
+    return unless @config['verbose']
+    $stderr.puts(['INFO', *args].join(' '))
+  end
+
+  def idle
+    @imap.idle(@config['timeout'] || 29 * 60) do |resp|
+      @imap.idle_done if resp.is_a?(Net::IMAP::UntaggedResponse) &&
+                         resp.name != 'OK'
+    end
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: biff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rick Frankel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rfc2047
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email:
+- biff@cybercode.nyc
+executables:
+- biffer
+- biff.5m.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- biff.gemspec
+- bin/biff.5m.rb
+- bin/biffer
+- bin/console
+- bin/setup
+- lib/biff.rb
+- lib/biff/cli.rb
+- lib/biff/options.rb
+homepage: https://github.com/cybercode/biff
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Imap IDLE based biff client
+test_files: []