jirasync 0.4.5 → 0.4.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a03445145f26a7d70ba8b1d604823a9a26d21d00b781453587f77f9dc76fe97d
+  data.tar.gz: 5592ecc86a2814a39b8d11cac69f1e11a593d401a59e11239a3a88dab44141f1
+SHA512:
+  metadata.gz: 0a320e45f7fde0470f70bf2a904446f0761305480d0a0905fc76f51b049cdf20fa5599ff47d4b415640e358cd9e90d2a460c270dbeec27ef52739b53b868b207
+  data.tar.gz: 5ce8f2dd1a3df4cd2c4df655e7e5bbd7bce44ea0a86a2c71eddf2f7412330e2629bdee0d3134e890fa0d832cf8b14f09ca3213690bbf367bb6331342290769fe

data/README.md

@@ -1,12 +1,9 @@
-# jira-sync
-
-A suite of utilities to synchronise JIRA projects to the local file system
+[![Gem Version](https://badge.fury.io/rb/jirasync.svg)](http://badge.fury.io/rb/jirasync)
 
 ## Installation
 
     gem install jirasync
 
-
 ## Usage
 
 ### Initial Fetch
@@ -152,6 +149,11 @@ jira-format-issues \
 
 ~~~
 
+## Using Cookie-Authentication
+
+If a single-sign-on solution is used, `jira-sync` can also use the session
+cookie to authenticate requests to jira.
+
 ## Motivation
 
 Having a local, unix-friendly copy of all tickets to avoid JIRA performance issues and

data/bin/jira-sync

@@ -21,7 +21,7 @@ Usage:
        jira-sync [options] [command]
 where command is one of the following
 
-  fetch-all: fetches all tickets from the given project
+      fetch: fetches all tickets from the given project
      update: fetches all tickets that have been updated/
              added since the last run
 
@@ -31,6 +31,7 @@ EOS
     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 :cookie, "Session cookie, to use cookie-based authentication instead of username & password (e.g. 'JSESSIONID=ABC123')", :type => :string
     opt :target, "Target directory, defaults to the project key", :type => :string
     opt :store_attachments, "Fetch and store attachments"
 end
@@ -39,8 +40,14 @@ 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
+authentication = begin
+    cookie = opts[:cookie]
+    if cookie then
+        JiraSync::CookieAuthentication.new(cookie)
+    else
+        JiraSync::UsernamePasswordAuthentication.new(opts[:user] || ENV['USER'], opts[:password] || prompt_for_password)
+    end
+end
 target = opts[:target] || opts[:project].chomp
 project = opts[:project]
 store_attachments = opts[:store_attachments]
@@ -52,7 +59,7 @@ if !["fetch", "update"].include?(command)
     exit 1
 end
 
-client = JiraSync::JiraClient.new(opts[:baseurl], user, pw)
+client = JiraSync::JiraClient.new(opts[:baseurl], authentication)
 repo = JiraSync::LocalIssueRepository.new(target)
 syncer = JiraSync::Syncer.new(client, repo, project, store_attachments)
 
@@ -61,7 +68,7 @@ if command == "fetch"
         update_statement=<<-END
 jira-sync \
     --baseurl #{opts[:baseurl]} \\
-    --user #{user} \\
+    #{ if authentication.cookie then "--cookie #{cookie}" else "--user #{user}" end} \\
     --project #{project} \\
     --target #{target} \\
     --store-attachments \\
@@ -83,7 +90,7 @@ if command == "update"
         fetch_statement=<<-END
 jira-sync \
     --baseurl #{opts[:baseurl]} \\
-    --user #{user} \\
+    #{ if authentication.cookie then "--cookie #{cookie}" else "--user #{user}" end} \\
     --project #{project} \\
     --target #{target} \\
     --store-attachments \\
@@ -99,4 +106,4 @@ Try to use a statement along the following lines
     end
 
     syncer.update
-end
+end

data/lib/jirasync/jira_client.rb

@@ -20,11 +20,48 @@ module JiraSync
     end
 
 
-    class JiraClient
+    class JiraAuthentication
+        attr_reader :options
+
+        def initialize(options)
+            @options = options
+        end
+    end
+
 
-        def initialize(baseurl, username, password)
+    class UsernamePasswordAuthentication < JiraAuthentication
+        attr_reader :username
+
+        def initialize(username, password)
+            super({
+                :basic_auth => {
+                    :username => username,
+                    :password => password,
+                },
+            })
             @username = username
-            @password = password
+        end
+    end
+
+
+    class CookieAuthentication < JiraAuthentication
+        attr_reader :cookie
+
+        def initialize(cookie)
+            super({
+                :headers => {
+                    "Cookie" => cookie,
+                },
+            })
+            @cookie = cookie
+        end
+    end
+
+
+    class JiraClient
+
+        def initialize(baseurl, authentication)
+            @authentication = authentication
             @baseurl = baseurl
             @timeout = 15
             @first_requets_timeout = 60
@@ -34,8 +71,7 @@ module JiraSync
 
         def get(jira_id)
             url = "#{@baseurl}/rest/api/latest/issue/#{jira_id}"
-            auth = {:username => @username, :password => @password}
-            response = HTTParty.get url, {:basic_auth => auth, :timeout => @timeout}
+            response = HTTParty.get url, @authentication.options.merge({:timeout => @timeout})
             if response.code == 200
                 response.parsed_response
             else
@@ -46,8 +82,7 @@ module JiraSync
         def attachments_for_issue(issue)
             attachments = []
             Parallel.map(issue['fields']['attachment'], :in_threads => 64) do |attachment|
-                auth = {:username => @username, :password => @password}
-                response = HTTParty.get attachment['content'], {:basic_auth => auth, :timeout => @timeout}
+                response = HTTParty.get attachment['content'], @authentication.options.merge({:timeout => @timeout})
                 if response.code == 200
                     attachments.push({:data => response.body, :attachment => attachment, :issue => issue})
                 else
@@ -60,13 +95,11 @@ module JiraSync
 
         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,
+            response = HTTParty.get url, @authentication.options.merge({
                 :query => {:jql => 'project="' + project_id + '" order by created', fields: 'summary,updated', maxResults: '1'},
                 :timeout => @first_requets_timeout
-            }
+            })
             if response.code == 200
                 response.parsed_response
             else
@@ -76,14 +109,12 @@ module JiraSync
 
         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,
+            response = HTTParty.get url, @authentication.options.merge({
                 :query => {:jql => jql, fields: 'summary,updated', maxResults: '1000'},
                 :timeout => @timeout
-            }
+            })
             if response.code == 200
                 response.parsed_response
             else
@@ -93,12 +124,10 @@ module JiraSync
 
         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,
+            response = HTTParty.get url, @authentication.options.merge({
                 :query => {:jql => 'project="' + project_id + '"', fields: 'summary,updated', maxResults: '50'},
                 :timeout => @timeout
-            }
+            })
             if response.code == 200
                 response.parse_response
             else

data/lib/jirasync/version.rb

@@ -1,3 +1,3 @@
 module JiraSync
-    VERSION = "0.4.5"
+    VERSION = "0.4.6"
 end

metadata

@@ -1,84 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: jirasync
 version: !ruby/object:Gem::Version
-  version: 0.4.5
-  prerelease: 
+  version: 0.4.6
 platform: ruby
 authors:
 - Felix Leipold
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2019-03-06 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'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   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."
+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.
 email: ''
 executables:
 - jira-format-issues
@@ -86,7 +79,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -101,26 +94,25 @@ files:
 - lib/jirasync/version.rb
 homepage: https://github.com/programmiersportgruppe/jira-sync
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.7.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: jirasync synchronises jira projects to the local file system
 test_files: []