rails_s3_uploader 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f23f923809dc8d672c33ee8c1c48ff01e7c03d7e2013f3819e471d7826c3100
-  data.tar.gz: f6c227b065a2269416735f4f10659d1af450c00582d1f45d50e2594322890e7f
+  metadata.gz: d98b82fb4e84cc13bc28e6b39406244b3f1fc90e2907a83dd362d50690d4323f
+  data.tar.gz: 9cca5b7570b4a62a6cf287b90e744f196d285bb799c0178a295e383973a10a33
 SHA512:
-  metadata.gz: ad71e6375a1b30237d80932fcfdd25a4dd7317ebf433ead960be20ea3f89346023f571d492cfb7085d8d3d98dff76d5626b8444ba8f159d4321f2de0bd9f4c60
-  data.tar.gz: e74b90b556676661e329e2af7e0e7121103b243be520bb0ce052aec3b37b4ce7fbbd94a54e5f99b0dca64a77766afc284ded82edc1c430c637bc31ec9130ebbf
+  metadata.gz: a0a025d7dc499fec9bae84f6317e90de047b2d5be99cd73b74f1df7c506175fb5745b1d6cd44e02068cecf651480dbedf43f84e87f97e20bb4442092abe5247a
+  data.tar.gz: b2b76b8f7dde18c7fa6bdda4fa1201e0d01b0555462fc34e3922dc863877234ad775b50a9e768785ccf371bed27f1036e4965dbbddbe4c56ef3de7dc7c705d32

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

@@ -0,0 +1,2 @@
+# CHANGE LOG
+

data/README.md

@@ -1,31 +1,98 @@
-# RailsS3Uploader
+# Rails S3 Uploader
 
-TODO: Delete this and the text below, and describe your gem
+Rails S3 Uploader is a gem in development to facilitate file uploads to Amazon S3 using Active Storage in Rails applications.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_s3_uploader`. To experiment with that code, run `bin/console` for an interactive prompt.
+---
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+**Note:** This gem is currently in development and your final version has not yet been released on RubyGems.org.
 
-Install the gem and add to the application's Gemfile by executing:
+To use the development version, add this line to your Gemfile:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+gem 'rails_s3_uploader', git: 'https://github.com/eltonsantos/rails_s3_uploader.git'
 
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+And run: **bundle install**
 
 ## Usage
 
-TODO: Write usage instructions here
+**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
+
+Create a **.env** file at the root of your Rails project and add your AWS credentials:
+
+```sh
+AWS_ACCESS_KEY_ID=your_access_key_id
+AWS_SECRET_ACCESS_KEY=your_secret_access_key
+AWS_REGION=your_region
+AWS_BUCKET=your_bucket
+```
+
+### Initializer
+
+Create an initializer in *config/initializers/rails_s3_uploader.rb*:
+
+```ruby
+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
+```
+
+### Development
+
+To set up the development environment, clone the repository and install the dependencies:
+
+```sh
+git clone https://github.com/eltonsantos/rails_s3_uploader.git
+
+cd rails_s3_uploader
+
+bin/setup
+```
+
+You can use *bin/console* for an interactive prompt that allows you to test the code.
+
+To install this gem locally, run:
+
+```sh
+bundle exec rake install
+```
+
+Contributions are welcome! Bug reports and pull requests are welcome on GitHub at *https://github.com/eltonsantos/rails_s3_uploader*.
+
+## Requirements
+
+- 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.
+
+## Licence
+
+This gem is available as open-source under the terms of the MIT license.
 
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_s3_uploader.

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.0"
+  VERSION = "0.1.2"
 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.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Elton Santos
@@ -10,9 +10,37 @@ 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!'
+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,9 +48,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
+- CHANGELOG.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
@@ -51,6 +84,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: []