TokiCLI 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13c76e7823ff774b8ccfe4af10201d6ea64afb6e
-  data.tar.gz: 3b7450b26fb26fba73dacda65d4f7d8e95b1cfd2
+  metadata.gz: 9d881a874cdf17efa2db5ad24c0ab808d5a89fc7
+  data.tar.gz: 118745d1d2ee3ab2e4108115303f99fc507ed1c1
 SHA512:
-  metadata.gz: c6e91245035e3dbd2939fdcb3af86249143df5c549068001ca91a7418692165c31585be41fb09ee0eb14db2fe46b481ef04ab94dcb9d45a9144af85e7535a4f8
-  data.tar.gz: 5c206edc01a9d1e385509d32c1c7c5b6d5de59fc79b7f8981a4bab1864564d082748c94e9f93bcf23c7e431de9d685530b48297a73c83b4bd1d17a145596fad9
+  metadata.gz: 6ea00b551307a61234ffed4f78fcbbd8bb355e5831a88903107eadcf7e3ead7281b2f225dc5e173d2a60c243ac2a392c72776803e0d800bc382c60687d129ff1
+  data.tar.gz: d9d1c10fa33308227dbcb96e5ebbb497dc50f2d88a1338765d6c8ccd6bda7ece83b872b3631555e2597e00fb02bc3662c725ccc616abcc28358dd07127895207

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -1,20 +1,11 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
+/.bundle/
+/.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+tmp/
 *.bundle
 *.so
 *.o
@@ -22,5 +13,6 @@ tmp
 mkmf.log
 token
 .tags
-lib/TokiServer/.sass-cache
+.sass-cache/
 .sublime*
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--fail-fast

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.3.0
+
+- Complete refactoring
+
 # 0.2.1
 
 - Fixed the "log" method in the CLI

data/README.md

@@ -1,39 +1,10 @@
-- [TokiCLI](#tokicli)
-	- [Installation](#installation)
-	- [Usage](#usage)
-		- [Total](#total)
-		- [Top](#top)
-		- [Day](#day)
-		- [Since](#since)
-		- [Before](#before)
-		- [Range](#range)
-		- [App](#app)
-		- [App before](#app-before)
-		- [App since](#app-since)
-		- [App day](#app-day)
-		- [App range](#app-range)
-		- [Log](#log)
-		- [Scan](#scan)
-		- [Auth](#auth)
-		- [Global option: JSON](#global-option-json)
-		- [Global option: CSV](#global-option-csv)
-		- [Restore database from App.net](#restore-database-from-appnet)
-- [API](#api)
-	- [Local server for the API](#local-server-for-the-api)
-	- [Endpoints](#endpoints)
-	- [Tools](#tools)
-- [Toki](#toki)
-	- [Important](#important)
-	- [Next](#next)
-	- [Thanks](#thanks)
-
 # TokiCLI
 
 Toki.app command-line client and API server. 
 
 Access your Toki data from the local database or from the App.net backup channel, via the CLI interface or the served API.
 
-![TokiCLI](https://www.evernote.com/shard/s89/sh/dd392b00-82b6-4f13-b573-c925a99ae5a0/02aa5ea4266e8bc7e28d7c91ba8b922c/deep/0/toki-server.png)  
+![TokiServer example](https://www.evernote.com/shard/s89/sh/dd392b00-82b6-4f13-b573-c925a99ae5a0/02aa5ea4266e8bc7e28d7c91ba8b922c/deep/0/toki-server.png)  
 
 
 ## Installation
@@ -42,6 +13,20 @@ Access your Toki data from the local database or from the App.net backup channel
 
 ## Usage
 
+### Help
+
+`toki`
+
+shows the basic commands.
+
+`toki help <command>`
+
+shows help and available options for a specific command.
+
+Example:
+
+`toki help bundle`
+
 ### Total
 
 The **total** command shows the total usage time for all apps.
@@ -88,60 +73,74 @@ The **range** command shows your top used apps between two specific days.
 
 ### App
 
-Total tracked time for an app
+Complete log for an app
+
+`toki app airmail`
+
+Several apps may contain the same name. In that case, they will all be processed.
+
+Example: `toki app apple`  
 
-`toki app iterm`
+#### App before
 
-You don't have to specify the exact name of the identifier: for example, typing 'iterm' will find 'com.googlecode.iterm2'.
+Complete log for an app before a specific day
 
-However, you can specify a bundle identifier if you need it.
+`toki app airmail --before 2014-04-19`
 
-`toki app --bundle 'com.googlecode.iterm2'`
 
-### App before
+#### App since
 
-Total tracked time for an app before a specific day
+Complete log for an app since a specific day
 
-`toki app_before iterm 2014-04-19`
+`toki app airmail --since 2014-04-19`
 
-`toki app_before --bundle 'com.googlecode.iterm2' 2014-04-19`
 
+#### App day
 
-### App since
+Complete log for an app on a specific day
 
-Total tracked time for an app since a specific day
+`toki app airmail --day 2014-04-19`
 
-`toki app_since iterm 2014-04-19`
+#### App range
 
-`toki app_since --bundle 'com.googlecode.iterm2' 2014-04-19`
+Complete log for an app between two specific days
 
+`toki app airmail --range 2014-04-19 2014-05-12`
 
-### App day
 
-Total tracked time for an app on a specific day
+### Bundle
 
-`toki app_day iterm 2014-04-19`
+Complete log for an app, given its exact bundle ID.
 
-`toki app_day --bundle 'com.googlecode.iterm2' 2014-04-19`
+Same features as for `app`, just give an app bundle instead of an app name.
 
-### App range
+This should always return only one app log.
+
+```
+toki bundle it.bloop.airmail
+toki bundle it.bloop.airmail --before 2014-04-19
+toki bundle it.bloop.airmail --since 2014-04-19
+toki bundle it.bloop.airmail --day 2014-04-19
+toki bundle it.bloop.airmail --range 2014-04-19 2014-05-12
+```  
 
-Total tracked time for an app between two specific days
+### Activity
 
-`toki app_range iterm 2014-04-19 2014-04-23`
+Recent Toki activity log.
 
-`toki app_range --bundle 'com.googlecode.iterm2' 2014-04-19 2014-04-23`
+`toki activity`
 
+#### Activity since
 
-### Log
+Complete Toki activity log since a specific day.
 
-The **log** command shows the entire log (history) for one app.
+`toki activity --since 2014-04-19`
 
-`toki log iterm`
+#### Activity day
 
-`toki log --bundle 'com.googlecode.iterm2'`
+Complete Toki activity log for a specific day.
 
-The results are sorted by ascending date and time.
+`toki activity --day 2014-04-19`
 
 ### Scan
 
@@ -149,154 +148,101 @@ Scan for apps name.
 
 Will crawl the Applications folder and try to resolve app names from bundle identifiers.
 
-Toki will display apps names in results if apps have been scanned.  
+*Toki can display apps names in results only if apps have been scanned.* 
+  
 
-### Auth
+### Option: JSON
 
-In order to be able to access your ADN channel (optional), TokiCLI has to obtain a "token" (secret code) from App.net.
+Export the Toki results as a JSON file with the `--json` option:
 
-Just do `toki auth` and follow the steps, this is fast and easy.  
+`toki total --json`
 
-### Global option: JSON
+`toki day 2014-04-18 --json `
 
-Export the Toki results as a JSON file with the `-j` option:
+`toki top -n10 -J` 
 
-`toki total -j`
+### Option: CSV
 
-`toki day 2014-04-18 -j`
+Export the Toki results as a CSV file with the `--csv` option:
 
-`toki top -n 10 -j` 
+`toki total --csv`
 
-### Global option: CSV
+`toki day 2014-04-18 --csv`
 
-Export the Toki results as a CSV file with the `-c` option:
+`toki top -n10 -C` 
 
-`toki total -c`
+### Delete
 
-`toki day 2014-04-18 -c`
+Completely delete all traces of an app in the database.
 
-`toki top -n 10 -c` 
+With backup:
+
+`toki delete it.bloop.airmail`
+
+Without backup:
+
+`toki delete it.bloop.airmail --no-backup`
 
 ### Restore database from App.net
 
 Toki.app backs up your Toki tracked apps data 'in the cloud' via an App.net channel.
 
-TokiCLI should be able to download this data and *rebuild the Toki database* if you lost your local install or you're simply moving toki.app to a new machine.
-
-`toki auth`
+TokiCLI should be able to download this data and *rebuild the Toki database* if you lost your local install or if it has been compromised.
 
 `toki restore`  
 
 # API
 
-## Local server for the API
+## Server for the API
 
 `toki serve`  
 
-You can see a list of requests on the index page: *http://localhost:4567*.
+Returns a JSON response for each request.
 
 Examples of API calls with curl:
 
 ```
 curl http://localhost:4567/api/apps/top/10
-curl http://localhost:4567/api/find/safari/log
-curl http://localhost:4567/api/find/safari/since/2014-05-27
-curl http://localhost:4567/api/bundle/com.apple.Safari/before/2014-05-27
 curl http://localhost:4567/api/apps/day/2014-05-27
 curl http://localhost:4567/api/apps/range/2014-05-27/2014-05-30
+curl http://localhost:4567/api/logs/app/safari/
+curl http://localhost:4567/api/logs/app/safari/since/2014-05-27
+curl http://localhost:4567/api/logs/bundle/com.apple.Safari/before/2014-05-27
+curl http://localhost:4567/api/user
+curl http://localhost:4567/api/bundles
 ```  
 
-Remove the "/api" part of the URL to access rendered views of the responses.  
+Find the list of all endpoints with `curl http://localhost:4567/api`.
 
-## Endpoints  
+## Library  
 
-You can also use the TokiCLI API in another app.
+You can also use the TokiCLI API in another app:
 
 `require 'TokiCLI'`  
 
-Create a TokiCLI API instance:
-
-`toki = TokiCLI::DBAPI.new`
-
-Get the total time for an app, in seconds, given its exact bundle identifier:
-
-`time = toki.bundle_total 'com.sublimetext.3'`
-
-With a (partial) name:
-
-`time = toki.name_total 'sublime'`
-
-Get the total time for an app, in seconds, given its exact bundle identifier, since a specific day:
-
-`time = toki.bundle_total_since 'com.sublimetext.3', '2014-05-15'`
-
-With a (partial) name:
-
-`time = toki.name_total_since 'sublime', '2014-05-15'`
+### Basic
 
-Get the total time for an app, in seconds, given its exact bundle identifier, before a specific day:
+Create a basic TokiCLI API instance:
 
-`time = toki.bundle_total_before 'com.sublimetext.3', '2014-05-15'`
+`toki = TokiCLI::TokiAPI.new("#{~/Library/path/to/tokiapp/db}")`
 
-With a (partial) name:
+*That's the format used by the test suite.*
 
-`time = toki.name_total_before 'sublime', '2014-05-15'`
+### With apps names
 
-Get the total time for an app, in seconds, given its exact bundle identifier, before and since a specific day:
+Create a TokiCLI FileOps instance:
 
-`time = toki.bundle_total_split 'com.sublimetext.3', '2014-05-15'`
+`fileops = TokiCLI::FileOps.new`
 
-With a (partial) name:
+Scan for apps names (see ##Tools):
 
-`time = toki.name_total_split 'sublime', '2014-05-15'`
+`fileops.save_bundles`
 
-Get the total time for an app, in seconds, given its exact bundle identifier, between two specific days:
-
-`time = toki.bundle_total_range 'com.sublimetext.3', '2014-05-15', '2014-05-17'`
-
-With a (partial) name:
-
-`time = toki.name_total_range 'sublime', '2014-05-15', '2014-05-17'`
-
-Get the total time of all apps used between day 1 and day 2:
-
-`apps = toki.apps_range '2014-05-15', '2014-05-17'`
-
-Get the total time of all apps used on a specific day:
-
-`apps = toki.apps_day '2014-05-15'`
-
-Get the total time of all tracked apps:
-
-`apps = toki.apps_total`
-
-Get the top x tracked apps (5 by default):
-
-`apps = toki.apps_top 10`
-
-Get the complete log for an app:
-
-`log = toki.bundle_log 'com.sublimetext.3'`
-
-With a (partial) name:
-
-`log = toki.name_log 'sublime text'`
-
-
-## Tools
-
-Scan disk for installed apps, get their names from their bundle identifiers and save the file (ignores unresolved identifiers):
-
-`app_names = toki.scan_apps`
-
-Get apps names and bundle identifiers (without re-scanning, and including unresolved identifiers):
-
-`app_names = toki.tracked_apps`
-
-Get bundle_id from app name or partial app name:
+Create a TokiCLI API instance:
 
-`bundle_id = toki.get_bundle_from_name 'sublime'`  
+`toki = TokiCLI::TokiAPI.new(fileops.db_file, fileops.bundles)`
 
+*See `toki_api.rb` and `fileops.rb` for the list of available methods.*
 
 # Toki
 
@@ -311,13 +257,3 @@ It's a time tracker for your apps that sits in the menu bar.
 **Tracking is the job of Toki.app by @keita.**
 
 TokiCLI interacts only with the Toki.app database or the App.net backup channel.
-
-## Next
-
-Teasing: TokiCLI has only read-only commands... for now. ;)
-
-## Thanks
-
-Keita was super nice and said "Awesome!" instead of just "Yes" or "GTFO" when I asked him if I could use the 'Toki' name for this companion Gem.
-
-Many thanks and congrats to Keita! :)

data/Rakefile

@@ -1,2 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec