s3-wrapper 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ea2f51f491d9026afee758db3e811e7a3e47540
+  data.tar.gz: 07507769240ee196fdb98f071b8d86897de6d2fa
+SHA512:
+  metadata.gz: 8742a60dcddf948726fd007fe27a134e8e082d7242b1dda4d8a445fd34c89dbb1bd0ac13c8a8b03a24a535b7529b3994dca5ec0ba5549da9dcb51829d9e1a67c
+  data.tar.gz: 1b0b97123e6a8bee99187961c83cd4aba431e2097dc9f20c8e2f10d9a403516cf3ce7b134f7394e3642d76c136a9c718f2be102a43cf63441958c05a3790bfd1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+bundler_args: --without development --deployment --jobs=3 --retry=3
+cache: bundler
+rvm:
+  - 2.2.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in s3-wrapper.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Carl
+
+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,40 @@
+# s3-wrapper
+
+This gem copies file to s3. It's especially useful to copy backup to s3 in organized structure.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3-wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install s3-wrapper
+
+## Usage
+
+Make your profile and upload files to s3.
+
+```bash
+s3-wrapper config-default aws_access_key='aws-access-key' aws_secret_key='aws-secret-key' bucket_name='some-bucket-to-use' host_name='name-of-host-to-backup'
+s3-wrapper create-profile 'profile-name' key1=value1 key2=value2
+s3-wrapper update-profile 'profile-name' key1=value1 key2=value2
+s3-wrapper delete-profile 'profile-name'
+
+s3-wrapper upload 'profile-name' file1 file2
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/carl8899/s3-wrapper/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,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task(:default).clear
+task :default => :spec

data/bin/s3-wrapper

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 's3-wrapper'
+
+command = ARGV.shift
+if command == "config-default"
+	params = Hash[ ARGV.join(' ').scan(/([^=\s]+)(?:=(\S+))?/) ]
+	profile = S3Wrapper::Profile.config_default(params)
+	if profile
+		puts "configured default"
+	else
+		puts "failed to configure default"
+	end
+else
+	profile_name = ARGV.shift
+	profile = S3Wrapper::Profile.get(profile_name)
+
+	case command
+	when "create-profile"
+		params = Hash[ ARGV.join(' ').scan(/([^=\s]+)(?:=(\S+))?/) ]
+		profile = S3Wrapper::Profile.create(profile_name, params)
+		puts "created #{profile.name}" if profile
+	when "get-profile"
+		if profile
+			puts "name: #{profile.name}"
+			puts "aws_access_key: #{profile.aws_access_key}"
+			puts "aws_secret_key: #{profile.aws_secret_key}"
+			puts "bucket_name: #{profile.bucket_name}"
+			puts "host_name: #{profile.host_name}"
+		end
+	when "delete-profile"
+		S3Wrapper::Profile.delete(profile.name)
+	when "upload"
+		if profile
+			S3Wrapper.upload_files(profile, ARGV)
+			puts "done"
+		end
+	end
+end

data/lib/s3-wrapper.rb

@@ -0,0 +1,57 @@
+require "s3-wrapper/version"
+require "s3-wrapper/profile"
+require 'aws-sdk'
+
+class S3Wrapper
+  attr_accessor :profile
+  attr_reader :aws_access_key, :aws_secret_key, :bucket_name, :host_name, :s3
+
+  def self.upload_files(profile, files)
+    wrapper = S3Wrapper.new(profile)
+    files.each do |file|
+      wrapper.upload_file(file)
+    end
+  end
+
+  def initialize(profile)
+    self.profile = profile
+    AWS.config(access_key_id: aws_access_key, secret_access_key: aws_secret_key, region: 'us-west-2')
+  end
+
+  def aws_access_key
+    profile.aws_access_key
+  end
+
+  def aws_secret_key
+    profile.aws_secret_key
+  end
+
+  def bucket_name
+    profile.bucket_name
+  end
+
+  def host_name
+    profile.host_name
+  end
+
+  def profile_name
+    profile.name
+  end
+
+  def s3
+    @s3 ||= AWS::S3.new()
+  end
+
+  def bucket
+    @bucket ||= s3.buckets[bucket_name]
+  end
+
+  def upload_file(file)
+    puts "Uploading #{file}"
+    today = Time.now.strftime("%Y%m%d")
+    key = File.basename(file)
+    key = "#{host_name}/#{profile_name}/#{today}/#{key}"
+    bucket.objects[key].delete
+    bucket.objects[key].write(file: file, acl: :authenticated_read)
+  end
+end

data/lib/s3-wrapper/profile.rb

@@ -0,0 +1,62 @@
+require 'yaml'
+
+class S3Wrapper
+  class Profile
+    attr_accessor :name, :aws_access_key, :aws_secret_key, :bucket_name, :host_name
+    CONFIG_FILE = '.s3-wrapper.rc'
+
+    def self.config_default(params)
+      self::create('default', params)
+    end
+
+    def self.create(name, params)
+      config = read_config(name)
+      params.each do |key, value|
+        config[name][key] = value
+      end
+      self::write_config(config)
+      S3Wrapper::Profile.new(name, config[name])
+    end
+
+    def self.delete(name)
+      config = read_config(name)
+      config.delete(name)
+      self::write_config(config)
+    end
+
+    def self.get(name)
+      config = read_config(name)
+      S3Wrapper::Profile.new(name, config[name])
+    end
+
+    def initialize(name, params = {})
+      self.name = name
+      params.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    def to_hash
+      Hash[*instance_variables.map { |v|
+        [v.to_sym, instance_variable_get(v)]
+      }.flatten]
+    end
+
+    private
+    def self.read_config(name)
+      config = {}
+      begin
+        config = File.open(CONFIG_FILE) { |f| YAML.load(f) }
+      rescue
+
+      end
+      config = {} unless config
+      config[name] = {} unless config[name]
+      config
+    end
+
+    def self.write_config(config)
+      open(CONFIG_FILE, 'w+') { |f| YAML.dump(config, f) }
+    end
+  end
+end

data/lib/s3-wrapper/version.rb

@@ -0,0 +1,3 @@
+class S3Wrapper
+  VERSION = "0.1.2"
+end

data/s3-wrapper.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 's3-wrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "s3-wrapper"
+  spec.version       = S3Wrapper::VERSION
+  spec.authors       = ["Carl Blomberg"]
+  spec.email         = ["carlblomberg@gmail.com"]
+  spec.summary       = %q{Upload files into AWS S3}
+  spec.description   = %q{Upload files into AWS S3. It's designed to upload files under predefined hierachy.}
+  spec.homepage      = "https://github.com/carl8899/s3-wrapper"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "aws-sdk", "~> 1.54"
+end

data/spec/lib/s3-wrapper/profile_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe S3Wrapper::Profile do
+  
+end

data/spec/lib/s3-wrapper_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+RSpec.describe S3Wrapper do
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,90 @@
+require File.expand_path("../../lib/s3-wrapper", __FILE__)
+require 'spec_prepare'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/spec_prepare.rb

@@ -0,0 +1,15 @@
+module S3Wrapper::Test
+	def self.profile
+		S3Wrapper::Profile.get('default')
+	end
+
+  def self.test_connection
+    @test_connection ||= AWS::S3.new(access_key_id: profile.aws_access_key, secret_access_key: profile.aws_secret_key)
+  end
+end
+
+RSpec.configure do |config|
+  config.before :suite do
+    S3Wrapper::Test.test_connection
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: s3-wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Carl Blomberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+description: Upload files into AWS S3. It's designed to upload files under predefined
+  hierachy.
+email:
+- carlblomberg@gmail.com
+executables:
+- s3-wrapper
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/s3-wrapper
+- lib/s3-wrapper.rb
+- lib/s3-wrapper/profile.rb
+- lib/s3-wrapper/version.rb
+- s3-wrapper.gemspec
+- spec/lib/s3-wrapper/profile_spec.rb
+- spec/lib/s3-wrapper_spec.rb
+- spec/spec_helper.rb
+- spec/spec_prepare.rb
+homepage: https://github.com/carl8899/s3-wrapper
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Upload files into AWS S3
+test_files:
+- spec/lib/s3-wrapper/profile_spec.rb
+- spec/lib/s3-wrapper_spec.rb
+- spec/spec_helper.rb
+- spec/spec_prepare.rb