leantesting 1.0.0

data/lib/Handler/Project/ProjectUsersHandler.rb

@@ -0,0 +1,20 @@
+class ProjectUsersHandler < EntityHandler
+
+	def initialize(origin, projectID)
+		super(origin)
+
+		@projectID = projectID
+	end
+
+	def all(filters = nil)
+		if !filters
+			filters = {}
+		end
+
+		super
+
+		request = APIRequest.new(@origin, '/v1/projects/' + @projectID.to_s() + '/users', 'GET')
+		EntityList.new(@origin, request, ProjectUser, filters)
+	end
+
+end

data/lib/Handler/Project/ProjectVersionsHandler.rb

@@ -0,0 +1,39 @@
+class ProjectVersionsHandler < EntityHandler
+
+	def initialize(origin, projectID)
+		super(origin)
+
+		@projectID = projectID
+	end
+
+	def create(fields)
+		super
+
+		supports = {
+			'number' => true
+		}
+
+		if enforce(fields, supports)
+			req = APIRequest.new(
+				@origin,
+				'/v1/projects/' + @projectID.to_s() + '/versions',
+				'POST',
+				{'params' => fields}
+			)
+
+			ProjectVersion.new(@origin, req.exec)
+		end
+	end
+
+	def all(filters = nil)
+		if !filters
+			filters = {}
+		end
+
+		super
+
+		request = APIRequest.new(@origin, '/v1/projects/' + @projectID.to_s() + '/versions', 'GET')
+		EntityList.new(@origin, request, ProjectVersion, filters)
+	end
+
+end

data/lib/Handler/Project/ProjectsHandler.rb

@@ -0,0 +1,46 @@
+class ProjectsHandler < EntityHandler
+
+	def create(fields)
+		super
+
+		supports = {
+			'name'            => true,
+			'organization_id' => false
+		}
+
+		if enforce(fields, supports)
+			req = APIRequest.new(@origin, '/v1/projects', 'POST', {'params' => fields})
+			Project.new(@origin, req.exec)
+		end
+	end
+
+	def all(filters = nil)
+		if !filters
+			filters = {}
+		end
+
+		super
+
+		request = APIRequest.new(@origin, '/v1/projects', 'GET')
+		EntityList.new(@origin, request, Project, filters)
+	end
+
+	def allArchived(filters = nil)
+		if !filters
+			filters = {}
+		end
+
+		super
+
+		request = APIRequest.new(@origin, '/v1/projects/archived', 'GET')
+		EntityList.new(@origin, request, Project, filters)
+	end
+
+	def find(id)
+		super
+
+		req = APIRequest.new(@origin, '/v1/projects/' + id.to_s(), 'GET')
+		Project.new(@origin, req.exec)
+	end
+
+end

data/lib/Handler/User/UserHandler.rb

@@ -0,0 +1,14 @@
+class UserHandler < EntityHandler
+	attr_reader :organizations
+
+	def initialize(origin)
+		super
+
+		@organizations = UserOrganizationsHandler.new(origin)
+	end
+
+	def getInformation
+		return (APIRequest.new(@origin, '/v1/me', 'GET')).exec
+	end
+
+end

data/lib/Handler/User/UserOrganizationsHandler.rb

@@ -0,0 +1,14 @@
+class UserOrganizationsHandler < EntityHandler
+
+	def all(filters = nil)
+		if !filters
+			filters = {}
+		end
+
+		super
+
+		request = APIRequest.new(@origin, '/v1/me/organizations', 'GET')
+		EntityList.new(@origin, request, UserOrganization, filters)
+	end
+
+end

data/lib/leantesting.rb

@@ -0,0 +1,65 @@
+#
+# Lean Testing Ruby Client SDK
+#
+# https://leantesting.com/en/api-docs Adheres to official API guidelines
+#
+
+require_relative 'loader.rb'
+
+module LeanTesting
+	class Client
+		attr_reader \
+			:auth,
+			:user,
+			:projects,
+			:bugs,
+			:attachments,
+			:platform
+
+		attr_accessor :debugReturn
+
+		def initialize
+			@accessToken = nil
+
+			@auth			= OAuth2Handler.new(self)
+			@user			= UserHandler.new(self)
+			@projects		= ProjectsHandler.new(self)
+			@bugs			= BugsHandler.new(self)
+			@attachments	= AttachmentsHandler.new(self)
+			@platform		= PlatformHandler.new(self)
+		end
+
+		#
+		# Function to retrieve curently attached token.
+		#
+		# Returns:
+		#	String  -- if a token is attached
+		#	boolean -- if no token is attached
+		#
+		def getCurrentToken
+			if !@accessToken
+				return false
+			end
+
+			@accessToken
+		end
+
+		#
+		# Function to attach new token to SDK Client instance. Token changes are dynamic; all objects/entities
+		# originating from an instance which has had its token updated will utilize the new token automatically.
+		#
+		# Arguments:
+		# 	accessToken String -- the string of the token to be attached
+		#
+		# Exceptions:
+		#	SDKInvalidArgException if provided accessToken param is not a string
+		#
+		def attachToken(accessToken)
+			if !accessToken.is_a? String
+				raise SDKInvalidArgException, '`accessToken` must be a string'
+			end
+			@accessToken = accessToken
+		end
+
+	end
+end

data/lib/loader.rb

@@ -0,0 +1,18 @@
+# Global inclusions
+require 'bundler'
+Bundler.require(:default)
+
+# Relative autopath inclusion
+sdkRoot = File.dirname(File.absolute_path(__FILE__))
+[
+	'Exception/BaseException/*.rb',
+	'Exception/*.rb',
+
+	'BaseClass/*.rb',
+
+	'Entity/**/*.rb',
+
+	'Handler/**/*.rb'
+].each do |path|
+	Dir.glob(sdkRoot + '/' + path){ |f| require(f) }
+end

data/tests/APIRequestTest.rb

@@ -0,0 +1,152 @@
+require 'bundler'
+Bundler.require(:default, :test)
+
+require_relative '../lib/Client'
+
+class APIRequestTest < MiniTest::Test
+
+	def test_APIRequestDefined
+		APIRequest
+	end
+
+
+
+
+	def test_APIRequestInstanceNonStrEndpoint
+		assert_raises SDKInvalidArgException do
+			APIRequest.new(Client.new, 12751, 'GET')
+		end
+	end
+	def test_APIRequestInstanceNonStrMethod
+		assert_raises SDKInvalidArgException do
+			APIRequest.new(Client.new, '/', 1233)
+		end
+	end
+	def test_APIRequestInstanceSupportedMethod
+		APIRequest.new(Client.new, '/', 'GET')
+		APIRequest.new(Client.new, '/', 'POST')
+		APIRequest.new(Client.new, '/', 'PUT')
+		APIRequest.new(Client.new, '/', 'DELETE')
+	end
+	def test_APIRequestInstanceNonSupportedMethod
+		assert_raises SDKInvalidArgException do
+			APIRequest.new(Client.new, '/', 'XXX')
+		end
+	end
+	def test_APIRequestInstanceNonArrOpts
+		assert_raises SDKInvalidArgException do
+			APIRequest.new(Client.new, '/', 'GET', 12123)
+		end
+	end
+	def test_APIRequestBadJSONResponse
+		req = APIRequest.new(Client.new, '/any/method', 'GET')
+		req.expects(:call).returns({'data'=> '{xxxxxxxxx', 'status'=> 200})
+
+		ex = assert_raises SDKBadJSONResponseException do
+			req.exec
+		end
+		assert_match '{xxxxxxxxx', ex.message
+	end
+
+
+
+
+
+
+	def test_APIRequestExpectedStatus
+		req = APIRequest.new(Client.new, '/any/method', 'GET')
+		req.expects(:call).returns({'data'=> '{"X": "X"}', 'status'=> 200})
+		req.exec
+
+		req = APIRequest.new(Client.new, '/any/method', 'POST')
+		req.expects(:call).returns({'data'=> '{"X": "X"}', 'status'=> 200})
+		req.exec
+
+		req = APIRequest.new(Client.new, '/any/method', 'PUT')
+		req.expects(:call).returns({'data'=> '{"X": "X"}', 'status'=> 200})
+		req.exec
+
+		req = APIRequest.new(Client.new, '/any/method', 'DELETE')
+		req.expects(:call).returns({'data'=> '1', 'status'=> 204})
+		req.exec
+	end
+
+
+
+
+
+
+	def test_APIRequestUnexpectedStatusDELETE
+		req = APIRequest.new(Client.new, '/any/method', 'DELETE')
+		req.expects(:call).returns({'data'=> 'XXXyyy', 'status'=> 200})
+
+		ex = assert_raises SDKErrorResponseException do
+			req.exec
+		end
+		assert_match 'XXXyyy', ex.message
+	end
+
+
+
+
+
+	def test_APIRequestUnexpectedStatusGET
+		req = APIRequest.new(Client.new, '/any/method', 'GET')
+		req.expects(:call).returns({'data'=> 'XXXyyy', 'status'=> 204})
+
+		ex = assert_raises SDKErrorResponseException do
+			req.exec
+		end
+		assert_match 'XXXyyy', ex.message
+	end
+	def test_APIRequestUnexpectedStatusPOST
+		req = APIRequest.new(Client.new, '/any/method', 'POST')
+		req.expects(:call).returns({'data'=> 'XXXyyy', 'status'=> 204})
+
+		ex = assert_raises SDKErrorResponseException do
+			req.exec
+		end
+		assert_match 'XXXyyy', ex.message
+	end
+	def test_APIRequestUnexpectedStatusPUT
+		req = APIRequest.new(Client.new, '/any/method', 'PUT')
+		req.expects(:call).returns({'data'=> 'XXXyyy', 'status'=> 204})
+
+		ex = assert_raises SDKErrorResponseException do
+			req.exec
+		end
+		assert_match 'XXXyyy', ex.message
+	end
+
+
+
+
+	def test_APIRequestEmptyRespGET
+		req = APIRequest.new(Client.new, '/any/method', 'GET')
+		req.expects(:call).returns({'data'=> '{}', 'status'=> 200})
+
+		ex = assert_raises SDKUnexpectedResponseException do
+			req.exec
+		end
+		assert_match 'Empty', ex.message
+	end
+	def test_APIRequestEmptyRespPOST
+		req = APIRequest.new(Client.new, '/any/method', 'POST')
+		req.expects(:call).returns({'data'=> '{}', 'status'=> 200})
+
+		ex = assert_raises SDKUnexpectedResponseException do
+			req.exec
+		end
+		assert_match 'Empty', ex.message
+	end
+	def test_APIRequestEmptyRespPUT
+		req = APIRequest.new(Client.new, '/any/method', 'PUT')
+		req.expects(:call).returns({'data'=> '{}', 'status'=> 200})
+
+		ex = assert_raises SDKUnexpectedResponseException do
+			req.exec
+		end
+		assert_match 'Empty', ex.message
+	end
+
+end

data/tests/BaseClassesTest.rb

@@ -0,0 +1,96 @@
+require 'bundler'
+Bundler.require(:default, :test)
+
+require_relative '../lib/Client'
+
+class BaseClassesTest < MiniTest::Test
+
+	# Entity
+	def test_EntityDefined
+		Entity
+	end
+
+	def test_EntityDataParsing
+		data = {'id' => 1}
+		entity = Entity.new(Client.new, data)
+
+		assert_equal entity.data, data
+	end
+
+	def test_EntityInstanceNonArrData
+		assert_raises SDKInvalidArgException do
+			Entity.new(Client.new, '')
+		end
+	end
+	def test_EntityInstanceEmptyData
+		assert_raises SDKInvalidArgException do
+			Entity.new(Client.new, {})
+		end
+	end
+	# END Entity
+
+
+
+	# EntityHandler
+	def test_EntityHandlerDefined
+		EntityHandler
+	end
+
+	def test_EntityHandlerCreateNonArrFields
+		assert_raises SDKInvalidArgException do
+			EntityHandler.new(Client.new).create('')
+		end
+	end
+	def test_EntityHandlerCreateEmptyFields
+		assert_raises SDKInvalidArgException do
+			EntityHandler.new(Client.new).create({})
+		end
+	end
+
+	def test_EntityHandlerAllNonArrFilters
+		assert_raises SDKInvalidArgException do
+			EntityHandler.new(Client.new).all('')
+		end
+	end
+	def test_EntityHandlerAllInvalidFilters
+		ex = assert_raises SDKInvalidArgException do
+			EntityHandler.new(Client.new).all({'XXXfilterXXX' => 9999})
+		end
+		assert_match 'XXXfilterXXX', ex.message
+	end
+	def test_EntityHandlerAllSupportedFilters
+		EntityHandler.new(Client.new).all({'include' => ''})
+		EntityHandler.new(Client.new).all({'limit' => 10})
+		EntityHandler.new(Client.new).all({'page' => 2})
+	end
+
+	def test_EntityHandlerFindNonIntID
+		assert_raises SDKInvalidArgException do
+			EntityHandler.new(Client.new).find('')
+		end
+	end
+
+	def test_EntityHandlerDeleteNonIntID
+		assert_raises SDKInvalidArgException do
+			EntityHandler.new(Client.new).delete('')
+		end
+	end
+
+	def test_EntityHandlerUpdateNonIntID
+		assert_raises SDKInvalidArgException do
+			EntityHandler.new(Client.new).update('', {'x' => 5})
+		end
+	end
+	def test_EntityHandlerUpdateNonArrFields
+		assert_raises SDKInvalidArgException do
+			EntityHandler.new(Client.new).update(5, '')
+		end
+	end
+	def test_EntityHandlerUpdateEmptyFields
+		assert_raises SDKInvalidArgException do
+			EntityHandler.new(Client.new).update(5, {})
+		end
+	end
+	# END EntityHandler
+
+end