rails_s3_uploader 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +2 -0
  3. data/README.md +62 -15
  4. data/lib/rails_s3_uploader/version.rb +1 -1
  5. metadata +2 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1f23f923809dc8d672c33ee8c1c48ff01e7c03d7e2013f3819e471d7826c3100
4
- data.tar.gz: f6c227b065a2269416735f4f10659d1af450c00582d1f45d50e2594322890e7f
3
+ metadata.gz: 139d3f98e569ddbb1be9e95d54bf99606037c2f526c7981112e24c5a2d5bb0a9
4
+ data.tar.gz: 7e07b130e856ae8bf482b42599c4a65e5e5a826cdff2270b77c93f3130b3859a
5
5
  SHA512:
6
- metadata.gz: ad71e6375a1b30237d80932fcfdd25a4dd7317ebf433ead960be20ea3f89346023f571d492cfb7085d8d3d98dff76d5626b8444ba8f159d4321f2de0bd9f4c60
7
- data.tar.gz: e74b90b556676661e329e2af7e0e7121103b243be520bb0ce052aec3b37b4ce7fbbd94a54e5f99b0dca64a77766afc284ded82edc1c430c637bc31ec9130ebbf
6
+ metadata.gz: bfd90abc4b69ab891b2ec55af6b190a263f6629a6fe2a257ddb7e0f09a1a8a869ac397e7e5fe5fa12ac75be7fa5f122fc3015b96a34c8d8925113291b6494b3a
7
+ data.tar.gz: 1a404d9730d6b5ac4720cc93309df6e5e19c440e714569b513bd43aa9bcc0bd6fa2b4ecd312c1dd40a2e546ac3a2d3d342b20345883d38fab0a7b2c8f249b383
data/CHANGELOG.md ADDED
@@ -0,0 +1,2 @@
1
+ # CHANGE LOG
2
+
data/README.md CHANGED
@@ -1,31 +1,78 @@
1
- # RailsS3Uploader
1
+ # Rails S3 Uploader
2
2
 
3
- TODO: Delete this and the text below, and describe your gem
3
+ Rails S3 Uploader is a gem in development to facilitate file uploads to Amazon S3 using Active Storage in Rails applications.
4
4
 
5
- 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.
5
+ ---
6
6
 
7
7
  ## Installation
8
8
 
9
- 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.
9
+ **Note:** This gem is currently in development and your final version has not yet been released on RubyGems.org.
10
10
 
11
- Install the gem and add to the application's Gemfile by executing:
11
+ To use the development version, add this line to your Gemfile:
12
12
 
13
- $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
13
+ ```ruby
14
+ gem 'rails_s3_uploader', git: 'https://github.com/eltonsantos/rails_s3_uploader.git'
14
15
 
15
- If bundler is not being used to manage dependencies, install the gem by executing:
16
-
17
- $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
16
+ ```
17
+ And run: **bundle install**
18
18
 
19
19
  ## Usage
20
20
 
21
- TODO: Write usage instructions here
21
+ **Note:** Full usage documentation will be provided in future versions.
22
+
23
+ ## Initial Configuration
24
+
25
+ #### Environment Variables
26
+
27
+ Create a **.env** file at the root of your Rails project and add your AWS credentials:
28
+
29
+ ```sh
30
+ AWS_ACCESS_KEY_ID=your_access_key_id
31
+ AWS_SECRET_ACCESS_KEY=your_secret_access_key
32
+ AWS_REGION=your_region
33
+ AWS_BUCKET=your_bucket
34
+ ```
35
+
36
+ ### Initializer
37
+
38
+ Create an initializer in *config/initializers/rails_s3_uploader.rb*:
39
+
40
+ ```ruby
41
+ RailsS3Uploader.configure do |config|
42
+ config.access_key_id = ENV['AWS_ACCESS_KEY_ID']
43
+ config.secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
44
+ config.region = ENV['AWS_REGION']
45
+ config.bucket = ENV['AWS_BUCKET']
46
+ end
47
+ ```
48
+
49
+ ### Development
50
+
51
+ To set up the development environment, clone the repository and install the dependencies:
52
+
53
+ ```sh
54
+ git clone https://github.com/eltonsantos/rails_s3_uploader.git
55
+
56
+ cd rails_s3_uploader
57
+
58
+ bin/setup
59
+ ```
60
+
61
+ You can use *bin/console* for an interactive prompt that allows you to test the code.
62
+
63
+ To install this gem locally, run:
64
+
65
+ ```sh
66
+ bundle exec rake install
67
+ ```
68
+
69
+ Contributions are welcome! Bug reports and pull requests are welcome on GitHub at *https://github.com/eltonsantos/rails_s3_uploader*.
70
+
71
+ ## Licence
72
+
73
+ This gem is available as open-source under the terms of the MIT license.
22
74
 
23
- ## Development
24
75
 
25
- 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.
26
76
 
27
- 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).
28
77
 
29
- ## Contributing
30
78
 
31
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_s3_uploader.
data/lib/rails_s3_uploader/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module RailsS3Uploader
4
- VERSION = "0.1.0"
4
+ VERSION = "0.1.1"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rails_s3_uploader
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elton Santos
@@ -20,6 +20,7 @@ executables: []
20
20
  extensions: []
21
21
  extra_rdoc_files: []
22
22
  files:
23
+ - CHANGELOG.md
23
24
  - README.md
24
25
  - Rakefile
25
26
  - lib/rails_s3_uploader.rb