jira-script 1.0.0

data/lib/jira-script.rb

@@ -0,0 +1,95 @@
+require 'jira-script/request'
+require 'jira-script/request_exception'
+
+module Jira
+
+# Jira class wrapper that basically runs the script
+class Dispatcher
+  attr_accessor :config, :request_queue
+
+  def initialize
+    self.config = {
+        api_path: 'rest/api/2',
+        default_issue_type: 'Story',
+        default_subtask_type: 'Technical task',
+        verbosity: 1
+    }
+  end
+
+  # config related methods
+  def user(u)
+    config[:user] = u
+  end
+
+  def password(p)
+    config[:password] = p
+  end
+
+  def host(h)
+    config[:host] = h
+  end
+
+  def api_path(api)
+    config[:api_path] = api
+  end
+
+  def project(p)
+    config[:project] = p
+  end
+
+  def quite(on)
+    self.config[:verbosity] = 0 if on
+  end
+
+  def verbosity(v)
+    self.config[:verbosity] = v
+  end
+
+  # build request config
+  def _get_request_config(res, type)
+    {
+        user: config[:user],
+        password: config[:password],
+        host: config[:host],
+        api_path: config[:api_path],
+        project: config[:project],
+        http_request_type: type,
+        resource: res,
+        default_issue_type: config[:default_issue_type],
+        default_subtask_type: config[:default_subtask_type],
+        verbosity: config[:verbosity]
+    }
+  end
+
+  # update command
+  def update(key, &block)
+    raise RequestException, "No update definition provided for issue #{key}" unless block_given?
+    request_config = _get_request_config('issue/' + key, :put)
+    request = Request.new(:update, request_config)
+    request.key = key
+    request.instance_eval(&block)
+    request.run
+  end
+
+  def create(summary, &block)
+    # create new request
+    request_config = _get_request_config('issue', :post)
+    request = Request.new(:create, request_config)
+    request.summary summary
+    request.project config[:project]
+
+    request.instance_eval(&block) if block_given?
+
+    # run request
+    request.run
+  end
+end
+
+def self.run(&block)
+  Dispatcher.new.instance_eval(&block)
+rescue RequestException => e
+  p "ERROR: #{e.message}"
+  puts e.backtrace
+end
+
+end

data/lib/jira-script/request.rb

@@ -0,0 +1,201 @@
+require 'json'
+require 'typhoeus'
+require 'jira-script/request_exception'
+
+module Jira
+
+# Generic Jira request
+class Request
+  # request config - host, api resource, etc
+  attr_accessor :config
+
+  # request data to send to server
+  attr_accessor :json_data
+
+  # request fields that were set
+  attr_accessor :fields
+
+  # mapping between our dsl keywords and Jira's json fields
+  attr_accessor :data_map
+
+  # request parent - used when creating subtasks
+  attr_accessor :request_parent
+
+  # request response
+  attr_accessor :response
+
+  # request children
+  attr_accessor :children
+
+  # request type (create, update)
+  attr_accessor :request_type
+
+  # issue key
+  attr_accessor :key
+
+  def initialize(type, config = {})
+    self.request_type = type
+    self.config = config
+    self.fields = {}
+    self.request_parent = nil
+    self.json_data = {}
+    self.children = []
+    self.key = nil
+    init_data_map
+  end
+
+  def init_data_map
+    self.data_map = {
+        project: 'fields/project/key',
+        parent: 'fields/parent/key',
+        summary: 'fields/summary',
+        description: 'fields/description',
+        type: 'fields/issuetype/name',
+        assignee: 'fields/assignee/name',
+        estimate: 'fields/timetracking/originalEstimate',
+        remaining: 'fields/timetracking/remainingEstimate',
+        components: 'fields/components',
+        labels: 'fields/labels'
+    }
+  end
+
+  def to_json
+    JSON.generate(json_data)
+  end
+
+  def to_s
+    json_data
+  end
+
+  def _set_default_type
+    # set default type if empty
+    return if fields.key?(:type)
+    if fields.key?(:parent)
+      type config[:default_subtask_type]
+    else
+      type config[:default_issue_type]
+    end
+  end
+
+  def _set_xpath(h, xpath, value)
+    len = xpath.length
+    pos = xpath.index('/')
+    if pos.nil?
+      h[xpath.to_sym] = value
+    else
+      key = xpath[0..pos - 1].to_sym
+      h[key] = h[key] || {}
+      _set_xpath(h[key], xpath[pos + 1..len], value)
+    end
+    h
+  end
+
+  def _set_field(name, val)
+    raise RequestException, "Invalid request parameter #{name}" unless data_map.key?(name)
+    fields[name] = val
+    _set_xpath(json_data, data_map[name], val)
+  end
+
+  def _error(msg)
+    if request_type == :create
+      raise RequestException, "Error trying to create ticket #{fields[:summary]}: #{msg}"
+    elsif request_type == :update
+      raise RequestException, "Error trying to update ticket #{key}: #{msg}"
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    data_map.key?(method_name) || super
+  end
+
+  def method_missing(name, *args, &block)
+    if data_map.key?(name)
+      _set_field(name, args[0])
+    else
+      super
+    end
+  end
+
+  def run
+    ret = nil
+    _set_default_type
+    url = [config[:host], config[:api_path], config[:resource]].join('/')
+    json_str = to_json
+    p "Sending json #{json_str}" if config[:verbosity] >= 2
+
+    req = Typhoeus::Request.new(
+        url,
+        ssl_verifypeer: false,
+        method: config[:http_request_type],
+        userpwd: "#{config[:user]}:#{config[:password]}",
+        body: json_str,
+        headers: { 'Content-Type' => 'application/json' }
+    )
+    req.on_complete do |response|
+      if response.success?
+        self.response = JSON.parse(response.body, symbolize_names: true)
+        ret = self.response[:key]
+        self.key = ret if request_type == :create
+
+        if config[:verbosity] >= 1
+          if fields[:parent].nil?
+            prefix = 'Issue'
+          else
+            prefix = '  - sub-task'
+          end
+          p "#{prefix} #{key} updated successfully" if request_type == :update
+          p "#{prefix} #{key}: '#{fields[:summary]}' created successfully" if request_type == :create
+        end
+
+        unless children.empty?
+          children.each do |child|
+            child.parent key
+            child.run
+          end
+        end
+      elsif response.timed_out?
+        _error('timeout')
+      elsif response.code.zero?
+        # Could not get an http response, something's wrong.
+        _error(response.return_message)
+      else
+        # Received a non-successful http response.
+        _error('HTTP request failed: ' + response.code.to_s + ' / message: ' + response.body)
+      end
+    end
+
+    req.run
+
+    ret
+  end
+
+  def create(summary, &block)
+    subtask(summary, &block)
+  end
+
+  def subtask(summary, &block)
+    raise RequestException, "Sub-task '#{fields[:summary]}' cannot have other sub-tasks" unless request_parent.nil?
+    request = Request.new(:create, config)
+    request.config[:http_request_type] = :post
+    request.request_parent = self
+    children.push request
+    request.summary summary
+    request.project fields[:project]
+    request.instance_eval(&block) if block_given?
+  end
+
+  def components(*args)
+    vals = []
+    args.each do |arg|
+      vals.push name: arg
+    end
+
+    _set_field(:components, vals)
+  end
+
+  def labels(*args)
+    _set_field(:labels, [*args])
+  end
+end
+
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: jira-script
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Florin Mihalache
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-28 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby DSL script implementation to automate creating and updating many
+  Jira issues at once.
+email: florin.mihalache@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jira-script.rb
+- lib/jira-script/request.rb
+homepage: http://github.com/mflorin/jira-script
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: Jira DSL
+test_files: []