task_report 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83f485efcd3d9a42cb28df8584a6b8395281b57a
+  data.tar.gz: dccb48b7fb94e18d523b0ac5e9b121790a529fa3
+SHA512:
+  metadata.gz: 3ce79635dda36eea5e05d39c2f2ad3b806a7eb037662532a92bb87259e63aeb5b334487b33d5997764f0066c27395478a22746b6b8a38d05b5895106354a1dd2
+  data.tar.gz: 3420cda1a200e996badde56d0514876b784608be9882eb9ceab08c14126cbfa8319e5143d52884b4a9f0426e083868cff689a2c68b01fd7a68db170d1239084c

data/.gitignore

@@ -0,0 +1 @@
+.byebug_history

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mat Pataki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+This repo is currently under construction. Don't use it while this message is here.
+
+## Description
+
+This tool enables you to track where your time goes via a private [gist](https://gist.github.com). The data itself is stored in a gist as json, and a formatted summary can be generated and shared (TODO, right now there's only a stdout summary). This means that task tracking is not tied to any specific machine, but rather a github account.
+
+## Installation
+
+- [Make a github / gist account.](https://github.com/join?return_to=https%3A%2F%2Fgist.github.com%2F%3Fsignup%3Dtrue&source=header-gist)
+- [Generate a Personal Access Token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) that has read / write access to your gists.
+- From a shell:
+```shell
+gem install task_report
+```
+
+- Add your *github user name* and *personal access token* a YAML config file located at `~/.task_report_config`.
+
+Example configuration:
+```
+user: you_github_username
+personal_access_token: 12345678abcdefghi9101112131415jklmnop
+```
+
+## Usage
+
+```
+Use `task` as follows:
+
+  `task start TASK-DESCRIPTION`
+    - finds or creates a new gist for today
+    - adds a new item with the provided TASK-DESCRIPTION
+
+  `task stop`
+    - stops time tracking the current task, if it exists
+
+  `task continue [TASK-ID, TASK-DESCRIPTION]`
+    - continues tracking the provided task, or latest task if none if provided
+
+  `task current`
+    - lists the currently ongoing task
+
+  `task list`
+    - Lists all of today's tasks
+
+  `task summary`
+    - prints a task summary to the command line
+
+  `task delete {TASK-ID, TASK-DESCRIPTION, today, gist}`
+    - deletes the provided task if it exists
+    - if 'today' is passed, then all tasks in today's report will be deleted
+    - if 'gist' is passed, then the whole report gist for today will be deleted
+
+  `task help`
+    - shows this message
+```
+
+## System Requirements
+
+- ruby >= 2.3.0
+
+## TODO:
+
+- [x] `continue`
+- [ ] `info`
+- [x] `delete`
+- [ ] confirmation messages for `delete`
+- [x] `list`
+- [x] `current`
+- [x] basic `summary`
+- [x] add configuration file support
+- [ ] gist `summary`
+- [ ] setup install
+- [ ] add jira support?
+  - at the very least, a ticket field
+- [ ] allow `summary` to take a gist id, so you can retroactively generate summaries
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/task

@@ -0,0 +1,58 @@
+#! /usr/bin/env ruby
+
+require 'task_report'
+
+def show_usage_message(exit_status = 0)
+  puts \
+"Use `task` as follows:
+
+  `task start TASK-DESCRIPTION`
+    - finds or creates a new gist for today
+    - adds a new item with the provided TASK-DESCRIPTION
+
+  `task stop`
+    - stops time tracking the current task, if it exists
+
+  `task continue [TASK-ID, TASK-DESCRIPTION]`
+    - continues tracking the provided task, or latest task if none if provided
+
+  `task current`
+    - lists the currently ongoing task
+
+  `task list`
+    - Lists all of today's tasks
+
+  `task summary`
+    - prints a task summary to the command line
+
+  `task delete {TASK-ID, TASK-DESCRIPTION, today, gist}`
+    - deletes the provided task if it exists
+    - if 'today' is passed, then all tasks in today's report will be deleted
+    - if 'gist' is passed, then the whole report gist for today will be deleted
+
+  `task help`
+    - shows this message"
+
+  exit exit_status
+end
+
+TaskReport.read_config
+
+case ARGV[0]
+when 'list'
+  TaskReport.list
+when 'start'
+  TaskReport.start(ARGV[1])
+when 'stop'
+  TaskReport.stop
+when 'continue'
+  TaskReport.continue(ARGV[1])
+when 'delete'
+  TaskReport.delete(ARGV[1])
+when 'current'
+  TaskReport.current
+when 'summary'
+  TaskReport.summary
+else
+  show_usage_message
+end

data/lib/task_report/duration.rb

@@ -0,0 +1,17 @@
+module TaskReport
+  class Duration
+    attr_accessor :seconds
+
+    def initialize(seconds)
+      @seconds = seconds.floor
+    end
+
+    def to_s
+      min, sec = @seconds.divmod(60)
+      min %= 60
+      hour, _ = @seconds.divmod(3600)
+
+      "#{hour} hours, #{min} minutes, #{sec} seconds"
+    end
+  end
+end

data/lib/task_report/gist.rb

@@ -0,0 +1,81 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module TaskReport
+  module Gist
+    class << self
+      def find_gist_from_today_by_description(description)
+        Gist.get_recent_gists_for_user.find do |gist|
+          gist['description'] == description
+        end
+      end
+
+      def get_recent_gists_for_user
+        now = Time.now
+
+        # kind of like Time.now.midnight in UTC
+        time_string = Time.new(now.year, now.month, now.day).getgm.strftime('%Y-%m-%dT%H:%M:%SZ')
+
+        params = {
+          access_token: User.api_token,
+          since: time_string
+        }
+
+        uri = URI "https://api.github.com/users/#{User.name}/gists"
+        uri.query = URI.encode_www_form params
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        request = Net::HTTP::Get.new(uri.request_uri)
+        response = http.request(request)
+        JSON.parse(response.body)
+      end
+
+      def create(params)
+        uri = URI "https://api.github.com/gists"
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        request = Net::HTTP::Post.new(uri.request_uri)
+        request['Accept'] = 'application/json'
+        request['Content-Type'] = 'application/json'
+        request['Authorization'] = "token #{User.api_token}"
+        request.body = JSON.dump(params)
+        response = http.request(request)
+        JSON.parse(response.body)
+      end
+
+      def edit(gist_id, params)
+        uri = URI "https://api.github.com/gists/#{gist_id}"
+        request = Net::HTTP::Patch.new(uri.request_uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        request['Accept'] = 'application/json'
+        request['Content-Type'] = 'application/json'
+        request['Authorization'] = "token #{User.api_token}"
+        request.body = JSON.dump(params)
+        response = http.request(request)
+        JSON.parse(response.body)
+      end
+
+      def delete(gist_id)
+        uri = URI "https://api.github.com/gists/#{gist_id}"
+        request = Net::HTTP::Delete.new(uri.request_uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        request['Authorization'] = "token #{User.api_token}"
+        http.request(request)
+      end
+
+      def file_content(raw_url)
+        uri = URI raw_url
+        request = Net::HTTP::Get.new(uri.request_uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        request['Accept'] = 'application/json'
+        request['Authorization'] = "token #{User.api_token}"
+        response = http.request(request)
+        JSON.parse(response.body)
+      end
+    end
+  end
+end

data/lib/task_report/report.rb

@@ -0,0 +1,202 @@
+module TaskReport
+  class Report
+    TaskAlreadyTracked = Class.new StandardError
+    TaskAlreadyOngoing = Class.new StandardError
+    TaskDNE = Class.new StandardError
+    MultipleOngoingTasks = Class.new StandardError
+
+    attr_reader :gist_id
+
+    class << self
+      def gist_description
+        "#{User.name}_report_#{Time.now.strftime('%Y-%m-%d')}"
+      end
+
+      def json_file_name
+        "#{gist_description}.json"
+      end
+
+      def create(new_task_description:)
+        Report.new(
+          description: gist_description,
+          json_file_name: json_file_name
+        )
+      end
+
+      def create_from_gist(gist)
+        raw_url = gist['files'][json_file_name]['raw_url']
+
+        Report.new(
+          description: gist_description,
+          json_file_name: json_file_name,
+          gist_id: gist['id'],
+          existing_json_content: Gist.file_content(raw_url)
+        )
+      end
+    end
+
+    def start_task(new_task_description)
+      if @tasks.any? { |t| t.description == new_task_description }
+        raise TaskAlreadyTracked
+      end
+
+      task = Task.new(description: new_task_description)
+      puts "Starting #{task.to_s}."
+      @tasks << task
+    end
+
+    def stop_all_tasks
+      @tasks.each(&:stop)
+    end
+
+    def continue(task_id)
+      ensure_no_tasks_ongoing!
+
+      task =
+        if task_id.nil?
+          find_last_task_to_be_worked_on
+        else
+          find_task_by_id(task_id) || find_task_by_description(task_id)
+        end
+
+      task.continue
+    end
+
+    def delete(task_id)
+      task = find_task_by_id(task_id) || find_task_by_description(task_id)
+      raise TaskDNE if task.nil?
+
+      puts "Deleting #{task.to_s}."
+      @tasks.delete_if { |t| t.id == task.id }
+    end
+
+    def delete_all
+      puts "Deleting all tasks for today."
+      @tasks = []
+    end
+
+    def print_tasks
+      if @tasks.empty?
+        puts 'There are no tasks reported for today.'
+        return
+      end
+
+      puts "Tasks:"
+
+      @tasks.each do |task|
+        puts "- #{task.to_s}"
+      end
+    end
+
+    def print_current_task
+      ensure_only_one_ongoing_task!
+
+      task = @tasks.find(&:ongoing?)
+
+      if task.nil?
+        puts "There is no task ongoing."
+      else
+        puts "Curent task: #{task.to_s}"
+      end
+    end
+
+    def print_summary
+      if @tasks.empty?
+        puts 'There are no tasks reported for today.'
+        return
+      end
+
+      puts "#{User.name} Task Report #{@date.strftime('%Y-%m-%d')}"
+
+      @tasks.each do |task|
+        puts "'#{task.description}'"
+        puts "  - #{task.duration.to_s}"
+      end
+    end
+
+    def save_to_gist!
+      if @gist_id
+        edit_existing_gist!
+      else
+        save_new_gist!
+      end
+    end
+
+    private
+      def initialize(description:, json_file_name:, gist_id: nil, existing_json_content: {})
+        @description = description
+        @json_file_name = json_file_name
+        @gist_id = gist_id
+
+        @date = Time.parse(
+          existing_json_content.fetch('date', Time.now.strftime('%Y-%m-%d %z'))
+        )
+
+        @tasks =
+          existing_json_content.fetch('tasks', []).map do |hash|
+            Task.from_existing_tasks(hash)
+          end
+      end
+
+      def to_h
+        {
+          date: @date.strftime('%Y-%m-%d %z'),
+          tasks: @tasks.map(&:to_h)
+        }
+      end
+
+      def task_json
+        JSON.pretty_generate(to_h)
+      end
+
+      def save_new_gist!
+        puts "Starting a new report gist for the day."
+
+        Gist.create(
+          public: false,
+          description: @description,
+          files: {
+            @json_file_name => {
+              content: task_json
+            }
+          }
+        )
+      end
+
+      def edit_existing_gist!
+        puts "Saving to today's report gist."
+
+        Gist.edit(@gist_id,
+          description: @description, # do we actually need this? Seems odd...
+          files: {
+            @json_file_name => {
+              content: task_json
+            }
+          }
+        )
+      end
+
+      def find_task_by_id(task_id)
+        @tasks.find { |t| t.id == task_id }
+      end
+
+      def find_task_by_description(task_description)
+        @tasks.find { |t| t.description == task_description }
+      end
+
+      def find_last_task_to_be_worked_on
+        @tasks.inject(@tasks.first) do |result, task|
+          task.last_start_time > result.last_start_time ? task : result
+        end
+      end
+
+      def ensure_no_tasks_ongoing!
+        ongoing_task = @tasks.find(&:ongoing?)
+        raise TaskAlreadyOngoing, ongoing_task if ongoing_task
+      end
+
+      def ensure_only_one_ongoing_task!
+        raise MultipleOngoingTasks if @tasks.count(&:ongoing?) > 1
+      end
+  end
+end

data/lib/task_report/task.rb

@@ -0,0 +1,72 @@
+require 'time' # Time.parse)
+require 'securerandom'
+
+module TaskReport
+  class Task
+    TaskOngoing = Class.new StandardError
+
+    attr_reader :id, :description
+
+    def self.from_existing_tasks(hash)
+      time =
+        hash['time'].map do |t|
+          {
+            start: Time.parse(t['start']),
+            end: t['end'].nil? ? nil : Time.parse(t['end'])
+          }
+        end
+
+      self.new(
+        id: hash['id'],
+        description: hash['description'],
+        time: time
+      )
+    end
+
+    def initialize(description:, time: nil, id: nil)
+      @description = description
+      @time = time || [{ start: Time.now, end: nil }]
+      @id = id || SecureRandom.hex(4)
+    end
+
+    def to_h
+      {
+        id: @id,
+        description: @description,
+        time: @time
+      }
+    end
+
+    def to_s
+      "Task #{@id}, '#{@description}'"
+    end
+
+    def duration
+      Duration.new(
+        @time.inject(0) do |sum, time|
+          sum + ( (time[:end] || Time.now) - time[:start] )
+        end
+      )
+    end
+
+    def stop
+      return unless @time.last[:end].nil?
+      puts "Stopping #{self.to_s}"
+      @time.last[:end] = Time.now
+    end
+
+    def continue
+      raise TaskOngoing if @time.last[:end].nil?
+      puts "Continueing #{self.to_s}"
+      @time << { start: Time.now, end: nil }
+    end
+
+    def last_start_time
+      @time.last[:start]
+    end
+
+    def ongoing?
+      @time.last[:end].nil?
+    end
+  end
+end

data/lib/task_report/user.rb

@@ -0,0 +1,7 @@
+module TaskReport
+  module User
+    class << self
+      attr_accessor :name, :api_token
+    end
+  end
+end

data/lib/task_report.rb

@@ -0,0 +1,126 @@
+require 'yaml'
+require 'task_report/user'
+require 'task_report/gist'
+require 'task_report/task'
+require 'task_report/report'
+require 'task_report/duration'
+
+module TaskReport
+  class << self
+    def read_config
+      config_path = File.expand_path('~/.task_report_config')
+      config = YAML.load(File.read(config_path))
+      TaskReport::User.name = config.fetch('user')
+      TaskReport::User.api_token = config.fetch('personal_access_token')
+    rescue Errno::ENOENT
+      puts 'Config file not found. It should be located at ~/.task_report_config.'
+      puts 'See https://github.com/mpataki/task_report for help.'
+      puts 'Exiting'
+      exit 1
+    rescue Psych::SyntaxError
+      puts 'The config file must be valid yaml syntax.'
+      puts 'Exiting'
+      exit 1
+    rescue KeyError
+      puts 'Config key not found.'
+      puts 'Required configuration keys are `user` and `personal_access_token`'
+      puts 'See an example at https://github.com/mpataki/task_report'
+      puts 'Exiting'
+      exit 1
+    end
+
+    def start(new_task_description)
+      @report ||=
+        if report_gist.nil?
+          Report.create(new_task_description: new_task_description)
+        else
+          Report.create_from_gist(report_gist).tap(&:stop_all_tasks)
+        end
+
+      @report.start_task(new_task_description)
+      @report.save_to_gist!
+    rescue Report::TaskAlreadyTracked
+      puts "Task '#{new_task_description}' is already being tracked. Continuing the task."
+      continue(new_task_description)
+    end
+
+    def stop
+      return if no_gist?
+
+      @report ||= Report.create_from_gist(report_gist)
+      @report.stop_all_tasks
+      @report.save_to_gist!
+      puts "All tasks stopped"
+    end
+
+    def continue(task_id)
+      return if no_gist?
+
+      @report ||= Report.create_from_gist(report_gist)
+      @report.continue(task_id)
+      @report.save_to_gist!
+    rescue Report::TaskAlreadyOngoing, Task::TaskOngoing => e
+      puts "Task already underway - #{e.message}"
+    end
+
+    def list
+      return if no_gist?
+      (@report || Report.create_from_gist(report_gist)).print_tasks
+    end
+
+    def delete(identifier)
+      return if no_gist?
+
+      @report ||= Report.create_from_gist(report_gist)
+
+      case identifier
+      when 'today'
+        @report.delete_all
+      when 'gist'
+        puts "Deleting today's report gist"
+        Gist.delete(@report.gist_id)
+        return
+      else
+        @report.delete(identifier)
+      end
+
+      @report.save_to_gist!
+    rescue Report::TaskDNE
+      puts "Task '#{identifier}' does not exist - nothing to do."
+    end
+
+    def current
+      return if no_gist?
+
+      @report ||= Report.create_from_gist(report_gist)
+      @report.print_current_task
+    rescue Report::MultipleOngoingTasks
+      puts 'Something went wrong. There are multiple ongoing tasks.'
+    end
+
+    def summary
+      return if no_gist?
+
+      @report ||= Report.create_from_gist(report_gist)
+      @report.print_summary
+    end
+
+    private
+      def report_gist
+        @report_gist ||=
+          Gist.find_gist_from_today_by_description(
+            Report.gist_description
+          )
+      end
+
+      def no_gist?
+        if report_gist.nil?
+          puts 'No report exists for today - nothing to do.'
+          puts 'See `task help` for usage info.'
+          return true
+        end
+
+        false
+      end
+  end
+end

data/task_report.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'task_report'
+  spec.version       = File.read('VERSION')
+  spec.authors       = ['Mat Pataki']
+  spec.email         = ['matpataki@gmail.com']
+
+  spec.summary       = 'Task tracker'
+  spec.homepage      = 'https://github.com/mpataki/task_report'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['task']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: task_report
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mat Pataki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- matpataki@gmail.com
+executables:
+- task
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- bin/task
+- lib/task_report.rb
+- lib/task_report/duration.rb
+- lib/task_report/gist.rb
+- lib/task_report/report.rb
+- lib/task_report/task.rb
+- lib/task_report/user.rb
+- task_report.gemspec
+homepage: https://github.com/mpataki/task_report
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Task tracker
+test_files: []