TokiCLI 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b09a54e6095cd0db8771b463d7b0b42abcce848
-  data.tar.gz: a38757d420d82bba26f791d5db014034ddd0ca69
+  metadata.gz: c3cc53491a92de90d5c231b3494d66aee6d8e3a5
+  data.tar.gz: 443389d76b7e0e0544bf95d1e90f12c062a2f305
 SHA512:
-  metadata.gz: c038040cc9efe49a44e23b70e9c3341ccfbba70619248ebd1a198997f1f8ad1436f9ceae4f7e6e1a7256b605938f4cfa4f8e879cd93c48d8c620c88e79659097
-  data.tar.gz: b2301f6b6608aea4cbc75f616893c18f8e484223fece39d13cb7e4dc05a1e5ab42d229e1a1bde9c0833407cd65f18a81ecf446660ecbf06ff6ed8e88fc4b76b1
+  metadata.gz: 19cd81f0e087c55785c0bbdfe45821803fd47e75c3b353356d9f905083c926a18e994355b4ee74c3c6826f6bf472a173fb9fa26853aaeaa4f7d89855a91d87bb
+  data.tar.gz: 810aec844f4f02afb7d9950374a6517133b6145ec3b79941e990f6199a8b2dfb80c01bb5b5abd52b4d17884551ca531b6a84addc1afa99c1243a636f4423a937

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.0.3
+
+- New command: day
+- New command: range
+- A few fixes
+- Option: export result as json file
+
 # 0.0.2
 
 - Repo URL

data/README.md

@@ -4,6 +4,9 @@ Toki.app command-line client.
 
 Access your Toki data from the local database or from the App.net backup channel.
 
+![TokiCLI](https://files.app.net/21krs3SJm.png)  
+
+
 ## Installation
 
     gem install TokiCLI
@@ -40,13 +43,29 @@ TokiCLI shows the top 5 by default, but you can specify a number with the `-n` o
 
 `toki top -n 10`
 
+### Day
+
+The **day** command shows your top used apps on a specific day.
+
+The date you type has to be formatted like this: year-month-day
+
+`toki day 2014-04-19`
+
+### Range
+
+The **range** command shows your top used apps between two specific days.
+
+The dates you type have to be formatted like this: year-month-day and separated by a single space.
+
+`toki range 2014-04-17 2014-04-19`
+
 ### Auth
 
 In order to be able to access your ADN channel (optional), you have to obtain a "token" (secret code) from App.net: go to your App.net account page, click "Your apps" then find "Create a token for yourself."
 
 The last step is simply to do `toki auth` and paste the token.
 
-### Global option
+### Global option: ADN
 
 TokiCLI accesses the local Toki database by default.
 
@@ -56,7 +75,17 @@ If you want to access the App.net backup channel instead, you have to specify th
 
 `toki log vlc -a`
 
-`toki top -n 10 -a`  
+`toki top -n 10 -a` 
+
+### Global option: JSON
+
+Export the Toki results as a JSON file with the `-j` option:
+
+`toki total -j`
+
+`toki day 2014-04-18 -j`
+
+`toki top -n 10 -j` 
 
 
 ## Toki

data/TokiCLI.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   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, delete data from both...}
+  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.homepage      = "https://github.com/ericdke/TokiCLI"
   spec.license       = "MIT"
 

data/lib/TokiCLI/app.rb

@@ -6,21 +6,26 @@ module TokiCLI
 
     desc "total", "Shows the total usage of all apps"
     option :adn, aliases: '-a', type: :boolean, desc: 'Select ADN channel as source (toki total -a)'
+    option :json, aliases: '-j', type: :boolean, desc: 'Export the results as a JSON file'
     def total
       toki = create_toki(options)
-      get_total(toki, options)
+      apps = get_total(toki, options)
+      clear
+      puts TokiCLI::View.new.total_table(apps)
+      puts "\n"
+      export(:json, apps, "toki-total-#{Time.now.to_s[0..9]}") if options[:json]
     end
 
     desc "top", "Shows your most used apps"
     option :adn, aliases: '-a', type: :boolean, desc: 'Select ADN channel as source (toki top -a)'
-    option :number, aliases: '-n', type: :numeric, desc: 'Specifi the number of apps (toki top -n 10)'
+    option :number, aliases: '-n', type: :numeric, desc: 'Specify the number of apps (toki top -n 10)'
+    option :json, aliases: '-j', type: :boolean, desc: 'Export the results as a JSON file'
     def top
-      toki = create_toki(options)
-      entries = toki.get_content(options)
+      toki, entries = init(options)
       clear
       hits = toki.top(entries, options[:number] || 5)
-      puts TokiCLI::View.new.hits_table(hits.reverse)
-      puts "\n"
+      view_hits_table(hits)
+      export(:json, hits, "toki-top-#{Time.now.to_s[0..9]}") if options[:json]
     end
 
     desc "auth", "Input your App.net token for authorization"
@@ -34,19 +39,90 @@ module TokiCLI
 
     desc "log APP", "Shows the complete log for an app"
     option :adn, aliases: '-a', type: :boolean, desc: 'Select ADN channel as source (toki log -a)'
+    option :json, aliases: '-j', type: :boolean, desc: 'Export the results as a JSON file'
     def log(*args)
       abort(Status.specify_name) if args.empty?
       asked = args[0]
-      toki = create_toki(options)
-      entries = toki.get_content(options)
+      toki, entries = init(options)
       app_data = toki.get_app(asked, entries)
-      v = TokiCLI::View.new
-      puts v.app_table(asked, app_data)
-      puts "\n"
+      view_app_table(asked, app_data)
+      export(:json, app_data, "toki-log-#{asked}-#{Time.now.to_s[0..9]}") if options[:json]
+    end
+
+    desc "day DATE", "Shows all apps used on a specific day (toki day 2014-04-19)"
+    option :adn, aliases: '-a', type: :boolean, desc: 'Select ADN channel as source (toki day 2014-04-19 -a)'
+    option :json, aliases: '-j', type: :boolean, desc: 'Export the results as a JSON file'
+    def day(*args)
+      abort(Status.specify_day) if args.empty?
+      begin
+        date = DateTime.strptime(args[0], '%Y-%m-%d')
+      rescue ArgumentError
+        abort(Status.specify_day)
+      end
+      toki, entries = init(options)
+      day_data = toki.get_day(date, entries, options)
+      clear
+      view_day_table(args[0], day_data)
+      export(:json, day_data, "toki-day-#{args[0]}") if options[:json]
     end
 
+    desc "range DAY1 DAY2", "Shows all apps used between day 1 and day 2 (toki range 2014-04-16 2014-04-18)"
+    option :adn, aliases: '-a', type: :boolean, desc: 'Select ADN channel as source (toki range 2014-04-16 2014-04-18 -a)'
+    option :json, aliases: '-j', type: :boolean, desc: 'Export the results as a JSON file'
+    def range(*args)
+      abort(Status.specify_range) if args.empty? || args.length != 2
+      begin
+        day1 = DateTime.strptime(args[0], '%Y-%m-%d')
+        day2 = DateTime.strptime(args[1], '%Y-%m-%d')
+      rescue ArgumentError
+        abort(Status.specify_range)
+      end
+      toki, entries = init(options)
+      range_data = toki.get_range(day1, day2, entries, options)
+      clear
+      view_range_table(args[0], args[1], range_data)
+      export(:json, range_data, "toki-range-#{args[0]}_#{args[1]}") if options[:json]
+    end
+
+
+
+
     private
 
+    def export(type, data, filename)
+      case type
+      when :json
+        name = Dir.home + "/temp/toki/#{filename}.json"
+        File.write(name, data.to_h.to_json)
+        puts "File converted and exported to #{name}\n\n"
+      end
+    end
+
+    def view_range_table(start, to, range_data)
+      puts TokiCLI::View.new.range_table(start, to, range_data)
+      puts "\n"
+    end
+
+    def view_day_table(date, day_data)
+      puts TokiCLI::View.new.day_table(date, day_data)
+      puts "\n"
+    end
+
+    def view_app_table(asked, app_data)
+      puts TokiCLI::View.new.app_table(asked, app_data)
+      puts "\n"
+    end
+
+    def view_hits_table(hits)
+      puts TokiCLI::View.new.hits_table(hits.reverse)
+      puts "\n"
+    end
+
+    def init(options)
+      toki = create_toki(options)
+      return toki, toki.get_content(options)
+    end
+
     def create_toki(options)
       if options[:adn]
         total_adn
@@ -77,9 +153,7 @@ module TokiCLI
         puts Status.error(e)
         exit
       end
-      clear
-      puts TokiCLI::View.new.total_table(apps)
-      puts "\n"
+      apps
     end
 
     def init_toki_db

data/lib/TokiCLI/module.rb

@@ -1,76 +1,90 @@
 # encoding: utf-8
 module TokiCLI
   class Toki
+
     def initialize(token, channel_id)
       @token = token
       @channel_id = channel_id
     end
+
     def get_content(options)
       synced = []
       if options[:adn]
-        messages = get_adn_data
-        messages.reverse.each do |obj|
+        get_adn_data.reverse.each do |obj|
           synced << make_obj_from_adn(obj)
         end
       else
-        content = get_db_data
-        content.each do |obj|
+        get_db_data.each do |obj|
           synced << make_obj_from_db(obj)
         end
       end
       synced
     end
+
     def get_app(app, synced)
       name_regex = /#{app.downcase}/
       app_data = {}
       totals = {}
       synced.each do |obj|
         next unless obj.app[:name].downcase =~ name_regex
-        unless totals[:app].nil?
-          totals[:app] = totals[:app] + obj.app[:total]
-        else
+        if totals[:app].nil?
           totals[:app] = obj.app[:total]
+        else
+          totals[:app] = totals[:app] + obj.app[:total]
         end
-        human = epoch_to_human(obj.app[:total])
         app_data[obj.msg[:id]] = {
           from: Time.at(obj.app[:active_from]).strftime("%Y/%m/%d %Hh:%Mm:%Ss"),
           to: Time.at(obj.app[:active_to]).strftime("%Y/%m/%d %Hh:%Mm:%Ss"),
-          duration: "#{human[:hours]}h #{human[:minutes]}m #{human[:seconds]}s",
+          duration: humanized_date(obj.app[:total]),
           name: obj.app[:name],
           raw_from: obj.app[:active_from]
         }
       end
-      human = epoch_to_human(totals[:app])
-      app_data['total'] = "#{human[:hours]}h #{human[:minutes]}m #{human[:seconds]}s"
+      app_data['total'] = humanized_date(totals[:app])
       app_data
     end
+
     def all_data(synced)
-      totals = get_totals(synced)
+      sorted = get_sorted_totals(synced)
       bundles = {}
-      sorted = sort_totals(totals)
-      sorted.each do |name, total|
-        human = epoch_to_human(total)
-        if human[:hours] < 1
-          bundles[name] = "#{human[:minutes]}m #{human[:seconds]}s"
-        else
-          bundles[name] = "#{human[:hours]}h #{human[:minutes]}m #{human[:seconds]}s"
-        end
-      end
+      sorted.each {|name, total| bundles[name] = humanized_date(total)}
       bundles
     end
+
     def top(synced, number = 5)
       number = -number
-      totals = get_totals(synced)
-      sorted = sort_totals(totals)
+      sorted = get_sorted_totals(synced)
       humanized = []
-      sorted.each do |n,t|
-        humanized << [n, humanized_date(t)]
-      end
+      sorted.each {|n,t| humanized << [n, humanized_date(t)]}
       humanized[number..-1]
     end
 
+    def get_day(date, entries, options)
+      min_epoch = date.to_time.to_i
+      max_epoch = date.next_day.to_time.to_i
+      get_between(min_epoch, max_epoch, entries)
+    end
+
+    def get_range(day1, day2, entries, options)
+      min_epoch = day1.to_time.to_i
+      max_epoch = day2.next_day.to_time.to_i # between start of 1 and end of 2
+      get_between(min_epoch, max_epoch, entries)
+    end
+
     private
 
+    def get_between(epoch1, epoch2, entries)
+      range = entries.select {|obj| obj.app[:active_from] > epoch1 && obj.app[:active_from] < epoch2}
+      day_totals = sort_totals get_totals(range)
+      humanized = []
+      day_totals.each {|n,t| humanized << [n, humanized_date(t)]}
+      humanized
+    end
+
+    def get_sorted_totals(synced)
+      sort_totals(get_totals(synced))
+    end
+
     def humanized_date(epoch)
       human = epoch_to_human(epoch)
       "#{human[:hours]}h #{human[:minutes]}m #{human[:seconds]}s"

data/lib/TokiCLI/status.rb

@@ -25,6 +25,12 @@ module TokiCLI
     def self.specify_name
       "\nPlease specify the name of the app (or part of it).\n\n"
     end
+    def self.specify_day
+      "\nPlease specify the date with this format: 2014-04-19\n\n"
+    end
+    def self.specify_range
+      "\nPlease specify the range with this format: 2014-04-17 2014-04-19\n\n"
+    end
     def self.run_auth
       "\nPlease run `toki auth` first.\n\n"
     end

data/lib/TokiCLI/version.rb

@@ -1,3 +1,3 @@
 module TokiCLI
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/TokiCLI/view.rb

@@ -4,18 +4,27 @@ module TokiCLI
     def total_table(list)
       table = init_table
       table.title = "Your apps monitored by Toki"
-      list.each do |k,v|
-        table << ["#{k}", "#{v}"]
-      end
-      table
+      table_2(list, table)
+    end
+    def day_table(day, list)
+      table = init_table
+      table.title = "Your apps monitored by Toki on #{day}"
+      table_2(list, table)
+    end
+    def range_table(day1, day2, list)
+      table = init_table
+      table.title = "Your apps monitored by Toki between #{day1} and #{day2}"
+      table_2(list, table)
+    end
+    def hours_table(hour1, hour2, list)
+      table = init_table
+      table.title = "Your apps monitored by Toki between #{hour1} and #{hour2}"
+      table_2(list, table)
     end
     def hits_table(list)
       table = init_table
       table.title = "Your top apps monitored by Toki"
-      list.each.with_index(1) do |obj,index|
-        table << ["#{index}", "#{obj[0]}", "#{obj[1]}"]
-      end
-      table
+      table2_index(list, table)
     end
     def app_table(asked, app_data)
       table = init_table
@@ -45,5 +54,17 @@ module TokiCLI
         t.style = { :width => 75 }
       end
     end
+    def table_2(list, table)
+      list.each do |k,v|
+        table << ["#{k}", "#{v}"]
+      end
+      table
+    end
+    def table2_index(list, table)
+      list.each.with_index(1) do |obj,index|
+        table << ["#{index}", "#{obj[0]}", "#{obj[1]}"]
+      end
+      table
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: TokiCLI
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eric Dejonckheere
@@ -95,7 +95,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: 'Toki.app command-line client: read your Toki data from the local database
-  or from the App.net backup channel, delete data from both...'
+  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.'
 email:
 - eric@aya.io
 executables: