outreach_gem 1.0.64 → 1.0.67

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 583dff6caf5e5700c26a3766da985bd101e81dfe13ebae98bf93924a91d37d9a
-  data.tar.gz: a447fcad60f655a2a10ea121edad7c6b9082f85a0a55e19e1a0a8d11a7455907
+  metadata.gz: 0f72dc1dff996479f5a0a725ea651a48102a58c16bbbb6377e9e509a54404d73
+  data.tar.gz: 252281ca2bccdb707471f400392e4944d0f6dddccb0a6d3f87b29fdf407d0008
 SHA512:
-  metadata.gz: a4a529882416d94d0bd19ce7e219d2a633109ca9572967c594d4d0dd33ffa3f7fac5a104c74c0758dfc241a61853861ba5b41313342710c275cfc69f7c7a1a7b
-  data.tar.gz: 9a956842d3b53f63689e8c1aad159b766071124e2f36edac565a9645116c68199c2ef00cf7c7626963ca33f53d014777f13e4f8449142e705f121c758122656e
+  metadata.gz: 7894c74041e00d3367661de5f5e63aafef6406f66c287610c8b453ce8457866f181182685ac4d27d264ab137677d23641d6b929c11fdff21b524a87cb8bacd82
+  data.tar.gz: 03aaca9b98badd37c8d56320ad7a9846a622c48a4433ea31684d8081fc69a0589b9080697503ca4917e632f293cad7a7de8503750a7c141814adfa514b74fd93

data/lib/outreach-s3/ruby-upload-s3.rb

@@ -2,36 +2,42 @@ require 'aws-sdk-s3'
 
 class OutreachUploadS3
 
-    # @param key [String] Name of the key used to access AWS
-    # @param secret [String] Name of the secret key used to access AWS
-    # @param region [String] Name of the region of the bucket
-    # @param bucketName [String] Name of the S3 Bucket
-    def initialize(key, secretKey, region, bucketName)
-        if secretKey.empty?
-            raise 'secretKey cannot be empty'
-        end
+    # @param parameters Is an object that represents the parameters for the initialization of this component 
+    # example of input format: 
+    # outreachClient = OutreachUploadS3.new(
+    #     key: ENV['S3_ACCESS_KEY'], [String] Name of the key used to access AWS
+    #     secretKey: ENV['S3_SECRET_KEY'], [String] Name of the secret key used to access AWS
+    #     region: 'us-west-2', [String] Name of the region of the bucket
+    #     bucketName: 'fb3e8922-fcb9-4042-b9f3-3f041602b5d3' [String] Name of the S3 Bucket
+    # )
 
-        if key.empty?
+    def initialize(parameters)
+        if parameters.fetch(:key, nil).nil?
             raise 'key cannot be empty'
         end
+        
+        if parameters.fetch(:secretKey, nil).nil?
+            raise 'secretKey cannot be empty'
+        end
 
-        if region.empty?
+        if parameters.fetch(:region, nil).nil?
             raise 'region cannot be empty'
         end
 
-        if bucketName.empty?
+        if parameters.fetch(:bucketName, nil).nil?
             raise 'bucketName cannot be empty'
         end
-        @region = region
-        @bucketName = bucketName
+
+        @region = parameters.fetch(:region)
+        @bucketName = parameters.fetch(:bucketName)
        
         Aws.config.update({
-            credentials: Aws::Credentials.new(key, secretKey)
+            credentials: Aws::Credentials.new(parameters.fetch(:key), parameters.fetch(:secretKey))
         })
         @s3_client = Aws::S3::Client.new({
             region:            @region,
-            access_key_id:     key,
-            secret_access_key: secretKey
+            access_key_id:     parameters.fetch(:key),
+            secret_access_key: parameters.fetch(:secretKey)
         })
     end
 

data/lib/rest-client/restfulclient.rb

@@ -7,35 +7,58 @@ require_relative 'resttype'
 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
+    # @param parameters [Hash] Is an object that represents the parameters for the initialization of this component
     # restful invocation {'state' => 'started'}
-    def initialize(uri, headers, rest_type, ssl, params)
-        @uri = URI(uri)
+    # example of input format: 
+    # RestClient.new(
+    # uri: 'https://api.travis-ci.com/repo/AES-Outreach%2FForms-Application/builds',  ([String] The URL to perform the request against)
+    # headers: { [Hash] Object that resembles the following structure
+    #     'Content-Type' => 'application/json'
+    # },
+    # rest_type: RestTypes::GET, [resttype] Module that defines the type of operation that we are about to perform
+    # ssl: true, [Boolean] True -> SSL is enabled. False -> SSL is disabled
+    # params:  {'state' => 'started'} [Hash] Is an object that represents the query string parameters to assign to the URL within the give
+    # )
+
+
+    def initialize(parameters)
+        
+        if parameters.fetch(:uri, nil).nil?
+            raise 'uri cannot be empty'
+        end
+
+        if parameters.fetch(:headers, nil).nil?
+            raise 'headers cannot be empty'
+        end
+
+        if parameters.fetch(:rest_type, nil).nil?
+            raise 'rest_type cannot be empty'
+        end
+        
+        if parameters.fetch(:ssl, nil).nil?
+            raise 'ssl cannot be empty'
+        end
+
+
+        @uri = URI(parameters.fetch(:uri))
         @http = Net::HTTP.new(@uri.host, @uri.port)
 
-        if ssl === true
+        if parameters.fetch(:ssl) === true
             @http.use_ssl = true
         end
         
-        if params.nil?
-            if RestTypes::POST === rest_type
-                @req = Net::HTTP::Post.new(@uri.path, headers)
-            elsif  RestTypes::GET === rest_type
-                @req = Net::HTTP::Get.new(@uri.path, headers)
+        if parameters.fetch(:params, nil).nil?
+            if RestTypes::POST === parameters.fetch(:rest_type)
+                @req = Net::HTTP::Post.new(@uri.path, parameters.fetch(:headers))
+            elsif  RestTypes::GET === parameters.fetch(:rest_type)
+                @req = Net::HTTP::Get.new(@uri.path, parameters.fetch(:headers))
             end
         else
-            @uri.query = URI.encode_www_form( params )
-            if RestTypes::POST === rest_type
-                @req = Net::HTTP::Post.new(@uri.path + '?' + @uri.query, headers)
-            elsif  RestTypes::GET === rest_type
-                @req = Net::HTTP::Get.new(@uri.path + '?' + @uri.query, headers)
+            @uri.query = URI.encode_www_form(parameters.fetch(:params))
+            if RestTypes::POST === parameters.fetch(:rest_type)
+                @req = Net::HTTP::Post.new(@uri.path + '?' + @uri.query, parameters.fetch(:headers))
+            elsif  RestTypes::GET === parameters.fetch(:rest_type)
+                @req = Net::HTTP::Get.new(@uri.path + '?' + @uri.query, parameters.fetch(:headers))
             end
         end
         

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: outreach_gem
 version: !ruby/object:Gem::Version
-  version: 1.0.64
+  version: 1.0.67
 platform: ruby
 authors:
 - Patrique Legault
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-12 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: patrique.legault@uottawa.ca