aapis / evertils Goto Github PK

A lot of the functionality is implemented in helpers right now, should be changed so we're directly updating Evertils::Common::Entity model objects instead. Most classes do not follow single responsibility principle. Classes to refactor/remove:

• Helper::Xml
• Helper::ApiEnmlHandler
• Controller::Log
• Helper::EvernoteENML

Currently it's Granify, i.e.

# now
module Granify
  class Utils
    @cache = Hash.new
    # ...

# desired
module Evertils
  class Utils
    @cache = Hash.new
    # ...

Controller (and other files) may require modification as well.

notebook: Standup
title: Standup For [%MONTH_NAME% %DAY% - %DOW_NAME%]
action: duplicate_previous
tags:
    - day-%DOY%
    - month-%MONTH%
    - week-%WEEK%
content: THIS IS A TITLE

OR

notebook: Standup
title: Standup For [%MONTH_NAME% %DAY% - %DOW_NAME%]
action: duplicate_previous
tags:
    - day-%DOY%
    - month-%MONTH%
    - week-%WEEK%
content: 
    - 
        label: Daily
        path: '%EVERTILS_CONF_TYPE_PATH%/daily.yml'

Noticed this while implementing evertils as a cron task, it failed while trying to load template daily.enml (expected Daily.enml). Thought this already handled the downcasing? Investigate.

Would work like logt/log message but update a specified note instead.

2 notes can have the same title in EN so we might as well remove this functionality.

Should be able to create a gist to share data from your logs. Could be expanded to other controllers as well.

It will always be an estimate unless you are very diligent about logging, but the app should attempt to calculate how much time was spent on a task. Perhaps a new command log-stats, or a modification of log-group.

Maybe this is a new controller (query SOMETHING for ex)? Allow you to say "get all rows that match this query term on THIS DAY or THIS WEEK or in THIS MONTH".

Belongs in this repo.

VC removes a lot of cruft in the initialization routines this script can benefit from as well.

* 01:22 - 2223 - working on the callback
* 02:22 - 2223 - finished callback

Then..

$ evertils log at 02:11 'callback now receives args from caller'

Result

* 01:22 - 2223 - working on the callback
* 02:11 - 2223 - callback now receives args from caller
* 02:22 - 2223 - finished callback

Key feature is that the new row is auto sorted into the existing log items.

Even though they execute sequentially there is not enough time to create a new note and then query for it's existence via the API. I suspect a simple sleep of 10ms will resolve this.

New command to parse the EN/rolling logs and get all messages for the requested job number.

Could also sort (non-destructively) and give you all the jobs you worked on grouped together (and sorted by time).

1. Add flag --cron
2. Output should be stripped.
3. May require updating notifaction too?

Should be focused on generating notes from YML definition files going forward.

Should tell you what it is doing, i.e.

$ creating FOLDER
$ creating FILE
$ creating FILE
...

Since the notifaction API changed there is a required argument now and it's not populated in most instances.

Since evertils-common 0.3.2, notes are created in the default notebook.

Not the first time I've noticed this, but if you try to log something before going into the daily note and manually hitting "*-tab" under the Triage title, it errors out claiming the following.

✖ undefined method `before' for nil:NilClass
/Users/prieber/.rvm/gems/ruby-2.4.0/gems/nokogiri-1.8.1/lib/nokogiri/xml/node_set.rb:55:in `before'
/Users/prieber/.rvm/gems/ruby-2.4.0/gems/evertils-0.3.21/lib/evertils/controllers/log.rb:39:in `modify'
/Users/prieber/.rvm/gems/ruby-2.4.0/gems/evertils-0.3.21/lib/evertils/controllers/log.rb:21:in `message'
/Users/prieber/.rvm/gems/ruby-2.4.0/gems/evertils-0.3.21/lib/evertils/controller.rb:40:in `exec'
/Users/prieber/.rvm/gems/ruby-2.4.0/gems/evertils-0.3.21/lib/evertils/router.rb:41:in `route'
/Users/prieber/.rvm/gems/ruby-2.4.0/gems/evertils-0.3.21/bin/evertils:15:in `<top (required)>'
/Users/prieber/.rvm/gems/ruby-2.4.0/bin/evertils:23:in `load'
/Users/prieber/.rvm/gems/ruby-2.4.0/bin/evertils:23:in `<main>'
/Users/prieber/.rvm/gems/ruby-2.4.0/bin/ruby_executable_hooks:15:in `eval'
/Users/prieber/.rvm/gems/ruby-2.4.0/bin/ruby_executable_hooks:15:in `<main>'

May have something to do with how the "first" section is determined in log.rb#L39.

After X chars, repeat the templated sections of the line (time + job number) and move the remaining characters to a second line. This way you could write whole paragraphs and they won't look weird in evernote (word wrapping really breaks the layout on small monitors).

This should be configurable in the future messages.yml file.

Weekly and monthly notes are supposed to get tagged with week-X or month-X to help with searching and statistics, but for some reason they are no longer being tagged during the generation process.

New configuration file (and directory) to customize template content. This will live outside the repo in $HOME/.evertils/ and be user customizable. Evertils should create the config file with a default section (EOD - End of Day) if it does not exist on when run, but should fall back on built-in templates if no custom templates are defined. If a custom template does not exist, stop program execution and alert the user.

a) Custom sections:

# ~/.evertils/config.yml
sections:
    EOD:
        - Item one
        - Item two
    JIRA links:
        - link one
        - link two

b) Custom templates:

# ~/.evertils/config.yml
templates:
    Daily:
        ~/.evertils/templates/daily.yml
    Weekly:
       ~/.evertils/templates/weekly.yml

https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/

Look into building a) an integration layer and b) an integration for Harvest. Features could be:

• logging time directly to the task in Harvest
• get metadata for previous days like "was this billed"

Running evertils generate weekly manually returns an EDAM code 11. Will need to find out the proper ENML format for this note by pulling an existing one from EN and modifying the built in and local templates accordingly.

Command
evertils generate mts CLIENT_NAME

Template

<div><span style="font-size: 18px;">Completed</span></div>
<ul>
<li>...</li>
</ul>
<br />
<div><span style="font-size: 18px;">Logs</span></div>
<ul>
<li>...</li>
</ul>

Tags

• Client name
• Month (i.e. month-2 for February)

This note should be uploaded to the $COMPANY_NAME Logs/Monthly Task Summaries notebook.

New configuration option "yubikey_serial". If present, code should check if this key is connected. This is enough for initial implementation, perhaps a smarter method would also verify the pgp key onboard but I don't know how to do that yet.

A currently unknown issue is preventing notes from being created in v0.2.8.2. This will be updated when the issue is diagnosed and resolved.

There are now several YML configurations for different kinds of generators, a class should be built to parse and manage these internally. Right now everything is basically crammed into the Cfg object and that's not working out so well.

It should:

• read and store the YML config
• provide a single/simple way to get this data and pass it around

Basically you would have a number of config files in your ~/.evertils/templates folder and evertils would parse the config and create them on demand. This would be a small change as far as generating from templates goes, but large in that you could create any "type" of note you wanted so long as you had a valid configuration for it.

For example, at a new job they have a new daily task called scrum. You want to record those things without having to modify evertils core.

# ~/.evertils/templates/type/scrum.yml

- type_name: Scrum
- format: Scrum For [%MONTH% %DAY% %DOW%]
- sections:
    header: nil
    body:
        - `Done`
        - `Next`
        - `Blockers`
    footer: nil
- tags:
    - day-%DOY%
    - month-%MONTH_NUM%
    - week-%WEEK_NUM%

Daily could be represented as follows.

# ~/.evertils/templates/type/daily.yml

- type_name: Daily
- format: Daily Log [%MONTH% %DAY% %DOW%]
- sections:
    header: nil
    body:
        - Triage
        - Meta:
            - Queue
            - Scrum
    footer: nil
- tags:
    - day-%DOY%
    - month-%MONTH_NUM%
    - week-%WEEK_NUM%

Missing types would throw TypeNotFoundException and exit.

https://github.com/defunkt/gist

Something like

$ evertils config pull
$ evertils config push

# .evertils/config.yml
# ...
gist_token: 0011161a57a398c44b7a27d6f113985e
# ...

Pushing creates/updates the gist token you defined in config.yml. Pull overwrites ~/.evertils with it's contents.

Should be able to configure where messages are logged to. Maybe allow multiple locations to be defined?

Add page that describes how to use evertils as a cron job to the wiki. Include sample crontab file, recommend RVM installation, etc.