jira_client 1.0.0

data/spec/jira_client/api/projects_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+describe JiraClient::API::Projects do
+
+  describe "#find_projects" do
+
+    before do
+      stub_get("/project").to_return(:body => fixture("projects.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "requests the correct resource" do
+      JiraClient.find_projects
+      expect(a_get("/project")).to have_been_made
+    end
+    it "returns an array of JiraClient::Project objects" do
+      projects = JiraClient.find_projects
+      projects.should be_a_kind_of Array
+      projects.each do |project|
+        project.should be_a_kind_of JiraClient::Project
+      end
+    end
+    it "assigns the correct information" do
+      projects = JiraClient.find_projects
+      projects.first.name.should == "Example"
+      projects.first.key.should == "EX"
+      projects.last.name.should == "Alphabetical"
+      projects.last.key.should == "ABC"
+    end
+  end
+
+  describe "#find_project_by_key" do
+
+    before do
+      stub_get("/project/ABC").to_return(:body => fixture("project.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "requests the correct resource" do
+      JiraClient.find_project_by_key(:ABC)
+      expect(a_get('/project/ABC')).to have_been_made
+    end
+    it "returns a JiraClient::Project object" do
+      project = JiraClient.find_project_by_key :ABC
+      project.should be_a_kind_of JiraClient::Project
+    end
+    it "accepts a key as a string" do
+      project = JiraClient.find_project_by_key "ABC"
+      project.should be_a_kind_of JiraClient::Project
+    end
+    it "accepts a key as a symbol" do
+      project = JiraClient.find_project_by_key :ABC
+      project.should be_a_kind_of JiraClient::Project
+    end
+  end
+
+end

data/spec/jira_client/api/server_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe JiraClient::API::Server do
+
+  before do
+    stub_get("/serverInfo").to_return(:body => fixture("server_info.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+  end
+
+  describe "#info" do
+
+    before do
+      @info = JiraClient.server_info
+    end
+
+    it "requests the correct resource" do
+      expect(a_get("/serverInfo")).to have_been_made
+    end
+    it "returns a JiraClient::ServerInfo object" do
+      expect(@info).to be_a_kind_of JiraClient::ServerInfo
+    end
+    it "sets the correct attributes" do
+      expect(@info.version).to eq("5.1.8")
+      expect(@info.base_url).to eq("https://example.jira.com")
+      expect(@info.build_number).to eq(787)
+      expect(@info.build_date).to eq(Time.parse("2012-10-29T00:00:00.000+0000"))
+      expect(@info.server_time).to eq(Time.parse("2013-04-24T22:01:45.802+0100"))
+      expect(@info.server_title).to eq("Example JIRA")
+    end
+  end
+
+end

data/spec/jira_client/api/statuses_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe JiraClient::API::Statuses do
+
+  describe "#find_statuses" do
+
+    before do
+      stub_get("/status").to_return(:body => fixture("statuses.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it "requests the correct resource" do
+      JiraClient.find_statuses
+      expect(a_get('/status')).to have_been_made
+    end
+    it "returns an array of JiraClient::Status objects" do
+      statuses = JiraClient.find_statuses
+      statuses.should be_a_kind_of Array
+      statuses.each do |status|
+        status.should be_a_kind_of JiraClient::Status
+      end
+    end
+    it "assigns the correct information" do
+      statuses = JiraClient.find_statuses
+      statuses.first.name.should == "In Progress"
+      statuses.first.description.should == "The issue is currently being worked on."
+      statuses.last.name.should == "Closed"
+      statuses.last.description.should == "The issue is closed."
+    end
+  end
+
+  describe "#find_status_by_id" do
+
+    before do
+      stub_get("/status/10000").to_return(:body => fixture("status.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+      @status = JiraClient.find_status_by_id 10000
+    end
+
+    it "requests the correct resource" do
+      expect(a_get("/status/10000")).to have_been_made
+    end
+    it "returns a JiraClient::Status object" do
+      @status.should be_a_kind_of JiraClient::Status
+    end
+    it "assigns the correct information" do
+      @status.name.should == "In Progress"
+      @status.id.should == "10000"
+    end
+  end
+
+  describe "#find_status_by_name" do
+
+    before do
+      stub_get("/status/In%20Progress").to_return(:body => fixture("status.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+      @status = JiraClient.find_status_by_name "In Progress"
+    end
+
+    it "requests the correct resource" do
+      expect(a_get("/status/In Progress")).to have_been_made
+    end
+    it "returns a JiraClient::Status object" do
+      @status.should be_a_kind_of JiraClient::Status
+    end
+    it "assigns the correct information" do
+      @status.name.should == "In Progress"
+      @status.id.should == "10000"
+    end
+  end
+
+end

data/spec/jira_client/api/users_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe JiraClient::API::Users do
+
+  describe "#find_user_by_username" do
+
+    before do
+      stub_get("/user?username=admin").to_return(:body => fixture("admin.json"))
+      @user = JiraClient.find_user_by_username "admin"
+    end
+
+    it "requests the correct resource" do
+      expect(a_get("/user?username=admin")).to have_been_made
+    end
+    it "returns a JiraClient::User object" do
+      @user.should be_a_kind_of JiraClient::User
+    end
+    it "sets the correct attributes" do
+      @user.display_name.should == "admin"
+      @user.should be_active
+      @user.email_address.should == "admin@example.com"
+    end
+
+    describe "when the user can't be found" do
+
+      before do
+        stub_get("/user?username=doesnt_exist").to_return(:status => 404, :body => fixture("user_doesnt_exist.json"))
+      end
+
+      it "raises a not found error" do
+        expect { JiraClient.find_user_by_username("doesnt_exist") }.to raise_error(JiraClient::Error::ResourceNotFound)
+      end
+    end
+  end
+
+  describe "#find_users" do
+
+    before do
+      stub_get("/user/search?username=test").to_return(:status => 200, :body => fixture("users.json"))
+      @users = JiraClient.find_users("test")
+    end
+
+    it "requests the correct resource" do
+      expect(a_get("/user/search?username=test")).to have_been_made
+    end
+    it "returns the correct number of results" do
+      @users.size.should == 2
+    end
+    it "returns user objects" do
+      @users.each do |user|
+        user.should be_a_kind_of JiraClient::User
+      end
+    end
+  end
+
+end

data/spec/jira_client/api/worklogs_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+describe JiraClient::API::Worklogs do
+
+  describe "#create_worklog" do
+
+    before do
+      stub_post("/issue/PROJECT-1234/worklog").to_return(:status => 201)
+    end
+
+    it "requests the correct resource" do
+      JiraClient.create_worklog("PROJECT-1234", "30m")
+      expect(a_post("/issue/PROJECT-1234/worklog")).to have_been_made
+    end
+
+    describe "Parsing duration strings" do
+      it "understands 30m" do
+        JiraClient.create_worklog("PROJECT-1234", "30m")
+        expect(a_post("/issue/PROJECT-1234/worklog").with(:body => {:timeSpentSeconds => 1800})).to have_been_made
+      end
+      it "understands 1h30m" do
+        JiraClient.create_worklog("PROJECT-1234", "1h30m")
+        expect(a_post("/issue/PROJECT-1234/worklog").with(:body => {:timeSpentSeconds => 5400})).to have_been_made
+      end
+      it "understands 1.5h" do
+        JiraClient.create_worklog("PROJECT-1234", "1.5h")
+        expect(a_post("/issue/PROJECT-1234/worklog").with(:body => {:timeSpentSeconds => 5400})).to have_been_made
+      end
+    end
+
+    describe "Adjusting estimates" do
+      it "can adjust remaining estimate to a specified amount" do
+        stub_post("/issue/PROJECT-1234/worklog?adjustEstimate=new&newEstimate=1h").to_return(:status => 201)
+        JiraClient.create_worklog("PROJECT-1234", "30m", :remaining_estimate => "1h")
+        expect(a_post("/issue/PROJECT-1234/worklog?adjustEstimate=new&newEstimate=1h").with(:body => {:timeSpentSeconds => 1800})).to have_been_made
+      end
+      it "can adjust remaining estimate to zero" do
+        stub_post("/issue/PROJECT-1234/worklog?adjustEstimate=new&newEstimate=0").to_return(:status => 201)
+        JiraClient.create_worklog("PROJECT-1234", "30m", :remaining_estimate => 0)
+        expect(a_post("/issue/PROJECT-1234/worklog?adjustEstimate=new&newEstimate=0")).to have_been_made
+      end
+      it "can manually reduce the estimate by a specified amount" do
+        stub_post("/issue/PROJECT-1234/worklog?adjustEstimate=manual&reduceBy=1h").to_return(:status => 201)
+        JiraClient.create_worklog("PROJECT-1234", "30m", :reduce_estimate => "1h")
+        expect(a_post("/issue/PROJECT-1234/worklog?adjustEstimate=manual&reduceBy=1h")).to have_been_made
+      end
+    end
+
+    describe "Commenting on work logs" do
+      it "should be possible" do
+        JiraClient.create_worklog("PROJECT-1234", "30m", :comment => "I did some work")
+        expect(a_post("/issue/PROJECT-1234/worklog").with(:body => {:timeSpentSeconds => 1800, :comment => "I did some work"})).to have_been_made
+      end
+    end
+  end
+
+  describe "#find_issue_worklogs" do
+
+    before do
+      stub_get("/issue/PROJECT-1234/worklog").to_return(:body => fixture("worklog.json"))
+      @worklogs = JiraClient.find_issue_worklogs("PROJECT-1234")
+      @worklog = @worklogs.first
+    end
+
+    it "requests the correct resource" do
+      expect(a_get("/issue/PROJECT-1234/worklog")).to have_been_made
+    end
+    it "returns an array of JiraClient::Worklog objects" do
+      @worklogs.should be_a_kind_of Array
+      @worklog.should be_a_kind_of JiraClient::Worklog
+    end
+    it "sets the correct attributes on the JiraClient::Worklog objects" do
+      @worklog.time_spent.should == "3h 20m"
+      @worklog.started.should == Time.parse("2012-02-15T17:34:37.937-0600")
+      @worklog.time_spent_seconds.should == 12000
+      @worklog.comment.should == "I did some work here."
+    end
+    it "parses the author as a JiraClient::User object" do
+      @worklog.author.should be_a_kind_of JiraClient::User
+    end
+    it "parses the update author as a JiraClient::User object" do
+      @worklog.update_author.should be_a_kind_of JiraClient::User
+    end
+  end
+
+end

data/spec/jira_client/configuration_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+describe "JiraClient.reset!" do
+  it "resets all options to defaults" do
+    JiraClient.configure do |config|
+      config.base_url = "some_url"
+      config.port = 2411
+      config.username = "admin"
+      config.password = "password"
+    end
+    JiraClient.reset!
+    expect(JiraClient.configuration).to be_nil
+  end
+end
+
+describe "JiraClient.configure" do
+  it "config variables are accessible through the configuration method" do
+    JiraClient.configure do |config|
+      config.base_url = "https://example.jira.com"
+    end
+    expect(JiraClient.configuration.base_url).to eq("https://example.jira.com")
+  end
+  it "raises JiraClient::Error::ConfigurationError when an unknown config option is provided" do
+    expect do
+      JiraClient.configure do |config|
+        config.unknown_config_variable = "not allowed"
+      end
+    end.to raise_error(JiraClient::Error::ConfigurationError)
+  end
+
+  describe "authentication options" do
+    describe "basic authentication" do
+      it "accepts a username" do
+        expect do
+          JiraClient.configure {|c| c.username = "admin"}
+        end.not_to raise_error
+      end
+      it "accepts a password" do
+        expect do
+          JiraClient.configure {|c| c.password = "admin"}
+        end.not_to raise_error
+      end
+    end
+  end
+end
+
+describe "JiraClient.configuration" do
+  it "raises an error when #configure has not been run" do
+    JiraClient.stub(:configuration).and_return(nil)
+    expect { JiraClient.find_issue_by_key "TEST-1" }.to raise_error(JiraClient::Error::ConfigurationError)
+  end
+
+  describe "#full_url" do
+    it "includes the base_url" do
+      JiraClient.configure {|c| c.base_url = "http://localhost"}
+      JiraClient.configuration.full_url.should include("http://localhost")
+    end
+    it "includes the port if specified" do
+      JiraClient.configure do |config|
+        config.base_url = "http://localhost"
+        config.port = 2990
+      end
+      JiraClient.configuration.full_url.should include(":2990")
+    end
+    it "includes the default API path" do
+      JiraClient.configure {|c| c.base_url = "http://localhost"}
+      JiraClient.configuration.full_url.should include ("/rest/api/2")
+    end
+    it "trims trailing / from the base_url" do
+      JiraClient.configure {|c| c.base_url = "http://localhost/"}
+      JiraClient.configuration.full_url.should == "http://localhost/rest/api/2"
+    end
+    it "raises an error if not configured properly" do
+      JiraClient.configure {|c| c.base_url = nil}
+      expect { JiraClient.configuration.full_url }.to raise_error JiraClient::Error::ConfigurationError
+    end
+  end
+end

data/spec/jira_client_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe JiraClient do
+  describe "proxy server" do
+    it "sets the proxy server on RestClient" do
+      JiraClient.configure do |config|
+        config.proxy = "http://myproxy.com"
+      end
+      # Build the resource
+      JiraClient.send(:resource)
+      RestClient.proxy.should == "http://myproxy.com"
+    end
+  end
+  describe "basic authentication" do
+
+    before do
+      @basic_auth_url = JiraClient.configuration.full_url.gsub("https://", "https://admin:admin@") + "/project"
+      stub_request(:get, @basic_auth_url).to_return(:body => fixture("projects.json"))
+    end
+
+    it "sends a username/password when provided" do
+      JiraClient.configure {|c| c.username = "admin"; c.password = "admin"}
+      JiraClient.find_projects
+      expect(a_request(:get, @basic_auth_url)).to have_been_made
+    end
+  end
+
+  describe "certificate authentication" do
+
+    before do
+      JiraClient.configure do |config|
+        config.certificate = fixture("my_certificate.pem")
+        config.certificate_passphrase = "password"
+      end
+      @resource_options = JiraClient.send(:resource).options
+    end
+
+    it "sets ssl_client_cert" do
+      @resource_options[:ssl_client_cert].should_not be_nil
+    end
+    it "sets ssl_client_key" do
+      @resource_options[:ssl_client_key].should_not be_nil
+    end
+    it "sets verify_ssl" do
+      @resource_options[:verify_ssl].should_not be_nil
+      @resource_options[:verify_ssl].should == OpenSSL::SSL::VERIFY_NONE
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+require "simplecov"
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter
+]
+SimpleCov.start
+
+require "webmock/rspec"
+require "jira_client"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+  config.before(:each) do
+    JiraClient.configure do |c|
+      c.base_url = "https://example.jira.com"
+    end
+  end
+  config.after(:each) do
+    JiraClient.reset!
+  end
+end
+
+def a_get(path)
+  a_request(:get, JiraClient.configuration.full_url + path)
+end
+
+def a_post(path)
+  a_request(:post, JiraClient.configuration.full_url + path)
+end
+
+def a_put(path)
+  a_request(:put, JiraClient.configuration.full_url + path)
+end
+
+def stub_get(path)
+  stub_request(:get, JiraClient.configuration.full_url + path)
+end
+
+def stub_post(path)
+  stub_request(:post, JiraClient.configuration.full_url + path)
+end
+
+def stub_put(path)
+  stub_request(:put, JiraClient.configuration.full_url + path)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end