jira-ruby 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e40d5ee749de621839801a5e80f92e4cda3325d
-  data.tar.gz: 35a5726e608c149b40ee31fbbd5d262876bfc710
+  metadata.gz: 2ff744bcd9ad2d2787f07ecf627888484805cadf
+  data.tar.gz: ae9c78df7d9b0de9fb35bdfb0671119240211a91
 SHA512:
-  metadata.gz: cdc3298da60ff9bd8553253c6abe2d87c7402bd970678d49e889f6b642f774654f80a234ab2a58ae2d066db84d9c1e5d329d72c59ac6c48a87226eba15e0ca8f
-  data.tar.gz: 42c0599010e58238193759fd88d0ad8b4a529311862432610f8e175fa3e584f8e3264dbebca71a029c1be791341aa280e6ebe6c2521e5045699cecb18ecda002
+  metadata.gz: d118f8da88f23970bb406d4cfabec43eb19fc4178fddc4c9ec9e9c893933dff4b0aa6c3aa56fdcfc92a1ee43817f8ba39d1b03d2a1645c950528bf104eebcbcd
+  data.tar.gz: 4a9a20b2c3ecb34c7ff79c87cbf0546ec5bbb89700a3655066fd4060d5b9fa4e8dbaf68e66d40f7a8ec02b36c96712be8af4889d6618f50a603ed85f91611c6f

data/README.rdoc

@@ -1,6 +1,6 @@
 = JIRA API Gem
 {<img src="https://codeclimate.com/github/sumoheavy/jira-ruby.png" />}[https://codeclimate.com/github/sumoheavy/jira-ruby]
-{<img src="https://travis-ci.org/sumoheavy/jira-ruby.png?branch=master"}[https://travis-ci.org/sumoheavy/jira-ruby]
+{<img src="https://travis-ci.org/sumoheavy/jira-ruby.png?branch=master" />}[https://travis-ci.org/sumoheavy/jira-ruby]
 
 This gem provides access to the Atlassian JIRA REST API.
 
@@ -80,7 +80,7 @@ of JIRA.
   require 'pp'
   require 'jira'
 
-  # Consider the use of :use_ssl and :ssl_verify_mode options if running locally 
+  # Consider the use of :use_ssl and :ssl_verify_mode options if running locally
   # for tests.
 
   username = "myremoteuser"
@@ -91,14 +91,15 @@ of JIRA.
               :password => password,
               :site     => 'http://localhost:8080/',
               :context_path => '/myjira',
-              :auth_type => :basic
+              :auth_type => :basic,
+              :read_timeout => 120
             }
 
   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
@@ -135,7 +136,7 @@ errors are handled gracefully
     private
 
     def get_jira_client
-      
+
       # add any extra configuration options for your instance of JIRA,
       # e.g. :use_ssl, :ssl_verify_mode, :context_path, :site
       options = {
@@ -148,8 +149,8 @@ errors are handled gracefully
       # Add AccessToken if authorised previously.
       if session[:jira_auth]
         @jira_client.set_access_token(
-          session[:jira_auth][:access_token],
-          session[:jira_auth][:access_key]
+          session[:jira_auth]['access_token'],
+          session[:jira_auth]['access_key']
         )
       end
     end
@@ -253,7 +254,7 @@ Here's the same example as a Sinatra application:
       if !session[:jira_auth]
         # not logged in
         <<-eos
-          <h1>jira-ruby (JIRA 5 Ruby Gem) demo </h1>You're not signed in. Why don't you 
+          <h1>jira-ruby (JIRA 5 Ruby Gem) demo </h1>You're not signed in. Why don't you
           <a href=/signin>sign in</a> first.
         eos
       else
@@ -262,25 +263,25 @@ Here's the same example as a Sinatra application:
 
         # HTTP response inlined with bind data below...
         <<-eos
-          You're now signed in. There #{@issues.count == 1 ? "is" : "are"} #{@issues.count} 
+          You're now signed in. There #{@issues.count == 1 ? "is" : "are"} #{@issues.count}
           issue#{@issues.count == 1 ? "" : "s"} in this JIRA instance. <a href='/signout'>Signout</a>
         eos
       end
     end
 
     # http://<yourserver>/signin
-    # Initiates the OAuth dance by first requesting a token then redirecting to 
+    # Initiates the OAuth dance by first requesting a token then redirecting to
     # http://<yourserver>/auth to get the @access_token
     get '/signin' do
       request_token = @jira_client.request_token
       session[:request_token] = request_token.token
       session[:request_secret] = request_token.secret
 
-      redirect request_token.authorize_url    
+      redirect request_token.authorize_url
     end
 
     # http://<yourserver>/callback
-    # Retrieves the @access_token then stores it inside a session cookie. In a real app, 
+    # Retrieves the @access_token then stores it inside a session cookie. In a real app,
     # you'll want to persist the token in a datastore associated with the user.
     get "/callback/" do
       request_token = @jira_client.set_request_token(

data/example.rb

@@ -117,3 +117,60 @@ pp issue
 # # 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/lib/jira.rb

@@ -21,10 +21,15 @@ 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/issue'
 require 'jira/resource/filter'
 require 'jira/resource/field'
 require 'jira/resource/rapidview'
+require 'jira/resource/serverinfo'
 
 require 'jira/request_client'
 require 'jira/oauth_client'

data/lib/jira/base.rb

@@ -365,7 +365,16 @@ module JIRA
         save_status = save!(attrs)
       rescue JIRA::HTTPError => exception
         puts ">>>>>>>>> Exception response: #{exception.response.body}"
-        set_attrs_from_response(exception.response) rescue JSON::ParserError  # Merge error status generated by JIRA REST API
+        begin
+          set_attrs_from_response(exception.response) # Merge error status generated by JIRA REST API
+        rescue JSON::ParserError => parse_exception
+          set_attrs("exception" => {
+                        "class" => exception.response.class.name,
+                        "code" => exception.response.code,
+                        "message" => exception.response.message
+                    }
+          )
+        end
         save_status = false
       end
       save_status

data/lib/jira/client.rb

@@ -129,6 +129,26 @@ module JIRA
       JIRA::Resource::RapidViewFactory.new(self)
     end
 
+    def ServerInfo
+      JIRA::Resource::ServerInfoFactory.new(self)
+    end
+
+    def ApplicationLink
+      JIRA::Resource::ApplicationLinkFactory.new(self)
+    end
+
+    def Issuelink
+      JIRA::Resource::IssuelinkFactory.new(self)
+    end
+
+    def Issuelinktype
+      JIRA::Resource::IssuelinktypeFactory.new(self)
+    end
+
+    def Remotelink
+      JIRA::Resource::RemotelinkFactory.new(self)
+    end
+
     # HTTP methods without a body
     def delete(path, headers = {})
       request(:delete, path, nil, merge_default_headers(headers))

data/lib/jira/http_client.rb

@@ -40,6 +40,7 @@ module JIRA
       http_conn = http_class.new(uri.host, uri.port)
       http_conn.use_ssl = @options[:use_ssl]
       http_conn.verify_mode = @options[:ssl_verify_mode]
+      http_conn.read_timeout = @options[:read_timeout]
       http_conn
     end
 

data/lib/jira/resource/applinks.rb

@@ -0,0 +1,42 @@
+module JIRA
+  module Resource
+
+    class ApplicationLinkFactory < JIRA::BaseFactory # :nodoc:
+      delegate_to_target_class :manifest
+    end
+
+    class ApplicationLink < JIRA::Base
+
+      REST_BASE_PATH = '/rest/applinks/1.0'
+
+      def self.endpoint_name
+        'listApplicationlinks'
+      end
+
+      def self.full_url(client)
+        client.options[:context_path] + REST_BASE_PATH
+      end
+
+      def self.collection_path(client, prefix = '/')
+        self.full_url(client) + prefix + self.endpoint_name
+      end
+
+      def self.all(client, options = {})
+        response = client.get(collection_path(client))
+        json = parse_json(response.body)
+        json = json['list']
+        json.map do |attrs|
+          self.new(client, {:attrs => attrs}.merge(options))
+        end
+      end
+
+      def self.manifest(client)
+        url = self.full_url(client) + '/manifest'
+        response = client.get(url)
+        json = parse_json(response.body)
+        JIRA::Base.new(client, {:attrs => json})
+      end
+
+    end
+  end
+end

data/lib/jira/resource/issue.rb

@@ -35,6 +35,10 @@ module JIRA
 
       has_many :worklogs, :nested_under => ['fields','worklog']
 
+      has_many :issuelinks, :nested_under => 'fields'
+
+      has_many :remotelink, :class => JIRA::Resource::Remotelink
+
       def self.all(client)
         url = client.options[:rest_base_path] + "/search?expand=transitions.fields"
         response = client.get(url)

data/lib/jira/resource/issuelink.rb

@@ -0,0 +1,22 @@
+module JIRA
+  module Resource
+
+    class IssuelinkFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    # Because of circular dependency Issue->IssueLink->Issue
+    # we have to declare JIRA::Resource::Issue class.
+    class Issue < JIRA::Base; end
+
+    class Issuelink < JIRA::Base
+      has_one :type, :class => JIRA::Resource::Issuelinktype
+      has_one :inwardIssue, :class => JIRA::Resource::Issue
+      has_one :outwardIssue, :class => JIRA::Resource::Issue
+
+      def self.endpoint_name
+        'issueLink'
+      end
+
+    end
+  end
+end

data/lib/jira/resource/issuelinktype.rb

@@ -0,0 +1,15 @@
+module JIRA
+  module Resource
+
+    class IssuelinktypeFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Issuelinktype < JIRA::Base
+      nested_collections true
+
+      def self.endpoint_name
+        'issueLinkType'
+      end
+    end
+  end
+end

data/lib/jira/resource/remotelink.rb

@@ -0,0 +1,29 @@
+module JIRA
+  module Resource
+
+    class RemotelinkFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class Remotelink < JIRA::Base
+      belongs_to :issue
+
+      def self.endpoint_name
+        'remotelink'
+      end
+
+      def self.all(client, options = {})
+        issue = options[:issue]
+        unless issue
+          raise ArgumentError.new("parent issue is required")
+        end
+
+        path = "#{issue.self}/#{endpoint_name}"
+        response = client.get(path)
+        json = parse_json(response.body)
+        json.map do |link|
+          issue.remotelink.build(link)
+        end
+      end
+    end
+  end
+end

data/lib/jira/resource/serverinfo.rb

@@ -0,0 +1,19 @@
+module JIRA
+  module Resource
+
+    class ServerInfoFactory < JIRA::BaseFactory # :nodoc:
+    end
+
+    class ServerInfo < JIRA::Base
+      def self.endpoint_name
+        'serverInfo'
+      end
+
+      def self.all(client, options = {})
+        response = client.get(collection_path(client))
+        json = parse_json(response.body)
+        self.new(client, {:attrs => json}.merge(options))
+      end
+    end
+  end
+end

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = "0.1.16"
+  VERSION = "0.1.17"
 end

data/spec/integration/issuelinktype_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe JIRA::Resource::Issuelinktype do
+
+  with_each_client do |site_url, client|
+    let(:client) { client }
+    let(:site_url) { site_url }
+
+
+    let(:key) { "10000" }
+
+    let(:expected_attributes) do
+      {
+        'id' => key,
+        "self"=>"http://localhost:2990/jira/rest/api/2/issueLinkType/10000",
+        "name"=>"Blocks",
+        "inward"=>"is blocked by",
+        "outward"=>"blocks"
+      }
+    end
+
+    let(:expected_collection_length) { 3 }
+
+    it_should_behave_like "a resource"
+    it_should_behave_like "a resource with a collection GET endpoint"
+    it_should_behave_like "a resource with a singular GET endpoint"
+
+  end
+end

data/spec/jira/base_spec.rb

@@ -270,6 +270,13 @@ describe JIRA::Base do
       expect(subject.save("invalid_field" => "foobar")).to be_falsey
     end
 
+    it "returns false with exception details when non json response body (unauthorized)" do # Unauthorized requests return a non-json body. This makes sure we can handle non-json bodies on HTTPError
+      response = double("Response", body: 'totally invalid json', code: 401, message: "Unauthorized")
+      expect(client).to receive(:post).with('/foo/bar','{"foo":"bar"}').and_raise(JIRA::HTTPError.new(response))
+      expect(subject.save("foo" => "bar")).to be_falsey
+      expect(subject.attrs["exception"]["code"]).to eq(401)
+      expect(subject.attrs["exception"]["message"]).to eq("Unauthorized")
+    end
   end
 
   describe "save!" do

data/spec/jira/http_client_spec.rb

@@ -96,6 +96,7 @@ describe JIRA::HttpClient do
     expect(Net::HTTP).to receive(:new).with(host, port).and_return(http_conn)
     expect(http_conn).to receive(:use_ssl=).with(basic_client.options[:use_ssl]).and_return(http_conn)
     expect(http_conn).to receive(:verify_mode=).with(basic_client.options[:ssl_verify_mode]).and_return(http_conn)
+    expect(http_conn).to receive(:read_timeout=).with(basic_client.options[:read_timeout]).and_return(http_conn)
     expect(basic_client.http_conn(uri)).to eq(http_conn)
   end
 

data/spec/jira/resource/issuelink_spec.rb

@@ -0,0 +1,14 @@
+# require 'spec_helper'
+#
+# describe JIRA::Resource::Issuelink do
+#   let(:client) { double() }
+#
+#   describe "links" do
+#     subject {
+#       JIRA::Resource::Issuelink.new(client, :attrs => {
+#
+#       }
+#       )
+#     }
+#   end
+# end

data/spec/mock_responses/issueLinkType.json

@@ -0,0 +1,25 @@
+{
+  "issueLinkTypes": [
+    {
+      "id": "10000",
+      "name": "Blocks",
+      "inward": "is blocked by",
+      "outward": "blocks",
+      "self": "http://localhost:2990/jira/rest/api/2/issueLinkType/10000"
+    },
+    {
+      "id": "10400",
+      "name": "Cloners",
+      "inward": "is cloned by",
+      "outward": "clones",
+      "self": "http://localhost:2990/jira/rest/api/2/issueLinkType/10400"
+    },
+    {
+      "id": "10401",
+      "name": "Duplicate",
+      "inward": "is duplicated by",
+      "outward": "duplicates",
+      "self": "http://localhost:2990/jira/rest/api/2/issueLinkType/10401"
+    }
+  ]
+}

data/spec/mock_responses/issueLinkType/10000.json

@@ -0,0 +1,7 @@
+{
+  "id": "10000",
+  "self": "http://localhost:2990/jira/rest/api/2/issueLinkType/10000",
+  "name": "Blocks",
+  "inward": "is blocked by",
+  "outward": "blocks"
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - SUMO Heavy Industries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2015-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -119,16 +119,21 @@ files:
 - lib/jira/oauth_client.rb
 - lib/jira/railtie.rb
 - lib/jira/request_client.rb
+- lib/jira/resource/applinks.rb
 - lib/jira/resource/attachment.rb
 - lib/jira/resource/comment.rb
 - lib/jira/resource/component.rb
 - lib/jira/resource/field.rb
 - lib/jira/resource/filter.rb
 - lib/jira/resource/issue.rb
+- lib/jira/resource/issuelink.rb
+- lib/jira/resource/issuelinktype.rb
 - lib/jira/resource/issuetype.rb
 - lib/jira/resource/priority.rb
 - lib/jira/resource/project.rb
 - lib/jira/resource/rapidview.rb
+- lib/jira/resource/remotelink.rb
+- lib/jira/resource/serverinfo.rb
 - lib/jira/resource/status.rb
 - lib/jira/resource/transition.rb
 - lib/jira/resource/user.rb
@@ -142,6 +147,7 @@ files:
 - spec/integration/component_spec.rb
 - spec/integration/field_spec.rb
 - spec/integration/issue_spec.rb
+- spec/integration/issuelinktype_spec.rb
 - spec/integration/issuetype_spec.rb
 - spec/integration/priority_spec.rb
 - spec/integration/project_spec.rb
@@ -162,6 +168,7 @@ files:
 - spec/jira/resource/attachment_spec.rb
 - spec/jira/resource/filter_spec.rb
 - spec/jira/resource/issue_spec.rb
+- spec/jira/resource/issuelink_spec.rb
 - spec/jira/resource/project_factory_spec.rb
 - spec/jira/resource/project_spec.rb
 - spec/jira/resource/worklog_spec.rb
@@ -187,6 +194,8 @@ files:
 - spec/mock_responses/issue/10002/worklog.post.json
 - spec/mock_responses/issue/10002/worklog/10000.json
 - spec/mock_responses/issue/10002/worklog/10000.put.json
+- spec/mock_responses/issueLinkType.json
+- spec/mock_responses/issueLinkType/10000.json
 - spec/mock_responses/issuetype.json
 - spec/mock_responses/issuetype/5.json
 - spec/mock_responses/priority.json
@@ -241,6 +250,7 @@ test_files:
 - spec/integration/component_spec.rb
 - spec/integration/field_spec.rb
 - spec/integration/issue_spec.rb
+- spec/integration/issuelinktype_spec.rb
 - spec/integration/issuetype_spec.rb
 - spec/integration/priority_spec.rb
 - spec/integration/project_spec.rb
@@ -261,6 +271,7 @@ test_files:
 - spec/jira/resource/attachment_spec.rb
 - spec/jira/resource/filter_spec.rb
 - spec/jira/resource/issue_spec.rb
+- spec/jira/resource/issuelink_spec.rb
 - spec/jira/resource/project_factory_spec.rb
 - spec/jira/resource/project_spec.rb
 - spec/jira/resource/worklog_spec.rb
@@ -286,6 +297,8 @@ test_files:
 - spec/mock_responses/issue/10002/worklog.post.json
 - spec/mock_responses/issue/10002/worklog/10000.json
 - spec/mock_responses/issue/10002/worklog/10000.put.json
+- spec/mock_responses/issueLinkType.json
+- spec/mock_responses/issueLinkType/10000.json
 - spec/mock_responses/issuetype.json
 - spec/mock_responses/issuetype/5.json
 - spec/mock_responses/priority.json