exel-s3 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8936d6a5957afc15092d755de27ebfdc8f8b5538
+  data.tar.gz: 73473d824eeb3851f0bc58700805abe63bb682d3
+SHA512:
+  metadata.gz: 8e8fda44139bedd03056d12abbf883d96e9ca29812754983554699cf397dbd6b629fd51c18d255c30303dc3caa6198b09a28e4f0d9ca4007d10f63877c2c186a
+  data.tar.gz: 4e14a6f528fe780dc68be98ccaae651ad0ebf56e6da467784973d12a98e90b148fb0364d3f6da403f750ac86dbf3e7e38bef2fa8147f47142a7f9746094b4744

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+*.iml
+.ruby-*

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,17 @@
+require:
+  - rubocop-rspec
+  - rubocop/rspec/focused
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayStyleGuide: true
+
+Metrics/LineLength:
+  Max: 120
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+RSpec/DescribedClass:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,17 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-12-14 10:00:47 -0500 using RuboCop version 0.35.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/exel/s3.rb'
+    - 'lib/exel/s3/s3_provider.rb'
+    - 'lib/exel/s3/version.rb'

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exel-s3.gemspec
+gemspec
+
+gem 'exel', git: 'https://github.com/47colborne/exel'

data/Guardfile

@@ -0,0 +1,21 @@
+group :rspec_rubocop, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec' do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :rubocop do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 yroo
+
+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,44 @@
+# EXEL::S3
+
+[![Build Status](https://snap-ci.com/47colborne/exel-s3/branch/master/build_image)](https://snap-ci.com/47colborne/exel-s3/branch/master)
+
+This gem implements a "remote provider" for [EXEL](https://github.com/47colborne/exel) using Amazon S3. The remote provider is used when an async command is executed and a context shift occurs. Its job is to move the context to a remote storage location when the async call is initiated, and retrieve it before the async block is executed.
+
+Typically, this gem would be used in conjunction with an EXEL async provider, such as [exel-sidekiq](https://github.com/47colborne/exel-sidekiq). In this case, the context is serialized and uploaded to S3 from the machine making the async call, then downloaded by the Sidekiq worker before it executes the async block.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exel-s3'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exel-s3
+
+## Usage
+
+By requiring this gem, EXEL will automatically be configured to use S3 to upload and download the serialized context when an async command is executed.
+
+The following configuration must be provided:
+
+    EXEL.configure do |config|
+        config.aws = OpenStruct.new(
+            access_key_id: 'your AWS access key ID',
+            secret_access_key: 'your AWS secret access key'
+        )
+      
+        config.s3_bucket = 'the name of the bucket to use'
+    end
+
+## Contributing
+
+1. Fork it ( https://github.com/47colborne/exel-s3/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 @@
+require 'bundler/gem_tasks'

data/exel-s3.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exel/s3/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'exel-s3'
+  spec.version       = EXEL::S3::VERSION
+  spec.authors       = ['yroo']
+  spec.email         = ['dev@yroo.com']
+  spec.summary       = 'Makes EXEL use S3 to store files during context shifts.'
+  spec.description   = 'Add-on to EXEL (https://github.com/47colborne/exel) that provides support for Amazon S3.'
+  spec.homepage      = 'https://github.com/47colborne/exel-s3'
+  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 'exel', '~> 1'
+  spec.add_dependency 'aws-sdk', '~> 2'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'guard', '~> 2'
+  spec.add_development_dependency 'guard-rspec', '~> 4'
+  spec.add_development_dependency 'guard-rubocop', '~> 1'
+  spec.add_development_dependency 'terminal-notifier', '~> 1'
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1'
+  spec.add_development_dependency 'rubocop', '~> 0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1'
+  spec.add_development_dependency 'rubocop-rspec-focused', '~> 0'
+end

data/lib/exel/s3/s3_provider.rb

@@ -0,0 +1,46 @@
+require 'aws-sdk-resources'
+
+module EXEL
+  module S3
+    class S3Provider
+      def upload(file)
+        filename = get_filename(file)
+        obj = get_object(filename)
+        obj.upload_file(file)
+        file.close
+
+        "s3://#{filename}"
+      end
+
+      def download(uri)
+        filename = uri.partition('://').last
+        obj = get_object(filename)
+        file = Tempfile.new(filename, encoding: Encoding::ASCII_8BIT)
+        obj.get(response_target: file)
+        file.set_encoding(Encoding::UTF_8)
+        file
+      end
+
+      def get_object(filename)
+        s3 = Aws::S3::Resource.new(
+          credentials: Aws::Credentials.new(
+            EXEL.configuration.aws.access_key_id,
+            EXEL.configuration.aws.secret_access_key
+          ),
+          region: 'us-east-1'
+        )
+        s3.bucket(EXEL.configuration.s3_bucket).object(filename)
+      end
+
+      def self.remote?(uri)
+        uri =~ %r{s3://}
+      end
+
+      private
+
+      def get_filename(file)
+        file.path.split('/').last
+      end
+    end
+  end
+end

data/lib/exel/s3/version.rb

@@ -0,0 +1,5 @@
+module EXEL
+  module S3
+    VERSION = '1.0.0'
+  end
+end

data/lib/exel/s3.rb

@@ -0,0 +1,10 @@
+require 'exel/s3/version'
+require_relative 's3/s3_provider'
+
+module EXEL
+  module S3
+    EXEL.configure do |config|
+      config.remote_provider = EXEL::S3::S3Provider
+    end
+  end
+end

data/spec/exel/s3/s3_provider_spec.rb

@@ -0,0 +1,62 @@
+module EXEL
+  module S3
+    describe S3Provider do
+      describe '#get_object' do
+        before do
+          EXEL.configure do |config|
+            config.aws = OpenStruct.new
+            config.s3_bucket = 'bucket'
+          end
+        end
+
+        it 'has the correct bucket and file names' do
+          file_name = 'abc.txt'
+          s3_obj = subject.get_object(file_name)
+          expect(s3_obj.bucket_name).to eq('bucket')
+          expect(s3_obj.key).to eq(file_name)
+        end
+      end
+
+      describe '#upload' do
+        let(:file) { double(path: '/path/to/abc.txt', close: nil) }
+
+        it 'uploads the file to s3' do
+          expect_any_instance_of(Aws::S3::Object).to receive(:upload_file).with(file)
+
+          subject.upload(file)
+        end
+
+        it 'returns the URI of the uploaded file' do
+          allow_any_instance_of(Aws::S3::Object).to receive(:upload_file).with(file)
+          expect(subject.upload(file)).to eq('s3://abc.txt')
+        end
+      end
+
+      describe '#download' do
+        it 'downloads the file from s3' do
+          file = double(:file)
+          s3_object = double(:s3_object)
+
+          expect(subject).to receive(:get_object).with('abc.txt').and_return(s3_object)
+          expect(Tempfile).to receive(:new).with('abc.txt', encoding: Encoding::ASCII_8BIT).and_return(file)
+          expect(s3_object).to receive(:get).with(hash_including(response_target: file)).and_return(file)
+          expect(file).to receive(:set_encoding).with(Encoding::UTF_8)
+
+          expect(subject.download('s3://abc.txt')).to eq(file)
+        end
+      end
+
+      describe '.remote?' do
+        it 'returns true for file:// URIs' do
+          expect(S3Provider.remote?('s3://file')).to be_truthy
+        end
+
+        it 'returns false for anything else' do
+          expect(S3Provider.remote?('file://path/to/file')).to be_falsey
+          expect(S3Provider.remote?(1)).to be_falsey
+          expect(S3Provider.remote?(nil)).to be_falsey
+        end
+      end
+    end
+  end
+end

data/spec/exel/s3_spec.rb

@@ -0,0 +1,7 @@
+module EXEL
+  describe S3 do
+    it 'sets itself as the remote provider' do
+      expect(EXEL.remote_provider).to eq(EXEL::S3::S3Provider)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'exel'
+
+Dir[File.expand_path('../../lib/**/*.rb', __FILE__)].each { |f| require f }
+
+EXEL.logger = nil

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification
+name: exel-s3
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- yroo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: exel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec-focused
+  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: Add-on to EXEL (https://github.com/47colborne/exel) that provides support
+  for Amazon S3.
+email:
+- dev@yroo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exel-s3.gemspec
+- lib/exel/s3.rb
+- lib/exel/s3/s3_provider.rb
+- lib/exel/s3/version.rb
+- spec/exel/s3/s3_provider_spec.rb
+- spec/exel/s3_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/47colborne/exel-s3
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Makes EXEL use S3 to store files during context shifts.
+test_files:
+- spec/exel/s3/s3_provider_spec.rb
+- spec/exel/s3_spec.rb
+- spec/spec_helper.rb