s3_patron 0.0.2.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ee834c0adc8d8c42f5f666dd151ef4166eca805
+  data.tar.gz: 39b5afc021171e595a5db2972a34d2444322f04e
+SHA512:
+  metadata.gz: 90f7f921c5e3a0a84453ab532226d87b0d0162a115252b8aa8dc352851b072b59cec1620ead4dc30809e9187587e6e71ad176442bd7865195f512298aa4de2e4
+  data.tar.gz: f6c799ab4fcd202f2b01500a2258776538c1043ffa5b83fece38835adf317851b94ef3acdea9bd431d4799f7c46a91c4a558cedeb10a54fdb919826e8e3ad119

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at suyeshb@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in s3_commander.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Suyesh Bhandari
+
+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

@@ -0,0 +1,39 @@
+# S3-Patron - Command-line utility for S3 written in Ruby
+![S3](https://cdn.foliovision.com/images/edd/2016/05/amazon-s3-icon1.png)
+
+S3-Patron lets you list, upload, download to and from s3 using your terminal
+
+
+## Setup
+Make sure [Ruby](https://www.ruby-lang.org/en/documentation/installation/) is installed.
+
+Add this line to your application's Gemfile:
+```
+    $ gem install s3_patron
+```
+
+Set ENV variables
+
+```
+    $ export AWS_ACCESS_KEY_ID="YOUR AWS ACCESS KEY"
+    $ export AWS_SECRET_ACCESS_KEY="YOUR AWS SECERET KEY"
+    $ export AWS_REGION="AWS REGION"
+```
+
+## Usage
+
+```
+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
+
+```
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "s3_patron"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/s3patron

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/s3_patron.rb'
+
+S3Patron::Cli.start(ARGV)

data/lib/s3_patron/cli.rb

@@ -0,0 +1,89 @@
+require 'aws-sdk'
+require 'thor'
+require 'colorize'
+
+module S3Patron
+    class Cli < Thor
+        desc 'list BUCKET_NAME REGION(OPTIONAL)', 'List objects inside of a bucket'
+        method_option :all, type: :boolean, default: false, aliases: '-a', desc: 'List all items'
+        method_option :limit, type: :numeric, default: 50, aliases: '-l', desc: 'Set limit of items to display'
+        def list(bucket, region=ENV['AWS_REGION'])
+          s3 = Aws::S3::Resource.new(region: region)
+          bucket = s3.bucket(bucket)
+          begin
+              if options[:all]
+                  puts "Showing all objects inside bucket named #{bucket.name}.".yellow
+                  bucket.objects.each do |item|
+                    puts item.key
+                  end
+              else
+                  puts "Showing first #{options[:limit]} objects from #{bucket.name}.Use -a flag to show all objects".yellow
+                  bucket.objects.limit(options[:limit]).each do |item|
+                    puts item.key
+                  end
+              end
+          rescue
+              puts 'Something went wrong. Please try again.'.red
+          end
+        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
+            item = file
+            bucket = bucket_name
+            name = File.basename(item)
+            obj = s3.bucket(bucket).object(name)
+            obj.upload_file(item)
+            puts "#{file} successfully uploaded to #{bucket}".yellow
+          rescue
+            puts "Something went wrong. Please try again.".red
+          end
+        end
+
+        desc 'create BUCKET_NAME REGION(OPTIONAL)', 'create a bucket'
+        def create(bucket_name, region=ENV['AWS_REGION'])
+            s3 = Aws::S3::Resource.new(region: region)
+            s3.create_bucket(bucket: bucket_name.to_s)
+            puts "#{bucket_name} successfully created.".yellow
+        rescue Aws::S3::Errors::BucketAlreadyExists
+            puts 'The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.'.red
+        rescue Aws::S3::Errors::InvalidBucketName
+            puts "The specified bucket name is not a valid format based on AWS guidelines.\nFor more info please visit http://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html".red
+        rescue Aws::S3::Errors::BucketAlreadyOwnedByYou
+          puts "There is already an existing bucket with the same name".red
+        end
+
+        desc 'download BUCKET_NAME OBJECT DOWNLOAD_LOCATION(OPTIONAL) REGION(OPTIONAL)', 'Download object from a bucket'
+        method_option :path, type: :string, default: false, aliases: '-p', desc: 'File path of location you want the file to be downloaded.'
+        def download(bucket_name, item, path=Dir.pwd, region=ENV['AWS_REGION'])
+          s3 = Aws::S3::Resource.new(region: region)
+          obj = s3.bucket(bucket_name).object(item)
+          obj.get(response_target: "#{path}/#{obj.key}")
+        end
+
+        desc 'buckets REGION(OPTIONAL)', 'List all the buckets in S3 account'
+        method_option :all, type: :boolean, default: false, aliases: '-a', desc: 'List all Items'
+        method_option :limit, type: :numeric, default: 50, aliases: '-l', desc: 'Set limit of items to display'
+        def buckets(region=ENV['AWS_REGION'])
+            s3 = Aws::S3::Resource.new(region: region)
+            begin
+                if options[:all]
+                    puts 'Showing all buckets.'.yellow
+                    s3.buckets.each do |b|
+                        puts b.name.to_s
+                    end
+                else
+                    puts "Showing first #{options[:limit]} buckets.Use -a flag to show all listings".yellow
+                    s3.buckets.limit(options[:limit]).each do |b|
+                        puts b.name.to_s
+                    end
+                end
+            rescue
+                puts 'Something went wrong. Please try again.'.red
+            end
+        end
+    end
+end

data/lib/s3_patron/version.rb

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

data/lib/s3_patron.rb

@@ -0,0 +1,6 @@
+require_relative "s3_patron/version.rb"
+require_relative "s3_patron/cli.rb"
+
+module S3Patron
+  # Your code goes here...
+end

data/s3_patron.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 's3_patron/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "s3_patron"
+  spec.version       = S3Patron::VERSION
+  spec.authors       = ["Suyesh Bhandari"]
+  spec.email         = ["suyeshb@gmail.com"]
+
+  spec.summary       = "Command-line utility to manage S3"
+  spec.description   = "Command-line utility to manage S3"
+  spec.homepage      = "https://github.com/suyesh/s3_patron"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_dependency 'thor', '~> 0.19.4'
+  spec.add_dependency 'aws-sdk', '~> 2.6', '>= 2.6.35'
+  spec.add_dependency 'colorize'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: s3_patron
+version: !ruby/object:Gem::Version
+  version: 0.0.2.pre
+platform: ruby
+authors:
+- Suyesh Bhandari
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.4
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.35
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.35
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Command-line utility to manage S3
+email:
+- suyeshb@gmail.com
+executables:
+- s3patron
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/s3patron
+- lib/s3_patron.rb
+- lib/s3_patron/cli.rb
+- lib/s3_patron/version.rb
+- s3_patron.gemspec
+homepage: https://github.com/suyesh/s3_patron
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Command-line utility to manage S3
+test_files: []