jiralicious 0.3.0 → 0.4.0

data/lib/jiralicious/user/avatar.rb

@@ -0,0 +1,130 @@
+# encoding: utf-8
+module Jiralicious
+	class User
+		##
+		# Avatars in the Project class.
+		#
+		class Avatar < Jiralicious::Base
+
+			##
+			# Initialization Method
+			#
+			# [Arguments]
+			# :decoded_json    (optional)    decoded json object
+			#
+			def initialize(decoded_json = nil)
+				@loaded = false
+				if !decoded_json.nil?
+					if decoded_json.is_a? Hash
+						decoded_json = properties_from_hash(decoded_json)
+						super(decoded_json)
+						parse!(decoded_json)
+						self.each do |k, v|
+							if v.is_a? Hash
+								self[k] = self.class.new(v)
+							elsif v.is_a? Array
+								v.each_index do |i|
+									if v[i].is_a? Hash
+										v[i] = self.class.new(v[i])
+									end
+								end
+								self[k] = v
+							end
+						end
+						@loaded = true
+					else
+						i = 0;
+						decoded_json.each do |list|
+							if !list['id'].nil?
+								if numeric? list['id']
+									id =  :"id_#{list['id']}"
+								else
+									id = :"#{list['id']}"
+								end
+							else
+								id = :"_#{i}"
+								i += 1
+							end
+							self.class.property id
+							self[id] = self.class.new(list)
+						end
+					end
+				end
+			end
+
+			class << self
+				##
+				# Converts the temporary avatar to a real avatar
+				#
+				# [Arguments]
+				# :username          (required)    username to change
+				#
+				# :cropperWidth      (optional)    width of the avatar
+				#
+				# :cropperOffsetX    (optional)    X offset on image
+				#
+				# :cropperOffsetY    (optional)    Y offset on image
+				#
+				# :needsCropping     (optional)    boolean if it needs cropping
+				#
+				def post(username, options = {})
+					options.merge!({:username => username})
+					response = fetch({:method => :post, :parent_uri => "#{parent_name}/", :body => options})
+				end
+
+				##
+				# Update Avatar information
+				#
+				# [Arguments]
+				# :username   (required)    project key
+				#
+				# :options    (optional)    not documented
+				#
+				def put(username, options = {})
+					options.merge!({:username => username})
+					response = fetch({:method => :put, :parent_uri => "#{parent_name}/", :body => options})
+				end
+
+				##
+				# Creates temporary avatar
+				#
+				# [Arguments]
+				# :username    (required)    project key
+				#
+				# :filename    (optional)    file to upload
+				#
+				# :size        (optional)    size of the file
+				#
+				def temporary(username, options = {})
+					options.merge!({:username => username})
+					response = fetch({:method => :post, :parent_uri => "#{parent_name}/", :key => 'temporary', :body => options})
+					return self.new(response.parsed_response)
+				end
+
+				##
+				# Deletes or removes the avatar from the project
+				#
+				# [Arguments]
+				# :username    (required)    project key
+				#
+				# :id          (required)    avatar id
+				#
+				def remove(username, id)
+					response = fetch({:method => :delete, :body_to_params => true, :parent_uri => "#{parent_name}/", :key => "#{id}", :body => {:username => username}})
+				end
+
+				##
+				# Gets a list of avatars
+				#
+				# [Arguments]
+				# :username    (required)    user name
+				#
+				def avatars(username, options = {})
+					options.merge!({:username => username})
+					response = fetch({:method => :get, :body_to_params => true, :url => "#{Jiralicious.rest_path}/#{parent_name}/#{endpoint_name}s", :body => options})
+					return self.new(response.parsed_response)
+				end
+			end
+		end
+	end
+end

data/lib/jiralicious/version.rb

@@ -1,4 +1,4 @@
 module Jiralicious
   # Current Jiralicious Version
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/avatar_spec.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Jiralicious, "avatar" do
+
+  before :each do
+    Jiralicious.configure do |config|
+      config.username = "jstewart"
+      config.password = "topsecret"
+      config.uri = "http://jstewart:topsecret@localhost"
+      config.auth_type = :basic
+      config.api_version = "latest"
+    end
+
+    FakeWeb.register_uri(:get,
+      "#{Jiralicious.rest_path}/avatar/user/system",
+      :status => "200",
+      :body => avatar_list_json)
+    FakeWeb.register_uri(:post,
+      "#{Jiralicious.rest_path}/avatar/user/temporary",
+      :status => "200",
+      :body => avatar_temp_json)
+    FakeWeb.register_uri(:post,
+      "#{Jiralicious.rest_path}/avatar/user/temporaryCrop",
+      :status => "200")
+  end
+
+  it "obtain system avatar list" do
+    avatar = Jiralicious::Avatar.system('user')
+	avatar.should be_instance_of(Jiralicious::Avatar)
+	avatar.system.count.should == 2
+    avatar.system[0].id.should == '10100'
+	avatar.system[1].isSystemAvatar.should == true
+  end
+
+  it "sends new avatar" do
+    file = "#{File.dirname(__FILE__)}/fixtures/avatar_test.png"
+    avatar = Jiralicious::Avatar.temporary('user', {:filename => file, :size => 4035})
+	avatar.needsCropping.should == true
+  end
+
+  it "crops the current avatar" do
+    response = Jiralicious::Avatar.temporary_crop('user', {:cropperWidth => 120,
+			 :cropperOffsetX => 50,
+			 :cropperOffsety => 50,
+			 :needsCropping => false})
+	response.response.class.should == Net::HTTPOK
+  end
+
+end

data/spec/basic_session_spec.rb

@@ -3,6 +3,10 @@ require "spec_helper"
 
 describe  "performing a request" do
   before :each do
+    Jiralicious.configure do |config|
+      config.uri = "http://jstewart:topsecret@localhost"
+    end
+
     FakeWeb.register_uri(:get,
       Jiralicious.uri + '/ok',
       :status => "200")

data/spec/comment_spec.rb

@@ -7,8 +7,8 @@ describe Jiralicious, "search" do
     Jiralicious.configure do |config|
       config.username = "jstewart"
       config.password = "topsecret"
-      config.uri = "http://localhost"
-      config.auth_type = :cookie
+      config.uri = "http://jstewart:topsecret@localhost"
+      config.auth_type = :basic
       config.api_version = "latest"
     end
 

data/spec/fixtures/avatar.json

@@ -0,0 +1,7 @@
+{
+  "id": "10100",
+  "owner": "fred",
+  "isSystemAvatar": true,
+  "isSelected": true,
+  "selected": true
+}

data/spec/fixtures/avatar_custom.json

@@ -0,0 +1,16 @@
+{
+  "system": [
+    {
+      "id": "10100",
+      "isSystemAvatar": false,
+      "isSelected": false,
+      "selected": false
+    },
+    {
+      "id": "10101",
+      "isSystemAvatar": true,
+      "isSelected": false,
+      "selected": false
+    }
+  ]
+}

data/spec/fixtures/avatar_list.json

@@ -0,0 +1,16 @@
+{
+  "system": [
+    {
+      "id": "10100",
+      "isSystemAvatar": false,
+      "isSelected": false,
+      "selected": false
+    },
+    {
+      "id": "10101",
+      "isSystemAvatar": true,
+      "isSelected": false,
+      "selected": false
+    }
+  ]
+}

data/spec/fixtures/avatar_temp.json

@@ -0,0 +1,7 @@
+{
+  "cropperWidth": 120,
+  "cropperOffsetX": 50,
+  "cropperOffsetY": 50,
+  "url": "http://example.com/jira/secure/temporaryavatar?cropped=true",
+  "needsCropping": true
+}

data/spec/fixtures/user.json

@@ -0,0 +1,27 @@
+{
+  "self": "http://www.example.com/jira/rest/api/2/user?username=test_user",
+  "name": "test",
+  "emailAddress": "test_user@example.com",
+  "avatarUrls": {
+    "16x16": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=test_user",
+    "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=test_user"
+  },
+  "displayName": "Test User",
+  "active": true,
+  "timeZone": "Australia/Sydney",
+  "groups": {
+    "size": 3,
+    "items": [
+      {
+        "name": "jira-user"
+      },
+      {
+        "name": "jira-admin"
+      },
+      {
+        "name": "important"
+      }
+    ]
+  },
+  "expand": "groups"
+}

data/spec/fixtures/user_array.json

@@ -0,0 +1,26 @@
+[
+  {
+    "self": "http://www.example.com/jira/rest/api/2/user?username=test_user",
+    "name": "test_user",
+  "emailAddress": "test_user@example.com",
+    "avatarUrls": {
+      "16x16": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=test_user",
+      "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=test_user"
+    },
+    "displayName": "Test User",
+    "active": false,
+  "timeZone": "America/Chicago"
+  },
+  {
+    "self": "http://www.example.com/jira/rest/api/2/user?username=simple_user",
+    "name": "simple_user",
+  "emailAddress": "simple_user@example.com",
+    "avatarUrls": {
+      "16x16": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=simple_user",
+      "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=simple_user"
+    },
+    "displayName": "Simple User",
+    "active": false,
+  "timeZone": "America/Chicago"
+  }
+]

data/spec/fixtures/user_picker.json

@@ -0,0 +1,18 @@
+{
+  "users": [
+  {
+    "name": "test_user",
+    "html": "test_user@example.com",
+    "displayName": "Test User",
+    "avatarUrl": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=test_user"
+  },
+  {
+    "name": "simple_user",
+    "html": "simple_user@example.com",
+    "displayName": "Simple User",
+    "avatarURL": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=simple_user"
+  }
+  ],
+  "total": 2,
+  "header": "Showing 2 of 25 matching groups"
+}

data/spec/issue_spec.rb

@@ -7,8 +7,8 @@ describe Jiralicious::Issue, "finding" do
     Jiralicious.configure do |config|
       config.username = "jstewart"
       config.password = "topsecret"
-      config.uri = "http://localhost"
-      config.auth_type = :cookie
+      config.uri = "http://jstewart:topsecret@localhost"
+      config.auth_type = :basic
       config.api_version = "latest"
     end
 
@@ -56,8 +56,8 @@ describe Jiralicious::Issue, "Managing Issues" do
     Jiralicious.configure do |config|
       config.username = "jstewart"
       config.password = "topsecret"
-      config.uri = "http://localhost"
-      config.auth_type = :cookie
+      config.uri = "http://jstewart:topsecret@localhost"
+      config.auth_type = :basic
       config.api_version = "latest"
     end
 
@@ -159,8 +159,8 @@ describe Jiralicious::Issue, "Managing Issues" do
     Jiralicious.configure do |config|
       config.username = "jstewart"
       config.password = "topsecret"
-      config.uri = "http://localhost"
-      config.auth_type = :cookie
+      config.uri = "http://jstewart:topsecret@localhost"
+      config.auth_type = :basic
       config.api_version = "latest"
     end
 
@@ -215,8 +215,8 @@ describe Jiralicious::Issue, "Issue Information and Field Class" do
     Jiralicious.configure do |config|
       config.username = "jstewart"
       config.password = "topsecret"
-      config.uri = "http://localhost"
-      config.auth_type = :cookie
+      config.uri = "http://jstewart:topsecret@localhost"
+      config.auth_type = :basic
       config.api_version = "latest"
     end
 
@@ -281,7 +281,8 @@ describe Jiralicious::Issue, "transitions" do
     Jiralicious.configure do |config|
       config.username = "jstewart"
       config.password = "topsecret"
-      config.uri = "http://localhost"
+      config.uri = "http://jstewart:topsecret@localhost"
+	  config.auth_type = :basic
       config.api_version = "latest"
     end
 

data/spec/project_avatar_spec.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require "spec_helper"
+
+describe Jiralicious, "Project Avatar" do
+
+  before :each do
+    Jiralicious.configure do |config|
+      config.username = "jstewart"
+      config.password = "topsecret"
+      config.uri = "http://jstewart:topsecret@localhost"
+      config.auth_type = :basic
+      config.api_version = "latest"
+    end
+
+    FakeWeb.register_uri(:put,
+      "#{Jiralicious.rest_path}/project/EX/avatar/",
+      :status => "204")
+    FakeWeb.register_uri(:post,
+      "#{Jiralicious.rest_path}/project/EX/avatar/",
+      :status => "200")
+    FakeWeb.register_uri(:delete,
+      "#{Jiralicious.rest_path}/project/EX/avatar/10100",
+      :status => "200")
+    FakeWeb.register_uri(:get,
+      "#{Jiralicious.rest_path}/project/EX/avatars/",
+      :status => "200",
+      :body => avatar_list_json)
+    FakeWeb.register_uri(:post,
+      "#{Jiralicious.rest_path}/project/EX/avatar/temporary",
+      :status => "200",
+      :body => avatar_temp_json)
+  end
+
+  it "obtain project avatar list" do
+    avatar = Jiralicious::Project::Avatar.avatars('EX')
+	avatar.should be_instance_of(Jiralicious::Project::Avatar)
+	avatar.system.count.should == 2
+    avatar.system[0].id.should == '10100'
+	avatar.system[1].isSystemAvatar.should == true
+  end
+
+  it "sends new project avatar" do
+    file = "#{File.dirname(__FILE__)}/fixtures/avatar_test.png"
+    avatar = Jiralicious::Project::Avatar.temporary('EX', {:filename => file, :size => 4035})
+	avatar.needsCropping.should == true
+  end
+
+  it "crops the current project avatar" do
+    response = Jiralicious::Project::Avatar.post('EX', {:cropperWidth => 120,
+			 :cropperOffsetX => 50,
+			 :cropperOffsety => 50,
+			 :needsCropping => false})
+	response.response.class.should == Net::HTTPOK
+  end
+
+  it "updates current project avatar" do
+    response = Jiralicious::Project::Avatar.put('EX')
+	response.response.class.should == Net::HTTPNoContent
+  end
+
+  it "updates current project avatar" do
+    response = Jiralicious::Project::Avatar.remove('EX', 10100)
+	response.response.class.should == Net::HTTPOK
+  end
+
+end