time_log_robot 0.1.1 → 0.1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0559ea642c0065a0807d04c0df40d65b50e6e285
-  data.tar.gz: aa9f9fb89b4b9bfa8218fee09d5bfaa6b71b6af0
+  metadata.gz: 71827460802d842afc432e63f81e43dc67430b73
+  data.tar.gz: e298a0e013600b8ceecbb17c96f450b1f92eed4e
 SHA512:
-  metadata.gz: e71c80181ea7bae7b217a18f9a0c3e03e6218d2b53803b32ab7272b7b22f6de60bc15cdb1d47cbdf8d6f8d243194d10f27bae4855acb1b0cd7594ba2a6f89ba3
-  data.tar.gz: 90ece6f79709e99a83cf12040c687cfa3de7839c506e00ba877075674d5be22805bc992d05470bf1a73cf59bc13013d82dab308b4d51d39c8c0645747fe8e473
+  metadata.gz: cf45dbe4c59830766700c4b413ff40fd69deb342807ddf7cc6be3b662315b6f37f33fc9a4dcc1476c6c9c1da5962698ec89afa97910ab9d3633e00c33468310a
+  data.tar.gz: 3b7f530b071a53e1741167165adcc55d78fdb99a923dc63487b04397c1bc9660299734f79c7205f8bb3ab90f4b912894321c1ea37e7393461e9e1807e4c130d8

data/.settings.yml

@@ -0,0 +1,7 @@
+---
+toggl_token: 5f85129ba262ce647e2914b7eeaa4cbc
+toggl_workspace_id: '702788'
+toggl_user_agent: markopolo@gmail.com
+toggl_default_log_tag: logged
+jira_username: markl
+jira_password: XDR%t6yhn

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    time_log_robot (0.1.1)
+    time_log_robot (0.1.2)
       activesupport (~> 4.2, >= 4.2.6)
       commander (~> 4.1, >= 4.1.6)
       httparty (~> 0.13, >= 0.13.0)
@@ -16,6 +16,9 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    ansi (1.5.0)
+    builder (3.2.2)
+    coderay (1.1.1)
     commander (4.1.6)
       highline (~> 1.6.11)
     highline (1.6.21)
@@ -23,10 +26,27 @@ GEM
       json (~> 1.8)
       multi_xml (>= 0.5.2)
     i18n (0.7.0)
+    interception (0.5)
     json (1.8.3)
+    method_source (0.8.2)
     minitest (5.8.4)
+    minitest-emoji (2.0.0)
+    minitest-reporters (1.1.9)
+      ansi
+      builder
+      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)
+    pry-rescue (1.4.4)
+      interception (>= 0.5)
+      pry
     rake (10.5.0)
+    ruby-progressbar (1.8.1)
+    slop (3.6.0)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
@@ -36,6 +56,10 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.3)
+  minitest
+  minitest-emoji
+  minitest-reporters
+  pry-rescue
   rake (~> 10.5)
   time_log_robot!
 

data/README.md

@@ -1,6 +1,35 @@
 # Time Log Robot
 ***Let the robot do your work time logging.***
 
+                  ,--.    ,--.
+                 ((O ))--((O ))
+               ,'_`--'____`--'_`.
+              _:  ____________  :_
+             | | ||::::::::::|| | |
+             | | ||::::::::::|| | |
+             | | ||::::::::::|| | |
+             |_| |/__________\| |_|
+               |________________|
+            __..-'            `-..__
+         .-| : .----------------. : |-.
+       ,\ || | |\______________/| | || /.
+      /`.\:| | ||  __  __  __  || | |;/,'\
+     :`-._\;.| || '--''--''--' || |,:/_.-':
+     |    :  | || .----------. || |  :    |
+     |    |  | || '----SSt---' || |  |    |
+     |    |  | ||   _   _   _  || |  |    |
+     :,--.;  | ||  (_) (_) (_) || |  :,--.;
+     (`-'|)  | ||______________|| |  (|`-')
+      `--'   | |/______________\| |   `--'
+             |____________________|
+              `.________________,'
+               (_______)(_______)
+               (_______)(_______)
+               (_______)(_______)
+               (_______)(_______)
+              |        ||        |
+              '--------''--------'
+
 This is an integration between project management tools (like JIRA) and time logging apps (like Toggl). Currently, it only works as an import from Toggl into JIRA.
 
 ## Installation
@@ -39,7 +68,7 @@ Here are some notes about how to find the appropriate values for those environme
 * **TOGGL_TOKEN**: In your Toggl account, go to your profile page and look for the API token at the bottom.
 * **TOGGL_WORKSPACE_ID**: This is a little trickier. Your workspaces usually only show a human-readable name to you in Toggl's UI, and here you need the workspace's machine ID. But you can do a curl request to find it like this (replacing **TOGGL_TOKEN** with your token from above):
 
-    curl -v -u TOGGL_TOKEN:api_token \ -X GET https://www.toggl.com/api/v8/workspaces
+    `curl -v -u TOGGL_TOKEN:api_token \ -X GET https://www.toggl.com/api/v8/workspaces`
 
   Look at the result and find the id given for the workspace you want to use.
 
@@ -48,6 +77,19 @@ Here are some notes about how to find the appropriate values for those environme
 * **JIRA_USERNAME**: This is your JIRA username, which is not an email, but usually your email minus the "@domain.com"
 * **JIRA_PASSWORD**: I know there's a lot of jargon, but some of these are pretty self-explanatory. :trollface:
 
+### Mapping keys
+
+You can now map JIRA keys to specific phrases so that in your Toggl time entries, you won't need to enter the JIRA key. These mappings are stored in a YAML file in the gem root directory:
+
+    path/to/gem/mapping.yml
+
+    # Example usage
+    # --
+    # phrase: JIRA-KEY
+    weekly planning: PM-1
+
+With this mapping, when logging time on on Toggl, instead of having to enter "weekly planning [PM-1]", you can just enter "weekly planning" and the robot will get the JIRA key from the `mapping.yml` file.
+
 ### Help
 
 For more details use the help flag:
@@ -72,4 +114,13 @@ To run the app in IRB for debugging run
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request to Dev
+5. Create new Pull Request to Dev
+
+## License
+
+This program is provided under an MIT open source license, read the [MIT-LICENSE.txt](http://github.com/supremebeing7/jira_toggl_importer/blob/master/LICENSE.txt) file for details.
+
+
+## Copyright
+
+Copyright (c) 2016 Mark J. Lehman

data/Rakefile

@@ -1,3 +1,4 @@
+require 'rake/testtask'
 require 'bundler/gem_tasks'
 
 desc 'Run in IRB for debugging'
@@ -8,3 +9,10 @@ task :console do
   ARGV.clear
   IRB.start
 end
+
+# @TODO Uncomment when it works! - `rake test`
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/lib/time_log_robot/jira/issue_key_parser.rb

@@ -1,26 +1,27 @@
 module TimeLogRobot
   module JIRA
     class IssueKeyParser
+
       class << self
-        def parse(entry)
-          matches = entry['description'].match(/(\[(?<issue_key>[^\]]*)\])/)
-          if matches.present?
-            matches['issue_key']
-          else
-            get_key_from_key_mapping(entry['description'])
-          end
+        def parse(description)
+          matches = description.match(/(\[(?<issue_key>[^\]]*)\])/)
+          return matches['issue_key'] unless matches.nil?
+          get_key_from_key_mapping(description)
         end
 
         private
 
         def get_key_from_key_mapping(description)
-          mappings = YAML.load_file(mapping_file_path) || {}
-          if found_key = mappings.keys.find { |key| /#{description}/ =~ key }
+          if found_key = mappings.keys.find { |key| description.include?(key) }
             mappings[found_key]
           end
         end
 
-        def mapping_file_path
+        def mappings
+          YAML.load_file(keymap_file_path) || {}
+        end
+
+        def keymap_file_path
           File.join(TimeLogRobot.root, 'mapping.yml')
         end
       end

data/lib/time_log_robot/jira/work_logger.rb

@@ -33,7 +33,7 @@ module TimeLogRobot
         end
 
         def log(entry)
-          issue_key = JIRA::IssueKeyParser.parse(entry)
+          issue_key = JIRA::IssueKeyParser.parse(entry['description'])
           payload = build_payload(entry)
           puts "Attempting to log #{human_readable_duration(parse_duration(entry))}"
           puts "starting on #{parse_start(entry)}"

data/lib/time_log_robot/version.rb

@@ -1,3 +1,3 @@
 module TimeLogRobot
-  VERSION = '0.1.1'
+  VERSION = '0.1.2.1'
 end

data/mapping.yml

@@ -1,3 +1,8 @@
 monday meeting: PM-1
 weekly planning meeting: PM-1
-time log robot: OSS-5
+architecture planning: PM-1
+architecture meeting: PM-1
+time log robot: OSS-5
+code review: PM-38
+daily planning: PM-35
+hw checkin meeting: HW-10

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/emoji'
+require 'minitest/reporters'
+require 'yaml'
+require 'active_support'
+# require 'pry-rescue/minitest'
+require 'httparty'
+
+Dir[File.expand_path "lib/**/*.rb"].each{|file| require_relative file }
+
+reporter_options = { color: true }
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(reporter_options)]
+

data/test/time_log_robot/jira/issue_key_parser_test.rb

@@ -0,0 +1,39 @@
+require_relative '../../test_helper'
+
+module TimeLogRobot
+  module JIRA
+    class IssueKeyParser
+      def self.mappings
+        {
+          "mapped description" => "HI-5"
+        }
+      end
+    end
+
+    class TestIssueKeyParser < Minitest::Test
+      def setup
+        @described_class = TimeLogRobot::JIRA::IssueKeyParser
+      end
+
+      def test_that_it_gets_the_issue_key
+        assert_equal "PM-12", @described_class.parse('description [PM-12]')
+      end
+
+      def test_that_it_gives_nothing_with_no_key_present
+        assert_equal nil, @described_class.parse('description')
+      end
+
+      def test_that_it_fetches_the_key_from_mapping
+        assert_equal "HI-5", @described_class.parse('mapped description')
+      end
+
+      def test_that_parse_is_not_too_strict_with_mappings
+        assert_equal "HI-5", @described_class.parse('mapped description with more text')
+      end
+
+      def test_that_parse_mappings_works_with_comments
+        assert_equal "HI-5", @described_class.parse('mapped description - {with comment}')
+      end
+    end
+  end
+end

data/time_log_robot.gemspec

@@ -21,6 +21,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 10.5'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-emoji'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'pry-rescue'
 
   spec.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.6'
   spec.add_runtime_dependency 'commander', '~> 4.1', '>= 4.1.6'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_log_robot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2.1
 platform: ruby
 authors:
 - Mark J. Lehman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: minitest-emoji
+  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: minitest-reporters
+  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: pry-rescue
+  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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +199,8 @@ files:
 - lib/time_log_robot/toggl/tagger.rb
 - lib/time_log_robot/version.rb
 - mapping.yml
+- test/test_helper.rb
+- test/time_log_robot/jira/issue_key_parser_test.rb
 - time_log_robot.gemspec
 homepage: https://github.com/supremebeing7/time_log_robot
 licenses:
@@ -168,5 +226,7 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Automate work time logging
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/time_log_robot/jira/issue_key_parser_test.rb
 has_rdoc: