jira-ruby 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8a9d8341a978cefa7838d24cb1ab04ed8b7b827
-  data.tar.gz: 751b670eee108023f9c9f26c3a047990980d8460
+  metadata.gz: 73c4e19bc5c82d26d320a378266855abc8244997
+  data.tar.gz: 2fd1c376a41076726c10f28afd9e4c380b38b91f
 SHA512:
-  metadata.gz: 2ad45e5cdc3d906be50dda804c90ce53a3bd82f9388357ad011186456bf51e2b98ce521709cbf95480f515e9e1dd0e37a54c908339ae9dad6db99713491410de
-  data.tar.gz: 5e4bf3c7720a0a12e89a0de06a289a9da2bad66d54f93d4b889fb19c189d9e8481f829c716b5f2aa99ace0823e5605529072982949d59dcd1828bff0c99dbada
+  metadata.gz: 4b150a3fc57ba754238ae9851d2dd1c0b8f190203cd3e195d88c4778381c261f8f8a5196200f8ec13382eca8821fa2e24cf0008c37bf9582d91efda165d0e162
+  data.tar.gz: af41788a14386555867711bd12b40622f2b473f02362b6fec5268cd7a3a99a4b82de73cb873bc91954296140e001900fd5f561cb307baf6eb45926b25c1bb911

data/lib/jira/base.rb

@@ -1,5 +1,6 @@
 require 'active_support/core_ext/string'
 require 'active_support/inflector'
+require 'set'
 
 module JIRA
 
@@ -50,6 +51,8 @@ module JIRA
   #   new_comment = issue.comments.build
   #
   class Base
+    QUERY_PARAMS_FOR_SINGLE_FETCH = Set.new [:expand, :fields]
+    QUERY_PARAMS_FOR_SEARCH = Set.new [:expand, :fields, :startAt, :maxResults]
 
     # A reference to the JIRA::Client used to initialize this resource.
     attr_reader :client
@@ -104,7 +107,7 @@ module JIRA
     def self.find(client, key, options = {})
       instance = self.new(client, options)
       instance.attrs[key_attribute.to_s] = key
-      instance.fetch
+      instance.fetch(false, query_params_for_single_fetch(options))
       instance
     end
 
@@ -331,9 +334,9 @@ module JIRA
     # Fetches the attributes for the specified resource from JIRA unless
     # the resource is already expanded and the optional force reload flag 
     # is not set
-    def fetch(reload = false)
+    def fetch(reload = false, query_params = {})
       return if expanded? && !reload
-      response = client.get(url)
+      response = client.get(url_with_query_params(url, query_params))
       set_attrs_from_response(response)
       @expanded = true
     end
@@ -465,5 +468,30 @@ module JIRA
       end
     end
 
+    def url_with_query_params(url, query_params)
+      if not query_params.empty?
+        "#{url}?#{hash_to_query_string query_params}"
+      else
+        url
+      end
+    end
+
+    def hash_to_query_string(query_params)
+      query_params.map do |k,v|
+        CGI.escape(k.to_s) + "=" + CGI.escape(v.to_s)
+      end.join('&')
+    end
+
+    def self.query_params_for_single_fetch(options)
+      Hash[options.select do |k,v|
+        QUERY_PARAMS_FOR_SINGLE_FETCH.include? k
+      end]
+    end
+
+    def self.query_params_for_search(options)
+      Hash[options.select do |k,v|
+        QUERY_PARAMS_FOR_SEARCH.include? k
+      end]
+    end
   end
 end

data/lib/jira/resource/project.rb

@@ -16,15 +16,16 @@ module JIRA
       end
 
       # Returns all the issues for this project
-      def issues
-        response = client.get(client.options[:rest_base_path] + "/search?jql=project%3D'#{key}'")
+      def issues(options={})
+        search_url = client.options[:rest_base_path] + '/search'
+        query_params = {:jql => "project=\"#{key}\""}
+        query_params.update Base.query_params_for_search(options)
+        response = client.get(url_with_query_params(search_url, query_params))
         json = self.class.parse_json(response.body)
         json['issues'].map do |issue|
           client.Issue.build(issue)
         end
       end
-
     end
-
   end
 end

data/lib/jira/version.rb

@@ -1,3 +1,3 @@
 module JIRA
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/spec/integration/project_spec.rb

@@ -26,7 +26,7 @@ describe JIRA::Resource::Project do
     describe "issues" do
 
       it "returns all the issues" do
-        stub_request(:get, site_url + "/jira/rest/api/2/search?jql=project='SAMPLEPROJECT'").
+        stub_request(:get, site_url + "/jira/rest/api/2/search?jql=project=\"SAMPLEPROJECT\"").
           to_return(:status => 200, :body => get_mock_response('project/SAMPLEPROJECT.issues.json'))
         subject = client.Project.build('key' => key)
         issues = subject.issues

data/spec/jira/base_spec.rb

@@ -67,6 +67,21 @@ describe JIRA::Base do
     deadbeef.expanded?.should be_true
   end
 
+  it "finds a deadbeef containing changelog by id" do
+    response = double() 
+    response.stub(:body).and_return('{"self":"http://deadbeef/","id":"98765","changelog":{"histories":[]}}')
+    client.should_receive(:get).with('/jira/rest/api/2/deadbeef/98765?expand=changelog').and_return(response)
+
+    JIRA::Resource::Deadbeef.should_receive(:collection_path).and_return('/jira/rest/api/2/deadbeef')
+
+    deadbeef = JIRA::Resource::Deadbeef.find(client, '98765', {expand:'changelog'})
+    deadbeef.client.should == client
+    deadbeef.attrs['self'].should  == 'http://deadbeef/'
+    deadbeef.attrs['id'].should   == '98765'
+    deadbeef.expanded?.should be_true
+    deadbeef.attrs['changelog']['histories'].should == []
+  end
+
   it "builds a deadbeef" do
     deadbeef = JIRA::Resource::Deadbeef.build(client, 'id' => "98765" )
     deadbeef.expanded?.should be_false
@@ -176,6 +191,21 @@ describe JIRA::Base do
       end
     end
 
+    context "with expand parameter 'changelog'" do
+      it "fetchs changelogs '" do
+        response = double() 
+        response.stub(:body).and_return('{"self":"http://deadbeef/","id":"98765","changelog":{"histories":[]}}')
+        client.should_receive(:get).with('/jira/rest/api/2/deadbeef/98765?expand=changelog').and_return(response)
+
+        JIRA::Resource::Deadbeef.should_receive(:collection_path).and_return('/jira/rest/api/2/deadbeef')
+
+        subject.fetch(false, {expand:'changelog'})
+
+        subject.self.should == "http://deadbeef/"
+        subject.id.should  == "98765"
+        subject.changelog['histories'].should == []
+      end
+    end
   end
 
   describe "save" do

data/spec/jira/resource/project_spec.rb

@@ -2,14 +2,17 @@ require 'spec_helper'
 
 describe JIRA::Resource::Project do
 
-  let(:client) { double() }
+  let(:client) { double("client", :options => {
+                          :rest_base_path => '/jira/rest/api/2'
+                        })
+  }
 
   describe "relationships" do
     subject {
       JIRA::Resource::Project.new(client, :attrs => {
-        'lead'        => {'foo' => 'bar'},
-        'issueTypes'  => [{'foo' =>'bar'},{'baz' => 'flum'}],
-        'versions'    => [{'foo' =>'bar'},{'baz' => 'flum'}]
+          'lead'        => {'foo' => 'bar'},
+          'issueTypes'  => [{'foo' =>'bar'},{'baz' => 'flum'}],
+          'versions'    => [{'foo' =>'bar'},{'baz' => 'flum'}],
       })
     }
 
@@ -25,4 +28,43 @@ describe JIRA::Resource::Project do
     end
   end
 
+  describe "issues" do
+    subject {
+      JIRA::Resource::Project.new(client, :attrs => {
+          'key'         => 'test'
+        })
+    }
+
+    it "returns issues" do
+      response_body = '{"expand":"schema,names","startAt":0,"maxResults":1,"total":1,"issues":[{"expand":"editmeta,renderedFields,transitions,changelog,operations","id":"53062","self":"/rest/api/2/issue/53062","key":"test key","fields":{"summary":"test summary"}}]}'
+      response = double("response",
+        :body => response_body)
+      issue_factory = double("issue factory")
+
+      client.should_receive(:get)
+        .with('/jira/rest/api/2/search?jql=project%3D%22test%22')
+        .and_return(response)
+      client.should_receive(:Issue).and_return(issue_factory)
+      issue_factory.should_receive(:build)
+        .with(JSON.parse(response_body)["issues"][0])
+      subject.issues
+    end
+
+    context "with changelog" do
+      it "returns issues" do
+        response_body = '{"expand":"schema,names","startAt":0,"maxResults":1,"total":1,"issues":[{"expand":"editmeta,renderedFields,transitions,changelog,operations","id":"53062","self":"/rest/api/2/issue/53062","key":"test key","fields":{"summary":"test summary"},"changelog":{}}]}'
+        response = double("response",
+          :body => response_body)
+        issue_factory = double("issue factory")
+
+        client.should_receive(:get)
+          .with('/jira/rest/api/2/search?jql=project%3D%22test%22&expand=changelog&startAt=1&maxResults=100')
+          .and_return(response)
+        client.should_receive(:Issue).and_return(issue_factory)
+        issue_factory.should_receive(:build)
+          .with(JSON.parse(response_body)["issues"][0])
+        subject.issues({expand:'changelog', startAt:1, maxResults:100})
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - SUMO Heavy Industries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-24 00:00:00.000000000 Z
+date: 2014-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth