volt-s3_uploader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd5126bdbee2912320391bb5e8be4e58bd48ba64
+  data.tar.gz: b98b96ebdb6be1589bab842cbf2759bdbb01a384
+SHA512:
+  metadata.gz: 993db98ac17a24f17f1488256decaa23f5d92d703498bd06dffdf0c975e0ef7e58616c00c86d4f23a8d2bcf617d1a5c05c9a14cf2710e1c2037fd8275ead7b9d
+  data.tar.gz: 92d501495cb8d6c9fc20b0ead27a406b6012f8a1397d1a82012560a53595d8c3dfe5b147cfb27cf1dd95933833e23738c93894e49fa9a6afe7c31047901b982a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ryan Stout
+
+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,36 @@
+# S3 Uploader
+
+This gem provides a simple way to upload files directly from the browser to s3.  Going straight to s3 simplifies serving and makes it easier to deploy to read only PaaS's like heroku.  While s3 upload is usually more compilcated, this gem tries to make it simple.  It only uploads files and does not do resizing.  You can handle resizing with the volt-s3_image_resizer gem.
+
+## How it works
+
+When an app with this gem boots, it checks the s3 api and if needed configures the buckets to support CORS.  Before a file upload starts, this gem hits a task that returns a signed upload url.  The url allows the browser to upload the file directly to s3.
+
+
+TODO:
+When the model does save on the server, the gem will add a meta-data to the file to mark it as a permenant file.  The gem includes a task to periodically clean uploaded files that never had their associated models saved.
+
+## Setup
+
+Signup for an S3 account, and generate a aws key and secret.
+
+In ```config/app.rb``` add:
+
+```ruby
+Volt.config.s3.key = ''
+Volt.config.s3.secret = ''
+```
+
+In the component you want to use the uploader from, add:
+
+```ruby
+component 's3_uploader'
+```
+
+In the model you wish to attach the file to, add:
+
+```ruby
+attachment :file, 'bucket_name_' + Volt.env.to_s
+```
+
+Make sure the bucket name is unique, otherwise it will be taken.  Adding the ENV helps make dev/testing work easier.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/s3_uploader/config/dependencies.rb

@@ -0,0 +1 @@
+# Component dependencies

data/app/s3_uploader/config/initializers/boot.rb

@@ -0,0 +1,12 @@
+# Place any code you want to run when the component is included on the client
+# or server.
+
+# To include code only on the client use:
+# if RUBY_PLATFORM == 'opal'
+#
+# To include code only on the server, use:
+# unless RUBY_PLATFORM == 'opal'
+# ^^ this will not send compile in code in the conditional to the client.
+# ^^ this include code required in the conditional.
+
+require 's3_uploader/lib/s3_attachment'

data/app/s3_uploader/config/routes.rb

@@ -0,0 +1 @@
+# Component routes

data/app/s3_uploader/controllers/main_controller.rb

@@ -0,0 +1,103 @@
+module S3Uploader
+  class MainController < Volt::ModelController
+    reactive_accessor :progress
+    reactive_accessor :error_message
+    reactive_accessor :s3_url
+    reactive_accessor :bucket
+    attr_accessor :uploading_promise
+
+    if RUBY_PLATFORM == 'opal'
+
+      def bucket_name
+        file_field_name = attrs.value_last_method
+        attrs.value_parent.send(file_field_name + "_bucket")
+      end
+
+      def upload(event)
+        target = event.target
+        set_progress(0)
+
+        file = nil
+        `
+          var files = target.files;
+
+          var output = [];
+          for (var i = 0, f; file = files[i]; i++) {
+            #{upload_file(file)}
+          }
+        `
+      end
+
+      def upload_file(file)
+        self.uploading_promise = Promise.new
+        puts "UP FILE: #{uploading_promise.inspect}"
+
+        S3UploadTasks.sign(bucket_name, `file.name`, `file.type`).then do |private_and_public|
+          self.s3_url = private_and_public[1]
+          upload_with_url(file, private_and_public[0])
+        end.fail do |err|
+          set_progress(0, 'Could not contact signing script. Status = ' + err.to_s)
+        end
+      end
+
+      def upload_with_url(file, signed_url)
+        # create PUT request to S3
+        `
+        var xhr = new XMLHttpRequest();
+        xhr.open('PUT', signed_url);
+        xhr.setRequestHeader('Content-Type', file.type);
+
+        xhr.onload = function() {
+          if (xhr.status == 200) {
+            #{uploaded}
+          }
+        };
+
+        xhr.onerror = function(e) {
+          self.$error(e.error || 'Upload Error');
+        };
+
+        xhr.upload.onprogress = function(e) {
+          console.log('onprogress');
+
+          if (e.lengthComputable) {
+            #{percentLoaded = `Math.round((e.loaded / e.total) * 100)`};
+            #{set_progress(percentLoaded, nil)}
+          }
+        };
+
+        xhr.send(file);
+        `
+
+        nil
+      end
+
+      # Resolve the uploading promise
+      def uploaded
+        promise = self.uploading_promise
+        self.uploading_promise = nil
+
+        set_progress(100, nil, true)
+        promise.resolve(nil)
+      end
+
+      def error(msg)
+        msg = msg.to_s
+        promsise = self.uploading_promise
+        self.uploading_promise = nil
+
+        set_progress(0, msg, true)
+        promsise.reject(msg)
+      end
+
+      def set_progress(progress, error=nil, done=false)
+        self.progress = progress
+        self.error_message = error
+
+        if attrs.respond_to?(:value)
+          attrs.value = [progress, done ? s3_url : nil, @uploading_promise]
+        end
+      end
+    end
+  end
+end

data/app/s3_uploader/lib/s3_attachment.rb

@@ -0,0 +1,78 @@
+# Included into Volt::Model to provide ```attachment```
+require 's3_uploader/lib/s3_bucket_manager' unless RUBY_PLATFORM == 'opal'
+
+module S3Uploader
+  module S3Attachment
+    module ClassMethods
+      def attachment(name, bucket)
+        unless RUBY_PLATFORM == 'opal'
+          # Create the bucket and set the CORS policy if needed
+          Volt.current_app.once('post_boot') do
+            S3BucketManager.ensure_bucket(bucket)
+          end
+        end
+
+        url_field_name = :"#{name}_url"
+        field(url_field_name, String)
+
+        upload_percent_field_name = :"#{name}_upload_percent"
+        reactive_accessor(upload_percent_field_name)
+
+        promise_field_name = :"#{name}_uploading_promise"
+        attr_accessor(promise_field_name)
+
+        # Create a method that returns the bucket passed in
+        define_method(:"#{name}_bucket") do
+          bucket
+        end
+
+        unless RUBY_PLATFORM == 'opal'
+          s3 = Volt.config.s3
+          current_buckets = (s3 ? s3.to_h[:buckets] : nil) || []
+          current_buckets << bucket
+
+          Volt.configure do |config|
+            config.s3.buckets = current_buckets
+          end
+        end
+
+        # An aggrate method is created for assigning to the value="{{ name }}"
+        # property of the tag.
+        define_method(name) do
+          url = send(url_field_name)
+          upload_percent = send(upload_percent_field_name)
+          [url, upload_percent]
+        end
+
+        define_method(:"#{name}=") do |val|
+          send(:"#{upload_percent_field_name}=", val[0])
+          send(:"#{url_field_name}=", val[1])
+          send(:"#{promise_field_name}=", val[2])
+        end
+
+        validate do
+          # MainController (linked via the value attribute on the s3-upload tag)
+          # will set a promise, which it resolves when the file is upload (if it
+          # is uploading).
+          promise = send(promise_field_name)
+
+          if promise.is_a?(Promise) && !promise.realized?
+            promise = promise.then do
+              puts "Uploaded"
+              trigger!("uploaded_#{name}")
+            end
+          end
+
+          # return the promise
+          promise
+        end
+      end
+    end
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+  end
+end
+
+Volt::Model.include(S3Uploader::S3Attachment)

data/app/s3_uploader/lib/s3_bucket_manager.rb

@@ -0,0 +1,47 @@
+module S3Uploader
+  class S3BucketManager
+    def self.ensure_bucket(bucket_name)
+      prop_key = "s3_bucket_#{bucket_name}"
+      unless Volt.current_app.properties[prop_key]
+        Volt.logger.info("Creating/Setting up S3 Bucket: #{bucket_name}")
+
+        creds = Aws::Credentials.new(Volt.config.s3.key, Volt.config.s3.secret)
+        s3 = Aws::S3::Resource.new(region: 'us-east-1', credentials: creds)
+
+        s3.create_bucket(
+          {
+            acl: "private", # accepts private, public-read, public-read-write, authenticated-read
+            bucket: bucket_name, # required
+            # create_bucket_configuration: {
+            #   location_constraint: "us-east-1", # accepts EU, eu-west-1, us-west-1, us-west-2, ap-southeast-1, ap-southeast-2, ap-northeast-1, sa-east-1, cn-north-1, eu-central-1
+            # },
+            # grant_full_control: "GrantFullControl",
+            # grant_read: "GrantRead",
+            # grant_read_acp: "GrantReadACP",
+            # grant_write: "GrantWrite",
+            # grant_write_acp: "GrantWriteACP",
+          }
+        )
+
+        bucket = s3.bucket(bucket_name)
+
+        bucket.cors.put(
+          {
+            bucket: bucket_name,
+            cors_configuration: {
+              cors_rules: [
+                {
+                  allowed_origins: ["*"],
+                  allowed_methods: ["GET", "POST", "PUT"], # required
+                  allowed_headers: ["*"]
+                },
+              ],
+            }
+          }
+        )
+
+        Volt.current_app.properties[prop_key] = '1'
+      end
+    end
+  end
+end

data/app/s3_uploader/tasks/s3_upload_tasks.rb

@@ -0,0 +1,43 @@
+require 'cgi'
+require 'securerandom'
+
+class S3UploadTasks < Volt::Task
+  EXPIRE_TIME = (60 * 5) # 5 minutes
+  S3_URL = 'http://s3.amazonaws.com'
+  LIMIT = 100 * 1024 * 1024 # 100 MB
+
+  BUCKETS = Volt.config.s3.buckets
+
+  def sign(bucket_name, filename, mime_type)
+    s3 = Volt.config.s3.to_h
+
+    buckets = s3[:buckets]
+    key = s3[:key]
+    secret = s3[:secret]
+
+    [:buckets, :key, :secret].each do |prop|
+      unless s3[prop]
+        raise "s3_upload configure issue: Please configure Volt.config.s3.#{prop.to_s}"
+      end
+    end
+
+    unless buckets.include?(bucket_name)
+      raise "The bucket passed in (#{bucket_name.inspect}) does not match the list of supported buckets"
+    end
+
+    extname = File.extname(filename)
+    filename = "#{SecureRandom.uuid}#{extname}"
+    upload_key = Pathname.new(filename).to_s
+
+    creds = Aws::Credentials.new(Volt.config.s3.key, Volt.config.s3.secret)
+    s3 = Aws::S3::Resource.new(region: 'us-east-1', credentials: creds)
+    bucket = s3.bucket(bucket_name)
+
+    obj = bucket.object(upload_key)
+
+    params = { acl: 'public-read' }
+    # params[:content_length] = LIMIT if LIMIT
+
+    [obj.presigned_url(:put, params), obj.public_url]
+  end
+end

data/app/s3_uploader/views/main/index.html

@@ -0,0 +1,19 @@
+<div class="form-group">
+  {{ if attrs.label.present? }}
+    <label class="control-label">{{ attrs.label }}</label>
+  {{ end }}
+  <input type="file" id="files" e-change="upload" name="files" />
+  {{ if progress.present? }}
+    <div class="progress">
+      <div class="progress-bar" role="progressbar" aria-valuenow="{{ progress }}" aria-valuemin="0" aria-valuemax="100" style="width: {{ progress }}%;">
+        {{ if progress > 0 }}
+          {{ progress }}% Uploaded
+        {{ end }}
+      </div>
+    </div>
+  {{ end }}
+  {{ if error_message.present? }}
+    <span class="control-label errors">{{ error_message }}</span>
+  {{ end }}
+</div>
+

data/lib/volt/s3_uploader.rb

@@ -0,0 +1,19 @@
+# If you need to require in code in the gem's app folder, keep in mind that
+# the app is not on the load path when the gem is required.  Use
+# app/{gemname}/config/initializers/boot.rb to require in client or server
+# code.
+#
+# Also, in volt apps, you typically use the lib folder in the
+# app/{componentname} folder instead of this lib folder.  This lib folder is
+# for setting up gem code when Bundler.require is called. (or the gem is
+# required.)
+#
+# If you need to configure volt in some way, you can add a Volt.configure block
+# in this file.
+
+require 'aws-sdk'
+
+module Volt
+  module S3Uploader
+  end
+end

data/lib/volt/s3_uploader/version.rb

@@ -0,0 +1,5 @@
+module Volt
+  module S3Uploader
+    VERSION = "0.1.0"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# Volt sets up rspec and capybara for testing.
+require 'volt/spec/setup'
+Volt.spec_setup
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end

data/spec/volt/s3_uploader_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Volt::S3Uploader do
+  it 'should have a version number' do
+    expect(Volt::S3Uploader::VERSION).not_to be nil
+  end
+
+  it 'should do something useful' do
+    expect(false).to be true
+  end
+end

data/volt-s3_uploader.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'volt/s3_uploader/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "volt-s3_uploader"
+  spec.version       = Volt::S3Uploader::VERSION
+  spec.authors       = ["Ryan Stout"]
+  spec.email         = ["ryanstout@gmail.com"]
+  spec.summary       = %q{A direct to s3 file uploader}
+  spec.homepage      = ""
+  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', '~> 2.1.15'
+  spec.add_dependency 'volt', '~> 0.9.6'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: volt-s3_uploader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Stout
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.15
+- !ruby/object:Gem::Dependency
+  name: volt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 
+email:
+- ryanstout@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/s3_uploader/config/dependencies.rb
+- app/s3_uploader/config/initializers/boot.rb
+- app/s3_uploader/config/routes.rb
+- app/s3_uploader/controllers/main_controller.rb
+- app/s3_uploader/lib/s3_attachment.rb
+- app/s3_uploader/lib/s3_bucket_manager.rb
+- app/s3_uploader/tasks/s3_upload_tasks.rb
+- app/s3_uploader/views/main/index.html
+- lib/volt/s3_uploader.rb
+- lib/volt/s3_uploader/version.rb
+- spec/spec_helper.rb
+- spec/volt/s3_uploader_spec.rb
+- volt-s3_uploader.gemspec
+homepage: ''
+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
+signing_key: 
+specification_version: 4
+summary: A direct to s3 file uploader
+test_files:
+- spec/spec_helper.rb
+- spec/volt/s3_uploader_spec.rb