glitch_auth 0.0.1 → 0.0.2

data/lib/glitch_auth.rb

@@ -1,6 +1,11 @@
+# This class builds a url that can be used to authenticate
+# with the API for Glitch, the game (http://www.glitch.com).
 class Glitch_Auth
 
-	# Default constructor
+	# Default constructor.
+	#
+	# @param [String] token the API token associated with the client's API key
+	# @param [String] redirect_uri the callback URL associated with the client's API key	
 	def initialize(token, redirect_uri)
 	
 		# unique to glitch
@@ -17,14 +22,18 @@ class Glitch_Auth
 	
 	end
 
+
+	# @param [String] value a string specifying the token already associated with this client's API key.
 	def token(value)
 		@token = value
 	end
 	
+	# @param [String] value a string specifying the redirect_uri already associated with this client's API key.
 	def redirect_uri(value)
 		@redirect_uri = value
 	end
 
+	# @param [String] value a string specifying the response_type required.  Must be either 'code' or 'token'.
 	def response_type(value)
 		if (value == 'code' || value == 'token') 								
 			@response_type = value
@@ -33,6 +42,7 @@ class Glitch_Auth
 		end	
 	end
 	
+	# @param [String] value a string specifying the scope of the request. Must be either 'identity', 'read' or 'write'.
 	def scope(value)	
 		if (value == 'identity' || value == 'read' || value == 'write') 								
 			@scope = value
@@ -41,12 +51,14 @@ class Glitch_Auth
 		end
 	end		
 	
+	# @param [String] value a string specifying the state.	
 	def state(value)
 		@state = value
 	end
 
+	# @return [String] a URI for authenticating with Glitch, customised as per the settings specified
 	def uri
-		puts "#{@path}?response_type=#{@response_type}&client_id=#{@token}&redirect_uri=#{@redirect_uri}&scope=#{@scope}&state=#{@state}"		
+		"#{@path}?response_type=#{@response_type}&client_id=#{@token}&redirect_uri=#{@redirect_uri}&scope=#{@scope}&state=#{@state}"		
 	end		
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: glitch_auth
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - martian-a