easys3 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a1e2d235a905bd32bc7c922d753fd734912fd98d5479feaa0c734f63009f4a7
+  data.tar.gz: 7ae9af3be235986e2c670d3dc243865d000a59f5f6b58940fed6e5885be1192d
+SHA512:
+  metadata.gz: 0e250f98d5030a512fb3be93e502f5525e3111be174e949ceaca80a00c671db914c4cb1ee36018034c9ab3fd7cb3ab997ce7b1f792967baa0559d52e4a59a77c
+  data.tar.gz: 610f5cc8f6dc36f9b9dfc765d6e86f311d6299341c509ad0357dd09fcb5e5fac976c3ea994ed3bf90626986d82027f925601e1d9d5f6ccd04f5abc924b7af931

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# ignore .env
+bin/.env
+.env
+
+# ignore bundle
+vendor/bundle
+
+# ignore other unnecessary files
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

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 yuyasato@icloud.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 easys3.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 chienomi
+
+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,108 @@
+# Easys3
+
+Putting files to S3 & getting files from S3 should be one liner. In reality, you might be confused with tricky behavior of official `aws-sdk` gem. With `easys3`, `Easys3.put(bucket_name, file_name, file, acl)` means putting files to s3 and `Easys3.get(bucket_name, file_name)` means getting a file from s3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easys3'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easys3
+
+## Usage
+
+### [Prerequisite] create your `.env` file
+```
+AWS_ACCESS_KEY_ID=...
+AWS_SECRET_ACCESS_KEY=...
+AWS_S3_REGION=...
+```
+
+##### FYI: Known AWS regions include:
+
+```
+ap-east-1
+ap-northeast-1
+ap-northeast-2
+ap-south-1
+ap-southeast-1
+ap-southeast-2
+ca-central-1
+eu-central-1
+eu-north-1
+eu-west-1
+eu-west-2
+eu-west-3
+sa-east-1
+us-east-1
+us-east-2
+us-west-1
+us-west-2
+cn-north-1
+cn-northwest-1
+us-gov-east-1
+us-gov-west-1
+```
+
+
+### Putting a file to s3
+```ruby
+Easys3.put(bucket_name, file_name, file, acl)
+```
+
+#### example response (success)
+```ruby
+{:status=>201, :data=>#<struct Aws::S3::Types::PutObjectOutput ... }
+```
+
+#### example response (failure)
+```ruby
+{:status=>500, :message=>#<Aws::Errors::NoSuchEndpointError: ... }
+```
+
+### Getting a file from s3
+```ruby
+Easys3.get(bucket_name, file_name)
+```
+
+#### example response (success)
+```ruby
+{:status=>200, :data=>"abc"}
+```
+
+#### example response (failure - 404)
+```ruby
+{:status=>404, :message=>"Could not find file: test/missing.log in the bucket: test-bucket"}
+```
+
+#### example response (failure - 500)
+```ruby
+{:status=>500, :message=>#<Aws::Errors::NoSuchEndpointError: ... }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, 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/chienomi/easys3. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Easys3 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/easys3/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "easys3"
+
+# 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(__FILE__)

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/easys3.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "easys3/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "easys3"
+  spec.version       = Easys3::VERSION
+  spec.authors       = ["chienomi"]
+  spec.email         = ["yuyasato@icloud.com"]
+
+  spec.summary       = %q{Put files to s3 & get files from s3 with single line of code.}
+  spec.description   = %q{Put files to s3 & get files from s3 with single line of code.}
+  spec.homepage      = "https://github.com/chienomi/easys3"
+  spec.license       = "MIT"
+
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency "aws-sdk"
+  spec.add_runtime_dependency "dotenv"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/easys3/error_handler.rb

@@ -0,0 +1,28 @@
+require "dotenv"
+Dotenv.overload()
+
+module ErrorHandler
+  def self.check_aws_region()
+    if !ENV["AWS_S3_REGION"] || ENV["AWS_S3_REGION"] == ""
+      raise "AWS_S3_REGION=... is missing in your .env file. Select your region from https://docs.aws.amazon.com/general/latest/gr/rande.html"
+    end
+  end
+
+  def self.check_aws_access_key()
+    if !ENV["AWS_ACCESS_KEY_ID"] || ENV["AWS_ACCESS_KEY_ID"] == ""
+      raise "AWS_ACCESS_KEY_ID=... is missing in your .env file"
+    end
+  end
+
+  def self.check_aws_secret_access_key()
+    if !ENV["AWS_SECRET_ACCESS_KEY"] || ENV["AWS_SECRET_ACCESS_KEY"] == ""
+      raise "AWS_SECRET_ACCESS_KEY=... is missing in your .env file"
+    end
+  end
+
+  def self.check_aws_bucket_name()
+    if !ENV["AWS_S3_REGION"] || ENV["AWS_S3_REGION"] == ""
+      raise "AWS_S3_REGION=.. is missing in your .env file"
+    end
+  end
+end

data/lib/easys3/response.rb

@@ -0,0 +1,23 @@
+module Response
+  def self.success(data, status=200)
+    return {
+      "status": status,
+      "data": data
+    }
+  end
+
+  def self.missing(message)
+    return {
+      "status": 404,
+      "message": message
+    }
+  end
+
+  def self.error(message)
+    return {
+      "status": 500,
+      "message": message
+    }
+  end
+
+end

data/lib/easys3/s3_handler.rb

@@ -0,0 +1,35 @@
+require "dotenv"
+Dotenv.overload()
+require "aws-sdk"
+
+module S3Handler
+  def self.get_s3_resorce(ignore_keys=false)
+    ErrorHandler.check_aws_region()
+
+    if ignore_keys
+      return Aws::S3::Resource.new(
+          region: ENV["AWS_S3_REGION"],
+        )
+    end
+
+    ErrorHandler.check_aws_access_key()
+    ErrorHandler.check_aws_secret_access_key()
+
+    return Aws::S3::Resource.new(
+        region: ENV["AWS_S3_REGION"],
+        access_key_id: ENV["AWS_ACCESS_KEY_ID"],
+        secret_access_key: ENV["AWS_SECRET_ACCESS_KEY"],
+      )
+  end
+
+
+  def self.get_bucket(bucket_name, ignore_keys=false)
+    ErrorHandler.check_aws_region()
+    s3 = S3Handler.get_s3_resorce(ignore_keys)
+    return s3.bucket(bucket_name)
+  end
+
+  def self.file_exists?(bucket, file_name)
+    return bucket.object(file_name).exists?
+  end
+end

data/lib/easys3/version.rb

@@ -0,0 +1,3 @@
+module Easys3
+  VERSION = "1.0.0"
+end

data/lib/easys3.rb

@@ -0,0 +1,63 @@
+require "easys3/version"
+require "easys3/error_handler"
+require "easys3/response"
+require "easys3/s3_handler"
+
+
+module Easys3
+  class Error < StandardError; end
+
+  def self.get(bucket_name, file_name)
+    begin
+      Easys3.get_without_rescue(bucket_name, file_name, ignore_keys=true)
+    rescue
+      begin
+        Easys3.get_without_rescue(bucket_name, file_name, ignore_keys=false)
+      rescue Exception => e
+        return Response.error(e)
+      end
+    end
+  end
+
+
+  def self.get_without_rescue(bucket_name, file_name, ignore_keys=false)
+    bucket = S3Handler.get_bucket(bucket_name, ignore_keys=ignore_keys)
+
+    if !S3Handler.file_exists?(bucket, file_name)
+      return Response.missing("Could not find file: " + file_name + " in the bucket: " + bucket.name)
+    end
+
+    data = bucket.object(file_name).get.body.read()
+    return Response.success(data)
+  end
+
+
+  def self.put(bucket_name, file_name, file, acl=nil)
+
+    # bucket.object(file_name).put(body: file, acl: 'public-read')
+
+    begin
+      return Easys3.put_without_rescue(bucket_name, file_name, file, ignore_keys=true)
+    rescue
+      begin
+        return Easys3.put_without_rescue(bucket_name, file_name, file, ignore_keys=false)
+      rescue Exception => e
+        return Response.error(e)
+      end
+    end
+  end
+
+
+  def self.put_without_rescue(bucket_name, file_name, file, acl=nil, ignore_keys=false)
+    bucket = S3Handler.get_bucket(bucket_name, ignore_keys=ignore_keys)
+
+    if acl
+      response = bucket.object(file_name).put(body: file, acl: acl)
+    else
+      response = bucket.object(file_name).put(body: file)
+    end
+
+    return Response.success(response, status=201)
+  end
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: easys3
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- chienomi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Put files to s3 & get files from s3 with single line of code.
+email:
+- yuyasato@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easys3.gemspec
+- lib/easys3.rb
+- lib/easys3/error_handler.rb
+- lib/easys3/response.rb
+- lib/easys3/s3_handler.rb
+- lib/easys3/version.rb
+homepage: https://github.com/chienomi/easys3
+licenses:
+- MIT
+metadata: {}
+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: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Put files to s3 & get files from s3 with single line of code.
+test_files: []