leantesting 1.0.1 → 1.0.2

data/lib/Handler/Attachment/AttachmentsHandler.rb

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

data/lib/Handler/Auth/OAuth2Handler.rb

@@ -3,116 +3,118 @@
 #
 # leantesting.com/en/api-docs#oauth-flow
 #
-class OAuth2Handler
+module LeanTesting
+	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'
+		#
+		# Constructs an OAuth2Handler instance
+		#
+		# Arguments:
+		#	origin Client -- Originating client reference
+		#
+		def initialize(origin)
+			@origin = origin
 		end
 
-		baseURL = 'https://leantesting.com/login/oauth/authorize'
-
-		params = {
-			'client_id'		=> clientID,
-			'redirect_uri'	=> redirectURI,
-			'scope'			=> scope
-		}
+		#
+		# 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
 
-		if state
-			params['state'] = state
-		end
+			baseURL = 'https://leantesting.com/login/oauth/authorize'
 
-		baseURL += '?' + Curl::postalize(params)
-		baseURL
-	end
+			params = {
+				'client_id'		=> clientID,
+				'redirect_uri'	=> redirectURI,
+				'scope'			=> scope
+			}
 
-	#
-	# 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
+			if state
+				params['state'] = state
+			end
 
-	# 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'
+			baseURL += '?' + Curl::postalize(params)
+			baseURL
 		end
 
-		params = {
-			'grant_type'	=> grantType,
-			'client_id'		=> clientID,
-			'client_secret'	=> clientSecret,
-			'redirect_uri'	=> redirectURI,
-			'code'			=> code
-		}
+		#
+		# 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
 
-		req = APIRequest.new(
-			@origin,
-			'/login/oauth/access_token',
-			'POST',
-			{
-				'base_uri'	=> 'https://leantesting.com',
-				'params'	=> params
+		# 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
 			}
-		)
 
-		resp = req.exec
-		resp['access_token']
-	end
+			req = APIRequest.new(
+				@origin,
+				'/login/oauth/access_token',
+				'POST',
+				{
+					'base_uri'	=> 'https://leantesting.com',
+					'params'	=> params
+				}
+			)
 
-end
+			resp = req.exec
+			resp['access_token']
+		end
+
+	end
+end

data/lib/Handler/Bug/BugAttachmentsHandler.rb

@@ -1,51 +1,53 @@
-class BugAttachmentsHandler < EntityHandler
+module LeanTesting
+	class BugAttachmentsHandler < LeanTesting::EntityHandler
 
-	def initialize(origin, bugID)
-		super(origin)
+		def initialize(origin, bugID)
+			super(origin)
 
-		@bugID = bugID
-	end
+			@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'
+		#
+		# 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
 
-		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
 
-	def all(filters = nil)
-		if !filters
-			filters = {}
-		end
+			super
 
-		super
+			request = APIRequest.new(@origin, '/v1/bugs/' + @bugID.to_s() + '/attachments', 'GET')
+			EntityList.new(@origin, request, BugAttachment, filters)
+		end
 
-		request = APIRequest.new(@origin, '/v1/bugs/' + @bugID.to_s() + '/attachments', 'GET')
-		EntityList.new(@origin, request, BugAttachment, filters)
 	end
-
-end
+end

data/lib/Handler/Bug/BugCommentsHandler.rb

@@ -1,20 +1,22 @@
-class BugCommentsHandler < EntityHandler
+module LeanTesting
+	class BugCommentsHandler < LeanTesting::EntityHandler
 
-	def initialize(origin, bugID)
-		super(origin)
+		def initialize(origin, bugID)
+			super(origin)
 
-		@bugID = bugID
-	end
-
-	def all(filters = nil)
-		if !filters
-			filters = {}
+			@bugID = bugID
 		end
 
-		super
+		def all(filters = nil)
+			if !filters
+				filters = {}
+			end
 
-		request = APIRequest.new(@origin, '/v1/bugs/' + @bugID.to_s() + '/comments', 'GET')
-		EntityList.new(@origin, request, BugComment, filters)
-	end
+			super
 
-end
+			request = APIRequest.new(@origin, '/v1/bugs/' + @bugID.to_s() + '/comments', 'GET')
+			EntityList.new(@origin, request, BugComment, filters)
+		end
+
+	end
+end

data/lib/Handler/Bug/BugsHandler.rb

@@ -1,57 +1,59 @@
-class BugsHandler < EntityHandler
-
-	def find(id)
-		super
-
-		req = APIRequest.new(
-			@origin,
-			'/v1/bugs/' + id.to_s(),
-			'GET',
-			{
-				'params' => {
-					'include' => 'steps,platform,attachments,comments,tags'
+module LeanTesting
+	class BugsHandler < LeanTesting::EntityHandler
+
+		def find(id)
+			super
+
+			req = APIRequest.new(
+				@origin,
+				'/v1/bugs/' + id.to_s(),
+				'GET',
+				{
+					'params' => {
+						'include' => 'steps,platform,attachments,comments,tags'
+					}
 				}
-			}
-		)
-		Bug.new(@origin, req.exec)
-	end
+			)
+			Bug.new(@origin, req.exec)
+		end
 
-	def delete(id)
-		super
+		def delete(id)
+			super
 
-		req = APIRequest.new(@origin, '/v1/bugs/' + id.to_s(), 'DELETE')
-		req.exec
-	end
+			req = APIRequest.new(@origin, '/v1/bugs/' + id.to_s(), 'DELETE')
+			req.exec
+		end
 
-	def update(id, fields)
-		super
-
-		supports = {
-			'title'              => false,
-			'status_id'          => false,
-			'severity_id'        => false,
-			'project_version_id' => false,
-			'project_section_id' => false,
-			'type_id'            => false,
-			'assigned_user_id'   => false,
-			'description'        => false,
-			'expected_results'   => false,
-			'steps'              => false,
-			'platform'           => false
-			# 'device_model'       => false,
-			# 'device_model_id'    => false,
-			# 'os'                 => false,
-			# 'os_version'         => false,
-			# 'os_version_id'      => false,
-			# 'browser_version_id' => false
-		}
-
-		if enforce(fields, supports)
-			fields = {'include' => 'steps,platform'}.merge(fields)
-
-			req = APIRequest.new(@origin, '/v1/bugs/' + id.to_s(), 'PUT', {'params' => fields})
-			Bug.new(@origin, req.exec)
+		def update(id, fields)
+			super
+
+			supports = {
+				'title'              => false,
+				'status_id'          => false,
+				'severity_id'        => false,
+				'project_version_id' => false,
+				'project_section_id' => false,
+				'type_id'            => false,
+				'assigned_user_id'   => false,
+				'description'        => false,
+				'expected_results'   => false,
+				'steps'              => false,
+				'platform'           => false
+				# 'device_model'       => false,
+				# 'device_model_id'    => false,
+				# 'os'                 => false,
+				# 'os_version'         => false,
+				# 'os_version_id'      => false,
+				# 'browser_version_id' => false
+			}
+
+			if enforce(fields, supports)
+				fields = {'include' => 'steps,platform'}.merge(fields)
+
+				req = APIRequest.new(@origin, '/v1/bugs/' + id.to_s(), 'PUT', {'params' => fields})
+				Bug.new(@origin, req.exec)
+			end
 		end
-	end
 
-end
+	end
+end