dug 0.1.0.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4455906bdb42a42d8fbdce98f6b73debdd0b5f1b
+  data.tar.gz: 63f162259f8dc882857627df00b17fb4ae23e28b
+SHA512:
+  metadata.gz: df82930ee5ea1e54545cf0a34f62f9ddf0c53f640771e36819636c8f88e2f7cc1a755846153e8bceedaa749a92f149b87be2613342218ecc56830593b8153359
+  data.tar.gz: 0e5565de67ebf529278a01f4ec52d31cd2197a6528b22d58fed0fc7fecc5b2196a739d1783386fac853d7b552b204f55a196fae8de089302c2a1288dbdb405db

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chris Arcand
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Dug
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dug`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dug'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dug
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dug. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dug"
+
+# 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
+
+require "irb"
+IRB.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/dug.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dug/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dug"
+  spec.version       = Dug::VERSION
+  spec.authors       = ["Chris Arcand"]
+  spec.email         = ["chris@chrisarcand.com"]
+
+  spec.summary       = %q{[D]amn yo[u], [G]mail. A gem to organize your GitHub notification emails in ways Gmail filters can't.}
+  spec.description   = %q{[D]amn yo[u], [G]mail. A gemified script to organize your GitHub notification emails using a simple configuration file in ways Gmail filters can't, such as X-GitHub-Reason headers.}
+  spec.homepage      = "https://github.com/chrisarcand/dug"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "google-api-client", "~> 0.9"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov"
+end

data/lib/dug/configurator.rb

@@ -0,0 +1,125 @@
+require 'yaml'
+
+module Dug
+  class Configurator
+    LABEL_RULE_TYPES = %i(organization repository reason)
+    GITHUB_REASONS = %w(author comment mention team_mention state_change assign)
+
+    attr_accessor :client_id
+    attr_accessor :client_secret
+    attr_accessor :token_store
+    attr_accessor :application_credentials_file
+
+    def initialize
+      self.label_rules = { "organizations" => {}, "reasons" => {} }
+    end
+
+    def set_organization_rule(name, label: nil)
+      organizations[name] ||= { "repositories" => {} }
+      organizations[name]["label"] = label || name
+    end
+
+    def set_repository_rule(name, organization:, label: nil)
+      organizations[organization] ||= { "repositories" => {} }
+      organizations[organization]["repositories"][name] ||= {}
+      organizations[organization]["repositories"][name]["label"] = label || name
+    end
+
+    def set_reason_rule(name, label: nil)
+      validate_reason(name)
+      reasons[name] ||= {}
+      reasons[name]["label"] = label || name
+    end
+
+    def label_for(type, name, organization: nil)
+      validate_label_type(type)
+      case type
+      when :organization
+        organizations.fetch(name, {})["label"]
+      when :repository
+        raise ArgumentError, "Repository label rules require an organization to be specified" unless organization
+        organizations.fetch(organization, {})
+                     .fetch("repositories", {})
+                     .fetch(name, {})["label"]
+      when :reason
+        validate_reason(name)
+        reasons.fetch(name, {})["label"]
+      end
+    end
+
+    def application_credentials_file
+      ENV['GOOGLE_APPLICATION_CREDENTIALS'] || @application_credentials_file
+    end
+
+    def client_id
+      ENV['GOOGLE_CLIENT_ID'] || @client_id
+    end
+
+    def client_secret
+      ENV['GOOGLE_CLIENT_SECRET'] || @client_secret
+    end
+
+    def token_store
+      ENV['TOKEN_STORE_PATH'] || @token_store || File.join(Dir.home, ".dug", "authorization.yaml")
+    end
+
+    def rule_file
+      @rule_file
+    end
+
+    def rule_file=(file_path)
+      @rule_file = file_path
+      load_rules
+      @rule_file
+    end
+
+    private
+
+    attr_accessor :label_rules
+
+    def load_rules
+      file = YAML.load_file(rule_file)
+
+      file["organizations"].each do |org|
+        case org
+        when String
+          set_organization_rule(org)
+        when Hash
+          set_organization_rule(org["name"], label: org["label"])
+          if repos = org["repositories"]
+            repos.each do |repo|
+              set_repository_rule(repo["name"], organization: org["name"], label: repo["label"])
+            end
+          end
+        end
+      end
+
+      file["reasons"].keys.each do |reason|
+        validate_reason(reason)
+        set_reason_rule(reason, label: file["reasons"][reason]["label"])
+      end
+    end
+
+    def validate_label_type(type)
+      unless LABEL_RULE_TYPES.include?(type)
+        raise ConfigurationError, "'#{type}' is not a valid label rule type. Valid types: #{}"
+      end
+    end
+
+    def validate_reason(reason)
+      unless GITHUB_REASONS.include?(reason)
+        raise ConfigurationError, "'#{reason}' is not a valid GitHub notification reason. Valid reasons include: #{GITHUB_REASONS.map { |x| "'#{x}'" }.join(', ')}"
+      end
+    end
+
+    def organizations
+      label_rules["organizations"]
+    end
+
+    def reasons
+      label_rules["reasons"]
+    end
+  end
+
+  ConfigurationError = Class.new(StandardError)
+end

data/lib/dug/gmail_servicer.rb

@@ -0,0 +1,91 @@
+require 'google/apis/gmail_v1'
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+require 'fileutils'
+require 'forwardable'
+
+module Dug
+  class GmailServicer
+    extend Forwardable
+
+    OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'
+    APPLICATION_NAME = 'Dug'
+    SCOPE = Google::Apis::GmailV1::AUTH_GMAIL_MODIFY
+
+    def_delegators :@gmail, :get_user_message,
+                            :list_user_messages,
+                            :modify_message
+
+    def initialize
+      @gmail = Google::Apis::GmailV1::GmailService.new
+      @gmail.client_options.application_name = APPLICATION_NAME
+    end
+
+    def labels(use_cache: true)
+      @labels = nil unless use_cache
+      @labels ||= @gmail.list_user_labels('me').labels.reduce({}) do |hash, label|
+        hash.tap { |h| h[label.name] = label }
+      end
+    end
+
+    def add_labels_by_name(*args)
+      modify_message_request(*args) do |request, ids|
+        request.add_label_ids = ids
+      end
+    end
+
+    def remove_labels_by_name(*args)
+      modify_message_request(*args) do |request, ids|
+        request.remove_label_ids = ids
+      end
+    end
+
+    # TODO: break some of this code down, prolly into a separate Authorizer class or something
+    def authorize!
+      token_store_path = Dug.configuration.token_store
+      FileUtils.mkdir_p(File.dirname(token_store_path))
+
+      client_id = begin
+                    if Dug.configuration.client_id
+                      Google::Auth::ClientId.new(Dug.configuration.client_id,
+                                                 Dug.configuration.client_secret)
+                    else
+                      Google::Auth::ClientId.from_file(Dug.configuration.application_credentials_file)
+                    end
+                  end
+      token_store = Google::Auth::Stores::FileTokenStore.new(file: token_store_path)
+      authorizer = Google::Auth::UserAuthorizer.new(client_id, SCOPE, token_store)
+      user_id = 'default'
+
+      credentials = authorizer.get_credentials(user_id)
+      if credentials.nil?
+        url = authorizer.get_authorization_url(
+          base_url: OOB_URI)
+        puts "Open the following URL in the browser and enter the " +
+          "resulting code after authorization"
+        puts url
+        code = gets
+        credentials = authorizer.get_and_store_credentials_from_code(
+          user_id: user_id, code: code, base_url: OOB_URI)
+      end
+      @gmail.authorization = credentials
+    end
+
+    private
+
+    def modify_message_request(message, label_names)
+      ids = []
+      label_names.each do |name|
+        unless labels[name] && id = labels[name].id
+          raise MissingLabel, "The label '#{name}' does not exist. Please add the label in Gmail first."
+        end
+        ids << id
+      end
+      request = Google::Apis::GmailV1::ModifyMessageRequest.new
+      yield request, ids
+      modify_message('me', message.id, request)
+    end
+  end
+
+  MissingLabel = Class.new(StandardError)
+end

data/lib/dug/logger.rb

@@ -0,0 +1,7 @@
+module Dug
+  module Logger
+    def log(message, level: :info)
+      puts "[#{level.to_s.upcase}] #{Time.now} - #{message}"
+    end
+  end
+end

data/lib/dug/notification_decorator.rb

@@ -0,0 +1,33 @@
+module Dug
+  class NotificationDecorator < SimpleDelegator
+    %w(Date From To Subject).each do |header|
+      define_method(header.downcase) do
+        headers[header]
+      end
+    end
+
+    def organization
+      list_match[1]
+    end
+
+    def repository
+      list_match[2]
+    end
+
+    def reason
+      headers["X-GitHub-Reason"]
+    end
+
+    def headers
+      @headers ||= payload.headers.each_with_object({}) do |header, hash|
+        hash[header.name] = header.value
+      end
+    end
+
+    private
+
+    def list_match
+      headers["List-ID"].match(/^([\w\-_]+)\/([\w\-_]+)/)
+    end
+  end
+end

data/lib/dug/runner.rb

@@ -0,0 +1,72 @@
+module Dug
+  class Runner
+    include Dug::Logger
+
+    attr_reader :servicer
+
+    def self.run(*args)
+      new.run(*args)
+    end
+
+    def initialize
+      @servicer = Dug::GmailServicer.new
+      servicer.authorize!
+    end
+
+    def run
+      if unprocessed_notifications?
+        log("Processing #{unprocessed_notifications.size} GitHub notifications...")
+        unprocessed_notifications.each do |message|
+          process_message(message.id)
+        end
+        log("Finished processing #{unprocessed_notifications.size} GitHub notifications.")
+      else
+        log("No new GitHub notifications.")
+      end
+    end
+
+    private
+
+    def process_message(id)
+      message = NotificationDecorator.new(servicer.get_user_message('me', id))
+
+      labels_to_add    = ["GitHub"]
+      labels_to_remove = ["GitHub/Unprocessed"]
+      if message.reason
+        labels_to_add << Dug.configuration.label_for(:reason, message.reason)
+      end
+      labels_to_add << Dug.configuration.label_for(:organization, message.organization)
+      labels_to_add << Dug.configuration.label_for(:repository,
+                                                   message.repository,
+                                                   organization: message.organization)
+      labels_to_add.flatten! and labels_to_remove.flatten!
+      labels_to_add.compact! and labels_to_remove.compact!
+
+      info = "Processing message:"
+      info << "\n    ID: #{message.id}"
+      %w(Date From Subject).each do |header|
+        info << "\n    #{header}: #{message.headers[header]}"
+      end
+      info << "\n    * Applying labels: #{labels_to_add.join(' | ')} *"
+      log(info)
+
+      servicer.add_labels_by_name(message, labels_to_add)
+      servicer.remove_labels_by_name(message, labels_to_remove)
+    end
+
+    def unprocessed_notifications(use_cache: true)
+      unless use_cache
+        log("Requesting latest emails from Gmail...")
+        @unprocessed_notifications = nil
+      end
+      unprocessed_label = servicer.labels(use_cache: use_cache)["GitHub/Unprocessed"]
+      @unprocessed_notifications ||= servicer
+        .list_user_messages('me', label_ids: [unprocessed_label.id])
+        .messages
+    end
+
+    def unprocessed_notifications?
+      !!unprocessed_notifications(use_cache: false)
+    end
+  end
+end

data/lib/dug/version.rb

@@ -0,0 +1,3 @@
+module Dug
+  VERSION = "0.1.0.alpha1"
+end

data/lib/dug.rb

@@ -0,0 +1,20 @@
+require "dug/version"
+require "dug/configurator"
+require "dug/gmail_servicer"
+require "dug/logger"
+require "dug/notification_decorator"
+require "dug/runner"
+
+module Dug
+  def self.authorize!
+    Dug::GmailServicer.new.authorize!
+  end
+
+  def self.configure(&block)
+    yield configuration
+  end
+
+  def self.configuration
+    @config ||= Dug::Configurator.new
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: dug
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha1
+platform: ruby
+authors:
+- Chris Arcand
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: "[D]amn yo[u], [G]mail. A gemified script to organize your GitHub notification
+  emails using a simple configuration file in ways Gmail filters can't, such as X-GitHub-Reason
+  headers."
+email:
+- chris@chrisarcand.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dug.gemspec
+- lib/dug.rb
+- lib/dug/configurator.rb
+- lib/dug/gmail_servicer.rb
+- lib/dug/logger.rb
+- lib/dug/notification_decorator.rb
+- lib/dug/runner.rb
+- lib/dug/version.rb
+homepage: https://github.com/chrisarcand/dug
+licenses:
+- MIT
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: "[D]amn yo[u], [G]mail. A gem to organize your GitHub notification emails
+  in ways Gmail filters can't."
+test_files: []