bg_s3uploadable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c10753fe8c1404bbb2816a0e96fcbdf391901560
+  data.tar.gz: 16412f90de3d1d9290b7ac53c79e719c55da20a8
+SHA512:
+  metadata.gz: 14e4b3612de21c1aa986339b9c11eb04314f680d49df75703695dbc9f12e203fc82b6671982915eeaa4747d3814a19e86a9c71a9c212680faadbabe01526a43d
+  data.tar.gz: 1c6a25806d8f5ef0d1fc337f6b2741ea0ed583c947b54e288e881bf64362e75829f86a5bf611871c871085c9c18a4de95237fcfa61f54d7c0f2bc60c642f1f26

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Keitaroh Kobayashi
+
+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,31 @@
+# BgS3uploadable
+
+Extracted from a couple of my projects. The code is still really messy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bg_s3uploadable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bg_s3uploadable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bg_s3uploadable/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,2 @@
+require "bundler/gem_tasks"
+

data/app/assets/javascripts/bg_s3uploadable/s3uploader.js.coffee

@@ -0,0 +1,129 @@
+#= require jquery.fileupload
+
+draganddrop = () ->
+  if @draggable == undefined
+    div = document.createElement 'div'
+    @draggable = ('draggable' of div) or ('ondragstart' of div and 'ondrop' of div)
+  else
+    @draggable
+
+window.s3uploaderInstall = () ->
+  $('.file-upload').each () ->
+    form = $ this
+
+    return if form.data('s3uploader-installed') == true
+    form.data 's3uploader-installed', true
+
+    if draganddrop()
+      installDragAndDrop this
+
+    bar = form.find '.progress-bar'
+
+    setProgress = (val) ->
+      bar.css 'width', "#{val}%"
+      bar.attr 'aria-valuenow', val
+
+    $s3key_field  = $ form.data('s3key-field')
+    $image_holder = $ form.data('image-holder')
+
+    setImageURI = (uri) ->
+      image = $image_holder.find('> img')
+      if image.length == 0
+        $("<img src='#{uri}'>").appendTo $image_holder
+      else
+        image.attr 'src', uri
+
+    form.fileupload
+      url: form.data 'action'
+      type: 'POST'
+      autoUpload: true
+      dataType: 'xml'
+      add: (event, data) ->
+        reader = new FileReader
+        reader.onload = (e) ->
+          setImageURI e.target.result
+        reader.readAsDataURL data.files[0]
+
+        $.ajax
+          url: '/s3/signed_url'
+          type: 'GET'
+          dataType: 'json'
+          data:
+            doc:
+              title: data.files[0].name
+          success: (signature) ->
+            data.formData =
+              key: signature.key
+              policy: signature.policy
+              signature: signature.signature
+              AWSAccessKeyId: form.data 'accesskeyid'
+              acl: 'private'
+              success_action_status: '201'
+              'x-amz-server-side-encryption': 'AES256'
+
+            data.submit()
+
+      send: (e, data) ->
+        form.find('.progress').fadeIn()
+
+      progress: (e, data) ->
+        percent = parseInt data.loaded / data.total * 100, 10
+        setProgress percent
+
+      fail: (e, data) ->
+        console.log "Failure."
+
+      success: (data) ->
+        key = $(data).find('Key').text()
+        $s3key_field.val key
+
+        # uri = "/s3/uploaded_image?key=#{key}"
+        # setImageURI uri
+
+        # form.parents('form').submit()
+        form.hide()
+      done: (e, data) ->
+        form.find('.progress').fadeOut 300, () ->
+          setProgress 0
+
+installDragAndDrop = (container) ->
+  counter = 0
+  $container = $ container
+
+  container.addEventListener 'dragover', (e) ->
+    e.preventDefault()
+
+  container.addEventListener 'dragenter', (e) ->
+    counter += 1
+
+    if counter == 1
+      $container.addClass 'filedrag'
+
+  container.addEventListener 'dragleave', (e) ->
+    counter -= 1
+
+    if counter == 0
+      $container.removeClass 'filedrag'
+
+  container.addEventListener 'drop', (e) ->
+    e.preventDefault()
+
+    counter = 0
+    $container.removeClass 'filedrag'
+
+$(document).on 'ready page:load', window.s3uploaderInstall
+$(document).on 'page:load', ->
+  $('.filestyle').each ->
+    $this = $ this
+    options =
+      'input'        : if $this.attr('data-input') == 'false' then false else true,
+      'icon'         : if $this.attr('data-icon') == 'false' then false else true,
+      'buttonBefore' : if $this.attr('data-buttonBefore') == 'true' then true else false,
+      'disabled'     : if $this.attr('data-disabled') == 'true' then true else false,
+      'size'         : $this.attr('data-size'),
+      'buttonText'   : $this.attr('data-buttonText'),
+      'buttonName'   : $this.attr('data-buttonName'),
+      'iconName'     : $this.attr('data-iconName'),
+      'badge'        : if $this.attr('data-badge') == 'false' then false else true
+
+    $this.filestyle options

data/app/controllers/bg_s3uploadable/signed_urls_controller.rb

@@ -0,0 +1,60 @@
+module BgS3uploadable
+  class SignedUrlsController < ApplicationController
+    def show
+      policy = s3_upload_policy_document
+
+      render json: {
+        policy: policy,
+        signature: s3_upload_signature(policy),
+        key: "uploads/#{SecureRandom.uuid}/#{params[:doc][:title]}",
+        success_action_redirect: "/",
+        upload_endpoint: "https://#{ENV['S3_BUCKET']}.s3.amazonaws.com",
+        :AWSAccessKeyID => ENV['AWS_ACCESS_KEY_ID'],
+      }
+    end
+
+    def uploaded_image
+      unless params[:key] =~ /\Auploads\//
+        render json: { error: 'Access denied' }, status: 403
+        return
+      end
+
+      s3 = AWS::S3.new
+      bucket = s3.buckets[ENV['S3_BUCKET']]
+      obj = bucket.objects[params[:key]]
+
+      presign = AWS::S3::PresignV4.new obj
+
+      redirect_to presign.presign(:get, expires: 5.minutes.from_now.to_i, secure: true).to_s
+    end
+
+    private
+
+    # generate the policy document that amazon is expecting.
+    def s3_upload_policy_document
+      Base64.strict_encode64(
+        {
+          expiration: 30.minutes.from_now.utc.strftime('%Y-%m-%dT%H:%M:%S.000Z'),
+          conditions: [
+            { bucket: ENV['S3_BUCKET'] },
+            { acl: 'private' },
+            ["starts-with", "$key", "uploads/"],
+            { success_action_status: '201' },
+            { :'x-amz-server-side-encryption' => 'AES256' }
+          ]
+        }.to_json
+      ).gsub(/\n|\r/, '')
+    end
+
+    # sign our request by Base64 encoding the policy document.
+    def s3_upload_signature(policy)
+      Base64.strict_encode64(
+        OpenSSL::HMAC.digest(
+          OpenSSL::Digest::SHA1.new,
+          ENV['AWS_SECRET_ACCESS_KEY'],
+          policy
+        )
+      ).gsub(/\n/, '')
+    end
+  end
+end

data/app/jobs/bg_s3uploadable/uploader_job.rb

@@ -0,0 +1,28 @@
+module BgS3uploadable
+  class UploaderJob < ::ActiveJob::Base
+    def perform(record, attachment)
+      key = record.send :"#{attachment}_s3key"
+      return if key.blank?
+
+      f = Tempfile.new(SecureRandom.uuid, encoding: 'binary')
+
+      s3 = AWS::S3.new
+      bucket = s3.buckets[ENV['S3_BUCKET']]
+      obj = bucket.objects[key]
+      obj.read do |chunk|
+        f.write chunk
+      end
+      f.flush
+
+      record.class.transaction do
+        record.send(:"#{attachment}=", f)
+        record.send(:write_attribute, :"#{attachment}_s3key", nil)
+
+        record.save validate: false
+      end
+    ensure
+      f.close
+      f.unlink
+    end
+  end
+end

data/bg_s3uploadable.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bg_s3uploadable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bg_s3uploadable"
+  spec.version       = BgS3uploadable::VERSION
+  spec.authors       = ["Keitaroh Kobayashi"]
+  spec.email         = ["keita@kkob.us"]
+  spec.summary       = %q{Extension for direct and background S3 uploading to Paperclip}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/keichan34/bg_s3uploadable"
+  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_runtime_dependency "rails", "~> 4.2"
+  spec.add_runtime_dependency "aws-sdk", "< 2.0"
+  spec.add_runtime_dependency "jquery.fileupload-rails", "~> 1.11"
+  spec.add_runtime_dependency "paperclip", ">= 4.2"
+  spec.add_runtime_dependency "coffee-rails", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+BgS3uploadable::Engine.routes.draw do
+  get '/signed_url' => 'signed_urls#show'
+  get '/uploaded_image' => 'signed_urls#uploaded_image'
+  get '/uploaded_image/*key' => 'signed_urls#uploaded_image',
+    format: false, as: :uploaded_image_with_key
+end

data/lib/bg_s3uploadable/engine.rb

@@ -0,0 +1,11 @@
+module BgS3uploadable
+  class Engine < ::Rails::Engine
+    isolate_namespace BgS3uploadable
+
+    initializer "bg_s3uploadable.activerecord_ext" do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :include, Uploadable
+      end
+    end
+  end
+end

data/lib/bg_s3uploadable/uploadable.rb

@@ -0,0 +1,58 @@
+module BgS3uploadable
+  module Uploadable
+    extend ActiveSupport::Concern
+
+    included do
+      after_commit :queue_s3key_notifications
+    end
+
+    private
+
+    def set_s3key(attachment, key)
+      return if key.blank?
+
+      fail ArgumentError, 'Invalid key' unless key =~ /\Auploads\//
+
+      write_attribute :"#{attachment}_s3key", key
+
+      @s3key_notifications_required ||= []
+      @s3key_notifications_required << attachment
+
+      # Clear the old attachment out while processing.
+      send(:"#{attachment}=", nil)
+    end
+
+    def queue_s3key_notifications
+      return if @s3key_notifications_required.blank?
+
+      @s3key_notifications_required.each do |attachment|
+        UploaderJob.perform_later self, attachment.to_s
+      end
+
+      @s3key_notifications_required = nil
+    end
+
+    module ClassMethods
+      def s3_uploadable(*attachments)
+        attachments.each { |e| _s3_uploadable e }
+      end
+
+      private
+
+      def _s3_uploadable(attachment)
+        define_method :"#{attachment}_s3key=" do |key|
+          set_s3key attachment, key
+        end
+
+        attr_reader :"remove_#{attachment}"
+
+        define_method :"remove_#{attachment}=" do |value|
+          instance_variable_set :"@remove_#{attachment}", value
+          if value == '1' or value == 1
+            send(:"#{attachment}=", nil)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bg_s3uploadable/version.rb

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

data/lib/bg_s3uploadable.rb

@@ -0,0 +1,9 @@
+require "jquery.fileupload-rails"
+
+require "bg_s3uploadable/version"
+
+module BgS3uploadable
+end
+
+require "bg_s3uploadable/uploadable"
+require "bg_s3uploadable/engine"

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: bg_s3uploadable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Keitaroh Kobayashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jquery.fileupload-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.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: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: ''
+email:
+- keita@kkob.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/bg_s3uploadable/s3uploader.js.coffee
+- app/controllers/bg_s3uploadable/signed_urls_controller.rb
+- app/jobs/bg_s3uploadable/uploader_job.rb
+- bg_s3uploadable.gemspec
+- config/routes.rb
+- lib/bg_s3uploadable.rb
+- lib/bg_s3uploadable/engine.rb
+- lib/bg_s3uploadable/uploadable.rb
+- lib/bg_s3uploadable/version.rb
+homepage: https://github.com/keichan34/bg_s3uploadable
+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: Extension for direct and background S3 uploading to Paperclip
+test_files: []