outreach_gem 1.0.48 → 1.0.56

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2df1cd2c5d1aed81ffc4542db07b6d9ba7497a5f320a1f65fac4b0ef51cfd69
-  data.tar.gz: d80a4b6b1abd07632f198083628806686bfa2fc1dfe27ab1edda8e5a2e905974
+  metadata.gz: '028f837f523d49ef1ec685b2192be60685057045495fda1f6c934b888cb44853'
+  data.tar.gz: 00fe634ca1cf2d7f25226a36424f35daee50123a0f943372fefaab935581f2ad
 SHA512:
-  metadata.gz: 9247df0cb2d4d6ee5aafcb6ffe3fbd4ba22519bb790f6b303495ba2d8ccfe48d856037e5f8b245b959b8723c1f07aa719970f9cacfcdd99b19911879e8e8411f
-  data.tar.gz: a0a3fa8d20e2880b210b018c503e6989731adee1245c0c1a57ffcf8acc7820968fc86db0c370b3187c93fc4027712d0f3a86e286ab5008bb7ae70f4aba3e986f
+  metadata.gz: 19088ea39d4ca3a43d4b0fbeda9610282fef9ad41b453fb950afe37e861dcf057a64ceafa4c9c0d64216e11e4ad175331c83647f5aba58233153b03f2cd0282e
+  data.tar.gz: 5cb67ab49b1d2c9277027d1ef8b2cb14badcdfeb8142ec6ad74f670591eb31181410c8f89a5821495daae17bbbcdc16fdd3bae599d4eedb52f19d4b7c5e55fbe

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

@@ -0,0 +1,79 @@
+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
+
+        if key.empty?
+            raise 'key cannot be empty'
+        end
+
+        if region.empty?
+            raise 'region cannot be empty'
+        end
+
+        if bucketName.empty?
+            raise 'bucketName cannot be empty'
+        end
+        @region = region
+        @bucketName = bucketName
+       
+        Aws.config.update({
+            credentials: Aws::Credentials.new(key, secretKey)
+        })
+        @s3_client = Aws::S3::Client.new({
+            region:            @region,
+            access_key_id:     key,
+            secret_access_key: secretKey
+        })
+    end
+
+    # @param path [String] path to the file that needs to be uploaded
+    # @param key [String] the name of the object to upload
+    def uploadFile(path, key)
+        content = File.read path
+        obj = @s3_client.put_object({
+            body: content,
+            bucket: @bucketName,
+            key: key
+        })
+        return obj
+    end
+
+    # Retrieve an item from S3
+    # @param [string] The key representing the item in the bucket
+    # @return [S3Object] Return the S3 Object if it exists, if not then nil
+    def getItem(item_name)
+        if item_name.nil? or item_name.empty?
+            raise 'Cannot have an empty or nil item to retrieve from S3'
+        end
+        object = @s3_client.get_object(bucket: @bucketName, key: item_name)
+        if object.nil?
+            return nil
+        end
+        return object
+    end
+
+    # Delete the S3Object
+    # @param s3_object [S3Object] Delete the S3 Object from the bucket
+    # @raise RuntimeError object cannot be nil 
+    def deleteFile(key)
+        result = @s3_client.delete_object({
+            bucket: @bucketName, 
+            key: key
+        })
+        return result
+    end
+
+    # Delete the content of the entire bucket
+    def clearBucket()
+        Aws::S3::Resource.new(region:@region).bucket(@bucketName).clear!
+    end
+end

data/lib/outreach_gem.rb

@@ -3,4 +3,7 @@ require_relative 'helpers/helpers'
 
 # Used to perform restful services in Ruby
 require_relative 'rest-client/restfulclient'
-require_relative 'rest-client/resttype'
+require_relative 'rest-client/resttype'
+
+# Used to perform invocations to Amazon S3 in Ruby
+require_relative 'outreach-s3/ruby-upload-s3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outreach_gem
 version: !ruby/object:Gem::Version
-  version: 1.0.48
+  version: 1.0.56
 platform: ruby
 authors:
 - Patrique Legault
@@ -17,6 +17,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/helpers/helpers.rb
+- lib/outreach-s3/ruby-upload-s3.rb
 - lib/outreach_gem.rb
 - lib/rest-client/restfulclient.rb
 - lib/rest-client/resttype.rb