jira_cli 0.1.1

data/jira_cli.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jira_cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jira_cli'
+  spec.version       = JiraCli::VERSION
+  spec.authors       = ['Sean Huber']
+  spec.email         = ['seanhuber@seanhuber.com']
+
+  spec.summary       = 'A ruby wrapper for JIRA Command Line Interface [Bob Swift Atlassian Add-on]'
+  spec.homepage      = 'https://github.com/seanhuber/jira_cli'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 5.1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'awesome_print'
+end

data/lib/jira_cli.rb

@@ -0,0 +1,13 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/inflector'
+
+require 'csv'
+require 'open3'
+
+require 'jira_cli/version'
+require 'jira_cli/wrapper'
+require 'jira_cli/output_error'
+
+module JiraCli
+end

data/lib/jira_cli/output_error.rb

@@ -0,0 +1,10 @@
+module JiraCli
+  class OutputError < StandardError
+    attr_reader :actual_output
+
+    def initialize msg, actual_output
+      @actual_output = actual_output
+      super msg
+    end
+  end
+end

data/lib/jira_cli/version.rb

@@ -0,0 +1,3 @@
+module JiraCli
+  VERSION = "0.1.1"
+end

data/lib/jira_cli/wrapper.rb

@@ -0,0 +1,87 @@
+module JiraCli
+  class Wrapper
+    include Singleton
+
+    ALL_METHODS = [:add_attachment, :add_attachments, :add_comment, :add_component, :add_custom_field, :add_group, :add_labels, :add_project_category, :add_project_role, :add_project_role_actors, :add_remote_link, :add_transition, :add_transition_function, :add_user, :add_user_to_group, :add_user_to_group_with_file, :add_user_with_file, :add_version, :add_vote, :add_watchers, :add_work, :archive_version, :assign_issue, :associate_workflow, :clone_issue, :clone_issues, :clone_project, :copy_attachments, :copy_component, :copy_components, :copy_field_value, :copy_project_role_actors, :copy_version, :copy_versions, :copy_workflow, :create_board, :create_filter, :create_issue, :create_or_update_issue, :create_project, :create_workflow_scheme, :delete_board, :delete_component, :delete_field_configuration, :delete_field_configuration_scheme, :delete_filter, :delete_issue, :delete_issue_security_scheme, :delete_issue_type_scheme, :delete_issue_type_screen_scheme, :delete_link, :delete_notification_scheme, :delete_permission_scheme, :delete_project, :delete_screen, :delete_screen_scheme, :delete_version, :delete_workflow, :delete_workflow_scheme, :export_data, :export_site, :export_workflow, :get_application_link_list, :get_attachment, :get_attachment_list, :get_available_steps, :get_board_list, :get_client_info, :get_comment, :get_comment_list, :get_comments, :get_component, :get_component_list, :get_custom_field_list, :get_field_configuration_list, :get_field_configuration_scheme_list, :get_field_list, :get_field_value, :get_filter, :get_filter_list, :get_group_list, :get_issue, :get_issue_history_list, :get_issue_list, :get_issue_security_scheme_list, :get_issue_type_list, :get_issue_type_scheme_list, :get_issue_type_screen_scheme_list, :get_link_list, :get_link_type_list, :get_login_info, :get_notification_scheme_list, :get_permission_scheme_list, :get_project, :get_project_category, :get_project_category_list, :get_project_list, :get_project_role_actor_list, :get_project_role_by_user_list, :get_project_role_list, :get_remote_link_list, :get_screen_list, :get_screen_scheme_list, :get_security_level_list, :get_server_info, :get_status_list, :get_transition_list, :get_user, :get_user_list, :get_version, :get_version_list, :get_voter_list, :get_watcher_list, :get_workflow, :get_workflow_list, :get_workflow_scheme, :get_workflow_scheme_list, :get_work_list, :import, :import_workflow, :link_issue, :login, :logout, :modify_field_value, :progress_issue, :release_version, :remove_attachment, :remove_comment, :remove_custom_field, :remove_group, :remove_labels, :remove_project_category, :remove_project_role, :remove_project_role_actors, :remove_remote_link, :remove_user, :remove_user_from_group, :remove_user_from_group_with_file, :remove_user_property, :remove_user_with_file, :remove_vote, :remove_watchers, :remove_work, :render_request, :restore_export, :run, :run_from_attachment_list, :run_from_comment_list, :run_from_component_list, :run_from_csv, :run_from_field_configuration_list, :run_from_field_configuration_scheme_list, :run_from_group_list, :run_from_issue_list, :run_from_issue_security_scheme_list, :run_from_issue_type_scheme_list, :run_from_issue_type_screen_scheme_list, :run_from_link_list, :run_from_list, :run_from_notification_scheme_list, :run_from_permission_scheme_list, :run_from_project_category_list, :run_from_project_list, :run_from_remote_link_list, :run_from_screen_list, :run_from_screen_scheme_list, :run_from_sql, :run_from_user_list, :run_from_version_list, :run_from_workflow_list, :run_from_workflow_scheme_list, :set_field_value, :set_share_scope, :transition_issue, :unarchive_version, :unrelease_version, :update_comment, :update_component, :update_filter, :update_issue, :update_project, :update_project_category, :update_project_role, :update_user, :update_user_property, :update_version, :update_work, :validate_license]
+
+    # TESTED_METHODS = [
+    #   :add_attachment, :add_comment, :create_issue, :create_project, :delete_issue, :delete_issue_type_scheme, :delete_issue_type_screen_scheme, :delete_project, :delete_screen, :delete_screen_scheme, :delete_version, :delete_workflow, :delete_workflow_scheme, :get_server_info, :release_version, :remove_attachment, :remove_comment, :transition_issue
+    # ]
+
+    def initialize
+      ALL_METHODS.each do |s_method|
+      # TESTED_METHODS.each do |s_method|
+        define_singleton_method s_method, -> **jira_args {jira_cmd s_method.to_s.camelize(:lower), **jira_args}
+      end
+    end
+
+    def override_csv_methods
+      {
+        get_attachment_list:               {label: 'attachments',               id_col: :id},
+        get_comment_list:                  {label: 'comments',                  id_col: :id},
+        get_issue_list:                    {label: 'issues',                    id_col: :id},
+        get_issue_type_screen_scheme_list: {label: 'issue type screen schemes', id_col: :id},
+        get_issue_type_scheme_list:        {label: 'issue type schemes',        id_col: :id},
+        get_screen_list:                   {label: 'screens',                   id_col: :id},
+        get_screen_scheme_list:            {label: 'screen schemes',            id_col: :id},
+        get_version_list:                  {label: 'versions',                  id_col: :id},
+        get_workflow_list:                 {label: 'workflows',                 id_col: :name},
+        get_workflow_scheme_list:          {label: 'workflow schemes',          id_col: :id}
+      }.each do |s_method, csv_args|
+        define_singleton_method s_method, -> **jira_args {get_csv_list **{cmd: s_method.to_s.camelize(:lower)}.merge(**jira_args, **csv_args)}
+      end
+    end
+
+    # TODO: this is being overriden in the constructor
+    # def add_version project:, name:, **jira_args
+    #   formatted_args = jira_args.map do |k, v|
+    #     v = v.strftime('%-m/%d/%y') if [:start_date, :date].include?(k)
+    #     [k, v]
+    #   end.to_h
+    #   jira_cmd 'addVersion', project: project, name: name, **formatted_args
+    # end
+
+    private
+
+    def check_first_line output, regex
+      raise OutputError.new("Expected response to begin with \"#{regex}\"", output) unless output =~ Regexp.new(regex)
+    end
+
+    def get_csv_list cmd:, label:, id_col:, **jira_args
+      output = jira_cmd cmd, **jira_args
+      check_first_line output, '^\d* '+label
+      return {} unless output.index("\n")
+      output = output[output.index("\n")+1..-1] # removing first line of output
+      arr = parse_csv output
+      arr.map{|h| [h[id_col], h.except(id_col)]}.to_h
+    end
+
+    def parse_csv str
+      CSV.parse(str, headers: true).map do |row|
+        row.map do |k,v|
+          if v.blank?
+            nil
+          else
+            [k.gsub(/\s/,'').underscore.to_sym, v =~ /\A\d+\z/ ? v.to_i : v]
+          end
+        end.compact.to_h
+      end
+    end
+
+    def jira_cmd action, **jira_args
+      cmd_args = {action: action}.merge(jira_args).map do |k,v|
+        cmd = "--#{k.to_s.camelize(:lower)}"
+        unless v.is_a? TrueClass
+          cmd += v.to_s.include?('"') && !v.to_s.include?('""') ? " '#{v}'" : " \"#{v}\""
+        end
+        cmd
+      end.join(' ')
+
+      stdout, stderr, status = Open3.capture3 "jira #{cmd_args}"
+      # ap "jira #{cmd_args}"
+      # puts stdout
+      raise stderr.strip if stderr != ''
+      stdout.strip
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: jira_cli
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sean Huber
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- seanhuber@seanhuber.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- build_examples.rb
+- debug.rb
+- examples.yml
+- jira_cli.gemspec
+- lib/jira_cli.rb
+- lib/jira_cli/output_error.rb
+- lib/jira_cli/version.rb
+- lib/jira_cli/wrapper.rb
+homepage: https://github.com/seanhuber/jira_cli
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for JIRA Command Line Interface [Bob Swift Atlassian Add-on]
+test_files: []