s3_utils 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85e08887f108e1d5a9f9ebd68b8e5040c3c8050f
+  data.tar.gz: 7fdfc58af701270d945d3e4db02cbbc34cf0b2ce
+SHA512:
+  metadata.gz: 502e4edf9005ebed5f0e1f07943c49a4dfe9d388e275f8fcdfa3b7d1a824c7219bd594a056ecf1ad06a17e0d516f39cf3c28d19e605dc195be8b9212e394373f
+  data.tar.gz: 0c8d94cc30df96972dd128250eb3a98da6e102d5a7398d8b990b2f86f05a12db71669490619ea1ba176e9fd86ee36fbbecde91e362aaaf2a209864d0d18acac2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.1
+branches:
+  only:
+    - master
+env:
+  global:
+    - AWS_ACCESS_KEY_ID=xxxx
+    - AWS_SECRET_ACCESS_KEY=yyyy

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 MOGI Hiromu
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 mgi166
+
+MIT License
+
+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,147 @@
+[![Coverage Status](https://coveralls.io/repos/mgi166/s3_utils/badge.png?branch=master)](https://coveralls.io/r/mgi166/s3_utils?branch=master)
+[![Code Climate](https://codeclimate.com/github/mgi166/s3_utils/badges/gpa.svg)](https://codeclimate.com/github/mgi166/s3_utils)
+
+# S3Utils
+Simple s3 modules in order to download, upload, copy and delete the file on s3.  
+It is a wrapper of `aws-sdk`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install s3_utils
+
+## dependency
+
+* [aws-sdk](https://github.com/aws/aws-sdk-ruby)
+
+## Usage
+
+```ruby
+require 's3_utils'
+```
+
+This module has some methods.
+
+* `#upload_to_s3`
+   * uploads the file in local to s3
+* `#download_from_s3`
+   * downloads from the file into local path
+* `#copy_on_s3`
+   * copies the file on s3 to other as `FileUtils.cp`
+* `#delete_on_s3`
+   * deletes the file on s3 as `FileUtils.rm`
+* `#create_on_s3`
+   * creates the file on s3 as `File.open`
+* `#read_on_s3`
+   * read the file on s3 as `File.read`
+
+### Using module includion
+
+```ruby
+require 's3_utils'
+
+include S3Utils
+
+upload_to_s3('path/to/local_file.txt', 's3.bucket.name/path/to/upload_file.txt')
+#=> upload to s3!
+
+download_from_s3('s3.bucket.name/path/to/upload_file.txt', 'path/to/local_file.txt')
+#=> download from s3!
+```
+
+### Using module function
+```ruby
+require 's3_utils'
+
+S3Utils.upload_to_s3("path/to/local_file.txt", "s3.bucket.name/path/to/dir/")
+#=> upload to "s3://s3.bucket.name/path/to/dir/local_file.txt"
+
+S3Utils.create_on_s3("s3.bucket.name/path/to/test.txt") do |f|
+  f.puts "This is the sample text"
+end
+#=> create the file "s3.bucket.name/path/to/test.txt" that has contents "This is the sample text"
+```
+
+## Methods
+### upload_to_s3
+Uploads the file in local path to s3.  
+when destination url has the string end with "/", upload the local file under the directory.
+
+```ruby
+S3Utils.upload_to_s3('path/to/local_file.txt', 's3.bucket.name/path/to/upload_file.txt')
+#=> Upload from "path/to/local_file.txt" to "s3.bucket.name/path/to/upload_file.txt"
+
+S3Utils.upload_to_s3("path/to/local_file.txt", "s3.bucket.name/path/to/dir/")
+#=> Upload from "path/to/local_file.txt" to "s3://s3.bucket.name/path/to/dir/local_file.txt"
+```
+
+### download_from_s3
+Downloads the file in s3 to local path.  
+When local path is directory, download to under the local directory.
+
+```ruby
+S3Utils.download_from_s3('s3.bucket.name/path/to/upload_file.txt', 'path/to/local_file.txt')
+#=> Download from "s3.bucket.name/path/to/upload_file.txt" to "path/to/local_file.txt"
+
+# path/to/dir is directory
+S3Utils.download_from_s3('s3.bucket.name/path/to/upload_file.txt', 'path/to/dir')
+#=> Donwload from "s3.bucket.name/path/to/upload_file.txt" to "path/to/dir/upload_file.txt"
+```
+
+### copy_on_s3
+Copy the file in s3 to another.  
+
+```ruby
+S3Utils.copy_on_s3('s3.bucket.com/path/to/source.txt', 's3.bucket.com/path/to/dest.txt')
+#=> Copy from "s3.bucket.com/path/to/source.txt" to "s3.bucket.com/path/to/dest.txt"
+```
+
+### delete_on_s3
+Delete the file in s3.  
+
+```ruby
+S3Utils.delete_on_s3('s3.bucket.com/path/to/source.txt')
+#=> Delete "s3.bucket.com/path/to/source.txt"
+```
+
+### create_on_s3
+Create the file in s3.  
+If block given, it will be passed the File object and uploads to s3.
+
+```ruby
+S3Utils.create_on_s3('s3.bucket.com/path/to/file.txt')
+#=> Create "s3.bucket.com/path/to/source.txt" but it is empty file
+
+S3Utils.create_on_s3('s3.bucket.com/path/to/file.txt') do |f|
+  f.puts "the file in s3"
+end
+#=> Create "s3.bucket.com/path/to/source.txt" and it has the contents "the file in s3"
+```
+
+### read_on_s3
+Read the file in s3.  
+
+```ruby
+# s3.bucket.com/path/to/file.txt has contents "abcdefg"
+S3Utils.read_on_s3('s3.bucket.com/path/to/file.txt')
+#=> abcdefg
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/s3_utils/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/s3_utils.rb

@@ -0,0 +1,8 @@
+require 'aws-sdk'
+require 's3_utils/path'
+require 's3_utils/generator'
+require 's3_utils/method'
+
+module S3Utils
+  include Method
+end

data/lib/s3_utils/generator.rb

@@ -0,0 +1,32 @@
+module S3Utils
+  class Generator
+    def initialize(path)
+      @path = Path.new(path)
+    end
+
+    def bucket
+      s3.buckets[@path.bucket_name]
+    end
+
+    def s3_object(path=nil)
+      base_path = @path.path_without_bucket
+      dest_path = path ? File.join(base_path, path) : base_path
+      bucket.objects[dest_path]
+    end
+
+    def s3_object_collection(path=nil)
+      base_path = @path.path_without_bucket
+      bucket.objects.with_prefix(base_path)
+    end
+
+    def tree
+      bucket.as_tree(prefix: @path.path_without_bucket)
+    end
+
+    private
+
+    def s3
+      ::AWS::S3.new
+    end
+  end
+end

data/lib/s3_utils/method.rb

@@ -0,0 +1,86 @@
+require 'tempfile'
+
+module S3Utils
+  module Method
+    def self.included(klass)
+      klass.extend(self)
+    end
+
+    def upload_to_s3(src, dest)
+      g = Generator.new(dest)
+
+      case
+      when File.file?(src)
+        filename = File.basename(src.to_s) if dest.to_s.end_with?('/')
+        g.s3_object(filename).write(file: src)
+      when File.directory?(src)
+        Dir[File.join(src, '**', '*')].each do |path|
+          next if File.directory?(path)
+          g.s3_object(path).write(file: path)
+        end
+      else
+        Dir[src].each do |path|
+          g.s3_object(path).write(file: path)
+        end
+      end
+    end
+
+    def download_from_s3(src, dest)
+      g = Generator.new(src)
+
+      if g.s3_object.exists?
+        download_path = File.directory?(dest) ? File.join(dest, File.basename(src)) : dest
+        File.open(download_path, 'w') do |f|
+          g.s3_object.read { |chunk| f.write(chunk) }
+        end
+      else
+        file_objects = g.tree.children(&:reaf?).map(&:object)
+
+        file_objects.each do |obj|
+          next unless obj.exists?
+
+          base_dir = File.basename(File.dirname(obj.key))
+          obj_name = File.basename(obj.key)
+
+          unless Dir.exist?(File.join(dest, base_dir))
+            Dir.mkdir(File.join(dest, base_dir))
+          end
+
+          File.open(File.join(dest, base_dir, obj_name), 'w') do |f|
+            obj.read { |chunk| f.write(chunk) }
+          end
+        end
+      end
+    end
+
+    def copy_on_s3(src, dest)
+      gs = Generator.new(src)
+      gd = Generator.new(dest)
+
+      gs.s3_object.copy_to(gd.s3_object)
+    end
+
+    def delete_on_s3(path)
+      g = Generator.new(path)
+      g.s3_object.delete
+    end
+
+    def create_on_s3(path)
+      @tmp = Tempfile.new('')
+      g = Generator.new(path)
+
+      File.open(@tmp, "w") do |f|
+        yield f if block_given?
+      end
+
+      g.s3_object.write(file: @tmp.path)
+    ensure
+      @tmp.close! if @tmp
+    end
+
+    def read_on_s3(path)
+      g = Generator.new(path)
+      g.s3_object.read.chomp
+    end
+  end
+end

data/lib/s3_utils/path.rb

@@ -0,0 +1,24 @@
+require 'pathname'
+
+module S3Utils
+  class Path
+    def initialize(path)
+      @path = Pathname.new(path)
+    end
+
+    def bucket_name
+      return '' if @path.to_s.empty? || @path.to_s == '.'
+
+      element[0].to_s.empty? ? element[1] : element[0]
+    end
+
+    def path_without_bucket
+      ele = element.drop_while(&:empty?).drop(1)
+      File.join(ele)
+    end
+
+    def element
+      @element ||= @path.cleanpath.to_s.split(Pathname::SEPARATOR_PAT)
+    end
+  end
+end

data/lib/s3_utils/version.rb

@@ -0,0 +1,3 @@
+module S3Utils
+  VERSION = "0.0.1"
+end

data/s3_utils.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 's3_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "s3_utils"
+  spec.version       = S3Utils::VERSION
+  spec.authors       = ["mgi166"]
+  spec.email         = ["skskoari@gmail.com"]
+  spec.summary       = %q{Simple s3 modules in order to download, upload, copy and delete the file on s3.}
+  spec.description   = %q{Simple s3 modules in order to download, upload, copy and delete the file on s3.}
+  spec.homepage      = "https://github.com/mgi166/s3_utils"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fakes3"
+  spec.add_development_dependency "coveralls"
+end

data/spec/lib/s3_utils/generator_spec.rb

@@ -0,0 +1,102 @@
+require 'fakes3/server'
+
+describe S3Utils::Generator do
+  before(:all) do
+    @pid = fork do
+      FakeS3::Server.new('0.0.0.0', 12345, FakeS3::FileStore.new('/var/tmp/fakes3'), 'localhost').serve
+    end
+    AWS.config(s3_endpoint: 'localhost', s3_force_path_style: true, s3_port: 12345, use_ssl: false)
+  end
+
+  after(:all) do
+    Process.kill(:TERM, @pid) rescue nil
+  end
+
+  describe '#bucket' do
+    let(:generator) { S3Utils::Generator.new('bucket/fuga/hoge') }
+
+    it 'returns AWS::S3::Bucket instance' do
+      expect(generator.bucket).to be_instance_of AWS::S3::Bucket
+    end
+
+    it 'has names bucket name' do
+      expect(generator.bucket.name).to eq('bucket')
+    end
+  end
+
+  describe '#s3_object' do
+    let(:generator) { S3Utils::Generator.new('bucket/fuga/hoge') }
+
+    context 'no given the argument of path' do
+      it 'returns AWS::S3::Object' do
+        expect(generator.s3_object).to be_instance_of AWS::S3::S3Object
+      end
+
+      it 'has the path' do
+        expect(generator.s3_object.key).to eq('fuga/hoge')
+      end
+
+      it 'has the bucket' do
+        expect(generator.s3_object.bucket).to eq(::AWS::S3.new.buckets['bucket'])
+      end
+    end
+
+    context 'given the argument of path' do
+      it 'returns AWS::S3::Object' do
+        expect(generator.s3_object('bazz/spec.txt')).to be_instance_of AWS::S3::S3Object
+      end
+
+      it 'has the path' do
+        expect(generator.s3_object('bazz/spec.txt').key).to eq('fuga/hoge/bazz/spec.txt')
+      end
+
+      it 'has the bucket' do
+        expect(generator.s3_object.bucket).to eq(::AWS::S3.new.buckets['bucket'])
+      end
+    end
+  end
+
+  describe '#s3_object_collection' do
+    let(:generator) { S3Utils::Generator.new('s3.bucket.com/fuga') }
+
+    context 'when the objects exists in s3' do
+      before do
+        create_on_s3('s3.bucket.com/fuga/hoge.txt') {|f| f.puts '' }
+        create_on_s3('s3.bucket.com/fuga/fuga.txt') {|f| f.puts '' }
+      end
+
+      after do
+        delete_on_s3('s3.bucket.com/fuga/hoge.txt')
+        delete_on_s3('s3.bucket.com/fuga/fuga.txt')
+      end
+
+      it 'returns the instance of AWS::S3::ObjectCollection' do
+        expect(generator.s3_object_collection).to be_instance_of AWS::S3::ObjectCollection
+      end
+
+      it 'returns the s3 objects under the directory' do
+        expect(
+          generator.s3_object_collection.to_a
+        ).to eq([S3Utils::Generator.new('s3.bucket.com/fuga/fuga.txt').s3_object, S3Utils::Generator.new('s3.bucket.com/fuga/hoge.txt').s3_object])
+      end
+    end
+  end
+
+  describe '#tree' do
+    let(:generator) { S3Utils::Generator.new('s3.bucket.com/fuga') }
+
+    before do
+      create_on_s3('s3.bucket.com/fuga/hoge.txt') {|f| f.puts '' }
+    end
+
+    it 'returns the instance of AWS::S3::Tree' do
+      expect(generator.tree).to be_instance_of AWS::S3::Tree
+    end
+
+    it 'returns the tree that has files in the argument directory' do
+      expect(
+        generator.tree.children.map(&:key)
+      ).to eq(['fuga/hoge.txt'])
+    end
+  end
+end

data/spec/lib/s3_utils/path_spec.rb

@@ -0,0 +1,109 @@
+require 'tmpdir'
+
+describe S3Utils::Path do
+  def path(p)
+    described_class.new(p)
+  end
+
+  describe '.initialize' do
+    context 'when the argument is the Object#to_str' do
+      it 'returns S3Utils::Path instance' do
+        expect(described_class.new('dev.spec.bucket.com')).to be_instance_of S3Utils::Path
+      end
+    end
+
+    context 'when the argument is nil(not response_to? #to_str)' do
+      it 'raise TypeError' do
+        expect do
+          described_class.new(nil)
+        end.to raise_error TypeError
+      end
+    end
+  end
+
+  describe '#bucket_name' do
+    context 'when the path is likely path of file' do
+      it 'returns the first of dirname' do
+        expect(path('bucket/fuga/hoge').bucket_name).to eq('bucket')
+      end
+    end
+
+    context 'when the path includes "//"' do
+      it 'returns the first of dirname' do
+        expect(path('bucket//fuga/hoge').bucket_name).to eq('bucket')
+      end
+    end
+
+    context 'when the path includes ".."' do
+      it 'returns the first of dirname with cleanpath' do
+        expect(path('bucket/../fuga/hoge').bucket_name).to eq('fuga')
+      end
+    end
+
+    context 'when the path includes "."' do
+      it 'returns the first of dirname with cleanpath' do
+        expect(path('./bucket/./fuga/hoge').bucket_name).to eq('bucket')
+      end
+    end
+
+    context 'when the path starts with "/"' do
+      it 'returns the first of dirname removed the "/"' do
+        expect(path('/bucket/fuga/hoge').bucket_name).to eq('bucket')
+      end
+    end
+
+    context 'when the path is empty string' do
+      it 'returns the empty' do
+        expect(path('').bucket_name).to be_empty
+      end
+    end
+
+    context 'when the path is "."' do
+      it 'returns the empty' do
+        expect(path('.').bucket_name).to be_empty
+      end
+    end
+  end
+
+  describe '#path_without_bucket' do
+    it 'returns the dirname without bucket' do
+      expect(path('bucket/fuga/hoge').path_without_bucket).to eq('fuga/hoge')
+    end
+
+    context 'when the path includes "//"' do
+      it 'returns the first of dirname' do
+        expect(path('bucket//fuga/hoge').path_without_bucket).to eq('fuga/hoge')
+      end
+    end
+
+    context 'when the path includes ".."' do
+      it 'returns the first of dirname with cleanpath' do
+        expect(path('bucket/../fuga/hoge').path_without_bucket).to eq('hoge')
+      end
+    end
+
+    context 'when the path includes "."' do
+      it 'returns the first of dirname with cleanpath' do
+        expect(path('./bucket/./fuga/hoge').path_without_bucket).to eq('fuga/hoge')
+      end
+    end
+
+    context 'when the path starts with "/"' do
+      it 'returns the first of dirname removed the "/"' do
+        expect(path('/bucket/fuga/hoge').path_without_bucket).to eq('fuga/hoge')
+      end
+    end
+
+    context 'when the path is empty string' do
+      it 'returns the empty' do
+        expect(path('').path_without_bucket).to be_empty
+      end
+    end
+
+    context 'when the path is "."' do
+      it 'returns the empty' do
+        expect(path('.').path_without_bucket).to be_empty
+      end
+    end
+  end
+end

data/spec/lib/s3_utils_spec.rb

@@ -0,0 +1,322 @@
+require 'tmpdir'
+require 'fakes3/server'
+
+describe S3Utils do
+  before(:all) do
+    @pid = fork do
+      FakeS3::Server.new('0.0.0.0', 12345, FakeS3::FileStore.new('/var/tmp/fakes3'), 'localhost').serve
+    end
+    AWS.config(s3_endpoint: 'localhost', s3_force_path_style: true, s3_port: 12345, use_ssl: false)
+  end
+
+  after(:all) do
+    Process.kill(:TERM, @pid) rescue nil
+  end
+
+  def create_tempfile(string)
+    src = Tempfile.new('src')
+    src.write(string)
+    src.close
+    src
+  end
+
+  describe '.upload_to_s3' do
+    context 'when source is file(not dest path end with "/")' do
+      before do
+        delete_on_s3('s3.bucket.com/spec/path')
+      end
+
+      it 'exists the upload file after #upload_to_s3' do
+        src = create_tempfile("aaa")
+
+        expect do
+          S3Utils.upload_to_s3(src.path, 's3.bucket.com/spec/path')
+        end.to change {
+          s3_object('s3.bucket.com/spec/path').exists?
+        }.from(false).to(true)
+      end
+
+      it 'uploads the file to dest path' do
+        src = create_tempfile("hoge\nfuga")
+
+        S3Utils.upload_to_s3(src.path, 's3.bucket.com/spec/path')
+
+        expect(
+          read_on_s3('s3.bucket.com/spec/path')
+        ).to eq("hoge\nfuga")
+      end
+    end
+
+    context 'when source is file(and dest path end with "/")' do
+      before do
+        delete_on_s3('s3.bucket.com/spec/path')
+      end
+
+      after { FileUtils.remove_entry_secure(@dir) if Dir.exist?(@dir) }
+
+      it 'uploads the file to under the dest path' do
+        @dir = Dir.mktmpdir
+        File.open(File.join(@dir, '1.txt'), 'w') {|f| f.puts "hogehoge" }
+
+        S3Utils.upload_to_s3(File.join(@dir, '1.txt'), 's3.bucket.com/spec/path/')
+
+        expect(
+          read_on_s3('s3.bucket.com/spec/path/1.txt')
+        ).to eq('hogehoge')
+      end
+    end
+
+    context 'when source is directory' do
+      before do
+        delete_on_s3('s3.bucket.com/spec/path')
+
+        @dir = Dir.mktmpdir
+        File.open(File.join(@dir, '1.txt'), 'w') {|f| f.puts "The one" }
+        File.open(File.join(@dir, '2.txt'), 'w') {|f| f.puts "The two" }
+      end
+
+      after { FileUtils.remove_entry_secure(@dir) if Dir.exist?(@dir) }
+
+      it 'uploads the file with directoy to dest path' do
+        S3Utils.upload_to_s3(@dir, 's3.bucket.com/spec/path')
+
+        expect(
+          read_on_s3("s3.bucket.com/spec/path/#{@dir}/1.txt")
+        ).to eq('The one')
+
+        expect(
+          read_on_s3("s3.bucket.com/spec/path/#{@dir}/2.txt")
+        ).to eq('The two')
+      end
+    end
+
+    context 'when source includes "*"' do
+      before do
+        delete_on_s3('s3.bucket.com/spec/path')
+
+        @dir = Dir.mktmpdir
+        File.open(File.join(@dir, 'abc1.txt'), 'w') {|f| f.puts "The abc1" }
+        File.open(File.join(@dir, 'def1.txt'), 'w') {|f| f.puts "The def" }
+        File.open(File.join(@dir, 'abc2.txt'), 'w') {|f| f.puts "The abc2" }
+      end
+
+      after { FileUtils.remove_entry_secure(@dir) if Dir.exist?(@dir) }
+
+      it "uploads the fnmatch file and doesn't upload not fmatch file" do
+        S3Utils.upload_to_s3("{#@dir}/abc*.txt", 's3.bucket.com/spec/path')
+
+        expect(
+          read_on_s3("s3.bucket.com/spec/path/#{@dir}/abc1.txt")
+        ).to eq('The abc1')
+
+        expect(
+          read_on_s3("s3.bucket.com/spec/path/#{@dir}/abc2.txt")
+        ).to eq('The abc2')
+
+        expect(
+          s3_object("s3.bucket.com/spec/path/#{@dir}/def1").exists?
+        ).to be false
+      end
+    end
+  end
+
+  describe '.download_from_s3' do
+    context 'when dest path is directory' do
+      before do
+        delete_on_s3('s3.bucket.com/spec/path')
+        create_on_s3('s3.bucket.com/spec/path/hoge.txt') {|f| f.write "hoge"}
+        @dir = Dir.mktmpdir
+      end
+
+      after { FileUtils.remove_entry_secure(@dir) if Dir.exist?(@dir) }
+
+      it 'downloads the file in the directory' do
+        S3Utils.download_from_s3('s3.bucket.com/spec/path/hoge.txt', @dir)
+
+        expect(File.read("#{@dir}/hoge.txt")).to eq('hoge')
+      end
+    end
+
+    context 'when dest path is file' do
+      before do
+        delete_on_s3('s3.bucket.com/spec/path')
+        create_on_s3('s3.bucket.com/spec/path/fuga.txt') {|f| f.write "fuga"}
+        @dir = Dir.mktmpdir
+      end
+
+      after { FileUtils.remove_entry_secure(@dir) if Dir.exist?(@dir) }
+
+      it 'downloads the file as local file' do
+        dest_file = File.join(@dir, 'fuga.txt')
+        S3Utils.download_from_s3('s3.bucket.com/spec/path/fuga.txt', dest_file)
+
+        expect(File.read(dest_file)).to eq('fuga')
+      end
+    end
+
+    describe 'when the src is directory' do
+      context 'the dest directory is already exists' do
+        before do
+          delete_on_s3('s3.bucket.com/spec/path')
+          create_on_s3('s3.bucket.com/spec/path/fuga.txt') {|f| f.write "fuga"}
+          create_on_s3('s3.bucket.com/spec/path/bazz.txt') {|f| f.write "bazz"}
+          @dir = Dir.mktmpdir
+        end
+
+        after { FileUtils.remove_entry_secure(@dir) if Dir.exist?(@dir) }
+
+        it 'downloads the directory in dest directory' do
+          S3Utils.download_from_s3('s3.bucket.com/spec/path', @dir)
+          expect(Dir["#{@dir}/path/**/*"]).to eq([ "#{@dir}/path/bazz.txt", "#{@dir}/path/fuga.txt"])
+        end
+      end
+    end
+  end
+
+  describe '.copy_on_s3' do
+    before do
+      delete_on_s3('s3.bucket.com/spec/path')
+      create_on_s3('s3.bucket.com/spec/path/hoge.txt') {|f| f.write "hoge"}
+    end
+
+    it 'copy src object to dest' do
+      S3Utils.copy_on_s3('s3.bucket.com/spec/path/hoge.txt', 's3.bucket.com/spec/path/fuga.txt')
+
+      expect(
+        read_on_s3("s3.bucket.com/spec/path/fuga.txt")
+      ).to eq('hoge')
+    end
+  end
+
+  describe '.delete_on_s3' do
+    context 'when the argument is file on s3' do
+      before do
+        create_on_s3('s3.bucket.com/spec/path/hoge.txt') {|f| f.write "hoge"}
+      end
+
+      it 'returns nil' do
+        expect(
+          S3Utils.delete_on_s3('s3.bucket.com/spec/path/dir/hoge.txt')
+        ).to be_nil
+      end
+
+      it 'deletes the argument file on s3' do
+        expect do
+          S3Utils.delete_on_s3('s3.bucket.com/spec/path/hoge.txt')
+        end.to change {
+          s3_object('s3.bucket.com/spec/path/hoge.txt').exists?
+        }.from(true).to(false)
+      end
+    end
+
+    context 'when the argument is directory on s3' do
+      before do
+        create_on_s3('s3.bucket.com/spec/path/dir/hoge.txt') {|f| f.write "hoge"}
+      end
+
+      it 'deletes the argument directory on s3' do
+        expect do
+          S3Utils.delete_on_s3('s3.bucket.com/spec/path/dir')
+        end.to change {
+          s3_object('s3.bucket.com/spec/path/dir/hoge.txt').exists?
+        }.from(true).to(false)
+      end
+    end
+
+    context "when the argument doesn't exist on s3" do
+      before do
+        delete_on_s3('s3.bucket.com/spec/path/dir/hoge.txt')
+      end
+
+      it 'returns nil' do
+        expect(
+          S3Utils.delete_on_s3('s3.bucket.com/spec/path/dir/hoge.txt')
+        ).to be_nil
+      end
+
+      it 'keeps of not existance' do
+        expect do
+          S3Utils.delete_on_s3('s3.bucket.com/spec/path/dir/hoge.txt')
+        end.to_not change {
+          s3_object('s3.bucket.com/spec/path/dir/hoge.txt').exists?
+        }.from(false)
+      end
+    end
+  end
+
+  describe '.create_on_s3' do
+    context "when the file doesn't exist on s3" do
+      before do
+        delete_on_s3('s3.bucket.com/spec/path')
+      end
+
+      it 'creates the file on s3' do
+        S3Utils.create_on_s3('s3.bucket.com/spec/path/test.txt') do |f|
+          f.puts "aaaa"
+          f.puts "bbbb"
+          f.puts "cccc"
+        end
+
+        expect(
+          read_on_s3('s3.bucket.com/spec/path/test.txt')
+        ).to eq("aaaa\nbbbb\ncccc")
+      end
+    end
+
+    context 'when the file already exist on s3' do
+      before do
+        create_on_s3('s3.bucket.com/spec/path/test.txt') do |f|
+          f.puts "already exist"
+        end
+      end
+
+      it 'overwrites the contents' do
+        S3Utils.create_on_s3('s3.bucket.com/spec/path/test.txt') do |f|
+          f.puts "overwrite the contents"
+        end
+
+        expect(
+          read_on_s3('s3.bucket.com/spec/path/test.txt')
+        ).to eq("overwrite the contents")
+      end
+    end
+
+    context 'when no block given' do
+      before do
+        delete_on_s3('s3.bucket.com/spec/path/test.txt')
+      end
+
+      it 'creates empty file on s3' do
+        S3Utils.create_on_s3('s3.bucket.com/spec/path/test.txt')
+
+        expect(read_on_s3('s3.bucket.com/spec/path/test.txt')).to be_empty
+      end
+    end
+  end
+
+  describe '.read_on_s3' do
+    context 'when the file exists' do
+      before do
+        create_on_s3('s3.bucket.com/spec/path/test.txt') {|f| f.puts "test" }
+      end
+
+      it 'returns the String that the file contains' do
+        expect(
+          S3Utils.read_on_s3('s3.bucket.com/spec/path/test.txt')
+        ).to eq('test')
+      end
+    end
+
+    context "when the file doesn't exists" do
+      before do
+        delete_on_s3('s3.bucket.com/spec/path/test.txt')
+      end
+
+      it 'raises error' do
+        expect do
+          S3Utils.read_on_s3('s3.bucket.com/spec/path/test.txt')
+        end.to raise_error AWS::S3::Errors::NoSuchKey
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 's3_utils'
+require 'support/s3_helper'
+
+RSpec.configure do |config|
+  config.include S3Helper
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.warnings = true
+  config.order = :random
+end

data/spec/support/s3_helper.rb

@@ -0,0 +1,42 @@
+module S3Helper
+  def read_on_s3(path)
+    s3_object(path).read.chomp
+  end
+
+  def delete_on_s3(path)
+    s3_object(path).delete
+  end
+
+  def create_on_s3(path, &block)
+    @tmp = Tempfile.new('')
+
+    File.open(@tmp, "w") do |f|
+      yield f
+    end
+
+    s3_object(path).write(file: @tmp.path)
+  ensure
+    @tmp.close
+  end
+
+  def s3_object(path)
+    bucket  = bucket(path)
+    s3_path = s3_path(path)
+
+    s3.buckets[bucket].objects[s3_path]
+  end
+
+  private
+
+  def bucket(path)
+    path.split('/', -1).first
+  end
+
+  def s3_path(path)
+    path.split('/', -1).drop(1).join('/')
+  end
+
+  def s3
+    @s3 ||= ::AWS::S3.new
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: s3_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- mgi166
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-13 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakes3
+  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: coveralls
+  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'
+description: Simple s3 modules in order to download, upload, copy and delete the file
+  on s3.
+email:
+- skskoari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/s3_utils.rb
+- lib/s3_utils/generator.rb
+- lib/s3_utils/method.rb
+- lib/s3_utils/path.rb
+- lib/s3_utils/version.rb
+- s3_utils.gemspec
+- spec/lib/s3_utils/generator_spec.rb
+- spec/lib/s3_utils/path_spec.rb
+- spec/lib/s3_utils_spec.rb
+- spec/spec_helper.rb
+- spec/support/s3_helper.rb
+homepage: https://github.com/mgi166/s3_utils
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple s3 modules in order to download, upload, copy and delete the file
+  on s3.
+test_files:
+- spec/lib/s3_utils/generator_spec.rb
+- spec/lib/s3_utils/path_spec.rb
+- spec/lib/s3_utils_spec.rb
+- spec/spec_helper.rb
+- spec/support/s3_helper.rb