jirasync 0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.iml

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 programmiersportgruppe
+
+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,2 @@
+# jira-sync
+A utility to synchronise jira projects to the local file system

data/Rakefile

@@ -0,0 +1,5 @@
+task :default => :build
+
+task :build do
+    system "gem build jirasync.gemspec"
+end

data/bin/jira-sync

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'io/console'
+require 'trollop'
+
+
+require 'jirasync'
+
+
+def prompt_for_password
+    print("Please enter password: ")
+    pw = STDIN.noecho(&:gets).chomp
+    puts
+    pw
+end
+
+opts = Trollop::options do
+    banner <<-EOS
+Utility to sync a jira project to the local file system.
+
+Usage:
+       jira-sync [options] [command]
+where command is one of the following
+
+  fetch-all: fetches all tickets from the given project
+     update: fetches all tickets that have been updated/
+             added since the last run
+
+where [options] are:
+EOS
+    opt :baseurl, "Jira base url", :type => :string
+    opt :project, "Project key", :type => :string
+    opt :user, "User, defaults to the current system user", :type => :string
+    opt :password, "Password, if not specified there, will be an interactive prompt", :type => :string
+    opt :target, "Target directory, defaults to the project key", :type => :string
+end
+
+Trollop::die :baseurl, "must be speficied" if !opts[:baseurl]
+Trollop::die :project, "must be speficied" if !opts[:project]
+
+
+user = opts[:user] || ENV['USER']
+pw = opts[:password] || prompt_for_password
+target = opts[:target] || opts[:project].chomp
+
+command = ARGV[0]
+
+if !["fetch", "update"].include?(command)
+    STDERR.puts("'#{command}' is not a valid command")
+    exit 1
+end
+
+client = JiraSync::JiraClient.new(opts[:baseurl], user, pw)
+repo = JiraSync::LocalIssueRepository.new(target)
+syncer = JiraSync::Syncer.new(client, repo, opts[:project].chomp)
+
+if command == "fetch"
+    syncer.fetch_all
+end
+
+if command == "update"
+    syncer.update
+end

data/jira-sync.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jira-sync/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "jira-sync"
+  gem.version       = Jira::Sync::VERSION
+  gem.authors       = ["Felix Leipold"]
+  gem.email         = ["felix.leipold@gmail.com"]
+  gem.description   = %q{TODO: Write a gem description}
+  gem.summary       = %q{TODO: Write a gem summary}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/jirasync.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name         = 'jirasync'
+  s.summary      = 'jirasync synchronises jira projects to the local file system'
+  s.description  = 'jirasync synchronises tickets from a jira project to the local
+                    file system. It supports a complete fetch operation as well as
+                    an incremental update.
+
+                    Each ticket is stored in a simple, pretty printed JSON file.'
+  s.version      = '0.2'
+  s.platform     = Gem::Platform::RUBY
+
+  s.files        = ['bin/jira-sync']
+
+  s.bindir = 'bin'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.author      = 'Felix Leipold'
+  s.email       = ''
+  s.homepage    = 'https://github.com/programmiersportgruppe/jira-sync'
+
+
+  s.add_dependency('trollop')
+  s.add_dependency('httparty')
+  s.add_dependency('parallel')
+end

data/lib/jirasync.rb

@@ -0,0 +1,9 @@
+require 'jirasync/jira_client'
+require 'jirasync/local_repository'
+require 'jirasync/syncer'
+require 'jirasync/version'
+
+module JiraSync
+
+end
+

data/lib/jirasync/jira_client.rb

@@ -0,0 +1,67 @@
+module JiraSync
+
+    require 'httparty'
+    require 'uri'
+    require 'json'
+
+
+    class JiraClient
+
+        def initialize(baseurl, username, password)
+            @username = username
+            @password = password
+            @baseurl = baseurl
+        end
+
+        def get(jira_id)
+            url = "#{@baseurl}/rest/api/latest/issue/#{jira_id}"
+            auth = {:username => @username, :password => @password}
+            response = HTTParty.get url, {:basic_auth => auth}
+            if response.code == 200
+                response.parsed_response
+            else
+                raise "no issue found for #{jira_id}. response code was #{response.code}, url was #{url}"
+            end
+        end
+
+        def latest_issue_for_project(project_id)
+            url = "#{@baseurl}/rest/api/2/search?"
+            auth = {:username => @username, :password => @password}
+
+            response = HTTParty.get url, {:basic_auth => auth, :query => {:jql => 'project="' + project_id + '" order by created', fields: 'summary,updated', maxResults: '1'}}
+            if response.code == 200
+                response.parsed_response
+            else
+                raise "no issue found for #{project_id}. response code was #{response.code}, url was #{url}"
+            end
+        end
+
+        def changed_since(project_id, date)
+            url = "#{@baseurl}/rest/api/2/search?"
+            auth = {:username => @username, :password => @password}
+            jql = 'project = "' + project_id + '" AND updated > ' + (date.to_time.to_i * 1000).to_s
+            # "' + date.to_s + '"'
+            response = HTTParty.get url, {:basic_auth => auth, :query => {:jql => jql, fields: 'summary,updated', maxResults: '1000'}}
+            if response.code == 200
+                response.parsed_response
+            else
+                raise "no issue found for #{project_id}. response code was #{response.code}, url was #{url}"
+            end
+        end
+
+        def project_info(project_id)
+            url = "#{@baseurl}/rest/api/2/project/#{project_id}"
+            auth = {:username => @username, :password => @password}
+            response = HTTParty.get url, {:basic_auth => auth, :query => {:jql => 'project="' + project_id + '"', fields: 'summary,updated', maxResults: '50'}}
+            if response.code == 200
+                response.parse_response
+            else
+                raise "no issue found for #{project_id}. response code was #{response.code}, url was #{url}"
+            end
+
+        end
+    end
+end
+
+
+

data/lib/jirasync/local_repository.rb

@@ -0,0 +1,39 @@
+module JiraSync
+    require 'fileutils'
+    require 'json'
+
+
+    class LocalIssueRepository
+
+        def initialize(path)
+            @path = path
+            FileUtils::mkdir_p @path
+        end
+
+        def save(issue)
+            json = JSON.pretty_generate(issue)
+            file_path = "#{@path}/#{issue['key']}.json"
+            File.write(file_path, json)
+
+            updateTime = DateTime.parse(issue['fields']['updated'])
+
+            File.utime(DateTime.now.to_time, updateTime.to_time, file_path)
+        end
+
+        def save_state(state)
+            json = JSON.pretty_generate(state)
+            file_path = "#{@path}/sync_state.json"
+            File.write(file_path, json)
+        end
+
+        def load_state()
+            file_path = "#{@path}/sync_state.json"
+            if (!File.exists?(file_path))
+                raise ("File '#{file_path}' with previous sync state could not be found\n" +
+                          "please run an initial fetch first")
+            end
+            s = IO.read(file_path)
+            JSON.parse(s)
+        end
+    end
+end

data/lib/jirasync/syncer.rb

@@ -0,0 +1,70 @@
+module JiraSync
+    require 'parallel'
+    require 'json'
+    require 'date'
+
+
+    class Syncer
+
+        def initialize(client, repo, project_key)
+            @client = client
+            @project_key = project_key
+            latest_issue = @client.latest_issue_for_project(@project_key)['issues'][0]
+            @latest_issue_key = latest_issue['key'].split("-")[1].to_i
+            @repo = repo
+        end
+
+
+        # Fetches a number of tickets in parallel
+        # prints progress information to stderr
+        # and returns a list of tickets that
+        # couldn't be fetched.
+        def fetch(keys)
+            keys_with_errors = []
+            Parallel.each_with_index(keys, :in_threads => 64) do |key, index|
+                STDERR.puts(key) if ((index % 100) == 0)
+                begin
+                    issue = @client.get(key)
+                    issue_project_key = issue['fields']['project']['key']
+                    if (issue_project_key == @project_key)
+                        @repo.save(issue)
+                    else
+                        STDERR.puts("Skipping ticket #{key} which has moved to #{issue_project_key}.")
+                    end
+                rescue => e
+                    STDERR.puts(e.to_s)
+                    keys_with_errors.push(key)
+                end
+            end
+            keys_with_errors.sort
+        end
+
+        def fetch_all
+            start_time = DateTime.now
+
+            keys = (1..@latest_issue_key).map { |key_number| @project_key + "-" + key_number.to_s }
+            keys_with_errors = fetch(keys)
+
+            @repo.save_state({"time" => start_time, "errors" => keys_with_errors})
+        end
+
+        def update()
+            state = @repo.load_state()
+            start_time = DateTime.now
+            since = DateTime.parse(state['time']).new_offset(0)
+            STDERR.puts("Fetching issues that have changes since #{since.to_s}")
+            issues = @client.changed_since(@project_key, since)['issues'].map { |issue| issue['key'] }
+            STDERR.puts("Updated Issues")
+            STDERR.puts(issues.join(", "))
+            STDERR.puts("Issues with earlier errors")
+            STDERR.puts(state['errors'].join(", "))
+            keys_with_errors = fetch(issues + state['errors'])
+            @repo.save_state({"time" => start_time, "errors" => keys_with_errors})
+        end
+
+        def dump()
+            puts(@latest_issue_key)
+
+        end
+    end
+end

data/lib/jirasync/version.rb

@@ -0,0 +1,3 @@
+module JiraSync
+    VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: jirasync
+version: !ruby/object:Gem::Version
+  version: '0.2'
+  prerelease: 
+platform: ruby
+authors:
+- Felix Leipold
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "jirasync synchronises tickets from a jira project to the local\n                    file
+  system. It supports a complete fetch operation as well as\n                    an
+  incremental update.\n\n                    Each ticket is stored in a simple, pretty
+  printed JSON file."
+email: ''
+executables:
+- jira-sync
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/jira-sync
+- jira-sync.gemspec
+- jirasync.gemspec
+- lib/jirasync.rb
+- lib/jirasync/jira_client.rb
+- lib/jirasync/local_repository.rb
+- lib/jirasync/syncer.rb
+- lib/jirasync/version.rb
+homepage: https://github.com/programmiersportgruppe/jira-sync
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: jirasync synchronises jira projects to the local file system
+test_files: []