outreach_gem 1.0.37 → 1.0.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0adfa6265cb32513f8145f00db9446dbe4d27522a1e40514eb7e36d408834434
-  data.tar.gz: e99b5322e266b594cf4937204798e05795684aa2f2e489a01cf52a01e2272243
+  metadata.gz: e11f82793f407e9bb46d76302832203a30e7380104b757bf579fa46e486d3952
+  data.tar.gz: c3d7aca57c254fd66027ffc6c567fd559e862df9643977d9591520b932614870
 SHA512:
-  metadata.gz: f4a2170f0fb0ff51c2ef81f363d88ec316d9a29f7123799f657e8f8206d275bf8be6d7a6aa8a836ead80bd436978046127147993dcbd2cc3fb74b035ab7ff294
-  data.tar.gz: d3f245f548a27362e91eb5de8b8d41bbfa83466c6e6e172122395e2878bca61124e6160aaac0f5672fdc633b5a014c8016691771b5adfa40932946aae6279f86
+  metadata.gz: 1ad71aac9d4f6de54ce180454c58684453c050270e97655edce4ff48ae758e6e628f64a490904f2b1e59e0e7f1480907a8e3d7c687acc48a06a93f87575f400f
+  data.tar.gz: 3c8ddfa553e8a9dd0502c29597c4dafd2200c5aa2089ebee40adac7b6b501a280f63bab42325c0ffb92d1393da6f27eb277dc4fd13c3c843912af3e6e68613b6

data/lib/helpers/helpers.rb

@@ -1,10 +1,19 @@
 class Helpers
 
+    # Used to retrieve the last character of a string
+    # @param string [String] The string that is used to retrieve the last character
+    # @return [String] The last character of the string
+    # @raise [TypeError] if the string is of the wrong type
     def self.getLastCharacter(string)
         raise TypeError unless string.is_a? String
         return string[-1]
     end
 
+    # Remove the last character of a string if the character is a given definition
+    # @param string [String] The string to remove a character from
+    # @param character [String] The character to remove from the string
+    # @return [String] The newly edited string with the removed character
+    # @raise [TypeError] if the character is of the wrong type
     def self.removeLastCharacterIf(string, character)
         raise TypeError unless character.is_a? String
 
@@ -12,6 +21,11 @@ class Helpers
         return string
     end
 
+    # Remove the multiple last character of a string if the character is a given definition
+    # @param string [String] The string to remove a character from
+    # @param characters [String] The character to remove from the string
+    # @return [String] The newly edited string with the removed character
+    # @raise [TypeError] if the character is of the wrong type
     def self.removeMultipleLastCharacterIf(string, characters)
         raise TypeError unless characters.is_a? Array
 
@@ -22,6 +36,12 @@ class Helpers
         return string
     end
 
+    # Replace all characters in a string given a pattern and a replacement string
+    # @param string [String] The string to remove a character from
+    # @param pattern [String] The pattern to be taken into account when analyzing the string
+    # @param replacement [String] The replacement string to use when the pattern is found
+    # @return [String] The newly edited string with the replacement and pattern applied to it
+    # @raise [TypeError] if the string, pattern or the replacement is of the wrong type
     def self.replaceAllCharacter(string, pattern, replacement)
         raise TypeError unless string.is_a? String
         raise TypeError unless pattern.is_a? String

data/lib/rest-client/restfulclient.rb

@@ -3,8 +3,19 @@ require 'json'
 
 require_relative 'resttype'
 
+# Class used to perform HTTP Post and Get operations over the HTTP protocol
 class RestClient
 
+    # Initalize the object to perform the operations
+    # @param uri [String] The URL to perform the request against
+    # @param headers [Hash] Object that resembles the following structure
+    # {
+    #    'Content-Type' => 'application/json'
+    # }
+    # @param rest_type [resttype] Module that defines the type of operation that we are about to perform
+    # @param ssl [Boolean] True -> SSL is enabled. False -> SSL is disabled
+    # @param params [Hash] Is an object that represents the query string parameters to assign to the URL within the give
+    # restful invocation {'state' => 'started'}
     def initialize(uri, headers, rest_type, ssl, params)
         @uri = URI(uri)
         @http = Net::HTTP.new(@uri.host, @uri.port)
@@ -30,42 +41,66 @@ class RestClient
         
     end    
 
+    # Return the URI of the web request
+    # @return [String] URL
     def getURI()
         return @uri.to_s
     end
 
+    # Return the URL's HOST
+    # @return [String] the URL's HOST
     def getHost()
         return @uri.host
     end
 
+    # Return the URL's PORT
+    # @return [Number] the URL's PORT
     def getPort()
         return @uri.port
     end
 
+    # Return the URL's PATH (URI)
+    # @return [String] the URL's URI
     def getPath()
         return @uri.path
     end
 
+    # Return the URL's Query string params
+    # @return [String] the URL's query string params
     def getQuery()
         return @uri.query
     end
 
+    # Set the URL's Query string params
+    # @param params [Hash] The params for the URL
     def setQueryStringParams(params)
         @uri.query = URI.encode_www_form( params )
     end
 
+    # Set the URL's Body
+    # @param content [Hash] The body of the web request.
+    # An example of this is the following data: 
+    # {"action":"coreui_Repository",
+    #     "method":"update"
+    # }.to_json
     def setBody(content)
         @req.body = content
     end
 
+    # Return the body that the webrequest is about the send
+    # @return [Hash] JSON body of the web request
     def getBody()
         return @req.body
     end
 
+    # Perform the HTTP Post request with the given information set within the object
+    # @return [HTTPResponse] Object containing all of the response information
     def post()
         return @http.request(@req)
     end
 
+    # Perform the HTTP GET request with the given information set within the object
+    # @return [HTTPResponse] Object containing all of the response information
     def get()
         return @http.request(@req)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outreach_gem
 version: !ruby/object:Gem::Version
-  version: 1.0.37
+  version: 1.0.46
 platform: ruby
 authors:
 - Patrique Legault