s3ff 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 945f26d43ebe1d6948e75709b443f1c10ecae50e
-  data.tar.gz: e90b28d666f592ddda901d5b0e13216a05214587
+  metadata.gz: 8f484d70a13f4f286c5c2359cfb0b2ce008646d9
+  data.tar.gz: b2ba48eb5a830b8369b70dac313ff6d1c4a239b0
 SHA512:
-  metadata.gz: e5d76292b4e71cb1f4d53ac99e7ed5765483206e46bb78561cd51b1f8854eee23d0d3702ea1434f14c3d4be61c0b205711666ff56aa093b78262a2ad7aa362e8
-  data.tar.gz: 3992c0fc1c8803b062eb07d0e6856db5cf0030570a01637437ac5bdc12428c5e08103f00ce0a77175872f645d01472d4e48034791cce942dcd8f9c6b4129256b
+  metadata.gz: 6ef9c3c7d3ebe06188c702897b123405eda017cbdd3f358520561ba5e06d0868baad82049777cf91db81fd5d4e2ced7c433305e694fa14c505efeccae303a6ea
+  data.tar.gz: 954dc7d61321c80d3d9fab2eaa02a4c7dcd22c83cbfca13d11bbc7798d674a9bc1764513737d2ae2c70cf7f2a258e02c12bc339b9f5c498614d0200df6ec12ab

data/README.md

@@ -123,8 +123,19 @@ end
 
 #### CAVEAT
 
-It is not ideal to handle your attachment processing synchronously inside the web request. For usage with `Sidekiq` or `DelayedJob`, look at the reference code in [sample/user.*.rb](https://github.com/jollygoodcode/s3ff/tree/master/sample)
+It is not ideal to handle your attachment processing synchronously inside the web request. If you have `Sidekiq` or `DelayedJob` installed, you should use the `download_from_direct_url_with_delay` helper method instead
 
+``` ruby
+class User < ActiveRecord::Base
+  has_attached_file :avatar
+  validates_attachment_content_type :avatar, content_type: /\Aimage\/.*\Z/
+
+  # s3ff changes
+  # for delayed_job, you MUST add a `avatar_direct_url` database column of string type
+  # for sidekiq, `avatar_direct_url` is a virtual attribute; adding a database column is optional
+  download_from_direct_url_with_delay :avatar
+end
+```
 
 ## Contributing
 

data/lib/s3ff.rb

@@ -1,9 +1,11 @@
 require 's3_file_field'
 require 's3ff/view_helper'
+require 's3ff/model_helper'
 require 's3ff/railtie'
 require 's3ff/engine'
 
 ActionView::Base.send(:include, S3FF::ViewHelper)
+ActiveRecord::Base.send(:extend, S3FF::ModelHelper)
 
 S3FileField::FormBuilder.class_eval do
   def s3_file_field_with_s3ff(method, options = {})

data/lib/s3ff/model_helper.rb

@@ -0,0 +1,42 @@
+module S3FF
+  module ModelHelper
+    def download_from_direct_url_with_delay(attr_name)
+      if self.respond_to?(:delay)
+        self.class_eval <<-EOM
+          attr_accessor :#{attr_name}_direct_url unless self.column_names.include?("#{attr_name}_direct_url")
+          after_save :delay_s3ff_download_direct_url, if: proc { #{attr_name}_direct_url.present? }
+
+          def delay_s3ff_download_direct_url
+            self.class.delay.s3ff_download_direct_url(id, #{attr_name}_direct_url)
+          end
+
+          def self.s3ff_download_direct_url(instance_id, #{attr_name}_direct_url)
+            open(#{attr_name}_direct_url, ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE) do |file|
+              find(instance_id).update(
+                #{attr_name}: file,
+                #{attr_name}_file_name: File.basename(#{attr_name}_direct_url),
+              )
+            end
+          end
+        EOM
+      elsif self.respond_to?(:handle_asynchronously)
+        self.class_eval <<-EOM
+          after_save :s3ff_download_direct_url, if: -> { #{attr_name}_direct_url.present? && #{attr_name}_direct_url_changed? }
+
+          def s3ff_download_direct_url
+            open(#{attr_name}_direct_url, ssl_verify_mode: OpenSSL::SSL::VERIFY_NONE) do |file|
+              update(
+                #{attr_name}: file,
+                #{attr_name}_file_name: File.basename(#{attr_name}_direct_url),
+              )
+            end
+          end
+
+          handle_asynchronously :s3ff_download_direct_url
+        EOM
+      else
+        raise NotImplementedError('download_from_direct_url_with_delay only supports delayed_job or sidekiq delayed extension')
+      end
+    end
+  end
+end

data/lib/s3ff/version.rb

@@ -1,3 +1,3 @@
 module S3FF
-  VERSION = '0.9.4'
+  VERSION = '0.9.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3ff
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - Chew Choon Keat
@@ -77,6 +77,7 @@ files:
 - app/assets/javascripts/s3ff.js
 - lib/s3ff.rb
 - lib/s3ff/engine.rb
+- lib/s3ff/model_helper.rb
 - lib/s3ff/railtie.rb
 - lib/s3ff/version.rb
 - lib/s3ff/view_helper.rb