effective_assets 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15d7f1fbde41fa5f9ff34ef4f5bd305b93577857
-  data.tar.gz: 3c480a731adcffefb4e1ff08ace835720554fa95
+  metadata.gz: b046d827dbdb53336ae75966f6e0b583d89eb392
+  data.tar.gz: df4319599899bb44a4ca80712f2825f9f02cf092
 SHA512:
-  metadata.gz: a10fe066f8b42ff90545dee4952500dc5f599011adab2f249fb9b603b533452b49ff4a0c4219263296ad09bff6664e4447469d8543457d744805f2d73d96c68a
-  data.tar.gz: 54179c2d4751645677c8da64df9a17d4a630b7b7e31fedfee0521286c13a3d262f48fd1dca6e9711a0678a002f3f598aded57b216884412c2d5f75e1f1e722a6
+  metadata.gz: eddcb8b9ddf413f78f399653b7fd8afe48ff51c332ec6bb354a99f43ade3362e64c16742bd295c09bdc90b0130b3355cba05f5276684abe5cbb429a68e02619d
+  data.tar.gz: fbf9f513853d9b99c1d216333c30eec15c0ee64c38a9feaf9176e0c4e893c4dcd3a467017eaeed28236a23f4792c0b2b965a9cc72e032efa7c1cea82ddca76b1

data/README.md

@@ -193,6 +193,8 @@ user.photos
 
 ### Validations
 
+You can validate the presence and length of the assets with a simple syntax:
+
 ```ruby
 class User
   acts_as_asset_box :avatar => true, :photos => false, :videos => 2, :mp3s => 5..10
@@ -201,8 +203,18 @@ end
 
 true means presence, false means no validations applied.
 
+or a more involved syntax:
+
+```ruby
+class User
+  acts_as_asset_box avatar: [presence: true], photos: false, videos: [length: 2], mp3s: [length: 5..10]
+end
+```
+
 The user in this example is only valid if exists an avatar, 2 videos, and 5..10 mp3s.
 
+Procs are not supported.
+
 ### Form Input
 
 There is a standard rails form input:
@@ -251,10 +263,10 @@ Use the custom form input for uploading (direct to S3) and attaching assets to t
 = f.input :pictures, :as => :asset_box, :dialog => true, :dialog_url => '/admin/effective_assets' # Use the attach dialog
 ```
 
-You may also upload secure (AWS: 'authenticated-read') assets with the same uploader
+You may also upload secure (AWS: 'authenticated-read') assets with the same uploader:
 
 ```ruby
-= f.input :pictures, :as => :asset_box, :aws_acl => 'authenticated-read'
+= f.input :pictures, :as => :asset_box, :private => true
 ```
 
 There is also a mechanism for collecting additional information from the upload form which will be set in the `asset.extra` field.
@@ -305,6 +317,41 @@ The permitted parameters are:
 :attachments_attributes => [:id, :asset_id, :attachable_type, :attachable_id, :position, :box, :_destroy]
 ```
 
+### Amazon S3 Public / Private
+
+When an asset is uploaded, it is created with an `aws_acl` of either `public-read` or `authenticated-read`.
+
+When in `authenticated-read` mode, calling `@asset.url` will return a URL that is valid for just 60 minutes.
+
+This privacy level can be configured in the following 3 ways:
+
+1. The app wide default is set in `config/initializers/effective_assets.rb`.  All Effective::Asset objects will be created with this ACL unless specified below.
+
+2. When you call `acts_as_asset_box` on a model, the `:private` or `:public` keys will define the behavior for just this asset box.
+
+```ruby
+acts_as_asset_box :avatar => :private
+acts_as_asset_box :avatar => :public
+```
+
+or, with validations:
+
+```ruby
+acts_as_asset_box :avatar => [presence: true, private: true]
+acts_as_asset_box :avatar => [presence: true, public: true]
+```
+
+All assets uploaded into this box will be created with this ACL unless overridden below.
+
+3. Set the ACL on the form upload field
+
+```ruby
+= f.input :avatar, :as => :asset_box, :private => true
+= f.input :avatar, :as => :asset_box, :public => true
+```
+
+Has final say over the privacy setting when uploaded from this form.
+
 
 ### Image Processing and Resizing
 

data/active_admin/effective_assets.rb

@@ -97,7 +97,13 @@ if defined?(ActiveAdmin)
     end
 
     member_action :reprocess, :method => :get do
-      asset = Effective::Asset.find(params[:id]).reprocess!
+      begin
+        Effective::Asset.find(params[:id]).reprocess!
+        flash[:success] = "Successfully reprocessed asset"
+      rescue => e
+        flash[:danger] = "Unable to process asset: #{e.message}"
+      end
+
       redirect_to admin_effective_assets_path
     end
   end

data/app/controllers/effective/s3_uploads_controller.rb

@@ -82,6 +82,8 @@ module Effective
       asset.aws_acl = opts[:aws_acl]
       asset[:data] = opts[:title]
 
+      asset.processed = true unless asset.image?
+
       # If our S3 Uploader has any issue uploading/saving the asset, destroy the placeholder empty one
       asset.save ? true : (asset.try(:destroy) and false)
     end

data/app/helpers/effective_assets_s3_helper.rb

@@ -57,7 +57,7 @@ module EffectiveAssetsS3Helper
     end
 
     def signature
-      Rails.logger.info 'WARNING: effective_assets config.aws_secret_access_key is blank. Please provide a value in config/initializers/effective_assets.rb' if @options[:aws_secret_access_key].blank?
+      raise 'effective_assets config.aws_secret_access_key is blank. Please provide a value in config/initializers/effective_assets.rb' if @options[:aws_secret_access_key].blank?
 
       Base64.encode64(
         OpenSSL::HMAC.digest(

data/app/models/concerns/acts_as_asset_box.rb

@@ -26,6 +26,8 @@
 module ActsAsAssetBox
   extend ActiveSupport::Concern
 
+  VALIDATION_KEYS = [:presence, :length, :inclusion, :private, :public]
+
   module ActiveRecord
     def acts_as_asset_box(*options)
       @acts_as_asset_box_opts = options || []
@@ -50,10 +52,40 @@ module ActsAsAssetBox
       boxes.each do |box, validation|
         self.send(:define_method, box) { effective_assets(box) }
 
-        if validation == true
+        # So we want to support 2 kinds of syntax here
+        # Syntax 1:
+        # acts_as_asset_box files: true     # Presence
+        # acts_as_asset_box files: false    # Nothing
+        # acts_as_asset_box files: 2        # Exactly 2 files
+        # acts_as_asset_box files: 5..10    # 5 to 10 photos
+        # acts_as_asset_box files: :private # AWS ACL private
+        # acts_as_asset_box files: :public  # AWS ACL private
+        #
+        # Syntax 2:
+        # acts_as_asset_box files: [presence: true, length: 5..2, private: true], another: :private
+
+        if validation == true || validation == :presence
           validates box, :asset_box_presence => true
         elsif validation.kind_of?(Integer) or validation.kind_of?(Range)
           validates box, :asset_box_length => validation
+        elsif validation == :private || validation == :public
+          # Do nothing
+        else
+          validations = Array(validation).first
+
+          if validations.kind_of?(Hash) != true
+            raise 'invalid parameters passed to acts_as_asset_box. Example Usage: acts_as_asset_box photos: [presence: true, length: 1..3, private: true]'
+          elsif (validations.keys - VALIDATION_KEYS).present?
+            raise "invalid key #{validations.keys - VALIDATION_KEYS} passed to acts_as_asset_box. Valid keys are: #{VALIDATION_KEYS}"
+          end
+
+          if validations[:presence]
+            validates box, :asset_box_presence => true
+          end
+
+          if validations[:length] || validations[:inclusion]
+            validates box, :asset_box_length => (validations[:length] || validations[:inclusion])
+          end
         end
       end
     else

data/app/models/effective/asset.rb

@@ -181,23 +181,17 @@ module Effective
     end
 
     def process!
-      begin
-        Rails.logger.info "Processing ##{id}..."
-        print "Processing ##{id}..."
-
-        data.cache_stored_file!
-        data.retrieve_from_cache!(data.cache_name)
-        data.recreate_versions!
-        save!
-
-        Rails.logger.info "Successfully processed ##{id}"
-        print "success"; puts ''
-        true
-      rescue => e
-        Rails.logger.info  "Error: #{id} -> #{e.to_s}"
-        print "error: #{e.to_s}"; puts ''
-        false
+      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 }
       end
+
+      data.cache_stored_file!
+      data.retrieve_from_cache!(data.cache_name)
+      data.recreate_versions!
+
+      self.processed = true
+      save!
     end
     alias_method :reprocess!, :process!
 
@@ -242,11 +236,10 @@ module Effective
     end
 
     def enqueue_delayed_job
-      if !self.processed && self.upload_file.present? && self.upload_file != 'placeholder'
-        Effective::DelayedJob.new.process_asset(self.id)
+      if !processed? && upload_file.present? && upload_file != 'placeholder'
+        Effective::DelayedJob.new.process_asset(id)
       end
     end
-
   end
 
   class AssetStringIO < StringIO

data/app/models/effective/delayed_job.rb

@@ -49,7 +49,19 @@ module Effective
     handle_asynchronously :process_asset
 
     def reprocess_asset(id)
-      Effective::Asset.find(id).reprocess!
+      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

data/app/models/inputs/asset_box.rb

@@ -157,7 +157,6 @@ module Inputs
         :dialog_url => @template.effective_assets.effective_assets_path,
         :disabled => false,
         :file_types => [:any],
-        :aws_acl => EffectiveAssets.aws_acl,
         :btn_label => "Upload..."
       }.merge(opts).tap do |options|
         options[:method] = method.to_s
@@ -165,6 +164,28 @@ module Inputs
         options[:attachable_id] ||= (@object.try(:id) rescue nil)
         options[:attachable_type] ||= @object.class.name.titleize.gsub(" ", "_").gsub('/', '_').downcase
 
+        # The logic for the AWS ACL is such that:
+        # 1.) If the :private or :aws_acl keys are set on the asset_box input, use those values
+        # 2.) If the :private or :public keys are set on the acts_as_asset_box declaration, use those values
+        # 3.) Fall back to default EffectiveAssets.aws_acl as per config file
+
+        uploader_private = (opts[:private] == true || opts[:public] == false || opts[:aws_acl] == EffectiveAssets::AWS_PRIVATE)
+        uploader_public = (opts[:private] == false || opts[:public] == true || opts[:aws_acl] == EffectiveAssets::AWS_PUBLIC)
+        object_private = ((@object.asset_boxes[method] == :private || @object.asset_boxes[method].first[:private] == true || @object.asset_boxes[method].first[:public] == false) rescue false)
+        object_public = ((@object.asset_boxes[method] == :public || @object.asset_boxes[method].first[:public] == true || @object.asset_boxes[method].first[:private] == false) rescue false)
+
+        if uploader_private
+          options[:aws_acl] = EffectiveAssets::AWS_PRIVATE
+        elsif uploader_public
+          options[:aws_acl] = EffectiveAssets::AWS_PUBLIC
+        elsif object_private
+          options[:aws_acl] = EffectiveAssets::AWS_PRIVATE
+        elsif object_public
+          options[:aws_acl] = EffectiveAssets::AWS_PUBLIC
+        else
+          options[:aws_acl] = EffectiveAssets.aws_acl
+        end
+
         options[:uid] = "#{options[:attachable_type]}-#{options[:attachable_id]}-#{options[:method]}-#{Time.zone.now.to_f}".parameterize
         options[:limit] = (options[:method] == options[:box] ? (options[:limit] || 10000) : 1)
       end

data/lib/effective_assets/version.rb

@@ -1,3 +1,3 @@
 module EffectiveAssets
-  VERSION = '1.7.1'.freeze
+  VERSION = '1.7.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_assets
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-17 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails