time_log_robot 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02779016739df4a954e1bdb2a1497dec6fc5c75f
-  data.tar.gz: bb7e9647e14ed514a143ac06f9e3e855388a2446
+  metadata.gz: 0559ea642c0065a0807d04c0df40d65b50e6e285
+  data.tar.gz: aa9f9fb89b4b9bfa8218fee09d5bfaa6b71b6af0
 SHA512:
-  metadata.gz: dfec06ec09c95fef5e4085cbdbc8a8fe4a23efc9a58fa18f1f09b7f01cc0396592c78b00b4c5f1c5b225d1a54906bdaeb91ab31ca32aba5dab4e11a26b6fe916
-  data.tar.gz: 7fad04cb28781642f91bb496551f3cf38ddf6e5caeb633a22ce7c7d8811ba40823402fb7725e070d9839aa9b8ff0ac686b316e932aa9e884ac16b363d19f99df
+  metadata.gz: e71c80181ea7bae7b217a18f9a0c3e03e6218d2b53803b32ab7272b7b22f6de60bc15cdb1d47cbdf8d6f8d243194d10f27bae4855acb1b0cd7594ba2a6f89ba3
+  data.tar.gz: 90ece6f79709e99a83cf12040c687cfa3de7839c506e00ba877075674d5be22805bc992d05470bf1a73cf59bc13013d82dab308b4d51d39c8c0645747fe8e473

data/.gitignore

@@ -1,2 +1 @@
-config/settings.sample.yaml
 pkg/

data/.settings.yml

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    time_log_robot (0.1.0)
+    time_log_robot (0.1.1)
       activesupport (~> 4.2, >= 4.2.6)
       commander (~> 4.1, >= 4.1.6)
       httparty (~> 0.13, >= 0.13.0)

data/README.md

@@ -5,14 +5,8 @@ This is an integration between project management tools (like JIRA) and time log
 
 ## Installation
 
-~~Download this gem:~~ This is not yet on RubyGems, but once it is, you will be able to download like so:
-
     gem install time_log_robot
 
-Until then...
-
-    rake install
-
 ## Usage
 
 The simplest usage is just to invoke the robot:

data/bin/time_log_robot

@@ -5,6 +5,7 @@ require 'time_log_robot'
 require 'time_log_robot/version'
 require 'time_log_robot/toggl/tagger'
 require 'time_log_robot/toggl/report'
+require 'time_log_robot/jira/issue_key_parser'
 require 'time_log_robot/jira/payload_builder'
 require 'time_log_robot/jira/work_logger'
 require 'yaml'

data/lib/time_log_robot.rb

@@ -8,14 +8,14 @@ module TimeLogRobot
 
   def self.start(since)
     time_entries = fetch_time_entries(since)
-    JIRA::WorkLogger.new(time_entries: time_entries).log_all
+    JIRA::WorkLogger.log_all(time_entries: time_entries)
   end
 
   def self.fetch_time_entries(since)
     if since.nil?
-      Toggl::Report.new.fetch
+      Toggl::Report.fetch
     else
-      Toggl::Report.new.fetch(since: since)
+      Toggl::Report.fetch(since: since)
     end
   end
 

data/lib/time_log_robot/jira/issue_key_parser.rb

@@ -0,0 +1,29 @@
+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
+        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 }
+            mappings[found_key]
+          end
+        end
+
+        def mapping_file_path
+          File.join(TimeLogRobot.root, 'mapping.yml')
+        end
+      end
+    end
+  end
+end

data/lib/time_log_robot/jira/payload_builder.rb

@@ -1,20 +1,14 @@
 module TimeLogRobot
   module JIRA
     class PayloadBuilder
-      attr_accessor :start, :duration_in_seconds, :comment
-
-      def initialize(start:, duration_in_seconds:, comment:)
-        @start = start
-        @duration_in_seconds = duration_in_seconds
-        @comment = comment
-      end
-
-      def build
-        {
-          "comment" => comment,
-          "started" => start.to_s,
-          "timeSpentSeconds" => duration_in_seconds
-        }.to_json
+      class << self
+        def build(start:, duration_in_seconds:, comment:)
+          {
+            "comment" => comment,
+            "started" => start.to_s,
+            "timeSpentSeconds" => duration_in_seconds
+          }.to_json
+        end
       end
     end
   end

data/lib/time_log_robot/jira/work_logger.rb

@@ -7,93 +7,106 @@ module TimeLogRobot
 
       base_uri 'https://hranswerlink.atlassian.net/rest/api/2'
 
-      def initialize(time_entries:, log_tags: [ENV['TOGGL_DEFAULT_LOG_TAG']])
-        @username = ENV['JIRA_USERNAME']
-        @password = ENV['JIRA_PASSWORD']
-        @time_entries = time_entries
-        @log_tags = log_tags
-      end
+      class << self
+        def log_all(time_entries:)
+          time_entries.each do |entry|
+            log(entry) unless is_logged?(entry)
+          end
+        end
 
-      def log_all
-        time_entries.each do |entry|
-          log(entry) unless is_logged?(entry)
+        private
+
+        def username
+          ENV['JIRA_USERNAME']
         end
-      end
 
-      private
+        def password
+          ENV['JIRA_PASSWORD']
+        end
 
-      def is_logged?(entry)
-        (log_tags - entry['tags']).size < log_tags.size
-      end
+        def log_tags
+          [ENV['TOGGL_DEFAULT_LOG_TAG']]
+        end
 
-      def log(entry)
-        issue_key = parse_issue_key(entry)
-        payload = build_payload(entry)
-        puts "Attempting to log #{human_readable_duration(parse_duration(entry))}"
-        puts "starting on #{parse_start(entry)}"
-        puts "to #{entry['description']}"
-        puts "with comment #{parse_comment(entry)}" unless parse_comment(entry).nil?
-        response = self.class.post("/issue/#{issue_key}/worklog", basic_auth: auth, headers: headers, body: payload)
-        if response.success?
-          puts "Success"
-          puts '*' * 20
-          set_entry_as_logged(entry)
-        else
-          puts "Failed! Response from JIRA:"
-          puts response
-          puts "(Hint: Did you forget to put the JIRA issue key in your Toggl entry?"
-          puts '*' * 20
+        def is_logged?(entry)
+          (log_tags - entry['tags']).size < log_tags.size
         end
-      end
 
-      def set_entry_as_logged(entry)
-        Toggl::Tagger.new(tags: log_tags).update(entry_id: entry['id'])
-      end
+        def log(entry)
+          issue_key = JIRA::IssueKeyParser.parse(entry)
+          payload = build_payload(entry)
+          puts "Attempting to log #{human_readable_duration(parse_duration(entry))}"
+          puts "starting on #{parse_start(entry)}"
+          puts "to #{entry['description']}"
+          puts "issue key #{issue_key}"
+          puts "with comment #{parse_comment(entry)}" unless parse_comment(entry).nil?
+          response = post("/issue/#{issue_key}/worklog", basic_auth: auth, headers: headers, body: payload)
+          if response.success?
+            puts "Success"
+            puts '*' * 20
+            set_entry_as_logged(entry)
+          else
+            puts response.code
+            puts "Failed! Response from JIRA:"
+            if response.code == 401
+              raise UnauthorizedError, "Please check your username and password and try again"
+            elsif response.code == 404
+              puts "Not Found - Did you forget to put the JIRA issue key in your Toggl entry?"
+            end
+            puts '*' * 20
+          end
+        end
+        class UnauthorizedError < Exception; end
 
-      def auth
-        {
-          username: username,
-          password: password
-        }
-      end
+        def set_entry_as_logged(entry)
+          Toggl::Tagger.update(entry_id: entry['id'])
+        end
 
-      # @TODO Extract since it's used in several different models
-      def headers
-        { 'Content-Type' => 'application/json' }
-      end
+        def auth
+          {
+            username: username,
+            password: password
+          }
+        end
 
-      def build_payload(entry)
-        JIRA::PayloadBuilder.new(
-          start: parse_start(entry),
-          duration_in_seconds: parse_duration(entry),
-          comment: parse_comment(entry)
-        ).build
-      end
+        # @TODO Extract since it's used in several different models
+        def headers
+          { 'Content-Type' => 'application/json' }
+        end
 
-      def parse_start(entry)
-        DateTime.strptime(entry['start'], "%FT%T%:z").strftime("%FT%T.%L%z")
-      end
+        def build_payload(entry)
+          JIRA::PayloadBuilder.build(
+            start: parse_start(entry),
+            duration_in_seconds: parse_duration(entry),
+            comment: parse_comment(entry)
+          )
+        end
 
-      def parse_duration(entry)
-        entry['dur']/1000 # Toggl sends times in milliseconds
-      end
+        def parse_start(entry)
+          DateTime.strptime(entry['start'], "%FT%T%:z").strftime("%FT%T.%L%z")
+        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_duration(entry)
+          entry['dur']/1000 # Toggl sends times in milliseconds
+        end
 
-      # @TODO figure out how to capture both of this in one .match call with one set of regex
-      def parse_issue_key(entry)
-        matches = entry['description'].match(/(\[(?<issue_key>[^\]]*)\])/)
-        matches['issue_key'] if matches.present?
-      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?
+        # @TODO figure out how to capture both of this in one .match call with one set of regex
+        def parse_issue_key(entry)
+          matches = entry['description'].match(/(\[(?<issue_key>[^\]]*)\])/)
+          matches['issue_key'] if matches.present?
+        end
+
+        def parse_comment(entry)
+          matches = entry['description'].match(/(\{(?<comment>[^\}]*)\})/)
+          matches['comment'] if matches.present?
+        end
       end
     end
   end

data/lib/time_log_robot/toggl/report.rb

@@ -5,44 +5,49 @@ module TimeLogRobot
     class Report
       include HTTParty
 
-      attr_accessor :token, :workspace_id, :user_agent
-
       base_uri 'https://toggl.com/reports/api/v2'
 
-      def initialize
-        @token = ENV['TOGGL_TOKEN']
-        @workspace_id = ENV['TOGGL_WORKSPACE_ID']
-        @user_agent = ENV['TOGGL_USER_AGENT']
-      end
+      class << self
+        def fetch(since: nil)
+          since ||= Date.today.beginning_of_week(:saturday).to_time
+          response = get('/details', basic_auth: auth, query: query(since))
+          if response.success?
+            response['data']
+          else
+            raise FetchError, response['error']
+          end
+        end
+        class FetchError < Exception; end
 
-      def fetch(since: nil)
-        since ||= Date.today.beginning_of_week(:saturday).to_time
-        response = self.class.get('/details', basic_auth: auth, query: query(since))
-        if response.success?
-          response['data']
-        else
-          raise FetchError, response['error']
+        private
+
+        def auth
+          {
+            username: token,
+            password: "api_token"
+          }
+        end
+
+        def token
+          ENV['TOGGL_TOKEN']
         end
-      end
-      class FetchError < Exception; end
 
-      private
+        def workspace_id
+          ENV['TOGGL_WORKSPACE_ID']
+        end
 
-      def auth
-        {
-          username: token,
-          password: "api_token"
-        }
-      end
+        def user_agent
+          ENV['TOGGL_USER_AGENT']
+        end
 
-      def query(since)
-        {
-          workspace_id: workspace_id,
-          user_agent: user_agent,
-          since: since
-        }
+        def query(since)
+          {
+            workspace_id: workspace_id,
+            user_agent: user_agent,
+            since: since
+          }
+        end
       end
     end
-
   end
 end

data/lib/time_log_robot/toggl/tagger.rb

@@ -3,39 +3,42 @@ module TimeLogRobot
     class Tagger
       include HTTParty
 
-      attr_accessor :token, :tags
-
       base_uri 'https://toggl.com/api/v8/time_entries'
 
-      def initialize(tags:[ENV['TOGGL_DEFAULT_LOG_TAG']])
-        @token = ENV['TOGGL_TOKEN']
-        @tags = tags
-      end
+      class << self
+        def update(entry_id:)
+          put("/#{entry_id}", basic_auth: auth, headers: headers, body: body)
+        end
 
-      def update(entry_id:)
-        self.class.put("/#{entry_id}", basic_auth: auth, headers: headers, body: body)
-      end
+        private
 
-      private
+        def auth
+          {
+            username: token,
+            password: "api_token"
+          }
+        end
 
-      def auth
-        {
-          username: token,
-          password: "api_token"
-        }
-      end
+        def token
+          ENV['TOGGL_TOKEN']
+        end
 
-      def headers
-        { 'Content-Type' => 'application/json' }
-      end
+        def headers
+          { 'Content-Type' => 'application/json' }
+        end
 
-      def body
-        {
-          time_entry:
+        def body
           {
-            tags: tags
-          }
-        }.to_json
+            time_entry:
+            {
+              tags: tags
+            }
+          }.to_json
+        end
+
+        def tags
+          [ENV['TOGGL_DEFAULT_LOG_TAG']]
+        end
       end
     end
   end

data/lib/time_log_robot/version.rb

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

data/mapping.yml

@@ -0,0 +1,3 @@
+monday meeting: PM-1
+weekly planning meeting: PM-1
+time log robot: OSS-5

data/time_log_robot.gemspec

@@ -1,12 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-# require 'time_log_robot/version'
+require 'time_log_robot/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'time_log_robot'
-  spec.version       = '0.1.0'
-  # spec.version       = TimeLogRobot::VERSION
+  spec.version       = TimeLogRobot::VERSION
   spec.authors       = ['Mark J. Lehman']
   spec.email         = ['markopolo@gmail.com']
   spec.description   = %q{Automate time logging from tools like Toggl to project management software such as JIRA}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_log_robot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mark J. Lehman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -136,11 +136,13 @@ files:
 - Rakefile
 - bin/time_log_robot
 - lib/time_log_robot.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/toggl/report.rb
 - lib/time_log_robot/toggl/tagger.rb
 - lib/time_log_robot/version.rb
+- mapping.yml
 - time_log_robot.gemspec
 homepage: https://github.com/supremebeing7/time_log_robot
 licenses: