expiring_asset_links 1.1.3 → 1.2.0

data/README.md

@@ -6,27 +6,84 @@ Handles storing and generating CarrierWave FOG expiring asset link stored in str
 
 This is helpful when using a WYSIWYG that inserts and previews assets directly from S3 using full S3 URLs.  These URLs need to be updated each time the object is reloaded.  When used in conjunction with CarrierWave and FOG gems, this gem will automatically update these links for you.
 
+## Dependencies
+
+the following gems are required
+
+    gem 'rails', '>= 4.0.0'
+    gem 'carrierwave'
+    gem 'fog'
+
 ## Installation
 
+install manually
+
     gem install expiring_asset_links
 
+or add it to your Gemfile
+
+    gem 'carrierwave'
+
 ## Usage
 
-### name your uploader mount `:asset`
+### configure CarrierWave
+
+your configuration must satisfy the following requirements:
+
+* specify `storage :fog`
+* use the default `store_dir` string or one that ends with `folder/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}`
+
+  any of the following will work
+
+<pre>
+uploads/#{Rails.env}/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}
+uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}
+#{Rails.env}/uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}
+#{Rails.env}/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}
+a/series/of/folder/names/or/1/numbers/2/that_do/not/contain/spaces/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}
+</pre>
+
+* `s3_headers` must include a value for `Expires`
+
+for example
+
+    class AssetUploader < CarrierWave::Uploader::Base
+      storage :fog
+    
+      def s3_headers
+        { "Expires" => 5.minutes.from_how.httpdate }
+      end
+    
+      def store_dir
+        "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+      end
+    
+    end
 
-    class Images
-      mount_uploader :asset, ImageUploader
-      
+### mount an uploader for any class containing an assets
+
+you may use as many different classes as you would like, but each may only contain one mounted uploader
+
+    class Image
+      mount_uploader :image, ImageUploader
+    
+    end
+    
+    class Attachment
+      mount_uploader :file, FileUploader
+    
     end
 
-### specify the fields that will contain :asset links
+### specify the attributes that will contain asset links
 
-    class Document
+the attributes specified should contain fully qualified asset URLs generated by CarrierWave with the `Expires` value specified when saved, these URLs will be automatically updated each time the attribute is accessed
+
+    class Document < ActiveRecord::Base
       attr_expiring_asset_links :body
-      
+    
     end
     
-    class Article
+    class Article < ActiveRecord::Base
       attr_expiring_asset_links :summary, :body
-      
+    
     end

data/expiring_asset_links.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency('carrierwave')
   s.add_dependency('fog')
-  s.add_dependency('rails')
+  s.add_dependency('rails', ['>= 4.0.0'])
   s.add_development_dependency('sqlite3')
 end

data/lib/expiring_asset_links/version.rb

@@ -2,8 +2,8 @@ module ExpiringAssetLinks
   # Contains information about this gem's version
   module Version
     MAJOR = 1
-    MINOR = 1
-    PATCH = 3
+    MINOR = 2
+    PATCH = 0
 
     # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
     #

data/lib/expiring_asset_links.rb

@@ -37,7 +37,8 @@ module ExpiringAssetLinks
     end
 
     def add_asset_tags(attribute)
-      self[attribute.to_sym].gsub(/([A-Za-z]+)\{\{(\d+)\}\}/) { $1.constantize.find($2).asset.url(:default) }
+      linked_attribute = 
+      self[attribute.to_sym].gsub(/([A-Za-z]+)\{\{(\d+)\}\}/) { $1.constantize.find($2).send($1.constantize.uploaders.keys.first).url(:default) }
     end
 
     def remove_all_asset_tags!

data/test/expiring_asset_links_test.rb

@@ -21,7 +21,7 @@ class ExpiringAssetLinksTest < Test::Unit::TestCase
 
   def test_should_assert_true
     file_attachment = FileAttachment.create(name: "test", asset: AssetUploader.new("https://test.s3-us-east-1.amazonaws.com/uploads/test/file_attachment/asset/1/sample.jpg"))
-    document = Document.create(title: "This is the Document Title", body: "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_attachment.asset.url}\">")
+    document = Document.create(title: "This is the Document Title", body: "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"#{file_attachment.send(FileAttachment.uploaders.keys.first).url}\">")
 
     assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"FileAttachment{{1}}\">", Document.find(document.id).attributes["body"]
     assert_equal "<h2>Section One</h2><p>This is the first section in the body of the document.  It includes an image.</p><img src=\"https://test.s3-us-east-1.amazonaws.com/uploads/test/file_attachment/asset/1/sample.jpg?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&amp;Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXX%3D&amp;Expires=2222222222\">", Document.find(document.id).body

data/test/test_helper.rb

@@ -8,7 +8,6 @@ require 'carrierwave'
 require 'fog'
 require 'test/unit'
 
-
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
 
 ActiveRecord::Schema.define(:version => 1) do
@@ -29,16 +28,31 @@ ActiveRecord::Schema.define(:version => 1) do
   end
 end
 
+module HasAssets
+  module ClassMethods
+    def serialize_asset
+      serialize :asset
+    end
+    def uploaders
+      { asset: AssetUploader }
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods).serialize_asset
+  end
+end
+
 class Document < ActiveRecord::Base
   attr_expiring_asset_links :body
 end
 
 class FileAttachment < ActiveRecord::Base
-  serialize :asset
+  include HasAssets
 end
 
 class ImageAttachment < ActiveRecord::Base
-  serialize :asset
+  include HasAssets
 end
 
 class AssetUploader < Struct.new(:my_url)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: expiring_asset_links
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement