jira_report 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da9f8a10bf34661f77ed0fda245da2fff4f45b09
+  data.tar.gz: 37c232eede2357b98fb47baea9cdce4b66ce6bab
+SHA512:
+  metadata.gz: c1045da422a6ab29b42f09f924745c117dd533e53ed9666391c25b753ab3b19b3a168ff8993519c049748582985b8b22a956b85f7f05ca41bb73fa8d654dcfc4
+  data.tar.gz: 0391e1b3a2fc1aa71d923b36180e9ef706b58fbdae9eebbebd9f91dcbcbf44308f40d89adfd5477b0759fcc16d61d86f399f7ebd9cff6ff80599d8deda9b7486

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Vitalii Elenhaupt
+
+MIT License
+
+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,56 @@
+jira_report
+===========================
+
+Queries user activities for specified period of time and prints it to console.
+
+##Installation
+```
+$gem install jira_report
+```
+
+##Usage
+```sh
+$jira-report -h
+Usage: jira-report [options]
+    -u, --username username          Username to query activity report.
+    -c, --config config              Path to config file. USER_HOME/.jira-report is default.
+```
+
+```
+$jira-report -u admin
+Querying jira...
+Jira activity report for [admin]:
+
+Created: 2
+  WFM-7180 - Provide static context for log property in BasicHashAnalyzer 
+  TST-5862 - Unable to install Nginx on HP-UX with Java 6
+
+Resolved: 8
+  GSM-364 - Migration of existing scenario
+  WFM-5865 - NullPointerException while finding categories
+  TST-5864 - Some NGinx installation improvements
+  TST-5863 - NGinx minimal dependency
+  SDK-7139 - Move common interfaces and classes from into individual jar
+  SDK-7138 - Move common interfaces and classes from into individual dll
+  TST-7111 - Event.getDonotNotify doesn't indicate about agent's state
+  TST-6985 - TST classes should have static Log fields
+
+Reopened: 0
+
+Closed: 5
+  TST-6943 - Remove redundant org.apache.log4j dependcy from common part
+  TST-5862 - Unable to install NGinx on HP-UX with Java 6
+  TST-5857 - Put back support for Jdk 1.6
+  TST-5840 - NGinx fails to handle interaction initiated
+  GSM-364 -  Migration of existing units
+```
+
+##Configuration
+Default path to configuration file is `~/.jira-report`. All settings are optional and may be read from user input. See [sample](examples/jira-report.sample).
+
+Period is set by two options `period_from` and `period_till`. Both options support [advanced jira searching](https://confluence.atlassian.com/display/JIRA/Advanced+Searching) and accept dates, jira functions, aliasing. For example:
+
+```
+period_from=-3w
+period_till=now()
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/jira-report

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'jira_report'
+
+parameters = JiraReport::Cli.new
+settings = JiraReport::Settings.new(parameters.ini)
+JiraReport::JiraReport.new(settings, parameters.username).report

data/examples/jira-report.sample

@@ -0,0 +1,6 @@
+url=jira.company.com
+username=jira_username
+password=s3cr3t
+
+period_from=-1w
+period_till=now()

data/jira_report.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jira_report/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jira_report'
+  spec.version       = JiraReport::VERSION
+  spec.authors       = ['Vitalii Elenhaupt']
+  spec.email         = ['velenhaupt@gmail.com']
+  spec.summary       = %q{Jira activity report generator.}
+  spec.description   = %q{Generates a productivity report base on activities in jira.}
+  spec.homepage      = 'https://github.com/veelenga/jira_report.git'
+  spec.license       = 'MIT'
+
+  spec.files         = `"C:/Program Files (x86)/Git/bin/git.exe" ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'inifile', '~> 3.0'
+  spec.add_runtime_dependency 'rest-client', '~> 1.7'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/jira_report/cli.rb

@@ -0,0 +1,31 @@
+require 'optparse'
+
+module JiraReport
+  # Prepares command line parameters using OptionParser
+  class Cli
+    attr_reader :username, :ini
+
+    def initialize
+      options = parse
+      @username = options[:username]
+      @ini = options[:ini] ? options[:ini] : "~/.jira-report"
+    end
+
+    private
+
+    def parse
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: jira-report [options]'
+        opts.on('-u', '--username username', 'Username to query activity report.') do |u|
+          options[:username] = u
+        end
+        opts.on('-c', '--config config', 'Path to config file. ' \
+                'USER_HOME/.jira-report is default.') do |s|
+          options[:ini] = s
+        end
+      end.parse!
+      options
+    end
+  end
+end

data/lib/jira_report/settings.rb

@@ -0,0 +1,48 @@
+require 'inifile'
+require 'io/console'
+
+# Initializes JiraReport settings.
+module JiraReport
+  class Settings
+    attr_reader :username, :password, :url,\
+      :period_from, :period_till
+
+    def initialize(path)
+      read(path)
+    end
+
+    private
+
+    def read(path)
+      loaded = IniFile.load(File.expand_path(path))
+
+      global = loaded[:global] if loaded
+      global ||= {}
+
+      @url = global['url']
+      @username = global['username']
+      @password = global['password']
+      @period_from = global['period_from']
+      @period_till = global['period_till']
+
+      @url = ask('Jira url in [jira.company.com] format: ') unless @url
+      @username = ask('Jira username: ') unless @username
+      @password = ask('Jira password: '){
+        STDIN.noecho(&:gets).chomp!
+      } unless @password
+      @period_from = '-1w' unless @period_from
+      @period_till = 'now()' unless @period_till
+
+      # TODO: attributes verification
+    end
+
+    def ask(message, &block)
+      print message
+      if block
+        yield block
+      else
+        gets.chomp!
+      end
+    end
+  end
+end

data/lib/jira_report/version.rb

@@ -0,0 +1,3 @@
+module JiraReport
+  VERSION = "0.0.1"
+end

data/lib/jira_report.rb

@@ -0,0 +1,89 @@
+require 'rest_client'
+require 'json'
+require 'uri'
+
+require 'jira_report/settings'
+require 'jira_report/cli'
+
+module JiraReport
+  # Base class that generate jira activity report
+  class JiraReport
+    attr_accessor :from, :till, :username
+
+    def initialize(init_set, username)
+      @username = username ? username : init_set.username
+      @search_url = jira_search_url(init_set.url,
+                                    init_set.username,
+                                    init_set.password)
+
+      @from = init_set.period_from.gsub(/'/, '')
+      @till = init_set.period_till.gsub(/'/, '')
+    end
+
+    def report
+      puts "\nQuerying jira..."
+
+      created = query(jql_created)
+      resolved = query(jql_resolved)
+      reopened = query(jql_reopened)
+      closed = query(jql_closed)
+
+      puts "\nJira activity report for [#{@username}]:"
+
+      puts "\nCreated: #{created.length}"
+      print_issues(created)
+
+      puts "\nResolved: #{resolved.length}"
+      print_issues(resolved)
+
+      puts "\nReopened: #{reopened.length}"
+      print_issues(reopened)
+
+      puts "\nClosed: #{closed.length}"
+      print_issues(closed)
+    end
+
+    private
+
+    def jira_search_url(url, username, password)
+      "http://#{username}:#{password}@#{url}/rest/api/2/search?"
+    end
+
+    def jql_created
+      "jql=created>=#{@from} "  \
+        "AND created<=#{@till} "\
+        "AND reporter=#{@username}"
+    end
+
+    def jql_resolved
+      "jql=resolved>=#{@from} "  \
+        "AND resolved<=#{@till} "\
+        "AND 'First Resolution User'=#{@username}"
+    end
+
+    def jql_closed
+      "jql='First Closed Date'>=#{@from} "  \
+        "AND 'First Closed Date'<=#{@till} "\
+        "AND 'First Closed User'=#{@username}"
+    end
+
+    def jql_reopened
+      "jql='First Reopened Date'>=#{@from} "  \
+        "AND 'First Reopened Date'<=#{@till} "\
+        "AND 'First Reopened User'=#{@username}"
+    end
+
+    def query(jql)
+      response = RestClient.get(@search_url + URI.escape(jql))
+      fail "Query unsuccessful. Response code #{response.code}"\
+        unless response.code == 200
+      JSON.parse(response.body)['issues']
+    end
+
+    def print_issues(issues)
+      issues.each do |issue|
+        puts "  #{issue['key']} - #{issue['fields']['summary']}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: jira_report
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vitalii Elenhaupt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inifile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Generates a productivity report base on activities in jira.
+email:
+- velenhaupt@gmail.com
+executables:
+- jira-report
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/jira-report
+- examples/jira-report.sample
+- jira_report.gemspec
+- lib/jira_report.rb
+- lib/jira_report/cli.rb
+- lib/jira_report/settings.rb
+- lib/jira_report/version.rb
+homepage: https://github.com/veelenga/jira_report.git
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Jira activity report generator.
+test_files: []