effective_assets 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 575677689fd92da51a47d0a77ea28c98bb903ca1
-  data.tar.gz: bcd980940b7e926a86de5f427553a45dde5a4010
+  metadata.gz: 4203bea664bf1bdd6bb31fb866375a10a186b51b
+  data.tar.gz: 0d8792dd7b61066eb0e13d671d8c591c98052a0e
 SHA512:
-  metadata.gz: 201889c758244e264caf67a5fb3b729e7f8f0466f8f059bd23d5ce84f9146bb231e4bdb3c556cbbee386f79a9bb630f120e3a106f2898d7f796988c1da776228
-  data.tar.gz: 63c9008b994f8920de7607fc56e43b9b4e0e0b3faa711ffd4188f4d76fc632f12d09baac616c32ace52d629638c46e576fd48309302c500e788d0af8cf110afb
+  metadata.gz: 8b36113a751f8240e1929663e61e9f91128f336746d3848002c9fd84c5fb6425f19dd74fafa3513089ed70dd96b169dc801579fdf8ba8ef4102abb96ad49d623
+  data.tar.gz: e49cb21cfc006dc6116098d85a64cedabf170ab0780a9753862f3f1770b4953ac0d8599ca4bc645a0cc3d15557ce8126be95e82be9ca41a83d4c4ea5e8e0329e

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 Code and Effect Inc.
+Copyright 2017 Code and Effect Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -355,9 +355,11 @@ Has final say over the privacy setting when uploaded from this form.
 
 ### Image Processing and Resizing
 
-CarrierWave and DelayedJob are used by this gem to perform image versioning.
+CarrierWave is used by this gem to perform image versioning.
 
-This will be moved over to the new ActiveJob API in future versions of this gem, but right now DelayedJob is the only supported background worker.
+All image processing is run asynchronously.
+
+If there is a valid ActiveJob queue_adapter configured, it will be used.  Otherwise we rely on the sucker_punch gem.
 
 See the installer created at `app/uploaders/asset_uploader.rb` to configure image versions.
 
@@ -505,20 +507,6 @@ rake effective_assets:check[1,200]  # check #1..#200
 rake effective:assets:check[1,200,:thumb]   # check #1..#200 only :thumb versions
 ```
 
-### Clear
-
-Deletes all effective_assets related jobs on the DelayedJob queue.
-
-```ruby
-rake effective_assets:clear
-```
-
-or to clear all jobs, even non-effective_assets related jobs, use DelayedJob's rake task:
-
-```ruby
-rake jobs:clear
-```
-
 ## License
 
 MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
@@ -526,11 +514,11 @@ MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
 
 ## Credits
 
-This gem heavily relies on:
+This gem relies on:
 
 CarrierWave (https://github.com/carrierwaveuploader/carrierwave)
 
-DelayedJob (https://github.com/collectiveidea/delayed_job)
+sucker_punch (https://github.com/brandonhilkert/sucker_punch)
 
 jQuery-File-Upload (https://github.com/blueimp/jQuery-File-Upload)
 

data/app/jobs/effective/process_with_active_job.rb

@@ -0,0 +1,12 @@
+module Effective
+  class ProcessWithActiveJob < (defined?(ApplicationJob) ? ApplicationJob : ActiveJob::Base)
+
+    def perform(id)
+      ActiveRecord::Base.connection_pool.with_connection do
+        asset = id.kind_of?(Effective::Asset) ? id : Effective::Asset.where(id: (id.to_i rescue 0)).first
+        asset.process! if asset
+      end
+    end
+
+  end
+end

data/app/jobs/effective/process_with_sucker_punch_job.rb

@@ -0,0 +1,15 @@
+require 'sucker_punch'
+
+module Effective
+  class ProcessWithSuckerPunchJob
+    include ::SuckerPunch::Job
+
+    def perform(id)
+      ActiveRecord::Base.connection_pool.with_connection do
+        asset = id.kind_of?(Effective::Asset) ? id : Effective::Asset.where(id: (id.to_i rescue 0)).first
+        asset.process! if asset
+      end
+    end
+
+  end
+end

data/app/models/effective/asset.rb

@@ -51,7 +51,7 @@ module Effective
 
     before_validation :set_content_type
     before_save :update_asset_dimensions
-    after_save :enqueue_delayed_job
+    after_commit :queue_async_job
 
     default_scope -> { order(:id) }
     scope :nonplaceholder, -> { where("#{EffectiveAssets.assets_table_name}.upload_file != ?", 'placeholder') }
@@ -78,7 +78,7 @@ module Effective
 
       # Just call me with Asset.create_from_url('http://somewhere.com/somthing.jpg')
       def create_from_url(url, options = {})
-        opts = {:upload_file => url, :user_id => 1, :aws_acl => EffectiveAssets.aws_acl}.merge(options)
+        opts = { upload_file: url, user_id: 1, aws_acl: EffectiveAssets.aws_acl }.merge(options)
 
         attempts = 3  # Try to upload this string file 3 times
         begin
@@ -104,7 +104,7 @@ module Effective
 
         filename = URI.escape(filename).gsub(/%\d\d|[^a-zA-Z0-9.-]/, '_')  # Replace anything not A-Z, a-z, 0-9, . -
 
-        opts = {:upload_file => "#{Asset.string_base_path}#{filename}", :user_id => 1, :aws_acl => EffectiveAssets.aws_acl}.merge(options)
+        opts = { upload_file: "#{Asset.string_base_path}#{filename}", user_id: 1, aws_acl: EffectiveAssets.aws_acl }.merge(options)
 
         attempts = 3  # Try to upload this string file 3 times
         begin
@@ -157,11 +157,11 @@ module Effective
     end
 
     def video?
-      content_type.include? 'video'
+      content_type.include? 'video/'
     end
 
     def image?
-      content_type.include? 'image'
+      content_type.include? 'image/'
     end
 
     def icon?
@@ -169,7 +169,7 @@ module Effective
     end
 
     def audio?
-      content_type.include? 'audio'
+      content_type.include? 'audio/'
     end
 
     def versions_info
@@ -180,15 +180,41 @@ module Effective
       title
     end
 
+    def placeholder?
+      upload_file.blank? || upload_file == 'placeholder'.freeze
+    end
+
+    # This method is called asynchronously by an after_commit filter
     def process!
+      # Make sure carrierwave-aws sets the correct permissions
       if data.respond_to?(:aws_acl) && aws_acl.present?
-        data.aws_acl = self.aws_acl
-        data.versions.each { |_, data| data.aws_acl = self.aws_acl }
+        data.aws_acl = aws_acl
+        data.versions.each { |_, data| data.aws_acl = aws_acl }
       end
 
-      data.cache_stored_file!
-      data.retrieve_from_cache!(data.cache_name)
-      data.recreate_versions!
+      if placeholder?
+        puts 'Placeholder Asset processing not required (this is a soft error)'
+        # Do nothing
+      elsif image? == false
+        puts 'Non-image Asset processing not required'
+        # Do Nothing
+      elsif upload_file.include?(Effective::Asset.string_base_path)
+        puts 'String-based Asset processing and uploading'
+
+        data.cache_stored_file!
+        data.retrieve_from_cache!(data.cache_name)
+        data.recreate_versions!
+      elsif upload_file.include?(Effective::Asset.s3_base_path)
+        # Carrierwave must download the file, process it, then upload the generated versions to S3
+        puts 'S3 Uploaded Asset downloading and processing'
+
+        self.remote_data_url = url
+      else
+        puts 'Non S3 Asset downloading and processing'
+        puts 'Downloading #{asset.url}'
+
+        self.remote_data_url = upload_file
+      end
 
       self.processed = true
       save!
@@ -235,9 +261,13 @@ module Effective
       true
     end
 
-    def enqueue_delayed_job
-      if !processed? && upload_file.present? && upload_file != 'placeholder'
-        Effective::DelayedJob.new.process_asset(id)
+    def queue_async_job
+      return if processed? || placeholder?
+
+      if [:inline, :async, nil].include?((Rails.application.config.active_job[:queue_adapter] rescue nil))
+        Effective::ProcessWithSuckerPunchJob.perform_async(id)
+      else
+        Effective::ProcessWithActiveJob.perform_later(id)
       end
     end
   end

data/config/effective_assets.rb

@@ -26,9 +26,9 @@ EffectiveAssets.setup do |config|
   config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) } # CanCanCan
 
   # This is your S3 bucket information
-  config.aws_bucket = ''
-  config.aws_access_key_id = ''
-  config.aws_secret_access_key = ''
+  config.aws_bucket = ''              # ENV.fetch('AWS_S3_BUCKET')
+  config.aws_access_key_id = ''       # ENV.fetch('AWS_ACCESS_KEY_ID')
+  config.aws_secret_access_key = ''   # ENV.fetch('AWS_SECRET_ACCESS_KEY')
   config.aws_region = 'us-east-1'
 
   config.aws_path = 'assets/'

data/lib/effective_assets/engine.rb

@@ -2,7 +2,7 @@ module EffectiveAssets
   class Engine < ::Rails::Engine
     engine_name 'effective_assets'
 
-    config.autoload_paths += Dir["#{config.root}/app/models/**/"]
+    config.autoload_paths += Dir["#{config.root}/app/models/**/", "#{config.root}/app/jobs/**/"]
 
     # Include Helpers to base application
     initializer 'effective_assets.action_controller' do |app|

data/lib/effective_assets/version.rb

@@ -1,3 +1,3 @@
 module EffectiveAssets
-  VERSION = '1.8.0'.freeze
+  VERSION = '1.9.0'.freeze
 end

data/lib/effective_assets.rb

@@ -1,5 +1,4 @@
 require 'carrierwave-aws'
-require 'delayed_job_active_record'
 require 'jquery-fileupload-rails'
 require 'haml-rails'
 require 'effective_assets/engine'

data/lib/generators/effective_assets/install_generator.rb

@@ -29,9 +29,6 @@ module EffectiveAssets
         migration_template ('../' * 3) + 'db/migrate/01_create_effective_assets.rb.erb', 'db/migrate/create_effective_assets.rb'
       end
 
-      def install_delayed_jobs
-        run 'rails generate delayed_job:active_record'
-      end
     end
   end
 end

data/lib/tasks/effective_assets_tasks.rake

@@ -2,31 +2,34 @@ require 'open-uri'
 
 namespace :effective_assets do
 
-  # rake reprocess_assets
+  # rake effective_assets:reprocess
   #
   # To reprocess every Asset:         rake reprocess_assets
   # Or reprocess from ID=100 and up:  rake reprocess_assets[100]
   # Or reprocess from ID=100 to 200:  rake reprocess_assets[100,200]
 
-  # desc "Reprocesses Effective::Assets and generate versions as per the current app/uploaders/asset_uploader.rb"
+  desc "Reprocesses Effective::Assets and re-generates versions as per the current app/uploaders/asset_uploader.rb"
   task :reprocess, [:start_at, :end_at] => :environment do |t, args|
     args.with_defaults(:start_at => 1, :end_at => Effective::Asset.unscoped.maximum(:id))
     ids = Range.new(args.start_at.to_i, args.end_at.to_i)
 
-    puts "Enqueuing reprocess asset jobs on the Delayed::Job queue..."
+    puts 'Reprocessing assets...'
 
-    Effective::Asset.where(:processed => true).where(:id => ids).pluck(:id).each do |id|
-      Effective::DelayedJob.new().reprocess_asset(id)
+    Effective::Asset.where(processed: true).where(id: ids).find_each do |asset|
+      begin
+        asset.reprocess!
+        puts "Successfully reprocessed ##{asset.id}"
+      rescue => e
+        puts "Error reprocessing ##{asset.id}: #{e.message}"
+      end
     end
 
-    puts "Success. Reprocessing jobs for each Effective::Asset (IDs #{ids.to_s}) have been created on the Delayed::Job queue."
-    puts "If a worker process is running, the reprocessing will have already begun."
-    puts "If not, run 'rake jobs:work' to begin the worker process now."
+    puts 'Done'
   end
 
   # This is going to pull all the versions and check every url manually
 
-  # rake check_assets
+  # rake rake effective_assets:check
   #
   # Checks the actual HTTP response code of the URL for each asset version
   #
@@ -90,10 +93,4 @@ namespace :effective_assets do
     end
   end
 
-  desc "Deletes all effective_asset related Delayed::Job jobs"
-  task :clear => :environment do |t, args|
-    Delayed::Job.where('handler ILIKE ?', '%method_name: :process_asset_without_delay%').delete_all
-    Delayed::Job.where('handler ILIKE ?', '%method_name: :reprocess_asset_without_delay%').delete_all
-    puts 'Deleted all effective_asset related Delayed::Job jobs'
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_assets
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2017-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: delayed_job_active_record
+  name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jquery-rails
+  name: haml-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: haml-rails
+  name: sass-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sass-rails
+  name: sucker_punch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,7 +146,6 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
-- Rakefile
 - active_admin/effective_assets.rb
 - app/assets/images/effective_assets/icon_close.png
 - app/assets/images/effective_assets/spinner.gif
@@ -178,11 +177,12 @@ files:
 - app/controllers/effective/s3_uploads_controller.rb
 - app/helpers/effective_assets_helper.rb
 - app/helpers/effective_assets_s3_helper.rb
+- app/jobs/effective/process_with_active_job.rb
+- app/jobs/effective/process_with_sucker_punch_job.rb
 - app/models/concerns/acts_as_asset_box.rb
 - app/models/effective/access_denied.rb
 - app/models/effective/asset.rb
 - app/models/effective/attachment.rb
-- app/models/effective/delayed_job.rb
 - app/models/effective/iframe_uploads.rb
 - app/models/effective/snippets/effective_asset.rb
 - app/models/inputs/asset_box.rb
@@ -236,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Upload images and files directly to AWS S3 with a custom form input then

data/Rakefile

@@ -1,23 +0,0 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-# Our tasks
-load 'lib/tasks/effective_assets_tasks.rake'
-
-# Testing tasks
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
-
-task :default => :spec

data/app/models/effective/delayed_job.rb

@@ -1,70 +0,0 @@
-# Call with DelayedJob.new.process_asset_images(...)
-# Run jobs locally with "rake jobs:work"
-
-module Effective
-  class DelayedJob
-    def process_asset(obj)
-      if obj.kind_of?(Effective::Asset)
-        asset = obj
-      else
-        asset = Effective::Asset.where(:id => (obj.to_i rescue 0)).first
-      end
-
-      if asset.present? && !asset.processed? && asset.upload_file.present? && asset.upload_file != 'placeholder'
-        puts "Processing asset ##{asset.id} from #{asset.upload_file}."
-
-        if asset.data.respond_to?(:aws_acl)
-          asset.data.aws_acl = asset.aws_acl
-          asset.data.versions.each { |_, data| data.aws_acl = asset.aws_acl }
-        end
-
-        if asset.upload_file.include?(Effective::Asset.string_base_path)
-          puts "String-based Asset processing and uploading..."
-
-          asset.data.cache_stored_file!
-          asset.data.retrieve_from_cache!(asset.data.cache_name)
-          asset.data.recreate_versions!
-        elsif asset.upload_file.include?(Effective::Asset.s3_base_path)
-          puts "S3 Uploaded Asset downloading and processing..."
-          # Carrierwave must download the file, process it, then upload the generated versions to S3
-          # We only want to process if it's an image, so we don't download zips or videos
-          asset.remote_data_url = asset.url if asset.image?
-        else
-          puts "Non S3 Asset downloading and processing..."
-          puts "Downloading #{asset.url}"
-
-          # Carrierwave must download the file, process it, then upload it and generated verions to S3
-          # We only want to process if it's an image, so we don't download zips or videos
-          asset.remote_data_url = asset.upload_file
-        end
-
-        asset.processed = true
-        asset.save!
-
-        (GC.start rescue nil)
-
-        puts "Successfully processed the asset."
-      end
-    end
-    handle_asynchronously :process_asset
-
-    def reprocess_asset(id)
-      Rails.logger.info "Processing ##{id}..."
-      print "Processing ##{id}..."
-
-      begin
-        Effective::Asset.find(id).reprocess!
-
-        Rails.logger.info "Successfully processed ##{id}"
-        print "success"; puts ''
-      rescue => e
-        Rails.logger.info  "Error: #{id} -> #{e.to_s}"
-        print "error: #{e.to_s}"; puts ''
-      end
-
-      (GC.start rescue nil)
-    end
-    handle_asynchronously :reprocess_asset
-
-  end
-end