checkoff 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac558deb21242fbafa8896765220574a9b7386ff
-  data.tar.gz: efe68230c0e4d485942c3bca5a7a21b94cb0acfa
+  metadata.gz: 8eda5499a65efce1e6439d1f91558d00e358dde1
+  data.tar.gz: 8390ace557f726d0a6a80bb3411de2459a2f5345
 SHA512:
-  metadata.gz: 7e67efc0190d8c58993e0657d3681da8266e274f246d7a15f13be90de50f12ead8c90d871289a5265e7e055e67107dfa8a8bdee44bd176f143ec444a97a2d132
-  data.tar.gz: 7dcffa12ba7ecf02b32d5cf48443214c5e265f76e7eed9324ce49effadbb21c904f25c8ebf3960ad3d1cbc08e80bcf6197727c4a409e75bc4aa229ec46459a39
+  metadata.gz: ef603fb6034b3b37d8587225a1fadf0dbd42e508197e22f9a075dd2a0fe7263ee7f75906098e0c4b50f1b7b743b4e1b85b9b21f049281eed0ded528b0e6a4d84
+  data.tar.gz: c94b4a269d580b99e6e44614ed070c770dee3ccfb909e8e9772e41a99d3bacbf725e993b8e8f193d5302c3f727bedbc9102c0c954887959a80e8aea9344cff62

data/README.md

@@ -3,31 +3,127 @@ Command-line and gem client for Asana (unofficial)
 [![Circle CI](https://circleci.com/gh/apiology/checkoff.svg?style=svg)](https://circleci.com/gh/apiology/checkoff)
 [![Travis CI](https://travis-ci.org/apiology/checkoff.svg?branch=master)](https://travis-ci.org/apiology/checkoff)
 
+## Using
+
+```
+$ checkoff --help
+View tasks:
+  checkoff view workspace project [section]
+
+'project' can be set to a project name, or :my_tasks, :my_tasks_upcoming, :my_tasks_new, or :my_tasks_today
+```
+
+Let's say we have a project like this:
+
+![project screenshot from asana.com](https://github.com/apiology/checkoff/raw/master/docs/example_project.png "Example project")
+
+Checkoff outputs things in JSON.  'jq' is a great tool to use in combination:
+
+```
+$ checkoff view 'Personal Projects' 'Create demo'
+{"":[{"name":"This is a task that doesn't belong to any sections."}],"Write it:":[{"name":"Write something"}],"Publish to github:":[{"name":"git push!"}],"Make sure it looks OK!:":[{"name":"Looks it up in your browser..."}]}
+$
+```
+
+```json
+$ checkoff view 'Personal Projects' 'Create demo' | jq
+{
+  "": [
+    {
+      "name": "This is a task that doesn't belong to any sections."
+    }
+  ],
+  "Write it:": [
+    {
+      "name": "Write something"
+    }
+  ],
+  "Publish to github:": [
+    {
+      "name": "git push!"
+    }
+  ],
+  "Make sure it looks OK!:": [
+    {
+      "name": "Looks it up in your browser..."
+    }
+  ]
+}
+```
+
+You can drill down into a section on the command line:
+
+```
+$ checkoff view 'Personal Projects' 'Create demo' 'Publish to github:'
+[{"name":"git push!"}]
+```
+
+You can use fun `jq` tricks:
+
+```json
+$ checkoff view 'Personal Projects' 'Create demo' | jq 'to_entries | map(.value) | flatten | map(.name)'
+[
+  "This is a task that doesn't belong to any sections.",
+  "Write something",
+  "git push!",
+  "Looks it up in your browser..."
+]
+```
+
+And even gather counts for project metrics:
+
+```bash
+$ checkoff view 'Personal Projects' 'Create demo' | jq 'to_entries | map(.value) | flatten | map(.name) | length'
+4
+$ 
+```
+
 ## Caching
 
 Note that I don't know of a way through the Asana API to target
 individual sections and pull back only those tasks, which is a real
 bummer!  As a result, sometimes the number of tasks brought back to
-answer a query is really large and takes a while.  To help make that
-less annoying, I do caching using memcached; you'll need to install
-it.
+answer a query is really large and takes a while--especially if you're
+querying on something like `:my_tasks_today`.  To help make that less
+annoying, I do caching using memcached; you'll need to install it.
+
+If you're working in real time with modifications in Asana, you may
+need to occasionally run `echo 'flush_all' | nc localhost 11211` to
+clear the cache.
 
 ## Installing
 
+This will work under OS X:
+
 ```bash
 brew install memcached
+ln -sfv /usr/local/opt/memcached/*.plist ~/Library/LaunchAgents
+launchctl load ~/Library/LaunchAgents/homebrew.mxcl.memcached.plist
 gem install checkoff
-
 ```
 
-## Using
+## Configuring
 
-```bash
-$ checkoff --help
-View tasks:
-  exe/checkoff view workspace project [section]
+You'll need to create a file called `.asana.yml` in your home directory, that looks like this:
 
-'project' can be set to a project name, or :my_tasks, :my_tasks_upcoming, :my_tasks_new, or :my_tasks_today
+```yaml
+---
+
+#
+# when you click on 'My Tasks' in Asana, put the number (just the
+# number) from the URL in the mapping below.
+#
+my_tasks:
+  'Your workspace name here': 'some_long_number'
+
+#
+
+# Click on your profile in the uppper right in Asana, go to 'My
+# Profile Settings', click on 'Apps', got o 'Manage Developer Apps',
+# and select 'Create New Personal Access Token'.  Note down the key
+# in this section.
+#
+personal_access_token: 'some_big_long_string_from_asana.com_here'
 ```
 
 ## Developing

data/coverage/.last_run.json

@@ -1,5 +1,5 @@
 {
   "result": {
-    "covered_percent": 98.31
+    "covered_percent": 98.65
   }
 }

data/lib/checkoff/cli.rb

@@ -21,9 +21,15 @@ module Checkoff
     end
 
     def task_to_hash(task)
-      {
+      task_out = {
         name: task.name,
       }
+      if task.due_on
+        task_out[:due] = task.due_on
+      elsif task.due_at
+        task_out[:due] = task.due_at
+      end
+      task_out
     end
 
     def tasks_to_hash(tasks)

data/lib/checkoff/config_loader.rb

@@ -5,7 +5,7 @@ require 'active_support/core_ext/hash'
 class ConfigLoader
   def self.load(sym)
     file = "#{sym}.yml"
-    YAML.load_file(File.expand_path("~/private/#{file}"))
+    YAML.load_file(File.expand_path("~/.#{file}"))
         .with_indifferent_access
   end
 end

data/lib/checkoff/projects.rb

@@ -64,7 +64,6 @@ module Checkoff
       if project_name.is_a?(Symbol) && project_name.to_s.start_with?('my_tasks')
         my_tasks(workspace_name)
       else
-        STDERR.puts "Looking for #{project_name} under #{workspace_name}"
         projects = projects_by_workspace_name(workspace_name)
         projects.find do |project|
           project.name == project_name

data/lib/checkoff/tasks.rb

@@ -12,8 +12,8 @@ module Checkoff
     LONG_CACHE_TIME = MINUTE * 15
     SHORT_CACHE_TIME = MINUTE * 5
 
-    def initialize
-      @sections = Checkoff::Sections.new
+    def initialize(sections: Checkoff::Sections.new)
+      @sections = sections
     end
 
     def tasks_minus_sections(tasks)

data/lib/checkoff/version.rb

@@ -1,3 +1,3 @@
 module Checkoff
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checkoff
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Vince Broz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-18 00:00:00.000000000 Z
+date: 2016-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dalli
@@ -173,6 +173,7 @@ files:
 - checkoff.gemspec
 - circle.yml
 - coverage/.last_run.json
+- docs/example_project.png
 - exe/checkoff
 - lib/checkoff.rb
 - lib/checkoff/cli.rb