anaconda 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f2f581ae3f7c35f01cf722109099bd11a7aa17e
-  data.tar.gz: 0a70065bd87eaa9fe2c168c8ce4e68fc8b6d590a
+  metadata.gz: 48af1f9503f065b652298a02de0fe6f0f22ead90
+  data.tar.gz: 91ba09bdb12f881ccd3b8612d482fe7681f41b82
 SHA512:
-  metadata.gz: 9bb89ebfa49e1d30f03b7c8a9b05a3976b943a0bad924664f563a728fe0960f63cda5983b35aac1b72b7c6e8423210e1ae91f76c76d172c2a04220c5ceddbdce
-  data.tar.gz: a41891beeeb959a71ec11d267770b39a8d13f963d842787a3758d4c35901ec788688fb39de16b429f2a60712e346df3bcd5e49780ea23d1ae86e80a78c369c0f
+  metadata.gz: 96ba09c1ba5ec0d753ebdeeecdad087ce928219729d1f8b568b40eee54714474ae1d82161dbe2d5a03e7113a4d0a96574f1fef542573c837f2145c9bb0597ec4
+  data.tar.gz: 3a14cc1ba75147fb24a87315e6f13a69596106afb0bc8c9d4d19d0b341a3be6deda93f915c5ade422a8ae3600442c317d763ca873742f6319e2c4602aa833b2d

data/README.markdown

@@ -76,6 +76,27 @@ We highly recommend the `figaro` gem [https://github.com/laserlemon/figaro](http
 *  Controller changes
   	
   	You must add these parameters to your permitted parameters. In Rails 4 this is done via strong parameters in the controller. In Rails 3 this is done in the model via attr_accessible.
+  	
+  	We add two Class methods on the model that return an array of columns used by each anaconda_for column. One is scoped per anaconda field, and the other returns all of the columns anaconda needs for the entire model. This is useful if you have multiple anaconda columns in your model.
+  	
+  	You can use these methods in your strong parameter list directly. Ex:
+  	
+  		PostMediasController < Application Controller
+  		...
+	  		def post_media_params
+	  			params.require(:post_media).permit(
+	  			:name,
+	  			:foobar,
+	  			PostMedia.anaconda_fields_for( :asset )
+	  			)
+	  		end
+  		end
+  	
+  	This keeps your strong parameter list clean and dry. If you have multiple anaconda models in your model and you wish for all of the params for all of the models to be permitted, you may use `PostMedia.anaconda_fields_for_all_columns` instead.
+  	
+  	We have not tested if you can use `Model.anaconda_fields_for( column )` in the rails 3 attr_accessible list.
+  	
+  	If you prefer to do this manually the fields this permit are listed below.
 
   	For each `anaconda_for` (assuming `anaconda_for :asset`):
   	
@@ -117,7 +138,8 @@ We highly recommend the `figaro` gem [https://github.com/laserlemon/figaro](http
 	* `allowed_file_types` default: _all_
 	* `host` String. If specified, this will be used to access publically stored objects instead of the S3 bucket. Useful for CloudFront integration. Note: At this time privately stored objects will still be requested via S3. Default: _false_
 	* `protocol` `https`, `http`, or `:auto`. If `:auto`, `//` will be used as the protocol. Note: At this time, all privately stored objects are requested over https. Default: `http`
-
+  * `remove_previous_s3_files_on_change` Boolean. If true, files will be removed from S3 when a new file is uploaded. Default: `true`
+  * `remove_previous_s3_files_on_destroy` Boolean. If true, files will be removed from S3 when a record is destroyed. Default: `true`
 
 *  Form setup
 
@@ -148,6 +170,7 @@ We highly recommend the `figaro` gem [https://github.com/laserlemon/figaro](http
     * :asset_stored_privately
     * :asset_type
     * :asset_url
+    * :asset_download_url
     
     The magic methods are asset_url and asset_download_url.
     
@@ -156,6 +179,11 @@ We highly recommend the `figaro` gem [https://github.com/laserlemon/figaro](http
     `asset_download_url` will return a signed S3 URL with content-disposition set to attachment so the file will be downloaded instead of opened in the browser.
 
 ## Changelog
+* 0.12.0
+  * Delete files from S3 when a new one us uploaded, or the record is deleted.
+  * Add options to disable deleting files from S3 when a new one is uploaded (`remove_previous_s3_files_on_change` and `remove_previous_s3_files_on_destroy`). These default to `true`
+  * Add `Model.anaconda_fields_for_all_columns` and `Model.anaconda_fields_for(column_name)` methods to make strong parameters cleaner
+  
 * 0.11.0
   * Change aws URLs to use path style URLs
   

data/lib/anaconda.rb

@@ -49,4 +49,9 @@ module Anaconda
     end
     return js_file_types
   end
+  
+  def self.remove_s3_object_in_bucket_with_file_path(bucket, file_path)
+    aws = Fog::Storage.new({:provider => 'AWS', :aws_access_key_id => Anaconda.aws[:aws_access_key], :aws_secret_access_key => Anaconda.aws[:aws_secret_key], :path_style => true})
+    aws.delete_object(bucket, file_path)
+  end
 end

data/lib/anaconda/anaconda.rb

@@ -1,3 +1,11 @@
 module Anaconda
   MagicMethods = [:url, :download_url]
+  FieldSuffixes = [
+    :filename,
+    :file_path,
+    :size,
+    :original_filename,
+    :stored_privately,
+    :type
+  ]
 end

data/lib/anaconda/anaconda_for.rb

@@ -38,9 +38,30 @@ module Anaconda
           allowed_file_types: [],
           base_key: "#{self.to_s.pluralize.downcase}/#{anaconda_column.to_s.pluralize}/#{(0...32).map{(65+rand(26)).chr}.join.downcase}",
           host: false,
-          protocol: "http"
+          protocol: "http",
+          remove_previous_s3_files_on_change: true,
+          remove_previous_s3_files_on_destroy: true
         )
+        
+        self.after_commit :anaconda_remove_previous_s3_files_on_change_or_destroy
+      end
+      
+      def anaconda_fields_for( anaconda_column )
+        if self.anaconda_columns.include? anaconda_column.to_sym
+          Anaconda::FieldSuffixes.collect do |suffix|
+            "#{anaconda_column}_#{suffix}".to_sym
+          end
+        else
+          raise "#{anaconda_column} not configured for anaconda. Misspelling or did you forget to add the anaconda_for call for this field?"
+        end
       end
+      
+      def anaconda_fields_for_all_columns
+        self.anaconda_columns.collect do |column|
+          anaconda_fields_for column
+        end.flatten
+      end
+      
     end
     module InstanceMethods
       def method_missing(method, *args, &block)
@@ -96,6 +117,31 @@ module Anaconda
           "#{self.anaconda_options[column_name.to_sym][:protocol]}://"
         end
       end
+      
+      def anaconda_remove_previous_s3_files_on_change_or_destroy
+        
+        if self.destroyed?
+          self.class.anaconda_columns.each do |column_name|
+            next unless self.anaconda_options[column_name.to_sym][:remove_previous_s3_files_on_destroy]
+            if self.send("#{column_name}_file_path").present?
+              Anaconda.remove_s3_object_in_bucket_with_file_path(Anaconda.aws[:aws_bucket], self.send("#{column_name}_file_path"))
+            end
+          end
+        else
+          self.class.anaconda_columns.each do |column_name|
+            next unless self.anaconda_options[column_name.to_sym][:remove_previous_s3_files_on_change]
+            if self.previous_changes["#{column_name}_file_path"].present?
+              # Looks like this field was edited.
+              if self.previous_changes["#{column_name}_file_path"][0].present? &&
+                self.previous_changes["#{column_name}_file_path"][0] != self.previous_changes["#{column_name}_file_path"][1]
+                # It's not a new entry ([0] would be nil), and it really did change, wasn't just committed for no reason
+                # So let's delete the previous file from S3
+                Anaconda.remove_s3_object_in_bucket_with_file_path(Anaconda.aws[:aws_bucket], self.previous_changes["#{column_name}_file_path"][0])
+              end
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/anaconda/version.rb

@@ -1,5 +1,5 @@
 module Anaconda
   module Rails
-    VERSION = "0.11.0"
+    VERSION = "0.12.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: anaconda
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Ben McFadden