s3_patron 0.0.2 → 0.0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5401d3149d3a10ccc33bca7672fd07ebe1b8ac3
-  data.tar.gz: 8dcfee301097d8ca826d009a1430da0615ca4150
+  metadata.gz: bcd8213be62686995920bd1ab4f8d701185ba94e
+  data.tar.gz: a5823c91f0d69389bc565ec6913946af9f054891
 SHA512:
-  metadata.gz: 13d7eb96bbcf23f5b48a347297fb1e1bbf34033a9213feb84cee0d204281370193618a79e18a60a003cd1754d9a6786fc8e47166d3724f19874a53253a500177
-  data.tar.gz: 2625ec19a26908f934bf4eccdb4d352584d99f651c8faf46c3a178fbc3bdc7e2016032f4236ce14b48b368198837c532be3cc14796d5f6a0977da659e0a5dfb1
+  metadata.gz: ac825c13054b08f5805a9716f529b1b6d0cf4aa5c213435fc9ea242acc7eef15aec3739ff4d27af4bda444b7d2bdfc7b0369a7636988cab7e0f5336070245f1a
+  data.tar.gz: 8f128df75dc287ed73eca60ea6e57af92eaa10be2b30a43611dba07240f2b85180d4d2f72b868d128cab907a6882dd2f8fadb7490f5fcca0ecfe7648e6789ef1

data/README.md

@@ -22,17 +22,81 @@ Set ENV variables
 
 ## Usage
 
+```shell
+#List of Commands:
+$ s3patron buckets [REGION(OPTIONAL)]   # List all buckets
+$ s3patron create [BUCKET_NAME] [REGION(OPTIONAL)]  # create bucket
+$ s3patron download [BUCKET_NAME] [OBJECT] [DOWNLOAD_LOCATION(default=CURRENT DIR)] [REGION(default=ENV[AWS_REGION])] # Download object from bucket
+$ s3patron help [COMMAND] # Describe Commands
+$ s3patron list [BUCKET_NAME] [REGION(OPTIONAL)] # List objects inside bucket
+$ s3patron upload [BUCKET_NAME] [FILE] [REGION(OPTIONAL)] # Upload into bucket
+
+```
+
+#Examples
+
+##List Buckets
+
+```shell
+#Normal
+$ s3patron buckets
+# Will list all buckets in your s3. By default it lists first 50 items
+
+$ s3patron buckets -a
+# passing -a flag will list all items with no limit.
+
+$ s3patron buckets -l 10 #will show first 10 buckets
+# You can customize number of results by passing -l flag followed by limit
+```
+
+##Create Bucket
+
+```shell
+#Normal
+$ s3patron create example_bucket
+# Will create a bucket named example_bucket
+
+#Optional
+# If you do not want to use the AWS REGION defined in env variables you can pass region as next argument to create
+$ s3patron create example_bucket us-east-1
 ```
-Commands:
-  s3patron buckets REGION(OPTIONAL)                                                  # List all buckets
-  s3patron create BUCKET_NAME REGION(OPTIONAL)                                       # create bucket
-  s3patron download BUCKET_NAME OBJECT DOWNLOAD_LOCATION(OPTIONAL) REGION(OPTIONAL)  # Download object from bucket
-  s3patron help [COMMAND]                                                            # Describe Commands
-  s3patron list BUCKET_NAME REGION(OPTIONAL)                                         # List objects inside bucket
-  s3patron upload BUCKET_NAME FILE REGION(OPTIONAL) PATH_TO_FILE                     # Upload into bucket
 
+##List Objects inside the bucket
+
+```shell
+#Normal
+$ s3patron list example_bucket
+# Will list all objects inside example_bucket in your s3. By default it lists first 50 items
+
+$ s3patron list example_bucket -a
+# passing -a flag will list all items with no limit.
+
+$ s3patron list example_bucket -l 10 #will show first 10 buckets
+# You can customize number of results by passing -l flag followed by limit
+```
+
+##Upload into a bucket
+```shell
+#Normal
+$ s3patron upload example_bucket example_file.txt
+# Will upload example_file.txt to example_bucket
+
+#Optional
+# If you do not want to use the AWS REGION defined in env variables you can pass region as next argument
 ```
 
+##Download object from bucket
+```shell
+#Normal
+$ s3patron download example_bucket example_file.txt
+# Will download example_file.txt to current directory
+
+#Optional
+# If you do not want to use the AWS REGION defined in env variables you can pass region as next argument
+```
+
+
+
 ##Rubygems.org
 Hosted at [Rubygems.org](https://rubygems.org/gems/s3_patron)
 

data/lib/s3_patron/cli.rb

@@ -28,7 +28,6 @@ module S3Patron
         end
 
         desc 'upload BUCKET_NAME FILE REGION(OPTIONAL) PATH_TO_FILE', 'Upload into a bucket'
-        method_option :bucket, type: :string, default: false, aliases: '-b', desc: 'Name of the bucket where you want to upload'
         def upload(bucket_name, file, region=ENV['AWS_REGION'])
           s3 = Aws::S3::Resource.new(region: region)
           begin

data/lib/s3_patron/version.rb

@@ -1,3 +1,3 @@
 module S3Patron
-    VERSION = '0.0.2'.freeze
+    VERSION = '0.0.2.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3_patron
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.2.1
 platform: ruby
 authors:
 - Suyesh Bhandari