leantesting 1.0.0

data/lib/Entity/Platform/PlatformDevice.rb

@@ -0,0 +1,7 @@
+class PlatformDevice < Entity
+
+	def initialize(origin, data)
+		super
+	end
+
+end

data/lib/Entity/Platform/PlatformOS.rb

@@ -0,0 +1,10 @@
+class PlatformOS < Entity
+	attr_reader :versions
+
+	def initialize(origin, data)
+		super
+
+		@versions = PlatformOSVersionsHandler.new(origin, data['id'])
+	end
+
+end

data/lib/Entity/Platform/PlatformOSVersion.rb

@@ -0,0 +1,7 @@
+class PlatformOSVersion < Entity
+
+	def initialize(origin, data)
+		super
+	end
+
+end

data/lib/Entity/Platform/PlatformType.rb

@@ -0,0 +1,10 @@
+class PlatformType < Entity
+	attr_reader :devices
+
+	def initialize(origin, data)
+		super
+
+		@devices = PlatformTypeDevicesHandler.new(origin, data['id'])
+	end
+
+end

data/lib/Entity/Project/Project.rb

@@ -0,0 +1,27 @@
+class Project < Entity
+	attr_reader \
+		:sections,
+		:versions,
+		:users,
+		:bugTypeScheme,
+		:bugStatusScheme,
+		:bugSeverityScheme,
+		:bugReproducibilityScheme,
+		:bugs
+
+	def initialize(origin, data)
+		super
+
+		@sections = ProjectSectionsHandler.new(origin, data['id'])
+		@versions = ProjectVersionsHandler.new(origin, data['id'])
+		@users    = ProjectUsersHandler.new(origin, data['id'])
+
+		@bugTypeScheme            = ProjectBugTypeSchemeHandler.new(origin, data['id'])
+		@bugStatusScheme          = ProjectBugStatusSchemeHandler.new(origin, data['id'])
+		@bugSeverityScheme        = ProjectBugSeveritySchemeHandler.new(origin, data['id'])
+		@bugReproducibilityScheme = ProjectBugReproducibilitySchemeHandler.new(origin, data['id'])
+
+		@bugs = ProjectBugsHandler.new(origin, data['id'])
+	end
+
+end

data/lib/Entity/Project/ProjectBugScheme.rb

@@ -0,0 +1,7 @@
+class ProjectBugScheme < Entity
+
+	def initialize(origin, data)
+		super
+	end
+
+end

data/lib/Entity/Project/ProjectSection.rb

@@ -0,0 +1,7 @@
+class ProjectSection < Entity
+
+	def initialize(origin, data)
+		super
+	end
+
+end

data/lib/Entity/Project/ProjectUser.rb

@@ -0,0 +1,7 @@
+class ProjectUser < Entity
+
+	def initialize(origin, data)
+		super
+	end
+
+end

data/lib/Entity/Project/ProjectVersion.rb

@@ -0,0 +1,7 @@
+class ProjectVersion < Entity
+
+	def initialize(origin, data)
+		super
+	end
+
+end

data/lib/Entity/User/UserOrganization.rb

@@ -0,0 +1,7 @@
+class UserOrganization < Entity
+
+	def initialize(origin, data)
+		super
+	end
+
+end

data/lib/Exception/BaseException/SDKException.rb

@@ -0,0 +1,19 @@
+class SDKException < Exception
+
+	def initialize(message = nil)
+		super
+
+		if !message
+			message = 'Unknown SDK Error'
+		else
+			message = 'SDK Error: ' + message
+		end
+
+		@message = message
+	end
+
+	def message
+		@message
+	end
+
+end

data/lib/Exception/SDKBadJSONResponseException.rb

@@ -0,0 +1,15 @@
+class SDKBadJSONResponseException < SDKException
+
+	def initialize(message = nil)
+		@baseMessage = 'JSON remote response is inconsistent or invalid'
+
+		if !message
+			message = @baseMessage
+		else
+			message = @baseMessage + ' - ' + message
+		end
+
+		super
+	end
+
+end

data/lib/Exception/SDKDuplicateRequestException.rb

@@ -0,0 +1,19 @@
+class SDKDuplicateRequestException < SDKException
+
+	def initialize(message = nil)
+		@baseMessage = 'Duplicate request data'
+
+		if message.is_a? Array
+			message = message.map{ |el| '`' + el + '`' }.join(', ')
+		end
+
+		if !message
+			message = @baseMessage
+		else
+			message = @baseMessage + ' - multiple ' + message
+		end
+
+		super
+	end
+
+end

data/lib/Exception/SDKErrorResponseException.rb

@@ -0,0 +1,13 @@
+class SDKErrorResponseException < SDKException
+
+	def initialize(message = nil)
+		if !message
+			message = 'Unknown remote error'
+		else
+			message = 'Got error response: ' + message
+		end
+
+		super
+	end
+
+end

data/lib/Exception/SDKIncompleteRequestException.rb

@@ -0,0 +1,19 @@
+class SDKIncompleteRequestException < SDKException
+
+	def initialize(message = nil)
+		@baseMessage = 'Incomplete request data'
+
+		if message.is_a? Array
+			message = message.map{ |el| '`' + el + '`' }.join(', ')
+		end
+
+		if !message
+			message = @baseMessage
+		else
+			message = @baseMessage + ' - missing required ' + message
+		end
+
+		super
+	end
+
+end

data/lib/Exception/SDKInvalidArgException.rb

@@ -0,0 +1,15 @@
+class SDKInvalidArgException < SDKException
+
+	def initialize(message = nil)
+		@baseMessage = 'Invalid argument'
+
+		if !message
+			message = @baseMessage
+		else
+			message = @baseMessage + ': ' + message
+		end
+
+		super
+	end
+
+end

data/lib/Exception/SDKMissingArgException.rb

@@ -0,0 +1,15 @@
+class SDKMissingArgException < SDKException
+
+	def initialize(message = nil)
+		@baseMessage = 'Missing argument'
+
+		if !message
+			message = @baseMessage
+		else
+			message = @baseMessage + ' `' + message + '`'
+		end
+
+		super
+	end
+
+end

data/lib/Exception/SDKUnexpectedResponseException.rb

@@ -0,0 +1,15 @@
+class SDKUnexpectedResponseException < SDKException
+
+	def initialize(message = nil)
+		@baseMessage = 'Got unexpected remote response'
+
+		if !message
+			message = @baseMessage
+		else
+			message = @baseMessage + ' - ' + message
+		end
+
+		super
+	end
+
+end

data/lib/Exception/SDKUnsupportedRequestException.rb

@@ -0,0 +1,19 @@
+class SDKUnsupportedRequestException < SDKException
+
+	def initialize(message = nil)
+		@baseMessage = 'Unsupported request data'
+
+		if message.is_a? Array
+			message = message.map{ |el| '`' + el + '`' }.join(', ')
+		end
+
+		if !message
+			message = @baseMessage
+		else
+			message = @baseMessage + ' - invalid ' + message
+		end
+
+		super
+	end
+
+end

data/lib/Handler/Attachment/AttachmentsHandler.rb

@@ -0,0 +1,17 @@
+class AttachmentsHandler < EntityHandler
+
+	def find(id)
+		super
+
+		req = APIRequest.new(@origin, '/v1/attachments/' + id.to_s(), 'GET')
+		BugAttachment.new(@origin, req.exec)
+	end
+
+	def delete(id)
+		super
+
+		req = APIRequest.new(@origin, '/v1/attachments/' + id.to_s(), 'DELETE')
+		req.exec
+	end
+
+end

data/lib/Handler/Auth/OAuth2Handler.rb

@@ -0,0 +1,118 @@
+#
+# Handler to manage general authentication routines
+#
+# leantesting.com/en/api-docs#oauth-flow
+#
+class OAuth2Handler
+
+	#
+	# Constructs an OAuth2Handler instance
+	#
+	# Arguments:
+	#	origin Client -- Originating client reference
+	#
+	def initialize(origin)
+		@origin = origin
+	end
+
+	#
+	# Function that generates link for user to follow in order to request authorization code
+	#
+	# Arguments:
+	#	clientID    String -- client ID given at application registration
+	#	redirectURI String -- URL to be redirected to after authorization
+	#	scope       String -- (optional) comma-separated list of requested scopes (default: 'read')
+	#	state       String -- (optional) random string for MITM attack prevention
+	#
+	# Exceptions:
+	#	SDKInvalidArgException if provided clientID param is not a string
+	#	SDKInvalidArgException if provided redirectURI param is not a string
+	#	SDKInvalidArgException if provided scope param is not a string
+	#	SDKInvalidArgException if provided state param is not a string
+	#
+	# Returns:
+	#	String -- returns URL to follow for authorization code request
+	#
+	def generateAuthLink(clientID, redirectURI, scope = 'read', state = nil)
+		if !clientID.is_a? String
+			raise SDKInvalidArgException, '`clientID` must be a string'
+		elsif !redirectURI.is_a? String
+			raise SDKInvalidArgException, '`redirectURI` must be a string'
+		elsif !scope.is_a? String
+			raise SDKInvalidArgException, '`scope` must be a string'
+		elsif state && !state.is_a?(String)
+			raise SDKInvalidArgException, '`state` must be a string'
+		end
+
+		baseURL = 'https://leantesting.com/login/oauth/authorize'
+
+		params = {
+			'client_id'		=> clientID,
+			'redirect_uri'	=> redirectURI,
+			'scope'			=> scope
+		}
+
+		if state
+			params['state'] = state
+		end
+
+		baseURL += '?' + Curl::postalize(params)
+		baseURL
+	end
+
+	#
+	# Generates an access token string from the provided authorization code
+	#
+	# Arguments:
+	#	clientID     String -- client ID given at application registration
+	#	clientSecret String -- client secret given at application registration
+	#	grantType    String -- oauth specific grant_type value (i.e.: authorization_code)
+	#	code         String -- authorization code obtained from the generated auth link
+	#	redirectURI  String -- URL to be redirected to after authorization
+
+	# Exceptions:
+	#	SDKInvalidArgException if provided clientID param is not a string
+	#	SDKInvalidArgException if provided clientSecret param is not a string
+	#	SDKInvalidArgException if provided grantType param is not a string
+	#	SDKInvalidArgException if provided code param is not a string
+	#	SDKInvalidArgException if provided redirectURI param is not a string
+	#
+	# Returns:
+	#	String -- returns obtained access token string
+	#
+	def exchangeAuthCode(clientID, clientSecret, grantType, code, redirectURI)
+		if !clientID.is_a? String
+			raise SDKInvalidArgException, '`clientID` must be a string'
+		elsif !clientSecret.is_a? String
+			raise SDKInvalidArgException, '`clientSecret` must be a string'
+		elsif !grantType.is_a? String
+			raise SDKInvalidArgException, '`grantType` must be a string'
+		elsif !code.is_a? String
+			raise SDKInvalidArgException, '`code` must be a string'
+		elsif !redirectURI.is_a? String
+			raise SDKInvalidArgException, '`redirectURI` must be a string'
+		end
+
+		params = {
+			'grant_type'	=> grantType,
+			'client_id'		=> clientID,
+			'client_secret'	=> clientSecret,
+			'redirect_uri'	=> redirectURI,
+			'code'			=> code
+		}
+
+		req = APIRequest.new(
+			@origin,
+			'/login/oauth/access_token',
+			'POST',
+			{
+				'base_uri'	=> 'https://leantesting.com',
+				'params'	=> params
+			}
+		)
+
+		resp = req.exec
+		resp['access_token']
+	end
+
+end

data/lib/Handler/Bug/BugAttachmentsHandler.rb

@@ -0,0 +1,51 @@
+class BugAttachmentsHandler < EntityHandler
+
+	def initialize(origin, bugID)
+		super(origin)
+
+		@bugID = bugID
+	end
+
+	#
+	# Uploads given file as an attachment for specified bug.
+	#
+	# Arguments:
+	#	filepath String -- an absolute path of the file to be uploaded
+	#					example: /home/path/to/file.txt (Linux), C:\\Users\\Documents\\file.txt (Windows)
+	#
+	# Exceptions:
+	#	SDKInvalidArgException if filepath is not a string
+	#
+	# Returns:
+	#	BugAttachment -- the newly uploaded attachment
+	#
+	def upload(filepath)
+		if !filepath.is_a? String
+			raise SDKInvalidArgException, '`filepath` must be of type string'
+		end
+
+		req = APIRequest.new(
+			@origin,
+			'/v1/bugs/' + @bugID.to_s() + '/attachments',
+			'POST',
+			{
+				'form_data' => true,
+				'file_path' => filepath
+			}
+		)
+
+		BugAttachment.new(@origin, req.exec)
+	end
+
+	def all(filters = nil)
+		if !filters
+			filters = {}
+		end
+
+		super
+
+		request = APIRequest.new(@origin, '/v1/bugs/' + @bugID.to_s() + '/attachments', 'GET')
+		EntityList.new(@origin, request, BugAttachment, filters)
+	end
+
+end