TokiCLI 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db9fe2bb7c5986f94a5990b01813fa6daf6aa17e
-  data.tar.gz: bcb36afe15205c5b6cb58a7ac356634ac00d85ed
+  metadata.gz: 57d68e57afaea0eb395e8ff1c9812120f3ef38f1
+  data.tar.gz: 88db8f5eb97538cb4875ae60cba14fed3ae832ef
 SHA512:
-  metadata.gz: a6f27e0aab7776aea2e9778a34ec32e5f01a06f8f36a47c1c16fcea66faccdb5d894d277d607c7eaba35b188064558fde4e7ac22d61ac2f5ccc10afb0637fa68
-  data.tar.gz: 96366f7ca1a02727c778895514d5300ba45ff1a738dcac2a4a7a7284f4c265e68fc84002fe12ae4fdd0e6c0b7951f4c326ee5471da0dfff5009c0f5c89cd90fa
+  metadata.gz: 50bc4c6af9b2d8c80b0941e698bfa31706d6e2c6a2105dc4854a33f70609c7465007e22acb24cd11f00b980d8cf5567abd8db36f6ac446b5b3de55c171692e79
+  data.tar.gz: 6ff97c30d19c09da4455d8f35e9ba93cd6e376a251122deee42f0c998ef26a048afeb31ad8c83a7c758ee58b8631927892ec38bdb170a18347f30917a17b039c

data/.gitignore

@@ -22,3 +22,5 @@ tmp
 mkmf.log
 token
 .tags
+lib/TokiServer/.sass-cache
+.sublime*

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.2.0
+
+- Toki server (serves API + web pages)
+- Files are backed up and saved in ~/.TokiCLI
+- No more database backup duplicates
+- SQL requests are more efficient
+
 # 0.1.1
 
 - Fixed a dependency in the now yanked 0.1.0

data/README.md

@@ -1,10 +1,39 @@
+- [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. 
+Toki.app command-line client and API server. 
 
-Access your Toki data from the local database or from the App.net backup channel.
+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://files.app.net/2dxzh_bHz.png)  
+![TokiCLI](https://www.evernote.com/shard/s89/sh/dd392b00-82b6-4f13-b573-c925a99ae5a0/02aa5ea4266e8bc7e28d7c91ba8b922c/deep/0/toki-server.png)  
 
 
 ## Installation
@@ -148,11 +177,11 @@ Export the Toki results as a CSV file with the `-c` option:
 
 `toki top -n 10 -c` 
 
-## Restore database from App.net
+### Restore database from App.net
 
 Toki.app backs up your Toki tracked apps data 'in the cloud' via an App.net channel.
 
-TokiCLI is 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.
+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`
 
@@ -160,17 +189,34 @@ TokiCLI is able to download this data and *rebuild the Toki database* if you los
 
 # API
 
-There's a special API if you want to use TokiCLI as a module in another app.
+## Local server for the API
+
+`toki serve`  
+
+You can see a list of requests on the index page: *http://localhost:4567*.
+
+Examples of API calls with curl:
 
 ```
-require 'TokiCLI/API/dbapi'
+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
 ```  
 
-First of all, create a TokiCLI/API instance:
+Remove the "/api" part of the URL to access rendered views of the responses.  
 
-`toki = TokiCLI::DBAPI.new`
+## Endpoints  
 
-## Endpoints
+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:
 

data/TokiCLI.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = TokiCLI::VERSION
   spec.authors       = ["Eric Dejonckheere"]
   spec.email         = ["eric@aya.io"]
-  spec.summary       = %q{Toki.app command-line client}
-  spec.description   = %q{Toki.app command-line client: read your Toki data from the local database or from the App.net backup channel. Show the log for an app, the top apps, the grand total, usage by day or range of days, etc.}
+  spec.summary       = %q{Toki.app command-line client and API server}
+  spec.description   = %q{Toki.app command-line client: read your Toki data from the local database or from the App.net backup channel. Show the log for an app, the top apps, the grand total, usage by day or range of days, etc. Use the API in another app, or launch the local server.}
   spec.homepage      = "https://github.com/ericdke/TokiCLI"
   spec.license       = "MIT"
 
@@ -25,6 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "amalgalite", "~> 1.3"
   spec.add_dependency "terminal-table", "~> 1.4"
   spec.add_dependency "CFPropertyList", "~> 2.2"
+  spec.add_dependency 'sinatra', '~> 1.4', '>= 1.4.5'
+  spec.add_dependency "thin", "~> 1.6"
+  spec.add_dependency 'sinatra-assetpack', "~> 0.3", '>= 0.3.2'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/lib/API/dbapi.rb

@@ -24,6 +24,7 @@ module TokiCLI
     # Get the total time for an app given its exact bundle identifier
     def bundle_total bundle_id, orig = nil
       sec = (@db.execute("SELECT sum(totalSeconds) FROM #{@table} WHERE bundleIdentifier IS '#{bundle_id}'").flatten)[0]
+      sec = 0 if sec.nil?
       args = if orig.nil?
         [bundle_id]
       else
@@ -57,6 +58,7 @@ module TokiCLI
     # Get the total time for an app given its exact bundle identifier, since a specific day
     def bundle_total_since bundle_id, day, orig = nil
       since = (@db.execute("SELECT sum(totalSeconds) FROM #{@table} WHERE bundleIdentifier IS '#{bundle_id}' AND activeFrom >= #{Time.parse(day).to_i}").flatten)[0]
+      since = 0 if since.nil?
       args = if orig.nil?
         [bundle_id, day]
       else
@@ -84,13 +86,14 @@ module TokiCLI
       if bun['meta']['code'] == 200
         bundle_total_since bun['data']['bundle'], day, name
       else
-        @helpers.json_nodata
+        return_422 'name_total_since', [name, day]
       end
     end
 
     # Get the total time for an app given its exact bundle identifier, before a specific day
     def bundle_total_before bundle_id, day, orig = nil
       before = (@db.execute("SELECT sum(totalSeconds) FROM #{@table} WHERE bundleIdentifier IS '#{bundle_id}' AND activeFrom < #{Time.parse(day).to_i}").flatten)[0]
+      before = 0 if before.nil?
       args = if orig.nil?
         [bundle_id, day]
       else
@@ -118,7 +121,7 @@ module TokiCLI
       if bun['meta']['code'] == 200
         bundle_total_before bun['data']['bundle'], day, name
       else
-        @helpers.json_nodata
+        return_422 'name_total_before', [name, day]
       end
     end
 
@@ -126,6 +129,8 @@ module TokiCLI
     def bundle_total_split bundle_id, day, orig = nil
       before = (@db.execute("SELECT sum(totalSeconds) FROM #{@table} WHERE bundleIdentifier IS '#{bundle_id}' AND activeFrom < #{Time.parse(day).to_i}").flatten)[0]
       since = (@db.execute("SELECT sum(totalSeconds) FROM #{@table} WHERE bundleIdentifier IS '#{bundle_id}' AND activeFrom >= #{Time.parse(day).to_i}").flatten)[0]
+      before = 0 if before.nil?
+      since = 0 if since.nil?
       args = if orig.nil?
         [bundle_id, day]
       else
@@ -159,7 +164,7 @@ module TokiCLI
       if bun['meta']['code'] == 200
         bundle_total_split bun['data']['bundle'], day, name
       else
-        @helpers.json_nodata
+        return_422 'name_total_split', [name, day]
       end
     end
 
@@ -171,25 +176,22 @@ module TokiCLI
       else
         [bundle_id, day1, day2, orig]
       end
-      if total.nil?
-        @helpers.json_nodata
-      else
-        { meta: {
-            code: 200,
-            request: {command: 'bundle_total_range', args: args, processed_at: Time.now}
-          },
-          data: {
-            bundle: bundle_id,
-            name: @helpers.find_app_name(bundle_id),
-            from: day1,
-            to: day2,
-            total: {
-              seconds: total,
-              time: @helpers.sec_to_time(total)
-            }
+      total = 0 if total.nil?
+      { meta: {
+          code: 200,
+          request: {command: 'bundle_total_range', args: args, processed_at: Time.now}
+        },
+        data: {
+          bundle: bundle_id,
+          name: @helpers.find_app_name(bundle_id),
+          from: day1,
+          to: day2,
+          total: {
+            seconds: total,
+            time: @helpers.sec_to_time(total)
           }
-        }.to_json
-      end
+        }
+      }.to_json
     end
 
     # Get the total time for an app given a (partial) name, between two specific days
@@ -198,7 +200,7 @@ module TokiCLI
       if bun['meta']['code'] == 200
         bundle_total_range bun['data']['bundle'], day1, day2, name
       else
-        @helpers.json_nodata
+        return_422 'name_total_range', [name, day1, day2]
       end
     end
 
@@ -214,18 +216,22 @@ module TokiCLI
           time: @helpers.sec_to_time(sec)
         }}
       }
-      result.sort_by! {|obj| obj[:total][:seconds]}
-      {
-        meta: {
-          code: 200,
-          request: {command: 'apps_range', args: [day1, day2], processed_at: Time.now}
-        },
-        data: {
-          from: day1,
-          to: day2,
-          apps: result
-        }
-      }.to_json
+      if result.empty?
+        return_422('apps_range', [day1, day2])
+      else
+        result.sort_by! {|obj| obj[:total][:seconds]}
+        {
+          meta: {
+            code: 200,
+            request: {command: 'apps_range', args: [day1, day2], processed_at: Time.now}
+          },
+          data: {
+            from: day1,
+            to: day2,
+            apps: result
+          }
+        }.to_json
+      end
     end
 
     # Get all apps used on a specific day
@@ -233,48 +239,60 @@ module TokiCLI
       date = DateTime.strptime(day, '%Y-%m-%d')
       response = @db.execute("SELECT bundleIdentifier,sum(totalSeconds) FROM #{@table} WHERE activeFrom >= #{date.to_time.to_i} AND activeFrom < #{date.next_day.to_time.to_i} GROUP BY bundleIdentifier")
       result = make_apps response
-      {
-        meta: {
-          code: 200,
-          request: {command: 'apps_day', args: [day], processed_at: Time.now}
-        },
-        data: {
-          date: day,
-          apps: result
-        }
-      }.to_json
+      if result.empty?
+        return_422 'apps_day', [day]
+      else
+        {
+          meta: {
+            code: 200,
+            request: {command: 'apps_day', args: [day], processed_at: Time.now}
+          },
+          data: {
+            date: day,
+            apps: result
+          }
+        }.to_json
+      end
     end
 
     def apps_since day
       date = DateTime.strptime(day, '%Y-%m-%d')
       response = @db.execute("SELECT bundleIdentifier,sum(totalSeconds) FROM #{@table} WHERE activeFrom >= #{date.to_time.to_i} GROUP BY bundleIdentifier")
       result = make_apps response
-      {
-        meta: {
-          code: 200,
-          request: {command: 'apps_since', args: [day], processed_at: Time.now}
-        },
-        data: {
-          since: day,
-          apps: result
-        }
-      }.to_json
+      if result.empty?
+        return_422 'apps_since', [day]
+      else
+        {
+          meta: {
+            code: 200,
+            request: {command: 'apps_since', args: [day], processed_at: Time.now}
+          },
+          data: {
+            since: day,
+            apps: result
+          }
+        }.to_json
+      end
     end
 
     def apps_before day
       date = DateTime.strptime(day, '%Y-%m-%d')
       response = @db.execute("SELECT bundleIdentifier,sum(totalSeconds) FROM #{@table} WHERE activeFrom < #{date.to_time.to_i} GROUP BY bundleIdentifier")
       result = make_apps response
-      {
-        meta: {
-          code: 200,
-          request: {command: 'apps_before', args: [day], processed_at: Time.now}
-        },
-        data: {
-          before: day,
-          apps: result
-        }
-      }.to_json
+      if result.empty?
+        return_422 'apps_before', [day]
+      else
+        {
+          meta: {
+            code: 200,
+            request: {command: 'apps_before', args: [day], processed_at: Time.now}
+          },
+          data: {
+            before: day,
+            apps: result
+          }
+        }.to_json
+      end
     end
 
     # Get totals of all tracked apps
@@ -294,14 +312,33 @@ module TokiCLI
     # Get totals of top tracked apps
     def apps_top number = 5
       result = make_total
+      args = [number]
       index = -number
+      apps = result[index..-1]
+      if apps.nil?
+        return_422 'apps_top', args
+      else
+        {
+          meta: {
+            code: 200,
+            request: {command: 'apps_top', args: args, processed_at: Time.now}
+          },
+          data: {
+            apps: apps
+          }
+        }.to_json
+      end
+    end
+
+    def return_422 command_name, args
       {
         meta: {
-          code: 200,
-          request: {command: 'apps_top', args: [number], processed_at: Time.now}
+          code: 422,
+          request: {command: command_name, args: args, processed_at: Time.now},
+          message: 'No data returned by this request'
         },
         data: {
-          apps: result[index..-1]
+          apps: []
         }
       }.to_json
     end

data/lib/API/helpers.rb

@@ -37,7 +37,12 @@ module TokiCLI
 
     def humanized_date epoch
       human = seconds_to_time epoch
-      "#{human[:hours]}h #{human[:minutes]}m #{human[:seconds]}s"
+      "#{'%.2d' % human[:hours]}h #{'%.2d' % human[:minutes]}m #{'%.2d' % human[:seconds]}s"
+    end
+
+    def humanized_minutes_seconds epoch
+      human = seconds_to_time epoch
+      "#{'%.2d' % human[:minutes]}m #{'%.2d' % human[:seconds]}s"
     end
 
     def seconds_to_time epoch
@@ -54,7 +59,7 @@ module TokiCLI
     def oops error
       puts "\nOOPS! A gremlin crashed the app.\n\n"
       puts "STACK: #{caller}\n\n"
-      abort "GREMLIN: #{error}\n\n"
+      puts "GREMLIN: #{error}\n\n"
     end
 
     def epoch_to_date epoch
@@ -74,12 +79,51 @@ module TokiCLI
       bundle_ids
     end
 
+    def scan_app_icons
+      @bundles.each do |k,v|
+        gs = v.gsub(' ', '\ ')
+        where = "/Applications/#{gs}.app/Contents/Resources/*.icns"
+        files = Dir.glob(where)
+        candidates = files.select {|f| File.basename(f) ==  "Icon.icns" || File.basename(f, ".icns").downcase =~ /#{v.downcase}/}
+        puts "#{v} => #{candidates}"
+      end
+    end
+
     # Scan for names from bundle ids
     def get_bundle_ids params = {}
       @infos = {}
       get_bundles(get_plists("/Applications/*/Contents/*"), params)
       get_bundles(get_plists("/Applications/Utilities/*/Contents/*"), params)
       get_bundles(get_plists("#{@home_path}/Applications/*/Contents/*"), params)
+      specials = {
+        'com.evernote.EvernoteHelper' => 'Evernote Helper',
+        'com.apple.finder' => 'Finder',
+        'com.apple.ReportPanic' => 'Kernel Panic',
+        'com.apple.coreservices.uiagent' => 'CoreServices UIAgent',
+        'com.apple.installer' => 'Apple Installer',
+        'com.apple.frameworks.diskimages.diuiagent' => 'Apple Disk Images Agent',
+        'com.mediaatelier.CheatSheet' => 'Cheat Sheet',
+        'com.vyprvpn.authorization' => 'VyprVPN',
+        'com.apple.WebKit.WebContent' => 'Safari module',
+        'com.apple.ProblemReporter' => 'Apple Problem Reporter',
+        'org.andymatuschak.sparkle.finish-installation' => 'Sparkle Install',
+        'com.noodlesoft.HazelHelper' => 'Hazel Helper',
+        'de.appsolute.MAMP' => 'MAMP',
+        'com.apple.KeyboardSetupAssistant' => 'Apple Keyboard Setup Assistant',
+        'com.apple.NetAuthAgent' => 'Apple Net Auth Agent',
+        'com.adobe.acc.AdobeCreativeCloud' => 'Adobe Creative Cloud',
+        'com.apple.iphonesimulator' => 'Apple iPhone Simulator',
+        'com.macromates.TextMate.preview' => 'TextMate',
+        'com.alfredapp.Alfred' => 'Alfred',
+        'com.runningwithcrayons.Alfred-Preferences' => 'Alfred Preferences',
+        'com.apple.WebKit.PluginProcess' => 'Safari Plugin',
+        'com.apple.ScreenSharing' => 'Apple Screen Sharing',
+        'org.virtualbox.app.VirtualBoxVM' => 'VirtualBox',
+        '2BUA8C4S2C.com.agilebits.onepassword-osx-helper' => '1Password Helper'
+      }
+      specials.each do |k, v|
+        @infos[k] = v
+      end
       @infos
     end
 
@@ -95,7 +139,7 @@ module TokiCLI
     def meta_nodata
       {
         code: 404,
-        error: { message: 'No data returned from the database' }
+        message: 'No data returned from the database'
       }
     end