dug 0.1.0.alpha2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c6c01300fe32cff493d71785c74fe0c37e02673
-  data.tar.gz: bf879e429299828cc2adf2bff39a1b30458da86c
+  metadata.gz: 0d92695864762a5b6667cb71be82f5655118bed7
+  data.tar.gz: 03a4ae0c0d2ebc6b2622a84ce2b9bc2d3ae0500e
 SHA512:
-  metadata.gz: 93dce7d68c25b9af837420525c8daad4bf489f93f1688445054f0794ea278a4b27344737b217bd26c6ce1183ca458497c72b6cd1c4effa25c854317774af7e27
-  data.tar.gz: 5aeac95bf1b2b1d41af25858c0c68e2f04874f960b6add28cb63cf67166010de76be0e578e0def24d4033e6dd546c842108cdd6d5e9fab4f09cf7f517b1e9ce0
+  metadata.gz: ec5f7374bf6513f68903ccef656b0d1825cf6c8df350c20396bf89b4e4bfbb49e508b9789100a52d8ad99004b9191aaa56521eb90d5d327500f6c3443ecefb3b
+  data.tar.gz: ca0c3d4b18afa6c6d76a9b9641143f402f71abd963c0fb463e0d3c664d8e977967fc9486e09c5b9c4e56095abb647ae7d441ace680321ff56279602e64c7f59c

data/README.md

@@ -6,13 +6,14 @@
 
 Created out of frustration. _"[D]amn yo[u], [G]mail!"_
 
-**Dug is a simple, configurable gem to organize your GitHub notification emails in
-ways Gmail can't and in an easier-to-configure way.** It interacts with Google's
-Gmail API to do all the things that people usually do with Gmail filters (label by
-organization name, repository name) as well as parse GitHub's custom X headers to
-label your messages with things like "Mentioned by name", "Assigned to me",
-"Commented", etc.
+**Dug is a simple, configurable gem to organize your GitHub notification emails
+in ways Gmail can't and in an easier-to-maintain way than large, slow Google
+Apps Scripts.** It interacts with Google's Gmail API to do all the things that
+people usually do with Gmail filters (label by organization name, repository
+name) as well as parse GitHub's custom X headers to label your messages with
+things like "Mentioned by name", "Assigned to me", "Commented", etc.
 
+![](http://screenshots.chrisarcand.com/permxqkc5.jpg)
 
 ## Quick Installation
 
@@ -23,13 +24,13 @@ whatever).
 
 Basic installation steps:
 
-1. Install Dug
+1. **Install Dug**
 
   ```
   $ gem install dug
   ```
 
-2. Create a YAML Rule file. Example (`dug_rules.yml`):
+2. **Create a YAML Rule file.** Example (`dug_rules.yml`):
 
   ```
   ---
@@ -63,12 +64,24 @@ Basic installation steps:
   * Label notifications with `Team mention` if a team I am a part of is mentioned in it.
   * Label notifications with `Assigned to me` if the Issue/PR is assigned to me.
 
-3. Create all of the labels in the preceding step in Gmail, if you haven't already.
+3. **Configure Gmail.** In Gmail...
 
-4. Create a project in the [Google Developers Console](https://console.developers.google.com) to authenticate to the
+   * Create the label "GitHub" and then "Unprocessed" nested underneath it (will show up as "GitHub/Unprocessed").
+   * Create all of the labels in the preceding step if you don't have them already.
+   * Set up the following filters:
+     ```
+     Matches: from:(notifications@github.com)
+     Do this: Apply label "GitHub/Unprocessed"
+
+     # This filter is optional but highly recommended.
+     Matches: from:(notifications@github.com) -{cc: youremail@example.non}
+     Do this: Skip Inbox
+     ```
+
+4. **Create a project in the [Google Developers Console](https://console.developers.google.com)** to authenticate to the
    Gmail API via OAuth 2.0. If you need help, detailed instructions are included further in this document.
 
-5. Create a script. Example (`script.rb`; fill in your OAuth credentials):
+5. **Create a runner script.** Example (`script.rb`; fill in your OAuth credentials):
 
    ```ruby
    require 'dug'
@@ -85,7 +98,7 @@ Basic installation steps:
    Dug::Runner.run
    ```
 
-6. Run the script and watch your notifications get organized! The first time your run this you will be given a link to
+6. **Run the script** and watch your notifications get organized! The first time your run this you will be given a link to
    visit in your browser to sign in to Gmail verify via a one time token.
 
   ```
@@ -96,7 +109,10 @@ Basic installation steps:
    just write a loop in your script `loop do; Dug::Runner.run; sleep 60; end`. How you run it is completely up to you,
    and really doesn't matter.
 
-For more help, see verbose instructions below.
+Woo, you're done! Now organizing GitHub notifications, after you subscribe to something on GitHub, is as easy as making
+a label and adding it to your rules YAML.
+
+**For more help, see verbose instructions below.**
 
 ## Verbose Installation/Usage
 
@@ -171,6 +187,12 @@ 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.
 
+## TODO
+* Add option to parse message body for labelling
+* Add more built-in reasons such as "Closed" statuses
+* The Google Auth Library has an API for Redis that could be supported easily.
+* Moar tests, plz
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/chrisarcand/dug.

data/lib/dug/version.rb

@@ -1,3 +1,3 @@
 module Dug
-  VERSION = "0.1.0.alpha2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dug
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha2
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Arcand
@@ -106,9 +106,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1