jira-ruby 2.1.3

data/Rakefile

@@ -0,0 +1,31 @@
+require 'bundler/gem_tasks'
+
+require 'rubygems'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
+task default: [:test]
+
+task test: %i[prepare spec]
+
+desc 'Prepare and run rspec tests'
+task :prepare do
+  rsa_key = File.expand_path('rsakey.pem')
+  unless File.exist?(rsa_key)
+    raise 'rsakey.pem does not exist, tests will fail.  Run `rake jira:generate_public_cert` first'
+  end
+end
+
+desc 'Run RSpec tests'
+# RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'doc']
+end
+
+Rake::RDocTask.new(:doc) do |rd|
+  rd.main       = 'README.rdoc'
+  rd.rdoc_dir   = 'doc'
+  rd.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
+end

data/example.rb

@@ -0,0 +1,224 @@
+require 'pp'
+require './lib/jira-ruby'
+
+CONSUMER_KEY = 'test'
+SITE         = 'https://test.jira.com'
+
+options = {
+  :private_key_file => "rsakey.pem",
+  :context_path     => '',
+  :consumer_key     => CONSUMER_KEY,
+  :site             => SITE
+}
+
+client = JIRA::Client.new(options)
+
+if ARGV.length == 0
+  # If not passed any command line arguments, open a browser and prompt the
+  # user for the OAuth verifier.
+  request_token = client.request_token
+  puts "Opening #{request_token.authorize_url}"
+  system "open #{request_token.authorize_url}"
+
+  puts "Enter the oauth_verifier: "
+  oauth_verifier = gets.strip
+
+  access_token = client.init_access_token(:oauth_verifier => oauth_verifier)
+  puts "Access token: #{access_token.token} secret: #{access_token.secret}"
+elsif ARGV.length == 2
+  # Otherwise assume the arguments are a previous access token and secret.
+  access_token = client.set_access_token(ARGV[0], ARGV[1])
+else
+  # Script must be passed 0 or 2 arguments
+  raise "Usage: #{$0} [ token secret ]"
+end
+
+# Show all projects
+projects = client.Project.all
+
+projects.each do |project|
+  puts "Project -> key: #{project.key}, name: #{project.name}"
+end
+issue = client.Issue.find('SAMPLEPROJECT-1')
+pp issue
+
+# # Handling fields by name, rather than by id
+# # ------------------------------------------
+# Cache the Field list from the server
+client.Field.map_fields
+# This allows use of friendlier names for custom fields
+# Say that 'Special Field' is customfield_12345
+# It becomes mapped to Special_Field which is usable as a method call
+#
+# Say that there is a second 'Special Field' is customfield_54321
+# Names are deduplicated so the second 'Special Field' becomes Special_Field_54321
+#
+# Names are massaged to get rid of special characters, and spaces
+# So 'Special & @ Field' becomes Special_____Field - not perfect, but usable
+old_way = issue.customfield_12345
+new_way = issue.Special_Field
+(old_way == new_way) && puts 'much easier'
+#
+# You can also specify fields to be returned in the response
+# This is especially useful in regards to shortening JQL query response times if performance becomes an issue
+client.Issue.jql(a_normal_jql_search, fields:[:description, :summary, :Special_field, :created])
+# Or you could always do it the old way - if you can remember the custom field numbers...
+client.Issue.jql(a_normal_jql_search, fields:[:description, :summary, :customfield_1234, :created])
+# You can also specify the maximum number of results to be returned in the response, i.e. 500
+client.Issue.jql(a_normal_jql_search, max_results: 500)
+
+# # Find a specific project by key
+# # ------------------------------
+# project = client.Project.find('SAMPLEPROJECT')
+# pp project
+# project.issues.each do |issue|
+#   puts "#{issue.id} - #{issue.fields['summary']}"
+# end
+#
+# # List all Issues
+# # ---------------
+# client.Issue.all.each do |issue|
+#   puts "#{issue.id} - #{issue.fields['summary']}"
+# end
+#
+# # List issues by JQL query
+# # ------------------------
+# client.Issue.jql('PROJECT = "SAMPLEPROJECT"', [comments, summary]).each do |issue|
+#   puts "#{issue.id} - #{issue.fields['summary']}"
+# end
+#
+# # Delete an issue
+# # ---------------
+# issue = client.Issue.find('SAMPLEPROJECT-2')
+# if issue.delete
+#   puts "Delete of issue SAMPLEPROJECT-2 sucessful"
+# else
+#   puts "Delete of issue SAMPLEPROJECT-2 failed"
+# end
+#
+# # Create an issue
+# # ---------------
+# issue = client.Issue.build
+# labels = ['label1', 'label2']
+# issue.save({
+#   "fields" => {
+#     "summary"   => "blarg from in example.rb",
+#     "project"   => {"key" => "SAMPLEPROJECT"},
+#     "issuetype" => {"id" => "3"},
+#     "labels"    => labels,
+#     "priority"  => {"id" => "1"}
+#   }
+# })
+# issue.fetch
+# pp issue
+#
+# # Update an issue
+# # ---------------
+# issue = client.Issue.find("10002")
+# issue.save({"fields"=>{"summary"=>"EVEN MOOOOOOARRR NINJAAAA!"}})
+# pp issue
+#
+# # Transition an issue
+# # -------------------
+# issue_transition = issue.transitions.build
+# issue_transition.save!('transition' => {'id' => transition_id})
+#
+# # Change assignee
+# # -------------------
+# issue.save({'fields' => {'assignee' => {'name' => person_name}}})
+#
+# # Find a user
+# # -----------
+# user = client.User.find('admin')
+# pp user
+#
+# # Get all issue watchers
+# # ----------------------
+# issue = client.Issue.find("10002")
+# watchers = issue.watchers.all
+# watchers = client.Watcher.all(:issue => issue)
+# # Get all issue types
+# # -------------------
+# issuetypes = client.Issuetype.all
+# pp issuetypes
+#
+# # Get a single issue type
+# # -----------------------
+# issuetype = client.Issuetype.find('5')
+# pp issuetype
+#
+# #  Get all comments for an issue
+# #  -----------------------------
+# issue.comments.each do |comment|
+#   pp comment
+# end
+#
+# # Build and Save a comment
+# # ------------------------
+# comment = issue.comments.build
+# comment.save!(:body => "New comment from example script")
+#
+# # Delete a comment from the collection
+# # ------------------------------------
+# issue.comments.last.delete
+#
+# # Update an existing comment
+# # --------------------------
+# issue.comments.first.save({"body" => "an updated comment frome example.rb"})
+
+# List all available link types
+# ------------------------------
+pp client.Issuelinktype.all
+
+# List issue's links
+# -------------------------
+issue = client.Issue.find("10002")
+pp issue.issuelinks
+
+# Link two issues (on the same Jira instance)
+# --------------------------------------------
+link = client.Issuelink.build
+link.save(
+    {
+        :type => {:name => 'Relates'},
+        :inwardIssue => {:key => 'AL-1'},
+        :outwardIssue => {:key => 'AL-2'}
+    }
+)
+
+# List issue's remote links
+# -------------------------
+pp issue.remotelink.all
+
+# Link two remote issues (on the different Jira instance)
+# In order to add remote links, you have to add
+# Application Links between two Jira instances first.
+# More information:
+# https://developer.atlassian.com/jiradev/jira-platform/guides/other/guide-jira-remote-issue-links/fields-in-remote-issue-links
+# http://stackoverflow.com/questions/29850252/jira-api-issuelink-connect-two-different-instances
+# -------------------------------------------------------
+client_1 = JIRA::Client.new(options)
+client_2 = JIRA::Client.new(options)
+
+# you have to search for your app id here, instead of getting the first
+client_2_app_link = client_2.ApplicationLink.manifest
+issue_1 = client_1.Issue.find('BB-2')
+issue_2 = client_2.Issue.find('AA-1')
+
+remote_link = issue_2.remotelink.build
+
+remote_link.save(
+    {
+        :globalId => "appId=#{client_2_app_link.id}&issueId=#{issue_1.id}",
+        :application => {
+            :type => 'com.atlassian.jira',
+            :name => client_2_app_link['name']
+        },
+        :relationship => 'relates to',
+
+        :object => {
+            :url => client_1.options[:site] + client_1.options[:context_path] + "/browse/#{issue_1.key}",
+            :title => issue_1.key,
+        }
+    }
+)

data/http-basic-example.rb

@@ -0,0 +1,113 @@
+require 'rubygems'
+require 'pp'
+require 'jira-ruby'
+
+if ARGV.empty?
+  # If not passed any command line arguments, prompt the
+  # user for the username and password.
+  puts 'Enter the username: '
+  username = gets.strip
+
+  puts 'Enter the password: '
+  password = gets.strip
+elsif ARGV.length == 2
+  username = ARGV[0]
+  password = ARGV[1]
+else
+  # Script must be passed 0 or 2 arguments
+  raise "Usage: #{$PROGRAM_NAME} [ username password ]"
+end
+
+options = {
+  username: username,
+  password: password,
+  site: 'http://localhost:8080/',
+  context_path: '',
+  auth_type: :basic,
+  use_ssl: false
+}
+
+client = JIRA::Client.new(options)
+
+# Show all projects
+projects = client.Project.all
+
+projects.each do |project|
+  puts "Project -> key: #{project.key}, name: #{project.name}"
+end
+
+# # Find a specific project by key
+# # ------------------------------
+# project = client.Project.find('SAMPLEPROJECT')
+# pp project
+# project.issues.each do |issue|
+#   puts "#{issue.id} - #{issue.fields['summary']}"
+# end
+#
+# # List all Issues
+# # ---------------
+# client.Issue.all.each do |issue|
+#   puts "#{issue.id} - #{issue.fields['summary']}"
+# end
+#
+# # List issues by JQL query
+# # ------------------------
+# client.Issue.jql('PROJECT = "SAMPLEPROJECT"', {fields: %w(summary status)}).each do |issue|
+#   puts "#{issue.id} - #{issue.fields['summary']}"
+# end
+#
+# # Delete an issue
+# # ---------------
+# issue = client.Issue.find('SAMPLEPROJECT-2')
+# if issue.delete
+#   puts "Delete of issue SAMPLEPROJECT-2 sucessful"
+# else
+#   puts "Delete of issue SAMPLEPROJECT-2 failed"
+# end
+#
+# # Create an issue
+# # ---------------
+# issue = client.Issue.build
+# issue.save({"fields"=>{"summary"=>"blarg from in example.rb","project"=>{"id"=>"10001"},"issuetype"=>{"id"=>"3"}}})
+# issue.fetch
+# pp issue
+#
+# # Update an issue
+# # ---------------
+# issue = client.Issue.find("10002")
+# issue.save({"fields"=>{"summary"=>"EVEN MOOOOOOARRR NINJAAAA!"}})
+# pp issue
+#
+# # Find a user
+# # -----------
+# user = client.User.find('admin')
+# pp user
+#
+# # Get all issue types
+# # -------------------
+# issuetypes = client.Issuetype.all
+# pp issuetypes
+#
+# # Get a single issue type
+# # -----------------------
+# issuetype = client.Issuetype.find('5')
+# pp issuetype
+#
+# #  Get all comments for an issue
+# #  -----------------------------
+# issue.comments.each do |comment|
+#   pp comment
+# end
+#
+# # Build and Save a comment
+# # ------------------------
+# comment = issue.comments.build
+# comment.save!(:body => "New comment from example script")
+#
+# # Delete a comment from the collection
+# # ------------------------------------
+# issue.comments.last.delete
+#
+# # Update an existing comment
+# # --------------------------
+# issue.comments.first.save({"body" => "an updated comment frome example.rb"})

data/jira-ruby.gemspec

@@ -0,0 +1,35 @@
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'jira/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'jira-ruby'
+  s.version     = JIRA::VERSION
+  s.authors     = ['SUMO Heavy Industries', 'test IO']
+  s.homepage    = 'http://www.sumoheavy.com'
+  s.summary     = 'Ruby Gem for use with the Atlassian JIRA REST API'
+  s.description = 'API for JIRA'
+  s.licenses    = ['MIT']
+  s.metadata    = { 'source_code_uri' => 'https://github.com/sumoheavy/jira-ruby' }
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  # Runtime Dependencies
+  s.add_runtime_dependency 'activesupport'
+  s.add_runtime_dependency 'atlassian-jwt'
+  s.add_runtime_dependency 'multipart-post'
+  s.add_runtime_dependency 'oauth', '~> 0.5', '>= 0.5.0'
+
+  # Development Dependencies
+  s.add_development_dependency 'guard', '~> 2.13', '>= 2.13.0'
+  s.add_development_dependency 'guard-rspec', '~> 4.6', '>= 4.6.5'
+  s.add_development_dependency 'pry', '~> 0.10', '>= 0.10.3'
+  s.add_development_dependency 'railties'
+  s.add_development_dependency 'rake', '~> 10.3', '>= 10.3.2'
+  s.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+  s.add_development_dependency 'webmock', '~> 1.18', '>= 1.18.0'
+end

data/lib/jira-ruby.rb

@@ -0,0 +1,49 @@
+$LOAD_PATH << __dir__
+
+require 'active_support/inflector'
+ActiveSupport::Inflector.inflections do |inflector|
+  inflector.singular /status$/, 'status'
+end
+
+require 'jira/base'
+require 'jira/base_factory'
+require 'jira/has_many_proxy'
+require 'jira/http_error'
+
+require 'jira/resource/user'
+require 'jira/resource/watcher'
+require 'jira/resource/attachment'
+require 'jira/resource/component'
+require 'jira/resource/issuetype'
+require 'jira/resource/version'
+require 'jira/resource/status'
+require 'jira/resource/transition'
+require 'jira/resource/project'
+require 'jira/resource/priority'
+require 'jira/resource/comment'
+require 'jira/resource/worklog'
+require 'jira/resource/applinks'
+require 'jira/resource/issuelinktype'
+require 'jira/resource/issuelink'
+require 'jira/resource/remotelink'
+require 'jira/resource/sprint'
+require 'jira/resource/sprint_report'
+require 'jira/resource/issue'
+require 'jira/resource/filter'
+require 'jira/resource/field'
+require 'jira/resource/rapidview'
+require 'jira/resource/resolution'
+require 'jira/resource/serverinfo'
+require 'jira/resource/createmeta'
+require 'jira/resource/webhook'
+require 'jira/resource/agile'
+require 'jira/resource/board'
+require 'jira/resource/board_configuration'
+
+require 'jira/request_client'
+require 'jira/oauth_client'
+require 'jira/http_client'
+require 'jira/jwt_client'
+require 'jira/client'
+
+require 'jira/railtie' if defined?(Rails)