time_log_robot 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea745bfe20d10a98d2a22ada30fea34c6ea9d138
-  data.tar.gz: ef7dc87e71be0e41c932f2d692fa80507b8a02c0
+  metadata.gz: f61caa0dc4d6525a101c6ce36384098b0b84d707
+  data.tar.gz: 946edcfc71a494b8687572411440988dabfb6fc0
 SHA512:
-  metadata.gz: 25361f569f95c89e8d06fef9841d31926bfd6292b54108c0e814444a4de98c0c4780fd893d7d5124b9dca7ca924c157a9306288e8cc07190551724379f6f3e66
-  data.tar.gz: 0d4a18ca78cc8cb920f151bd7a15f65001f90d989cf9306277967fa9019380d968c093260ec7fb8c802d6ae1ac98323b4c1a7151ec153e80598497f23f324fac
+  metadata.gz: 7d9a8d4838ec1f7178e9ee66111d9e13dabd1324ec24de3d634d662b7d389c08739ed797cb4980470dd3144f38d82074c7ccd3ebb74a6821ab834a369f4ce973
+  data.tar.gz: ce614922c96cdaf8fa142bf4c7fb005d43d1f4cdac73eb421f7dd72f7a920ace010d8ebc606479ccdb89051d62970db1e5047429d98f56f611dbcb842544a6e8

data/.codeclimate.yml

@@ -12,8 +12,13 @@ engines:
       - php
   fixme:
     enabled: true
+    exclude_fingerprints:
+    - 9b1a9060d3684be85a832e44ca1ea7dd
   rubocop:
     enabled: true
+    checks:
+      Rubocop/Lint/AssignmentInCondition:
+        enabled: false
 ratings:
   paths:
   - Gemfile.lock
@@ -26,3 +31,4 @@ ratings:
   - "**.rb"
 exclude_paths:
 - test/
+- README.md

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    time_log_robot (0.1.3)
+    time_log_robot (0.2.0)
       activesupport (~> 4.2, >= 4.2.6)
       commander (~> 4.1, >= 4.1.6)
       httparty (~> 0.13, >= 0.13.0)
@@ -18,14 +18,19 @@ GEM
       tzinfo (~> 1.1)
     ansi (1.5.0)
     builder (3.2.2)
-    commander (4.1.6)
-      highline (~> 1.6.11)
-    highline (1.6.21)
-    httparty (0.13.3)
+    codeclimate-test-reporter (0.5.2)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.1)
+    commander (4.4.0)
+      highline (~> 1.7.2)
+    docile (1.1.5)
+    highline (1.7.8)
+    httparty (0.13.7)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
     i18n (0.7.0)
     json (1.8.3)
+    method_source (0.8.2)
     minitest (5.8.4)
     minitest-reporters (1.1.9)
       ansi
@@ -33,8 +38,18 @@ GEM
       minitest (>= 5.0)
       ruby-progressbar
     multi_xml (0.5.5)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rake (10.5.0)
     ruby-progressbar (1.8.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
@@ -44,10 +59,12 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.3)
+  codeclimate-test-reporter (~> 0.5)
   minitest (~> 5.8)
   minitest-reporters (~> 1.1)
+  pry
   rake (~> 10.5)
   time_log_robot!
 
 BUNDLED WITH
-   1.12.3
+   1.12.5

data/README.md

@@ -47,6 +47,35 @@ The simplest usage is just to invoke the robot:
 
     $ time_log_robot
 
+#### Format of time entries
+
+Time entries need an issue key (in JIRA, something like `BUG-12`), a start time, and a duration. The robot will try to parse an issue key from the description first, then from the project name, then from the mapping file (see ["Mapping Keys"](#mapping-keys) section).
+
+For example, all of these are valid:
+
+    This is a bug BUG-15
+
+    (no description) APP-20
+
+    Meeting
+    (In project named: ADMIN-123)
+
+##### Comments
+
+Some project management tools also accept comments/descriptions for each time log entry. The robot uses any text within curly braces in the time logging app (Toggl) entry as the description in the project management log entry.
+
+For example:
+
+    This is a bug {This is my comment} BUG-15
+
+If there are no curly braces present, the robot will use the entire description as the comment.
+
+For example:
+
+    This whole description is my comment on issue BUG-20
+
+#### Specifying how far back to log
+
 By default, the robot will get all time entries since the previous Saturday. To specify a different time, run it with the optional `--since` flag (Note: the date given must be in YYYY-MM-DD format):
 
     $ time_log_robot --since 2016-05-01
@@ -126,6 +155,8 @@ To run the app in IRB for debugging run
 
 ## Contributing
 
+Contributions are welcome! See the [Issues](https://github.com/supremebeing7/time_log_robot/issues) for stuff that needs doing, or create a new one if you have an idea and we can discuss. Eventually it would be great to integrate this with other project management and time tracking tools, so if you use something besides JIRA or Toggl and want to build an integration, that would be welcome. (There's some refactoring that needs to be done on the existing code to make this simpler - issue [#18](https://github.com/supremebeing7/time_log_robot/issues/18).)
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Write tests for your new code (uses `minitest`)

data/Rakefile

@@ -17,4 +17,6 @@ end
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.test_files = FileList['test/**/*_test.rb']
-end
+end
+
+task default: :test

data/bin/time_log_robot

@@ -2,9 +2,13 @@
 
 require 'commander/import'
 require 'time_log_robot'
+require 'time_log_robot/entry'
+require 'time_log_robot/reporter'
+require 'time_log_robot/tagger'
 require 'time_log_robot/version'
-require 'time_log_robot/toggl/tagger'
+require 'time_log_robot/toggl/entry'
 require 'time_log_robot/toggl/report'
+require 'time_log_robot/toggl/tagger'
 require 'time_log_robot/jira/issue_key_parser'
 require 'time_log_robot/jira/payload_builder'
 require 'time_log_robot/jira/work_logger'

data/lib/time_log_robot/entry.rb

@@ -0,0 +1,12 @@
+module TimeLogRobot
+  class Entry
+    class << self
+      def new(service:, raw_entry:)
+        case service
+        when 'Toggl'
+          Toggl::Entry.new(raw_entry)
+        end
+      end
+    end
+  end
+end

data/lib/time_log_robot/jira/issue_key_parser.rb

@@ -1,16 +1,25 @@
 module TimeLogRobot
   module JIRA
     class IssueKeyParser
+      ISSUE_KEY_REGEX = /([A-Z]+-\d+)/
 
       class << self
-        def parse(description)
-          matches = description.match(/(\[(?<issue_key>[^\]]*)\])/)
-          return matches['issue_key'] unless matches.nil?
-          get_key_from_key_mapping(description)
+        def parse(entry)
+          get_key_from_description(entry.description) ||
+          get_key_from_project(entry.project_name) ||
+          get_key_from_key_mapping(entry.description)
         end
 
         private
 
+        def get_key_from_description(description)
+          description.match(ISSUE_KEY_REGEX).to_a[1]
+        end
+
+        def get_key_from_project(project_name)
+          project_name.match(ISSUE_KEY_REGEX).to_a[1]
+        end
+
         def get_key_from_key_mapping(description)
           if found_key = mappings.keys.find { |key| description.include?(key) }
             mappings[found_key]

data/lib/time_log_robot/jira/work_logger.rb

@@ -7,15 +7,17 @@ module TimeLogRobot
 
       @errors = []
       @logged_count = 0
+      @issue_key = nil
 
       class << self
-        attr_accessor :errors, :logged_count
+        attr_accessor :errors, :logged_count, :issue_key
 
-        def log_all(time_entries:)
-          time_entries.each do |entry|
+        def log_all(service:, time_entries:)
+          time_entries.each do |raw_entry|
+            entry = Entry.new(service: service, raw_entry: raw_entry)
             log(entry) unless is_logged?(entry)
           end
-          print_report
+          report!
         end
 
         private
@@ -33,16 +35,16 @@ module TimeLogRobot
         end
 
         def is_logged?(entry)
-          (log_tags - entry['tags']).size < log_tags.size
+          (log_tags - entry.tags).size < log_tags.size
         end
 
         def log(entry)
-          issue_key = parse_issue_key(entry)
           payload = build_payload(entry)
+          @issue_key = parse_issue_key(entry)
           response = post("/issue/#{issue_key}/worklog", basic_auth: auth, headers: headers, body: payload)
           if response.success?
             print "\e[32m.\e[0m"
-            set_entry_as_logged(entry)
+            tag!(entry) if should_tag?(entry)
             @logged_count += 1
           else
             print "\e[31mF\e[0m"
@@ -54,36 +56,16 @@ module TimeLogRobot
         end
         class UnauthorizedError < Exception; end
 
-        def parse_issue_key(entry)
-          JIRA::IssueKeyParser.parse(entry['description'])
+        def report!
+          Reporter.report(errors, logged_count)
         end
 
-        def print_report
-          print_errors if errors.any?
-          puts "\n\t#{logged_count} entries logged, #{errors.size} failed.\n\n"
+        def tag!(entry)
+          Tagger.tag(entry)
         end
 
-        def print_errors
-          puts "\n\t\e[1;31m Failed to log the following entries:\e[0m"
-          errors.each_with_index do |(entry, response), index|
-            puts "\e[31m"
-            puts "\t#{index + 1})\tDescription: #{entry['description']}"
-            if issue_key = parse_issue_key(entry)
-              puts "\t\tIssue Key: #{issue_key}"
-            else
-              puts "\t\tIssue Key: Missing"
-            end
-            unless parse_comment(entry).nil?
-              puts "\t\tComment: #{parse_comment(entry)}"
-            end
-            puts "\t\t#{human_readable_duration(parse_duration(entry))} starting on #{parse_start(entry)}"
-            puts "\t\tResponse Code: #{response.code}"
-            puts "\e[0m"
-          end
-        end
-
-        def set_entry_as_logged(entry)
-          Toggl::Tagger.update(entry_id: entry['id'])
+        def should_tag?(entry)
+          entry.should_tag?
         end
 
         def auth
@@ -99,31 +81,15 @@ module TimeLogRobot
         end
 
         def build_payload(entry)
-          JIRA::PayloadBuilder.build(
-            start: parse_start(entry),
-            duration_in_seconds: parse_duration(entry),
-            comment: parse_comment(entry)
+          PayloadBuilder.build(
+            start: entry.start,
+            duration_in_seconds: entry.duration_in_seconds,
+            comment: entry.comment
           )
         end
 
-        def parse_start(entry)
-          DateTime.strptime(entry['start'], "%FT%T%:z").strftime("%FT%T.%L%z")
-        end
-
-        def parse_duration(entry)
-          entry['dur']/1000 # Toggl sends times in milliseconds
-        end
-
-        def human_readable_duration(seconds)
-          total_minutes = seconds/60
-          hours = total_minutes/60
-          remaining_minutes = total_minutes - hours * 60
-          "#{hours}h #{remaining_minutes}m"
-        end
-
-        def parse_comment(entry)
-          matches = entry['description'].match(/(\{(?<comment>[^\}]*)\})/)
-          matches['comment'] if matches.present?
+        def parse_issue_key(entry)
+          IssueKeyParser.parse(entry)
         end
       end
     end

data/lib/time_log_robot/reporter.rb

@@ -0,0 +1,32 @@
+module TimeLogRobot
+  class Reporter
+    class << self
+      attr_accessor :errors
+
+      def report(errors, logged_count)
+        @errors = errors
+        print_errors if errors.any?
+        puts "\n\t#{logged_count} entries logged, #{errors.size} failed.\n\n"
+      end
+
+      def print_errors
+        puts "\n\t\e[1;31m Failed to log the following entries:\e[0m"
+        errors.each_with_index do |(entry, response), index|
+          puts "\e[31m"
+          puts "\t#{index + 1})\tDescription: #{entry.description}"
+          if entry.issue_key
+            puts "\t\tIssue Key: #{entry.issue_key}"
+          else
+            puts "\t\tIssue Key: Missing"
+          end
+          if entry.comment
+            puts "\t\tComment: #{entry.comment}"
+          end
+          puts "\t\t#{entry.human_readable_duration} starting on #{entry.start}"
+          puts "\t\tResponse Code: #{response.code}"
+          puts "\e[0m"
+        end
+      end
+    end
+  end
+end

data/lib/time_log_robot/tagger.rb

@@ -0,0 +1,12 @@
+module TimeLogRobot
+  class Tagger
+    class << self
+      def tag(entry)
+        case entry
+        when Toggl::Entry
+          Toggl::Tagger.update(entry_id: entry.id)
+        end
+      end
+    end
+  end
+end

data/lib/time_log_robot/toggl/entry.rb

@@ -0,0 +1,54 @@
+module TimeLogRobot
+  module Toggl
+    class Entry
+      attr_accessor :raw_entry, :duration
+
+      def initialize(raw_entry)
+        @raw_entry = raw_entry
+      end
+
+      def description
+        raw_entry['description']
+      end
+
+      def comment
+        matches = raw_entry['description'].match(/(\{(?<comment>[^\}]*)\})/)
+        return matches['comment'] if matches.present?
+        description
+      end
+
+      def start
+        DateTime.strptime(raw_entry['start'], "%FT%T%:z").strftime("%FT%T.%L%z")
+      end
+
+      def duration_in_seconds
+        # Toggl sends times in milliseconds
+        @duration_in_seconds ||= raw_entry['dur']/1000
+      end
+
+      # @TODO This probably belongs on the reporter class?
+      def human_readable_duration
+        total_minutes = duration_in_seconds/60
+        hours = total_minutes/60
+        remaining_minutes = total_minutes - hours * 60
+        "#{hours}h #{remaining_minutes}m"
+      end
+
+      def id
+        raw_entry['id']
+      end
+
+      def tags
+        raw_entry['tags']
+      end
+
+      def project_name
+        raw_entry['project'] || ''
+      end
+
+      def should_tag?
+        true
+      end
+    end
+  end
+end

data/lib/time_log_robot/toggl/report.rb

@@ -27,7 +27,7 @@ module TimeLogRobot
           2.upto(pages) do |page|
             entries += get_entries_from_next_page(since, page)
           end
-          entries
+          { service: 'Toggl', entries: entries }
         end
 
         def get_entries_from_next_page(since, page)

data/lib/time_log_robot/version.rb

@@ -1,3 +1,3 @@
 module TimeLogRobot
-  VERSION = '0.1.5'
+  VERSION = '0.2.0'
 end

data/lib/time_log_robot.rb

@@ -7,11 +7,14 @@ module TimeLogRobot
   end
 
   def self.start(since)
-    time_entries = fetch_time_entries(since)
-    JIRA::WorkLogger.log_all(time_entries: time_entries)
+    report = fetch_time_report(since)
+    JIRA::WorkLogger.log_all(
+      service: report[:service],
+      time_entries: report[:entries]
+    )
   end
 
-  def self.fetch_time_entries(since)
+  def self.fetch_time_report(since)
     if since.nil?
       Toggl::Report.fetch
     else

data/test/time_log_robot/jira/issue_key_parser_test.rb

@@ -13,26 +13,47 @@ module TimeLogRobot
     class TestIssueKeyParser < Minitest::Test
       def setup
         @described_class = TimeLogRobot::JIRA::IssueKeyParser
+        @entry = OpenStruct.new(description: '', project_name: '')
       end
 
       def test_that_it_gets_the_issue_key
-        assert_equal "PM-12", @described_class.parse('description [PM-12]')
+        @entry.description = 'description [PM-12]'
+        assert_equal "PM-12", @described_class.parse(@entry)
+      end
+
+      def test_that_it_gets_the_issue_key_without_brackets
+        @entry.description = 'description PM-12'
+        assert_equal "PM-12", @described_class.parse(@entry)
       end
 
       def test_that_it_gives_nothing_with_no_key_present
-        assert_equal nil, @described_class.parse('description')
+        @entry.description = 'description'
+        assert_equal nil, @described_class.parse(@entry)
       end
 
       def test_that_it_fetches_the_key_from_mapping
-        assert_equal "HI-5", @described_class.parse('mapped description')
+        @entry.description = 'mapped description'
+        assert_equal "HI-5", @described_class.parse(@entry)
       end
 
       def test_that_parse_is_not_too_strict_with_mappings
-        assert_equal "HI-5", @described_class.parse('mapped description with more text')
+        @entry.description = 'mapped description with more text'
+        assert_equal "HI-5", @described_class.parse(@entry)
       end
 
       def test_that_parse_mappings_works_with_comments
-        assert_equal "HI-5", @described_class.parse('mapped description - {with comment}')
+        @entry.description = 'mapped description - {with comment}'
+        assert_equal "HI-5", @described_class.parse(@entry)
+      end
+
+      def test_get_issue_key_from_project_name
+        @entry.project_name = 'BUG-30'
+        assert_equal "BUG-30", @described_class.parse(@entry)
+      end
+
+      def test_get_issue_key_from_project_name_with_extra_text
+        @entry.project_name = 'BUG-30 crazy bug'
+        assert_equal "BUG-30", @described_class.parse(@entry)
       end
     end
   end

data/time_log_robot.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.0'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 10.5'
   spec.add_development_dependency 'minitest', '~> 5.8'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: time_log_robot
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark J. Lehman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-06-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -179,9 +193,13 @@ files:
 - Rakefile
 - bin/time_log_robot
 - lib/time_log_robot.rb
+- lib/time_log_robot/entry.rb
 - lib/time_log_robot/jira/issue_key_parser.rb
 - lib/time_log_robot/jira/payload_builder.rb
 - lib/time_log_robot/jira/work_logger.rb
+- lib/time_log_robot/reporter.rb
+- lib/time_log_robot/tagger.rb
+- lib/time_log_robot/toggl/entry.rb
 - lib/time_log_robot/toggl/report.rb
 - lib/time_log_robot/toggl/tagger.rb
 - lib/time_log_robot/version.rb
@@ -215,4 +233,3 @@ summary: Automate work time logging
 test_files:
 - test/test_helper.rb
 - test/time_log_robot/jira/issue_key_parser_test.rb
-has_rdoc: