jiralicious 0.0.6

data/spec/jiralicious_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Jiralicious do
+  it "creates a session on load" do
+    Jiralicious.session.should_not be_nil
+  end
+
+  it "creates a rest path" do
+    Jiralicious.configure do |config|
+      config.uri = "http://localhost:8080"
+      config.api_version = "2.0"
+    end
+    Jiralicious.rest_path.should == 'http://localhost:8080/rest/api/2.0'
+  end
+end

data/spec/search_result_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Jiralicious::SearchResult do
+  before :each do
+    FakeWeb.register_uri(:get,
+                         "#{Jiralicious.rest_path}/issue/HSP-1",
+                         :status => "200",
+                         :body => issue_json)
+  end
+
+  let(:search_data) {
+    {
+      "startAt" => 0,
+      "maxResults" =>  50,
+      "total" =>  1,
+      "issues" => [{
+                   "self" => "http://www.example.com/jira/rest/api/2.0/jira/rest/api/2.0/issue/HSP-1",
+                   "key" =>  "HSP-1"
+                 }]
+    }
+  }
+  let(:search_result) { Jiralicious::SearchResult.new(search_data) }
+
+  it "assigns an array to back the search results" do
+    search_result.instance_variable_get('@issues').
+      should == [ {"self" => "http://www.example.com/jira/rest/api/2.0/jira/rest/api/2.0/issue/HSP-1",
+                  "key" => "HSP-1"} ]
+  end
+
+  it "knows it's offset" do
+    search_result.offset.should == 0
+  end
+
+  it "knows how many results are returned from the web service" do
+    search_result.num_results.should == 1
+  end
+
+  it "fetches issues" do
+    search_result.issues.first.should be_instance_of(Jiralicious::Issue)
+  end
+end

data/spec/search_spec.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Jiralicious, "search", do
+
+  before :each do
+    Jiralicious.configure do |config|
+      config.username = "jstewart"
+      config.password = "topsecret"
+      config.uri = "http://localhost"
+      config.api_version = "latest"
+    end
+  end
+
+  context "when successful" do
+    before :each do
+      FakeWeb.register_uri(:post,
+                           "#{Jiralicious.rest_path}/search",
+                           :status => "200",
+                           :body => search_json)
+
+    end
+
+    it "instantiates a search result" do
+      results = Jiralicious.search("key = HSP-1")
+      results.should be_instance_of(Jiralicious::SearchResult)
+    end
+  end
+
+  context "When there's a problem with the query" do
+    before :each do
+      FakeWeb.register_uri(:post,
+                           "#{Jiralicious.rest_path}/search",
+                           :status => "400")
+    end
+
+    it "raises an exception" do
+      lambda {
+        results = Jiralicious.search("key = HSP-1")
+      }.should raise_error(Jiralicious::JqlError)
+    end
+  end
+end

data/spec/session_spec.rb

@@ -0,0 +1,278 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Jiralicious::Session, "when logging in" do
+  context "successfully" do
+    before :each do
+      register_login
+      @session = Jiralicious::Session.new
+      @session.login
+    end
+
+    it "is alive" do
+      @session.should be_alive
+    end
+
+    it "populates the session and login info" do
+      @session.session.should == {
+        "name" =>  "JSESSIONID",
+        "value" => "12345678901234567890"
+      }
+      @session.login_info.should == {
+        "failedLoginCount" =>  10,
+        "loginCount" =>  127,
+        "lastFailedLoginTime" => "2011-07-25T06:31:07.556-0500",
+        "previousLoginTime" => "2011-07-25T06:31:07.556-0500"
+      }
+    end
+  end
+
+  context "with an invalid login" do
+    before :each do
+      FakeWeb.register_uri(:post,
+                           Jiralicious.uri + '/rest/auth/latest/session',
+                           :status => ["401", "Not Authorized"])
+      @session = Jiralicious::Session.new
+    end
+
+    it "raises the correct exception" do
+      lambda { @session.login }.
+        should raise_error(Jiralicious::InvalidLogin)
+    end
+
+    it "is not alive" do
+      begin; @session.login; rescue Jiralicious::InvalidLogin; end
+      @session.should_not be_alive
+    end
+
+    it "clears the session and login info" do
+      @session.login_info = "GARBAGE"
+      @session.session = "GARBAGE"
+      begin; @session.login; rescue Jiralicious::InvalidLogin; end
+      @session.login_info.should be_nil
+      @session.session.should be_nil
+    end
+  end
+
+  context "when CAPTCHA is required" do
+    before :each do
+      FakeWeb.register_uri(:post,
+                           Jiralicious.uri + '/rest/auth/latest/session',
+                           :status => ["403", "Captcha Required"])
+      @session = Jiralicious::Session.new
+    end
+
+    it "raises an exception" do
+      lambda { @session.login }.
+        should raise_error(Jiralicious::CaptchaRequired)
+    end
+
+    it "clears the session and login info" do
+      @session.login_info = "GARBAGE"
+      @session.session = "GARBAGE"
+      begin; @session.login; rescue Jiralicious::CaptchaRequired; end
+      @session.login_info.should be_nil
+      @session.session.should be_nil
+    end
+  end
+
+  context "with any other HTTP error" do
+    before :each do
+      FakeWeb.register_uri(:post,
+                           Jiralicious.uri + '/rest/auth/latest/session',
+                           :status => ["500", "Internal Server Error"])
+      @session = Jiralicious::Session.new
+    end
+
+    it "raises an exception" do
+      lambda { @session.login }.
+        should raise_error(Jiralicious::JiraError)
+    end
+
+    it "clears the session and login info" do
+      @session.login_info = "GARBAGE"
+      @session.session = "GARBAGE"
+      begin; @session.login; rescue Jiralicious::JiraError; end
+      @session.login_info.should be_nil
+      @session.session.should be_nil
+    end
+
+    it "gives the Net::HTTP reason for failure" do
+      begin
+        @session.login
+      rescue Jiralicious::JiraError => e
+        e.message.should == "Internal Server Error"
+      end
+    end
+  end
+end
+
+describe Jiralicious::Session, "when logging out" do
+  before :each do
+    register_login
+    @session = Jiralicious::Session.new
+    @session.login
+    @session.should be_alive
+    FakeWeb.register_uri(:delete,
+                         Jiralicious.uri + '/rest/auth/latest/session',
+                         :status => "204")
+    @session.logout
+  end
+
+  it "is not alive" do
+    @session.should_not be_alive
+  end
+
+  it "clears the session and login info" do
+    @session.session.should be_nil
+    @session.login_info.should be_nil
+  end
+
+  context "when not logged in" do
+    before :each do
+      @session = Jiralicious::Session.new
+      FakeWeb.register_uri(:delete,
+                         Jiralicious.uri + '/rest/auth/latest/session',
+                         :status => ["401", "Not Authorized"])
+    end
+
+    it "should raise the correct error" do
+      lambda { @session.logout }.should raise_error(Jiralicious::NotLoggedIn)
+    end
+  end
+
+  context "with any other HTTP error" do
+    before :each do
+      @session = Jiralicious::Session.new
+      FakeWeb.register_uri(:delete,
+                         Jiralicious.uri + '/rest/auth/latest/session',
+                         :status => ["500", "Internal Server Error"])
+    end
+
+    it "raises an exception" do
+      lambda { @session.logout }.
+        should raise_error(Jiralicious::JiraError)
+    end
+
+    it "gives the Net::HTTP reason for failure" do
+      begin
+        @session.logout
+      rescue Jiralicious::JiraError => e
+        e.message.should == "Internal Server Error"
+      end
+    end
+  end
+end
+
+describe Jiralicious::Session, "performing a request" do
+  include ConfigurationHelper
+  include LoginHelper
+
+  before :each do
+    FakeWeb.register_uri(:get,
+                         Jiralicious.uri + '/fake/uri',
+                         :status => "200")
+  end
+
+  context "when login is required" do
+    before :each do
+      @session = Jiralicious::Session.new
+      @session.stub!(:require_login?).and_return(true)
+    end
+
+    it "attempts to log in beforehand" do
+      @session.should_receive(:login)
+      @session.perform_request do
+        Jiralicious::Session.get('/fake/uri')
+      end
+    end
+  end
+
+  context "when login is not required" do
+    before :each do
+      @session = Jiralicious::Session.new
+      @session.stub!(:require_login?).and_return(false)
+    end
+
+    it "doesn't try to log in before making the request" do
+      @session.should_receive(:login).never
+      @session.perform_request do
+        Jiralicious::Session.get('/fake/uri')
+      end
+    end
+  end
+end
+
+describe  "performing a request with a successful response" do
+    before :each do
+      FakeWeb.register_uri(:get,
+                           Jiralicious.uri + '/ok',
+                           :status => "200")
+      FakeWeb.register_uri(:post,
+                           Jiralicious.uri + '/created',
+                           :status => "201")
+      FakeWeb.register_uri(:delete,
+                           Jiralicious.uri + '/nocontent',
+                           :status => "204")
+
+      register_login
+  end
+
+  let(:session) { Jiralicious::Session.new }
+
+  it "returns the response on ok" do
+    r = session.perform_request { Jiralicious::Session.get('/ok') }
+    r.class.should == HTTParty::Response
+  end
+
+  it "returns the response on created" do
+    r = session.perform_request { Jiralicious::Session.post('/created') }
+    r.class.should == HTTParty::Response
+  end
+
+  it "returns the response on no content" do
+    r = session.perform_request { Jiralicious::Session.delete('/nocontent') }
+    r.class.should == HTTParty::Response
+  end
+end
+
+describe  "performing a request with an unsuccessful response" do
+    before :each do
+      FakeWeb.register_uri(:get,
+                           Jiralicious.uri + '/cookie_expired',
+                           [
+                            {:status => "401", :body => "Cookie Expired"},
+                            {:status => "200"}
+                           ])
+      FakeWeb.register_uri(:get,
+                           Jiralicious.uri + '/captcha_needed',
+                           :status => "401",
+                           "X-Seraph-LoginReason" => "AUTHENTICATION_DENIED")
+      register_login
+  end
+
+  let(:session) { Jiralicious::Session.new }
+
+  it "retries the login when the cookie expires" do
+    session.should_receive(:login).twice
+    session.perform_request { Jiralicious::Session.get('/cookie_expired') }
+  end
+
+  it "raises an exception when retried and failed" do
+    FakeWeb.register_uri(:get,
+                         Jiralicious.uri + '/cookie_expired',
+                         [
+                          {:status => "401", :body => "Cookie Expired"},
+                          {:status => "401", :body => "Cookie Expired"}
+                         ])
+    lambda {
+      session.perform_request { Jiralicious::Session.get('/cookie_expired') }
+    }.should raise_error(Jiralicious::CookieExpired)
+  end
+
+  it "raises an exception when the captcha is required" do
+    lambda {
+      session.perform_request { Jiralicious::Session.get('/captcha_needed') }
+    }.should raise_error(Jiralicious::CaptchaRequired)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'fakeweb'
+require 'jiralicious'
+
+FakeWeb.allow_net_connect = false
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include ConfigurationHelper
+  config.include LoginHelper
+  config.include JsonResponse
+
+  config.before(:each) do
+    configure_jiralicious
+    register_login
+  end
+end

data/spec/support/configuration.rb

@@ -0,0 +1,10 @@
+module ConfigurationHelper
+  def configure_jiralicious
+    Jiralicious.configure do |config|
+      config.username = "jstewart"
+      config.password = "topsecret"
+      config.uri = "http://localhost"
+      config.api_version = "latest"
+    end
+  end
+end

data/spec/support/http.rb

@@ -0,0 +1,34 @@
+module LoginHelper
+  def register_login
+    response = %Q|
+    {
+      "session": {
+      "name": "JSESSIONID",
+      "value": "12345678901234567890"
+    },
+      "loginInfo": {
+        "failedLoginCount": 10,
+        "loginCount": 127,
+        "lastFailedLoginTime": "2011-07-25T06:31:07.556-0500",
+        "previousLoginTime": "2011-07-25T06:31:07.556-0500"
+      }
+    }|
+    FakeWeb.register_uri(:post,
+                         Jiralicious.uri + '/rest/auth/latest/session',
+                         :body => response)
+  end
+end
+
+module JsonResponse
+  def issue_json
+    File.new(File.expand_path('issue.json', File.dirname(__FILE__) + '/../fixtures')).read
+  end
+
+  def search_json
+    File.new(File.expand_path('search.json', File.dirname(__FILE__) + '/../fixtures')).read
+  end
+
+  def transitions_json
+    File.new(File.expand_path('transitions.json', File.dirname(__FILE__) + '/../fixtures')).read
+  end
+end