gpuzzletime 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3f853932bdf602db7566b6e122e7b130f09b55f8520da2922c178a621bad930
+  data.tar.gz: 2be9f507dc5f3501a3f204505a255c86f2db62e7262f9339a0ba90ca457f191c
+SHA512:
+  metadata.gz: a2ba71e0e22135f99f34e38ed95cf37342d20f79f92f8f78b19a53ca5a8df0469c07562a4a508fc006797899e5a99284f4a65398b6c1f5b93ab359532460ab9b
+  data.tar.gz: 55b6f2fa52083b8708d59cc5c9bb2b430945151ff013fad5b0993f8eae495da12782082ce6d8d15d3e8d82bce4296e418c225fc9906d8f7c50c87406b621ad0f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+gpuzzletime

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.4.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gpuzzletime.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-2018 Matthias Viehweger
+
+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,73 @@
+# gPuzzleTime
+
+small tooling to transfer timelog-entries from gtimelog's timelog.txt to the PuzzleTime TimeTracking Website.
+
+## Approach
+
+- [x] read timelog.txt
+  - [x] from known location
+  - [ ] later: configure location?
+  - [ ] later: auto-detect location?
+- [x] parse out last day
+  - [x] especially start/end-times for each entry
+  - [x] date - ticket - description
+  - [x] later: parse out specific day
+- [x] open N browser instances with the time entry data
+  - [x] without selected account
+- [x] infer time-account from ticket-format
+  - [x] support user-supplied ticket-parsers
+  - [x] get ticket-parser from tags
+- [ ] merge equal adjacent entries into one
+- [ ] complete login/entry automation
+  - [ ] login
+  - [ ] store cookie
+  - [ ] make entries
+  - [ ] open day in browser for review
+- [ ] avoid duplicate entries
+  - [ ] start/end time as indicator?
+- [ ] offer rounding times to the next 5, 10 or 15 minutes
+- [ ] allow to add entries from the command-line
+
+
+## Installation
+
+Install it with:
+
+    $ gem install gpuzzletime
+
+## Usage
+
+    $ gpuzzletime ACTION DATE
+
+### Actions
+
+Currently supported actions are
+
+- show
+- upload
+
+### Date-Identifier
+
+To handle a specific date, the format YYYY-MM-DD is expected, e.g. 2017-12-25. Please note that you should not work on that day, unless you bring presents.
+
+For reusability in a shell-history the following keywords are supported:
+
+- today
+- yesterday
+
+If nothing is specified, the action is applied to all entries.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec gpuzzletime` to use the gem in this directory, ignoring other installed copies of this gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kronn/gpuzzletime.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gpuzzletime"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gpuzzletime

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/gpuzzletime'
+
+Gpuzzletime::App.new(ARGV).run

data/gpuzzletime.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gpuzzletime/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gpuzzletime"
+  spec.version       = Gpuzzletime::VERSION
+  spec.authors       = ["Matthias Viehweger"]
+  spec.email         = ["kronn@kronn.de"]
+
+  spec.summary       = %q{Move time-entries from gTimelog to PuzzleTime}
+  # spec.description   = %q{}
+  spec.homepage      = "https://github.com/kronn/gpuzzletime"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.50"
+end

data/lib/gpuzzletime/app.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'erb'
+require 'pathname'
+
+# Wrapper for everything
+module Gpuzzletime
+  class App
+    def initialize(args)
+      @base_url = 'https://time.puzzle.ch'
+
+      @command = (args[0] || :show).to_sym
+
+      case @command
+      when :show, :upload
+        @date = named_dates(args[1]) || :all
+      when :edit
+        @file = args[1]
+      else
+        raise ArgumentError, "Unsupported Command #{@command}"
+      end
+    end
+
+    def run
+      launch_editor if @command == :edit
+
+      @entries = {}
+
+      parse(read).each do |date, entries|
+        # this is mixing preparation, assembly and output, but gets the job done
+        next unless date                           # guard against the machine
+        next unless @date == :all || @date == date # limit to one day if passed
+        @entries[date] = []
+
+        start = nil             # at the start of the day, we have no previous end
+
+        entries.each do |entry|
+          finish = entry[:time] # we use that twice
+          hidden = entry[:description].match(/\*\*$/) # hide lunch and breaks
+
+          if start && !hidden
+            case @command # assemble data according to command
+            when :show
+              @entries[date] << [
+                start, '-', finish,
+                [
+                  entry[:ticket],
+                  entry[:description],
+                  entry[:tags],
+                  infer_account(entry),
+                ].compact.join(' ∴ '),
+              ].compact.join(' ')
+            when :upload
+              @entries[date] << [start, entry]
+            end
+          end
+
+          start = finish # store previous ending for nice display of next entry
+        end
+      end
+
+      case @command
+      when :show
+        @entries.each do |date, entries|
+          puts date, '----------'
+          entries.each do |entry|
+            puts entry
+          end
+          puts nil
+        end
+      when :upload
+        @entries.each do |date, entries|
+          puts "Uploading #{date}"
+          entries.each do |start, entry|
+            open_browser(start, entry)
+          end
+        end
+      end
+    end
+
+    private
+
+    def open_browser(start, entry)
+      url = "#{@base_url}/ordertimes/new?#{url_options(start, entry)}"
+      system "gnome-open '#{url}' > /dev/null 2> /dev/null"
+    end
+
+    def launch_editor
+      editor = `which $EDITOR`.chomp
+
+      file = @file.nil? ? timelog_txt : parser_file(@file)
+
+      exec "#{editor} #{file}"
+    end
+
+    def url_options(start, entry)
+      {
+        work_date:                    entry[:date],
+        'ordertime[ticket]':          entry[:ticket],
+        'ordertime[description]':     entry[:description],
+        'ordertime[from_start_time]': start,
+        'ordertime[to_end_time]':     entry[:time],
+        'ordertime[account_id]':      infer_account(entry),
+      }
+        .map { |key, value| [key, ERB::Util.url_encode(value)].join('=') }
+        .join('&')
+    end
+
+    def named_dates(date)
+      case date
+      when 'yesterday' then Date.today.prev_day.to_s
+      when 'today'     then Date.today.to_s
+      else                  date
+      end
+    end
+
+    def timelog_txt
+      Pathname.new('~/.local/share/gtimelog/timelog.txt').expand_path
+    end
+
+    def read
+      timelog_txt.read
+    end
+
+    def parse(data)
+      data.split("\n")
+        .map { |line| tokenize(line) }
+        .group_by { |match| match && match[:date] }
+        .to_a
+    end
+
+    def tokenize(line)
+      re_date = /(?<date>\d{4}-\d{2}-\d{2})/
+      re_time = /(?<time>\d{2}:\d{2})/
+      re_tick = /(?:(?<ticket>.*?): )/
+      re_desc = /(?<description>.*?)/
+      re_tags = /(?: -- (?<tags>.*)?)/
+
+      regexp = /^#{re_date} #{re_time}: #{re_tick}?#{re_desc}#{re_tags}?$/
+      line.match(regexp)
+    end
+
+    def parser_file(parser_name)
+      Pathname.new("~/.config/gpuzzletime/parsers/#{parser_name}") # security-hole, prevent relative paths!
+              .expand_path
+    end
+
+    def infer_account(entry)
+      return unless entry[:tags]
+
+      tags = entry[:tags].split
+      parser_name = tags.shift
+
+      parser = parser_file(parser_name)
+
+      return unless parser.exist?
+
+      `#{parser} "#{entry[:ticket]}" "#{entry[:description]}" #{tags}`.chomp # maybe only execute if parser is in correct dir?
+    end
+  end
+end

data/lib/gpuzzletime/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Version
+module Gpuzzletime
+  VERSION = '0.1.0'
+end

data/lib/gpuzzletime.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+# Autoloading and such
+module Gpuzzletime
+  autoload :App, 'gpuzzletime/app'
+  autoload :VERSION, 'gpuzzletime/version'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: gpuzzletime
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthias Viehweger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+description: 
+email:
+- kronn@kronn.de
+executables:
+- gpuzzletime
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gpuzzletime
+- gpuzzletime.gemspec
+- lib/gpuzzletime.rb
+- lib/gpuzzletime/app.rb
+- lib/gpuzzletime/version.rb
+homepage: https://github.com/kronn/gpuzzletime
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Move time-entries from gTimelog to PuzzleTime
+test_files: []