jira-worklog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dae0dae3af9ab3285fb419cdc4c1d6338c9ed5df
+  data.tar.gz: d9b95a7c330cb519c77afcc71440e1e0522f52bd
+SHA512:
+  metadata.gz: 0050fc8ced2f953489114eadeea114b85e9dfbbd6e24ba1120d968f5db5b04efb547003fbe5d7c91acb71adc575a6fe3cdbd4ad6e9475060522505f59e45eb8c
+  data.tar.gz: ead9e23abe1e027a1bf14489ae6aadc3dd01b1e1cb3cdedcbd3ba526a6da64d8bf9522b661702255ff2ca9d7dcdea933fea5911adb31c6df4468fa1be495402f

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    jira-worklog (0.1.0)
+      commander (~> 4.4.3)
+      rest-client (~> 2.0.0)
+      simple_xlsx_reader (~> 1.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    commander (4.4.3)
+      highline (~> 1.7.2)
+    diff-lcs (1.3)
+    domain_name (0.5.20161129)
+      unf (>= 0.0.5, < 1.0.0)
+    highline (1.7.8)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    netrc (0.11.0)
+    nokogiri (1.7.0.1)
+      mini_portile2 (~> 2.1.0)
+    rake (10.5.0)
+    rest-client (2.0.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubyzip (1.2.1)
+    simple_xlsx_reader (1.0.2)
+      nokogiri
+      rubyzip
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  jira-worklog!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Petr Cervinka
+
+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,82 @@
+# Jira::Worklog
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jira-worklog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jira-worklog
+
+## Usage
+
+You can use JIRA API Client programatically (see `lib/jira/worklog/api_client.rb`) or as CLI utility `jira-worklog`
+
+
+
+### CLI - List issues 
+
+In order to add some worklog from excel, you need to know available issues (key or id). This command helps you to get list of issues:
+ 
+```bash
+jira-worklog issues -u MY_USERNAME -p MY_PASSWORD -b https://jira.example.com/rest/api/2/
+```
+
+### CLI - List worklogs for issue
+ 
+```bash
+jira-worklog list -u MY_USERNAME -p MY_PASSWORD -b https://jira.example.com/rest/api/2/ --issue ISUE_ID_OR_KEY 
+```
+ 
+### CLI - Add worklogs from xlsx file
+
+File must be in excel xlsx form and must contain 4 colums (ussue_id_or_key, date, duration_in_hours, comment). For example file se `exmple.xlsx`.
+ 
+```bash
+jira-worklog add -u MY_USERNAME -p MY_PASSWORD -b https://jira.example.com/rest/api/2/ --xlsx FILE.XLSX
+```
+ 
+### CLI - delete worklogs
+
+```bash
+jira-worklog delete -u MY_USERNAME -p MY_PASSWORD -b https://jira.example.com/rest/api/2/ WORKLOG_ID1,WORKLOG_ID2,...
+```
+ 
+
+### Ruby API Client
+
+```ruby
+api = Jira::Worklog::APIClient.new(base_url, user, password)
+api.issues()                    # list issues for logged user
+api.worklogs(issue_id_or_key)   # fetch stored worklogs for given issue
+api.add_worklog(worklog_data)   # add worklog - worklog_data is a Hash:
+                                # {issue: 'ISSSUE_ID_OR_KEY', started: Date, duration: in_seconds, comment: 'comment'} 
+api.delete_worklog(issue_id_or_key, worklog_id)                              
+
+```
+
+## 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.
+
+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/[USERNAME]/jira-worklog.
+
+
+## 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 "jira/worklog"
+
+# 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/jira-worklog

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'jira/worklog'
+require 'jira/worklog/cli'

data/jira-worklog.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jira/worklog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jira-worklog'
+  spec.version       = Jira::Worklog::VERSION
+  spec.authors       = ['Petr Cervinka']
+  spec.email         = ['petr@petrcervinka.cz']
+
+  spec.summary       = %q{Allow add JIRA worklog (hours worked) from excel (.xlsx) file via JIRA REST API}
+  spec.homepage      = 'https://github.com/cervinka/jira-worklog'
+  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_dependency 'commander', '~> 4.4.3'
+  spec.add_dependency 'rest-client', '~> 2.0.0'
+  spec.add_dependency 'simple_xlsx_reader', '~> 1.0.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/jira/worklog.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'json'
+require 'rest-client'
+require 'simple_xlsx_reader'
+require 'jira/worklog/version'
+require 'jira/worklog/api_client'
+
+module Jira
+  module Worklog
+    # Your code goes here...
+  end
+end

data/lib/jira/worklog/api_client.rb

@@ -0,0 +1,64 @@
+class APIClient
+  attr_reader :user, :password, :url_base
+
+  def initialize(url_base, user, password)
+    @user = user
+    @password = password
+    @url_base = url_base
+  end
+
+
+  def issues
+    data = request("search?jql=assignee=#{user}")
+    data['issues'].map { |issue| {key: issue['key'], id: issue['id'], summary: issue['fields']['summary']} }
+  end
+
+  def delete_worklog(issue, worklog_id)
+    delete_request("issue/#{issue}/worklog/#{worklog_id}")
+  end
+
+  def add_worklog(worklog)
+    req = {
+        comment: worklog[:comment],
+        started: worklog[:date].strftime('%Y-%m-%d') + 'T07:00:00.000+0100',
+        timeSpentSeconds: worklog[:duration]
+    }
+    data = post_request("issue/#{worklog[:issue]}/worklog", req.to_json)
+    # puts "added: #{worklog.inspect}"
+    data['id']
+  end
+
+
+  def worklogs(issue)
+    data = request("issue/#{issue}/worklog")
+    # pp data
+    data['worklogs'].map { |worklog|
+      {
+          duration: worklog['timeSpentSeconds'],
+          comment: worklog['comment'],
+          issue_id: worklog['issueId'],
+          id: worklog['id'],
+          date: Date.strptime(worklog['started'][0..9], '%Y-%m-%d')
+      }
+    }
+  end
+
+  private
+  def request(path)
+    url = url_base + path
+    resp = RestClient::Request.execute method: :get, url: url, user: user, password: password, :verify_ssl => false
+    JSON.parse resp.body
+  end
+
+  def delete_request(path)
+    url = url_base + path
+    RestClient::Request.execute method: :delete, url: url, user: user, password: password, :verify_ssl => false
+  end
+
+  def post_request(path, payload)
+    url = url_base + path
+    resp = RestClient::Request.execute method: :post, url: url, user: user, password: password, :verify_ssl => false, payload: payload, headers: {'Content-Type' => 'application/json; charset=utf-8'}
+    JSON.parse resp.body
+  end
+
+end

data/lib/jira/worklog/cli.rb

@@ -0,0 +1,129 @@
+require 'commander/import'
+
+program :name, 'jira-worklog'
+program :version, '0.0.1'
+program :description, 'Add worklog to JIRA using REST API'
+# program :help_formatter, :compact
+
+global_option '-u', '--user USERNAME', 'JIRA login username'
+global_option '-p', '--password PASSWORD', 'JIRA login password'
+global_option '-b', '--url-base BASE_URL', 'JIRA base URL. ie: https://jira.example.com/rest/api/2/'
+
+command :issues do |c|
+  c.syntax = 'jira-worklog issues [options]'
+  c.summary = 'List available issues'
+  # c.description = ''
+  c.example 'list issues', 'jira-worklog issues -u USERNAME -p PASSWORD -b BASE_URL'
+  c.action do |_args, options|
+    url_base, user, password = get_credentials(options)
+    api = APIClient.new(url_base,user, password)
+    # api = Jira::Worklog::APIClient.new(url_base,user, password)
+    api.issues.each do |issue|
+      puts "#{issue[:key]} (issue_id #{issue[:id]}) - #{issue[:summary]}"
+    end
+  end
+end
+
+command :add do |c|
+  c.syntax = 'jira-worklog add [options]'
+  c.summary = 'Add new worklog entries to JIRA'
+  c.description= <<DESCRIPTION
+- input file must contain 4 columns and each column is required  (additional rows are ignored)
+  - 1st column: issue key or id
+  - 2nd column: date (start time is set to 7am automatically)
+  - 3rd column: duration in hours
+  - 4th column: comment
+DESCRIPTION
+  c.example 'description', 'jira-worklog add -u USER -p PASSWORD -b BASE_URL --xlsx FILE.XLSX'
+  c.option '--xlsx FILE', 'Add new entries to JIRA workog from xlsx file'
+  c.action do |_args, options|
+    raise '--xlsx is mandatory parameter' unless options.xlsx
+    url_base, user, password = get_credentials(options)
+    api = APIClient.new(url_base, user, password)
+    worklogs = load_from_xlsx(options.xlsx)
+    worklog_ids = []
+
+    worklogs.each do |worklog|
+      worklog_id = api.add_worklog(worklog)
+      worklog_ids << worklog_id
+      puts "#{formatted_duration(worklog[:duration])} - (id: #{worklog_id}) #{worklog[:date]} #{worklog[:issue]} #{worklog[:comment]}"
+    end
+    puts '-' * 60
+    puts "#{formatted_duration(worklogs.inject(0) { |sum, worklog| sum + worklog[:duration] })} inserted"
+    puts "New ids: #{worklog_ids.join(',')}"
+  end
+end
+
+command :delete do |c|
+  c.syntax = 'jira-worklog delete ISSUE WORKLOG_IDS'
+  c.summary = 'Delete worklog entries by ids (comma separated)'
+  c.example 'delete worklogs', 'jira-worklog delete -u USER -p PASSWORD -b BASE_URL WORKLOG1_ID,WORKLOG2_ID,...'
+  c.action do |args, options|
+    issue = args[0].to_s
+    raise 'please specify issue key or id' if issue.nil?
+    ids = args[1].to_s.split(',')
+    raise 'please specify worklog ids (comma separated)' if ids.empty?
+    url_base, user, password = get_credentials(options)
+    api = APIClient.new(url_base, user, password)
+    ids.each do |worklog_id|
+      puts "Deleting worklog ##{worklog_id}"
+      api.delete_worklog(issue, worklog_id)
+    end
+
+  end
+end
+
+command :list do |c|
+  c.syntax = 'jira-worklog list [options]'
+  c.summary = 'List worklog entries for given issue'
+  c.description = ''
+  c.example 'list worklogs for given issue', 'jira-worklog list -u USER -p PASSWORD -b BASE_URL --issue ISSUE_ID_OR_KEY'
+  c.option '--issue ISSUE', 'JIRA Issue Key or Id (use "issues" command to list available issues)'
+  c.action do |_args, options|
+    raise '--issue is mandatory parameter' unless options.issue
+    url_base, user, password = get_credentials(options)
+    api = APIClient.new(url_base, user, password)
+    worklogs = api.worklogs(options.issue)
+    worklog_ids = []
+    worklogs.each do |worklog|
+      puts "#{formatted_duration(worklog[:duration])} - (id: #{worklog[:id]}) #{worklog[:date]} #{worklog[:comment]}"
+      worklog_ids << worklog[:id]
+    end
+    puts '-' * 60
+    puts "#{formatted_duration(worklogs.inject(0) { |sum, worklog| sum + worklog[:duration] })} total"
+    puts "Worklog ids: #{worklog_ids.join(',')}"
+  end
+end
+
+def load_from_xlsx(filename)
+  doc = SimpleXlsxReader.open(filename)
+  doc.sheets # => [<#SXR::Sheet>, ...]
+  sheet = doc.sheets.first
+  puts "Loading from sheet: #{sheet.name}"
+  worklogs = []
+  sheet.rows.each.with_index do |row, idx|
+    issue, date, duration, comment = row[0], row[1], row[2], row[3]
+    duration = Float(duration) rescue 0
+    if issue && !issue.nil? && !issue.empty? && date.is_a?(Date) && duration > 0 && comment && !comment.nil? && !comment.empty?
+      worklogs << ({issue: issue, date: date, duration: duration * 3600, comment: comment})
+    else
+      puts "Skipping row ##{idx + 1}: #{row.inspect}"
+    end
+  end
+  worklogs
+end
+
+def formatted_duration(total_seconds)
+  hours = total_seconds / (60 * 60)
+  minutes = (total_seconds / 60) % 60
+  seconds = total_seconds % 60
+  '%2d:%02d:%02d' % [hours, minutes, seconds]
+end
+
+def get_credentials(options)
+  user = options.user || ask('JIRA user: ')
+  password = options.password || ask('JIRA password: ') { |q| q.echo = '*' }
+  url_base = options.url_base
+  raise('--url_base is mandatory option') if url_base.nil? || url_base.empty?
+  [url_base, user, password]
+end

data/lib/jira/worklog/version.rb

@@ -0,0 +1,5 @@
+module Jira
+  module Worklog
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: jira-worklog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Petr Cervinka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.3
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: simple_xlsx_reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: 
+email:
+- petr@petrcervinka.cz
+executables:
+- jira-worklog
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example.xlsx
+- exe/jira-worklog
+- jira-worklog.gemspec
+- lib/jira/worklog.rb
+- lib/jira/worklog/api_client.rb
+- lib/jira/worklog/cli.rb
+- lib/jira/worklog/version.rb
+homepage: https://github.com/cervinka/jira-worklog
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Allow add JIRA worklog (hours worked) from excel (.xlsx) file via JIRA REST
+  API
+test_files: []