async_paperclip_uploader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d77f312cfc665bb0f172d455db26f5b63946b08233e6e63bd0ad03b73bc0f3e
+  data.tar.gz: 1f6cb6ee735509f4258c145e935a7667c04be4c7f84ec080da252038845f4a41
+SHA512:
+  metadata.gz: bd55a8a148867357826308da2416071e8ad6d0fc541de932550d87fd7cabc897c0bdafce81f8e9d44b9d1eb1b1eec294956b666b21f470183bd330d77ad67c3a
+  data.tar.gz: a6c2c7fcf0c07cc66fd6d688d4a57079e0e3489801f05c62d24fcd445d7aac7e6293325e384a574a75cdd64dc9f8d3cc013087d120d84ca69e53d58749660aa3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in async_paperclip_uploader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Sarah
+
+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,72 @@
+# AsyncPaperclipUploader
+
+Save your attachments first to filesystem and then save async to your model
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'async_paperclip_uploader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install async_paperclip_uploader
+
+## Usage
+
+First, call AsyncPaperclipUploader::Temporary.new passing the model object, the related attachment attribute, and the uploaded file. 
+e.g.:
+
+```AsyncPaperclipUploader::Temporary.new(@user, 'avatar', uploaded_file).call```
+
+Next, create the sidekiq job class, which should follow the following name convention: object class name + UploadJob, e.g.:
+
+``` UserUploadJob ```
+
+In this class, you must receive the attributes object_id, attribute and filepath. e.g.:
+
+``` 
+class UserUploadJob
+  include Sidekiq::Worker
+
+  def perform(user_id, attribute, filepath)
+  
+  end
+
+end
+
+```
+
+Inside perform method, you will want to call AsyncPaperclipUploader::Permanent.new, which expects to receive the object class name, the object id, the attribute, and the filepath. e.g.:
+
+
+```
+def perform(user_id, attribute, filepath)
+  AsyncPaperclipUploader::Permanent.new('User', user_id, attribute, filepath).call
+end
+```
+
+If you want a callback to be ran, the call method accepts a block. e.g.:
+
+```
+AsyncPaperclipUploader::Permanent.new('User', user_id, attribute, filepath).call do
+  # you callback here
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/async_paperclip_uploader.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "async_paperclip_uploader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "async_paperclip_uploader"
+  spec.version       = AsyncPaperclipUploader::VERSION
+  spec.authors       = ["Husky Dev Team"]
+  spec.email         = ["dev@husky.io"]
+
+  spec.summary       = 'Async paperclip uploader'
+  #spec.description   = %q{TODO: Write a longer description or delete this line.}
+  #spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "async_paperclip_uploader"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/async_paperclip_uploader.rb

@@ -0,0 +1,2 @@
+require 'async_paperclip_uploader/temporary.rb'
+require 'async_paperclip_uploader/permanent.rb'

data/lib/async_paperclip_uploader/permanent.rb

@@ -0,0 +1,29 @@
+
+module AsyncPaperclipUploader
+  class Permanent
+    def initialize(class_name, object_id, attribute, filepath)
+      @object = Object::const_get(class_name).find_by_id(object_id)
+      @attribute = attribute
+      @filepath = filepath
+    end
+
+    def call
+      @object.send("#{@attribute}=", file)
+      if @object.save
+        if block_given?
+          yield
+        end
+        clean 
+      end
+    end
+
+    private
+    def file
+      File.open(@filepath)
+    end
+
+    def clean
+      File.delete(@filepath)
+    end
+  end
+end

data/lib/async_paperclip_uploader/temporary.rb

@@ -0,0 +1,67 @@
+module AsyncPaperclipUploader
+  class Temporary
+    def initialize(object, attribute, uploaded_file)
+      @object = object
+      @attribute = attribute
+      @uploaded_file = uploaded_file
+    end
+
+    def call
+      if valid?
+        upload
+        run_permanent_upload_job
+      end
+    end
+
+    def valid?
+      valid_class_attr? && valid_attachment? 
+    end
+
+    def valid_class_attr?
+      @object.respond_to?(@attribute.to_sym)
+    end
+
+    def valid_attachment?
+      attachment = {
+        :filename => @uploaded_file[:filename],
+        :content_type => @uploaded_file[:type],
+        :headers => @uploaded_file[:head],
+        :tempfile => @uploaded_file[:tempfile]
+      }
+      @object.send("#{@attribute}=", ActionDispatch::Http::UploadedFile.new(attachment))
+      @object.valid?
+    end
+
+    def self.base_path
+      ENV["FILE_UPLOAD_STAGING_DIR"]
+    end
+
+    private
+    def upload
+      File.open(path, "wb") { |f| f.write(tempfile.read) }
+    end
+
+    def path
+      extname = File.extname(@uploaded_file[:filename])
+      name = "#{@attribute}-#{@object.id}#{extname}"
+      File.join(self.class.base_path, name)
+    end
+
+    def tempfile
+      @uploaded_file[:tempfile]
+    end
+
+    def run_permanent_upload_job
+      job_class.perform_async(@object.id, @attribute, path)
+    end
+
+    def job_class
+      name = "#{@object.class.name}#{base_job_class_name}"
+      Object::const_get(name)
+    end
+
+    def base_job_class_name
+      'UploadJob'
+    end
+  end
+end

data/lib/async_paperclip_uploader/version.rb

@@ -0,0 +1,3 @@
+module AsyncPaperclipUploader
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: async_paperclip_uploader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Husky Dev Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- dev@husky.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- async_paperclip_uploader.gemspec
+- bin/console
+- bin/setup
+- lib/async_paperclip_uploader.rb
+- lib/async_paperclip_uploader/permanent.rb
+- lib/async_paperclip_uploader/temporary.rb
+- lib/async_paperclip_uploader/version.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Async paperclip uploader
+test_files: []