rails_s3_uploader 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 139d3f98e569ddbb1be9e95d54bf99606037c2f526c7981112e24c5a2d5bb0a9
-  data.tar.gz: 7e07b130e856ae8bf482b42599c4a65e5e5a826cdff2270b77c93f3130b3859a
+  metadata.gz: 37706c7dbcb59c11c70fc3743c52270d1c4a7c81b38edefabb50431f1c7c8992
+  data.tar.gz: 2323539b33ffc365ceb253922c28d44b107c17d523d4437868b77e04a7c50601
 SHA512:
-  metadata.gz: bfd90abc4b69ab891b2ec55af6b190a263f6629a6fe2a257ddb7e0f09a1a8a869ac397e7e5fe5fa12ac75be7fa5f122fc3015b96a34c8d8925113291b6494b3a
-  data.tar.gz: 1a404d9730d6b5ac4720cc93309df6e5e19c440e714569b513bd43aa9bcc0bd6fa2b4ecd312c1dd40a2e546ac3a2d3d342b20345883d38fab0a7b2c8f249b383
+  metadata.gz: c30f89ebe5c7551b73a7ff20ff2192f7a20e927ee4a73bf018b422030e9d7899cd585e70d7fc385db164e2d6850fbc0487f4c6402646af254988840f731ad495
+  data.tar.gz: abe71291c35fc435e4d755f0567e861b95ba095995f8b9793589ea6d50ce2a945349d3f3fd1c38e4f5068db8512c0ec06eb80f699dbaec24d4e247983fec5ebb

data/.env.sample

@@ -0,0 +1,4 @@
+AWS_ACCESS_KEY_ID=your_access_key_id
+AWS_SECRET_ACCESS_KEY=your_secret_access_key
+AWS_REGION=your_region
+AWS_BUCKET=your_bucket

data/CHANGELOG.md

@@ -1,2 +1,17 @@
-# CHANGE LOG
+## 0.1.3
 
+- Change readme
+- Change changelog
+- Add MIT License
+
+## 0.1.2
+
+- Change readme
+  
+## 0.1.1
+
+- Add first logic on gem
+
+## 0.1.0
+
+- First release

data/MIT-LICENSE.md

@@ -0,0 +1,5 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,30 @@
 # Rails S3 Uploader
 
-Rails S3 Uploader is a gem in development to facilitate file uploads to Amazon S3 using Active Storage in Rails applications.
+**Rails S3 Uploader** is a gem that facilitates the process of uploading files to cloud storage services, such as **AWS S3**, by integrating flexibly with Active Storage. This gem was developed to offer advanced and customizable features beyond those natively provided by Active Storage.
+
+## Purpose and Key Benefits
+
+The primary purpose of **Rails S3 Uploader** is to provide developers with greater flexibility and control over file management in the cloud. By integrating this gem into your Rails project, you can:
+
+### Customization and Configuration Flexibility
+
+- Easily configure integration with AWS S3 or other cloud storage services through custom storage policies, advanced security, and detailed control over files.
+  
+### Advanced File Handling
+
+- Implement sophisticated operations on files before or after uploading, such as image processing, thumbnail generation, and content validation, automating complex tasks directly within the gem.
+
+### Integration with APIs and External Services
+
+- Easily integrate with external APIs to send notifications, process files in external systems, or integrate with content analysis services to ensure security and compliance.
+
+### Custom Retention and Expiration Policies
+
+- Define custom policies to manage file retention and expiration according to your project's specific requirements.
+
+### Support for Business-Specific Features
+
+- Meet specific business needs, such as version control of files, secure sharing of download links with expiration, and detailed auditing of upload operations.
 
 ---
 
@@ -20,6 +44,18 @@ And run: **bundle install**
 
 **Note:** Full usage documentation will be provided in future versions.
 
+Rails S3 Uploader was developed to facilitate the file upload process to AWS S3 in Ruby on Rails projects. It can be especially useful in projects that need to store and manage files efficiently in the AWS cloud.
+
+### Recommended Project Types
+
+- **Web Applications:** Easily integrate image, document, and other file uploads in web applications built with Ruby on Rails.
+
+- **E-commerce Applications:** Manage product images, catalogs, and media files on e-commerce platforms.
+
+- **Content Management Systems (CMS):** Allow users to upload and manage multimedia content in Rails-based CMS systems.
+
+- **Collaboration Projects:** Facilitate document sharing among users on collaborative platforms.
+
 ## Initial Configuration
 
 #### Environment Variables
@@ -68,11 +104,20 @@ bundle exec rake install
 
 Contributions are welcome! Bug reports and pull requests are welcome on GitHub at *https://github.com/eltonsantos/rails_s3_uploader*.
 
-## Licence
+## Requirements
 
-This gem is available as open-source under the terms of the MIT license.
+- Ruby >= 2.6.0 (recommended 2.7+)
+  
+- Rails >= 6.0 (compatible up to Rails 7)
+  
+- AWS S3 Account: You need an S3 bucket and access credentials to use the rails_s3_uploader gem.
 
+## Contributing to Rails S3 Uploader
 
+Fork, fix, then send a pull request.
 
+## Licence
 
+This gem is available as open-source under the terms of The MIT License (MIT).
 
+Copyright (c) 2024 **Elton Santos, Raquel Fonseca**. See **MIT-LICENSE** for further details.

data/config/initializers/rails_s3_uploader.rb

@@ -0,0 +1,7 @@
+RailsS3Uploader.configure do |config|
+  config.access_key_id = ENV['AWS_ACCESS_KEY_ID']
+  config.secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+  config.region = ENV['AWS_REGION']
+  config.bucket = ENV['AWS_BUCKET']
+end
+  

data/config/storage.yml

@@ -0,0 +1,6 @@
+amazon:
+  service: S3
+  access_key_id: <%= ENV['AWS_ACCESS_KEY_ID'] %>
+  secret_access_key: <%= ENV['AWS_SECRET_ACCESS_KEY'] %>
+  region: <%= ENV['AWS_REGION'] %>
+  bucket: <%= ENV['AWS_BUCKET'] %>

data/lib/rails_s3_uploader/configuration.rb

@@ -0,0 +1,13 @@
+module RailsS3Uploader
+    class Configuration
+      attr_accessor :access_key_id, :secret_access_key, :region, :bucket
+  
+      def initialize
+        @access_key_id = ENV['AWS_ACCESS_KEY_ID']
+        @secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+        @region = ENV['AWS_REGION']
+        @bucket = ENV['AWS_BUCKET']
+      end
+    end
+  end
+  

data/lib/rails_s3_uploader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsS3Uploader
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/rails_s3_uploader.rb

@@ -1,8 +1,22 @@
-# frozen_string_literal: true
-
-require_relative "rails_s3_uploader/version"
-
+require 'aws-sdk-s3'
 module RailsS3Uploader
-  class Error < StandardError; end
-  # Your code goes here...
+  class S3Uploader
+    def initialize
+      @s3_client = Aws::S3::Client.new(
+        access_key_id: RailsS3Uploader.configuration.access_key_id,
+        secret_access_key: RailsS3Uploader.configuration.secret_access_key,
+        region: RailsS3Uploader.configuration.region
+      )
+      @bucket = RailsS3Uploader.configuration.bucket
+    end
+
+    def upload(file, key)
+      obj = Aws::S3::Object.new(bucket_name: @bucket, key: key, client: @s3_client)
+      obj.upload_file(file.path)
+      obj.public_url
+    rescue StandardError => e
+      puts "Error uploading file: #{e.message}"
+      nil
+    end
+  end
 end

data/rails_s3_uploader.gemspec

@@ -1,39 +1,34 @@
-# frozen_string_literal: true
 
 require_relative "lib/rails_s3_uploader/version"
 
 Gem::Specification.new do |spec|
-  spec.name = "rails_s3_uploader"
-  spec.version = RailsS3Uploader::VERSION
-  spec.authors = ["Elton Santos", "Raquel Fonseca"]
-  spec.email = ["eltonaxl@hotmail.com", "raque-leto@hotmail.com"]
-  spec.summary = "Gem that makes it easy to integrate and upload files with AWS S3 using active storage"
-  spec.description = "Gem that makes it easy to integrate and upload files with AWS S3 using active storage. Pay Attention: this gem still is in development. Please CONTRIBUTE!"
-  spec.homepage = "https://github.com/eltonsantos/rails_s3_uploader"
+  spec.name          = "rails_s3_uploader"
+  spec.version       = RailsS3Uploader::VERSION
+  spec.authors       = ["Elton Santos", "Raquel Fonseca"]
+  spec.email         = ["eltonaxl@hotmail.com", "raque-leto@hotmail.com"]
+  spec.summary       = "Gem that makes it easy to integrate and upload files with AWS S3 using Active Storage"
+  spec.description   = "Gem that makes it easy to integrate and upload files to AWS S3 using Active Storage. Pay attention: this gem is still in development. Please CONTRIBUTE!"
+  spec.homepage      = "https://github.com/eltonsantos/rails_s3_uploader"
   spec.required_ruby_version = ">= 2.6.0"
-  spec.license = "MIT"
+  spec.license       = "MIT"
 
   spec.metadata = {
-    "homepage_uri" => spec.homepage,
-    "source_code_uri" => "https://github.com/eltonsantos/rails_s3_uploader",
-    "changelog_uri" => "https://github.com/eltonsantos/rails_s3_uploader/blob/master/CHANGELOG.md",
+    "homepage_uri"   => spec.homepage,
+    "source_code_uri"=> "https://github.com/eltonsantos/rails_s3_uploader",
+    "changelog_uri"  => "https://github.com/eltonsantos/rails_s3_uploader/blob/master/CHANGELOG.md",
   }
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
+  spec.files         = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
       (File.expand_path(f) == __FILE__) ||
         f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
     end
   end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_dependency "rails", ">= 6.0"
+  spec.add_dependency "aws-sdk-s3", "~> 1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_s3_uploader
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Elton Santos
@@ -9,10 +9,38 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-23 00:00:00.000000000 Z
-dependencies: []
-description: 'Gem that makes it easy to integrate and upload files with AWS S3 using
-  active storage. Pay Attention: this gem still is in development. Please CONTRIBUTE!'
+date: 2024-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'Gem that makes it easy to integrate and upload files to AWS S3 using
+  Active Storage. Pay attention: this gem is still in development. Please CONTRIBUTE!'
 email:
 - eltonaxl@hotmail.com
 - raque-leto@hotmail.com
@@ -20,10 +48,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - CHANGELOG.md
+- MIT-LICENSE.md
 - README.md
 - Rakefile
+- config/initializers/rails_s3_uploader.rb
+- config/storage.yml
 - lib/rails_s3_uploader.rb
+- lib/rails_s3_uploader/configuration.rb
 - lib/rails_s3_uploader/version.rb
 - rails_s3_uploader.gemspec
 - sig/rails_s3_uploader.rbs
@@ -52,6 +85,6 @@ requirements: []
 rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
-summary: Gem that makes it easy to integrate and upload files with AWS S3 using active
-  storage
+summary: Gem that makes it easy to integrate and upload files with AWS S3 using Active
+  Storage
 test_files: []